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