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