1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _LINUX_FS_H 3 #define _LINUX_FS_H 4 5 #include <linux/linkage.h> 6 #include <linux/wait_bit.h> 7 #include <linux/kdev_t.h> 8 #include <linux/dcache.h> 9 #include <linux/path.h> 10 #include <linux/stat.h> 11 #include <linux/cache.h> 12 #include <linux/list.h> 13 #include <linux/list_lru.h> 14 #include <linux/llist.h> 15 #include <linux/radix-tree.h> 16 #include <linux/xarray.h> 17 #include <linux/rbtree.h> 18 #include <linux/init.h> 19 #include <linux/pid.h> 20 #include <linux/bug.h> 21 #include <linux/mutex.h> 22 #include <linux/rwsem.h> 23 #include <linux/mm_types.h> 24 #include <linux/capability.h> 25 #include <linux/semaphore.h> 26 #include <linux/fcntl.h> 27 #include <linux/rculist_bl.h> 28 #include <linux/atomic.h> 29 #include <linux/shrinker.h> 30 #include <linux/migrate_mode.h> 31 #include <linux/uidgid.h> 32 #include <linux/lockdep.h> 33 #include <linux/percpu-rwsem.h> 34 #include <linux/workqueue.h> 35 #include <linux/delayed_call.h> 36 #include <linux/uuid.h> 37 #include <linux/errseq.h> 38 #include <linux/ioprio.h> 39 #include <linux/fs_types.h> 40 #include <linux/build_bug.h> 41 #include <linux/stddef.h> 42 43 #include <asm/byteorder.h> 44 #include <uapi/linux/fs.h> 45 46 struct backing_dev_info; 47 struct bdi_writeback; 48 struct bio; 49 struct export_operations; 50 struct fiemap_extent_info; 51 struct hd_geometry; 52 struct iovec; 53 struct kiocb; 54 struct kobject; 55 struct pipe_inode_info; 56 struct poll_table_struct; 57 struct kstatfs; 58 struct vm_area_struct; 59 struct vfsmount; 60 struct cred; 61 struct swap_info_struct; 62 struct seq_file; 63 struct workqueue_struct; 64 struct iov_iter; 65 struct fscrypt_info; 66 struct fscrypt_operations; 67 struct fsverity_info; 68 struct fsverity_operations; 69 struct fs_context; 70 struct fs_parameter_spec; 71 72 extern void __init inode_init(void); 73 extern void __init inode_init_early(void); 74 extern void __init files_init(void); 75 extern void __init files_maxfiles_init(void); 76 77 extern struct files_stat_struct files_stat; 78 extern unsigned long get_max_files(void); 79 extern unsigned int sysctl_nr_open; 80 extern struct inodes_stat_t inodes_stat; 81 extern int leases_enable, lease_break_time; 82 extern int sysctl_protected_symlinks; 83 extern int sysctl_protected_hardlinks; 84 extern int sysctl_protected_fifos; 85 extern int sysctl_protected_regular; 86 87 typedef __kernel_rwf_t rwf_t; 88 89 struct buffer_head; 90 typedef int (get_block_t)(struct inode *inode, sector_t iblock, 91 struct buffer_head *bh_result, int create); 92 typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset, 93 ssize_t bytes, void *private); 94 95 #define MAY_EXEC 0x00000001 96 #define MAY_WRITE 0x00000002 97 #define MAY_READ 0x00000004 98 #define MAY_APPEND 0x00000008 99 #define MAY_ACCESS 0x00000010 100 #define MAY_OPEN 0x00000020 101 #define MAY_CHDIR 0x00000040 102 /* called from RCU mode, don't block */ 103 #define MAY_NOT_BLOCK 0x00000080 104 105 /* 106 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond 107 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open() 108 */ 109 110 /* file is open for reading */ 111 #define FMODE_READ ((__force fmode_t)0x1) 112 /* file is open for writing */ 113 #define FMODE_WRITE ((__force fmode_t)0x2) 114 /* file is seekable */ 115 #define FMODE_LSEEK ((__force fmode_t)0x4) 116 /* file can be accessed using pread */ 117 #define FMODE_PREAD ((__force fmode_t)0x8) 118 /* file can be accessed using pwrite */ 119 #define FMODE_PWRITE ((__force fmode_t)0x10) 120 /* File is opened for execution with sys_execve / sys_uselib */ 121 #define FMODE_EXEC ((__force fmode_t)0x20) 122 /* File is opened with O_NDELAY (only set for block devices) */ 123 #define FMODE_NDELAY ((__force fmode_t)0x40) 124 /* File is opened with O_EXCL (only set for block devices) */ 125 #define FMODE_EXCL ((__force fmode_t)0x80) 126 /* File is opened using open(.., 3, ..) and is writeable only for ioctls 127 (specialy hack for floppy.c) */ 128 #define FMODE_WRITE_IOCTL ((__force fmode_t)0x100) 129 /* 32bit hashes as llseek() offset (for directories) */ 130 #define FMODE_32BITHASH ((__force fmode_t)0x200) 131 /* 64bit hashes as llseek() offset (for directories) */ 132 #define FMODE_64BITHASH ((__force fmode_t)0x400) 133 134 /* 135 * Don't update ctime and mtime. 136 * 137 * Currently a special hack for the XFS open_by_handle ioctl, but we'll 138 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon. 139 */ 140 #define FMODE_NOCMTIME ((__force fmode_t)0x800) 141 142 /* Expect random access pattern */ 143 #define FMODE_RANDOM ((__force fmode_t)0x1000) 144 145 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */ 146 #define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000) 147 148 /* File is opened with O_PATH; almost nothing can be done with it */ 149 #define FMODE_PATH ((__force fmode_t)0x4000) 150 151 /* File needs atomic accesses to f_pos */ 152 #define FMODE_ATOMIC_POS ((__force fmode_t)0x8000) 153 /* Write access to underlying fs */ 154 #define FMODE_WRITER ((__force fmode_t)0x10000) 155 /* Has read method(s) */ 156 #define FMODE_CAN_READ ((__force fmode_t)0x20000) 157 /* Has write method(s) */ 158 #define FMODE_CAN_WRITE ((__force fmode_t)0x40000) 159 160 #define FMODE_OPENED ((__force fmode_t)0x80000) 161 #define FMODE_CREATED ((__force fmode_t)0x100000) 162 163 /* File is stream-like */ 164 #define FMODE_STREAM ((__force fmode_t)0x200000) 165 166 /* File was opened by fanotify and shouldn't generate fanotify events */ 167 #define FMODE_NONOTIFY ((__force fmode_t)0x4000000) 168 169 /* File is capable of returning -EAGAIN if I/O will block */ 170 #define FMODE_NOWAIT ((__force fmode_t)0x8000000) 171 172 /* File represents mount that needs unmounting */ 173 #define FMODE_NEED_UNMOUNT ((__force fmode_t)0x10000000) 174 175 /* File does not contribute to nr_files count */ 176 #define FMODE_NOACCOUNT ((__force fmode_t)0x20000000) 177 178 /* 179 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector 180 * that indicates that they should check the contents of the iovec are 181 * valid, but not check the memory that the iovec elements 182 * points too. 183 */ 184 #define CHECK_IOVEC_ONLY -1 185 186 /* 187 * Attribute flags. These should be or-ed together to figure out what 188 * has been changed! 189 */ 190 #define ATTR_MODE (1 << 0) 191 #define ATTR_UID (1 << 1) 192 #define ATTR_GID (1 << 2) 193 #define ATTR_SIZE (1 << 3) 194 #define ATTR_ATIME (1 << 4) 195 #define ATTR_MTIME (1 << 5) 196 #define ATTR_CTIME (1 << 6) 197 #define ATTR_ATIME_SET (1 << 7) 198 #define ATTR_MTIME_SET (1 << 8) 199 #define ATTR_FORCE (1 << 9) /* Not a change, but a change it */ 200 #define ATTR_KILL_SUID (1 << 11) 201 #define ATTR_KILL_SGID (1 << 12) 202 #define ATTR_FILE (1 << 13) 203 #define ATTR_KILL_PRIV (1 << 14) 204 #define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */ 205 #define ATTR_TIMES_SET (1 << 16) 206 #define ATTR_TOUCH (1 << 17) 207 208 /* 209 * Whiteout is represented by a char device. The following constants define the 210 * mode and device number to use. 211 */ 212 #define WHITEOUT_MODE 0 213 #define WHITEOUT_DEV 0 214 215 /* 216 * This is the Inode Attributes structure, used for notify_change(). It 217 * uses the above definitions as flags, to know which values have changed. 218 * Also, in this manner, a Filesystem can look at only the values it cares 219 * about. Basically, these are the attributes that the VFS layer can 220 * request to change from the FS layer. 221 * 222 * Derek Atkins <[email protected]> 94-10-20 223 */ 224 struct iattr { 225 unsigned int ia_valid; 226 umode_t ia_mode; 227 kuid_t ia_uid; 228 kgid_t ia_gid; 229 loff_t ia_size; 230 struct timespec64 ia_atime; 231 struct timespec64 ia_mtime; 232 struct timespec64 ia_ctime; 233 234 /* 235 * Not an attribute, but an auxiliary info for filesystems wanting to 236 * implement an ftruncate() like method. NOTE: filesystem should 237 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL). 238 */ 239 struct file *ia_file; 240 }; 241 242 /* 243 * Includes for diskquotas. 244 */ 245 #include <linux/quota.h> 246 247 /* 248 * Maximum number of layers of fs stack. Needs to be limited to 249 * prevent kernel stack overflow 250 */ 251 #define FILESYSTEM_MAX_STACK_DEPTH 2 252 253 /** 254 * enum positive_aop_returns - aop return codes with specific semantics 255 * 256 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has 257 * completed, that the page is still locked, and 258 * should be considered active. The VM uses this hint 259 * to return the page to the active list -- it won't 260 * be a candidate for writeback again in the near 261 * future. Other callers must be careful to unlock 262 * the page if they get this return. Returned by 263 * writepage(); 264 * 265 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has 266 * unlocked it and the page might have been truncated. 267 * The caller should back up to acquiring a new page and 268 * trying again. The aop will be taking reasonable 269 * precautions not to livelock. If the caller held a page 270 * reference, it should drop it before retrying. Returned 271 * by readpage(). 272 * 273 * address_space_operation functions return these large constants to indicate 274 * special semantics to the caller. These are much larger than the bytes in a 275 * page to allow for functions that return the number of bytes operated on in a 276 * given page. 277 */ 278 279 enum positive_aop_returns { 280 AOP_WRITEPAGE_ACTIVATE = 0x80000, 281 AOP_TRUNCATED_PAGE = 0x80001, 282 }; 283 284 #define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */ 285 #define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct 286 * helper code (eg buffer layer) 287 * to clear GFP_FS from alloc */ 288 289 /* 290 * oh the beauties of C type declarations. 291 */ 292 struct page; 293 struct address_space; 294 struct writeback_control; 295 struct readahead_control; 296 297 /* 298 * Write life time hint values. 299 * Stored in struct inode as u8. 300 */ 301 enum rw_hint { 302 WRITE_LIFE_NOT_SET = 0, 303 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE, 304 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT, 305 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM, 306 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG, 307 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME, 308 }; 309 310 #define IOCB_EVENTFD (1 << 0) 311 #define IOCB_APPEND (1 << 1) 312 #define IOCB_DIRECT (1 << 2) 313 #define IOCB_HIPRI (1 << 3) 314 #define IOCB_DSYNC (1 << 4) 315 #define IOCB_SYNC (1 << 5) 316 #define IOCB_WRITE (1 << 6) 317 #define IOCB_NOWAIT (1 << 7) 318 319 struct kiocb { 320 struct file *ki_filp; 321 322 /* The 'ki_filp' pointer is shared in a union for aio */ 323 randomized_struct_fields_start 324 325 loff_t ki_pos; 326 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2); 327 void *private; 328 int ki_flags; 329 u16 ki_hint; 330 u16 ki_ioprio; /* See linux/ioprio.h */ 331 unsigned int ki_cookie; /* for ->iopoll */ 332 333 randomized_struct_fields_end 334 }; 335 336 static inline bool is_sync_kiocb(struct kiocb *kiocb) 337 { 338 return kiocb->ki_complete == NULL; 339 } 340 341 /* 342 * "descriptor" for what we're up to with a read. 343 * This allows us to use the same read code yet 344 * have multiple different users of the data that 345 * we read from a file. 346 * 347 * The simplest case just copies the data to user 348 * mode. 349 */ 350 typedef struct { 351 size_t written; 352 size_t count; 353 union { 354 char __user *buf; 355 void *data; 356 } arg; 357 int error; 358 } read_descriptor_t; 359 360 typedef int (*read_actor_t)(read_descriptor_t *, struct page *, 361 unsigned long, unsigned long); 362 363 struct address_space_operations { 364 int (*writepage)(struct page *page, struct writeback_control *wbc); 365 int (*readpage)(struct file *, struct page *); 366 367 /* Write back some dirty pages from this mapping. */ 368 int (*writepages)(struct address_space *, struct writeback_control *); 369 370 /* Set a page dirty. Return true if this dirtied it */ 371 int (*set_page_dirty)(struct page *page); 372 373 /* 374 * Reads in the requested pages. Unlike ->readpage(), this is 375 * PURELY used for read-ahead!. 376 */ 377 int (*readpages)(struct file *filp, struct address_space *mapping, 378 struct list_head *pages, unsigned nr_pages); 379 void (*readahead)(struct readahead_control *); 380 381 int (*write_begin)(struct file *, struct address_space *mapping, 382 loff_t pos, unsigned len, unsigned flags, 383 struct page **pagep, void **fsdata); 384 int (*write_end)(struct file *, struct address_space *mapping, 385 loff_t pos, unsigned len, unsigned copied, 386 struct page *page, void *fsdata); 387 388 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */ 389 sector_t (*bmap)(struct address_space *, sector_t); 390 void (*invalidatepage) (struct page *, unsigned int, unsigned int); 391 int (*releasepage) (struct page *, gfp_t); 392 void (*freepage)(struct page *); 393 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter); 394 /* 395 * migrate the contents of a page to the specified target. If 396 * migrate_mode is MIGRATE_ASYNC, it must not block. 397 */ 398 int (*migratepage) (struct address_space *, 399 struct page *, struct page *, enum migrate_mode); 400 bool (*isolate_page)(struct page *, isolate_mode_t); 401 void (*putback_page)(struct page *); 402 int (*launder_page) (struct page *); 403 int (*is_partially_uptodate) (struct page *, unsigned long, 404 unsigned long); 405 void (*is_dirty_writeback) (struct page *, bool *, bool *); 406 int (*error_remove_page)(struct address_space *, struct page *); 407 408 /* swapfile support */ 409 int (*swap_activate)(struct swap_info_struct *sis, struct file *file, 410 sector_t *span); 411 void (*swap_deactivate)(struct file *file); 412 }; 413 414 extern const struct address_space_operations empty_aops; 415 416 /* 417 * pagecache_write_begin/pagecache_write_end must be used by general code 418 * to write into the pagecache. 419 */ 420 int pagecache_write_begin(struct file *, struct address_space *mapping, 421 loff_t pos, unsigned len, unsigned flags, 422 struct page **pagep, void **fsdata); 423 424 int pagecache_write_end(struct file *, struct address_space *mapping, 425 loff_t pos, unsigned len, unsigned copied, 426 struct page *page, void *fsdata); 427 428 /** 429 * struct address_space - Contents of a cacheable, mappable object. 430 * @host: Owner, either the inode or the block_device. 431 * @i_pages: Cached pages. 432 * @gfp_mask: Memory allocation flags to use for allocating pages. 433 * @i_mmap_writable: Number of VM_SHARED mappings. 434 * @nr_thps: Number of THPs in the pagecache (non-shmem only). 435 * @i_mmap: Tree of private and shared mappings. 436 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable. 437 * @nrpages: Number of page entries, protected by the i_pages lock. 438 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock. 439 * @writeback_index: Writeback starts here. 440 * @a_ops: Methods. 441 * @flags: Error bits and flags (AS_*). 442 * @wb_err: The most recent error which has occurred. 443 * @private_lock: For use by the owner of the address_space. 444 * @private_list: For use by the owner of the address_space. 445 * @private_data: For use by the owner of the address_space. 446 */ 447 struct address_space { 448 struct inode *host; 449 struct xarray i_pages; 450 gfp_t gfp_mask; 451 atomic_t i_mmap_writable; 452 #ifdef CONFIG_READ_ONLY_THP_FOR_FS 453 /* number of thp, only for non-shmem files */ 454 atomic_t nr_thps; 455 #endif 456 struct rb_root_cached i_mmap; 457 struct rw_semaphore i_mmap_rwsem; 458 unsigned long nrpages; 459 unsigned long nrexceptional; 460 pgoff_t writeback_index; 461 const struct address_space_operations *a_ops; 462 unsigned long flags; 463 errseq_t wb_err; 464 spinlock_t private_lock; 465 struct list_head private_list; 466 void *private_data; 467 } __attribute__((aligned(sizeof(long)))) __randomize_layout; 468 /* 469 * On most architectures that alignment is already the case; but 470 * must be enforced here for CRIS, to let the least significant bit 471 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON. 472 */ 473 struct request_queue; 474 475 struct block_device { 476 dev_t bd_dev; /* not a kdev_t - it's a search key */ 477 int bd_openers; 478 struct inode * bd_inode; /* will die */ 479 struct super_block * bd_super; 480 struct mutex bd_mutex; /* open/close mutex */ 481 void * bd_claiming; 482 void * bd_holder; 483 int bd_holders; 484 bool bd_write_holder; 485 #ifdef CONFIG_SYSFS 486 struct list_head bd_holder_disks; 487 #endif 488 struct block_device * bd_contains; 489 unsigned bd_block_size; 490 u8 bd_partno; 491 struct hd_struct * bd_part; 492 /* number of times partitions within this device have been opened. */ 493 unsigned bd_part_count; 494 int bd_invalidated; 495 struct gendisk * bd_disk; 496 struct request_queue * bd_queue; 497 struct backing_dev_info *bd_bdi; 498 struct list_head bd_list; 499 /* 500 * Private data. You must have bd_claim'ed the block_device 501 * to use this. NOTE: bd_claim allows an owner to claim 502 * the same device multiple times, the owner must take special 503 * care to not mess up bd_private for that case. 504 */ 505 unsigned long bd_private; 506 507 /* The counter of freeze processes */ 508 int bd_fsfreeze_count; 509 /* Mutex for freeze */ 510 struct mutex bd_fsfreeze_mutex; 511 } __randomize_layout; 512 513 /* XArray tags, for tagging dirty and writeback pages in the pagecache. */ 514 #define PAGECACHE_TAG_DIRTY XA_MARK_0 515 #define PAGECACHE_TAG_WRITEBACK XA_MARK_1 516 #define PAGECACHE_TAG_TOWRITE XA_MARK_2 517 518 /* 519 * Returns true if any of the pages in the mapping are marked with the tag. 520 */ 521 static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag) 522 { 523 return xa_marked(&mapping->i_pages, tag); 524 } 525 526 static inline void i_mmap_lock_write(struct address_space *mapping) 527 { 528 down_write(&mapping->i_mmap_rwsem); 529 } 530 531 static inline int i_mmap_trylock_write(struct address_space *mapping) 532 { 533 return down_write_trylock(&mapping->i_mmap_rwsem); 534 } 535 536 static inline void i_mmap_unlock_write(struct address_space *mapping) 537 { 538 up_write(&mapping->i_mmap_rwsem); 539 } 540 541 static inline void i_mmap_lock_read(struct address_space *mapping) 542 { 543 down_read(&mapping->i_mmap_rwsem); 544 } 545 546 static inline void i_mmap_unlock_read(struct address_space *mapping) 547 { 548 up_read(&mapping->i_mmap_rwsem); 549 } 550 551 /* 552 * Might pages of this file be mapped into userspace? 553 */ 554 static inline int mapping_mapped(struct address_space *mapping) 555 { 556 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root); 557 } 558 559 /* 560 * Might pages of this file have been modified in userspace? 561 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff 562 * marks vma as VM_SHARED if it is shared, and the file was opened for 563 * writing i.e. vma may be mprotected writable even if now readonly. 564 * 565 * If i_mmap_writable is negative, no new writable mappings are allowed. You 566 * can only deny writable mappings, if none exists right now. 567 */ 568 static inline int mapping_writably_mapped(struct address_space *mapping) 569 { 570 return atomic_read(&mapping->i_mmap_writable) > 0; 571 } 572 573 static inline int mapping_map_writable(struct address_space *mapping) 574 { 575 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ? 576 0 : -EPERM; 577 } 578 579 static inline void mapping_unmap_writable(struct address_space *mapping) 580 { 581 atomic_dec(&mapping->i_mmap_writable); 582 } 583 584 static inline int mapping_deny_writable(struct address_space *mapping) 585 { 586 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ? 587 0 : -EBUSY; 588 } 589 590 static inline void mapping_allow_writable(struct address_space *mapping) 591 { 592 atomic_inc(&mapping->i_mmap_writable); 593 } 594 595 /* 596 * Use sequence counter to get consistent i_size on 32-bit processors. 597 */ 598 #if BITS_PER_LONG==32 && defined(CONFIG_SMP) 599 #include <linux/seqlock.h> 600 #define __NEED_I_SIZE_ORDERED 601 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount) 602 #else 603 #define i_size_ordered_init(inode) do { } while (0) 604 #endif 605 606 struct posix_acl; 607 #define ACL_NOT_CACHED ((void *)(-1)) 608 #define ACL_DONT_CACHE ((void *)(-3)) 609 610 static inline struct posix_acl * 611 uncached_acl_sentinel(struct task_struct *task) 612 { 613 return (void *)task + 1; 614 } 615 616 static inline bool 617 is_uncached_acl(struct posix_acl *acl) 618 { 619 return (long)acl & 1; 620 } 621 622 #define IOP_FASTPERM 0x0001 623 #define IOP_LOOKUP 0x0002 624 #define IOP_NOFOLLOW 0x0004 625 #define IOP_XATTR 0x0008 626 #define IOP_DEFAULT_READLINK 0x0010 627 628 struct fsnotify_mark_connector; 629 630 /* 631 * Keep mostly read-only and often accessed (especially for 632 * the RCU path lookup and 'stat' data) fields at the beginning 633 * of the 'struct inode' 634 */ 635 struct inode { 636 umode_t i_mode; 637 unsigned short i_opflags; 638 kuid_t i_uid; 639 kgid_t i_gid; 640 unsigned int i_flags; 641 642 #ifdef CONFIG_FS_POSIX_ACL 643 struct posix_acl *i_acl; 644 struct posix_acl *i_default_acl; 645 #endif 646 647 const struct inode_operations *i_op; 648 struct super_block *i_sb; 649 struct address_space *i_mapping; 650 651 #ifdef CONFIG_SECURITY 652 void *i_security; 653 #endif 654 655 /* Stat data, not accessed from path walking */ 656 unsigned long i_ino; 657 /* 658 * Filesystems may only read i_nlink directly. They shall use the 659 * following functions for modification: 660 * 661 * (set|clear|inc|drop)_nlink 662 * inode_(inc|dec)_link_count 663 */ 664 union { 665 const unsigned int i_nlink; 666 unsigned int __i_nlink; 667 }; 668 dev_t i_rdev; 669 loff_t i_size; 670 struct timespec64 i_atime; 671 struct timespec64 i_mtime; 672 struct timespec64 i_ctime; 673 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */ 674 unsigned short i_bytes; 675 u8 i_blkbits; 676 u8 i_write_hint; 677 blkcnt_t i_blocks; 678 679 #ifdef __NEED_I_SIZE_ORDERED 680 seqcount_t i_size_seqcount; 681 #endif 682 683 /* Misc */ 684 unsigned long i_state; 685 struct rw_semaphore i_rwsem; 686 687 unsigned long dirtied_when; /* jiffies of first dirtying */ 688 unsigned long dirtied_time_when; 689 690 struct hlist_node i_hash; 691 struct list_head i_io_list; /* backing dev IO list */ 692 #ifdef CONFIG_CGROUP_WRITEBACK 693 struct bdi_writeback *i_wb; /* the associated cgroup wb */ 694 695 /* foreign inode detection, see wbc_detach_inode() */ 696 int i_wb_frn_winner; 697 u16 i_wb_frn_avg_time; 698 u16 i_wb_frn_history; 699 #endif 700 struct list_head i_lru; /* inode LRU list */ 701 struct list_head i_sb_list; 702 struct list_head i_wb_list; /* backing dev writeback list */ 703 union { 704 struct hlist_head i_dentry; 705 struct rcu_head i_rcu; 706 }; 707 atomic64_t i_version; 708 atomic64_t i_sequence; /* see futex */ 709 atomic_t i_count; 710 atomic_t i_dio_count; 711 atomic_t i_writecount; 712 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING) 713 atomic_t i_readcount; /* struct files open RO */ 714 #endif 715 union { 716 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */ 717 void (*free_inode)(struct inode *); 718 }; 719 struct file_lock_context *i_flctx; 720 struct address_space i_data; 721 struct list_head i_devices; 722 union { 723 struct pipe_inode_info *i_pipe; 724 struct block_device *i_bdev; 725 struct cdev *i_cdev; 726 char *i_link; 727 unsigned i_dir_seq; 728 }; 729 730 __u32 i_generation; 731 732 #ifdef CONFIG_FSNOTIFY 733 __u32 i_fsnotify_mask; /* all events this inode cares about */ 734 struct fsnotify_mark_connector __rcu *i_fsnotify_marks; 735 #endif 736 737 #ifdef CONFIG_FS_ENCRYPTION 738 struct fscrypt_info *i_crypt_info; 739 #endif 740 741 #ifdef CONFIG_FS_VERITY 742 struct fsverity_info *i_verity_info; 743 #endif 744 745 void *i_private; /* fs or device private pointer */ 746 } __randomize_layout; 747 748 struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode); 749 750 static inline unsigned int i_blocksize(const struct inode *node) 751 { 752 return (1 << node->i_blkbits); 753 } 754 755 static inline int inode_unhashed(struct inode *inode) 756 { 757 return hlist_unhashed(&inode->i_hash); 758 } 759 760 /* 761 * __mark_inode_dirty expects inodes to be hashed. Since we don't 762 * want special inodes in the fileset inode space, we make them 763 * appear hashed, but do not put on any lists. hlist_del() 764 * will work fine and require no locking. 765 */ 766 static inline void inode_fake_hash(struct inode *inode) 767 { 768 hlist_add_fake(&inode->i_hash); 769 } 770 771 /* 772 * inode->i_mutex nesting subclasses for the lock validator: 773 * 774 * 0: the object of the current VFS operation 775 * 1: parent 776 * 2: child/target 777 * 3: xattr 778 * 4: second non-directory 779 * 5: second parent (when locking independent directories in rename) 780 * 781 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two 782 * non-directories at once. 783 * 784 * The locking order between these classes is 785 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory 786 */ 787 enum inode_i_mutex_lock_class 788 { 789 I_MUTEX_NORMAL, 790 I_MUTEX_PARENT, 791 I_MUTEX_CHILD, 792 I_MUTEX_XATTR, 793 I_MUTEX_NONDIR2, 794 I_MUTEX_PARENT2, 795 }; 796 797 static inline void inode_lock(struct inode *inode) 798 { 799 down_write(&inode->i_rwsem); 800 } 801 802 static inline void inode_unlock(struct inode *inode) 803 { 804 up_write(&inode->i_rwsem); 805 } 806 807 static inline void inode_lock_shared(struct inode *inode) 808 { 809 down_read(&inode->i_rwsem); 810 } 811 812 static inline void inode_unlock_shared(struct inode *inode) 813 { 814 up_read(&inode->i_rwsem); 815 } 816 817 static inline int inode_trylock(struct inode *inode) 818 { 819 return down_write_trylock(&inode->i_rwsem); 820 } 821 822 static inline int inode_trylock_shared(struct inode *inode) 823 { 824 return down_read_trylock(&inode->i_rwsem); 825 } 826 827 static inline int inode_is_locked(struct inode *inode) 828 { 829 return rwsem_is_locked(&inode->i_rwsem); 830 } 831 832 static inline void inode_lock_nested(struct inode *inode, unsigned subclass) 833 { 834 down_write_nested(&inode->i_rwsem, subclass); 835 } 836 837 static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass) 838 { 839 down_read_nested(&inode->i_rwsem, subclass); 840 } 841 842 void lock_two_nondirectories(struct inode *, struct inode*); 843 void unlock_two_nondirectories(struct inode *, struct inode*); 844 845 /* 846 * NOTE: in a 32bit arch with a preemptable kernel and 847 * an UP compile the i_size_read/write must be atomic 848 * with respect to the local cpu (unlike with preempt disabled), 849 * but they don't need to be atomic with respect to other cpus like in 850 * true SMP (so they need either to either locally disable irq around 851 * the read or for example on x86 they can be still implemented as a 852 * cmpxchg8b without the need of the lock prefix). For SMP compiles 853 * and 64bit archs it makes no difference if preempt is enabled or not. 854 */ 855 static inline loff_t i_size_read(const struct inode *inode) 856 { 857 #if BITS_PER_LONG==32 && defined(CONFIG_SMP) 858 loff_t i_size; 859 unsigned int seq; 860 861 do { 862 seq = read_seqcount_begin(&inode->i_size_seqcount); 863 i_size = inode->i_size; 864 } while (read_seqcount_retry(&inode->i_size_seqcount, seq)); 865 return i_size; 866 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION) 867 loff_t i_size; 868 869 preempt_disable(); 870 i_size = inode->i_size; 871 preempt_enable(); 872 return i_size; 873 #else 874 return inode->i_size; 875 #endif 876 } 877 878 /* 879 * NOTE: unlike i_size_read(), i_size_write() does need locking around it 880 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount 881 * can be lost, resulting in subsequent i_size_read() calls spinning forever. 882 */ 883 static inline void i_size_write(struct inode *inode, loff_t i_size) 884 { 885 #if BITS_PER_LONG==32 && defined(CONFIG_SMP) 886 preempt_disable(); 887 write_seqcount_begin(&inode->i_size_seqcount); 888 inode->i_size = i_size; 889 write_seqcount_end(&inode->i_size_seqcount); 890 preempt_enable(); 891 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION) 892 preempt_disable(); 893 inode->i_size = i_size; 894 preempt_enable(); 895 #else 896 inode->i_size = i_size; 897 #endif 898 } 899 900 static inline unsigned iminor(const struct inode *inode) 901 { 902 return MINOR(inode->i_rdev); 903 } 904 905 static inline unsigned imajor(const struct inode *inode) 906 { 907 return MAJOR(inode->i_rdev); 908 } 909 910 extern struct block_device *I_BDEV(struct inode *inode); 911 912 struct fown_struct { 913 rwlock_t lock; /* protects pid, uid, euid fields */ 914 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */ 915 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */ 916 kuid_t uid, euid; /* uid/euid of process setting the owner */ 917 int signum; /* posix.1b rt signal to be delivered on IO */ 918 }; 919 920 /* 921 * Track a single file's readahead state 922 */ 923 struct file_ra_state { 924 pgoff_t start; /* where readahead started */ 925 unsigned int size; /* # of readahead pages */ 926 unsigned int async_size; /* do asynchronous readahead when 927 there are only # of pages ahead */ 928 929 unsigned int ra_pages; /* Maximum readahead window */ 930 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */ 931 loff_t prev_pos; /* Cache last read() position */ 932 }; 933 934 /* 935 * Check if @index falls in the readahead windows. 936 */ 937 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index) 938 { 939 return (index >= ra->start && 940 index < ra->start + ra->size); 941 } 942 943 struct file { 944 union { 945 struct llist_node fu_llist; 946 struct rcu_head fu_rcuhead; 947 } f_u; 948 struct path f_path; 949 struct inode *f_inode; /* cached value */ 950 const struct file_operations *f_op; 951 952 /* 953 * Protects f_ep_links, f_flags. 954 * Must not be taken from IRQ context. 955 */ 956 spinlock_t f_lock; 957 enum rw_hint f_write_hint; 958 atomic_long_t f_count; 959 unsigned int f_flags; 960 fmode_t f_mode; 961 struct mutex f_pos_lock; 962 loff_t f_pos; 963 struct fown_struct f_owner; 964 const struct cred *f_cred; 965 struct file_ra_state f_ra; 966 967 u64 f_version; 968 #ifdef CONFIG_SECURITY 969 void *f_security; 970 #endif 971 /* needed for tty driver, and maybe others */ 972 void *private_data; 973 974 #ifdef CONFIG_EPOLL 975 /* Used by fs/eventpoll.c to link all the hooks to this file */ 976 struct list_head f_ep_links; 977 struct list_head f_tfile_llink; 978 #endif /* #ifdef CONFIG_EPOLL */ 979 struct address_space *f_mapping; 980 errseq_t f_wb_err; 981 errseq_t f_sb_err; /* for syncfs */ 982 } __randomize_layout 983 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */ 984 985 struct file_handle { 986 __u32 handle_bytes; 987 int handle_type; 988 /* file identifier */ 989 unsigned char f_handle[]; 990 }; 991 992 static inline struct file *get_file(struct file *f) 993 { 994 atomic_long_inc(&f->f_count); 995 return f; 996 } 997 #define get_file_rcu_many(x, cnt) \ 998 atomic_long_add_unless(&(x)->f_count, (cnt), 0) 999 #define get_file_rcu(x) get_file_rcu_many((x), 1) 1000 #define file_count(x) atomic_long_read(&(x)->f_count) 1001 1002 #define MAX_NON_LFS ((1UL<<31) - 1) 1003 1004 /* Page cache limit. The filesystems should put that into their s_maxbytes 1005 limits, otherwise bad things can happen in VM. */ 1006 #if BITS_PER_LONG==32 1007 #define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT) 1008 #elif BITS_PER_LONG==64 1009 #define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX) 1010 #endif 1011 1012 #define FL_POSIX 1 1013 #define FL_FLOCK 2 1014 #define FL_DELEG 4 /* NFSv4 delegation */ 1015 #define FL_ACCESS 8 /* not trying to lock, just looking */ 1016 #define FL_EXISTS 16 /* when unlocking, test for existence */ 1017 #define FL_LEASE 32 /* lease held on this file */ 1018 #define FL_CLOSE 64 /* unlock on close */ 1019 #define FL_SLEEP 128 /* A blocking lock */ 1020 #define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */ 1021 #define FL_UNLOCK_PENDING 512 /* Lease is being broken */ 1022 #define FL_OFDLCK 1024 /* lock is "owned" by struct file */ 1023 #define FL_LAYOUT 2048 /* outstanding pNFS layout */ 1024 1025 #define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE) 1026 1027 /* 1028 * Special return value from posix_lock_file() and vfs_lock_file() for 1029 * asynchronous locking. 1030 */ 1031 #define FILE_LOCK_DEFERRED 1 1032 1033 /* legacy typedef, should eventually be removed */ 1034 typedef void *fl_owner_t; 1035 1036 struct file_lock; 1037 1038 struct file_lock_operations { 1039 void (*fl_copy_lock)(struct file_lock *, struct file_lock *); 1040 void (*fl_release_private)(struct file_lock *); 1041 }; 1042 1043 struct lock_manager_operations { 1044 fl_owner_t (*lm_get_owner)(fl_owner_t); 1045 void (*lm_put_owner)(fl_owner_t); 1046 void (*lm_notify)(struct file_lock *); /* unblock callback */ 1047 int (*lm_grant)(struct file_lock *, int); 1048 bool (*lm_break)(struct file_lock *); 1049 int (*lm_change)(struct file_lock *, int, struct list_head *); 1050 void (*lm_setup)(struct file_lock *, void **); 1051 bool (*lm_breaker_owns_lease)(struct file_lock *); 1052 }; 1053 1054 struct lock_manager { 1055 struct list_head list; 1056 /* 1057 * NFSv4 and up also want opens blocked during the grace period; 1058 * NLM doesn't care: 1059 */ 1060 bool block_opens; 1061 }; 1062 1063 struct net; 1064 void locks_start_grace(struct net *, struct lock_manager *); 1065 void locks_end_grace(struct lock_manager *); 1066 bool locks_in_grace(struct net *); 1067 bool opens_in_grace(struct net *); 1068 1069 /* that will die - we need it for nfs_lock_info */ 1070 #include <linux/nfs_fs_i.h> 1071 1072 /* 1073 * struct file_lock represents a generic "file lock". It's used to represent 1074 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to 1075 * note that the same struct is used to represent both a request for a lock and 1076 * the lock itself, but the same object is never used for both. 1077 * 1078 * FIXME: should we create a separate "struct lock_request" to help distinguish 1079 * these two uses? 1080 * 1081 * The varous i_flctx lists are ordered by: 1082 * 1083 * 1) lock owner 1084 * 2) lock range start 1085 * 3) lock range end 1086 * 1087 * Obviously, the last two criteria only matter for POSIX locks. 1088 */ 1089 struct file_lock { 1090 struct file_lock *fl_blocker; /* The lock, that is blocking us */ 1091 struct list_head fl_list; /* link into file_lock_context */ 1092 struct hlist_node fl_link; /* node in global lists */ 1093 struct list_head fl_blocked_requests; /* list of requests with 1094 * ->fl_blocker pointing here 1095 */ 1096 struct list_head fl_blocked_member; /* node in 1097 * ->fl_blocker->fl_blocked_requests 1098 */ 1099 fl_owner_t fl_owner; 1100 unsigned int fl_flags; 1101 unsigned char fl_type; 1102 unsigned int fl_pid; 1103 int fl_link_cpu; /* what cpu's list is this on? */ 1104 wait_queue_head_t fl_wait; 1105 struct file *fl_file; 1106 loff_t fl_start; 1107 loff_t fl_end; 1108 1109 struct fasync_struct * fl_fasync; /* for lease break notifications */ 1110 /* for lease breaks: */ 1111 unsigned long fl_break_time; 1112 unsigned long fl_downgrade_time; 1113 1114 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */ 1115 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */ 1116 union { 1117 struct nfs_lock_info nfs_fl; 1118 struct nfs4_lock_info nfs4_fl; 1119 struct { 1120 struct list_head link; /* link in AFS vnode's pending_locks list */ 1121 int state; /* state of grant or error if -ve */ 1122 unsigned int debug_id; 1123 } afs; 1124 } fl_u; 1125 } __randomize_layout; 1126 1127 struct file_lock_context { 1128 spinlock_t flc_lock; 1129 struct list_head flc_flock; 1130 struct list_head flc_posix; 1131 struct list_head flc_lease; 1132 }; 1133 1134 /* The following constant reflects the upper bound of the file/locking space */ 1135 #ifndef OFFSET_MAX 1136 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1))) 1137 #define OFFSET_MAX INT_LIMIT(loff_t) 1138 #define OFFT_OFFSET_MAX INT_LIMIT(off_t) 1139 #endif 1140 1141 extern void send_sigio(struct fown_struct *fown, int fd, int band); 1142 1143 #define locks_inode(f) file_inode(f) 1144 1145 #ifdef CONFIG_FILE_LOCKING 1146 extern int fcntl_getlk(struct file *, unsigned int, struct flock *); 1147 extern int fcntl_setlk(unsigned int, struct file *, unsigned int, 1148 struct flock *); 1149 1150 #if BITS_PER_LONG == 32 1151 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *); 1152 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int, 1153 struct flock64 *); 1154 #endif 1155 1156 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg); 1157 extern int fcntl_getlease(struct file *filp); 1158 1159 /* fs/locks.c */ 1160 void locks_free_lock_context(struct inode *inode); 1161 void locks_free_lock(struct file_lock *fl); 1162 extern void locks_init_lock(struct file_lock *); 1163 extern struct file_lock * locks_alloc_lock(void); 1164 extern void locks_copy_lock(struct file_lock *, struct file_lock *); 1165 extern void locks_copy_conflock(struct file_lock *, struct file_lock *); 1166 extern void locks_remove_posix(struct file *, fl_owner_t); 1167 extern void locks_remove_file(struct file *); 1168 extern void locks_release_private(struct file_lock *); 1169 extern void posix_test_lock(struct file *, struct file_lock *); 1170 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *); 1171 extern int locks_delete_block(struct file_lock *); 1172 extern int vfs_test_lock(struct file *, struct file_lock *); 1173 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *); 1174 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl); 1175 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl); 1176 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type); 1177 extern void lease_get_mtime(struct inode *, struct timespec64 *time); 1178 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv); 1179 extern int vfs_setlease(struct file *, long, struct file_lock **, void **); 1180 extern int lease_modify(struct file_lock *, int, struct list_head *); 1181 1182 struct notifier_block; 1183 extern int lease_register_notifier(struct notifier_block *); 1184 extern void lease_unregister_notifier(struct notifier_block *); 1185 1186 struct files_struct; 1187 extern void show_fd_locks(struct seq_file *f, 1188 struct file *filp, struct files_struct *files); 1189 #else /* !CONFIG_FILE_LOCKING */ 1190 static inline int fcntl_getlk(struct file *file, unsigned int cmd, 1191 struct flock __user *user) 1192 { 1193 return -EINVAL; 1194 } 1195 1196 static inline int fcntl_setlk(unsigned int fd, struct file *file, 1197 unsigned int cmd, struct flock __user *user) 1198 { 1199 return -EACCES; 1200 } 1201 1202 #if BITS_PER_LONG == 32 1203 static inline int fcntl_getlk64(struct file *file, unsigned int cmd, 1204 struct flock64 __user *user) 1205 { 1206 return -EINVAL; 1207 } 1208 1209 static inline int fcntl_setlk64(unsigned int fd, struct file *file, 1210 unsigned int cmd, struct flock64 __user *user) 1211 { 1212 return -EACCES; 1213 } 1214 #endif 1215 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg) 1216 { 1217 return -EINVAL; 1218 } 1219 1220 static inline int fcntl_getlease(struct file *filp) 1221 { 1222 return F_UNLCK; 1223 } 1224 1225 static inline void 1226 locks_free_lock_context(struct inode *inode) 1227 { 1228 } 1229 1230 static inline void locks_init_lock(struct file_lock *fl) 1231 { 1232 return; 1233 } 1234 1235 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl) 1236 { 1237 return; 1238 } 1239 1240 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl) 1241 { 1242 return; 1243 } 1244 1245 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner) 1246 { 1247 return; 1248 } 1249 1250 static inline void locks_remove_file(struct file *filp) 1251 { 1252 return; 1253 } 1254 1255 static inline void posix_test_lock(struct file *filp, struct file_lock *fl) 1256 { 1257 return; 1258 } 1259 1260 static inline int posix_lock_file(struct file *filp, struct file_lock *fl, 1261 struct file_lock *conflock) 1262 { 1263 return -ENOLCK; 1264 } 1265 1266 static inline int locks_delete_block(struct file_lock *waiter) 1267 { 1268 return -ENOENT; 1269 } 1270 1271 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl) 1272 { 1273 return 0; 1274 } 1275 1276 static inline int vfs_lock_file(struct file *filp, unsigned int cmd, 1277 struct file_lock *fl, struct file_lock *conf) 1278 { 1279 return -ENOLCK; 1280 } 1281 1282 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl) 1283 { 1284 return 0; 1285 } 1286 1287 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl) 1288 { 1289 return -ENOLCK; 1290 } 1291 1292 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type) 1293 { 1294 return 0; 1295 } 1296 1297 static inline void lease_get_mtime(struct inode *inode, 1298 struct timespec64 *time) 1299 { 1300 return; 1301 } 1302 1303 static inline int generic_setlease(struct file *filp, long arg, 1304 struct file_lock **flp, void **priv) 1305 { 1306 return -EINVAL; 1307 } 1308 1309 static inline int vfs_setlease(struct file *filp, long arg, 1310 struct file_lock **lease, void **priv) 1311 { 1312 return -EINVAL; 1313 } 1314 1315 static inline int lease_modify(struct file_lock *fl, int arg, 1316 struct list_head *dispose) 1317 { 1318 return -EINVAL; 1319 } 1320 1321 struct files_struct; 1322 static inline void show_fd_locks(struct seq_file *f, 1323 struct file *filp, struct files_struct *files) {} 1324 #endif /* !CONFIG_FILE_LOCKING */ 1325 1326 static inline struct inode *file_inode(const struct file *f) 1327 { 1328 return f->f_inode; 1329 } 1330 1331 static inline struct dentry *file_dentry(const struct file *file) 1332 { 1333 return d_real(file->f_path.dentry, file_inode(file)); 1334 } 1335 1336 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl) 1337 { 1338 return locks_lock_inode_wait(locks_inode(filp), fl); 1339 } 1340 1341 struct fasync_struct { 1342 rwlock_t fa_lock; 1343 int magic; 1344 int fa_fd; 1345 struct fasync_struct *fa_next; /* singly linked list */ 1346 struct file *fa_file; 1347 struct rcu_head fa_rcu; 1348 }; 1349 1350 #define FASYNC_MAGIC 0x4601 1351 1352 /* SMP safe fasync helpers: */ 1353 extern int fasync_helper(int, struct file *, int, struct fasync_struct **); 1354 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *); 1355 extern int fasync_remove_entry(struct file *, struct fasync_struct **); 1356 extern struct fasync_struct *fasync_alloc(void); 1357 extern void fasync_free(struct fasync_struct *); 1358 1359 /* can be called from interrupts */ 1360 extern void kill_fasync(struct fasync_struct **, int, int); 1361 1362 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force); 1363 extern int f_setown(struct file *filp, unsigned long arg, int force); 1364 extern void f_delown(struct file *filp); 1365 extern pid_t f_getown(struct file *filp); 1366 extern int send_sigurg(struct fown_struct *fown); 1367 1368 /* 1369 * sb->s_flags. Note that these mirror the equivalent MS_* flags where 1370 * represented in both. 1371 */ 1372 #define SB_RDONLY 1 /* Mount read-only */ 1373 #define SB_NOSUID 2 /* Ignore suid and sgid bits */ 1374 #define SB_NODEV 4 /* Disallow access to device special files */ 1375 #define SB_NOEXEC 8 /* Disallow program execution */ 1376 #define SB_SYNCHRONOUS 16 /* Writes are synced at once */ 1377 #define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */ 1378 #define SB_DIRSYNC 128 /* Directory modifications are synchronous */ 1379 #define SB_NOATIME 1024 /* Do not update access times. */ 1380 #define SB_NODIRATIME 2048 /* Do not update directory access times */ 1381 #define SB_SILENT 32768 1382 #define SB_POSIXACL (1<<16) /* VFS does not apply the umask */ 1383 #define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */ 1384 #define SB_I_VERSION (1<<23) /* Update inode I_version field */ 1385 #define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */ 1386 1387 /* These sb flags are internal to the kernel */ 1388 #define SB_SUBMOUNT (1<<26) 1389 #define SB_FORCE (1<<27) 1390 #define SB_NOSEC (1<<28) 1391 #define SB_BORN (1<<29) 1392 #define SB_ACTIVE (1<<30) 1393 #define SB_NOUSER (1<<31) 1394 1395 /* 1396 * Umount options 1397 */ 1398 1399 #define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */ 1400 #define MNT_DETACH 0x00000002 /* Just detach from the tree */ 1401 #define MNT_EXPIRE 0x00000004 /* Mark for expiry */ 1402 #define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */ 1403 #define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */ 1404 1405 /* sb->s_iflags */ 1406 #define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */ 1407 #define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */ 1408 #define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */ 1409 #define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */ 1410 1411 /* sb->s_iflags to limit user namespace mounts */ 1412 #define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */ 1413 #define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020 1414 #define SB_I_UNTRUSTED_MOUNTER 0x00000040 1415 1416 #define SB_I_SKIP_SYNC 0x00000100 /* Skip superblock at global sync */ 1417 1418 /* Possible states of 'frozen' field */ 1419 enum { 1420 SB_UNFROZEN = 0, /* FS is unfrozen */ 1421 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */ 1422 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */ 1423 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop 1424 * internal threads if needed) */ 1425 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */ 1426 }; 1427 1428 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1) 1429 1430 struct sb_writers { 1431 int frozen; /* Is sb frozen? */ 1432 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */ 1433 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS]; 1434 }; 1435 1436 struct super_block { 1437 struct list_head s_list; /* Keep this first */ 1438 dev_t s_dev; /* search index; _not_ kdev_t */ 1439 unsigned char s_blocksize_bits; 1440 unsigned long s_blocksize; 1441 loff_t s_maxbytes; /* Max file size */ 1442 struct file_system_type *s_type; 1443 const struct super_operations *s_op; 1444 const struct dquot_operations *dq_op; 1445 const struct quotactl_ops *s_qcop; 1446 const struct export_operations *s_export_op; 1447 unsigned long s_flags; 1448 unsigned long s_iflags; /* internal SB_I_* flags */ 1449 unsigned long s_magic; 1450 struct dentry *s_root; 1451 struct rw_semaphore s_umount; 1452 int s_count; 1453 atomic_t s_active; 1454 #ifdef CONFIG_SECURITY 1455 void *s_security; 1456 #endif 1457 const struct xattr_handler **s_xattr; 1458 #ifdef CONFIG_FS_ENCRYPTION 1459 const struct fscrypt_operations *s_cop; 1460 struct key *s_master_keys; /* master crypto keys in use */ 1461 #endif 1462 #ifdef CONFIG_FS_VERITY 1463 const struct fsverity_operations *s_vop; 1464 #endif 1465 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */ 1466 struct list_head s_mounts; /* list of mounts; _not_ for fs use */ 1467 struct block_device *s_bdev; 1468 struct backing_dev_info *s_bdi; 1469 struct mtd_info *s_mtd; 1470 struct hlist_node s_instances; 1471 unsigned int s_quota_types; /* Bitmask of supported quota types */ 1472 struct quota_info s_dquot; /* Diskquota specific options */ 1473 1474 struct sb_writers s_writers; 1475 1476 /* 1477 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and 1478 * s_fsnotify_marks together for cache efficiency. They are frequently 1479 * accessed and rarely modified. 1480 */ 1481 void *s_fs_info; /* Filesystem private info */ 1482 1483 /* Granularity of c/m/atime in ns (cannot be worse than a second) */ 1484 u32 s_time_gran; 1485 /* Time limits for c/m/atime in seconds */ 1486 time64_t s_time_min; 1487 time64_t s_time_max; 1488 #ifdef CONFIG_FSNOTIFY 1489 __u32 s_fsnotify_mask; 1490 struct fsnotify_mark_connector __rcu *s_fsnotify_marks; 1491 #endif 1492 1493 char s_id[32]; /* Informational name */ 1494 uuid_t s_uuid; /* UUID */ 1495 1496 unsigned int s_max_links; 1497 fmode_t s_mode; 1498 1499 /* 1500 * The next field is for VFS *only*. No filesystems have any business 1501 * even looking at it. You had been warned. 1502 */ 1503 struct mutex s_vfs_rename_mutex; /* Kludge */ 1504 1505 /* 1506 * Filesystem subtype. If non-empty the filesystem type field 1507 * in /proc/mounts will be "type.subtype" 1508 */ 1509 const char *s_subtype; 1510 1511 const struct dentry_operations *s_d_op; /* default d_op for dentries */ 1512 1513 /* 1514 * Saved pool identifier for cleancache (-1 means none) 1515 */ 1516 int cleancache_poolid; 1517 1518 struct shrinker s_shrink; /* per-sb shrinker handle */ 1519 1520 /* Number of inodes with nlink == 0 but still referenced */ 1521 atomic_long_t s_remove_count; 1522 1523 /* Pending fsnotify inode refs */ 1524 atomic_long_t s_fsnotify_inode_refs; 1525 1526 /* Being remounted read-only */ 1527 int s_readonly_remount; 1528 1529 /* per-sb errseq_t for reporting writeback errors via syncfs */ 1530 errseq_t s_wb_err; 1531 1532 /* AIO completions deferred from interrupt context */ 1533 struct workqueue_struct *s_dio_done_wq; 1534 struct hlist_head s_pins; 1535 1536 /* 1537 * Owning user namespace and default context in which to 1538 * interpret filesystem uids, gids, quotas, device nodes, 1539 * xattrs and security labels. 1540 */ 1541 struct user_namespace *s_user_ns; 1542 1543 /* 1544 * The list_lru structure is essentially just a pointer to a table 1545 * of per-node lru lists, each of which has its own spinlock. 1546 * There is no need to put them into separate cachelines. 1547 */ 1548 struct list_lru s_dentry_lru; 1549 struct list_lru s_inode_lru; 1550 struct rcu_head rcu; 1551 struct work_struct destroy_work; 1552 1553 struct mutex s_sync_lock; /* sync serialisation lock */ 1554 1555 /* 1556 * Indicates how deep in a filesystem stack this SB is 1557 */ 1558 int s_stack_depth; 1559 1560 /* s_inode_list_lock protects s_inodes */ 1561 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp; 1562 struct list_head s_inodes; /* all inodes */ 1563 1564 spinlock_t s_inode_wblist_lock; 1565 struct list_head s_inodes_wb; /* writeback inodes */ 1566 } __randomize_layout; 1567 1568 /* Helper functions so that in most cases filesystems will 1569 * not need to deal directly with kuid_t and kgid_t and can 1570 * instead deal with the raw numeric values that are stored 1571 * in the filesystem. 1572 */ 1573 static inline uid_t i_uid_read(const struct inode *inode) 1574 { 1575 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid); 1576 } 1577 1578 static inline gid_t i_gid_read(const struct inode *inode) 1579 { 1580 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid); 1581 } 1582 1583 static inline void i_uid_write(struct inode *inode, uid_t uid) 1584 { 1585 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid); 1586 } 1587 1588 static inline void i_gid_write(struct inode *inode, gid_t gid) 1589 { 1590 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid); 1591 } 1592 1593 extern struct timespec64 current_time(struct inode *inode); 1594 1595 /* 1596 * Snapshotting support. 1597 */ 1598 1599 void __sb_end_write(struct super_block *sb, int level); 1600 int __sb_start_write(struct super_block *sb, int level, bool wait); 1601 1602 #define __sb_writers_acquired(sb, lev) \ 1603 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_) 1604 #define __sb_writers_release(sb, lev) \ 1605 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_) 1606 1607 /** 1608 * sb_end_write - drop write access to a superblock 1609 * @sb: the super we wrote to 1610 * 1611 * Decrement number of writers to the filesystem. Wake up possible waiters 1612 * wanting to freeze the filesystem. 1613 */ 1614 static inline void sb_end_write(struct super_block *sb) 1615 { 1616 __sb_end_write(sb, SB_FREEZE_WRITE); 1617 } 1618 1619 /** 1620 * sb_end_pagefault - drop write access to a superblock from a page fault 1621 * @sb: the super we wrote to 1622 * 1623 * Decrement number of processes handling write page fault to the filesystem. 1624 * Wake up possible waiters wanting to freeze the filesystem. 1625 */ 1626 static inline void sb_end_pagefault(struct super_block *sb) 1627 { 1628 __sb_end_write(sb, SB_FREEZE_PAGEFAULT); 1629 } 1630 1631 /** 1632 * sb_end_intwrite - drop write access to a superblock for internal fs purposes 1633 * @sb: the super we wrote to 1634 * 1635 * Decrement fs-internal number of writers to the filesystem. Wake up possible 1636 * waiters wanting to freeze the filesystem. 1637 */ 1638 static inline void sb_end_intwrite(struct super_block *sb) 1639 { 1640 __sb_end_write(sb, SB_FREEZE_FS); 1641 } 1642 1643 /** 1644 * sb_start_write - get write access to a superblock 1645 * @sb: the super we write to 1646 * 1647 * When a process wants to write data or metadata to a file system (i.e. dirty 1648 * a page or an inode), it should embed the operation in a sb_start_write() - 1649 * sb_end_write() pair to get exclusion against file system freezing. This 1650 * function increments number of writers preventing freezing. If the file 1651 * system is already frozen, the function waits until the file system is 1652 * thawed. 1653 * 1654 * Since freeze protection behaves as a lock, users have to preserve 1655 * ordering of freeze protection and other filesystem locks. Generally, 1656 * freeze protection should be the outermost lock. In particular, we have: 1657 * 1658 * sb_start_write 1659 * -> i_mutex (write path, truncate, directory ops, ...) 1660 * -> s_umount (freeze_super, thaw_super) 1661 */ 1662 static inline void sb_start_write(struct super_block *sb) 1663 { 1664 __sb_start_write(sb, SB_FREEZE_WRITE, true); 1665 } 1666 1667 static inline int sb_start_write_trylock(struct super_block *sb) 1668 { 1669 return __sb_start_write(sb, SB_FREEZE_WRITE, false); 1670 } 1671 1672 /** 1673 * sb_start_pagefault - get write access to a superblock from a page fault 1674 * @sb: the super we write to 1675 * 1676 * When a process starts handling write page fault, it should embed the 1677 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get 1678 * exclusion against file system freezing. This is needed since the page fault 1679 * is going to dirty a page. This function increments number of running page 1680 * faults preventing freezing. If the file system is already frozen, the 1681 * function waits until the file system is thawed. 1682 * 1683 * Since page fault freeze protection behaves as a lock, users have to preserve 1684 * ordering of freeze protection and other filesystem locks. It is advised to 1685 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault 1686 * handling code implies lock dependency: 1687 * 1688 * mmap_lock 1689 * -> sb_start_pagefault 1690 */ 1691 static inline void sb_start_pagefault(struct super_block *sb) 1692 { 1693 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true); 1694 } 1695 1696 /* 1697 * sb_start_intwrite - get write access to a superblock for internal fs purposes 1698 * @sb: the super we write to 1699 * 1700 * This is the third level of protection against filesystem freezing. It is 1701 * free for use by a filesystem. The only requirement is that it must rank 1702 * below sb_start_pagefault. 1703 * 1704 * For example filesystem can call sb_start_intwrite() when starting a 1705 * transaction which somewhat eases handling of freezing for internal sources 1706 * of filesystem changes (internal fs threads, discarding preallocation on file 1707 * close, etc.). 1708 */ 1709 static inline void sb_start_intwrite(struct super_block *sb) 1710 { 1711 __sb_start_write(sb, SB_FREEZE_FS, true); 1712 } 1713 1714 static inline int sb_start_intwrite_trylock(struct super_block *sb) 1715 { 1716 return __sb_start_write(sb, SB_FREEZE_FS, false); 1717 } 1718 1719 1720 extern bool inode_owner_or_capable(const struct inode *inode); 1721 1722 /* 1723 * VFS helper functions.. 1724 */ 1725 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool); 1726 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t); 1727 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t); 1728 extern int vfs_symlink(struct inode *, struct dentry *, const char *); 1729 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **); 1730 extern int vfs_rmdir(struct inode *, struct dentry *); 1731 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **); 1732 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int); 1733 1734 static inline int vfs_whiteout(struct inode *dir, struct dentry *dentry) 1735 { 1736 return vfs_mknod(dir, dentry, S_IFCHR | WHITEOUT_MODE, WHITEOUT_DEV); 1737 } 1738 1739 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode, 1740 int open_flag); 1741 1742 int vfs_mkobj(struct dentry *, umode_t, 1743 int (*f)(struct dentry *, umode_t, void *), 1744 void *); 1745 1746 extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 1747 1748 #ifdef CONFIG_COMPAT 1749 extern long compat_ptr_ioctl(struct file *file, unsigned int cmd, 1750 unsigned long arg); 1751 #else 1752 #define compat_ptr_ioctl NULL 1753 #endif 1754 1755 /* 1756 * VFS file helper functions. 1757 */ 1758 extern void inode_init_owner(struct inode *inode, const struct inode *dir, 1759 umode_t mode); 1760 extern bool may_open_dev(const struct path *path); 1761 1762 /* 1763 * This is the "filldir" function type, used by readdir() to let 1764 * the kernel specify what kind of dirent layout it wants to have. 1765 * This allows the kernel to read directories into kernel space or 1766 * to have different dirent layouts depending on the binary type. 1767 */ 1768 struct dir_context; 1769 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64, 1770 unsigned); 1771 1772 struct dir_context { 1773 filldir_t actor; 1774 loff_t pos; 1775 }; 1776 1777 struct block_device_operations; 1778 1779 /* These macros are for out of kernel modules to test that 1780 * the kernel supports the unlocked_ioctl and compat_ioctl 1781 * fields in struct file_operations. */ 1782 #define HAVE_COMPAT_IOCTL 1 1783 #define HAVE_UNLOCKED_IOCTL 1 1784 1785 /* 1786 * These flags let !MMU mmap() govern direct device mapping vs immediate 1787 * copying more easily for MAP_PRIVATE, especially for ROM filesystems. 1788 * 1789 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE) 1790 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED) 1791 * NOMMU_MAP_READ: Can be mapped for reading 1792 * NOMMU_MAP_WRITE: Can be mapped for writing 1793 * NOMMU_MAP_EXEC: Can be mapped for execution 1794 */ 1795 #define NOMMU_MAP_COPY 0x00000001 1796 #define NOMMU_MAP_DIRECT 0x00000008 1797 #define NOMMU_MAP_READ VM_MAYREAD 1798 #define NOMMU_MAP_WRITE VM_MAYWRITE 1799 #define NOMMU_MAP_EXEC VM_MAYEXEC 1800 1801 #define NOMMU_VMFLAGS \ 1802 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC) 1803 1804 /* 1805 * These flags control the behavior of the remap_file_range function pointer. 1806 * If it is called with len == 0 that means "remap to end of source file". 1807 * See Documentation/filesystems/vfs.rst for more details about this call. 1808 * 1809 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate) 1810 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request 1811 */ 1812 #define REMAP_FILE_DEDUP (1 << 0) 1813 #define REMAP_FILE_CAN_SHORTEN (1 << 1) 1814 1815 /* 1816 * These flags signal that the caller is ok with altering various aspects of 1817 * the behavior of the remap operation. The changes must be made by the 1818 * implementation; the vfs remap helper functions can take advantage of them. 1819 * Flags in this category exist to preserve the quirky behavior of the hoisted 1820 * btrfs clone/dedupe ioctls. 1821 */ 1822 #define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN) 1823 1824 struct iov_iter; 1825 1826 struct file_operations { 1827 struct module *owner; 1828 loff_t (*llseek) (struct file *, loff_t, int); 1829 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *); 1830 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *); 1831 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *); 1832 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *); 1833 int (*iopoll)(struct kiocb *kiocb, bool spin); 1834 int (*iterate) (struct file *, struct dir_context *); 1835 int (*iterate_shared) (struct file *, struct dir_context *); 1836 __poll_t (*poll) (struct file *, struct poll_table_struct *); 1837 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long); 1838 long (*compat_ioctl) (struct file *, unsigned int, unsigned long); 1839 int (*mmap) (struct file *, struct vm_area_struct *); 1840 unsigned long mmap_supported_flags; 1841 int (*open) (struct inode *, struct file *); 1842 int (*flush) (struct file *, fl_owner_t id); 1843 int (*release) (struct inode *, struct file *); 1844 int (*fsync) (struct file *, loff_t, loff_t, int datasync); 1845 int (*fasync) (int, struct file *, int); 1846 int (*lock) (struct file *, int, struct file_lock *); 1847 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int); 1848 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long); 1849 int (*check_flags)(int); 1850 int (*flock) (struct file *, int, struct file_lock *); 1851 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int); 1852 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int); 1853 int (*setlease)(struct file *, long, struct file_lock **, void **); 1854 long (*fallocate)(struct file *file, int mode, loff_t offset, 1855 loff_t len); 1856 void (*show_fdinfo)(struct seq_file *m, struct file *f); 1857 #ifndef CONFIG_MMU 1858 unsigned (*mmap_capabilities)(struct file *); 1859 #endif 1860 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *, 1861 loff_t, size_t, unsigned int); 1862 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in, 1863 struct file *file_out, loff_t pos_out, 1864 loff_t len, unsigned int remap_flags); 1865 int (*fadvise)(struct file *, loff_t, loff_t, int); 1866 } __randomize_layout; 1867 1868 struct inode_operations { 1869 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int); 1870 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *); 1871 int (*permission) (struct inode *, int); 1872 struct posix_acl * (*get_acl)(struct inode *, int); 1873 1874 int (*readlink) (struct dentry *, char __user *,int); 1875 1876 int (*create) (struct inode *,struct dentry *, umode_t, bool); 1877 int (*link) (struct dentry *,struct inode *,struct dentry *); 1878 int (*unlink) (struct inode *,struct dentry *); 1879 int (*symlink) (struct inode *,struct dentry *,const char *); 1880 int (*mkdir) (struct inode *,struct dentry *,umode_t); 1881 int (*rmdir) (struct inode *,struct dentry *); 1882 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t); 1883 int (*rename) (struct inode *, struct dentry *, 1884 struct inode *, struct dentry *, unsigned int); 1885 int (*setattr) (struct dentry *, struct iattr *); 1886 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int); 1887 ssize_t (*listxattr) (struct dentry *, char *, size_t); 1888 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start, 1889 u64 len); 1890 int (*update_time)(struct inode *, struct timespec64 *, int); 1891 int (*atomic_open)(struct inode *, struct dentry *, 1892 struct file *, unsigned open_flag, 1893 umode_t create_mode); 1894 int (*tmpfile) (struct inode *, struct dentry *, umode_t); 1895 int (*set_acl)(struct inode *, struct posix_acl *, int); 1896 } ____cacheline_aligned; 1897 1898 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio, 1899 struct iov_iter *iter) 1900 { 1901 return file->f_op->read_iter(kio, iter); 1902 } 1903 1904 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio, 1905 struct iov_iter *iter) 1906 { 1907 return file->f_op->write_iter(kio, iter); 1908 } 1909 1910 static inline int call_mmap(struct file *file, struct vm_area_struct *vma) 1911 { 1912 return file->f_op->mmap(file, vma); 1913 } 1914 1915 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector, 1916 unsigned long nr_segs, unsigned long fast_segs, 1917 struct iovec *fast_pointer, 1918 struct iovec **ret_pointer); 1919 1920 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *); 1921 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *); 1922 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *); 1923 extern ssize_t vfs_readv(struct file *, const struct iovec __user *, 1924 unsigned long, loff_t *, rwf_t); 1925 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *, 1926 loff_t, size_t, unsigned int); 1927 extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in, 1928 struct file *file_out, loff_t pos_out, 1929 size_t len, unsigned int flags); 1930 extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in, 1931 struct file *file_out, loff_t pos_out, 1932 loff_t *count, 1933 unsigned int remap_flags); 1934 extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in, 1935 struct file *file_out, loff_t pos_out, 1936 loff_t len, unsigned int remap_flags); 1937 extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in, 1938 struct file *file_out, loff_t pos_out, 1939 loff_t len, unsigned int remap_flags); 1940 extern int vfs_dedupe_file_range(struct file *file, 1941 struct file_dedupe_range *same); 1942 extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos, 1943 struct file *dst_file, loff_t dst_pos, 1944 loff_t len, unsigned int remap_flags); 1945 1946 1947 struct super_operations { 1948 struct inode *(*alloc_inode)(struct super_block *sb); 1949 void (*destroy_inode)(struct inode *); 1950 void (*free_inode)(struct inode *); 1951 1952 void (*dirty_inode) (struct inode *, int flags); 1953 int (*write_inode) (struct inode *, struct writeback_control *wbc); 1954 int (*drop_inode) (struct inode *); 1955 void (*evict_inode) (struct inode *); 1956 void (*put_super) (struct super_block *); 1957 int (*sync_fs)(struct super_block *sb, int wait); 1958 int (*freeze_super) (struct super_block *); 1959 int (*freeze_fs) (struct super_block *); 1960 int (*thaw_super) (struct super_block *); 1961 int (*unfreeze_fs) (struct super_block *); 1962 int (*statfs) (struct dentry *, struct kstatfs *); 1963 int (*remount_fs) (struct super_block *, int *, char *); 1964 void (*umount_begin) (struct super_block *); 1965 1966 int (*show_options)(struct seq_file *, struct dentry *); 1967 int (*show_devname)(struct seq_file *, struct dentry *); 1968 int (*show_path)(struct seq_file *, struct dentry *); 1969 int (*show_stats)(struct seq_file *, struct dentry *); 1970 #ifdef CONFIG_QUOTA 1971 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t); 1972 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t); 1973 struct dquot **(*get_dquots)(struct inode *); 1974 #endif 1975 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t); 1976 long (*nr_cached_objects)(struct super_block *, 1977 struct shrink_control *); 1978 long (*free_cached_objects)(struct super_block *, 1979 struct shrink_control *); 1980 }; 1981 1982 /* 1983 * Inode flags - they have no relation to superblock flags now 1984 */ 1985 #define S_SYNC 1 /* Writes are synced at once */ 1986 #define S_NOATIME 2 /* Do not update access times */ 1987 #define S_APPEND 4 /* Append-only file */ 1988 #define S_IMMUTABLE 8 /* Immutable file */ 1989 #define S_DEAD 16 /* removed, but still open directory */ 1990 #define S_NOQUOTA 32 /* Inode is not counted to quota */ 1991 #define S_DIRSYNC 64 /* Directory modifications are synchronous */ 1992 #define S_NOCMTIME 128 /* Do not update file c/mtime */ 1993 #define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */ 1994 #define S_PRIVATE 512 /* Inode is fs-internal */ 1995 #define S_IMA 1024 /* Inode has an associated IMA struct */ 1996 #define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */ 1997 #define S_NOSEC 4096 /* no suid or xattr security attributes */ 1998 #ifdef CONFIG_FS_DAX 1999 #define S_DAX 8192 /* Direct Access, avoiding the page cache */ 2000 #else 2001 #define S_DAX 0 /* Make all the DAX code disappear */ 2002 #endif 2003 #define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */ 2004 #define S_CASEFOLD 32768 /* Casefolded file */ 2005 #define S_VERITY 65536 /* Verity file (using fs/verity/) */ 2006 2007 /* 2008 * Note that nosuid etc flags are inode-specific: setting some file-system 2009 * flags just means all the inodes inherit those flags by default. It might be 2010 * possible to override it selectively if you really wanted to with some 2011 * ioctl() that is not currently implemented. 2012 * 2013 * Exception: SB_RDONLY is always applied to the entire file system. 2014 * 2015 * Unfortunately, it is possible to change a filesystems flags with it mounted 2016 * with files in use. This means that all of the inodes will not have their 2017 * i_flags updated. Hence, i_flags no longer inherit the superblock mount 2018 * flags, so these have to be checked separately. -- [email protected] 2019 */ 2020 #define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg)) 2021 2022 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; } 2023 #define IS_RDONLY(inode) sb_rdonly((inode)->i_sb) 2024 #define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \ 2025 ((inode)->i_flags & S_SYNC)) 2026 #define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \ 2027 ((inode)->i_flags & (S_SYNC|S_DIRSYNC))) 2028 #define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK) 2029 #define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME) 2030 #define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION) 2031 2032 #define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA) 2033 #define IS_APPEND(inode) ((inode)->i_flags & S_APPEND) 2034 #define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE) 2035 #define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL) 2036 2037 #define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD) 2038 #define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME) 2039 #define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE) 2040 #define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE) 2041 #define IS_IMA(inode) ((inode)->i_flags & S_IMA) 2042 #define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT) 2043 #define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC) 2044 #define IS_DAX(inode) ((inode)->i_flags & S_DAX) 2045 #define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED) 2046 #define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD) 2047 #define IS_VERITY(inode) ((inode)->i_flags & S_VERITY) 2048 2049 #define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \ 2050 (inode)->i_rdev == WHITEOUT_DEV) 2051 2052 static inline bool HAS_UNMAPPED_ID(struct inode *inode) 2053 { 2054 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid); 2055 } 2056 2057 static inline enum rw_hint file_write_hint(struct file *file) 2058 { 2059 if (file->f_write_hint != WRITE_LIFE_NOT_SET) 2060 return file->f_write_hint; 2061 2062 return file_inode(file)->i_write_hint; 2063 } 2064 2065 static inline int iocb_flags(struct file *file); 2066 2067 static inline u16 ki_hint_validate(enum rw_hint hint) 2068 { 2069 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1; 2070 2071 if (hint <= max_hint) 2072 return hint; 2073 return 0; 2074 } 2075 2076 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp) 2077 { 2078 *kiocb = (struct kiocb) { 2079 .ki_filp = filp, 2080 .ki_flags = iocb_flags(filp), 2081 .ki_hint = ki_hint_validate(file_write_hint(filp)), 2082 .ki_ioprio = get_current_ioprio(), 2083 }; 2084 } 2085 2086 static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src, 2087 struct file *filp) 2088 { 2089 *kiocb = (struct kiocb) { 2090 .ki_filp = filp, 2091 .ki_flags = kiocb_src->ki_flags, 2092 .ki_hint = kiocb_src->ki_hint, 2093 .ki_ioprio = kiocb_src->ki_ioprio, 2094 .ki_pos = kiocb_src->ki_pos, 2095 }; 2096 } 2097 2098 /* 2099 * Inode state bits. Protected by inode->i_lock 2100 * 2101 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC, 2102 * I_DIRTY_DATASYNC and I_DIRTY_PAGES. 2103 * 2104 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW, 2105 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at 2106 * various stages of removing an inode. 2107 * 2108 * Two bits are used for locking and completion notification, I_NEW and I_SYNC. 2109 * 2110 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on 2111 * fdatasync(). i_atime is the usual cause. 2112 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of 2113 * these changes separately from I_DIRTY_SYNC so that we 2114 * don't have to write inode on fdatasync() when only 2115 * mtime has changed in it. 2116 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean. 2117 * I_NEW Serves as both a mutex and completion notification. 2118 * New inodes set I_NEW. If two processes both create 2119 * the same inode, one of them will release its inode and 2120 * wait for I_NEW to be released before returning. 2121 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can 2122 * also cause waiting on I_NEW, without I_NEW actually 2123 * being set. find_inode() uses this to prevent returning 2124 * nearly-dead inodes. 2125 * I_WILL_FREE Must be set when calling write_inode_now() if i_count 2126 * is zero. I_FREEING must be set when I_WILL_FREE is 2127 * cleared. 2128 * I_FREEING Set when inode is about to be freed but still has dirty 2129 * pages or buffers attached or the inode itself is still 2130 * dirty. 2131 * I_CLEAR Added by clear_inode(). In this state the inode is 2132 * clean and can be destroyed. Inode keeps I_FREEING. 2133 * 2134 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are 2135 * prohibited for many purposes. iget() must wait for 2136 * the inode to be completely released, then create it 2137 * anew. Other functions will just ignore such inodes, 2138 * if appropriate. I_NEW is used for waiting. 2139 * 2140 * I_SYNC Writeback of inode is running. The bit is set during 2141 * data writeback, and cleared with a wakeup on the bit 2142 * address once it is done. The bit is also used to pin 2143 * the inode in memory for flusher thread. 2144 * 2145 * I_REFERENCED Marks the inode as recently references on the LRU list. 2146 * 2147 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit(). 2148 * 2149 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to 2150 * synchronize competing switching instances and to tell 2151 * wb stat updates to grab the i_pages lock. See 2152 * inode_switch_wbs_work_fn() for details. 2153 * 2154 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper 2155 * and work dirs among overlayfs mounts. 2156 * 2157 * I_CREATING New object's inode in the middle of setting up. 2158 * 2159 * I_DONTCACHE Evict inode as soon as it is not used anymore. 2160 * 2161 * Q: What is the difference between I_WILL_FREE and I_FREEING? 2162 */ 2163 #define I_DIRTY_SYNC (1 << 0) 2164 #define I_DIRTY_DATASYNC (1 << 1) 2165 #define I_DIRTY_PAGES (1 << 2) 2166 #define __I_NEW 3 2167 #define I_NEW (1 << __I_NEW) 2168 #define I_WILL_FREE (1 << 4) 2169 #define I_FREEING (1 << 5) 2170 #define I_CLEAR (1 << 6) 2171 #define __I_SYNC 7 2172 #define I_SYNC (1 << __I_SYNC) 2173 #define I_REFERENCED (1 << 8) 2174 #define __I_DIO_WAKEUP 9 2175 #define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP) 2176 #define I_LINKABLE (1 << 10) 2177 #define I_DIRTY_TIME (1 << 11) 2178 #define __I_DIRTY_TIME_EXPIRED 12 2179 #define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED) 2180 #define I_WB_SWITCH (1 << 13) 2181 #define I_OVL_INUSE (1 << 14) 2182 #define I_CREATING (1 << 15) 2183 #define I_DONTCACHE (1 << 16) 2184 2185 #define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC) 2186 #define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES) 2187 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME) 2188 2189 extern void __mark_inode_dirty(struct inode *, int); 2190 static inline void mark_inode_dirty(struct inode *inode) 2191 { 2192 __mark_inode_dirty(inode, I_DIRTY); 2193 } 2194 2195 static inline void mark_inode_dirty_sync(struct inode *inode) 2196 { 2197 __mark_inode_dirty(inode, I_DIRTY_SYNC); 2198 } 2199 2200 extern void inc_nlink(struct inode *inode); 2201 extern void drop_nlink(struct inode *inode); 2202 extern void clear_nlink(struct inode *inode); 2203 extern void set_nlink(struct inode *inode, unsigned int nlink); 2204 2205 static inline void inode_inc_link_count(struct inode *inode) 2206 { 2207 inc_nlink(inode); 2208 mark_inode_dirty(inode); 2209 } 2210 2211 static inline void inode_dec_link_count(struct inode *inode) 2212 { 2213 drop_nlink(inode); 2214 mark_inode_dirty(inode); 2215 } 2216 2217 enum file_time_flags { 2218 S_ATIME = 1, 2219 S_MTIME = 2, 2220 S_CTIME = 4, 2221 S_VERSION = 8, 2222 }; 2223 2224 extern bool atime_needs_update(const struct path *, struct inode *); 2225 extern void touch_atime(const struct path *); 2226 static inline void file_accessed(struct file *file) 2227 { 2228 if (!(file->f_flags & O_NOATIME)) 2229 touch_atime(&file->f_path); 2230 } 2231 2232 extern int file_modified(struct file *file); 2233 2234 int sync_inode(struct inode *inode, struct writeback_control *wbc); 2235 int sync_inode_metadata(struct inode *inode, int wait); 2236 2237 struct file_system_type { 2238 const char *name; 2239 int fs_flags; 2240 #define FS_REQUIRES_DEV 1 2241 #define FS_BINARY_MOUNTDATA 2 2242 #define FS_HAS_SUBTYPE 4 2243 #define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */ 2244 #define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */ 2245 #define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */ 2246 int (*init_fs_context)(struct fs_context *); 2247 const struct fs_parameter_spec *parameters; 2248 struct dentry *(*mount) (struct file_system_type *, int, 2249 const char *, void *); 2250 void (*kill_sb) (struct super_block *); 2251 struct module *owner; 2252 struct file_system_type * next; 2253 struct hlist_head fs_supers; 2254 2255 struct lock_class_key s_lock_key; 2256 struct lock_class_key s_umount_key; 2257 struct lock_class_key s_vfs_rename_key; 2258 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS]; 2259 2260 struct lock_class_key i_lock_key; 2261 struct lock_class_key i_mutex_key; 2262 struct lock_class_key i_mutex_dir_key; 2263 }; 2264 2265 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME) 2266 2267 #ifdef CONFIG_BLOCK 2268 extern struct dentry *mount_bdev(struct file_system_type *fs_type, 2269 int flags, const char *dev_name, void *data, 2270 int (*fill_super)(struct super_block *, void *, int)); 2271 #else 2272 static inline struct dentry *mount_bdev(struct file_system_type *fs_type, 2273 int flags, const char *dev_name, void *data, 2274 int (*fill_super)(struct super_block *, void *, int)) 2275 { 2276 return ERR_PTR(-ENODEV); 2277 } 2278 #endif 2279 extern struct dentry *mount_single(struct file_system_type *fs_type, 2280 int flags, void *data, 2281 int (*fill_super)(struct super_block *, void *, int)); 2282 extern struct dentry *mount_nodev(struct file_system_type *fs_type, 2283 int flags, void *data, 2284 int (*fill_super)(struct super_block *, void *, int)); 2285 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path); 2286 void generic_shutdown_super(struct super_block *sb); 2287 #ifdef CONFIG_BLOCK 2288 void kill_block_super(struct super_block *sb); 2289 #else 2290 static inline void kill_block_super(struct super_block *sb) 2291 { 2292 BUG(); 2293 } 2294 #endif 2295 void kill_anon_super(struct super_block *sb); 2296 void kill_litter_super(struct super_block *sb); 2297 void deactivate_super(struct super_block *sb); 2298 void deactivate_locked_super(struct super_block *sb); 2299 int set_anon_super(struct super_block *s, void *data); 2300 int set_anon_super_fc(struct super_block *s, struct fs_context *fc); 2301 int get_anon_bdev(dev_t *); 2302 void free_anon_bdev(dev_t); 2303 struct super_block *sget_fc(struct fs_context *fc, 2304 int (*test)(struct super_block *, struct fs_context *), 2305 int (*set)(struct super_block *, struct fs_context *)); 2306 struct super_block *sget(struct file_system_type *type, 2307 int (*test)(struct super_block *,void *), 2308 int (*set)(struct super_block *,void *), 2309 int flags, void *data); 2310 2311 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */ 2312 #define fops_get(fops) \ 2313 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL)) 2314 #define fops_put(fops) \ 2315 do { if (fops) module_put((fops)->owner); } while(0) 2316 /* 2317 * This one is to be used *ONLY* from ->open() instances. 2318 * fops must be non-NULL, pinned down *and* module dependencies 2319 * should be sufficient to pin the caller down as well. 2320 */ 2321 #define replace_fops(f, fops) \ 2322 do { \ 2323 struct file *__file = (f); \ 2324 fops_put(__file->f_op); \ 2325 BUG_ON(!(__file->f_op = (fops))); \ 2326 } while(0) 2327 2328 extern int register_filesystem(struct file_system_type *); 2329 extern int unregister_filesystem(struct file_system_type *); 2330 extern struct vfsmount *kern_mount(struct file_system_type *); 2331 extern void kern_unmount(struct vfsmount *mnt); 2332 extern int may_umount_tree(struct vfsmount *); 2333 extern int may_umount(struct vfsmount *); 2334 extern long do_mount(const char *, const char __user *, 2335 const char *, unsigned long, void *); 2336 extern struct vfsmount *collect_mounts(const struct path *); 2337 extern void drop_collected_mounts(struct vfsmount *); 2338 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *, 2339 struct vfsmount *); 2340 extern int vfs_statfs(const struct path *, struct kstatfs *); 2341 extern int user_statfs(const char __user *, struct kstatfs *); 2342 extern int fd_statfs(int, struct kstatfs *); 2343 extern int freeze_super(struct super_block *super); 2344 extern int thaw_super(struct super_block *super); 2345 extern bool our_mnt(struct vfsmount *mnt); 2346 extern __printf(2, 3) 2347 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...); 2348 extern int super_setup_bdi(struct super_block *sb); 2349 2350 extern int current_umask(void); 2351 2352 extern void ihold(struct inode * inode); 2353 extern void iput(struct inode *); 2354 extern int generic_update_time(struct inode *, struct timespec64 *, int); 2355 2356 /* /sys/fs */ 2357 extern struct kobject *fs_kobj; 2358 2359 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK) 2360 2361 #ifdef CONFIG_MANDATORY_FILE_LOCKING 2362 extern int locks_mandatory_locked(struct file *); 2363 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char); 2364 2365 /* 2366 * Candidates for mandatory locking have the setgid bit set 2367 * but no group execute bit - an otherwise meaningless combination. 2368 */ 2369 2370 static inline int __mandatory_lock(struct inode *ino) 2371 { 2372 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID; 2373 } 2374 2375 /* 2376 * ... and these candidates should be on SB_MANDLOCK mounted fs, 2377 * otherwise these will be advisory locks 2378 */ 2379 2380 static inline int mandatory_lock(struct inode *ino) 2381 { 2382 return IS_MANDLOCK(ino) && __mandatory_lock(ino); 2383 } 2384 2385 static inline int locks_verify_locked(struct file *file) 2386 { 2387 if (mandatory_lock(locks_inode(file))) 2388 return locks_mandatory_locked(file); 2389 return 0; 2390 } 2391 2392 static inline int locks_verify_truncate(struct inode *inode, 2393 struct file *f, 2394 loff_t size) 2395 { 2396 if (!inode->i_flctx || !mandatory_lock(inode)) 2397 return 0; 2398 2399 if (size < inode->i_size) { 2400 return locks_mandatory_area(inode, f, size, inode->i_size - 1, 2401 F_WRLCK); 2402 } else { 2403 return locks_mandatory_area(inode, f, inode->i_size, size - 1, 2404 F_WRLCK); 2405 } 2406 } 2407 2408 #else /* !CONFIG_MANDATORY_FILE_LOCKING */ 2409 2410 static inline int locks_mandatory_locked(struct file *file) 2411 { 2412 return 0; 2413 } 2414 2415 static inline int locks_mandatory_area(struct inode *inode, struct file *filp, 2416 loff_t start, loff_t end, unsigned char type) 2417 { 2418 return 0; 2419 } 2420 2421 static inline int __mandatory_lock(struct inode *inode) 2422 { 2423 return 0; 2424 } 2425 2426 static inline int mandatory_lock(struct inode *inode) 2427 { 2428 return 0; 2429 } 2430 2431 static inline int locks_verify_locked(struct file *file) 2432 { 2433 return 0; 2434 } 2435 2436 static inline int locks_verify_truncate(struct inode *inode, struct file *filp, 2437 size_t size) 2438 { 2439 return 0; 2440 } 2441 2442 #endif /* CONFIG_MANDATORY_FILE_LOCKING */ 2443 2444 2445 #ifdef CONFIG_FILE_LOCKING 2446 static inline int break_lease(struct inode *inode, unsigned int mode) 2447 { 2448 /* 2449 * Since this check is lockless, we must ensure that any refcounts 2450 * taken are done before checking i_flctx->flc_lease. Otherwise, we 2451 * could end up racing with tasks trying to set a new lease on this 2452 * file. 2453 */ 2454 smp_mb(); 2455 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease)) 2456 return __break_lease(inode, mode, FL_LEASE); 2457 return 0; 2458 } 2459 2460 static inline int break_deleg(struct inode *inode, unsigned int mode) 2461 { 2462 /* 2463 * Since this check is lockless, we must ensure that any refcounts 2464 * taken are done before checking i_flctx->flc_lease. Otherwise, we 2465 * could end up racing with tasks trying to set a new lease on this 2466 * file. 2467 */ 2468 smp_mb(); 2469 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease)) 2470 return __break_lease(inode, mode, FL_DELEG); 2471 return 0; 2472 } 2473 2474 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode) 2475 { 2476 int ret; 2477 2478 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK); 2479 if (ret == -EWOULDBLOCK && delegated_inode) { 2480 *delegated_inode = inode; 2481 ihold(inode); 2482 } 2483 return ret; 2484 } 2485 2486 static inline int break_deleg_wait(struct inode **delegated_inode) 2487 { 2488 int ret; 2489 2490 ret = break_deleg(*delegated_inode, O_WRONLY); 2491 iput(*delegated_inode); 2492 *delegated_inode = NULL; 2493 return ret; 2494 } 2495 2496 static inline int break_layout(struct inode *inode, bool wait) 2497 { 2498 smp_mb(); 2499 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease)) 2500 return __break_lease(inode, 2501 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK, 2502 FL_LAYOUT); 2503 return 0; 2504 } 2505 2506 #else /* !CONFIG_FILE_LOCKING */ 2507 static inline int break_lease(struct inode *inode, unsigned int mode) 2508 { 2509 return 0; 2510 } 2511 2512 static inline int break_deleg(struct inode *inode, unsigned int mode) 2513 { 2514 return 0; 2515 } 2516 2517 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode) 2518 { 2519 return 0; 2520 } 2521 2522 static inline int break_deleg_wait(struct inode **delegated_inode) 2523 { 2524 BUG(); 2525 return 0; 2526 } 2527 2528 static inline int break_layout(struct inode *inode, bool wait) 2529 { 2530 return 0; 2531 } 2532 2533 #endif /* CONFIG_FILE_LOCKING */ 2534 2535 /* fs/open.c */ 2536 struct audit_names; 2537 struct filename { 2538 const char *name; /* pointer to actual string */ 2539 const __user char *uptr; /* original userland pointer */ 2540 int refcnt; 2541 struct audit_names *aname; 2542 const char iname[]; 2543 }; 2544 static_assert(offsetof(struct filename, iname) % sizeof(long) == 0); 2545 2546 extern long vfs_truncate(const struct path *, loff_t); 2547 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs, 2548 struct file *filp); 2549 extern int vfs_fallocate(struct file *file, int mode, loff_t offset, 2550 loff_t len); 2551 extern long do_sys_open(int dfd, const char __user *filename, int flags, 2552 umode_t mode); 2553 extern struct file *file_open_name(struct filename *, int, umode_t); 2554 extern struct file *filp_open(const char *, int, umode_t); 2555 extern struct file *file_open_root(struct dentry *, struct vfsmount *, 2556 const char *, int, umode_t); 2557 extern struct file * dentry_open(const struct path *, int, const struct cred *); 2558 extern struct file * open_with_fake_path(const struct path *, int, 2559 struct inode*, const struct cred *); 2560 static inline struct file *file_clone_open(struct file *file) 2561 { 2562 return dentry_open(&file->f_path, file->f_flags, file->f_cred); 2563 } 2564 extern int filp_close(struct file *, fl_owner_t id); 2565 2566 extern struct filename *getname_flags(const char __user *, int, int *); 2567 extern struct filename *getname(const char __user *); 2568 extern struct filename *getname_kernel(const char *); 2569 extern void putname(struct filename *name); 2570 2571 extern int finish_open(struct file *file, struct dentry *dentry, 2572 int (*open)(struct inode *, struct file *)); 2573 extern int finish_no_open(struct file *file, struct dentry *dentry); 2574 2575 /* fs/dcache.c */ 2576 extern void __init vfs_caches_init_early(void); 2577 extern void __init vfs_caches_init(void); 2578 2579 extern struct kmem_cache *names_cachep; 2580 2581 #define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL) 2582 #define __putname(name) kmem_cache_free(names_cachep, (void *)(name)) 2583 2584 #ifdef CONFIG_BLOCK 2585 extern int register_blkdev(unsigned int, const char *); 2586 extern void unregister_blkdev(unsigned int, const char *); 2587 extern struct block_device *bdget(dev_t); 2588 extern struct block_device *bdgrab(struct block_device *bdev); 2589 extern void bd_set_size(struct block_device *, loff_t size); 2590 extern void bd_forget(struct inode *inode); 2591 extern void bdput(struct block_device *); 2592 extern void invalidate_bdev(struct block_device *); 2593 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *); 2594 extern int sync_blockdev(struct block_device *bdev); 2595 extern void kill_bdev(struct block_device *); 2596 extern struct super_block *freeze_bdev(struct block_device *); 2597 extern void emergency_thaw_all(void); 2598 extern void emergency_thaw_bdev(struct super_block *sb); 2599 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb); 2600 extern int fsync_bdev(struct block_device *); 2601 2602 extern struct super_block *blockdev_superblock; 2603 2604 static inline bool sb_is_blkdev_sb(struct super_block *sb) 2605 { 2606 return sb == blockdev_superblock; 2607 } 2608 #else 2609 static inline void bd_forget(struct inode *inode) {} 2610 static inline int sync_blockdev(struct block_device *bdev) { return 0; } 2611 static inline void kill_bdev(struct block_device *bdev) {} 2612 static inline void invalidate_bdev(struct block_device *bdev) {} 2613 2614 static inline struct super_block *freeze_bdev(struct block_device *sb) 2615 { 2616 return NULL; 2617 } 2618 2619 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb) 2620 { 2621 return 0; 2622 } 2623 2624 static inline int emergency_thaw_bdev(struct super_block *sb) 2625 { 2626 return 0; 2627 } 2628 2629 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg) 2630 { 2631 } 2632 2633 static inline bool sb_is_blkdev_sb(struct super_block *sb) 2634 { 2635 return false; 2636 } 2637 #endif 2638 extern int sync_filesystem(struct super_block *); 2639 extern const struct file_operations def_blk_fops; 2640 extern const struct file_operations def_chr_fops; 2641 #ifdef CONFIG_BLOCK 2642 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long); 2643 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long); 2644 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder); 2645 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode, 2646 void *holder); 2647 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode, 2648 void *holder); 2649 extern struct block_device *bd_start_claiming(struct block_device *bdev, 2650 void *holder); 2651 extern void bd_finish_claiming(struct block_device *bdev, 2652 struct block_device *whole, void *holder); 2653 extern void bd_abort_claiming(struct block_device *bdev, 2654 struct block_device *whole, void *holder); 2655 extern void blkdev_put(struct block_device *bdev, fmode_t mode); 2656 2657 #ifdef CONFIG_SYSFS 2658 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk); 2659 extern void bd_unlink_disk_holder(struct block_device *bdev, 2660 struct gendisk *disk); 2661 #else 2662 static inline int bd_link_disk_holder(struct block_device *bdev, 2663 struct gendisk *disk) 2664 { 2665 return 0; 2666 } 2667 static inline void bd_unlink_disk_holder(struct block_device *bdev, 2668 struct gendisk *disk) 2669 { 2670 } 2671 #endif 2672 #endif 2673 2674 /* fs/char_dev.c */ 2675 #define CHRDEV_MAJOR_MAX 512 2676 /* Marks the bottom of the first segment of free char majors */ 2677 #define CHRDEV_MAJOR_DYN_END 234 2678 /* Marks the top and bottom of the second segment of free char majors */ 2679 #define CHRDEV_MAJOR_DYN_EXT_START 511 2680 #define CHRDEV_MAJOR_DYN_EXT_END 384 2681 2682 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *); 2683 extern int register_chrdev_region(dev_t, unsigned, const char *); 2684 extern int __register_chrdev(unsigned int major, unsigned int baseminor, 2685 unsigned int count, const char *name, 2686 const struct file_operations *fops); 2687 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor, 2688 unsigned int count, const char *name); 2689 extern void unregister_chrdev_region(dev_t, unsigned); 2690 extern void chrdev_show(struct seq_file *,off_t); 2691 2692 static inline int register_chrdev(unsigned int major, const char *name, 2693 const struct file_operations *fops) 2694 { 2695 return __register_chrdev(major, 0, 256, name, fops); 2696 } 2697 2698 static inline void unregister_chrdev(unsigned int major, const char *name) 2699 { 2700 __unregister_chrdev(major, 0, 256, name); 2701 } 2702 2703 /* fs/block_dev.c */ 2704 #define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */ 2705 #define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */ 2706 2707 #ifdef CONFIG_BLOCK 2708 #define BLKDEV_MAJOR_MAX 512 2709 extern const char *bdevname(struct block_device *bdev, char *buffer); 2710 extern struct block_device *lookup_bdev(const char *); 2711 extern void blkdev_show(struct seq_file *,off_t); 2712 2713 #else 2714 #define BLKDEV_MAJOR_MAX 0 2715 #endif 2716 2717 extern void init_special_inode(struct inode *, umode_t, dev_t); 2718 2719 /* Invalid inode operations -- fs/bad_inode.c */ 2720 extern void make_bad_inode(struct inode *); 2721 extern bool is_bad_inode(struct inode *); 2722 2723 #ifdef CONFIG_BLOCK 2724 extern int revalidate_disk(struct gendisk *); 2725 extern int check_disk_change(struct block_device *); 2726 extern int __invalidate_device(struct block_device *, bool); 2727 #endif 2728 unsigned long invalidate_mapping_pages(struct address_space *mapping, 2729 pgoff_t start, pgoff_t end); 2730 2731 static inline void invalidate_remote_inode(struct inode *inode) 2732 { 2733 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) || 2734 S_ISLNK(inode->i_mode)) 2735 invalidate_mapping_pages(inode->i_mapping, 0, -1); 2736 } 2737 extern int invalidate_inode_pages2(struct address_space *mapping); 2738 extern int invalidate_inode_pages2_range(struct address_space *mapping, 2739 pgoff_t start, pgoff_t end); 2740 extern int write_inode_now(struct inode *, int); 2741 extern int filemap_fdatawrite(struct address_space *); 2742 extern int filemap_flush(struct address_space *); 2743 extern int filemap_fdatawait_keep_errors(struct address_space *mapping); 2744 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart, 2745 loff_t lend); 2746 extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping, 2747 loff_t start_byte, loff_t end_byte); 2748 2749 static inline int filemap_fdatawait(struct address_space *mapping) 2750 { 2751 return filemap_fdatawait_range(mapping, 0, LLONG_MAX); 2752 } 2753 2754 extern bool filemap_range_has_page(struct address_space *, loff_t lstart, 2755 loff_t lend); 2756 extern int filemap_write_and_wait_range(struct address_space *mapping, 2757 loff_t lstart, loff_t lend); 2758 extern int __filemap_fdatawrite_range(struct address_space *mapping, 2759 loff_t start, loff_t end, int sync_mode); 2760 extern int filemap_fdatawrite_range(struct address_space *mapping, 2761 loff_t start, loff_t end); 2762 extern int filemap_check_errors(struct address_space *mapping); 2763 extern void __filemap_set_wb_err(struct address_space *mapping, int err); 2764 2765 static inline int filemap_write_and_wait(struct address_space *mapping) 2766 { 2767 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX); 2768 } 2769 2770 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart, 2771 loff_t lend); 2772 extern int __must_check file_check_and_advance_wb_err(struct file *file); 2773 extern int __must_check file_write_and_wait_range(struct file *file, 2774 loff_t start, loff_t end); 2775 2776 static inline int file_write_and_wait(struct file *file) 2777 { 2778 return file_write_and_wait_range(file, 0, LLONG_MAX); 2779 } 2780 2781 /** 2782 * filemap_set_wb_err - set a writeback error on an address_space 2783 * @mapping: mapping in which to set writeback error 2784 * @err: error to be set in mapping 2785 * 2786 * When writeback fails in some way, we must record that error so that 2787 * userspace can be informed when fsync and the like are called. We endeavor 2788 * to report errors on any file that was open at the time of the error. Some 2789 * internal callers also need to know when writeback errors have occurred. 2790 * 2791 * When a writeback error occurs, most filesystems will want to call 2792 * filemap_set_wb_err to record the error in the mapping so that it will be 2793 * automatically reported whenever fsync is called on the file. 2794 */ 2795 static inline void filemap_set_wb_err(struct address_space *mapping, int err) 2796 { 2797 /* Fastpath for common case of no error */ 2798 if (unlikely(err)) 2799 __filemap_set_wb_err(mapping, err); 2800 } 2801 2802 /** 2803 * filemap_check_wb_error - has an error occurred since the mark was sampled? 2804 * @mapping: mapping to check for writeback errors 2805 * @since: previously-sampled errseq_t 2806 * 2807 * Grab the errseq_t value from the mapping, and see if it has changed "since" 2808 * the given value was sampled. 2809 * 2810 * If it has then report the latest error set, otherwise return 0. 2811 */ 2812 static inline int filemap_check_wb_err(struct address_space *mapping, 2813 errseq_t since) 2814 { 2815 return errseq_check(&mapping->wb_err, since); 2816 } 2817 2818 /** 2819 * filemap_sample_wb_err - sample the current errseq_t to test for later errors 2820 * @mapping: mapping to be sampled 2821 * 2822 * Writeback errors are always reported relative to a particular sample point 2823 * in the past. This function provides those sample points. 2824 */ 2825 static inline errseq_t filemap_sample_wb_err(struct address_space *mapping) 2826 { 2827 return errseq_sample(&mapping->wb_err); 2828 } 2829 2830 /** 2831 * file_sample_sb_err - sample the current errseq_t to test for later errors 2832 * @mapping: mapping to be sampled 2833 * 2834 * Grab the most current superblock-level errseq_t value for the given 2835 * struct file. 2836 */ 2837 static inline errseq_t file_sample_sb_err(struct file *file) 2838 { 2839 return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err); 2840 } 2841 2842 static inline int filemap_nr_thps(struct address_space *mapping) 2843 { 2844 #ifdef CONFIG_READ_ONLY_THP_FOR_FS 2845 return atomic_read(&mapping->nr_thps); 2846 #else 2847 return 0; 2848 #endif 2849 } 2850 2851 static inline void filemap_nr_thps_inc(struct address_space *mapping) 2852 { 2853 #ifdef CONFIG_READ_ONLY_THP_FOR_FS 2854 atomic_inc(&mapping->nr_thps); 2855 #else 2856 WARN_ON_ONCE(1); 2857 #endif 2858 } 2859 2860 static inline void filemap_nr_thps_dec(struct address_space *mapping) 2861 { 2862 #ifdef CONFIG_READ_ONLY_THP_FOR_FS 2863 atomic_dec(&mapping->nr_thps); 2864 #else 2865 WARN_ON_ONCE(1); 2866 #endif 2867 } 2868 2869 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end, 2870 int datasync); 2871 extern int vfs_fsync(struct file *file, int datasync); 2872 2873 extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes, 2874 unsigned int flags); 2875 2876 /* 2877 * Sync the bytes written if this was a synchronous write. Expect ki_pos 2878 * to already be updated for the write, and will return either the amount 2879 * of bytes passed in, or an error if syncing the file failed. 2880 */ 2881 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count) 2882 { 2883 if (iocb->ki_flags & IOCB_DSYNC) { 2884 int ret = vfs_fsync_range(iocb->ki_filp, 2885 iocb->ki_pos - count, iocb->ki_pos - 1, 2886 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1); 2887 if (ret) 2888 return ret; 2889 } 2890 2891 return count; 2892 } 2893 2894 extern void emergency_sync(void); 2895 extern void emergency_remount(void); 2896 2897 #ifdef CONFIG_BLOCK 2898 extern int bmap(struct inode *inode, sector_t *block); 2899 #else 2900 static inline int bmap(struct inode *inode, sector_t *block) 2901 { 2902 return -EINVAL; 2903 } 2904 #endif 2905 2906 extern int notify_change(struct dentry *, struct iattr *, struct inode **); 2907 extern int inode_permission(struct inode *, int); 2908 extern int generic_permission(struct inode *, int); 2909 extern int __check_sticky(struct inode *dir, struct inode *inode); 2910 2911 static inline bool execute_ok(struct inode *inode) 2912 { 2913 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode); 2914 } 2915 2916 static inline void file_start_write(struct file *file) 2917 { 2918 if (!S_ISREG(file_inode(file)->i_mode)) 2919 return; 2920 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true); 2921 } 2922 2923 static inline bool file_start_write_trylock(struct file *file) 2924 { 2925 if (!S_ISREG(file_inode(file)->i_mode)) 2926 return true; 2927 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false); 2928 } 2929 2930 static inline void file_end_write(struct file *file) 2931 { 2932 if (!S_ISREG(file_inode(file)->i_mode)) 2933 return; 2934 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE); 2935 } 2936 2937 /* 2938 * get_write_access() gets write permission for a file. 2939 * put_write_access() releases this write permission. 2940 * This is used for regular files. 2941 * We cannot support write (and maybe mmap read-write shared) accesses and 2942 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode 2943 * can have the following values: 2944 * 0: no writers, no VM_DENYWRITE mappings 2945 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist 2946 * > 0: (i_writecount) users are writing to the file. 2947 * 2948 * Normally we operate on that counter with atomic_{inc,dec} and it's safe 2949 * except for the cases where we don't hold i_writecount yet. Then we need to 2950 * use {get,deny}_write_access() - these functions check the sign and refuse 2951 * to do the change if sign is wrong. 2952 */ 2953 static inline int get_write_access(struct inode *inode) 2954 { 2955 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY; 2956 } 2957 static inline int deny_write_access(struct file *file) 2958 { 2959 struct inode *inode = file_inode(file); 2960 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY; 2961 } 2962 static inline void put_write_access(struct inode * inode) 2963 { 2964 atomic_dec(&inode->i_writecount); 2965 } 2966 static inline void allow_write_access(struct file *file) 2967 { 2968 if (file) 2969 atomic_inc(&file_inode(file)->i_writecount); 2970 } 2971 static inline bool inode_is_open_for_write(const struct inode *inode) 2972 { 2973 return atomic_read(&inode->i_writecount) > 0; 2974 } 2975 2976 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING) 2977 static inline void i_readcount_dec(struct inode *inode) 2978 { 2979 BUG_ON(!atomic_read(&inode->i_readcount)); 2980 atomic_dec(&inode->i_readcount); 2981 } 2982 static inline void i_readcount_inc(struct inode *inode) 2983 { 2984 atomic_inc(&inode->i_readcount); 2985 } 2986 #else 2987 static inline void i_readcount_dec(struct inode *inode) 2988 { 2989 return; 2990 } 2991 static inline void i_readcount_inc(struct inode *inode) 2992 { 2993 return; 2994 } 2995 #endif 2996 extern int do_pipe_flags(int *, int); 2997 2998 #define __kernel_read_file_id(id) \ 2999 id(UNKNOWN, unknown) \ 3000 id(FIRMWARE, firmware) \ 3001 id(FIRMWARE_PREALLOC_BUFFER, firmware) \ 3002 id(FIRMWARE_EFI_EMBEDDED, firmware) \ 3003 id(MODULE, kernel-module) \ 3004 id(KEXEC_IMAGE, kexec-image) \ 3005 id(KEXEC_INITRAMFS, kexec-initramfs) \ 3006 id(POLICY, security-policy) \ 3007 id(X509_CERTIFICATE, x509-certificate) \ 3008 id(MAX_ID, ) 3009 3010 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM, 3011 #define __fid_stringify(dummy, str) #str, 3012 3013 enum kernel_read_file_id { 3014 __kernel_read_file_id(__fid_enumify) 3015 }; 3016 3017 static const char * const kernel_read_file_str[] = { 3018 __kernel_read_file_id(__fid_stringify) 3019 }; 3020 3021 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id) 3022 { 3023 if ((unsigned)id >= READING_MAX_ID) 3024 return kernel_read_file_str[READING_UNKNOWN]; 3025 3026 return kernel_read_file_str[id]; 3027 } 3028 3029 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t, 3030 enum kernel_read_file_id); 3031 extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t, 3032 enum kernel_read_file_id); 3033 extern int kernel_read_file_from_path_initns(const char *, void **, loff_t *, loff_t, 3034 enum kernel_read_file_id); 3035 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t, 3036 enum kernel_read_file_id); 3037 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *); 3038 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *); 3039 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *); 3040 extern struct file * open_exec(const char *); 3041 3042 /* fs/dcache.c -- generic fs support functions */ 3043 extern bool is_subdir(struct dentry *, struct dentry *); 3044 extern bool path_is_under(const struct path *, const struct path *); 3045 3046 extern char *file_path(struct file *, char *, int); 3047 3048 #include <linux/err.h> 3049 3050 /* needed for stackable file system support */ 3051 extern loff_t default_llseek(struct file *file, loff_t offset, int whence); 3052 3053 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence); 3054 3055 extern int inode_init_always(struct super_block *, struct inode *); 3056 extern void inode_init_once(struct inode *); 3057 extern void address_space_init_once(struct address_space *mapping); 3058 extern struct inode * igrab(struct inode *); 3059 extern ino_t iunique(struct super_block *, ino_t); 3060 extern int inode_needs_sync(struct inode *inode); 3061 extern int generic_delete_inode(struct inode *inode); 3062 static inline int generic_drop_inode(struct inode *inode) 3063 { 3064 return !inode->i_nlink || inode_unhashed(inode) || 3065 (inode->i_state & I_DONTCACHE); 3066 } 3067 extern void d_mark_dontcache(struct inode *inode); 3068 3069 extern struct inode *ilookup5_nowait(struct super_block *sb, 3070 unsigned long hashval, int (*test)(struct inode *, void *), 3071 void *data); 3072 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval, 3073 int (*test)(struct inode *, void *), void *data); 3074 extern struct inode *ilookup(struct super_block *sb, unsigned long ino); 3075 3076 extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval, 3077 int (*test)(struct inode *, void *), 3078 int (*set)(struct inode *, void *), 3079 void *data); 3080 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *); 3081 extern struct inode * iget_locked(struct super_block *, unsigned long); 3082 extern struct inode *find_inode_nowait(struct super_block *, 3083 unsigned long, 3084 int (*match)(struct inode *, 3085 unsigned long, void *), 3086 void *data); 3087 extern struct inode *find_inode_rcu(struct super_block *, unsigned long, 3088 int (*)(struct inode *, void *), void *); 3089 extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long); 3090 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *); 3091 extern int insert_inode_locked(struct inode *); 3092 #ifdef CONFIG_DEBUG_LOCK_ALLOC 3093 extern void lockdep_annotate_inode_mutex_key(struct inode *inode); 3094 #else 3095 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { }; 3096 #endif 3097 extern void unlock_new_inode(struct inode *); 3098 extern void discard_new_inode(struct inode *); 3099 extern unsigned int get_next_ino(void); 3100 extern void evict_inodes(struct super_block *sb); 3101 3102 extern void __iget(struct inode * inode); 3103 extern void iget_failed(struct inode *); 3104 extern void clear_inode(struct inode *); 3105 extern void __destroy_inode(struct inode *); 3106 extern struct inode *new_inode_pseudo(struct super_block *sb); 3107 extern struct inode *new_inode(struct super_block *sb); 3108 extern void free_inode_nonrcu(struct inode *inode); 3109 extern int should_remove_suid(struct dentry *); 3110 extern int file_remove_privs(struct file *); 3111 3112 extern void __insert_inode_hash(struct inode *, unsigned long hashval); 3113 static inline void insert_inode_hash(struct inode *inode) 3114 { 3115 __insert_inode_hash(inode, inode->i_ino); 3116 } 3117 3118 extern void __remove_inode_hash(struct inode *); 3119 static inline void remove_inode_hash(struct inode *inode) 3120 { 3121 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash)) 3122 __remove_inode_hash(inode); 3123 } 3124 3125 extern void inode_sb_list_add(struct inode *inode); 3126 3127 #ifdef CONFIG_BLOCK 3128 extern int bdev_read_only(struct block_device *); 3129 #endif 3130 extern int set_blocksize(struct block_device *, int); 3131 extern int sb_set_blocksize(struct super_block *, int); 3132 extern int sb_min_blocksize(struct super_block *, int); 3133 3134 extern int generic_file_mmap(struct file *, struct vm_area_struct *); 3135 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *); 3136 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *); 3137 extern int generic_remap_checks(struct file *file_in, loff_t pos_in, 3138 struct file *file_out, loff_t pos_out, 3139 loff_t *count, unsigned int remap_flags); 3140 extern int generic_file_rw_checks(struct file *file_in, struct file *file_out); 3141 extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in, 3142 struct file *file_out, loff_t pos_out, 3143 size_t *count, unsigned int flags); 3144 extern ssize_t generic_file_buffered_read(struct kiocb *iocb, 3145 struct iov_iter *to, ssize_t already_read); 3146 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *); 3147 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *); 3148 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *); 3149 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *); 3150 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t); 3151 3152 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos, 3153 rwf_t flags); 3154 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos, 3155 rwf_t flags); 3156 ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb, 3157 struct iov_iter *iter); 3158 ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb, 3159 struct iov_iter *iter); 3160 3161 /* fs/block_dev.c */ 3162 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to); 3163 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from); 3164 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end, 3165 int datasync); 3166 extern void block_sync_page(struct page *page); 3167 3168 /* fs/splice.c */ 3169 extern ssize_t generic_file_splice_read(struct file *, loff_t *, 3170 struct pipe_inode_info *, size_t, unsigned int); 3171 extern ssize_t iter_file_splice_write(struct pipe_inode_info *, 3172 struct file *, loff_t *, size_t, unsigned int); 3173 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, 3174 struct file *out, loff_t *, size_t len, unsigned int flags); 3175 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out, 3176 loff_t *opos, size_t len, unsigned int flags); 3177 3178 3179 extern void 3180 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping); 3181 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence); 3182 extern loff_t no_llseek(struct file *file, loff_t offset, int whence); 3183 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize); 3184 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence); 3185 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset, 3186 int whence, loff_t maxsize, loff_t eof); 3187 extern loff_t fixed_size_llseek(struct file *file, loff_t offset, 3188 int whence, loff_t size); 3189 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t); 3190 extern loff_t no_seek_end_llseek(struct file *, loff_t, int); 3191 extern int generic_file_open(struct inode * inode, struct file * filp); 3192 extern int nonseekable_open(struct inode * inode, struct file * filp); 3193 extern int stream_open(struct inode * inode, struct file * filp); 3194 3195 #ifdef CONFIG_BLOCK 3196 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode, 3197 loff_t file_offset); 3198 3199 enum { 3200 /* need locking between buffered and direct access */ 3201 DIO_LOCKING = 0x01, 3202 3203 /* filesystem does not support filling holes */ 3204 DIO_SKIP_HOLES = 0x02, 3205 }; 3206 3207 void dio_end_io(struct bio *bio); 3208 3209 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode, 3210 struct block_device *bdev, struct iov_iter *iter, 3211 get_block_t get_block, 3212 dio_iodone_t end_io, dio_submit_t submit_io, 3213 int flags); 3214 3215 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb, 3216 struct inode *inode, 3217 struct iov_iter *iter, 3218 get_block_t get_block) 3219 { 3220 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter, 3221 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES); 3222 } 3223 #endif 3224 3225 void inode_dio_wait(struct inode *inode); 3226 3227 /* 3228 * inode_dio_begin - signal start of a direct I/O requests 3229 * @inode: inode the direct I/O happens on 3230 * 3231 * This is called once we've finished processing a direct I/O request, 3232 * and is used to wake up callers waiting for direct I/O to be quiesced. 3233 */ 3234 static inline void inode_dio_begin(struct inode *inode) 3235 { 3236 atomic_inc(&inode->i_dio_count); 3237 } 3238 3239 /* 3240 * inode_dio_end - signal finish of a direct I/O requests 3241 * @inode: inode the direct I/O happens on 3242 * 3243 * This is called once we've finished processing a direct I/O request, 3244 * and is used to wake up callers waiting for direct I/O to be quiesced. 3245 */ 3246 static inline void inode_dio_end(struct inode *inode) 3247 { 3248 if (atomic_dec_and_test(&inode->i_dio_count)) 3249 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP); 3250 } 3251 3252 /* 3253 * Warn about a page cache invalidation failure diring a direct I/O write. 3254 */ 3255 void dio_warn_stale_pagecache(struct file *filp); 3256 3257 extern void inode_set_flags(struct inode *inode, unsigned int flags, 3258 unsigned int mask); 3259 3260 extern const struct file_operations generic_ro_fops; 3261 3262 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m)) 3263 3264 extern int readlink_copy(char __user *, int, const char *); 3265 extern int page_readlink(struct dentry *, char __user *, int); 3266 extern const char *page_get_link(struct dentry *, struct inode *, 3267 struct delayed_call *); 3268 extern void page_put_link(void *); 3269 extern int __page_symlink(struct inode *inode, const char *symname, int len, 3270 int nofs); 3271 extern int page_symlink(struct inode *inode, const char *symname, int len); 3272 extern const struct inode_operations page_symlink_inode_operations; 3273 extern void kfree_link(void *); 3274 extern void generic_fillattr(struct inode *, struct kstat *); 3275 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int); 3276 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int); 3277 void __inode_add_bytes(struct inode *inode, loff_t bytes); 3278 void inode_add_bytes(struct inode *inode, loff_t bytes); 3279 void __inode_sub_bytes(struct inode *inode, loff_t bytes); 3280 void inode_sub_bytes(struct inode *inode, loff_t bytes); 3281 static inline loff_t __inode_get_bytes(struct inode *inode) 3282 { 3283 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes; 3284 } 3285 loff_t inode_get_bytes(struct inode *inode); 3286 void inode_set_bytes(struct inode *inode, loff_t bytes); 3287 const char *simple_get_link(struct dentry *, struct inode *, 3288 struct delayed_call *); 3289 extern const struct inode_operations simple_symlink_inode_operations; 3290 3291 extern int iterate_dir(struct file *, struct dir_context *); 3292 3293 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32); 3294 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int); 3295 3296 static inline int vfs_stat(const char __user *filename, struct kstat *stat) 3297 { 3298 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT, 3299 stat, STATX_BASIC_STATS); 3300 } 3301 static inline int vfs_lstat(const char __user *name, struct kstat *stat) 3302 { 3303 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT, 3304 stat, STATX_BASIC_STATS); 3305 } 3306 static inline int vfs_fstatat(int dfd, const char __user *filename, 3307 struct kstat *stat, int flags) 3308 { 3309 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT, 3310 stat, STATX_BASIC_STATS); 3311 } 3312 static inline int vfs_fstat(int fd, struct kstat *stat) 3313 { 3314 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0); 3315 } 3316 3317 3318 extern const char *vfs_get_link(struct dentry *, struct delayed_call *); 3319 extern int vfs_readlink(struct dentry *, char __user *, int); 3320 3321 extern struct file_system_type *get_filesystem(struct file_system_type *fs); 3322 extern void put_filesystem(struct file_system_type *fs); 3323 extern struct file_system_type *get_fs_type(const char *name); 3324 extern struct super_block *get_super(struct block_device *); 3325 extern struct super_block *get_super_thawed(struct block_device *); 3326 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev); 3327 extern struct super_block *get_active_super(struct block_device *bdev); 3328 extern void drop_super(struct super_block *sb); 3329 extern void drop_super_exclusive(struct super_block *sb); 3330 extern void iterate_supers(void (*)(struct super_block *, void *), void *); 3331 extern void iterate_supers_type(struct file_system_type *, 3332 void (*)(struct super_block *, void *), void *); 3333 3334 extern int dcache_dir_open(struct inode *, struct file *); 3335 extern int dcache_dir_close(struct inode *, struct file *); 3336 extern loff_t dcache_dir_lseek(struct file *, loff_t, int); 3337 extern int dcache_readdir(struct file *, struct dir_context *); 3338 extern int simple_setattr(struct dentry *, struct iattr *); 3339 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int); 3340 extern int simple_statfs(struct dentry *, struct kstatfs *); 3341 extern int simple_open(struct inode *inode, struct file *file); 3342 extern int simple_link(struct dentry *, struct inode *, struct dentry *); 3343 extern int simple_unlink(struct inode *, struct dentry *); 3344 extern int simple_rmdir(struct inode *, struct dentry *); 3345 extern int simple_rename(struct inode *, struct dentry *, 3346 struct inode *, struct dentry *, unsigned int); 3347 extern void simple_recursive_removal(struct dentry *, 3348 void (*callback)(struct dentry *)); 3349 extern int noop_fsync(struct file *, loff_t, loff_t, int); 3350 extern int noop_set_page_dirty(struct page *page); 3351 extern void noop_invalidatepage(struct page *page, unsigned int offset, 3352 unsigned int length); 3353 extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter); 3354 extern int simple_empty(struct dentry *); 3355 extern int simple_readpage(struct file *file, struct page *page); 3356 extern int simple_write_begin(struct file *file, struct address_space *mapping, 3357 loff_t pos, unsigned len, unsigned flags, 3358 struct page **pagep, void **fsdata); 3359 extern int simple_write_end(struct file *file, struct address_space *mapping, 3360 loff_t pos, unsigned len, unsigned copied, 3361 struct page *page, void *fsdata); 3362 extern int always_delete_dentry(const struct dentry *); 3363 extern struct inode *alloc_anon_inode(struct super_block *); 3364 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **); 3365 extern const struct dentry_operations simple_dentry_operations; 3366 3367 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags); 3368 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *); 3369 extern const struct file_operations simple_dir_operations; 3370 extern const struct inode_operations simple_dir_inode_operations; 3371 extern void make_empty_dir_inode(struct inode *inode); 3372 extern bool is_empty_dir_inode(struct inode *inode); 3373 struct tree_descr { const char *name; const struct file_operations *ops; int mode; }; 3374 struct dentry *d_alloc_name(struct dentry *, const char *); 3375 extern int simple_fill_super(struct super_block *, unsigned long, 3376 const struct tree_descr *); 3377 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count); 3378 extern void simple_release_fs(struct vfsmount **mount, int *count); 3379 3380 extern ssize_t simple_read_from_buffer(void __user *to, size_t count, 3381 loff_t *ppos, const void *from, size_t available); 3382 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos, 3383 const void __user *from, size_t count); 3384 3385 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int); 3386 extern int generic_file_fsync(struct file *, loff_t, loff_t, int); 3387 3388 extern int generic_check_addressable(unsigned, u64); 3389 3390 #ifdef CONFIG_MIGRATION 3391 extern int buffer_migrate_page(struct address_space *, 3392 struct page *, struct page *, 3393 enum migrate_mode); 3394 extern int buffer_migrate_page_norefs(struct address_space *, 3395 struct page *, struct page *, 3396 enum migrate_mode); 3397 #else 3398 #define buffer_migrate_page NULL 3399 #define buffer_migrate_page_norefs NULL 3400 #endif 3401 3402 extern int setattr_prepare(struct dentry *, struct iattr *); 3403 extern int inode_newsize_ok(const struct inode *, loff_t offset); 3404 extern void setattr_copy(struct inode *inode, const struct iattr *attr); 3405 3406 extern int file_update_time(struct file *file); 3407 3408 static inline bool vma_is_dax(const struct vm_area_struct *vma) 3409 { 3410 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host); 3411 } 3412 3413 static inline bool vma_is_fsdax(struct vm_area_struct *vma) 3414 { 3415 struct inode *inode; 3416 3417 if (!vma->vm_file) 3418 return false; 3419 if (!vma_is_dax(vma)) 3420 return false; 3421 inode = file_inode(vma->vm_file); 3422 if (S_ISCHR(inode->i_mode)) 3423 return false; /* device-dax */ 3424 return true; 3425 } 3426 3427 static inline int iocb_flags(struct file *file) 3428 { 3429 int res = 0; 3430 if (file->f_flags & O_APPEND) 3431 res |= IOCB_APPEND; 3432 if (file->f_flags & O_DIRECT) 3433 res |= IOCB_DIRECT; 3434 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host)) 3435 res |= IOCB_DSYNC; 3436 if (file->f_flags & __O_SYNC) 3437 res |= IOCB_SYNC; 3438 return res; 3439 } 3440 3441 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags) 3442 { 3443 if (unlikely(flags & ~RWF_SUPPORTED)) 3444 return -EOPNOTSUPP; 3445 3446 if (flags & RWF_NOWAIT) { 3447 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT)) 3448 return -EOPNOTSUPP; 3449 ki->ki_flags |= IOCB_NOWAIT; 3450 } 3451 if (flags & RWF_HIPRI) 3452 ki->ki_flags |= IOCB_HIPRI; 3453 if (flags & RWF_DSYNC) 3454 ki->ki_flags |= IOCB_DSYNC; 3455 if (flags & RWF_SYNC) 3456 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC); 3457 if (flags & RWF_APPEND) 3458 ki->ki_flags |= IOCB_APPEND; 3459 return 0; 3460 } 3461 3462 static inline ino_t parent_ino(struct dentry *dentry) 3463 { 3464 ino_t res; 3465 3466 /* 3467 * Don't strictly need d_lock here? If the parent ino could change 3468 * then surely we'd have a deeper race in the caller? 3469 */ 3470 spin_lock(&dentry->d_lock); 3471 res = dentry->d_parent->d_inode->i_ino; 3472 spin_unlock(&dentry->d_lock); 3473 return res; 3474 } 3475 3476 /* Transaction based IO helpers */ 3477 3478 /* 3479 * An argresp is stored in an allocated page and holds the 3480 * size of the argument or response, along with its content 3481 */ 3482 struct simple_transaction_argresp { 3483 ssize_t size; 3484 char data[0]; 3485 }; 3486 3487 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp)) 3488 3489 char *simple_transaction_get(struct file *file, const char __user *buf, 3490 size_t size); 3491 ssize_t simple_transaction_read(struct file *file, char __user *buf, 3492 size_t size, loff_t *pos); 3493 int simple_transaction_release(struct inode *inode, struct file *file); 3494 3495 void simple_transaction_set(struct file *file, size_t n); 3496 3497 /* 3498 * simple attribute files 3499 * 3500 * These attributes behave similar to those in sysfs: 3501 * 3502 * Writing to an attribute immediately sets a value, an open file can be 3503 * written to multiple times. 3504 * 3505 * Reading from an attribute creates a buffer from the value that might get 3506 * read with multiple read calls. When the attribute has been read 3507 * completely, no further read calls are possible until the file is opened 3508 * again. 3509 * 3510 * All attributes contain a text representation of a numeric value 3511 * that are accessed with the get() and set() functions. 3512 */ 3513 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \ 3514 static int __fops ## _open(struct inode *inode, struct file *file) \ 3515 { \ 3516 __simple_attr_check_format(__fmt, 0ull); \ 3517 return simple_attr_open(inode, file, __get, __set, __fmt); \ 3518 } \ 3519 static const struct file_operations __fops = { \ 3520 .owner = THIS_MODULE, \ 3521 .open = __fops ## _open, \ 3522 .release = simple_attr_release, \ 3523 .read = simple_attr_read, \ 3524 .write = simple_attr_write, \ 3525 .llseek = generic_file_llseek, \ 3526 } 3527 3528 static inline __printf(1, 2) 3529 void __simple_attr_check_format(const char *fmt, ...) 3530 { 3531 /* don't do anything, just let the compiler check the arguments; */ 3532 } 3533 3534 int simple_attr_open(struct inode *inode, struct file *file, 3535 int (*get)(void *, u64 *), int (*set)(void *, u64), 3536 const char *fmt); 3537 int simple_attr_release(struct inode *inode, struct file *file); 3538 ssize_t simple_attr_read(struct file *file, char __user *buf, 3539 size_t len, loff_t *ppos); 3540 ssize_t simple_attr_write(struct file *file, const char __user *buf, 3541 size_t len, loff_t *ppos); 3542 3543 struct ctl_table; 3544 int proc_nr_files(struct ctl_table *table, int write, 3545 void *buffer, size_t *lenp, loff_t *ppos); 3546 int proc_nr_dentry(struct ctl_table *table, int write, 3547 void *buffer, size_t *lenp, loff_t *ppos); 3548 int proc_nr_inodes(struct ctl_table *table, int write, 3549 void *buffer, size_t *lenp, loff_t *ppos); 3550 int __init get_filesystem_list(char *buf); 3551 3552 #define __FMODE_EXEC ((__force int) FMODE_EXEC) 3553 #define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY) 3554 3555 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE]) 3556 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \ 3557 (flag & __FMODE_NONOTIFY))) 3558 3559 static inline bool is_sxid(umode_t mode) 3560 { 3561 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP)); 3562 } 3563 3564 static inline int check_sticky(struct inode *dir, struct inode *inode) 3565 { 3566 if (!(dir->i_mode & S_ISVTX)) 3567 return 0; 3568 3569 return __check_sticky(dir, inode); 3570 } 3571 3572 static inline void inode_has_no_xattr(struct inode *inode) 3573 { 3574 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC)) 3575 inode->i_flags |= S_NOSEC; 3576 } 3577 3578 static inline bool is_root_inode(struct inode *inode) 3579 { 3580 return inode == inode->i_sb->s_root->d_inode; 3581 } 3582 3583 static inline bool dir_emit(struct dir_context *ctx, 3584 const char *name, int namelen, 3585 u64 ino, unsigned type) 3586 { 3587 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0; 3588 } 3589 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx) 3590 { 3591 return ctx->actor(ctx, ".", 1, ctx->pos, 3592 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0; 3593 } 3594 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx) 3595 { 3596 return ctx->actor(ctx, "..", 2, ctx->pos, 3597 parent_ino(file->f_path.dentry), DT_DIR) == 0; 3598 } 3599 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx) 3600 { 3601 if (ctx->pos == 0) { 3602 if (!dir_emit_dot(file, ctx)) 3603 return false; 3604 ctx->pos = 1; 3605 } 3606 if (ctx->pos == 1) { 3607 if (!dir_emit_dotdot(file, ctx)) 3608 return false; 3609 ctx->pos = 2; 3610 } 3611 return true; 3612 } 3613 static inline bool dir_relax(struct inode *inode) 3614 { 3615 inode_unlock(inode); 3616 inode_lock(inode); 3617 return !IS_DEADDIR(inode); 3618 } 3619 3620 static inline bool dir_relax_shared(struct inode *inode) 3621 { 3622 inode_unlock_shared(inode); 3623 inode_lock_shared(inode); 3624 return !IS_DEADDIR(inode); 3625 } 3626 3627 extern bool path_noexec(const struct path *path); 3628 extern void inode_nohighmem(struct inode *inode); 3629 3630 /* mm/fadvise.c */ 3631 extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len, 3632 int advice); 3633 extern int generic_fadvise(struct file *file, loff_t offset, loff_t len, 3634 int advice); 3635 3636 #if defined(CONFIG_IO_URING) 3637 extern struct sock *io_uring_get_socket(struct file *file); 3638 #else 3639 static inline struct sock *io_uring_get_socket(struct file *file) 3640 { 3641 return NULL; 3642 } 3643 #endif 3644 3645 int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags, 3646 unsigned int flags); 3647 3648 int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa, 3649 struct fsxattr *fa); 3650 3651 static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags) 3652 { 3653 memset(fa, 0, sizeof(*fa)); 3654 fa->fsx_xflags = xflags; 3655 } 3656 3657 /* 3658 * Flush file data before changing attributes. Caller must hold any locks 3659 * required to prevent further writes to this file until we're done setting 3660 * flags. 3661 */ 3662 static inline int inode_drain_writes(struct inode *inode) 3663 { 3664 inode_dio_wait(inode); 3665 return filemap_write_and_wait(inode->i_mapping); 3666 } 3667 3668 #endif /* _LINUX_FS_H */ 3669