1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/linkage.h>
6 #include <linux/wait_bit.h>
7 #include <linux/kdev_t.h>
8 #include <linux/dcache.h>
9 #include <linux/path.h>
10 #include <linux/stat.h>
11 #include <linux/cache.h>
12 #include <linux/list.h>
13 #include <linux/list_lru.h>
14 #include <linux/llist.h>
15 #include <linux/radix-tree.h>
16 #include <linux/xarray.h>
17 #include <linux/rbtree.h>
18 #include <linux/init.h>
19 #include <linux/pid.h>
20 #include <linux/bug.h>
21 #include <linux/mutex.h>
22 #include <linux/rwsem.h>
23 #include <linux/mm_types.h>
24 #include <linux/capability.h>
25 #include <linux/semaphore.h>
26 #include <linux/fcntl.h>
27 #include <linux/rculist_bl.h>
28 #include <linux/atomic.h>
29 #include <linux/shrinker.h>
30 #include <linux/migrate_mode.h>
31 #include <linux/uidgid.h>
32 #include <linux/lockdep.h>
33 #include <linux/percpu-rwsem.h>
34 #include <linux/workqueue.h>
35 #include <linux/delayed_call.h>
36 #include <linux/uuid.h>
37 #include <linux/errseq.h>
38 #include <linux/ioprio.h>
39 #include <linux/fs_types.h>
40 #include <linux/build_bug.h>
41 #include <linux/stddef.h>
43 #include <asm/byteorder.h>
44 #include <uapi/linux/fs.h>
46 struct backing_dev_info;
49 struct export_operations;
50 struct fiemap_extent_info;
55 struct pipe_inode_info;
56 struct poll_table_struct;
58 struct vm_area_struct;
61 struct swap_info_struct;
63 struct workqueue_struct;
66 struct fscrypt_operations;
68 struct fsverity_operations;
70 struct fs_parameter_spec;
72 extern void __init inode_init(void);
73 extern void __init inode_init_early(void);
74 extern void __init files_init(void);
75 extern void __init files_maxfiles_init(void);
77 extern struct files_stat_struct files_stat;
78 extern unsigned long get_max_files(void);
79 extern unsigned int sysctl_nr_open;
80 extern struct inodes_stat_t inodes_stat;
81 extern int leases_enable, lease_break_time;
82 extern int sysctl_protected_symlinks;
83 extern int sysctl_protected_hardlinks;
84 extern int sysctl_protected_fifos;
85 extern int sysctl_protected_regular;
87 typedef __kernel_rwf_t rwf_t;
90 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
91 struct buffer_head *bh_result, int create);
92 typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
93 ssize_t bytes, void *private);
95 #define MAY_EXEC 0x00000001
96 #define MAY_WRITE 0x00000002
97 #define MAY_READ 0x00000004
98 #define MAY_APPEND 0x00000008
99 #define MAY_ACCESS 0x00000010
100 #define MAY_OPEN 0x00000020
101 #define MAY_CHDIR 0x00000040
102 /* called from RCU mode, don't block */
103 #define MAY_NOT_BLOCK 0x00000080
106 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
107 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
110 /* file is open for reading */
111 #define FMODE_READ ((__force fmode_t)0x1)
112 /* file is open for writing */
113 #define FMODE_WRITE ((__force fmode_t)0x2)
114 /* file is seekable */
115 #define FMODE_LSEEK ((__force fmode_t)0x4)
116 /* file can be accessed using pread */
117 #define FMODE_PREAD ((__force fmode_t)0x8)
118 /* file can be accessed using pwrite */
119 #define FMODE_PWRITE ((__force fmode_t)0x10)
120 /* File is opened for execution with sys_execve / sys_uselib */
121 #define FMODE_EXEC ((__force fmode_t)0x20)
122 /* File is opened with O_NDELAY (only set for block devices) */
123 #define FMODE_NDELAY ((__force fmode_t)0x40)
124 /* File is opened with O_EXCL (only set for block devices) */
125 #define FMODE_EXCL ((__force fmode_t)0x80)
126 /* File is opened using open(.., 3, ..) and is writeable only for ioctls
127 (specialy hack for floppy.c) */
128 #define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
129 /* 32bit hashes as llseek() offset (for directories) */
130 #define FMODE_32BITHASH ((__force fmode_t)0x200)
131 /* 64bit hashes as llseek() offset (for directories) */
132 #define FMODE_64BITHASH ((__force fmode_t)0x400)
135 * Don't update ctime and mtime.
137 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
138 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
140 #define FMODE_NOCMTIME ((__force fmode_t)0x800)
142 /* Expect random access pattern */
143 #define FMODE_RANDOM ((__force fmode_t)0x1000)
145 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
146 #define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
148 /* File is opened with O_PATH; almost nothing can be done with it */
149 #define FMODE_PATH ((__force fmode_t)0x4000)
151 /* File needs atomic accesses to f_pos */
152 #define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
153 /* Write access to underlying fs */
154 #define FMODE_WRITER ((__force fmode_t)0x10000)
155 /* Has read method(s) */
156 #define FMODE_CAN_READ ((__force fmode_t)0x20000)
157 /* Has write method(s) */
158 #define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
160 #define FMODE_OPENED ((__force fmode_t)0x80000)
161 #define FMODE_CREATED ((__force fmode_t)0x100000)
163 /* File is stream-like */
164 #define FMODE_STREAM ((__force fmode_t)0x200000)
166 /* File was opened by fanotify and shouldn't generate fanotify events */
167 #define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
169 /* File is capable of returning -EAGAIN if I/O will block */
170 #define FMODE_NOWAIT ((__force fmode_t)0x8000000)
172 /* File represents mount that needs unmounting */
173 #define FMODE_NEED_UNMOUNT ((__force fmode_t)0x10000000)
175 /* File does not contribute to nr_files count */
176 #define FMODE_NOACCOUNT ((__force fmode_t)0x20000000)
179 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
180 * that indicates that they should check the contents of the iovec are
181 * valid, but not check the memory that the iovec elements
184 #define CHECK_IOVEC_ONLY -1
187 * Attribute flags. These should be or-ed together to figure out what
190 #define ATTR_MODE (1 << 0)
191 #define ATTR_UID (1 << 1)
192 #define ATTR_GID (1 << 2)
193 #define ATTR_SIZE (1 << 3)
194 #define ATTR_ATIME (1 << 4)
195 #define ATTR_MTIME (1 << 5)
196 #define ATTR_CTIME (1 << 6)
197 #define ATTR_ATIME_SET (1 << 7)
198 #define ATTR_MTIME_SET (1 << 8)
199 #define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
200 #define ATTR_KILL_SUID (1 << 11)
201 #define ATTR_KILL_SGID (1 << 12)
202 #define ATTR_FILE (1 << 13)
203 #define ATTR_KILL_PRIV (1 << 14)
204 #define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
205 #define ATTR_TIMES_SET (1 << 16)
206 #define ATTR_TOUCH (1 << 17)
209 * Whiteout is represented by a char device. The following constants define the
210 * mode and device number to use.
212 #define WHITEOUT_MODE 0
213 #define WHITEOUT_DEV 0
216 * This is the Inode Attributes structure, used for notify_change(). It
217 * uses the above definitions as flags, to know which values have changed.
218 * Also, in this manner, a Filesystem can look at only the values it cares
219 * about. Basically, these are the attributes that the VFS layer can
220 * request to change from the FS layer.
225 unsigned int ia_valid;
230 struct timespec64 ia_atime;
231 struct timespec64 ia_mtime;
232 struct timespec64 ia_ctime;
235 * Not an attribute, but an auxiliary info for filesystems wanting to
236 * implement an ftruncate() like method. NOTE: filesystem should
237 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
239 struct file *ia_file;
243 * Includes for diskquotas.
245 #include <linux/quota.h>
248 * Maximum number of layers of fs stack. Needs to be limited to
249 * prevent kernel stack overflow
251 #define FILESYSTEM_MAX_STACK_DEPTH 2
254 * enum positive_aop_returns - aop return codes with specific semantics
256 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
257 * completed, that the page is still locked, and
258 * should be considered active. The VM uses this hint
259 * to return the page to the active list -- it won't
260 * be a candidate for writeback again in the near
261 * future. Other callers must be careful to unlock
262 * the page if they get this return. Returned by
265 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
266 * unlocked it and the page might have been truncated.
267 * The caller should back up to acquiring a new page and
268 * trying again. The aop will be taking reasonable
269 * precautions not to livelock. If the caller held a page
270 * reference, it should drop it before retrying. Returned
273 * address_space_operation functions return these large constants to indicate
274 * special semantics to the caller. These are much larger than the bytes in a
275 * page to allow for functions that return the number of bytes operated on in a
279 enum positive_aop_returns {
280 AOP_WRITEPAGE_ACTIVATE = 0x80000,
281 AOP_TRUNCATED_PAGE = 0x80001,
284 #define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
285 #define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
286 * helper code (eg buffer layer)
287 * to clear GFP_FS from alloc */
290 * oh the beauties of C type declarations.
293 struct address_space;
294 struct writeback_control;
295 struct readahead_control;
298 * Write life time hint values.
299 * Stored in struct inode as u8.
302 WRITE_LIFE_NOT_SET = 0,
303 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
304 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
305 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
306 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
307 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
310 #define IOCB_EVENTFD (1 << 0)
311 #define IOCB_APPEND (1 << 1)
312 #define IOCB_DIRECT (1 << 2)
313 #define IOCB_HIPRI (1 << 3)
314 #define IOCB_DSYNC (1 << 4)
315 #define IOCB_SYNC (1 << 5)
316 #define IOCB_WRITE (1 << 6)
317 #define IOCB_NOWAIT (1 << 7)
318 #define IOCB_NOIO (1 << 9)
321 struct file *ki_filp;
323 /* The 'ki_filp' pointer is shared in a union for aio */
324 randomized_struct_fields_start
327 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
331 u16 ki_ioprio; /* See linux/ioprio.h */
332 unsigned int ki_cookie; /* for ->iopoll */
334 randomized_struct_fields_end
337 static inline bool is_sync_kiocb(struct kiocb *kiocb)
339 return kiocb->ki_complete == NULL;
343 * "descriptor" for what we're up to with a read.
344 * This allows us to use the same read code yet
345 * have multiple different users of the data that
346 * we read from a file.
348 * The simplest case just copies the data to user
361 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
362 unsigned long, unsigned long);
364 struct address_space_operations {
365 int (*writepage)(struct page *page, struct writeback_control *wbc);
366 int (*readpage)(struct file *, struct page *);
368 /* Write back some dirty pages from this mapping. */
369 int (*writepages)(struct address_space *, struct writeback_control *);
371 /* Set a page dirty. Return true if this dirtied it */
372 int (*set_page_dirty)(struct page *page);
375 * Reads in the requested pages. Unlike ->readpage(), this is
376 * PURELY used for read-ahead!.
378 int (*readpages)(struct file *filp, struct address_space *mapping,
379 struct list_head *pages, unsigned nr_pages);
380 void (*readahead)(struct readahead_control *);
382 int (*write_begin)(struct file *, struct address_space *mapping,
383 loff_t pos, unsigned len, unsigned flags,
384 struct page **pagep, void **fsdata);
385 int (*write_end)(struct file *, struct address_space *mapping,
386 loff_t pos, unsigned len, unsigned copied,
387 struct page *page, void *fsdata);
389 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
390 sector_t (*bmap)(struct address_space *, sector_t);
391 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
392 int (*releasepage) (struct page *, gfp_t);
393 void (*freepage)(struct page *);
394 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
396 * migrate the contents of a page to the specified target. If
397 * migrate_mode is MIGRATE_ASYNC, it must not block.
399 int (*migratepage) (struct address_space *,
400 struct page *, struct page *, enum migrate_mode);
401 bool (*isolate_page)(struct page *, isolate_mode_t);
402 void (*putback_page)(struct page *);
403 int (*launder_page) (struct page *);
404 int (*is_partially_uptodate) (struct page *, unsigned long,
406 void (*is_dirty_writeback) (struct page *, bool *, bool *);
407 int (*error_remove_page)(struct address_space *, struct page *);
409 /* swapfile support */
410 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
412 void (*swap_deactivate)(struct file *file);
415 extern const struct address_space_operations empty_aops;
418 * pagecache_write_begin/pagecache_write_end must be used by general code
419 * to write into the pagecache.
421 int pagecache_write_begin(struct file *, struct address_space *mapping,
422 loff_t pos, unsigned len, unsigned flags,
423 struct page **pagep, void **fsdata);
425 int pagecache_write_end(struct file *, struct address_space *mapping,
426 loff_t pos, unsigned len, unsigned copied,
427 struct page *page, void *fsdata);
430 * struct address_space - Contents of a cacheable, mappable object.
431 * @host: Owner, either the inode or the block_device.
432 * @i_pages: Cached pages.
433 * @gfp_mask: Memory allocation flags to use for allocating pages.
434 * @i_mmap_writable: Number of VM_SHARED mappings.
435 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
436 * @i_mmap: Tree of private and shared mappings.
437 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
438 * @nrpages: Number of page entries, protected by the i_pages lock.
439 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
440 * @writeback_index: Writeback starts here.
442 * @flags: Error bits and flags (AS_*).
443 * @wb_err: The most recent error which has occurred.
444 * @private_lock: For use by the owner of the address_space.
445 * @private_list: For use by the owner of the address_space.
446 * @private_data: For use by the owner of the address_space.
448 struct address_space {
450 struct xarray i_pages;
452 atomic_t i_mmap_writable;
453 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
454 /* number of thp, only for non-shmem files */
457 struct rb_root_cached i_mmap;
458 struct rw_semaphore i_mmap_rwsem;
459 unsigned long nrpages;
460 unsigned long nrexceptional;
461 pgoff_t writeback_index;
462 const struct address_space_operations *a_ops;
465 spinlock_t private_lock;
466 struct list_head private_list;
468 } __attribute__((aligned(sizeof(long)))) __randomize_layout;
470 * On most architectures that alignment is already the case; but
471 * must be enforced here for CRIS, to let the least significant bit
472 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
475 /* XArray tags, for tagging dirty and writeback pages in the pagecache. */
476 #define PAGECACHE_TAG_DIRTY XA_MARK_0
477 #define PAGECACHE_TAG_WRITEBACK XA_MARK_1
478 #define PAGECACHE_TAG_TOWRITE XA_MARK_2
481 * Returns true if any of the pages in the mapping are marked with the tag.
483 static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
485 return xa_marked(&mapping->i_pages, tag);
488 static inline void i_mmap_lock_write(struct address_space *mapping)
490 down_write(&mapping->i_mmap_rwsem);
493 static inline int i_mmap_trylock_write(struct address_space *mapping)
495 return down_write_trylock(&mapping->i_mmap_rwsem);
498 static inline void i_mmap_unlock_write(struct address_space *mapping)
500 up_write(&mapping->i_mmap_rwsem);
503 static inline void i_mmap_lock_read(struct address_space *mapping)
505 down_read(&mapping->i_mmap_rwsem);
508 static inline void i_mmap_unlock_read(struct address_space *mapping)
510 up_read(&mapping->i_mmap_rwsem);
514 * Might pages of this file be mapped into userspace?
516 static inline int mapping_mapped(struct address_space *mapping)
518 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
522 * Might pages of this file have been modified in userspace?
523 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
524 * marks vma as VM_SHARED if it is shared, and the file was opened for
525 * writing i.e. vma may be mprotected writable even if now readonly.
527 * If i_mmap_writable is negative, no new writable mappings are allowed. You
528 * can only deny writable mappings, if none exists right now.
530 static inline int mapping_writably_mapped(struct address_space *mapping)
532 return atomic_read(&mapping->i_mmap_writable) > 0;
535 static inline int mapping_map_writable(struct address_space *mapping)
537 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
541 static inline void mapping_unmap_writable(struct address_space *mapping)
543 atomic_dec(&mapping->i_mmap_writable);
546 static inline int mapping_deny_writable(struct address_space *mapping)
548 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
552 static inline void mapping_allow_writable(struct address_space *mapping)
554 atomic_inc(&mapping->i_mmap_writable);
558 * Use sequence counter to get consistent i_size on 32-bit processors.
560 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
561 #include <linux/seqlock.h>
562 #define __NEED_I_SIZE_ORDERED
563 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
565 #define i_size_ordered_init(inode) do { } while (0)
569 #define ACL_NOT_CACHED ((void *)(-1))
570 #define ACL_DONT_CACHE ((void *)(-3))
572 static inline struct posix_acl *
573 uncached_acl_sentinel(struct task_struct *task)
575 return (void *)task + 1;
579 is_uncached_acl(struct posix_acl *acl)
581 return (long)acl & 1;
584 #define IOP_FASTPERM 0x0001
585 #define IOP_LOOKUP 0x0002
586 #define IOP_NOFOLLOW 0x0004
587 #define IOP_XATTR 0x0008
588 #define IOP_DEFAULT_READLINK 0x0010
590 struct fsnotify_mark_connector;
593 * Keep mostly read-only and often accessed (especially for
594 * the RCU path lookup and 'stat' data) fields at the beginning
595 * of the 'struct inode'
599 unsigned short i_opflags;
602 unsigned int i_flags;
604 #ifdef CONFIG_FS_POSIX_ACL
605 struct posix_acl *i_acl;
606 struct posix_acl *i_default_acl;
609 const struct inode_operations *i_op;
610 struct super_block *i_sb;
611 struct address_space *i_mapping;
613 #ifdef CONFIG_SECURITY
617 /* Stat data, not accessed from path walking */
620 * Filesystems may only read i_nlink directly. They shall use the
621 * following functions for modification:
623 * (set|clear|inc|drop)_nlink
624 * inode_(inc|dec)_link_count
627 const unsigned int i_nlink;
628 unsigned int __i_nlink;
632 struct timespec64 i_atime;
633 struct timespec64 i_mtime;
634 struct timespec64 i_ctime;
635 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
636 unsigned short i_bytes;
641 #ifdef __NEED_I_SIZE_ORDERED
642 seqcount_t i_size_seqcount;
646 unsigned long i_state;
647 struct rw_semaphore i_rwsem;
649 unsigned long dirtied_when; /* jiffies of first dirtying */
650 unsigned long dirtied_time_when;
652 struct hlist_node i_hash;
653 struct list_head i_io_list; /* backing dev IO list */
654 #ifdef CONFIG_CGROUP_WRITEBACK
655 struct bdi_writeback *i_wb; /* the associated cgroup wb */
657 /* foreign inode detection, see wbc_detach_inode() */
659 u16 i_wb_frn_avg_time;
660 u16 i_wb_frn_history;
662 struct list_head i_lru; /* inode LRU list */
663 struct list_head i_sb_list;
664 struct list_head i_wb_list; /* backing dev writeback list */
666 struct hlist_head i_dentry;
667 struct rcu_head i_rcu;
669 atomic64_t i_version;
670 atomic64_t i_sequence; /* see futex */
672 atomic_t i_dio_count;
673 atomic_t i_writecount;
674 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
675 atomic_t i_readcount; /* struct files open RO */
678 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
679 void (*free_inode)(struct inode *);
681 struct file_lock_context *i_flctx;
682 struct address_space i_data;
683 struct list_head i_devices;
685 struct pipe_inode_info *i_pipe;
686 struct block_device *i_bdev;
694 #ifdef CONFIG_FSNOTIFY
695 __u32 i_fsnotify_mask; /* all events this inode cares about */
696 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
699 #ifdef CONFIG_FS_ENCRYPTION
700 struct fscrypt_info *i_crypt_info;
703 #ifdef CONFIG_FS_VERITY
704 struct fsverity_info *i_verity_info;
707 void *i_private; /* fs or device private pointer */
708 } __randomize_layout;
710 struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);
712 static inline unsigned int i_blocksize(const struct inode *node)
714 return (1 << node->i_blkbits);
717 static inline int inode_unhashed(struct inode *inode)
719 return hlist_unhashed(&inode->i_hash);
723 * __mark_inode_dirty expects inodes to be hashed. Since we don't
724 * want special inodes in the fileset inode space, we make them
725 * appear hashed, but do not put on any lists. hlist_del()
726 * will work fine and require no locking.
728 static inline void inode_fake_hash(struct inode *inode)
730 hlist_add_fake(&inode->i_hash);
734 * inode->i_mutex nesting subclasses for the lock validator:
736 * 0: the object of the current VFS operation
740 * 4: second non-directory
741 * 5: second parent (when locking independent directories in rename)
743 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
744 * non-directories at once.
746 * The locking order between these classes is
747 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
749 enum inode_i_mutex_lock_class
759 static inline void inode_lock(struct inode *inode)
761 down_write(&inode->i_rwsem);
764 static inline void inode_unlock(struct inode *inode)
766 up_write(&inode->i_rwsem);
769 static inline void inode_lock_shared(struct inode *inode)
771 down_read(&inode->i_rwsem);
774 static inline void inode_unlock_shared(struct inode *inode)
776 up_read(&inode->i_rwsem);
779 static inline int inode_trylock(struct inode *inode)
781 return down_write_trylock(&inode->i_rwsem);
784 static inline int inode_trylock_shared(struct inode *inode)
786 return down_read_trylock(&inode->i_rwsem);
789 static inline int inode_is_locked(struct inode *inode)
791 return rwsem_is_locked(&inode->i_rwsem);
794 static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
796 down_write_nested(&inode->i_rwsem, subclass);
799 static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
801 down_read_nested(&inode->i_rwsem, subclass);
804 void lock_two_nondirectories(struct inode *, struct inode*);
805 void unlock_two_nondirectories(struct inode *, struct inode*);
808 * NOTE: in a 32bit arch with a preemptable kernel and
809 * an UP compile the i_size_read/write must be atomic
810 * with respect to the local cpu (unlike with preempt disabled),
811 * but they don't need to be atomic with respect to other cpus like in
812 * true SMP (so they need either to either locally disable irq around
813 * the read or for example on x86 they can be still implemented as a
814 * cmpxchg8b without the need of the lock prefix). For SMP compiles
815 * and 64bit archs it makes no difference if preempt is enabled or not.
817 static inline loff_t i_size_read(const struct inode *inode)
819 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
824 seq = read_seqcount_begin(&inode->i_size_seqcount);
825 i_size = inode->i_size;
826 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
828 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
832 i_size = inode->i_size;
836 return inode->i_size;
841 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
842 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
843 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
845 static inline void i_size_write(struct inode *inode, loff_t i_size)
847 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
849 write_seqcount_begin(&inode->i_size_seqcount);
850 inode->i_size = i_size;
851 write_seqcount_end(&inode->i_size_seqcount);
853 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
855 inode->i_size = i_size;
858 inode->i_size = i_size;
862 static inline unsigned iminor(const struct inode *inode)
864 return MINOR(inode->i_rdev);
867 static inline unsigned imajor(const struct inode *inode)
869 return MAJOR(inode->i_rdev);
873 rwlock_t lock; /* protects pid, uid, euid fields */
874 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
875 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
876 kuid_t uid, euid; /* uid/euid of process setting the owner */
877 int signum; /* posix.1b rt signal to be delivered on IO */
881 * Track a single file's readahead state
883 struct file_ra_state {
884 pgoff_t start; /* where readahead started */
885 unsigned int size; /* # of readahead pages */
886 unsigned int async_size; /* do asynchronous readahead when
887 there are only # of pages ahead */
889 unsigned int ra_pages; /* Maximum readahead window */
890 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
891 loff_t prev_pos; /* Cache last read() position */
895 * Check if @index falls in the readahead windows.
897 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
899 return (index >= ra->start &&
900 index < ra->start + ra->size);
905 struct llist_node fu_llist;
906 struct rcu_head fu_rcuhead;
909 struct inode *f_inode; /* cached value */
910 const struct file_operations *f_op;
913 * Protects f_ep_links, f_flags.
914 * Must not be taken from IRQ context.
917 enum rw_hint f_write_hint;
918 atomic_long_t f_count;
919 unsigned int f_flags;
921 struct mutex f_pos_lock;
923 struct fown_struct f_owner;
924 const struct cred *f_cred;
925 struct file_ra_state f_ra;
928 #ifdef CONFIG_SECURITY
931 /* needed for tty driver, and maybe others */
935 /* Used by fs/eventpoll.c to link all the hooks to this file */
936 struct list_head f_ep_links;
937 struct list_head f_tfile_llink;
938 #endif /* #ifdef CONFIG_EPOLL */
939 struct address_space *f_mapping;
941 errseq_t f_sb_err; /* for syncfs */
943 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
948 /* file identifier */
949 unsigned char f_handle[];
952 static inline struct file *get_file(struct file *f)
954 atomic_long_inc(&f->f_count);
957 #define get_file_rcu_many(x, cnt) \
958 atomic_long_add_unless(&(x)->f_count, (cnt), 0)
959 #define get_file_rcu(x) get_file_rcu_many((x), 1)
960 #define file_count(x) atomic_long_read(&(x)->f_count)
962 #define MAX_NON_LFS ((1UL<<31) - 1)
964 /* Page cache limit. The filesystems should put that into their s_maxbytes
965 limits, otherwise bad things can happen in VM. */
966 #if BITS_PER_LONG==32
967 #define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
968 #elif BITS_PER_LONG==64
969 #define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
974 #define FL_DELEG 4 /* NFSv4 delegation */
975 #define FL_ACCESS 8 /* not trying to lock, just looking */
976 #define FL_EXISTS 16 /* when unlocking, test for existence */
977 #define FL_LEASE 32 /* lease held on this file */
978 #define FL_CLOSE 64 /* unlock on close */
979 #define FL_SLEEP 128 /* A blocking lock */
980 #define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
981 #define FL_UNLOCK_PENDING 512 /* Lease is being broken */
982 #define FL_OFDLCK 1024 /* lock is "owned" by struct file */
983 #define FL_LAYOUT 2048 /* outstanding pNFS layout */
985 #define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
988 * Special return value from posix_lock_file() and vfs_lock_file() for
989 * asynchronous locking.
991 #define FILE_LOCK_DEFERRED 1
993 /* legacy typedef, should eventually be removed */
994 typedef void *fl_owner_t;
998 struct file_lock_operations {
999 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1000 void (*fl_release_private)(struct file_lock *);
1003 struct lock_manager_operations {
1004 fl_owner_t (*lm_get_owner)(fl_owner_t);
1005 void (*lm_put_owner)(fl_owner_t);
1006 void (*lm_notify)(struct file_lock *); /* unblock callback */
1007 int (*lm_grant)(struct file_lock *, int);
1008 bool (*lm_break)(struct file_lock *);
1009 int (*lm_change)(struct file_lock *, int, struct list_head *);
1010 void (*lm_setup)(struct file_lock *, void **);
1011 bool (*lm_breaker_owns_lease)(struct file_lock *);
1014 struct lock_manager {
1015 struct list_head list;
1017 * NFSv4 and up also want opens blocked during the grace period;
1024 void locks_start_grace(struct net *, struct lock_manager *);
1025 void locks_end_grace(struct lock_manager *);
1026 bool locks_in_grace(struct net *);
1027 bool opens_in_grace(struct net *);
1029 /* that will die - we need it for nfs_lock_info */
1030 #include <linux/nfs_fs_i.h>
1033 * struct file_lock represents a generic "file lock". It's used to represent
1034 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1035 * note that the same struct is used to represent both a request for a lock and
1036 * the lock itself, but the same object is never used for both.
1038 * FIXME: should we create a separate "struct lock_request" to help distinguish
1041 * The varous i_flctx lists are ordered by:
1044 * 2) lock range start
1047 * Obviously, the last two criteria only matter for POSIX locks.
1050 struct file_lock *fl_blocker; /* The lock, that is blocking us */
1051 struct list_head fl_list; /* link into file_lock_context */
1052 struct hlist_node fl_link; /* node in global lists */
1053 struct list_head fl_blocked_requests; /* list of requests with
1054 * ->fl_blocker pointing here
1056 struct list_head fl_blocked_member; /* node in
1057 * ->fl_blocker->fl_blocked_requests
1059 fl_owner_t fl_owner;
1060 unsigned int fl_flags;
1061 unsigned char fl_type;
1062 unsigned int fl_pid;
1063 int fl_link_cpu; /* what cpu's list is this on? */
1064 wait_queue_head_t fl_wait;
1065 struct file *fl_file;
1069 struct fasync_struct * fl_fasync; /* for lease break notifications */
1070 /* for lease breaks: */
1071 unsigned long fl_break_time;
1072 unsigned long fl_downgrade_time;
1074 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
1075 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
1077 struct nfs_lock_info nfs_fl;
1078 struct nfs4_lock_info nfs4_fl;
1080 struct list_head link; /* link in AFS vnode's pending_locks list */
1081 int state; /* state of grant or error if -ve */
1082 unsigned int debug_id;
1085 } __randomize_layout;
1087 struct file_lock_context {
1088 spinlock_t flc_lock;
1089 struct list_head flc_flock;
1090 struct list_head flc_posix;
1091 struct list_head flc_lease;
1094 /* The following constant reflects the upper bound of the file/locking space */
1096 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1097 #define OFFSET_MAX INT_LIMIT(loff_t)
1098 #define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1101 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1103 #define locks_inode(f) file_inode(f)
1105 #ifdef CONFIG_FILE_LOCKING
1106 extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1107 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1110 #if BITS_PER_LONG == 32
1111 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1112 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1116 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1117 extern int fcntl_getlease(struct file *filp);
1120 void locks_free_lock_context(struct inode *inode);
1121 void locks_free_lock(struct file_lock *fl);
1122 extern void locks_init_lock(struct file_lock *);
1123 extern struct file_lock * locks_alloc_lock(void);
1124 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1125 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1126 extern void locks_remove_posix(struct file *, fl_owner_t);
1127 extern void locks_remove_file(struct file *);
1128 extern void locks_release_private(struct file_lock *);
1129 extern void posix_test_lock(struct file *, struct file_lock *);
1130 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1131 extern int locks_delete_block(struct file_lock *);
1132 extern int vfs_test_lock(struct file *, struct file_lock *);
1133 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1134 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1135 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
1136 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1137 extern void lease_get_mtime(struct inode *, struct timespec64 *time);
1138 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1139 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1140 extern int lease_modify(struct file_lock *, int, struct list_head *);
1142 struct notifier_block;
1143 extern int lease_register_notifier(struct notifier_block *);
1144 extern void lease_unregister_notifier(struct notifier_block *);
1146 struct files_struct;
1147 extern void show_fd_locks(struct seq_file *f,
1148 struct file *filp, struct files_struct *files);
1149 #else /* !CONFIG_FILE_LOCKING */
1150 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1151 struct flock __user *user)
1156 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1157 unsigned int cmd, struct flock __user *user)
1162 #if BITS_PER_LONG == 32
1163 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1164 struct flock64 __user *user)
1169 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1170 unsigned int cmd, struct flock64 __user *user)
1175 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1180 static inline int fcntl_getlease(struct file *filp)
1186 locks_free_lock_context(struct inode *inode)
1190 static inline void locks_init_lock(struct file_lock *fl)
1195 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1200 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1205 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1210 static inline void locks_remove_file(struct file *filp)
1215 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1220 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1221 struct file_lock *conflock)
1226 static inline int locks_delete_block(struct file_lock *waiter)
1231 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1236 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1237 struct file_lock *fl, struct file_lock *conf)
1242 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1247 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1252 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1257 static inline void lease_get_mtime(struct inode *inode,
1258 struct timespec64 *time)
1263 static inline int generic_setlease(struct file *filp, long arg,
1264 struct file_lock **flp, void **priv)
1269 static inline int vfs_setlease(struct file *filp, long arg,
1270 struct file_lock **lease, void **priv)
1275 static inline int lease_modify(struct file_lock *fl, int arg,
1276 struct list_head *dispose)
1281 struct files_struct;
1282 static inline void show_fd_locks(struct seq_file *f,
1283 struct file *filp, struct files_struct *files) {}
1284 #endif /* !CONFIG_FILE_LOCKING */
1286 static inline struct inode *file_inode(const struct file *f)
1291 static inline struct dentry *file_dentry(const struct file *file)
1293 return d_real(file->f_path.dentry, file_inode(file));
1296 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1298 return locks_lock_inode_wait(locks_inode(filp), fl);
1301 struct fasync_struct {
1305 struct fasync_struct *fa_next; /* singly linked list */
1306 struct file *fa_file;
1307 struct rcu_head fa_rcu;
1310 #define FASYNC_MAGIC 0x4601
1312 /* SMP safe fasync helpers: */
1313 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1314 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1315 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1316 extern struct fasync_struct *fasync_alloc(void);
1317 extern void fasync_free(struct fasync_struct *);
1319 /* can be called from interrupts */
1320 extern void kill_fasync(struct fasync_struct **, int, int);
1322 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1323 extern int f_setown(struct file *filp, unsigned long arg, int force);
1324 extern void f_delown(struct file *filp);
1325 extern pid_t f_getown(struct file *filp);
1326 extern int send_sigurg(struct fown_struct *fown);
1329 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1330 * represented in both.
1332 #define SB_RDONLY 1 /* Mount read-only */
1333 #define SB_NOSUID 2 /* Ignore suid and sgid bits */
1334 #define SB_NODEV 4 /* Disallow access to device special files */
1335 #define SB_NOEXEC 8 /* Disallow program execution */
1336 #define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1337 #define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1338 #define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1339 #define SB_NOATIME 1024 /* Do not update access times. */
1340 #define SB_NODIRATIME 2048 /* Do not update directory access times */
1341 #define SB_SILENT 32768
1342 #define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1343 #define SB_INLINECRYPT (1<<17) /* Use blk-crypto for encrypted files */
1344 #define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1345 #define SB_I_VERSION (1<<23) /* Update inode I_version field */
1346 #define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1348 /* These sb flags are internal to the kernel */
1349 #define SB_SUBMOUNT (1<<26)
1350 #define SB_FORCE (1<<27)
1351 #define SB_NOSEC (1<<28)
1352 #define SB_BORN (1<<29)
1353 #define SB_ACTIVE (1<<30)
1354 #define SB_NOUSER (1<<31)
1360 #define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1361 #define MNT_DETACH 0x00000002 /* Just detach from the tree */
1362 #define MNT_EXPIRE 0x00000004 /* Mark for expiry */
1363 #define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1364 #define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1367 #define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
1368 #define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
1369 #define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
1370 #define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
1372 /* sb->s_iflags to limit user namespace mounts */
1373 #define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
1374 #define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1375 #define SB_I_UNTRUSTED_MOUNTER 0x00000040
1377 #define SB_I_SKIP_SYNC 0x00000100 /* Skip superblock at global sync */
1379 /* Possible states of 'frozen' field */
1381 SB_UNFROZEN = 0, /* FS is unfrozen */
1382 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
1383 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1384 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1385 * internal threads if needed) */
1386 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1389 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1392 int frozen; /* Is sb frozen? */
1393 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1394 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
1397 struct super_block {
1398 struct list_head s_list; /* Keep this first */
1399 dev_t s_dev; /* search index; _not_ kdev_t */
1400 unsigned char s_blocksize_bits;
1401 unsigned long s_blocksize;
1402 loff_t s_maxbytes; /* Max file size */
1403 struct file_system_type *s_type;
1404 const struct super_operations *s_op;
1405 const struct dquot_operations *dq_op;
1406 const struct quotactl_ops *s_qcop;
1407 const struct export_operations *s_export_op;
1408 unsigned long s_flags;
1409 unsigned long s_iflags; /* internal SB_I_* flags */
1410 unsigned long s_magic;
1411 struct dentry *s_root;
1412 struct rw_semaphore s_umount;
1415 #ifdef CONFIG_SECURITY
1418 const struct xattr_handler **s_xattr;
1419 #ifdef CONFIG_FS_ENCRYPTION
1420 const struct fscrypt_operations *s_cop;
1421 struct key *s_master_keys; /* master crypto keys in use */
1423 #ifdef CONFIG_FS_VERITY
1424 const struct fsverity_operations *s_vop;
1426 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
1427 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1428 struct block_device *s_bdev;
1429 struct backing_dev_info *s_bdi;
1430 struct mtd_info *s_mtd;
1431 struct hlist_node s_instances;
1432 unsigned int s_quota_types; /* Bitmask of supported quota types */
1433 struct quota_info s_dquot; /* Diskquota specific options */
1435 struct sb_writers s_writers;
1438 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1439 * s_fsnotify_marks together for cache efficiency. They are frequently
1440 * accessed and rarely modified.
1442 void *s_fs_info; /* Filesystem private info */
1444 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1446 /* Time limits for c/m/atime in seconds */
1447 time64_t s_time_min;
1448 time64_t s_time_max;
1449 #ifdef CONFIG_FSNOTIFY
1450 __u32 s_fsnotify_mask;
1451 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1454 char s_id[32]; /* Informational name */
1455 uuid_t s_uuid; /* UUID */
1457 unsigned int s_max_links;
1461 * The next field is for VFS *only*. No filesystems have any business
1462 * even looking at it. You had been warned.
1464 struct mutex s_vfs_rename_mutex; /* Kludge */
1467 * Filesystem subtype. If non-empty the filesystem type field
1468 * in /proc/mounts will be "type.subtype"
1470 const char *s_subtype;
1472 const struct dentry_operations *s_d_op; /* default d_op for dentries */
1475 * Saved pool identifier for cleancache (-1 means none)
1477 int cleancache_poolid;
1479 struct shrinker s_shrink; /* per-sb shrinker handle */
1481 /* Number of inodes with nlink == 0 but still referenced */
1482 atomic_long_t s_remove_count;
1484 /* Pending fsnotify inode refs */
1485 atomic_long_t s_fsnotify_inode_refs;
1487 /* Being remounted read-only */
1488 int s_readonly_remount;
1490 /* per-sb errseq_t for reporting writeback errors via syncfs */
1493 /* AIO completions deferred from interrupt context */
1494 struct workqueue_struct *s_dio_done_wq;
1495 struct hlist_head s_pins;
1498 * Owning user namespace and default context in which to
1499 * interpret filesystem uids, gids, quotas, device nodes,
1500 * xattrs and security labels.
1502 struct user_namespace *s_user_ns;
1505 * The list_lru structure is essentially just a pointer to a table
1506 * of per-node lru lists, each of which has its own spinlock.
1507 * There is no need to put them into separate cachelines.
1509 struct list_lru s_dentry_lru;
1510 struct list_lru s_inode_lru;
1511 struct rcu_head rcu;
1512 struct work_struct destroy_work;
1514 struct mutex s_sync_lock; /* sync serialisation lock */
1517 * Indicates how deep in a filesystem stack this SB is
1521 /* s_inode_list_lock protects s_inodes */
1522 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1523 struct list_head s_inodes; /* all inodes */
1525 spinlock_t s_inode_wblist_lock;
1526 struct list_head s_inodes_wb; /* writeback inodes */
1527 } __randomize_layout;
1529 /* Helper functions so that in most cases filesystems will
1530 * not need to deal directly with kuid_t and kgid_t and can
1531 * instead deal with the raw numeric values that are stored
1532 * in the filesystem.
1534 static inline uid_t i_uid_read(const struct inode *inode)
1536 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1539 static inline gid_t i_gid_read(const struct inode *inode)
1541 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1544 static inline void i_uid_write(struct inode *inode, uid_t uid)
1546 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1549 static inline void i_gid_write(struct inode *inode, gid_t gid)
1551 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1554 extern struct timespec64 current_time(struct inode *inode);
1557 * Snapshotting support.
1560 void __sb_end_write(struct super_block *sb, int level);
1561 int __sb_start_write(struct super_block *sb, int level, bool wait);
1563 #define __sb_writers_acquired(sb, lev) \
1564 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1565 #define __sb_writers_release(sb, lev) \
1566 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1569 * sb_end_write - drop write access to a superblock
1570 * @sb: the super we wrote to
1572 * Decrement number of writers to the filesystem. Wake up possible waiters
1573 * wanting to freeze the filesystem.
1575 static inline void sb_end_write(struct super_block *sb)
1577 __sb_end_write(sb, SB_FREEZE_WRITE);
1581 * sb_end_pagefault - drop write access to a superblock from a page fault
1582 * @sb: the super we wrote to
1584 * Decrement number of processes handling write page fault to the filesystem.
1585 * Wake up possible waiters wanting to freeze the filesystem.
1587 static inline void sb_end_pagefault(struct super_block *sb)
1589 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1593 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1594 * @sb: the super we wrote to
1596 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1597 * waiters wanting to freeze the filesystem.
1599 static inline void sb_end_intwrite(struct super_block *sb)
1601 __sb_end_write(sb, SB_FREEZE_FS);
1605 * sb_start_write - get write access to a superblock
1606 * @sb: the super we write to
1608 * When a process wants to write data or metadata to a file system (i.e. dirty
1609 * a page or an inode), it should embed the operation in a sb_start_write() -
1610 * sb_end_write() pair to get exclusion against file system freezing. This
1611 * function increments number of writers preventing freezing. If the file
1612 * system is already frozen, the function waits until the file system is
1615 * Since freeze protection behaves as a lock, users have to preserve
1616 * ordering of freeze protection and other filesystem locks. Generally,
1617 * freeze protection should be the outermost lock. In particular, we have:
1620 * -> i_mutex (write path, truncate, directory ops, ...)
1621 * -> s_umount (freeze_super, thaw_super)
1623 static inline void sb_start_write(struct super_block *sb)
1625 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1628 static inline int sb_start_write_trylock(struct super_block *sb)
1630 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1634 * sb_start_pagefault - get write access to a superblock from a page fault
1635 * @sb: the super we write to
1637 * When a process starts handling write page fault, it should embed the
1638 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1639 * exclusion against file system freezing. This is needed since the page fault
1640 * is going to dirty a page. This function increments number of running page
1641 * faults preventing freezing. If the file system is already frozen, the
1642 * function waits until the file system is thawed.
1644 * Since page fault freeze protection behaves as a lock, users have to preserve
1645 * ordering of freeze protection and other filesystem locks. It is advised to
1646 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
1647 * handling code implies lock dependency:
1650 * -> sb_start_pagefault
1652 static inline void sb_start_pagefault(struct super_block *sb)
1654 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1658 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1659 * @sb: the super we write to
1661 * This is the third level of protection against filesystem freezing. It is
1662 * free for use by a filesystem. The only requirement is that it must rank
1663 * below sb_start_pagefault.
1665 * For example filesystem can call sb_start_intwrite() when starting a
1666 * transaction which somewhat eases handling of freezing for internal sources
1667 * of filesystem changes (internal fs threads, discarding preallocation on file
1670 static inline void sb_start_intwrite(struct super_block *sb)
1672 __sb_start_write(sb, SB_FREEZE_FS, true);
1675 static inline int sb_start_intwrite_trylock(struct super_block *sb)
1677 return __sb_start_write(sb, SB_FREEZE_FS, false);
1681 extern bool inode_owner_or_capable(const struct inode *inode);
1684 * VFS helper functions..
1686 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1687 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1688 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1689 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1690 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1691 extern int vfs_rmdir(struct inode *, struct dentry *);
1692 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1693 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1695 static inline int vfs_whiteout(struct inode *dir, struct dentry *dentry)
1697 return vfs_mknod(dir, dentry, S_IFCHR | WHITEOUT_MODE, WHITEOUT_DEV);
1700 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1703 int vfs_mkobj(struct dentry *, umode_t,
1704 int (*f)(struct dentry *, umode_t, void *),
1707 extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1709 #ifdef CONFIG_COMPAT
1710 extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
1713 #define compat_ptr_ioctl NULL
1717 * VFS file helper functions.
1719 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1721 extern bool may_open_dev(const struct path *path);
1724 * This is the "filldir" function type, used by readdir() to let
1725 * the kernel specify what kind of dirent layout it wants to have.
1726 * This allows the kernel to read directories into kernel space or
1727 * to have different dirent layouts depending on the binary type.
1730 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1733 struct dir_context {
1739 * These flags let !MMU mmap() govern direct device mapping vs immediate
1740 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1742 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1743 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1744 * NOMMU_MAP_READ: Can be mapped for reading
1745 * NOMMU_MAP_WRITE: Can be mapped for writing
1746 * NOMMU_MAP_EXEC: Can be mapped for execution
1748 #define NOMMU_MAP_COPY 0x00000001
1749 #define NOMMU_MAP_DIRECT 0x00000008
1750 #define NOMMU_MAP_READ VM_MAYREAD
1751 #define NOMMU_MAP_WRITE VM_MAYWRITE
1752 #define NOMMU_MAP_EXEC VM_MAYEXEC
1754 #define NOMMU_VMFLAGS \
1755 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1758 * These flags control the behavior of the remap_file_range function pointer.
1759 * If it is called with len == 0 that means "remap to end of source file".
1760 * See Documentation/filesystems/vfs.rst for more details about this call.
1762 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
1763 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
1765 #define REMAP_FILE_DEDUP (1 << 0)
1766 #define REMAP_FILE_CAN_SHORTEN (1 << 1)
1769 * These flags signal that the caller is ok with altering various aspects of
1770 * the behavior of the remap operation. The changes must be made by the
1771 * implementation; the vfs remap helper functions can take advantage of them.
1772 * Flags in this category exist to preserve the quirky behavior of the hoisted
1773 * btrfs clone/dedupe ioctls.
1775 #define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
1779 struct file_operations {
1780 struct module *owner;
1781 loff_t (*llseek) (struct file *, loff_t, int);
1782 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1783 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1784 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1785 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1786 int (*iopoll)(struct kiocb *kiocb, bool spin);
1787 int (*iterate) (struct file *, struct dir_context *);
1788 int (*iterate_shared) (struct file *, struct dir_context *);
1789 __poll_t (*poll) (struct file *, struct poll_table_struct *);
1790 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1791 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1792 int (*mmap) (struct file *, struct vm_area_struct *);
1793 unsigned long mmap_supported_flags;
1794 int (*open) (struct inode *, struct file *);
1795 int (*flush) (struct file *, fl_owner_t id);
1796 int (*release) (struct inode *, struct file *);
1797 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1798 int (*fasync) (int, struct file *, int);
1799 int (*lock) (struct file *, int, struct file_lock *);
1800 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1801 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1802 int (*check_flags)(int);
1803 int (*flock) (struct file *, int, struct file_lock *);
1804 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1805 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1806 int (*setlease)(struct file *, long, struct file_lock **, void **);
1807 long (*fallocate)(struct file *file, int mode, loff_t offset,
1809 void (*show_fdinfo)(struct seq_file *m, struct file *f);
1811 unsigned (*mmap_capabilities)(struct file *);
1813 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1814 loff_t, size_t, unsigned int);
1815 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1816 struct file *file_out, loff_t pos_out,
1817 loff_t len, unsigned int remap_flags);
1818 int (*fadvise)(struct file *, loff_t, loff_t, int);
1819 } __randomize_layout;
1821 struct inode_operations {
1822 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1823 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1824 int (*permission) (struct inode *, int);
1825 struct posix_acl * (*get_acl)(struct inode *, int);
1827 int (*readlink) (struct dentry *, char __user *,int);
1829 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1830 int (*link) (struct dentry *,struct inode *,struct dentry *);
1831 int (*unlink) (struct inode *,struct dentry *);
1832 int (*symlink) (struct inode *,struct dentry *,const char *);
1833 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1834 int (*rmdir) (struct inode *,struct dentry *);
1835 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1836 int (*rename) (struct inode *, struct dentry *,
1837 struct inode *, struct dentry *, unsigned int);
1838 int (*setattr) (struct dentry *, struct iattr *);
1839 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1840 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1841 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1843 int (*update_time)(struct inode *, struct timespec64 *, int);
1844 int (*atomic_open)(struct inode *, struct dentry *,
1845 struct file *, unsigned open_flag,
1846 umode_t create_mode);
1847 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1848 int (*set_acl)(struct inode *, struct posix_acl *, int);
1849 } ____cacheline_aligned;
1851 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1852 struct iov_iter *iter)
1854 return file->f_op->read_iter(kio, iter);
1857 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1858 struct iov_iter *iter)
1860 return file->f_op->write_iter(kio, iter);
1863 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1865 return file->f_op->mmap(file, vma);
1868 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1869 unsigned long nr_segs, unsigned long fast_segs,
1870 struct iovec *fast_pointer,
1871 struct iovec **ret_pointer);
1873 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1874 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1875 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1876 unsigned long, loff_t *, rwf_t);
1877 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1878 loff_t, size_t, unsigned int);
1879 extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
1880 struct file *file_out, loff_t pos_out,
1881 size_t len, unsigned int flags);
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,
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);
1899 struct super_operations {
1900 struct inode *(*alloc_inode)(struct super_block *sb);
1901 void (*destroy_inode)(struct inode *);
1902 void (*free_inode)(struct inode *);
1904 void (*dirty_inode) (struct inode *, int flags);
1905 int (*write_inode) (struct inode *, struct writeback_control *wbc);
1906 int (*drop_inode) (struct inode *);
1907 void (*evict_inode) (struct inode *);
1908 void (*put_super) (struct super_block *);
1909 int (*sync_fs)(struct super_block *sb, int wait);
1910 int (*freeze_super) (struct super_block *);
1911 int (*freeze_fs) (struct super_block *);
1912 int (*thaw_super) (struct super_block *);
1913 int (*unfreeze_fs) (struct super_block *);
1914 int (*statfs) (struct dentry *, struct kstatfs *);
1915 int (*remount_fs) (struct super_block *, int *, char *);
1916 void (*umount_begin) (struct super_block *);
1918 int (*show_options)(struct seq_file *, struct dentry *);
1919 int (*show_devname)(struct seq_file *, struct dentry *);
1920 int (*show_path)(struct seq_file *, struct dentry *);
1921 int (*show_stats)(struct seq_file *, struct dentry *);
1923 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1924 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1925 struct dquot **(*get_dquots)(struct inode *);
1927 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1928 long (*nr_cached_objects)(struct super_block *,
1929 struct shrink_control *);
1930 long (*free_cached_objects)(struct super_block *,
1931 struct shrink_control *);
1935 * Inode flags - they have no relation to superblock flags now
1937 #define S_SYNC 1 /* Writes are synced at once */
1938 #define S_NOATIME 2 /* Do not update access times */
1939 #define S_APPEND 4 /* Append-only file */
1940 #define S_IMMUTABLE 8 /* Immutable file */
1941 #define S_DEAD 16 /* removed, but still open directory */
1942 #define S_NOQUOTA 32 /* Inode is not counted to quota */
1943 #define S_DIRSYNC 64 /* Directory modifications are synchronous */
1944 #define S_NOCMTIME 128 /* Do not update file c/mtime */
1945 #define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1946 #define S_PRIVATE 512 /* Inode is fs-internal */
1947 #define S_IMA 1024 /* Inode has an associated IMA struct */
1948 #define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1949 #define S_NOSEC 4096 /* no suid or xattr security attributes */
1950 #ifdef CONFIG_FS_DAX
1951 #define S_DAX 8192 /* Direct Access, avoiding the page cache */
1953 #define S_DAX 0 /* Make all the DAX code disappear */
1955 #define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
1956 #define S_CASEFOLD 32768 /* Casefolded file */
1957 #define S_VERITY 65536 /* Verity file (using fs/verity/) */
1960 * Note that nosuid etc flags are inode-specific: setting some file-system
1961 * flags just means all the inodes inherit those flags by default. It might be
1962 * possible to override it selectively if you really wanted to with some
1963 * ioctl() that is not currently implemented.
1965 * Exception: SB_RDONLY is always applied to the entire file system.
1967 * Unfortunately, it is possible to change a filesystems flags with it mounted
1968 * with files in use. This means that all of the inodes will not have their
1969 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1972 #define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1974 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
1975 #define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
1976 #define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
1977 ((inode)->i_flags & S_SYNC))
1978 #define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
1979 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1980 #define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
1981 #define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1982 #define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
1984 #define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1985 #define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1986 #define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1987 #define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
1989 #define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1990 #define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1991 #define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1992 #define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1993 #define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1994 #define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1995 #define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
1996 #define IS_DAX(inode) ((inode)->i_flags & S_DAX)
1997 #define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
1998 #define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
1999 #define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
2001 #define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2002 (inode)->i_rdev == WHITEOUT_DEV)
2004 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2006 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2009 static inline enum rw_hint file_write_hint(struct file *file)
2011 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2012 return file->f_write_hint;
2014 return file_inode(file)->i_write_hint;
2017 static inline int iocb_flags(struct file *file);
2019 static inline u16 ki_hint_validate(enum rw_hint hint)
2021 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2023 if (hint <= max_hint)
2028 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2030 *kiocb = (struct kiocb) {
2032 .ki_flags = iocb_flags(filp),
2033 .ki_hint = ki_hint_validate(file_write_hint(filp)),
2034 .ki_ioprio = get_current_ioprio(),
2038 static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2041 *kiocb = (struct kiocb) {
2043 .ki_flags = kiocb_src->ki_flags,
2044 .ki_hint = kiocb_src->ki_hint,
2045 .ki_ioprio = kiocb_src->ki_ioprio,
2046 .ki_pos = kiocb_src->ki_pos,
2051 * Inode state bits. Protected by inode->i_lock
2053 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2054 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2056 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2057 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2058 * various stages of removing an inode.
2060 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
2062 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2063 * fdatasync(). i_atime is the usual cause.
2064 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2065 * these changes separately from I_DIRTY_SYNC so that we
2066 * don't have to write inode on fdatasync() when only
2067 * mtime has changed in it.
2068 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
2069 * I_NEW Serves as both a mutex and completion notification.
2070 * New inodes set I_NEW. If two processes both create
2071 * the same inode, one of them will release its inode and
2072 * wait for I_NEW to be released before returning.
2073 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2074 * also cause waiting on I_NEW, without I_NEW actually
2075 * being set. find_inode() uses this to prevent returning
2076 * nearly-dead inodes.
2077 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2078 * is zero. I_FREEING must be set when I_WILL_FREE is
2080 * I_FREEING Set when inode is about to be freed but still has dirty
2081 * pages or buffers attached or the inode itself is still
2083 * I_CLEAR Added by clear_inode(). In this state the inode is
2084 * clean and can be destroyed. Inode keeps I_FREEING.
2086 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2087 * prohibited for many purposes. iget() must wait for
2088 * the inode to be completely released, then create it
2089 * anew. Other functions will just ignore such inodes,
2090 * if appropriate. I_NEW is used for waiting.
2092 * I_SYNC Writeback of inode is running. The bit is set during
2093 * data writeback, and cleared with a wakeup on the bit
2094 * address once it is done. The bit is also used to pin
2095 * the inode in memory for flusher thread.
2097 * I_REFERENCED Marks the inode as recently references on the LRU list.
2099 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2101 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2102 * synchronize competing switching instances and to tell
2103 * wb stat updates to grab the i_pages lock. See
2104 * inode_switch_wbs_work_fn() for details.
2106 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2107 * and work dirs among overlayfs mounts.
2109 * I_CREATING New object's inode in the middle of setting up.
2111 * I_DONTCACHE Evict inode as soon as it is not used anymore.
2113 * Q: What is the difference between I_WILL_FREE and I_FREEING?
2115 #define I_DIRTY_SYNC (1 << 0)
2116 #define I_DIRTY_DATASYNC (1 << 1)
2117 #define I_DIRTY_PAGES (1 << 2)
2119 #define I_NEW (1 << __I_NEW)
2120 #define I_WILL_FREE (1 << 4)
2121 #define I_FREEING (1 << 5)
2122 #define I_CLEAR (1 << 6)
2124 #define I_SYNC (1 << __I_SYNC)
2125 #define I_REFERENCED (1 << 8)
2126 #define __I_DIO_WAKEUP 9
2127 #define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
2128 #define I_LINKABLE (1 << 10)
2129 #define I_DIRTY_TIME (1 << 11)
2130 #define __I_DIRTY_TIME_EXPIRED 12
2131 #define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
2132 #define I_WB_SWITCH (1 << 13)
2133 #define I_OVL_INUSE (1 << 14)
2134 #define I_CREATING (1 << 15)
2135 #define I_DONTCACHE (1 << 16)
2137 #define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2138 #define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2139 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
2141 extern void __mark_inode_dirty(struct inode *, int);
2142 static inline void mark_inode_dirty(struct inode *inode)
2144 __mark_inode_dirty(inode, I_DIRTY);
2147 static inline void mark_inode_dirty_sync(struct inode *inode)
2149 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2152 extern void inc_nlink(struct inode *inode);
2153 extern void drop_nlink(struct inode *inode);
2154 extern void clear_nlink(struct inode *inode);
2155 extern void set_nlink(struct inode *inode, unsigned int nlink);
2157 static inline void inode_inc_link_count(struct inode *inode)
2160 mark_inode_dirty(inode);
2163 static inline void inode_dec_link_count(struct inode *inode)
2166 mark_inode_dirty(inode);
2169 enum file_time_flags {
2176 extern bool atime_needs_update(const struct path *, struct inode *);
2177 extern void touch_atime(const struct path *);
2178 static inline void file_accessed(struct file *file)
2180 if (!(file->f_flags & O_NOATIME))
2181 touch_atime(&file->f_path);
2184 extern int file_modified(struct file *file);
2186 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2187 int sync_inode_metadata(struct inode *inode, int wait);
2189 struct file_system_type {
2192 #define FS_REQUIRES_DEV 1
2193 #define FS_BINARY_MOUNTDATA 2
2194 #define FS_HAS_SUBTYPE 4
2195 #define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
2196 #define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
2197 #define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
2198 int (*init_fs_context)(struct fs_context *);
2199 const struct fs_parameter_spec *parameters;
2200 struct dentry *(*mount) (struct file_system_type *, int,
2201 const char *, void *);
2202 void (*kill_sb) (struct super_block *);
2203 struct module *owner;
2204 struct file_system_type * next;
2205 struct hlist_head fs_supers;
2207 struct lock_class_key s_lock_key;
2208 struct lock_class_key s_umount_key;
2209 struct lock_class_key s_vfs_rename_key;
2210 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2212 struct lock_class_key i_lock_key;
2213 struct lock_class_key i_mutex_key;
2214 struct lock_class_key i_mutex_dir_key;
2217 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2219 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2220 int flags, const char *dev_name, void *data,
2221 int (*fill_super)(struct super_block *, void *, int));
2222 extern struct dentry *mount_single(struct file_system_type *fs_type,
2223 int flags, void *data,
2224 int (*fill_super)(struct super_block *, void *, int));
2225 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2226 int flags, void *data,
2227 int (*fill_super)(struct super_block *, void *, int));
2228 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2229 void generic_shutdown_super(struct super_block *sb);
2230 void kill_block_super(struct super_block *sb);
2231 void kill_anon_super(struct super_block *sb);
2232 void kill_litter_super(struct super_block *sb);
2233 void deactivate_super(struct super_block *sb);
2234 void deactivate_locked_super(struct super_block *sb);
2235 int set_anon_super(struct super_block *s, void *data);
2236 int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2237 int get_anon_bdev(dev_t *);
2238 void free_anon_bdev(dev_t);
2239 struct super_block *sget_fc(struct fs_context *fc,
2240 int (*test)(struct super_block *, struct fs_context *),
2241 int (*set)(struct super_block *, struct fs_context *));
2242 struct super_block *sget(struct file_system_type *type,
2243 int (*test)(struct super_block *,void *),
2244 int (*set)(struct super_block *,void *),
2245 int flags, void *data);
2247 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2248 #define fops_get(fops) \
2249 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2250 #define fops_put(fops) \
2251 do { if (fops) module_put((fops)->owner); } while(0)
2253 * This one is to be used *ONLY* from ->open() instances.
2254 * fops must be non-NULL, pinned down *and* module dependencies
2255 * should be sufficient to pin the caller down as well.
2257 #define replace_fops(f, fops) \
2259 struct file *__file = (f); \
2260 fops_put(__file->f_op); \
2261 BUG_ON(!(__file->f_op = (fops))); \
2264 extern int register_filesystem(struct file_system_type *);
2265 extern int unregister_filesystem(struct file_system_type *);
2266 extern struct vfsmount *kern_mount(struct file_system_type *);
2267 extern void kern_unmount(struct vfsmount *mnt);
2268 extern int may_umount_tree(struct vfsmount *);
2269 extern int may_umount(struct vfsmount *);
2270 extern long do_mount(const char *, const char __user *,
2271 const char *, unsigned long, void *);
2272 extern struct vfsmount *collect_mounts(const struct path *);
2273 extern void drop_collected_mounts(struct vfsmount *);
2274 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2276 extern int vfs_statfs(const struct path *, struct kstatfs *);
2277 extern int user_statfs(const char __user *, struct kstatfs *);
2278 extern int fd_statfs(int, struct kstatfs *);
2279 extern int freeze_super(struct super_block *super);
2280 extern int thaw_super(struct super_block *super);
2281 extern bool our_mnt(struct vfsmount *mnt);
2282 extern __printf(2, 3)
2283 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2284 extern int super_setup_bdi(struct super_block *sb);
2286 extern int current_umask(void);
2288 extern void ihold(struct inode * inode);
2289 extern void iput(struct inode *);
2290 extern int generic_update_time(struct inode *, struct timespec64 *, int);
2293 extern struct kobject *fs_kobj;
2295 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2297 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2298 extern int locks_mandatory_locked(struct file *);
2299 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2302 * Candidates for mandatory locking have the setgid bit set
2303 * but no group execute bit - an otherwise meaningless combination.
2306 static inline int __mandatory_lock(struct inode *ino)
2308 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2312 * ... and these candidates should be on SB_MANDLOCK mounted fs,
2313 * otherwise these will be advisory locks
2316 static inline int mandatory_lock(struct inode *ino)
2318 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2321 static inline int locks_verify_locked(struct file *file)
2323 if (mandatory_lock(locks_inode(file)))
2324 return locks_mandatory_locked(file);
2328 static inline int locks_verify_truncate(struct inode *inode,
2332 if (!inode->i_flctx || !mandatory_lock(inode))
2335 if (size < inode->i_size) {
2336 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2339 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2344 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2346 static inline int locks_mandatory_locked(struct file *file)
2351 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2352 loff_t start, loff_t end, unsigned char type)
2357 static inline int __mandatory_lock(struct inode *inode)
2362 static inline int mandatory_lock(struct inode *inode)
2367 static inline int locks_verify_locked(struct file *file)
2372 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2378 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2381 #ifdef CONFIG_FILE_LOCKING
2382 static inline int break_lease(struct inode *inode, unsigned int mode)
2385 * Since this check is lockless, we must ensure that any refcounts
2386 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2387 * could end up racing with tasks trying to set a new lease on this
2391 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2392 return __break_lease(inode, mode, FL_LEASE);
2396 static inline int break_deleg(struct inode *inode, unsigned int mode)
2399 * Since this check is lockless, we must ensure that any refcounts
2400 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2401 * could end up racing with tasks trying to set a new lease on this
2405 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2406 return __break_lease(inode, mode, FL_DELEG);
2410 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2414 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2415 if (ret == -EWOULDBLOCK && delegated_inode) {
2416 *delegated_inode = inode;
2422 static inline int break_deleg_wait(struct inode **delegated_inode)
2426 ret = break_deleg(*delegated_inode, O_WRONLY);
2427 iput(*delegated_inode);
2428 *delegated_inode = NULL;
2432 static inline int break_layout(struct inode *inode, bool wait)
2435 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2436 return __break_lease(inode,
2437 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2442 #else /* !CONFIG_FILE_LOCKING */
2443 static inline int break_lease(struct inode *inode, unsigned int mode)
2448 static inline int break_deleg(struct inode *inode, unsigned int mode)
2453 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2458 static inline int break_deleg_wait(struct inode **delegated_inode)
2464 static inline int break_layout(struct inode *inode, bool wait)
2469 #endif /* CONFIG_FILE_LOCKING */
2474 const char *name; /* pointer to actual string */
2475 const __user char *uptr; /* original userland pointer */
2477 struct audit_names *aname;
2480 static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
2482 extern long vfs_truncate(const struct path *, loff_t);
2483 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2485 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2487 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2489 extern struct file *file_open_name(struct filename *, int, umode_t);
2490 extern struct file *filp_open(const char *, int, umode_t);
2491 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2492 const char *, int, umode_t);
2493 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2494 extern struct file * open_with_fake_path(const struct path *, int,
2495 struct inode*, const struct cred *);
2496 static inline struct file *file_clone_open(struct file *file)
2498 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2500 extern int filp_close(struct file *, fl_owner_t id);
2502 extern struct filename *getname_flags(const char __user *, int, int *);
2503 extern struct filename *getname(const char __user *);
2504 extern struct filename *getname_kernel(const char *);
2505 extern void putname(struct filename *name);
2507 extern int finish_open(struct file *file, struct dentry *dentry,
2508 int (*open)(struct inode *, struct file *));
2509 extern int finish_no_open(struct file *file, struct dentry *dentry);
2512 extern void __init vfs_caches_init_early(void);
2513 extern void __init vfs_caches_init(void);
2515 extern struct kmem_cache *names_cachep;
2517 #define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
2518 #define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
2520 extern struct super_block *blockdev_superblock;
2521 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2523 return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
2526 void emergency_thaw_all(void);
2527 extern int sync_filesystem(struct super_block *);
2528 extern const struct file_operations def_blk_fops;
2529 extern const struct file_operations def_chr_fops;
2532 #define CHRDEV_MAJOR_MAX 512
2533 /* Marks the bottom of the first segment of free char majors */
2534 #define CHRDEV_MAJOR_DYN_END 234
2535 /* Marks the top and bottom of the second segment of free char majors */
2536 #define CHRDEV_MAJOR_DYN_EXT_START 511
2537 #define CHRDEV_MAJOR_DYN_EXT_END 384
2539 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2540 extern int register_chrdev_region(dev_t, unsigned, const char *);
2541 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2542 unsigned int count, const char *name,
2543 const struct file_operations *fops);
2544 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2545 unsigned int count, const char *name);
2546 extern void unregister_chrdev_region(dev_t, unsigned);
2547 extern void chrdev_show(struct seq_file *,off_t);
2549 static inline int register_chrdev(unsigned int major, const char *name,
2550 const struct file_operations *fops)
2552 return __register_chrdev(major, 0, 256, name, fops);
2555 static inline void unregister_chrdev(unsigned int major, const char *name)
2557 __unregister_chrdev(major, 0, 256, name);
2560 extern void init_special_inode(struct inode *, umode_t, dev_t);
2562 /* Invalid inode operations -- fs/bad_inode.c */
2563 extern void make_bad_inode(struct inode *);
2564 extern bool is_bad_inode(struct inode *);
2566 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2567 pgoff_t start, pgoff_t end);
2569 static inline void invalidate_remote_inode(struct inode *inode)
2571 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2572 S_ISLNK(inode->i_mode))
2573 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2575 extern int invalidate_inode_pages2(struct address_space *mapping);
2576 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2577 pgoff_t start, pgoff_t end);
2578 extern int write_inode_now(struct inode *, int);
2579 extern int filemap_fdatawrite(struct address_space *);
2580 extern int filemap_flush(struct address_space *);
2581 extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2582 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2584 extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2585 loff_t start_byte, loff_t end_byte);
2587 static inline int filemap_fdatawait(struct address_space *mapping)
2589 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2592 extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2594 extern int filemap_write_and_wait_range(struct address_space *mapping,
2595 loff_t lstart, loff_t lend);
2596 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2597 loff_t start, loff_t end, int sync_mode);
2598 extern int filemap_fdatawrite_range(struct address_space *mapping,
2599 loff_t start, loff_t end);
2600 extern int filemap_check_errors(struct address_space *mapping);
2601 extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2603 static inline int filemap_write_and_wait(struct address_space *mapping)
2605 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
2608 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2610 extern int __must_check file_check_and_advance_wb_err(struct file *file);
2611 extern int __must_check file_write_and_wait_range(struct file *file,
2612 loff_t start, loff_t end);
2614 static inline int file_write_and_wait(struct file *file)
2616 return file_write_and_wait_range(file, 0, LLONG_MAX);
2620 * filemap_set_wb_err - set a writeback error on an address_space
2621 * @mapping: mapping in which to set writeback error
2622 * @err: error to be set in mapping
2624 * When writeback fails in some way, we must record that error so that
2625 * userspace can be informed when fsync and the like are called. We endeavor
2626 * to report errors on any file that was open at the time of the error. Some
2627 * internal callers also need to know when writeback errors have occurred.
2629 * When a writeback error occurs, most filesystems will want to call
2630 * filemap_set_wb_err to record the error in the mapping so that it will be
2631 * automatically reported whenever fsync is called on the file.
2633 static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2635 /* Fastpath for common case of no error */
2637 __filemap_set_wb_err(mapping, err);
2641 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2642 * @mapping: mapping to check for writeback errors
2643 * @since: previously-sampled errseq_t
2645 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2646 * the given value was sampled.
2648 * If it has then report the latest error set, otherwise return 0.
2650 static inline int filemap_check_wb_err(struct address_space *mapping,
2653 return errseq_check(&mapping->wb_err, since);
2657 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2658 * @mapping: mapping to be sampled
2660 * Writeback errors are always reported relative to a particular sample point
2661 * in the past. This function provides those sample points.
2663 static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2665 return errseq_sample(&mapping->wb_err);
2669 * file_sample_sb_err - sample the current errseq_t to test for later errors
2670 * @mapping: mapping to be sampled
2672 * Grab the most current superblock-level errseq_t value for the given
2675 static inline errseq_t file_sample_sb_err(struct file *file)
2677 return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
2680 static inline int filemap_nr_thps(struct address_space *mapping)
2682 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
2683 return atomic_read(&mapping->nr_thps);
2689 static inline void filemap_nr_thps_inc(struct address_space *mapping)
2691 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
2692 atomic_inc(&mapping->nr_thps);
2698 static inline void filemap_nr_thps_dec(struct address_space *mapping)
2700 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
2701 atomic_dec(&mapping->nr_thps);
2707 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2709 extern int vfs_fsync(struct file *file, int datasync);
2711 extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2712 unsigned int flags);
2715 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2716 * to already be updated for the write, and will return either the amount
2717 * of bytes passed in, or an error if syncing the file failed.
2719 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2721 if (iocb->ki_flags & IOCB_DSYNC) {
2722 int ret = vfs_fsync_range(iocb->ki_filp,
2723 iocb->ki_pos - count, iocb->ki_pos - 1,
2724 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2732 extern void emergency_sync(void);
2733 extern void emergency_remount(void);
2736 extern int bmap(struct inode *inode, sector_t *block);
2738 static inline int bmap(struct inode *inode, sector_t *block)
2744 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2745 extern int inode_permission(struct inode *, int);
2746 extern int generic_permission(struct inode *, int);
2747 extern int __check_sticky(struct inode *dir, struct inode *inode);
2749 static inline bool execute_ok(struct inode *inode)
2751 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2754 static inline void file_start_write(struct file *file)
2756 if (!S_ISREG(file_inode(file)->i_mode))
2758 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2761 static inline bool file_start_write_trylock(struct file *file)
2763 if (!S_ISREG(file_inode(file)->i_mode))
2765 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2768 static inline void file_end_write(struct file *file)
2770 if (!S_ISREG(file_inode(file)->i_mode))
2772 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2776 * get_write_access() gets write permission for a file.
2777 * put_write_access() releases this write permission.
2778 * This is used for regular files.
2779 * We cannot support write (and maybe mmap read-write shared) accesses and
2780 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2781 * can have the following values:
2782 * 0: no writers, no VM_DENYWRITE mappings
2783 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2784 * > 0: (i_writecount) users are writing to the file.
2786 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2787 * except for the cases where we don't hold i_writecount yet. Then we need to
2788 * use {get,deny}_write_access() - these functions check the sign and refuse
2789 * to do the change if sign is wrong.
2791 static inline int get_write_access(struct inode *inode)
2793 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2795 static inline int deny_write_access(struct file *file)
2797 struct inode *inode = file_inode(file);
2798 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2800 static inline void put_write_access(struct inode * inode)
2802 atomic_dec(&inode->i_writecount);
2804 static inline void allow_write_access(struct file *file)
2807 atomic_inc(&file_inode(file)->i_writecount);
2809 static inline bool inode_is_open_for_write(const struct inode *inode)
2811 return atomic_read(&inode->i_writecount) > 0;
2814 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
2815 static inline void i_readcount_dec(struct inode *inode)
2817 BUG_ON(!atomic_read(&inode->i_readcount));
2818 atomic_dec(&inode->i_readcount);
2820 static inline void i_readcount_inc(struct inode *inode)
2822 atomic_inc(&inode->i_readcount);
2825 static inline void i_readcount_dec(struct inode *inode)
2829 static inline void i_readcount_inc(struct inode *inode)
2834 extern int do_pipe_flags(int *, int);
2836 #define __kernel_read_file_id(id) \
2837 id(UNKNOWN, unknown) \
2838 id(FIRMWARE, firmware) \
2839 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
2840 id(FIRMWARE_EFI_EMBEDDED, firmware) \
2841 id(MODULE, kernel-module) \
2842 id(KEXEC_IMAGE, kexec-image) \
2843 id(KEXEC_INITRAMFS, kexec-initramfs) \
2844 id(POLICY, security-policy) \
2845 id(X509_CERTIFICATE, x509-certificate) \
2848 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2849 #define __fid_stringify(dummy, str) #str,
2851 enum kernel_read_file_id {
2852 __kernel_read_file_id(__fid_enumify)
2855 static const char * const kernel_read_file_str[] = {
2856 __kernel_read_file_id(__fid_stringify)
2859 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2861 if ((unsigned)id >= READING_MAX_ID)
2862 return kernel_read_file_str[READING_UNKNOWN];
2864 return kernel_read_file_str[id];
2867 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2868 enum kernel_read_file_id);
2869 extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2870 enum kernel_read_file_id);
2871 extern int kernel_read_file_from_path_initns(const char *, void **, loff_t *, loff_t,
2872 enum kernel_read_file_id);
2873 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2874 enum kernel_read_file_id);
2875 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2876 ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
2877 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2878 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
2879 extern struct file * open_exec(const char *);
2881 /* fs/dcache.c -- generic fs support functions */
2882 extern bool is_subdir(struct dentry *, struct dentry *);
2883 extern bool path_is_under(const struct path *, const struct path *);
2885 extern char *file_path(struct file *, char *, int);
2887 #include <linux/err.h>
2889 /* needed for stackable file system support */
2890 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2892 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2894 extern int inode_init_always(struct super_block *, struct inode *);
2895 extern void inode_init_once(struct inode *);
2896 extern void address_space_init_once(struct address_space *mapping);
2897 extern struct inode * igrab(struct inode *);
2898 extern ino_t iunique(struct super_block *, ino_t);
2899 extern int inode_needs_sync(struct inode *inode);
2900 extern int generic_delete_inode(struct inode *inode);
2901 static inline int generic_drop_inode(struct inode *inode)
2903 return !inode->i_nlink || inode_unhashed(inode) ||
2904 (inode->i_state & I_DONTCACHE);
2906 extern void d_mark_dontcache(struct inode *inode);
2908 extern struct inode *ilookup5_nowait(struct super_block *sb,
2909 unsigned long hashval, int (*test)(struct inode *, void *),
2911 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2912 int (*test)(struct inode *, void *), void *data);
2913 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2915 extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2916 int (*test)(struct inode *, void *),
2917 int (*set)(struct inode *, void *),
2919 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2920 extern struct inode * iget_locked(struct super_block *, unsigned long);
2921 extern struct inode *find_inode_nowait(struct super_block *,
2923 int (*match)(struct inode *,
2924 unsigned long, void *),
2926 extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
2927 int (*)(struct inode *, void *), void *);
2928 extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
2929 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2930 extern int insert_inode_locked(struct inode *);
2931 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2932 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2934 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2936 extern void unlock_new_inode(struct inode *);
2937 extern void discard_new_inode(struct inode *);
2938 extern unsigned int get_next_ino(void);
2939 extern void evict_inodes(struct super_block *sb);
2941 extern void __iget(struct inode * inode);
2942 extern void iget_failed(struct inode *);
2943 extern void clear_inode(struct inode *);
2944 extern void __destroy_inode(struct inode *);
2945 extern struct inode *new_inode_pseudo(struct super_block *sb);
2946 extern struct inode *new_inode(struct super_block *sb);
2947 extern void free_inode_nonrcu(struct inode *inode);
2948 extern int should_remove_suid(struct dentry *);
2949 extern int file_remove_privs(struct file *);
2951 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2952 static inline void insert_inode_hash(struct inode *inode)
2954 __insert_inode_hash(inode, inode->i_ino);
2957 extern void __remove_inode_hash(struct inode *);
2958 static inline void remove_inode_hash(struct inode *inode)
2960 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
2961 __remove_inode_hash(inode);
2964 extern void inode_sb_list_add(struct inode *inode);
2966 extern int sb_set_blocksize(struct super_block *, int);
2967 extern int sb_min_blocksize(struct super_block *, int);
2969 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2970 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2971 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
2972 extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
2973 struct file *file_out, loff_t pos_out,
2974 loff_t *count, unsigned int remap_flags);
2975 extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
2976 extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
2977 struct file *file_out, loff_t pos_out,
2978 size_t *count, unsigned int flags);
2979 extern ssize_t generic_file_buffered_read(struct kiocb *iocb,
2980 struct iov_iter *to, ssize_t already_read);
2981 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
2982 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
2983 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
2984 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
2985 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
2987 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
2989 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
2991 ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
2992 struct iov_iter *iter);
2993 ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
2994 struct iov_iter *iter);
2996 /* fs/block_dev.c */
2997 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
2998 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
2999 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3001 extern void block_sync_page(struct page *page);
3004 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
3005 struct pipe_inode_info *, size_t, unsigned int);
3006 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3007 struct file *, loff_t *, size_t, unsigned int);
3008 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
3009 struct file *out, loff_t *, size_t len, unsigned int flags);
3010 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3011 loff_t *opos, size_t len, unsigned int flags);
3015 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3016 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3017 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
3018 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3019 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
3020 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3021 int whence, loff_t maxsize, loff_t eof);
3022 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3023 int whence, loff_t size);
3024 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3025 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
3026 extern int generic_file_open(struct inode * inode, struct file * filp);
3027 extern int nonseekable_open(struct inode * inode, struct file * filp);
3028 extern int stream_open(struct inode * inode, struct file * filp);
3031 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3032 loff_t file_offset);
3035 /* need locking between buffered and direct access */
3038 /* filesystem does not support filling holes */
3039 DIO_SKIP_HOLES = 0x02,
3042 void dio_end_io(struct bio *bio);
3044 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3045 struct block_device *bdev, struct iov_iter *iter,
3046 get_block_t get_block,
3047 dio_iodone_t end_io, dio_submit_t submit_io,
3050 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3051 struct inode *inode,
3052 struct iov_iter *iter,
3053 get_block_t get_block)
3055 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3056 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
3060 void inode_dio_wait(struct inode *inode);
3063 * inode_dio_begin - signal start of a direct I/O requests
3064 * @inode: inode the direct I/O happens on
3066 * This is called once we've finished processing a direct I/O request,
3067 * and is used to wake up callers waiting for direct I/O to be quiesced.
3069 static inline void inode_dio_begin(struct inode *inode)
3071 atomic_inc(&inode->i_dio_count);
3075 * inode_dio_end - signal finish of a direct I/O requests
3076 * @inode: inode the direct I/O happens on
3078 * This is called once we've finished processing a direct I/O request,
3079 * and is used to wake up callers waiting for direct I/O to be quiesced.
3081 static inline void inode_dio_end(struct inode *inode)
3083 if (atomic_dec_and_test(&inode->i_dio_count))
3084 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3088 * Warn about a page cache invalidation failure diring a direct I/O write.
3090 void dio_warn_stale_pagecache(struct file *filp);
3092 extern void inode_set_flags(struct inode *inode, unsigned int flags,
3095 extern const struct file_operations generic_ro_fops;
3097 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3099 extern int readlink_copy(char __user *, int, const char *);
3100 extern int page_readlink(struct dentry *, char __user *, int);
3101 extern const char *page_get_link(struct dentry *, struct inode *,
3102 struct delayed_call *);
3103 extern void page_put_link(void *);
3104 extern int __page_symlink(struct inode *inode, const char *symname, int len,
3106 extern int page_symlink(struct inode *inode, const char *symname, int len);
3107 extern const struct inode_operations page_symlink_inode_operations;
3108 extern void kfree_link(void *);
3109 extern void generic_fillattr(struct inode *, struct kstat *);
3110 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3111 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3112 void __inode_add_bytes(struct inode *inode, loff_t bytes);
3113 void inode_add_bytes(struct inode *inode, loff_t bytes);
3114 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
3115 void inode_sub_bytes(struct inode *inode, loff_t bytes);
3116 static inline loff_t __inode_get_bytes(struct inode *inode)
3118 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3120 loff_t inode_get_bytes(struct inode *inode);
3121 void inode_set_bytes(struct inode *inode, loff_t bytes);
3122 const char *simple_get_link(struct dentry *, struct inode *,
3123 struct delayed_call *);
3124 extern const struct inode_operations simple_symlink_inode_operations;
3126 extern int iterate_dir(struct file *, struct dir_context *);
3128 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3129 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3131 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3133 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3134 stat, STATX_BASIC_STATS);
3136 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3138 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3139 stat, STATX_BASIC_STATS);
3141 static inline int vfs_fstatat(int dfd, const char __user *filename,
3142 struct kstat *stat, int flags)
3144 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3145 stat, STATX_BASIC_STATS);
3147 static inline int vfs_fstat(int fd, struct kstat *stat)
3149 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3153 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3154 extern int vfs_readlink(struct dentry *, char __user *, int);
3156 extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3157 extern void put_filesystem(struct file_system_type *fs);
3158 extern struct file_system_type *get_fs_type(const char *name);
3159 extern struct super_block *get_super(struct block_device *);
3160 extern struct super_block *get_super_thawed(struct block_device *);
3161 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3162 extern struct super_block *get_active_super(struct block_device *bdev);
3163 extern void drop_super(struct super_block *sb);
3164 extern void drop_super_exclusive(struct super_block *sb);
3165 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
3166 extern void iterate_supers_type(struct file_system_type *,
3167 void (*)(struct super_block *, void *), void *);
3169 extern int dcache_dir_open(struct inode *, struct file *);
3170 extern int dcache_dir_close(struct inode *, struct file *);
3171 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3172 extern int dcache_readdir(struct file *, struct dir_context *);
3173 extern int simple_setattr(struct dentry *, struct iattr *);
3174 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3175 extern int simple_statfs(struct dentry *, struct kstatfs *);
3176 extern int simple_open(struct inode *inode, struct file *file);
3177 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3178 extern int simple_unlink(struct inode *, struct dentry *);
3179 extern int simple_rmdir(struct inode *, struct dentry *);
3180 extern int simple_rename(struct inode *, struct dentry *,
3181 struct inode *, struct dentry *, unsigned int);
3182 extern void simple_recursive_removal(struct dentry *,
3183 void (*callback)(struct dentry *));
3184 extern int noop_fsync(struct file *, loff_t, loff_t, int);
3185 extern int noop_set_page_dirty(struct page *page);
3186 extern void noop_invalidatepage(struct page *page, unsigned int offset,
3187 unsigned int length);
3188 extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
3189 extern int simple_empty(struct dentry *);
3190 extern int simple_readpage(struct file *file, struct page *page);
3191 extern int simple_write_begin(struct file *file, struct address_space *mapping,
3192 loff_t pos, unsigned len, unsigned flags,
3193 struct page **pagep, void **fsdata);
3194 extern int simple_write_end(struct file *file, struct address_space *mapping,
3195 loff_t pos, unsigned len, unsigned copied,
3196 struct page *page, void *fsdata);
3197 extern int always_delete_dentry(const struct dentry *);
3198 extern struct inode *alloc_anon_inode(struct super_block *);
3199 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3200 extern const struct dentry_operations simple_dentry_operations;
3202 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
3203 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3204 extern const struct file_operations simple_dir_operations;
3205 extern const struct inode_operations simple_dir_inode_operations;
3206 extern void make_empty_dir_inode(struct inode *inode);
3207 extern bool is_empty_dir_inode(struct inode *inode);
3208 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3209 struct dentry *d_alloc_name(struct dentry *, const char *);
3210 extern int simple_fill_super(struct super_block *, unsigned long,
3211 const struct tree_descr *);
3212 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3213 extern void simple_release_fs(struct vfsmount **mount, int *count);
3215 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3216 loff_t *ppos, const void *from, size_t available);
3217 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3218 const void __user *from, size_t count);
3220 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3221 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3223 extern int generic_check_addressable(unsigned, u64);
3225 #ifdef CONFIG_MIGRATION
3226 extern int buffer_migrate_page(struct address_space *,
3227 struct page *, struct page *,
3229 extern int buffer_migrate_page_norefs(struct address_space *,
3230 struct page *, struct page *,
3233 #define buffer_migrate_page NULL
3234 #define buffer_migrate_page_norefs NULL
3237 extern int setattr_prepare(struct dentry *, struct iattr *);
3238 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3239 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3241 extern int file_update_time(struct file *file);
3243 static inline bool vma_is_dax(const struct vm_area_struct *vma)
3245 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3248 static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3250 struct inode *inode;
3254 if (!vma_is_dax(vma))
3256 inode = file_inode(vma->vm_file);
3257 if (S_ISCHR(inode->i_mode))
3258 return false; /* device-dax */
3262 static inline int iocb_flags(struct file *file)
3265 if (file->f_flags & O_APPEND)
3267 if (file->f_flags & O_DIRECT)
3269 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3271 if (file->f_flags & __O_SYNC)
3276 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3278 if (unlikely(flags & ~RWF_SUPPORTED))
3281 if (flags & RWF_NOWAIT) {
3282 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3284 ki->ki_flags |= IOCB_NOWAIT;
3286 if (flags & RWF_HIPRI)
3287 ki->ki_flags |= IOCB_HIPRI;
3288 if (flags & RWF_DSYNC)
3289 ki->ki_flags |= IOCB_DSYNC;
3290 if (flags & RWF_SYNC)
3291 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
3292 if (flags & RWF_APPEND)
3293 ki->ki_flags |= IOCB_APPEND;
3297 static inline ino_t parent_ino(struct dentry *dentry)
3302 * Don't strictly need d_lock here? If the parent ino could change
3303 * then surely we'd have a deeper race in the caller?
3305 spin_lock(&dentry->d_lock);
3306 res = dentry->d_parent->d_inode->i_ino;
3307 spin_unlock(&dentry->d_lock);
3311 /* Transaction based IO helpers */
3314 * An argresp is stored in an allocated page and holds the
3315 * size of the argument or response, along with its content
3317 struct simple_transaction_argresp {
3322 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3324 char *simple_transaction_get(struct file *file, const char __user *buf,
3326 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3327 size_t size, loff_t *pos);
3328 int simple_transaction_release(struct inode *inode, struct file *file);
3330 void simple_transaction_set(struct file *file, size_t n);
3333 * simple attribute files
3335 * These attributes behave similar to those in sysfs:
3337 * Writing to an attribute immediately sets a value, an open file can be
3338 * written to multiple times.
3340 * Reading from an attribute creates a buffer from the value that might get
3341 * read with multiple read calls. When the attribute has been read
3342 * completely, no further read calls are possible until the file is opened
3345 * All attributes contain a text representation of a numeric value
3346 * that are accessed with the get() and set() functions.
3348 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3349 static int __fops ## _open(struct inode *inode, struct file *file) \
3351 __simple_attr_check_format(__fmt, 0ull); \
3352 return simple_attr_open(inode, file, __get, __set, __fmt); \
3354 static const struct file_operations __fops = { \
3355 .owner = THIS_MODULE, \
3356 .open = __fops ## _open, \
3357 .release = simple_attr_release, \
3358 .read = simple_attr_read, \
3359 .write = simple_attr_write, \
3360 .llseek = generic_file_llseek, \
3363 static inline __printf(1, 2)
3364 void __simple_attr_check_format(const char *fmt, ...)
3366 /* don't do anything, just let the compiler check the arguments; */
3369 int simple_attr_open(struct inode *inode, struct file *file,
3370 int (*get)(void *, u64 *), int (*set)(void *, u64),
3372 int simple_attr_release(struct inode *inode, struct file *file);
3373 ssize_t simple_attr_read(struct file *file, char __user *buf,
3374 size_t len, loff_t *ppos);
3375 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3376 size_t len, loff_t *ppos);
3379 int proc_nr_files(struct ctl_table *table, int write,
3380 void *buffer, size_t *lenp, loff_t *ppos);
3381 int proc_nr_dentry(struct ctl_table *table, int write,
3382 void *buffer, size_t *lenp, loff_t *ppos);
3383 int proc_nr_inodes(struct ctl_table *table, int write,
3384 void *buffer, size_t *lenp, loff_t *ppos);
3385 int __init get_filesystem_list(char *buf);
3387 #define __FMODE_EXEC ((__force int) FMODE_EXEC)
3388 #define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3390 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3391 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3392 (flag & __FMODE_NONOTIFY)))
3394 static inline bool is_sxid(umode_t mode)
3396 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3399 static inline int check_sticky(struct inode *dir, struct inode *inode)
3401 if (!(dir->i_mode & S_ISVTX))
3404 return __check_sticky(dir, inode);
3407 static inline void inode_has_no_xattr(struct inode *inode)
3409 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3410 inode->i_flags |= S_NOSEC;
3413 static inline bool is_root_inode(struct inode *inode)
3415 return inode == inode->i_sb->s_root->d_inode;
3418 static inline bool dir_emit(struct dir_context *ctx,
3419 const char *name, int namelen,
3420 u64 ino, unsigned type)
3422 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3424 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3426 return ctx->actor(ctx, ".", 1, ctx->pos,
3427 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3429 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3431 return ctx->actor(ctx, "..", 2, ctx->pos,
3432 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3434 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3436 if (ctx->pos == 0) {
3437 if (!dir_emit_dot(file, ctx))
3441 if (ctx->pos == 1) {
3442 if (!dir_emit_dotdot(file, ctx))
3448 static inline bool dir_relax(struct inode *inode)
3450 inode_unlock(inode);
3452 return !IS_DEADDIR(inode);
3455 static inline bool dir_relax_shared(struct inode *inode)
3457 inode_unlock_shared(inode);
3458 inode_lock_shared(inode);
3459 return !IS_DEADDIR(inode);
3462 extern bool path_noexec(const struct path *path);
3463 extern void inode_nohighmem(struct inode *inode);
3466 extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3468 extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3471 #if defined(CONFIG_IO_URING)
3472 extern struct sock *io_uring_get_socket(struct file *file);
3474 static inline struct sock *io_uring_get_socket(struct file *file)
3480 int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3481 unsigned int flags);
3483 int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3484 struct fsxattr *fa);
3486 static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3488 memset(fa, 0, sizeof(*fa));
3489 fa->fsx_xflags = xflags;
3493 * Flush file data before changing attributes. Caller must hold any locks
3494 * required to prevent further writes to this file until we're done setting
3497 static inline int inode_drain_writes(struct inode *inode)
3499 inode_dio_wait(inode);
3500 return filemap_write_and_wait(inode->i_mapping);
3503 #endif /* _LINUX_FS_H */