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