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