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