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