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