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