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