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