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)
178 /* File supports async buffered reads */
179 #define FMODE_BUF_RASYNC ((__force fmode_t)0x40000000)
182 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
183 * that indicates that they should check the contents of the iovec are
184 * valid, but not check the memory that the iovec elements
187 #define CHECK_IOVEC_ONLY -1
190 * Attribute flags. These should be or-ed together to figure out what
193 #define ATTR_MODE (1 << 0)
194 #define ATTR_UID (1 << 1)
195 #define ATTR_GID (1 << 2)
196 #define ATTR_SIZE (1 << 3)
197 #define ATTR_ATIME (1 << 4)
198 #define ATTR_MTIME (1 << 5)
199 #define ATTR_CTIME (1 << 6)
200 #define ATTR_ATIME_SET (1 << 7)
201 #define ATTR_MTIME_SET (1 << 8)
202 #define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
203 #define ATTR_KILL_SUID (1 << 11)
204 #define ATTR_KILL_SGID (1 << 12)
205 #define ATTR_FILE (1 << 13)
206 #define ATTR_KILL_PRIV (1 << 14)
207 #define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
208 #define ATTR_TIMES_SET (1 << 16)
209 #define ATTR_TOUCH (1 << 17)
212 * Whiteout is represented by a char device. The following constants define the
213 * mode and device number to use.
215 #define WHITEOUT_MODE 0
216 #define WHITEOUT_DEV 0
219 * This is the Inode Attributes structure, used for notify_change(). It
220 * uses the above definitions as flags, to know which values have changed.
221 * Also, in this manner, a Filesystem can look at only the values it cares
222 * about. Basically, these are the attributes that the VFS layer can
223 * request to change from the FS layer.
228 unsigned int ia_valid;
233 struct timespec64 ia_atime;
234 struct timespec64 ia_mtime;
235 struct timespec64 ia_ctime;
238 * Not an attribute, but an auxiliary info for filesystems wanting to
239 * implement an ftruncate() like method. NOTE: filesystem should
240 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
242 struct file *ia_file;
246 * Includes for diskquotas.
248 #include <linux/quota.h>
251 * Maximum number of layers of fs stack. Needs to be limited to
252 * prevent kernel stack overflow
254 #define FILESYSTEM_MAX_STACK_DEPTH 2
257 * enum positive_aop_returns - aop return codes with specific semantics
259 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
260 * completed, that the page is still locked, and
261 * should be considered active. The VM uses this hint
262 * to return the page to the active list -- it won't
263 * be a candidate for writeback again in the near
264 * future. Other callers must be careful to unlock
265 * the page if they get this return. Returned by
268 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
269 * unlocked it and the page might have been truncated.
270 * The caller should back up to acquiring a new page and
271 * trying again. The aop will be taking reasonable
272 * precautions not to livelock. If the caller held a page
273 * reference, it should drop it before retrying. Returned
276 * address_space_operation functions return these large constants to indicate
277 * special semantics to the caller. These are much larger than the bytes in a
278 * page to allow for functions that return the number of bytes operated on in a
282 enum positive_aop_returns {
283 AOP_WRITEPAGE_ACTIVATE = 0x80000,
284 AOP_TRUNCATED_PAGE = 0x80001,
287 #define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
288 #define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
289 * helper code (eg buffer layer)
290 * to clear GFP_FS from alloc */
293 * oh the beauties of C type declarations.
296 struct address_space;
297 struct writeback_control;
298 struct readahead_control;
301 * Write life time hint values.
302 * Stored in struct inode as u8.
305 WRITE_LIFE_NOT_SET = 0,
306 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
307 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
308 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
309 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
310 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
313 #define IOCB_EVENTFD (1 << 0)
314 #define IOCB_APPEND (1 << 1)
315 #define IOCB_DIRECT (1 << 2)
316 #define IOCB_HIPRI (1 << 3)
317 #define IOCB_DSYNC (1 << 4)
318 #define IOCB_SYNC (1 << 5)
319 #define IOCB_WRITE (1 << 6)
320 #define IOCB_NOWAIT (1 << 7)
321 /* iocb->ki_waitq is valid */
322 #define IOCB_WAITQ (1 << 8)
323 #define IOCB_NOIO (1 << 9)
326 struct file *ki_filp;
328 /* The 'ki_filp' pointer is shared in a union for aio */
329 randomized_struct_fields_start
332 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
336 u16 ki_ioprio; /* See linux/ioprio.h */
338 unsigned int ki_cookie; /* for ->iopoll */
339 struct wait_page_queue *ki_waitq; /* for async buffered IO */
342 randomized_struct_fields_end
345 static inline bool is_sync_kiocb(struct kiocb *kiocb)
347 return kiocb->ki_complete == NULL;
351 * "descriptor" for what we're up to with a read.
352 * This allows us to use the same read code yet
353 * have multiple different users of the data that
354 * we read from a file.
356 * The simplest case just copies the data to user
369 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
370 unsigned long, unsigned long);
372 struct address_space_operations {
373 int (*writepage)(struct page *page, struct writeback_control *wbc);
374 int (*readpage)(struct file *, struct page *);
376 /* Write back some dirty pages from this mapping. */
377 int (*writepages)(struct address_space *, struct writeback_control *);
379 /* Set a page dirty. Return true if this dirtied it */
380 int (*set_page_dirty)(struct page *page);
383 * Reads in the requested pages. Unlike ->readpage(), this is
384 * PURELY used for read-ahead!.
386 int (*readpages)(struct file *filp, struct address_space *mapping,
387 struct list_head *pages, unsigned nr_pages);
388 void (*readahead)(struct readahead_control *);
390 int (*write_begin)(struct file *, struct address_space *mapping,
391 loff_t pos, unsigned len, unsigned flags,
392 struct page **pagep, void **fsdata);
393 int (*write_end)(struct file *, struct address_space *mapping,
394 loff_t pos, unsigned len, unsigned copied,
395 struct page *page, void *fsdata);
397 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
398 sector_t (*bmap)(struct address_space *, sector_t);
399 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
400 int (*releasepage) (struct page *, gfp_t);
401 void (*freepage)(struct page *);
402 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
404 * migrate the contents of a page to the specified target. If
405 * migrate_mode is MIGRATE_ASYNC, it must not block.
407 int (*migratepage) (struct address_space *,
408 struct page *, struct page *, enum migrate_mode);
409 bool (*isolate_page)(struct page *, isolate_mode_t);
410 void (*putback_page)(struct page *);
411 int (*launder_page) (struct page *);
412 int (*is_partially_uptodate) (struct page *, unsigned long,
414 void (*is_dirty_writeback) (struct page *, bool *, bool *);
415 int (*error_remove_page)(struct address_space *, struct page *);
417 /* swapfile support */
418 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
420 void (*swap_deactivate)(struct file *file);
423 extern const struct address_space_operations empty_aops;
426 * pagecache_write_begin/pagecache_write_end must be used by general code
427 * to write into the pagecache.
429 int pagecache_write_begin(struct file *, struct address_space *mapping,
430 loff_t pos, unsigned len, unsigned flags,
431 struct page **pagep, void **fsdata);
433 int pagecache_write_end(struct file *, struct address_space *mapping,
434 loff_t pos, unsigned len, unsigned copied,
435 struct page *page, void *fsdata);
438 * struct address_space - Contents of a cacheable, mappable object.
439 * @host: Owner, either the inode or the block_device.
440 * @i_pages: Cached pages.
441 * @gfp_mask: Memory allocation flags to use for allocating pages.
442 * @i_mmap_writable: Number of VM_SHARED mappings.
443 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
444 * @i_mmap: Tree of private and shared mappings.
445 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
446 * @nrpages: Number of page entries, protected by the i_pages lock.
447 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
448 * @writeback_index: Writeback starts here.
450 * @flags: Error bits and flags (AS_*).
451 * @wb_err: The most recent error which has occurred.
452 * @private_lock: For use by the owner of the address_space.
453 * @private_list: For use by the owner of the address_space.
454 * @private_data: For use by the owner of the address_space.
456 struct address_space {
458 struct xarray i_pages;
460 atomic_t i_mmap_writable;
461 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
462 /* number of thp, only for non-shmem files */
465 struct rb_root_cached i_mmap;
466 struct rw_semaphore i_mmap_rwsem;
467 unsigned long nrpages;
468 unsigned long nrexceptional;
469 pgoff_t writeback_index;
470 const struct address_space_operations *a_ops;
473 spinlock_t private_lock;
474 struct list_head private_list;
476 } __attribute__((aligned(sizeof(long)))) __randomize_layout;
478 * On most architectures that alignment is already the case; but
479 * must be enforced here for CRIS, to let the least significant bit
480 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
483 /* XArray tags, for tagging dirty and writeback pages in the pagecache. */
484 #define PAGECACHE_TAG_DIRTY XA_MARK_0
485 #define PAGECACHE_TAG_WRITEBACK XA_MARK_1
486 #define PAGECACHE_TAG_TOWRITE XA_MARK_2
489 * Returns true if any of the pages in the mapping are marked with the tag.
491 static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
493 return xa_marked(&mapping->i_pages, tag);
496 static inline void i_mmap_lock_write(struct address_space *mapping)
498 down_write(&mapping->i_mmap_rwsem);
501 static inline int i_mmap_trylock_write(struct address_space *mapping)
503 return down_write_trylock(&mapping->i_mmap_rwsem);
506 static inline void i_mmap_unlock_write(struct address_space *mapping)
508 up_write(&mapping->i_mmap_rwsem);
511 static inline void i_mmap_lock_read(struct address_space *mapping)
513 down_read(&mapping->i_mmap_rwsem);
516 static inline void i_mmap_unlock_read(struct address_space *mapping)
518 up_read(&mapping->i_mmap_rwsem);
521 static inline void i_mmap_assert_locked(struct address_space *mapping)
523 lockdep_assert_held(&mapping->i_mmap_rwsem);
526 static inline void i_mmap_assert_write_locked(struct address_space *mapping)
528 lockdep_assert_held_write(&mapping->i_mmap_rwsem);
532 * Might pages of this file be mapped into userspace?
534 static inline int mapping_mapped(struct address_space *mapping)
536 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
540 * Might pages of this file have been modified in userspace?
541 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap
542 * marks vma as VM_SHARED if it is shared, and the file was opened for
543 * writing i.e. vma may be mprotected writable even if now readonly.
545 * If i_mmap_writable is negative, no new writable mappings are allowed. You
546 * can only deny writable mappings, if none exists right now.
548 static inline int mapping_writably_mapped(struct address_space *mapping)
550 return atomic_read(&mapping->i_mmap_writable) > 0;
553 static inline int mapping_map_writable(struct address_space *mapping)
555 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
559 static inline void mapping_unmap_writable(struct address_space *mapping)
561 atomic_dec(&mapping->i_mmap_writable);
564 static inline int mapping_deny_writable(struct address_space *mapping)
566 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
570 static inline void mapping_allow_writable(struct address_space *mapping)
572 atomic_inc(&mapping->i_mmap_writable);
576 * Use sequence counter to get consistent i_size on 32-bit processors.
578 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
579 #include <linux/seqlock.h>
580 #define __NEED_I_SIZE_ORDERED
581 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
583 #define i_size_ordered_init(inode) do { } while (0)
587 #define ACL_NOT_CACHED ((void *)(-1))
588 #define ACL_DONT_CACHE ((void *)(-3))
590 static inline struct posix_acl *
591 uncached_acl_sentinel(struct task_struct *task)
593 return (void *)task + 1;
597 is_uncached_acl(struct posix_acl *acl)
599 return (long)acl & 1;
602 #define IOP_FASTPERM 0x0001
603 #define IOP_LOOKUP 0x0002
604 #define IOP_NOFOLLOW 0x0004
605 #define IOP_XATTR 0x0008
606 #define IOP_DEFAULT_READLINK 0x0010
608 struct fsnotify_mark_connector;
611 * Keep mostly read-only and often accessed (especially for
612 * the RCU path lookup and 'stat' data) fields at the beginning
613 * of the 'struct inode'
617 unsigned short i_opflags;
620 unsigned int i_flags;
622 #ifdef CONFIG_FS_POSIX_ACL
623 struct posix_acl *i_acl;
624 struct posix_acl *i_default_acl;
627 const struct inode_operations *i_op;
628 struct super_block *i_sb;
629 struct address_space *i_mapping;
631 #ifdef CONFIG_SECURITY
635 /* Stat data, not accessed from path walking */
638 * Filesystems may only read i_nlink directly. They shall use the
639 * following functions for modification:
641 * (set|clear|inc|drop)_nlink
642 * inode_(inc|dec)_link_count
645 const unsigned int i_nlink;
646 unsigned int __i_nlink;
650 struct timespec64 i_atime;
651 struct timespec64 i_mtime;
652 struct timespec64 i_ctime;
653 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
654 unsigned short i_bytes;
659 #ifdef __NEED_I_SIZE_ORDERED
660 seqcount_t i_size_seqcount;
664 unsigned long i_state;
665 struct rw_semaphore i_rwsem;
667 unsigned long dirtied_when; /* jiffies of first dirtying */
668 unsigned long dirtied_time_when;
670 struct hlist_node i_hash;
671 struct list_head i_io_list; /* backing dev IO list */
672 #ifdef CONFIG_CGROUP_WRITEBACK
673 struct bdi_writeback *i_wb; /* the associated cgroup wb */
675 /* foreign inode detection, see wbc_detach_inode() */
677 u16 i_wb_frn_avg_time;
678 u16 i_wb_frn_history;
680 struct list_head i_lru; /* inode LRU list */
681 struct list_head i_sb_list;
682 struct list_head i_wb_list; /* backing dev writeback list */
684 struct hlist_head i_dentry;
685 struct rcu_head i_rcu;
687 atomic64_t i_version;
688 atomic64_t i_sequence; /* see futex */
690 atomic_t i_dio_count;
691 atomic_t i_writecount;
692 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
693 atomic_t i_readcount; /* struct files open RO */
696 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
697 void (*free_inode)(struct inode *);
699 struct file_lock_context *i_flctx;
700 struct address_space i_data;
701 struct list_head i_devices;
703 struct pipe_inode_info *i_pipe;
704 struct block_device *i_bdev;
712 #ifdef CONFIG_FSNOTIFY
713 __u32 i_fsnotify_mask; /* all events this inode cares about */
714 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
717 #ifdef CONFIG_FS_ENCRYPTION
718 struct fscrypt_info *i_crypt_info;
721 #ifdef CONFIG_FS_VERITY
722 struct fsverity_info *i_verity_info;
725 void *i_private; /* fs or device private pointer */
726 } __randomize_layout;
728 struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);
730 static inline unsigned int i_blocksize(const struct inode *node)
732 return (1 << node->i_blkbits);
735 static inline int inode_unhashed(struct inode *inode)
737 return hlist_unhashed(&inode->i_hash);
741 * __mark_inode_dirty expects inodes to be hashed. Since we don't
742 * want special inodes in the fileset inode space, we make them
743 * appear hashed, but do not put on any lists. hlist_del()
744 * will work fine and require no locking.
746 static inline void inode_fake_hash(struct inode *inode)
748 hlist_add_fake(&inode->i_hash);
752 * inode->i_mutex nesting subclasses for the lock validator:
754 * 0: the object of the current VFS operation
758 * 4: second non-directory
759 * 5: second parent (when locking independent directories in rename)
761 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
762 * non-directories at once.
764 * The locking order between these classes is
765 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
767 enum inode_i_mutex_lock_class
777 static inline void inode_lock(struct inode *inode)
779 down_write(&inode->i_rwsem);
782 static inline void inode_unlock(struct inode *inode)
784 up_write(&inode->i_rwsem);
787 static inline void inode_lock_shared(struct inode *inode)
789 down_read(&inode->i_rwsem);
792 static inline void inode_unlock_shared(struct inode *inode)
794 up_read(&inode->i_rwsem);
797 static inline int inode_trylock(struct inode *inode)
799 return down_write_trylock(&inode->i_rwsem);
802 static inline int inode_trylock_shared(struct inode *inode)
804 return down_read_trylock(&inode->i_rwsem);
807 static inline int inode_is_locked(struct inode *inode)
809 return rwsem_is_locked(&inode->i_rwsem);
812 static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
814 down_write_nested(&inode->i_rwsem, subclass);
817 static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
819 down_read_nested(&inode->i_rwsem, subclass);
822 void lock_two_nondirectories(struct inode *, struct inode*);
823 void unlock_two_nondirectories(struct inode *, struct inode*);
826 * NOTE: in a 32bit arch with a preemptable kernel and
827 * an UP compile the i_size_read/write must be atomic
828 * with respect to the local cpu (unlike with preempt disabled),
829 * but they don't need to be atomic with respect to other cpus like in
830 * true SMP (so they need either to either locally disable irq around
831 * the read or for example on x86 they can be still implemented as a
832 * cmpxchg8b without the need of the lock prefix). For SMP compiles
833 * and 64bit archs it makes no difference if preempt is enabled or not.
835 static inline loff_t i_size_read(const struct inode *inode)
837 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
842 seq = read_seqcount_begin(&inode->i_size_seqcount);
843 i_size = inode->i_size;
844 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
846 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
850 i_size = inode->i_size;
854 return inode->i_size;
859 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
860 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
861 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
863 static inline void i_size_write(struct inode *inode, loff_t i_size)
865 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
867 write_seqcount_begin(&inode->i_size_seqcount);
868 inode->i_size = i_size;
869 write_seqcount_end(&inode->i_size_seqcount);
871 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
873 inode->i_size = i_size;
876 inode->i_size = i_size;
880 static inline unsigned iminor(const struct inode *inode)
882 return MINOR(inode->i_rdev);
885 static inline unsigned imajor(const struct inode *inode)
887 return MAJOR(inode->i_rdev);
891 rwlock_t lock; /* protects pid, uid, euid fields */
892 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
893 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
894 kuid_t uid, euid; /* uid/euid of process setting the owner */
895 int signum; /* posix.1b rt signal to be delivered on IO */
899 * Track a single file's readahead state
901 struct file_ra_state {
902 pgoff_t start; /* where readahead started */
903 unsigned int size; /* # of readahead pages */
904 unsigned int async_size; /* do asynchronous readahead when
905 there are only # of pages ahead */
907 unsigned int ra_pages; /* Maximum readahead window */
908 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
909 loff_t prev_pos; /* Cache last read() position */
913 * Check if @index falls in the readahead windows.
915 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
917 return (index >= ra->start &&
918 index < ra->start + ra->size);
923 struct llist_node fu_llist;
924 struct rcu_head fu_rcuhead;
927 struct inode *f_inode; /* cached value */
928 const struct file_operations *f_op;
931 * Protects f_ep_links, f_flags.
932 * Must not be taken from IRQ context.
935 enum rw_hint f_write_hint;
936 atomic_long_t f_count;
937 unsigned int f_flags;
939 struct mutex f_pos_lock;
941 struct fown_struct f_owner;
942 const struct cred *f_cred;
943 struct file_ra_state f_ra;
946 #ifdef CONFIG_SECURITY
949 /* needed for tty driver, and maybe others */
953 /* Used by fs/eventpoll.c to link all the hooks to this file */
954 struct list_head f_ep_links;
955 struct list_head f_tfile_llink;
956 #endif /* #ifdef CONFIG_EPOLL */
957 struct address_space *f_mapping;
959 errseq_t f_sb_err; /* for syncfs */
961 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
966 /* file identifier */
967 unsigned char f_handle[];
970 static inline struct file *get_file(struct file *f)
972 atomic_long_inc(&f->f_count);
975 #define get_file_rcu_many(x, cnt) \
976 atomic_long_add_unless(&(x)->f_count, (cnt), 0)
977 #define get_file_rcu(x) get_file_rcu_many((x), 1)
978 #define file_count(x) atomic_long_read(&(x)->f_count)
980 #define MAX_NON_LFS ((1UL<<31) - 1)
982 /* Page cache limit. The filesystems should put that into their s_maxbytes
983 limits, otherwise bad things can happen in VM. */
984 #if BITS_PER_LONG==32
985 #define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
986 #elif BITS_PER_LONG==64
987 #define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
992 #define FL_DELEG 4 /* NFSv4 delegation */
993 #define FL_ACCESS 8 /* not trying to lock, just looking */
994 #define FL_EXISTS 16 /* when unlocking, test for existence */
995 #define FL_LEASE 32 /* lease held on this file */
996 #define FL_CLOSE 64 /* unlock on close */
997 #define FL_SLEEP 128 /* A blocking lock */
998 #define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
999 #define FL_UNLOCK_PENDING 512 /* Lease is being broken */
1000 #define FL_OFDLCK 1024 /* lock is "owned" by struct file */
1001 #define FL_LAYOUT 2048 /* outstanding pNFS layout */
1003 #define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
1006 * Special return value from posix_lock_file() and vfs_lock_file() for
1007 * asynchronous locking.
1009 #define FILE_LOCK_DEFERRED 1
1011 /* legacy typedef, should eventually be removed */
1012 typedef void *fl_owner_t;
1016 struct file_lock_operations {
1017 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1018 void (*fl_release_private)(struct file_lock *);
1021 struct lock_manager_operations {
1022 fl_owner_t (*lm_get_owner)(fl_owner_t);
1023 void (*lm_put_owner)(fl_owner_t);
1024 void (*lm_notify)(struct file_lock *); /* unblock callback */
1025 int (*lm_grant)(struct file_lock *, int);
1026 bool (*lm_break)(struct file_lock *);
1027 int (*lm_change)(struct file_lock *, int, struct list_head *);
1028 void (*lm_setup)(struct file_lock *, void **);
1029 bool (*lm_breaker_owns_lease)(struct file_lock *);
1032 struct lock_manager {
1033 struct list_head list;
1035 * NFSv4 and up also want opens blocked during the grace period;
1042 void locks_start_grace(struct net *, struct lock_manager *);
1043 void locks_end_grace(struct lock_manager *);
1044 bool locks_in_grace(struct net *);
1045 bool opens_in_grace(struct net *);
1047 /* that will die - we need it for nfs_lock_info */
1048 #include <linux/nfs_fs_i.h>
1051 * struct file_lock represents a generic "file lock". It's used to represent
1052 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1053 * note that the same struct is used to represent both a request for a lock and
1054 * the lock itself, but the same object is never used for both.
1056 * FIXME: should we create a separate "struct lock_request" to help distinguish
1059 * The varous i_flctx lists are ordered by:
1062 * 2) lock range start
1065 * Obviously, the last two criteria only matter for POSIX locks.
1068 struct file_lock *fl_blocker; /* The lock, that is blocking us */
1069 struct list_head fl_list; /* link into file_lock_context */
1070 struct hlist_node fl_link; /* node in global lists */
1071 struct list_head fl_blocked_requests; /* list of requests with
1072 * ->fl_blocker pointing here
1074 struct list_head fl_blocked_member; /* node in
1075 * ->fl_blocker->fl_blocked_requests
1077 fl_owner_t fl_owner;
1078 unsigned int fl_flags;
1079 unsigned char fl_type;
1080 unsigned int fl_pid;
1081 int fl_link_cpu; /* what cpu's list is this on? */
1082 wait_queue_head_t fl_wait;
1083 struct file *fl_file;
1087 struct fasync_struct * fl_fasync; /* for lease break notifications */
1088 /* for lease breaks: */
1089 unsigned long fl_break_time;
1090 unsigned long fl_downgrade_time;
1092 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
1093 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
1095 struct nfs_lock_info nfs_fl;
1096 struct nfs4_lock_info nfs4_fl;
1098 struct list_head link; /* link in AFS vnode's pending_locks list */
1099 int state; /* state of grant or error if -ve */
1100 unsigned int debug_id;
1103 } __randomize_layout;
1105 struct file_lock_context {
1106 spinlock_t flc_lock;
1107 struct list_head flc_flock;
1108 struct list_head flc_posix;
1109 struct list_head flc_lease;
1112 /* The following constant reflects the upper bound of the file/locking space */
1114 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1115 #define OFFSET_MAX INT_LIMIT(loff_t)
1116 #define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1119 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1121 #define locks_inode(f) file_inode(f)
1123 #ifdef CONFIG_FILE_LOCKING
1124 extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1125 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1128 #if BITS_PER_LONG == 32
1129 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1130 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1134 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1135 extern int fcntl_getlease(struct file *filp);
1138 void locks_free_lock_context(struct inode *inode);
1139 void locks_free_lock(struct file_lock *fl);
1140 extern void locks_init_lock(struct file_lock *);
1141 extern struct file_lock * locks_alloc_lock(void);
1142 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1143 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1144 extern void locks_remove_posix(struct file *, fl_owner_t);
1145 extern void locks_remove_file(struct file *);
1146 extern void locks_release_private(struct file_lock *);
1147 extern void posix_test_lock(struct file *, struct file_lock *);
1148 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1149 extern int locks_delete_block(struct file_lock *);
1150 extern int vfs_test_lock(struct file *, struct file_lock *);
1151 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1152 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1153 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
1154 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1155 extern void lease_get_mtime(struct inode *, struct timespec64 *time);
1156 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1157 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1158 extern int lease_modify(struct file_lock *, int, struct list_head *);
1160 struct notifier_block;
1161 extern int lease_register_notifier(struct notifier_block *);
1162 extern void lease_unregister_notifier(struct notifier_block *);
1164 struct files_struct;
1165 extern void show_fd_locks(struct seq_file *f,
1166 struct file *filp, struct files_struct *files);
1167 #else /* !CONFIG_FILE_LOCKING */
1168 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1169 struct flock __user *user)
1174 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1175 unsigned int cmd, struct flock __user *user)
1180 #if BITS_PER_LONG == 32
1181 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1182 struct flock64 __user *user)
1187 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1188 unsigned int cmd, struct flock64 __user *user)
1193 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1198 static inline int fcntl_getlease(struct file *filp)
1204 locks_free_lock_context(struct inode *inode)
1208 static inline void locks_init_lock(struct file_lock *fl)
1213 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1218 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1223 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1228 static inline void locks_remove_file(struct file *filp)
1233 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1238 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1239 struct file_lock *conflock)
1244 static inline int locks_delete_block(struct file_lock *waiter)
1249 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1254 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1255 struct file_lock *fl, struct file_lock *conf)
1260 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1265 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1270 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1275 static inline void lease_get_mtime(struct inode *inode,
1276 struct timespec64 *time)
1281 static inline int generic_setlease(struct file *filp, long arg,
1282 struct file_lock **flp, void **priv)
1287 static inline int vfs_setlease(struct file *filp, long arg,
1288 struct file_lock **lease, void **priv)
1293 static inline int lease_modify(struct file_lock *fl, int arg,
1294 struct list_head *dispose)
1299 struct files_struct;
1300 static inline void show_fd_locks(struct seq_file *f,
1301 struct file *filp, struct files_struct *files) {}
1302 #endif /* !CONFIG_FILE_LOCKING */
1304 static inline struct inode *file_inode(const struct file *f)
1309 static inline struct dentry *file_dentry(const struct file *file)
1311 return d_real(file->f_path.dentry, file_inode(file));
1314 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1316 return locks_lock_inode_wait(locks_inode(filp), fl);
1319 struct fasync_struct {
1323 struct fasync_struct *fa_next; /* singly linked list */
1324 struct file *fa_file;
1325 struct rcu_head fa_rcu;
1328 #define FASYNC_MAGIC 0x4601
1330 /* SMP safe fasync helpers: */
1331 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1332 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1333 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1334 extern struct fasync_struct *fasync_alloc(void);
1335 extern void fasync_free(struct fasync_struct *);
1337 /* can be called from interrupts */
1338 extern void kill_fasync(struct fasync_struct **, int, int);
1340 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1341 extern int f_setown(struct file *filp, unsigned long arg, int force);
1342 extern void f_delown(struct file *filp);
1343 extern pid_t f_getown(struct file *filp);
1344 extern int send_sigurg(struct fown_struct *fown);
1347 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1348 * represented in both.
1350 #define SB_RDONLY 1 /* Mount read-only */
1351 #define SB_NOSUID 2 /* Ignore suid and sgid bits */
1352 #define SB_NODEV 4 /* Disallow access to device special files */
1353 #define SB_NOEXEC 8 /* Disallow program execution */
1354 #define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1355 #define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1356 #define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1357 #define SB_NOATIME 1024 /* Do not update access times. */
1358 #define SB_NODIRATIME 2048 /* Do not update directory access times */
1359 #define SB_SILENT 32768
1360 #define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1361 #define SB_INLINECRYPT (1<<17) /* Use blk-crypto for encrypted files */
1362 #define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1363 #define SB_I_VERSION (1<<23) /* Update inode I_version field */
1364 #define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1366 /* These sb flags are internal to the kernel */
1367 #define SB_SUBMOUNT (1<<26)
1368 #define SB_FORCE (1<<27)
1369 #define SB_NOSEC (1<<28)
1370 #define SB_BORN (1<<29)
1371 #define SB_ACTIVE (1<<30)
1372 #define SB_NOUSER (1<<31)
1378 #define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1379 #define MNT_DETACH 0x00000002 /* Just detach from the tree */
1380 #define MNT_EXPIRE 0x00000004 /* Mark for expiry */
1381 #define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1382 #define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1385 #define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
1386 #define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
1387 #define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
1388 #define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
1390 /* sb->s_iflags to limit user namespace mounts */
1391 #define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
1392 #define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1393 #define SB_I_UNTRUSTED_MOUNTER 0x00000040
1395 #define SB_I_SKIP_SYNC 0x00000100 /* Skip superblock at global sync */
1397 /* Possible states of 'frozen' field */
1399 SB_UNFROZEN = 0, /* FS is unfrozen */
1400 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
1401 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1402 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1403 * internal threads if needed) */
1404 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1407 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1410 int frozen; /* Is sb frozen? */
1411 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1412 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
1415 struct super_block {
1416 struct list_head s_list; /* Keep this first */
1417 dev_t s_dev; /* search index; _not_ kdev_t */
1418 unsigned char s_blocksize_bits;
1419 unsigned long s_blocksize;
1420 loff_t s_maxbytes; /* Max file size */
1421 struct file_system_type *s_type;
1422 const struct super_operations *s_op;
1423 const struct dquot_operations *dq_op;
1424 const struct quotactl_ops *s_qcop;
1425 const struct export_operations *s_export_op;
1426 unsigned long s_flags;
1427 unsigned long s_iflags; /* internal SB_I_* flags */
1428 unsigned long s_magic;
1429 struct dentry *s_root;
1430 struct rw_semaphore s_umount;
1433 #ifdef CONFIG_SECURITY
1436 const struct xattr_handler **s_xattr;
1437 #ifdef CONFIG_FS_ENCRYPTION
1438 const struct fscrypt_operations *s_cop;
1439 struct key *s_master_keys; /* master crypto keys in use */
1441 #ifdef CONFIG_FS_VERITY
1442 const struct fsverity_operations *s_vop;
1444 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
1445 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1446 struct block_device *s_bdev;
1447 struct backing_dev_info *s_bdi;
1448 struct mtd_info *s_mtd;
1449 struct hlist_node s_instances;
1450 unsigned int s_quota_types; /* Bitmask of supported quota types */
1451 struct quota_info s_dquot; /* Diskquota specific options */
1453 struct sb_writers s_writers;
1456 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1457 * s_fsnotify_marks together for cache efficiency. They are frequently
1458 * accessed and rarely modified.
1460 void *s_fs_info; /* Filesystem private info */
1462 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1464 /* Time limits for c/m/atime in seconds */
1465 time64_t s_time_min;
1466 time64_t s_time_max;
1467 #ifdef CONFIG_FSNOTIFY
1468 __u32 s_fsnotify_mask;
1469 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1472 char s_id[32]; /* Informational name */
1473 uuid_t s_uuid; /* UUID */
1475 unsigned int s_max_links;
1479 * The next field is for VFS *only*. No filesystems have any business
1480 * even looking at it. You had been warned.
1482 struct mutex s_vfs_rename_mutex; /* Kludge */
1485 * Filesystem subtype. If non-empty the filesystem type field
1486 * in /proc/mounts will be "type.subtype"
1488 const char *s_subtype;
1490 const struct dentry_operations *s_d_op; /* default d_op for dentries */
1493 * Saved pool identifier for cleancache (-1 means none)
1495 int cleancache_poolid;
1497 struct shrinker s_shrink; /* per-sb shrinker handle */
1499 /* Number of inodes with nlink == 0 but still referenced */
1500 atomic_long_t s_remove_count;
1502 /* Pending fsnotify inode refs */
1503 atomic_long_t s_fsnotify_inode_refs;
1505 /* Being remounted read-only */
1506 int s_readonly_remount;
1508 /* per-sb errseq_t for reporting writeback errors via syncfs */
1511 /* AIO completions deferred from interrupt context */
1512 struct workqueue_struct *s_dio_done_wq;
1513 struct hlist_head s_pins;
1516 * Owning user namespace and default context in which to
1517 * interpret filesystem uids, gids, quotas, device nodes,
1518 * xattrs and security labels.
1520 struct user_namespace *s_user_ns;
1523 * The list_lru structure is essentially just a pointer to a table
1524 * of per-node lru lists, each of which has its own spinlock.
1525 * There is no need to put them into separate cachelines.
1527 struct list_lru s_dentry_lru;
1528 struct list_lru s_inode_lru;
1529 struct rcu_head rcu;
1530 struct work_struct destroy_work;
1532 struct mutex s_sync_lock; /* sync serialisation lock */
1535 * Indicates how deep in a filesystem stack this SB is
1539 /* s_inode_list_lock protects s_inodes */
1540 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1541 struct list_head s_inodes; /* all inodes */
1543 spinlock_t s_inode_wblist_lock;
1544 struct list_head s_inodes_wb; /* writeback inodes */
1545 } __randomize_layout;
1547 /* Helper functions so that in most cases filesystems will
1548 * not need to deal directly with kuid_t and kgid_t and can
1549 * instead deal with the raw numeric values that are stored
1550 * in the filesystem.
1552 static inline uid_t i_uid_read(const struct inode *inode)
1554 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1557 static inline gid_t i_gid_read(const struct inode *inode)
1559 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1562 static inline void i_uid_write(struct inode *inode, uid_t uid)
1564 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1567 static inline void i_gid_write(struct inode *inode, gid_t gid)
1569 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1572 extern struct timespec64 current_time(struct inode *inode);
1575 * Snapshotting support.
1578 void __sb_end_write(struct super_block *sb, int level);
1579 int __sb_start_write(struct super_block *sb, int level, bool wait);
1581 #define __sb_writers_acquired(sb, lev) \
1582 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1583 #define __sb_writers_release(sb, lev) \
1584 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1587 * sb_end_write - drop write access to a superblock
1588 * @sb: the super we wrote to
1590 * Decrement number of writers to the filesystem. Wake up possible waiters
1591 * wanting to freeze the filesystem.
1593 static inline void sb_end_write(struct super_block *sb)
1595 __sb_end_write(sb, SB_FREEZE_WRITE);
1599 * sb_end_pagefault - drop write access to a superblock from a page fault
1600 * @sb: the super we wrote to
1602 * Decrement number of processes handling write page fault to the filesystem.
1603 * Wake up possible waiters wanting to freeze the filesystem.
1605 static inline void sb_end_pagefault(struct super_block *sb)
1607 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1611 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1612 * @sb: the super we wrote to
1614 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1615 * waiters wanting to freeze the filesystem.
1617 static inline void sb_end_intwrite(struct super_block *sb)
1619 __sb_end_write(sb, SB_FREEZE_FS);
1623 * sb_start_write - get write access to a superblock
1624 * @sb: the super we write to
1626 * When a process wants to write data or metadata to a file system (i.e. dirty
1627 * a page or an inode), it should embed the operation in a sb_start_write() -
1628 * sb_end_write() pair to get exclusion against file system freezing. This
1629 * function increments number of writers preventing freezing. If the file
1630 * system is already frozen, the function waits until the file system is
1633 * Since freeze protection behaves as a lock, users have to preserve
1634 * ordering of freeze protection and other filesystem locks. Generally,
1635 * freeze protection should be the outermost lock. In particular, we have:
1638 * -> i_mutex (write path, truncate, directory ops, ...)
1639 * -> s_umount (freeze_super, thaw_super)
1641 static inline void sb_start_write(struct super_block *sb)
1643 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1646 static inline int sb_start_write_trylock(struct super_block *sb)
1648 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1652 * sb_start_pagefault - get write access to a superblock from a page fault
1653 * @sb: the super we write to
1655 * When a process starts handling write page fault, it should embed the
1656 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1657 * exclusion against file system freezing. This is needed since the page fault
1658 * is going to dirty a page. This function increments number of running page
1659 * faults preventing freezing. If the file system is already frozen, the
1660 * function waits until the file system is thawed.
1662 * Since page fault freeze protection behaves as a lock, users have to preserve
1663 * ordering of freeze protection and other filesystem locks. It is advised to
1664 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
1665 * handling code implies lock dependency:
1668 * -> sb_start_pagefault
1670 static inline void sb_start_pagefault(struct super_block *sb)
1672 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1676 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1677 * @sb: the super we write to
1679 * This is the third level of protection against filesystem freezing. It is
1680 * free for use by a filesystem. The only requirement is that it must rank
1681 * below sb_start_pagefault.
1683 * For example filesystem can call sb_start_intwrite() when starting a
1684 * transaction which somewhat eases handling of freezing for internal sources
1685 * of filesystem changes (internal fs threads, discarding preallocation on file
1688 static inline void sb_start_intwrite(struct super_block *sb)
1690 __sb_start_write(sb, SB_FREEZE_FS, true);
1693 static inline int sb_start_intwrite_trylock(struct super_block *sb)
1695 return __sb_start_write(sb, SB_FREEZE_FS, false);
1699 extern bool inode_owner_or_capable(const struct inode *inode);
1702 * VFS helper functions..
1704 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1705 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1706 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1707 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1708 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1709 extern int vfs_rmdir(struct inode *, struct dentry *);
1710 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1711 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1713 static inline int vfs_whiteout(struct inode *dir, struct dentry *dentry)
1715 return vfs_mknod(dir, dentry, S_IFCHR | WHITEOUT_MODE, WHITEOUT_DEV);
1718 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1721 int vfs_mkobj(struct dentry *, umode_t,
1722 int (*f)(struct dentry *, umode_t, void *),
1725 int vfs_fchown(struct file *file, uid_t user, gid_t group);
1726 int vfs_fchmod(struct file *file, umode_t mode);
1727 int vfs_utimes(const struct path *path, struct timespec64 *times);
1729 extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1731 #ifdef CONFIG_COMPAT
1732 extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
1735 #define compat_ptr_ioctl NULL
1739 * VFS file helper functions.
1741 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1743 extern bool may_open_dev(const struct path *path);
1746 * This is the "filldir" function type, used by readdir() to let
1747 * the kernel specify what kind of dirent layout it wants to have.
1748 * This allows the kernel to read directories into kernel space or
1749 * to have different dirent layouts depending on the binary type.
1752 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1755 struct dir_context {
1761 * These flags let !MMU mmap() govern direct device mapping vs immediate
1762 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1764 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1765 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1766 * NOMMU_MAP_READ: Can be mapped for reading
1767 * NOMMU_MAP_WRITE: Can be mapped for writing
1768 * NOMMU_MAP_EXEC: Can be mapped for execution
1770 #define NOMMU_MAP_COPY 0x00000001
1771 #define NOMMU_MAP_DIRECT 0x00000008
1772 #define NOMMU_MAP_READ VM_MAYREAD
1773 #define NOMMU_MAP_WRITE VM_MAYWRITE
1774 #define NOMMU_MAP_EXEC VM_MAYEXEC
1776 #define NOMMU_VMFLAGS \
1777 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1780 * These flags control the behavior of the remap_file_range function pointer.
1781 * If it is called with len == 0 that means "remap to end of source file".
1782 * See Documentation/filesystems/vfs.rst for more details about this call.
1784 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
1785 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
1787 #define REMAP_FILE_DEDUP (1 << 0)
1788 #define REMAP_FILE_CAN_SHORTEN (1 << 1)
1791 * These flags signal that the caller is ok with altering various aspects of
1792 * the behavior of the remap operation. The changes must be made by the
1793 * implementation; the vfs remap helper functions can take advantage of them.
1794 * Flags in this category exist to preserve the quirky behavior of the hoisted
1795 * btrfs clone/dedupe ioctls.
1797 #define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
1801 struct file_operations {
1802 struct module *owner;
1803 loff_t (*llseek) (struct file *, loff_t, int);
1804 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1805 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1806 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1807 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1808 int (*iopoll)(struct kiocb *kiocb, bool spin);
1809 int (*iterate) (struct file *, struct dir_context *);
1810 int (*iterate_shared) (struct file *, struct dir_context *);
1811 __poll_t (*poll) (struct file *, struct poll_table_struct *);
1812 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1813 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1814 int (*mmap) (struct file *, struct vm_area_struct *);
1815 unsigned long mmap_supported_flags;
1816 int (*open) (struct inode *, struct file *);
1817 int (*flush) (struct file *, fl_owner_t id);
1818 int (*release) (struct inode *, struct file *);
1819 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1820 int (*fasync) (int, struct file *, int);
1821 int (*lock) (struct file *, int, struct file_lock *);
1822 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1823 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1824 int (*check_flags)(int);
1825 int (*flock) (struct file *, int, struct file_lock *);
1826 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1827 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1828 int (*setlease)(struct file *, long, struct file_lock **, void **);
1829 long (*fallocate)(struct file *file, int mode, loff_t offset,
1831 void (*show_fdinfo)(struct seq_file *m, struct file *f);
1833 unsigned (*mmap_capabilities)(struct file *);
1835 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1836 loff_t, size_t, unsigned int);
1837 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1838 struct file *file_out, loff_t pos_out,
1839 loff_t len, unsigned int remap_flags);
1840 int (*fadvise)(struct file *, loff_t, loff_t, int);
1841 } __randomize_layout;
1843 struct inode_operations {
1844 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1845 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1846 int (*permission) (struct inode *, int);
1847 struct posix_acl * (*get_acl)(struct inode *, int);
1849 int (*readlink) (struct dentry *, char __user *,int);
1851 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1852 int (*link) (struct dentry *,struct inode *,struct dentry *);
1853 int (*unlink) (struct inode *,struct dentry *);
1854 int (*symlink) (struct inode *,struct dentry *,const char *);
1855 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1856 int (*rmdir) (struct inode *,struct dentry *);
1857 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1858 int (*rename) (struct inode *, struct dentry *,
1859 struct inode *, struct dentry *, unsigned int);
1860 int (*setattr) (struct dentry *, struct iattr *);
1861 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1862 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1863 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1865 int (*update_time)(struct inode *, struct timespec64 *, int);
1866 int (*atomic_open)(struct inode *, struct dentry *,
1867 struct file *, unsigned open_flag,
1868 umode_t create_mode);
1869 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1870 int (*set_acl)(struct inode *, struct posix_acl *, int);
1871 } ____cacheline_aligned;
1873 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1874 struct iov_iter *iter)
1876 return file->f_op->read_iter(kio, iter);
1879 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1880 struct iov_iter *iter)
1882 return file->f_op->write_iter(kio, iter);
1885 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1887 return file->f_op->mmap(file, vma);
1890 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1891 unsigned long nr_segs, unsigned long fast_segs,
1892 struct iovec *fast_pointer,
1893 struct iovec **ret_pointer);
1895 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1896 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1897 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1898 unsigned long, loff_t *, rwf_t);
1899 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1900 loff_t, size_t, unsigned int);
1901 extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
1902 struct file *file_out, loff_t pos_out,
1903 size_t len, unsigned int flags);
1904 extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
1905 struct file *file_out, loff_t pos_out,
1907 unsigned int remap_flags);
1908 extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
1909 struct file *file_out, loff_t pos_out,
1910 loff_t len, unsigned int remap_flags);
1911 extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1912 struct file *file_out, loff_t pos_out,
1913 loff_t len, unsigned int remap_flags);
1914 extern int vfs_dedupe_file_range(struct file *file,
1915 struct file_dedupe_range *same);
1916 extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1917 struct file *dst_file, loff_t dst_pos,
1918 loff_t len, unsigned int remap_flags);
1921 struct super_operations {
1922 struct inode *(*alloc_inode)(struct super_block *sb);
1923 void (*destroy_inode)(struct inode *);
1924 void (*free_inode)(struct inode *);
1926 void (*dirty_inode) (struct inode *, int flags);
1927 int (*write_inode) (struct inode *, struct writeback_control *wbc);
1928 int (*drop_inode) (struct inode *);
1929 void (*evict_inode) (struct inode *);
1930 void (*put_super) (struct super_block *);
1931 int (*sync_fs)(struct super_block *sb, int wait);
1932 int (*freeze_super) (struct super_block *);
1933 int (*freeze_fs) (struct super_block *);
1934 int (*thaw_super) (struct super_block *);
1935 int (*unfreeze_fs) (struct super_block *);
1936 int (*statfs) (struct dentry *, struct kstatfs *);
1937 int (*remount_fs) (struct super_block *, int *, char *);
1938 void (*umount_begin) (struct super_block *);
1940 int (*show_options)(struct seq_file *, struct dentry *);
1941 int (*show_devname)(struct seq_file *, struct dentry *);
1942 int (*show_path)(struct seq_file *, struct dentry *);
1943 int (*show_stats)(struct seq_file *, struct dentry *);
1945 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1946 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1947 struct dquot **(*get_dquots)(struct inode *);
1949 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1950 long (*nr_cached_objects)(struct super_block *,
1951 struct shrink_control *);
1952 long (*free_cached_objects)(struct super_block *,
1953 struct shrink_control *);
1957 * Inode flags - they have no relation to superblock flags now
1959 #define S_SYNC (1 << 0) /* Writes are synced at once */
1960 #define S_NOATIME (1 << 1) /* Do not update access times */
1961 #define S_APPEND (1 << 2) /* Append-only file */
1962 #define S_IMMUTABLE (1 << 3) /* Immutable file */
1963 #define S_DEAD (1 << 4) /* removed, but still open directory */
1964 #define S_NOQUOTA (1 << 5) /* Inode is not counted to quota */
1965 #define S_DIRSYNC (1 << 6) /* Directory modifications are synchronous */
1966 #define S_NOCMTIME (1 << 7) /* Do not update file c/mtime */
1967 #define S_SWAPFILE (1 << 8) /* Do not truncate: swapon got its bmaps */
1968 #define S_PRIVATE (1 << 9) /* Inode is fs-internal */
1969 #define S_IMA (1 << 10) /* Inode has an associated IMA struct */
1970 #define S_AUTOMOUNT (1 << 11) /* Automount/referral quasi-directory */
1971 #define S_NOSEC (1 << 12) /* no suid or xattr security attributes */
1972 #ifdef CONFIG_FS_DAX
1973 #define S_DAX (1 << 13) /* Direct Access, avoiding the page cache */
1975 #define S_DAX 0 /* Make all the DAX code disappear */
1977 #define S_ENCRYPTED (1 << 14) /* Encrypted file (using fs/crypto/) */
1978 #define S_CASEFOLD (1 << 15) /* Casefolded file */
1979 #define S_VERITY (1 << 16) /* Verity file (using fs/verity/) */
1982 * Note that nosuid etc flags are inode-specific: setting some file-system
1983 * flags just means all the inodes inherit those flags by default. It might be
1984 * possible to override it selectively if you really wanted to with some
1985 * ioctl() that is not currently implemented.
1987 * Exception: SB_RDONLY is always applied to the entire file system.
1989 * Unfortunately, it is possible to change a filesystems flags with it mounted
1990 * with files in use. This means that all of the inodes will not have their
1991 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1994 #define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1996 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
1997 #define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
1998 #define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
1999 ((inode)->i_flags & S_SYNC))
2000 #define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
2001 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
2002 #define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
2003 #define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
2004 #define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
2006 #define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
2007 #define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
2008 #define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
2009 #define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
2011 #define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
2012 #define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
2013 #define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2014 #define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2015 #define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2016 #define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2017 #define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
2018 #define IS_DAX(inode) ((inode)->i_flags & S_DAX)
2019 #define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
2020 #define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
2021 #define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
2023 #define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2024 (inode)->i_rdev == WHITEOUT_DEV)
2026 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2028 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2031 static inline enum rw_hint file_write_hint(struct file *file)
2033 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2034 return file->f_write_hint;
2036 return file_inode(file)->i_write_hint;
2039 static inline int iocb_flags(struct file *file);
2041 static inline u16 ki_hint_validate(enum rw_hint hint)
2043 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2045 if (hint <= max_hint)
2050 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2052 *kiocb = (struct kiocb) {
2054 .ki_flags = iocb_flags(filp),
2055 .ki_hint = ki_hint_validate(file_write_hint(filp)),
2056 .ki_ioprio = get_current_ioprio(),
2060 static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2063 *kiocb = (struct kiocb) {
2065 .ki_flags = kiocb_src->ki_flags,
2066 .ki_hint = kiocb_src->ki_hint,
2067 .ki_ioprio = kiocb_src->ki_ioprio,
2068 .ki_pos = kiocb_src->ki_pos,
2073 * Inode state bits. Protected by inode->i_lock
2075 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2076 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2078 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2079 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2080 * various stages of removing an inode.
2082 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
2084 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2085 * fdatasync(). i_atime is the usual cause.
2086 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2087 * these changes separately from I_DIRTY_SYNC so that we
2088 * don't have to write inode on fdatasync() when only
2089 * mtime has changed in it.
2090 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
2091 * I_NEW Serves as both a mutex and completion notification.
2092 * New inodes set I_NEW. If two processes both create
2093 * the same inode, one of them will release its inode and
2094 * wait for I_NEW to be released before returning.
2095 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2096 * also cause waiting on I_NEW, without I_NEW actually
2097 * being set. find_inode() uses this to prevent returning
2098 * nearly-dead inodes.
2099 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2100 * is zero. I_FREEING must be set when I_WILL_FREE is
2102 * I_FREEING Set when inode is about to be freed but still has dirty
2103 * pages or buffers attached or the inode itself is still
2105 * I_CLEAR Added by clear_inode(). In this state the inode is
2106 * clean and can be destroyed. Inode keeps I_FREEING.
2108 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2109 * prohibited for many purposes. iget() must wait for
2110 * the inode to be completely released, then create it
2111 * anew. Other functions will just ignore such inodes,
2112 * if appropriate. I_NEW is used for waiting.
2114 * I_SYNC Writeback of inode is running. The bit is set during
2115 * data writeback, and cleared with a wakeup on the bit
2116 * address once it is done. The bit is also used to pin
2117 * the inode in memory for flusher thread.
2119 * I_REFERENCED Marks the inode as recently references on the LRU list.
2121 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2123 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2124 * synchronize competing switching instances and to tell
2125 * wb stat updates to grab the i_pages lock. See
2126 * inode_switch_wbs_work_fn() for details.
2128 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2129 * and work dirs among overlayfs mounts.
2131 * I_CREATING New object's inode in the middle of setting up.
2133 * I_DONTCACHE Evict inode as soon as it is not used anymore.
2135 * I_SYNC_QUEUED Inode is queued in b_io or b_more_io writeback lists.
2136 * Used to detect that mark_inode_dirty() should not move
2137 * inode between dirty lists.
2139 * Q: What is the difference between I_WILL_FREE and I_FREEING?
2141 #define I_DIRTY_SYNC (1 << 0)
2142 #define I_DIRTY_DATASYNC (1 << 1)
2143 #define I_DIRTY_PAGES (1 << 2)
2145 #define I_NEW (1 << __I_NEW)
2146 #define I_WILL_FREE (1 << 4)
2147 #define I_FREEING (1 << 5)
2148 #define I_CLEAR (1 << 6)
2150 #define I_SYNC (1 << __I_SYNC)
2151 #define I_REFERENCED (1 << 8)
2152 #define __I_DIO_WAKEUP 9
2153 #define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
2154 #define I_LINKABLE (1 << 10)
2155 #define I_DIRTY_TIME (1 << 11)
2156 #define I_WB_SWITCH (1 << 13)
2157 #define I_OVL_INUSE (1 << 14)
2158 #define I_CREATING (1 << 15)
2159 #define I_DONTCACHE (1 << 16)
2160 #define I_SYNC_QUEUED (1 << 17)
2162 #define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2163 #define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2164 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
2166 extern void __mark_inode_dirty(struct inode *, int);
2167 static inline void mark_inode_dirty(struct inode *inode)
2169 __mark_inode_dirty(inode, I_DIRTY);
2172 static inline void mark_inode_dirty_sync(struct inode *inode)
2174 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2177 extern void inc_nlink(struct inode *inode);
2178 extern void drop_nlink(struct inode *inode);
2179 extern void clear_nlink(struct inode *inode);
2180 extern void set_nlink(struct inode *inode, unsigned int nlink);
2182 static inline void inode_inc_link_count(struct inode *inode)
2185 mark_inode_dirty(inode);
2188 static inline void inode_dec_link_count(struct inode *inode)
2191 mark_inode_dirty(inode);
2194 enum file_time_flags {
2201 extern bool atime_needs_update(const struct path *, struct inode *);
2202 extern void touch_atime(const struct path *);
2203 static inline void file_accessed(struct file *file)
2205 if (!(file->f_flags & O_NOATIME))
2206 touch_atime(&file->f_path);
2209 extern int file_modified(struct file *file);
2211 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2212 int sync_inode_metadata(struct inode *inode, int wait);
2214 struct file_system_type {
2217 #define FS_REQUIRES_DEV 1
2218 #define FS_BINARY_MOUNTDATA 2
2219 #define FS_HAS_SUBTYPE 4
2220 #define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
2221 #define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
2222 #define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
2223 int (*init_fs_context)(struct fs_context *);
2224 const struct fs_parameter_spec *parameters;
2225 struct dentry *(*mount) (struct file_system_type *, int,
2226 const char *, void *);
2227 void (*kill_sb) (struct super_block *);
2228 struct module *owner;
2229 struct file_system_type * next;
2230 struct hlist_head fs_supers;
2232 struct lock_class_key s_lock_key;
2233 struct lock_class_key s_umount_key;
2234 struct lock_class_key s_vfs_rename_key;
2235 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2237 struct lock_class_key i_lock_key;
2238 struct lock_class_key i_mutex_key;
2239 struct lock_class_key i_mutex_dir_key;
2242 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2244 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2245 int flags, const char *dev_name, void *data,
2246 int (*fill_super)(struct super_block *, void *, int));
2247 extern struct dentry *mount_single(struct file_system_type *fs_type,
2248 int flags, void *data,
2249 int (*fill_super)(struct super_block *, void *, int));
2250 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2251 int flags, void *data,
2252 int (*fill_super)(struct super_block *, void *, int));
2253 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2254 void generic_shutdown_super(struct super_block *sb);
2255 void kill_block_super(struct super_block *sb);
2256 void kill_anon_super(struct super_block *sb);
2257 void kill_litter_super(struct super_block *sb);
2258 void deactivate_super(struct super_block *sb);
2259 void deactivate_locked_super(struct super_block *sb);
2260 int set_anon_super(struct super_block *s, void *data);
2261 int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2262 int get_anon_bdev(dev_t *);
2263 void free_anon_bdev(dev_t);
2264 struct super_block *sget_fc(struct fs_context *fc,
2265 int (*test)(struct super_block *, struct fs_context *),
2266 int (*set)(struct super_block *, struct fs_context *));
2267 struct super_block *sget(struct file_system_type *type,
2268 int (*test)(struct super_block *,void *),
2269 int (*set)(struct super_block *,void *),
2270 int flags, void *data);
2272 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2273 #define fops_get(fops) \
2274 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2275 #define fops_put(fops) \
2276 do { if (fops) module_put((fops)->owner); } while(0)
2278 * This one is to be used *ONLY* from ->open() instances.
2279 * fops must be non-NULL, pinned down *and* module dependencies
2280 * should be sufficient to pin the caller down as well.
2282 #define replace_fops(f, fops) \
2284 struct file *__file = (f); \
2285 fops_put(__file->f_op); \
2286 BUG_ON(!(__file->f_op = (fops))); \
2289 extern int register_filesystem(struct file_system_type *);
2290 extern int unregister_filesystem(struct file_system_type *);
2291 extern struct vfsmount *kern_mount(struct file_system_type *);
2292 extern void kern_unmount(struct vfsmount *mnt);
2293 extern int may_umount_tree(struct vfsmount *);
2294 extern int may_umount(struct vfsmount *);
2295 extern long do_mount(const char *, const char __user *,
2296 const char *, unsigned long, void *);
2297 extern struct vfsmount *collect_mounts(const struct path *);
2298 extern void drop_collected_mounts(struct vfsmount *);
2299 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2301 extern int vfs_statfs(const struct path *, struct kstatfs *);
2302 extern int user_statfs(const char __user *, struct kstatfs *);
2303 extern int fd_statfs(int, struct kstatfs *);
2304 extern int freeze_super(struct super_block *super);
2305 extern int thaw_super(struct super_block *super);
2306 extern bool our_mnt(struct vfsmount *mnt);
2307 extern __printf(2, 3)
2308 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2309 extern int super_setup_bdi(struct super_block *sb);
2311 extern int current_umask(void);
2313 extern void ihold(struct inode * inode);
2314 extern void iput(struct inode *);
2315 extern int generic_update_time(struct inode *, struct timespec64 *, int);
2318 extern struct kobject *fs_kobj;
2320 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2322 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2323 extern int locks_mandatory_locked(struct file *);
2324 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2327 * Candidates for mandatory locking have the setgid bit set
2328 * but no group execute bit - an otherwise meaningless combination.
2331 static inline int __mandatory_lock(struct inode *ino)
2333 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2337 * ... and these candidates should be on SB_MANDLOCK mounted fs,
2338 * otherwise these will be advisory locks
2341 static inline int mandatory_lock(struct inode *ino)
2343 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2346 static inline int locks_verify_locked(struct file *file)
2348 if (mandatory_lock(locks_inode(file)))
2349 return locks_mandatory_locked(file);
2353 static inline int locks_verify_truncate(struct inode *inode,
2357 if (!inode->i_flctx || !mandatory_lock(inode))
2360 if (size < inode->i_size) {
2361 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2364 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2369 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2371 static inline int locks_mandatory_locked(struct file *file)
2376 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2377 loff_t start, loff_t end, unsigned char type)
2382 static inline int __mandatory_lock(struct inode *inode)
2387 static inline int mandatory_lock(struct inode *inode)
2392 static inline int locks_verify_locked(struct file *file)
2397 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2403 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2406 #ifdef CONFIG_FILE_LOCKING
2407 static inline int break_lease(struct inode *inode, unsigned int mode)
2410 * Since this check is lockless, we must ensure that any refcounts
2411 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2412 * could end up racing with tasks trying to set a new lease on this
2416 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2417 return __break_lease(inode, mode, FL_LEASE);
2421 static inline int break_deleg(struct inode *inode, unsigned int mode)
2424 * Since this check is lockless, we must ensure that any refcounts
2425 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2426 * could end up racing with tasks trying to set a new lease on this
2430 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2431 return __break_lease(inode, mode, FL_DELEG);
2435 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2439 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2440 if (ret == -EWOULDBLOCK && delegated_inode) {
2441 *delegated_inode = inode;
2447 static inline int break_deleg_wait(struct inode **delegated_inode)
2451 ret = break_deleg(*delegated_inode, O_WRONLY);
2452 iput(*delegated_inode);
2453 *delegated_inode = NULL;
2457 static inline int break_layout(struct inode *inode, bool wait)
2460 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2461 return __break_lease(inode,
2462 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2467 #else /* !CONFIG_FILE_LOCKING */
2468 static inline int break_lease(struct inode *inode, unsigned int mode)
2473 static inline int break_deleg(struct inode *inode, unsigned int mode)
2478 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2483 static inline int break_deleg_wait(struct inode **delegated_inode)
2489 static inline int break_layout(struct inode *inode, bool wait)
2494 #endif /* CONFIG_FILE_LOCKING */
2499 const char *name; /* pointer to actual string */
2500 const __user char *uptr; /* original userland pointer */
2502 struct audit_names *aname;
2505 static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
2507 extern long vfs_truncate(const struct path *, loff_t);
2508 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2510 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2512 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2514 extern struct file *file_open_name(struct filename *, int, umode_t);
2515 extern struct file *filp_open(const char *, int, umode_t);
2516 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2517 const char *, int, umode_t);
2518 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2519 extern struct file * open_with_fake_path(const struct path *, int,
2520 struct inode*, const struct cred *);
2521 static inline struct file *file_clone_open(struct file *file)
2523 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2525 extern int filp_close(struct file *, fl_owner_t id);
2527 extern struct filename *getname_flags(const char __user *, int, int *);
2528 extern struct filename *getname(const char __user *);
2529 extern struct filename *getname_kernel(const char *);
2530 extern void putname(struct filename *name);
2532 extern int finish_open(struct file *file, struct dentry *dentry,
2533 int (*open)(struct inode *, struct file *));
2534 extern int finish_no_open(struct file *file, struct dentry *dentry);
2537 extern void __init vfs_caches_init_early(void);
2538 extern void __init vfs_caches_init(void);
2540 extern struct kmem_cache *names_cachep;
2542 #define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
2543 #define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
2545 extern struct super_block *blockdev_superblock;
2546 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2548 return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
2551 void emergency_thaw_all(void);
2552 extern int sync_filesystem(struct super_block *);
2553 extern const struct file_operations def_blk_fops;
2554 extern const struct file_operations def_chr_fops;
2557 #define CHRDEV_MAJOR_MAX 512
2558 /* Marks the bottom of the first segment of free char majors */
2559 #define CHRDEV_MAJOR_DYN_END 234
2560 /* Marks the top and bottom of the second segment of free char majors */
2561 #define CHRDEV_MAJOR_DYN_EXT_START 511
2562 #define CHRDEV_MAJOR_DYN_EXT_END 384
2564 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2565 extern int register_chrdev_region(dev_t, unsigned, const char *);
2566 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2567 unsigned int count, const char *name,
2568 const struct file_operations *fops);
2569 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2570 unsigned int count, const char *name);
2571 extern void unregister_chrdev_region(dev_t, unsigned);
2572 extern void chrdev_show(struct seq_file *,off_t);
2574 static inline int register_chrdev(unsigned int major, const char *name,
2575 const struct file_operations *fops)
2577 return __register_chrdev(major, 0, 256, name, fops);
2580 static inline void unregister_chrdev(unsigned int major, const char *name)
2582 __unregister_chrdev(major, 0, 256, name);
2585 extern void init_special_inode(struct inode *, umode_t, dev_t);
2587 /* Invalid inode operations -- fs/bad_inode.c */
2588 extern void make_bad_inode(struct inode *);
2589 extern bool is_bad_inode(struct inode *);
2591 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2592 pgoff_t start, pgoff_t end);
2594 static inline void invalidate_remote_inode(struct inode *inode)
2596 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2597 S_ISLNK(inode->i_mode))
2598 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2600 extern int invalidate_inode_pages2(struct address_space *mapping);
2601 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2602 pgoff_t start, pgoff_t end);
2603 extern int write_inode_now(struct inode *, int);
2604 extern int filemap_fdatawrite(struct address_space *);
2605 extern int filemap_flush(struct address_space *);
2606 extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2607 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2609 extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2610 loff_t start_byte, loff_t end_byte);
2612 static inline int filemap_fdatawait(struct address_space *mapping)
2614 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2617 extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2619 extern int filemap_write_and_wait_range(struct address_space *mapping,
2620 loff_t lstart, loff_t lend);
2621 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2622 loff_t start, loff_t end, int sync_mode);
2623 extern int filemap_fdatawrite_range(struct address_space *mapping,
2624 loff_t start, loff_t end);
2625 extern int filemap_check_errors(struct address_space *mapping);
2626 extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2628 static inline int filemap_write_and_wait(struct address_space *mapping)
2630 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
2633 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2635 extern int __must_check file_check_and_advance_wb_err(struct file *file);
2636 extern int __must_check file_write_and_wait_range(struct file *file,
2637 loff_t start, loff_t end);
2639 static inline int file_write_and_wait(struct file *file)
2641 return file_write_and_wait_range(file, 0, LLONG_MAX);
2645 * filemap_set_wb_err - set a writeback error on an address_space
2646 * @mapping: mapping in which to set writeback error
2647 * @err: error to be set in mapping
2649 * When writeback fails in some way, we must record that error so that
2650 * userspace can be informed when fsync and the like are called. We endeavor
2651 * to report errors on any file that was open at the time of the error. Some
2652 * internal callers also need to know when writeback errors have occurred.
2654 * When a writeback error occurs, most filesystems will want to call
2655 * filemap_set_wb_err to record the error in the mapping so that it will be
2656 * automatically reported whenever fsync is called on the file.
2658 static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2660 /* Fastpath for common case of no error */
2662 __filemap_set_wb_err(mapping, err);
2666 * filemap_check_wb_err - has an error occurred since the mark was sampled?
2667 * @mapping: mapping to check for writeback errors
2668 * @since: previously-sampled errseq_t
2670 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2671 * the given value was sampled.
2673 * If it has then report the latest error set, otherwise return 0.
2675 static inline int filemap_check_wb_err(struct address_space *mapping,
2678 return errseq_check(&mapping->wb_err, since);
2682 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2683 * @mapping: mapping to be sampled
2685 * Writeback errors are always reported relative to a particular sample point
2686 * in the past. This function provides those sample points.
2688 static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2690 return errseq_sample(&mapping->wb_err);
2694 * file_sample_sb_err - sample the current errseq_t to test for later errors
2695 * @file: file pointer to be sampled
2697 * Grab the most current superblock-level errseq_t value for the given
2700 static inline errseq_t file_sample_sb_err(struct file *file)
2702 return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
2705 static inline int filemap_nr_thps(struct address_space *mapping)
2707 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
2708 return atomic_read(&mapping->nr_thps);
2714 static inline void filemap_nr_thps_inc(struct address_space *mapping)
2716 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
2717 atomic_inc(&mapping->nr_thps);
2723 static inline void filemap_nr_thps_dec(struct address_space *mapping)
2725 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
2726 atomic_dec(&mapping->nr_thps);
2732 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2734 extern int vfs_fsync(struct file *file, int datasync);
2736 extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2737 unsigned int flags);
2740 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2741 * to already be updated for the write, and will return either the amount
2742 * of bytes passed in, or an error if syncing the file failed.
2744 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2746 if (iocb->ki_flags & IOCB_DSYNC) {
2747 int ret = vfs_fsync_range(iocb->ki_filp,
2748 iocb->ki_pos - count, iocb->ki_pos - 1,
2749 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2757 extern void emergency_sync(void);
2758 extern void emergency_remount(void);
2761 extern int bmap(struct inode *inode, sector_t *block);
2763 static inline int bmap(struct inode *inode, sector_t *block)
2769 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2770 extern int inode_permission(struct inode *, int);
2771 extern int generic_permission(struct inode *, int);
2772 extern int __check_sticky(struct inode *dir, struct inode *inode);
2774 static inline bool execute_ok(struct inode *inode)
2776 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2779 static inline void file_start_write(struct file *file)
2781 if (!S_ISREG(file_inode(file)->i_mode))
2783 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2786 static inline bool file_start_write_trylock(struct file *file)
2788 if (!S_ISREG(file_inode(file)->i_mode))
2790 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2793 static inline void file_end_write(struct file *file)
2795 if (!S_ISREG(file_inode(file)->i_mode))
2797 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2801 * get_write_access() gets write permission for a file.
2802 * put_write_access() releases this write permission.
2803 * This is used for regular files.
2804 * We cannot support write (and maybe mmap read-write shared) accesses and
2805 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2806 * can have the following values:
2807 * 0: no writers, no VM_DENYWRITE mappings
2808 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2809 * > 0: (i_writecount) users are writing to the file.
2811 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2812 * except for the cases where we don't hold i_writecount yet. Then we need to
2813 * use {get,deny}_write_access() - these functions check the sign and refuse
2814 * to do the change if sign is wrong.
2816 static inline int get_write_access(struct inode *inode)
2818 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2820 static inline int deny_write_access(struct file *file)
2822 struct inode *inode = file_inode(file);
2823 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2825 static inline void put_write_access(struct inode * inode)
2827 atomic_dec(&inode->i_writecount);
2829 static inline void allow_write_access(struct file *file)
2832 atomic_inc(&file_inode(file)->i_writecount);
2834 static inline bool inode_is_open_for_write(const struct inode *inode)
2836 return atomic_read(&inode->i_writecount) > 0;
2839 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
2840 static inline void i_readcount_dec(struct inode *inode)
2842 BUG_ON(!atomic_read(&inode->i_readcount));
2843 atomic_dec(&inode->i_readcount);
2845 static inline void i_readcount_inc(struct inode *inode)
2847 atomic_inc(&inode->i_readcount);
2850 static inline void i_readcount_dec(struct inode *inode)
2854 static inline void i_readcount_inc(struct inode *inode)
2859 extern int do_pipe_flags(int *, int);
2861 #define __kernel_read_file_id(id) \
2862 id(UNKNOWN, unknown) \
2863 id(FIRMWARE, firmware) \
2864 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
2865 id(FIRMWARE_EFI_EMBEDDED, firmware) \
2866 id(MODULE, kernel-module) \
2867 id(KEXEC_IMAGE, kexec-image) \
2868 id(KEXEC_INITRAMFS, kexec-initramfs) \
2869 id(POLICY, security-policy) \
2870 id(X509_CERTIFICATE, x509-certificate) \
2873 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2874 #define __fid_stringify(dummy, str) #str,
2876 enum kernel_read_file_id {
2877 __kernel_read_file_id(__fid_enumify)
2880 static const char * const kernel_read_file_str[] = {
2881 __kernel_read_file_id(__fid_stringify)
2884 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2886 if ((unsigned)id >= READING_MAX_ID)
2887 return kernel_read_file_str[READING_UNKNOWN];
2889 return kernel_read_file_str[id];
2892 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2893 enum kernel_read_file_id);
2894 extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2895 enum kernel_read_file_id);
2896 extern int kernel_read_file_from_path_initns(const char *, void **, loff_t *, loff_t,
2897 enum kernel_read_file_id);
2898 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2899 enum kernel_read_file_id);
2900 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2901 ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
2902 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2903 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
2904 extern struct file * open_exec(const char *);
2906 /* fs/dcache.c -- generic fs support functions */
2907 extern bool is_subdir(struct dentry *, struct dentry *);
2908 extern bool path_is_under(const struct path *, const struct path *);
2910 extern char *file_path(struct file *, char *, int);
2912 #include <linux/err.h>
2914 /* needed for stackable file system support */
2915 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2917 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2919 extern int inode_init_always(struct super_block *, struct inode *);
2920 extern void inode_init_once(struct inode *);
2921 extern void address_space_init_once(struct address_space *mapping);
2922 extern struct inode * igrab(struct inode *);
2923 extern ino_t iunique(struct super_block *, ino_t);
2924 extern int inode_needs_sync(struct inode *inode);
2925 extern int generic_delete_inode(struct inode *inode);
2926 static inline int generic_drop_inode(struct inode *inode)
2928 return !inode->i_nlink || inode_unhashed(inode) ||
2929 (inode->i_state & I_DONTCACHE);
2931 extern void d_mark_dontcache(struct inode *inode);
2933 extern struct inode *ilookup5_nowait(struct super_block *sb,
2934 unsigned long hashval, int (*test)(struct inode *, void *),
2936 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2937 int (*test)(struct inode *, void *), void *data);
2938 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2940 extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2941 int (*test)(struct inode *, void *),
2942 int (*set)(struct inode *, void *),
2944 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2945 extern struct inode * iget_locked(struct super_block *, unsigned long);
2946 extern struct inode *find_inode_nowait(struct super_block *,
2948 int (*match)(struct inode *,
2949 unsigned long, void *),
2951 extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
2952 int (*)(struct inode *, void *), void *);
2953 extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
2954 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2955 extern int insert_inode_locked(struct inode *);
2956 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2957 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2959 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2961 extern void unlock_new_inode(struct inode *);
2962 extern void discard_new_inode(struct inode *);
2963 extern unsigned int get_next_ino(void);
2964 extern void evict_inodes(struct super_block *sb);
2967 * Userspace may rely on the the inode number being non-zero. For example, glibc
2968 * simply ignores files with zero i_ino in unlink() and other places.
2970 * As an additional complication, if userspace was compiled with
2971 * _FILE_OFFSET_BITS=32 on a 64-bit kernel we'll only end up reading out the
2972 * lower 32 bits, so we need to check that those aren't zero explicitly. With
2973 * _FILE_OFFSET_BITS=64, this may cause some harmless false-negatives, but
2974 * better safe than sorry.
2976 static inline bool is_zero_ino(ino_t ino)
2978 return (u32)ino == 0;
2981 extern void __iget(struct inode * inode);
2982 extern void iget_failed(struct inode *);
2983 extern void clear_inode(struct inode *);
2984 extern void __destroy_inode(struct inode *);
2985 extern struct inode *new_inode_pseudo(struct super_block *sb);
2986 extern struct inode *new_inode(struct super_block *sb);
2987 extern void free_inode_nonrcu(struct inode *inode);
2988 extern int should_remove_suid(struct dentry *);
2989 extern int file_remove_privs(struct file *);
2991 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2992 static inline void insert_inode_hash(struct inode *inode)
2994 __insert_inode_hash(inode, inode->i_ino);
2997 extern void __remove_inode_hash(struct inode *);
2998 static inline void remove_inode_hash(struct inode *inode)
3000 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
3001 __remove_inode_hash(inode);
3004 extern void inode_sb_list_add(struct inode *inode);
3006 extern int sb_set_blocksize(struct super_block *, int);
3007 extern int sb_min_blocksize(struct super_block *, int);
3009 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
3010 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3011 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
3012 extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
3013 struct file *file_out, loff_t pos_out,
3014 loff_t *count, unsigned int remap_flags);
3015 extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
3016 extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3017 struct file *file_out, loff_t pos_out,
3018 size_t *count, unsigned int flags);
3019 extern ssize_t generic_file_buffered_read(struct kiocb *iocb,
3020 struct iov_iter *to, ssize_t already_read);
3021 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
3022 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
3023 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
3024 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3025 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
3027 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
3029 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
3031 ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
3032 struct iov_iter *iter);
3033 ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
3034 struct iov_iter *iter);
3036 /* fs/block_dev.c */
3037 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
3038 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
3039 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3041 extern void block_sync_page(struct page *page);
3044 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
3045 struct pipe_inode_info *, size_t, unsigned int);
3046 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3047 struct file *, loff_t *, size_t, unsigned int);
3048 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
3049 struct file *out, loff_t *, size_t len, unsigned int flags);
3050 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3051 loff_t *opos, size_t len, unsigned int flags);
3055 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3056 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3057 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
3058 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3059 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
3060 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3061 int whence, loff_t maxsize, loff_t eof);
3062 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3063 int whence, loff_t size);
3064 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3065 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
3066 extern int generic_file_open(struct inode * inode, struct file * filp);
3067 extern int nonseekable_open(struct inode * inode, struct file * filp);
3068 extern int stream_open(struct inode * inode, struct file * filp);
3071 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3072 loff_t file_offset);
3075 /* need locking between buffered and direct access */
3078 /* filesystem does not support filling holes */
3079 DIO_SKIP_HOLES = 0x02,
3082 void dio_end_io(struct bio *bio);
3084 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3085 struct block_device *bdev, struct iov_iter *iter,
3086 get_block_t get_block,
3087 dio_iodone_t end_io, dio_submit_t submit_io,
3090 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3091 struct inode *inode,
3092 struct iov_iter *iter,
3093 get_block_t get_block)
3095 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3096 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
3100 void inode_dio_wait(struct inode *inode);
3103 * inode_dio_begin - signal start of a direct I/O requests
3104 * @inode: inode the direct I/O happens on
3106 * This is called once we've finished processing a direct I/O request,
3107 * and is used to wake up callers waiting for direct I/O to be quiesced.
3109 static inline void inode_dio_begin(struct inode *inode)
3111 atomic_inc(&inode->i_dio_count);
3115 * inode_dio_end - signal finish of a direct I/O requests
3116 * @inode: inode the direct I/O happens on
3118 * This is called once we've finished processing a direct I/O request,
3119 * and is used to wake up callers waiting for direct I/O to be quiesced.
3121 static inline void inode_dio_end(struct inode *inode)
3123 if (atomic_dec_and_test(&inode->i_dio_count))
3124 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3128 * Warn about a page cache invalidation failure diring a direct I/O write.
3130 void dio_warn_stale_pagecache(struct file *filp);
3132 extern void inode_set_flags(struct inode *inode, unsigned int flags,
3135 extern const struct file_operations generic_ro_fops;
3137 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3139 extern int readlink_copy(char __user *, int, const char *);
3140 extern int page_readlink(struct dentry *, char __user *, int);
3141 extern const char *page_get_link(struct dentry *, struct inode *,
3142 struct delayed_call *);
3143 extern void page_put_link(void *);
3144 extern int __page_symlink(struct inode *inode, const char *symname, int len,
3146 extern int page_symlink(struct inode *inode, const char *symname, int len);
3147 extern const struct inode_operations page_symlink_inode_operations;
3148 extern void kfree_link(void *);
3149 extern void generic_fillattr(struct inode *, struct kstat *);
3150 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3151 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3152 void __inode_add_bytes(struct inode *inode, loff_t bytes);
3153 void inode_add_bytes(struct inode *inode, loff_t bytes);
3154 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
3155 void inode_sub_bytes(struct inode *inode, loff_t bytes);
3156 static inline loff_t __inode_get_bytes(struct inode *inode)
3158 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3160 loff_t inode_get_bytes(struct inode *inode);
3161 void inode_set_bytes(struct inode *inode, loff_t bytes);
3162 const char *simple_get_link(struct dentry *, struct inode *,
3163 struct delayed_call *);
3164 extern const struct inode_operations simple_symlink_inode_operations;
3166 extern int iterate_dir(struct file *, struct dir_context *);
3168 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3169 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3171 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3173 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3174 stat, STATX_BASIC_STATS);
3176 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3178 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3179 stat, STATX_BASIC_STATS);
3181 static inline int vfs_fstatat(int dfd, const char __user *filename,
3182 struct kstat *stat, int flags)
3184 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3185 stat, STATX_BASIC_STATS);
3187 static inline int vfs_fstat(int fd, struct kstat *stat)
3189 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3193 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3194 extern int vfs_readlink(struct dentry *, char __user *, int);
3196 extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3197 extern void put_filesystem(struct file_system_type *fs);
3198 extern struct file_system_type *get_fs_type(const char *name);
3199 extern struct super_block *get_super(struct block_device *);
3200 extern struct super_block *get_super_thawed(struct block_device *);
3201 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3202 extern struct super_block *get_active_super(struct block_device *bdev);
3203 extern void drop_super(struct super_block *sb);
3204 extern void drop_super_exclusive(struct super_block *sb);
3205 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
3206 extern void iterate_supers_type(struct file_system_type *,
3207 void (*)(struct super_block *, void *), void *);
3209 extern int dcache_dir_open(struct inode *, struct file *);
3210 extern int dcache_dir_close(struct inode *, struct file *);
3211 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3212 extern int dcache_readdir(struct file *, struct dir_context *);
3213 extern int simple_setattr(struct dentry *, struct iattr *);
3214 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3215 extern int simple_statfs(struct dentry *, struct kstatfs *);
3216 extern int simple_open(struct inode *inode, struct file *file);
3217 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3218 extern int simple_unlink(struct inode *, struct dentry *);
3219 extern int simple_rmdir(struct inode *, struct dentry *);
3220 extern int simple_rename(struct inode *, struct dentry *,
3221 struct inode *, struct dentry *, unsigned int);
3222 extern void simple_recursive_removal(struct dentry *,
3223 void (*callback)(struct dentry *));
3224 extern int noop_fsync(struct file *, loff_t, loff_t, int);
3225 extern int noop_set_page_dirty(struct page *page);
3226 extern void noop_invalidatepage(struct page *page, unsigned int offset,
3227 unsigned int length);
3228 extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
3229 extern int simple_empty(struct dentry *);
3230 extern int simple_readpage(struct file *file, struct page *page);
3231 extern int simple_write_begin(struct file *file, struct address_space *mapping,
3232 loff_t pos, unsigned len, unsigned flags,
3233 struct page **pagep, void **fsdata);
3234 extern int simple_write_end(struct file *file, struct address_space *mapping,
3235 loff_t pos, unsigned len, unsigned copied,
3236 struct page *page, void *fsdata);
3237 extern int always_delete_dentry(const struct dentry *);
3238 extern struct inode *alloc_anon_inode(struct super_block *);
3239 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3240 extern const struct dentry_operations simple_dentry_operations;
3242 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
3243 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3244 extern const struct file_operations simple_dir_operations;
3245 extern const struct inode_operations simple_dir_inode_operations;
3246 extern void make_empty_dir_inode(struct inode *inode);
3247 extern bool is_empty_dir_inode(struct inode *inode);
3248 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3249 struct dentry *d_alloc_name(struct dentry *, const char *);
3250 extern int simple_fill_super(struct super_block *, unsigned long,
3251 const struct tree_descr *);
3252 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3253 extern void simple_release_fs(struct vfsmount **mount, int *count);
3255 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3256 loff_t *ppos, const void *from, size_t available);
3257 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3258 const void __user *from, size_t count);
3260 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3261 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3263 extern int generic_check_addressable(unsigned, u64);
3265 #ifdef CONFIG_MIGRATION
3266 extern int buffer_migrate_page(struct address_space *,
3267 struct page *, struct page *,
3269 extern int buffer_migrate_page_norefs(struct address_space *,
3270 struct page *, struct page *,
3273 #define buffer_migrate_page NULL
3274 #define buffer_migrate_page_norefs NULL
3277 extern int setattr_prepare(struct dentry *, struct iattr *);
3278 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3279 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3281 extern int file_update_time(struct file *file);
3283 static inline bool vma_is_dax(const struct vm_area_struct *vma)
3285 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3288 static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3290 struct inode *inode;
3294 if (!vma_is_dax(vma))
3296 inode = file_inode(vma->vm_file);
3297 if (S_ISCHR(inode->i_mode))
3298 return false; /* device-dax */
3302 static inline int iocb_flags(struct file *file)
3305 if (file->f_flags & O_APPEND)
3307 if (file->f_flags & O_DIRECT)
3309 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3311 if (file->f_flags & __O_SYNC)
3316 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3318 int kiocb_flags = 0;
3322 if (unlikely(flags & ~RWF_SUPPORTED))
3325 if (flags & RWF_NOWAIT) {
3326 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3328 kiocb_flags |= IOCB_NOWAIT | IOCB_NOIO;
3330 if (flags & RWF_HIPRI)
3331 kiocb_flags |= IOCB_HIPRI;
3332 if (flags & RWF_DSYNC)
3333 kiocb_flags |= IOCB_DSYNC;
3334 if (flags & RWF_SYNC)
3335 kiocb_flags |= (IOCB_DSYNC | IOCB_SYNC);
3336 if (flags & RWF_APPEND)
3337 kiocb_flags |= IOCB_APPEND;
3339 ki->ki_flags |= kiocb_flags;
3343 static inline ino_t parent_ino(struct dentry *dentry)
3348 * Don't strictly need d_lock here? If the parent ino could change
3349 * then surely we'd have a deeper race in the caller?
3351 spin_lock(&dentry->d_lock);
3352 res = dentry->d_parent->d_inode->i_ino;
3353 spin_unlock(&dentry->d_lock);
3357 /* Transaction based IO helpers */
3360 * An argresp is stored in an allocated page and holds the
3361 * size of the argument or response, along with its content
3363 struct simple_transaction_argresp {
3368 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3370 char *simple_transaction_get(struct file *file, const char __user *buf,
3372 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3373 size_t size, loff_t *pos);
3374 int simple_transaction_release(struct inode *inode, struct file *file);
3376 void simple_transaction_set(struct file *file, size_t n);
3379 * simple attribute files
3381 * These attributes behave similar to those in sysfs:
3383 * Writing to an attribute immediately sets a value, an open file can be
3384 * written to multiple times.
3386 * Reading from an attribute creates a buffer from the value that might get
3387 * read with multiple read calls. When the attribute has been read
3388 * completely, no further read calls are possible until the file is opened
3391 * All attributes contain a text representation of a numeric value
3392 * that are accessed with the get() and set() functions.
3394 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3395 static int __fops ## _open(struct inode *inode, struct file *file) \
3397 __simple_attr_check_format(__fmt, 0ull); \
3398 return simple_attr_open(inode, file, __get, __set, __fmt); \
3400 static const struct file_operations __fops = { \
3401 .owner = THIS_MODULE, \
3402 .open = __fops ## _open, \
3403 .release = simple_attr_release, \
3404 .read = simple_attr_read, \
3405 .write = simple_attr_write, \
3406 .llseek = generic_file_llseek, \
3409 static inline __printf(1, 2)
3410 void __simple_attr_check_format(const char *fmt, ...)
3412 /* don't do anything, just let the compiler check the arguments; */
3415 int simple_attr_open(struct inode *inode, struct file *file,
3416 int (*get)(void *, u64 *), int (*set)(void *, u64),
3418 int simple_attr_release(struct inode *inode, struct file *file);
3419 ssize_t simple_attr_read(struct file *file, char __user *buf,
3420 size_t len, loff_t *ppos);
3421 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3422 size_t len, loff_t *ppos);
3425 int proc_nr_files(struct ctl_table *table, int write,
3426 void *buffer, size_t *lenp, loff_t *ppos);
3427 int proc_nr_dentry(struct ctl_table *table, int write,
3428 void *buffer, size_t *lenp, loff_t *ppos);
3429 int proc_nr_inodes(struct ctl_table *table, int write,
3430 void *buffer, size_t *lenp, loff_t *ppos);
3431 int __init get_filesystem_list(char *buf);
3433 #define __FMODE_EXEC ((__force int) FMODE_EXEC)
3434 #define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3436 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3437 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3438 (flag & __FMODE_NONOTIFY)))
3440 static inline bool is_sxid(umode_t mode)
3442 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3445 static inline int check_sticky(struct inode *dir, struct inode *inode)
3447 if (!(dir->i_mode & S_ISVTX))
3450 return __check_sticky(dir, inode);
3453 static inline void inode_has_no_xattr(struct inode *inode)
3455 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3456 inode->i_flags |= S_NOSEC;
3459 static inline bool is_root_inode(struct inode *inode)
3461 return inode == inode->i_sb->s_root->d_inode;
3464 static inline bool dir_emit(struct dir_context *ctx,
3465 const char *name, int namelen,
3466 u64 ino, unsigned type)
3468 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3470 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3472 return ctx->actor(ctx, ".", 1, ctx->pos,
3473 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3475 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3477 return ctx->actor(ctx, "..", 2, ctx->pos,
3478 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3480 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3482 if (ctx->pos == 0) {
3483 if (!dir_emit_dot(file, ctx))
3487 if (ctx->pos == 1) {
3488 if (!dir_emit_dotdot(file, ctx))
3494 static inline bool dir_relax(struct inode *inode)
3496 inode_unlock(inode);
3498 return !IS_DEADDIR(inode);
3501 static inline bool dir_relax_shared(struct inode *inode)
3503 inode_unlock_shared(inode);
3504 inode_lock_shared(inode);
3505 return !IS_DEADDIR(inode);
3508 extern bool path_noexec(const struct path *path);
3509 extern void inode_nohighmem(struct inode *inode);
3512 extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3514 extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3517 #if defined(CONFIG_IO_URING)
3518 extern struct sock *io_uring_get_socket(struct file *file);
3520 static inline struct sock *io_uring_get_socket(struct file *file)
3526 int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3527 unsigned int flags);
3529 int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3530 struct fsxattr *fa);
3532 static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3534 memset(fa, 0, sizeof(*fa));
3535 fa->fsx_xflags = xflags;
3539 * Flush file data before changing attributes. Caller must hold any locks
3540 * required to prevent further writes to this file until we're done setting
3543 static inline int inode_drain_writes(struct inode *inode)
3545 inode_dio_wait(inode);
3546 return filemap_write_and_wait(inode->i_mapping);
3549 #endif /* _LINUX_FS_H */