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/fiemap.h>
28 #include <linux/rculist_bl.h>
29 #include <linux/atomic.h>
30 #include <linux/shrinker.h>
31 #include <linux/migrate_mode.h>
32 #include <linux/uidgid.h>
33 #include <linux/lockdep.h>
34 #include <linux/percpu-rwsem.h>
35 #include <linux/workqueue.h>
36 #include <linux/delayed_call.h>
37 #include <linux/uuid.h>
38 #include <linux/errseq.h>
39 #include <linux/ioprio.h>
40 #include <linux/fs_types.h>
41 #include <linux/build_bug.h>
42 #include <linux/stddef.h>
44 #include <asm/byteorder.h>
45 #include <uapi/linux/fs.h>
47 struct backing_dev_info;
50 struct export_operations;
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 fs_parameter_description;
70 extern void __init inode_init(void);
71 extern void __init inode_init_early(void);
72 extern void __init files_init(void);
73 extern void __init files_maxfiles_init(void);
75 extern struct files_stat_struct files_stat;
76 extern unsigned long get_max_files(void);
77 extern unsigned int sysctl_nr_open;
78 extern struct inodes_stat_t inodes_stat;
79 extern int leases_enable, lease_break_time;
80 extern int sysctl_protected_symlinks;
81 extern int sysctl_protected_hardlinks;
82 extern int sysctl_protected_fifos;
83 extern int sysctl_protected_regular;
85 typedef __kernel_rwf_t rwf_t;
88 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
89 struct buffer_head *bh_result, int create);
90 typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
91 ssize_t bytes, void *private);
93 #define MAY_EXEC 0x00000001
94 #define MAY_WRITE 0x00000002
95 #define MAY_READ 0x00000004
96 #define MAY_APPEND 0x00000008
97 #define MAY_ACCESS 0x00000010
98 #define MAY_OPEN 0x00000020
99 #define MAY_CHDIR 0x00000040
100 /* called from RCU mode, don't block */
101 #define MAY_NOT_BLOCK 0x00000080
104 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
105 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
108 /* file is open for reading */
109 #define FMODE_READ ((__force fmode_t)0x1)
110 /* file is open for writing */
111 #define FMODE_WRITE ((__force fmode_t)0x2)
112 /* file is seekable */
113 #define FMODE_LSEEK ((__force fmode_t)0x4)
114 /* file can be accessed using pread */
115 #define FMODE_PREAD ((__force fmode_t)0x8)
116 /* file can be accessed using pwrite */
117 #define FMODE_PWRITE ((__force fmode_t)0x10)
118 /* File is opened for execution with sys_execve / sys_uselib */
119 #define FMODE_EXEC ((__force fmode_t)0x20)
120 /* File is opened with O_NDELAY (only set for block devices) */
121 #define FMODE_NDELAY ((__force fmode_t)0x40)
122 /* File is opened with O_EXCL (only set for block devices) */
123 #define FMODE_EXCL ((__force fmode_t)0x80)
124 /* File is opened using open(.., 3, ..) and is writeable only for ioctls
125 (specialy hack for floppy.c) */
126 #define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
127 /* 32bit hashes as llseek() offset (for directories) */
128 #define FMODE_32BITHASH ((__force fmode_t)0x200)
129 /* 64bit hashes as llseek() offset (for directories) */
130 #define FMODE_64BITHASH ((__force fmode_t)0x400)
133 * Don't update ctime and mtime.
135 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
136 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
138 #define FMODE_NOCMTIME ((__force fmode_t)0x800)
140 /* Expect random access pattern */
141 #define FMODE_RANDOM ((__force fmode_t)0x1000)
143 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
144 #define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
146 /* File is opened with O_PATH; almost nothing can be done with it */
147 #define FMODE_PATH ((__force fmode_t)0x4000)
149 /* File needs atomic accesses to f_pos */
150 #define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
151 /* Write access to underlying fs */
152 #define FMODE_WRITER ((__force fmode_t)0x10000)
153 /* Has read method(s) */
154 #define FMODE_CAN_READ ((__force fmode_t)0x20000)
155 /* Has write method(s) */
156 #define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
158 #define FMODE_OPENED ((__force fmode_t)0x80000)
159 #define FMODE_CREATED ((__force fmode_t)0x100000)
161 /* File was opened by fanotify and shouldn't generate fanotify events */
162 #define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
164 /* File is capable of returning -EAGAIN if I/O will block */
165 #define FMODE_NOWAIT ((__force fmode_t)0x8000000)
167 /* File does not contribute to nr_files count */
168 #define FMODE_NOACCOUNT ((__force fmode_t)0x20000000)
171 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
172 * that indicates that they should check the contents of the iovec are
173 * valid, but not check the memory that the iovec elements
176 #define CHECK_IOVEC_ONLY -1
179 * Attribute flags. These should be or-ed together to figure out what
182 #define ATTR_MODE (1 << 0)
183 #define ATTR_UID (1 << 1)
184 #define ATTR_GID (1 << 2)
185 #define ATTR_SIZE (1 << 3)
186 #define ATTR_ATIME (1 << 4)
187 #define ATTR_MTIME (1 << 5)
188 #define ATTR_CTIME (1 << 6)
189 #define ATTR_ATIME_SET (1 << 7)
190 #define ATTR_MTIME_SET (1 << 8)
191 #define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
192 #define ATTR_KILL_SUID (1 << 11)
193 #define ATTR_KILL_SGID (1 << 12)
194 #define ATTR_FILE (1 << 13)
195 #define ATTR_KILL_PRIV (1 << 14)
196 #define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
197 #define ATTR_TIMES_SET (1 << 16)
198 #define ATTR_TOUCH (1 << 17)
201 * Whiteout is represented by a char device. The following constants define the
202 * mode and device number to use.
204 #define WHITEOUT_MODE 0
205 #define WHITEOUT_DEV 0
208 * This is the Inode Attributes structure, used for notify_change(). It
209 * uses the above definitions as flags, to know which values have changed.
210 * Also, in this manner, a Filesystem can look at only the values it cares
211 * about. Basically, these are the attributes that the VFS layer can
212 * request to change from the FS layer.
217 unsigned int ia_valid;
222 struct timespec64 ia_atime;
223 struct timespec64 ia_mtime;
224 struct timespec64 ia_ctime;
227 * Not an attribute, but an auxiliary info for filesystems wanting to
228 * implement an ftruncate() like method. NOTE: filesystem should
229 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
231 struct file *ia_file;
235 * Includes for diskquotas.
237 #include <linux/quota.h>
240 * Maximum number of layers of fs stack. Needs to be limited to
241 * prevent kernel stack overflow
243 #define FILESYSTEM_MAX_STACK_DEPTH 2
246 * enum positive_aop_returns - aop return codes with specific semantics
248 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
249 * completed, that the page is still locked, and
250 * should be considered active. The VM uses this hint
251 * to return the page to the active list -- it won't
252 * be a candidate for writeback again in the near
253 * future. Other callers must be careful to unlock
254 * the page if they get this return. Returned by
257 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
258 * unlocked it and the page might have been truncated.
259 * The caller should back up to acquiring a new page and
260 * trying again. The aop will be taking reasonable
261 * precautions not to livelock. If the caller held a page
262 * reference, it should drop it before retrying. Returned
265 * address_space_operation functions return these large constants to indicate
266 * special semantics to the caller. These are much larger than the bytes in a
267 * page to allow for functions that return the number of bytes operated on in a
271 enum positive_aop_returns {
272 AOP_WRITEPAGE_ACTIVATE = 0x80000,
273 AOP_TRUNCATED_PAGE = 0x80001,
276 #define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
277 #define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
278 * helper code (eg buffer layer)
279 * to clear GFP_FS from alloc */
282 * oh the beauties of C type declarations.
285 struct address_space;
286 struct writeback_control;
289 * Write life time hint values.
290 * Stored in struct inode as u8.
293 WRITE_LIFE_NOT_SET = 0,
294 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
295 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
296 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
297 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
298 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
301 #define IOCB_EVENTFD (1 << 0)
302 #define IOCB_APPEND (1 << 1)
303 #define IOCB_DIRECT (1 << 2)
304 #define IOCB_HIPRI (1 << 3)
305 #define IOCB_DSYNC (1 << 4)
306 #define IOCB_SYNC (1 << 5)
307 #define IOCB_WRITE (1 << 6)
308 #define IOCB_NOWAIT (1 << 7)
311 struct file *ki_filp;
313 /* The 'ki_filp' pointer is shared in a union for aio */
314 randomized_struct_fields_start
317 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
321 u16 ki_ioprio; /* See linux/ioprio.h */
322 unsigned int ki_cookie; /* for ->iopoll */
324 randomized_struct_fields_end
327 static inline bool is_sync_kiocb(struct kiocb *kiocb)
329 return kiocb->ki_complete == NULL;
333 * "descriptor" for what we're up to with a read.
334 * This allows us to use the same read code yet
335 * have multiple different users of the data that
336 * we read from a file.
338 * The simplest case just copies the data to user
351 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
352 unsigned long, unsigned long);
354 struct address_space_operations {
355 int (*writepage)(struct page *page, struct writeback_control *wbc);
356 int (*readpage)(struct file *, struct page *);
358 /* Write back some dirty pages from this mapping. */
359 int (*writepages)(struct address_space *, struct writeback_control *);
361 /* Set a page dirty. Return true if this dirtied it */
362 int (*set_page_dirty)(struct page *page);
365 * Reads in the requested pages. Unlike ->readpage(), this is
366 * PURELY used for read-ahead!.
368 int (*readpages)(struct file *filp, struct address_space *mapping,
369 struct list_head *pages, unsigned nr_pages);
371 int (*write_begin)(struct file *, struct address_space *mapping,
372 loff_t pos, unsigned len, unsigned flags,
373 struct page **pagep, void **fsdata);
374 int (*write_end)(struct file *, struct address_space *mapping,
375 loff_t pos, unsigned len, unsigned copied,
376 struct page *page, void *fsdata);
378 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
379 sector_t (*bmap)(struct address_space *, sector_t);
380 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
381 int (*releasepage) (struct page *, gfp_t);
382 void (*freepage)(struct page *);
383 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
385 * migrate the contents of a page to the specified target. If
386 * migrate_mode is MIGRATE_ASYNC, it must not block.
388 int (*migratepage) (struct address_space *,
389 struct page *, struct page *, enum migrate_mode);
390 bool (*isolate_page)(struct page *, isolate_mode_t);
391 void (*putback_page)(struct page *);
392 int (*launder_page) (struct page *);
393 int (*is_partially_uptodate) (struct page *, unsigned long,
395 void (*is_dirty_writeback) (struct page *, bool *, bool *);
396 int (*error_remove_page)(struct address_space *, struct page *);
398 /* swapfile support */
399 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
401 void (*swap_deactivate)(struct file *file);
404 extern const struct address_space_operations empty_aops;
407 * pagecache_write_begin/pagecache_write_end must be used by general code
408 * to write into the pagecache.
410 int pagecache_write_begin(struct file *, struct address_space *mapping,
411 loff_t pos, unsigned len, unsigned flags,
412 struct page **pagep, void **fsdata);
414 int pagecache_write_end(struct file *, struct address_space *mapping,
415 loff_t pos, unsigned len, unsigned copied,
416 struct page *page, void *fsdata);
419 * struct address_space - Contents of a cacheable, mappable object.
420 * @host: Owner, either the inode or the block_device.
421 * @i_pages: Cached pages.
422 * @gfp_mask: Memory allocation flags to use for allocating pages.
423 * @i_mmap_writable: Number of VM_SHARED mappings.
424 * @i_mmap: Tree of private and shared mappings.
425 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
426 * @nrpages: Number of page entries, protected by the i_pages lock.
427 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
428 * @writeback_index: Writeback starts here.
430 * @flags: Error bits and flags (AS_*).
431 * @wb_err: The most recent error which has occurred.
432 * @private_lock: For use by the owner of the address_space.
433 * @private_list: For use by the owner of the address_space.
434 * @private_data: For use by the owner of the address_space.
436 struct address_space {
438 struct xarray i_pages;
440 atomic_t i_mmap_writable;
441 struct rb_root_cached i_mmap;
442 struct rw_semaphore i_mmap_rwsem;
443 unsigned long nrpages;
444 unsigned long nrexceptional;
445 pgoff_t writeback_index;
446 const struct address_space_operations *a_ops;
449 spinlock_t private_lock;
450 struct list_head private_list;
452 } __attribute__((aligned(sizeof(long)))) __randomize_layout;
454 * On most architectures that alignment is already the case; but
455 * must be enforced here for CRIS, to let the least significant bit
456 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
458 struct request_queue;
460 struct block_device {
461 dev_t bd_dev; /* not a kdev_t - it's a search key */
463 struct inode * bd_inode; /* will die */
464 struct super_block * bd_super;
465 struct mutex bd_mutex; /* open/close mutex */
469 bool bd_write_holder;
471 struct list_head bd_holder_disks;
473 struct block_device * bd_contains;
474 unsigned bd_block_size;
476 struct hd_struct * bd_part;
477 /* number of times partitions within this device have been opened. */
478 unsigned bd_part_count;
480 struct gendisk * bd_disk;
481 struct request_queue * bd_queue;
482 struct backing_dev_info *bd_bdi;
483 struct list_head bd_list;
485 * Private data. You must have bd_claim'ed the block_device
486 * to use this. NOTE: bd_claim allows an owner to claim
487 * the same device multiple times, the owner must take special
488 * care to not mess up bd_private for that case.
490 unsigned long bd_private;
492 /* The counter of freeze processes */
493 int bd_fsfreeze_count;
494 /* Mutex for freeze */
495 struct mutex bd_fsfreeze_mutex;
496 } __randomize_layout;
498 /* XArray tags, for tagging dirty and writeback pages in the pagecache. */
499 #define PAGECACHE_TAG_DIRTY XA_MARK_0
500 #define PAGECACHE_TAG_WRITEBACK XA_MARK_1
501 #define PAGECACHE_TAG_TOWRITE XA_MARK_2
504 * Returns true if any of the pages in the mapping are marked with the tag.
506 static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
508 return xa_marked(&mapping->i_pages, tag);
511 static inline void i_mmap_lock_write(struct address_space *mapping)
513 down_write(&mapping->i_mmap_rwsem);
516 static inline void i_mmap_unlock_write(struct address_space *mapping)
518 up_write(&mapping->i_mmap_rwsem);
521 static inline void i_mmap_lock_read(struct address_space *mapping)
523 down_read(&mapping->i_mmap_rwsem);
526 static inline void i_mmap_unlock_read(struct address_space *mapping)
528 up_read(&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_pgoff
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;
689 atomic_t i_dio_count;
690 atomic_t i_writecount;
692 atomic_t i_readcount; /* struct files open RO */
694 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
695 struct file_lock_context *i_flctx;
696 struct address_space i_data;
697 struct list_head i_devices;
699 struct pipe_inode_info *i_pipe;
700 struct block_device *i_bdev;
708 #ifdef CONFIG_FSNOTIFY
709 __u32 i_fsnotify_mask; /* all events this inode cares about */
710 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
713 #ifdef CONFIG_FS_ENCRYPTION
714 struct fscrypt_info *i_crypt_info;
717 void *i_private; /* fs or device private pointer */
718 } __randomize_layout;
720 static inline unsigned int i_blocksize(const struct inode *node)
722 return (1 << node->i_blkbits);
725 static inline int inode_unhashed(struct inode *inode)
727 return hlist_unhashed(&inode->i_hash);
731 * __mark_inode_dirty expects inodes to be hashed. Since we don't
732 * want special inodes in the fileset inode space, we make them
733 * appear hashed, but do not put on any lists. hlist_del()
734 * will work fine and require no locking.
736 static inline void inode_fake_hash(struct inode *inode)
738 hlist_add_fake(&inode->i_hash);
742 * inode->i_mutex nesting subclasses for the lock validator:
744 * 0: the object of the current VFS operation
748 * 4: second non-directory
749 * 5: second parent (when locking independent directories in rename)
751 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
752 * non-directories at once.
754 * The locking order between these classes is
755 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
757 enum inode_i_mutex_lock_class
767 static inline void inode_lock(struct inode *inode)
769 down_write(&inode->i_rwsem);
772 static inline void inode_unlock(struct inode *inode)
774 up_write(&inode->i_rwsem);
777 static inline void inode_lock_shared(struct inode *inode)
779 down_read(&inode->i_rwsem);
782 static inline void inode_unlock_shared(struct inode *inode)
784 up_read(&inode->i_rwsem);
787 static inline int inode_trylock(struct inode *inode)
789 return down_write_trylock(&inode->i_rwsem);
792 static inline int inode_trylock_shared(struct inode *inode)
794 return down_read_trylock(&inode->i_rwsem);
797 static inline int inode_is_locked(struct inode *inode)
799 return rwsem_is_locked(&inode->i_rwsem);
802 static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
804 down_write_nested(&inode->i_rwsem, subclass);
807 static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
809 down_read_nested(&inode->i_rwsem, subclass);
812 void lock_two_nondirectories(struct inode *, struct inode*);
813 void unlock_two_nondirectories(struct inode *, struct inode*);
816 * NOTE: in a 32bit arch with a preemptable kernel and
817 * an UP compile the i_size_read/write must be atomic
818 * with respect to the local cpu (unlike with preempt disabled),
819 * but they don't need to be atomic with respect to other cpus like in
820 * true SMP (so they need either to either locally disable irq around
821 * the read or for example on x86 they can be still implemented as a
822 * cmpxchg8b without the need of the lock prefix). For SMP compiles
823 * and 64bit archs it makes no difference if preempt is enabled or not.
825 static inline loff_t i_size_read(const struct inode *inode)
827 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
832 seq = read_seqcount_begin(&inode->i_size_seqcount);
833 i_size = inode->i_size;
834 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
836 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
840 i_size = inode->i_size;
844 return inode->i_size;
849 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
850 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
851 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
853 static inline void i_size_write(struct inode *inode, loff_t i_size)
855 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
857 write_seqcount_begin(&inode->i_size_seqcount);
858 inode->i_size = i_size;
859 write_seqcount_end(&inode->i_size_seqcount);
861 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
863 inode->i_size = i_size;
866 inode->i_size = i_size;
870 static inline unsigned iminor(const struct inode *inode)
872 return MINOR(inode->i_rdev);
875 static inline unsigned imajor(const struct inode *inode)
877 return MAJOR(inode->i_rdev);
880 extern struct block_device *I_BDEV(struct inode *inode);
883 rwlock_t lock; /* protects pid, uid, euid fields */
884 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
885 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
886 kuid_t uid, euid; /* uid/euid of process setting the owner */
887 int signum; /* posix.1b rt signal to be delivered on IO */
891 * Track a single file's readahead state
893 struct file_ra_state {
894 pgoff_t start; /* where readahead started */
895 unsigned int size; /* # of readahead pages */
896 unsigned int async_size; /* do asynchronous readahead when
897 there are only # of pages ahead */
899 unsigned int ra_pages; /* Maximum readahead window */
900 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
901 loff_t prev_pos; /* Cache last read() position */
905 * Check if @index falls in the readahead windows.
907 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
909 return (index >= ra->start &&
910 index < ra->start + ra->size);
915 struct llist_node fu_llist;
916 struct rcu_head fu_rcuhead;
919 struct inode *f_inode; /* cached value */
920 const struct file_operations *f_op;
923 * Protects f_ep_links, f_flags.
924 * Must not be taken from IRQ context.
927 enum rw_hint f_write_hint;
928 atomic_long_t f_count;
929 unsigned int f_flags;
931 struct mutex f_pos_lock;
933 struct fown_struct f_owner;
934 const struct cred *f_cred;
935 struct file_ra_state f_ra;
938 #ifdef CONFIG_SECURITY
941 /* needed for tty driver, and maybe others */
945 /* Used by fs/eventpoll.c to link all the hooks to this file */
946 struct list_head f_ep_links;
947 struct list_head f_tfile_llink;
948 #endif /* #ifdef CONFIG_EPOLL */
949 struct address_space *f_mapping;
952 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
957 /* file identifier */
958 unsigned char f_handle[0];
961 static inline struct file *get_file(struct file *f)
963 atomic_long_inc(&f->f_count);
966 #define get_file_rcu_many(x, cnt) \
967 atomic_long_add_unless(&(x)->f_count, (cnt), 0)
968 #define get_file_rcu(x) get_file_rcu_many((x), 1)
969 #define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
970 #define file_count(x) atomic_long_read(&(x)->f_count)
972 #define MAX_NON_LFS ((1UL<<31) - 1)
974 /* Page cache limit. The filesystems should put that into their s_maxbytes
975 limits, otherwise bad things can happen in VM. */
976 #if BITS_PER_LONG==32
977 #define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
978 #elif BITS_PER_LONG==64
979 #define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
984 #define FL_DELEG 4 /* NFSv4 delegation */
985 #define FL_ACCESS 8 /* not trying to lock, just looking */
986 #define FL_EXISTS 16 /* when unlocking, test for existence */
987 #define FL_LEASE 32 /* lease held on this file */
988 #define FL_CLOSE 64 /* unlock on close */
989 #define FL_SLEEP 128 /* A blocking lock */
990 #define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
991 #define FL_UNLOCK_PENDING 512 /* Lease is being broken */
992 #define FL_OFDLCK 1024 /* lock is "owned" by struct file */
993 #define FL_LAYOUT 2048 /* outstanding pNFS layout */
995 #define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
998 * Special return value from posix_lock_file() and vfs_lock_file() for
999 * asynchronous locking.
1001 #define FILE_LOCK_DEFERRED 1
1003 /* legacy typedef, should eventually be removed */
1004 typedef void *fl_owner_t;
1008 struct file_lock_operations {
1009 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1010 void (*fl_release_private)(struct file_lock *);
1013 struct lock_manager_operations {
1014 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
1015 unsigned long (*lm_owner_key)(struct file_lock *);
1016 fl_owner_t (*lm_get_owner)(fl_owner_t);
1017 void (*lm_put_owner)(fl_owner_t);
1018 void (*lm_notify)(struct file_lock *); /* unblock callback */
1019 int (*lm_grant)(struct file_lock *, int);
1020 bool (*lm_break)(struct file_lock *);
1021 int (*lm_change)(struct file_lock *, int, struct list_head *);
1022 void (*lm_setup)(struct file_lock *, void **);
1025 struct lock_manager {
1026 struct list_head list;
1028 * NFSv4 and up also want opens blocked during the grace period;
1035 void locks_start_grace(struct net *, struct lock_manager *);
1036 void locks_end_grace(struct lock_manager *);
1037 bool locks_in_grace(struct net *);
1038 bool opens_in_grace(struct net *);
1040 /* that will die - we need it for nfs_lock_info */
1041 #include <linux/nfs_fs_i.h>
1044 * struct file_lock represents a generic "file lock". It's used to represent
1045 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1046 * note that the same struct is used to represent both a request for a lock and
1047 * the lock itself, but the same object is never used for both.
1049 * FIXME: should we create a separate "struct lock_request" to help distinguish
1052 * The varous i_flctx lists are ordered by:
1055 * 2) lock range start
1058 * Obviously, the last two criteria only matter for POSIX locks.
1061 struct file_lock *fl_blocker; /* The lock, that is blocking us */
1062 struct list_head fl_list; /* link into file_lock_context */
1063 struct hlist_node fl_link; /* node in global lists */
1064 struct list_head fl_blocked_requests; /* list of requests with
1065 * ->fl_blocker pointing here
1067 struct list_head fl_blocked_member; /* node in
1068 * ->fl_blocker->fl_blocked_requests
1070 fl_owner_t fl_owner;
1071 unsigned int fl_flags;
1072 unsigned char fl_type;
1073 unsigned int fl_pid;
1074 int fl_link_cpu; /* what cpu's list is this on? */
1075 wait_queue_head_t fl_wait;
1076 struct file *fl_file;
1080 struct fasync_struct * fl_fasync; /* for lease break notifications */
1081 /* for lease breaks: */
1082 unsigned long fl_break_time;
1083 unsigned long fl_downgrade_time;
1085 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
1086 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
1088 struct nfs_lock_info nfs_fl;
1089 struct nfs4_lock_info nfs4_fl;
1091 struct list_head link; /* link in AFS vnode's pending_locks list */
1092 int state; /* state of grant or error if -ve */
1095 } __randomize_layout;
1097 struct file_lock_context {
1098 spinlock_t flc_lock;
1099 struct list_head flc_flock;
1100 struct list_head flc_posix;
1101 struct list_head flc_lease;
1104 /* The following constant reflects the upper bound of the file/locking space */
1106 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1107 #define OFFSET_MAX INT_LIMIT(loff_t)
1108 #define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1111 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1113 #define locks_inode(f) file_inode(f)
1115 #ifdef CONFIG_FILE_LOCKING
1116 extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1117 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1120 #if BITS_PER_LONG == 32
1121 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1122 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1126 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1127 extern int fcntl_getlease(struct file *filp);
1130 void locks_free_lock_context(struct inode *inode);
1131 void locks_free_lock(struct file_lock *fl);
1132 extern void locks_init_lock(struct file_lock *);
1133 extern struct file_lock * locks_alloc_lock(void);
1134 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1135 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1136 extern void locks_remove_posix(struct file *, fl_owner_t);
1137 extern void locks_remove_file(struct file *);
1138 extern void locks_release_private(struct file_lock *);
1139 extern void posix_test_lock(struct file *, struct file_lock *);
1140 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1141 extern int locks_delete_block(struct file_lock *);
1142 extern int vfs_test_lock(struct file *, struct file_lock *);
1143 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1144 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1145 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
1146 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1147 extern void lease_get_mtime(struct inode *, struct timespec64 *time);
1148 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1149 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1150 extern int lease_modify(struct file_lock *, int, struct list_head *);
1151 struct files_struct;
1152 extern void show_fd_locks(struct seq_file *f,
1153 struct file *filp, struct files_struct *files);
1154 #else /* !CONFIG_FILE_LOCKING */
1155 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1156 struct flock __user *user)
1161 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1162 unsigned int cmd, struct flock __user *user)
1167 #if BITS_PER_LONG == 32
1168 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1169 struct flock64 __user *user)
1174 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1175 unsigned int cmd, struct flock64 __user *user)
1180 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1185 static inline int fcntl_getlease(struct file *filp)
1191 locks_free_lock_context(struct inode *inode)
1195 static inline void locks_init_lock(struct file_lock *fl)
1200 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1205 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1210 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1215 static inline void locks_remove_file(struct file *filp)
1220 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1225 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1226 struct file_lock *conflock)
1231 static inline int locks_delete_block(struct file_lock *waiter)
1236 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1241 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1242 struct file_lock *fl, struct file_lock *conf)
1247 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1252 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1257 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1262 static inline void lease_get_mtime(struct inode *inode,
1263 struct timespec64 *time)
1268 static inline int generic_setlease(struct file *filp, long arg,
1269 struct file_lock **flp, void **priv)
1274 static inline int vfs_setlease(struct file *filp, long arg,
1275 struct file_lock **lease, void **priv)
1280 static inline int lease_modify(struct file_lock *fl, int arg,
1281 struct list_head *dispose)
1286 struct files_struct;
1287 static inline void show_fd_locks(struct seq_file *f,
1288 struct file *filp, struct files_struct *files) {}
1289 #endif /* !CONFIG_FILE_LOCKING */
1291 static inline struct inode *file_inode(const struct file *f)
1296 static inline struct dentry *file_dentry(const struct file *file)
1298 return d_real(file->f_path.dentry, file_inode(file));
1301 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1303 return locks_lock_inode_wait(locks_inode(filp), fl);
1306 struct fasync_struct {
1310 struct fasync_struct *fa_next; /* singly linked list */
1311 struct file *fa_file;
1312 struct rcu_head fa_rcu;
1315 #define FASYNC_MAGIC 0x4601
1317 /* SMP safe fasync helpers: */
1318 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1319 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1320 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1321 extern struct fasync_struct *fasync_alloc(void);
1322 extern void fasync_free(struct fasync_struct *);
1324 /* can be called from interrupts */
1325 extern void kill_fasync(struct fasync_struct **, int, int);
1327 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1328 extern int f_setown(struct file *filp, unsigned long arg, int force);
1329 extern void f_delown(struct file *filp);
1330 extern pid_t f_getown(struct file *filp);
1331 extern int send_sigurg(struct fown_struct *fown);
1334 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1335 * represented in both.
1337 #define SB_RDONLY 1 /* Mount read-only */
1338 #define SB_NOSUID 2 /* Ignore suid and sgid bits */
1339 #define SB_NODEV 4 /* Disallow access to device special files */
1340 #define SB_NOEXEC 8 /* Disallow program execution */
1341 #define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1342 #define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1343 #define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1344 #define SB_NOATIME 1024 /* Do not update access times. */
1345 #define SB_NODIRATIME 2048 /* Do not update directory access times */
1346 #define SB_SILENT 32768
1347 #define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1348 #define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1349 #define SB_I_VERSION (1<<23) /* Update inode I_version field */
1350 #define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1352 /* These sb flags are internal to the kernel */
1353 #define SB_SUBMOUNT (1<<26)
1354 #define SB_FORCE (1<<27)
1355 #define SB_NOSEC (1<<28)
1356 #define SB_BORN (1<<29)
1357 #define SB_ACTIVE (1<<30)
1358 #define SB_NOUSER (1<<31)
1364 #define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1365 #define MNT_DETACH 0x00000002 /* Just detach from the tree */
1366 #define MNT_EXPIRE 0x00000004 /* Mark for expiry */
1367 #define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1368 #define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1371 #define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
1372 #define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
1373 #define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
1374 #define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
1376 /* sb->s_iflags to limit user namespace mounts */
1377 #define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
1378 #define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1379 #define SB_I_UNTRUSTED_MOUNTER 0x00000040
1381 /* Possible states of 'frozen' field */
1383 SB_UNFROZEN = 0, /* FS is unfrozen */
1384 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
1385 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1386 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1387 * internal threads if needed) */
1388 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1391 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1394 int frozen; /* Is sb frozen? */
1395 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1396 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
1399 struct super_block {
1400 struct list_head s_list; /* Keep this first */
1401 dev_t s_dev; /* search index; _not_ kdev_t */
1402 unsigned char s_blocksize_bits;
1403 unsigned long s_blocksize;
1404 loff_t s_maxbytes; /* Max file size */
1405 struct file_system_type *s_type;
1406 const struct super_operations *s_op;
1407 const struct dquot_operations *dq_op;
1408 const struct quotactl_ops *s_qcop;
1409 const struct export_operations *s_export_op;
1410 unsigned long s_flags;
1411 unsigned long s_iflags; /* internal SB_I_* flags */
1412 unsigned long s_magic;
1413 struct dentry *s_root;
1414 struct rw_semaphore s_umount;
1417 #ifdef CONFIG_SECURITY
1420 const struct xattr_handler **s_xattr;
1421 #ifdef CONFIG_FS_ENCRYPTION
1422 const struct fscrypt_operations *s_cop;
1424 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
1425 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1426 struct block_device *s_bdev;
1427 struct backing_dev_info *s_bdi;
1428 struct mtd_info *s_mtd;
1429 struct hlist_node s_instances;
1430 unsigned int s_quota_types; /* Bitmask of supported quota types */
1431 struct quota_info s_dquot; /* Diskquota specific options */
1433 struct sb_writers s_writers;
1436 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1437 * s_fsnotify_marks together for cache efficiency. They are frequently
1438 * accessed and rarely modified.
1440 void *s_fs_info; /* Filesystem private info */
1442 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1444 #ifdef CONFIG_FSNOTIFY
1445 __u32 s_fsnotify_mask;
1446 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1449 char s_id[32]; /* Informational name */
1450 uuid_t s_uuid; /* UUID */
1452 unsigned int s_max_links;
1456 * The next field is for VFS *only*. No filesystems have any business
1457 * even looking at it. You had been warned.
1459 struct mutex s_vfs_rename_mutex; /* Kludge */
1462 * Filesystem subtype. If non-empty the filesystem type field
1463 * in /proc/mounts will be "type.subtype"
1465 const char *s_subtype;
1467 const struct dentry_operations *s_d_op; /* default d_op for dentries */
1470 * Saved pool identifier for cleancache (-1 means none)
1472 int cleancache_poolid;
1474 struct shrinker s_shrink; /* per-sb shrinker handle */
1476 /* Number of inodes with nlink == 0 but still referenced */
1477 atomic_long_t s_remove_count;
1479 /* Pending fsnotify inode refs */
1480 atomic_long_t s_fsnotify_inode_refs;
1482 /* Being remounted read-only */
1483 int s_readonly_remount;
1485 /* AIO completions deferred from interrupt context */
1486 struct workqueue_struct *s_dio_done_wq;
1487 struct hlist_head s_pins;
1490 * Owning user namespace and default context in which to
1491 * interpret filesystem uids, gids, quotas, device nodes,
1492 * xattrs and security labels.
1494 struct user_namespace *s_user_ns;
1497 * The list_lru structure is essentially just a pointer to a table
1498 * of per-node lru lists, each of which has its own spinlock.
1499 * There is no need to put them into separate cachelines.
1501 struct list_lru s_dentry_lru;
1502 struct list_lru s_inode_lru;
1503 struct rcu_head rcu;
1504 struct work_struct destroy_work;
1506 struct mutex s_sync_lock; /* sync serialisation lock */
1509 * Indicates how deep in a filesystem stack this SB is
1513 /* s_inode_list_lock protects s_inodes */
1514 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1515 struct list_head s_inodes; /* all inodes */
1517 spinlock_t s_inode_wblist_lock;
1518 struct list_head s_inodes_wb; /* writeback inodes */
1519 } __randomize_layout;
1521 /* Helper functions so that in most cases filesystems will
1522 * not need to deal directly with kuid_t and kgid_t and can
1523 * instead deal with the raw numeric values that are stored
1524 * in the filesystem.
1526 static inline uid_t i_uid_read(const struct inode *inode)
1528 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1531 static inline gid_t i_gid_read(const struct inode *inode)
1533 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1536 static inline void i_uid_write(struct inode *inode, uid_t uid)
1538 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1541 static inline void i_gid_write(struct inode *inode, gid_t gid)
1543 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1546 extern struct timespec64 timespec64_trunc(struct timespec64 t, unsigned gran);
1547 extern struct timespec64 current_time(struct inode *inode);
1550 * Snapshotting support.
1553 void __sb_end_write(struct super_block *sb, int level);
1554 int __sb_start_write(struct super_block *sb, int level, bool wait);
1556 #define __sb_writers_acquired(sb, lev) \
1557 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1558 #define __sb_writers_release(sb, lev) \
1559 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1562 * sb_end_write - drop write access to a superblock
1563 * @sb: the super we wrote to
1565 * Decrement number of writers to the filesystem. Wake up possible waiters
1566 * wanting to freeze the filesystem.
1568 static inline void sb_end_write(struct super_block *sb)
1570 __sb_end_write(sb, SB_FREEZE_WRITE);
1574 * sb_end_pagefault - drop write access to a superblock from a page fault
1575 * @sb: the super we wrote to
1577 * Decrement number of processes handling write page fault to the filesystem.
1578 * Wake up possible waiters wanting to freeze the filesystem.
1580 static inline void sb_end_pagefault(struct super_block *sb)
1582 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1586 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1587 * @sb: the super we wrote to
1589 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1590 * waiters wanting to freeze the filesystem.
1592 static inline void sb_end_intwrite(struct super_block *sb)
1594 __sb_end_write(sb, SB_FREEZE_FS);
1598 * sb_start_write - get write access to a superblock
1599 * @sb: the super we write to
1601 * When a process wants to write data or metadata to a file system (i.e. dirty
1602 * a page or an inode), it should embed the operation in a sb_start_write() -
1603 * sb_end_write() pair to get exclusion against file system freezing. This
1604 * function increments number of writers preventing freezing. If the file
1605 * system is already frozen, the function waits until the file system is
1608 * Since freeze protection behaves as a lock, users have to preserve
1609 * ordering of freeze protection and other filesystem locks. Generally,
1610 * freeze protection should be the outermost lock. In particular, we have:
1613 * -> i_mutex (write path, truncate, directory ops, ...)
1614 * -> s_umount (freeze_super, thaw_super)
1616 static inline void sb_start_write(struct super_block *sb)
1618 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1621 static inline int sb_start_write_trylock(struct super_block *sb)
1623 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1627 * sb_start_pagefault - get write access to a superblock from a page fault
1628 * @sb: the super we write to
1630 * When a process starts handling write page fault, it should embed the
1631 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1632 * exclusion against file system freezing. This is needed since the page fault
1633 * is going to dirty a page. This function increments number of running page
1634 * faults preventing freezing. If the file system is already frozen, the
1635 * function waits until the file system is thawed.
1637 * Since page fault freeze protection behaves as a lock, users have to preserve
1638 * ordering of freeze protection and other filesystem locks. It is advised to
1639 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1640 * handling code implies lock dependency:
1643 * -> sb_start_pagefault
1645 static inline void sb_start_pagefault(struct super_block *sb)
1647 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1651 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1652 * @sb: the super we write to
1654 * This is the third level of protection against filesystem freezing. It is
1655 * free for use by a filesystem. The only requirement is that it must rank
1656 * below sb_start_pagefault.
1658 * For example filesystem can call sb_start_intwrite() when starting a
1659 * transaction which somewhat eases handling of freezing for internal sources
1660 * of filesystem changes (internal fs threads, discarding preallocation on file
1663 static inline void sb_start_intwrite(struct super_block *sb)
1665 __sb_start_write(sb, SB_FREEZE_FS, true);
1668 static inline int sb_start_intwrite_trylock(struct super_block *sb)
1670 return __sb_start_write(sb, SB_FREEZE_FS, false);
1674 extern bool inode_owner_or_capable(const struct inode *inode);
1677 * VFS helper functions..
1679 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1680 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1681 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1682 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1683 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1684 extern int vfs_rmdir(struct inode *, struct dentry *);
1685 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1686 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1687 extern int vfs_whiteout(struct inode *, struct dentry *);
1689 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1692 int vfs_mkobj(struct dentry *, umode_t,
1693 int (*f)(struct dentry *, umode_t, void *),
1696 extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1699 * VFS file helper functions.
1701 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1703 extern bool may_open_dev(const struct path *path);
1705 * VFS FS_IOC_FIEMAP helper definitions.
1707 struct fiemap_extent_info {
1708 unsigned int fi_flags; /* Flags as passed from user */
1709 unsigned int fi_extents_mapped; /* Number of mapped extents */
1710 unsigned int fi_extents_max; /* Size of fiemap_extent array */
1711 struct fiemap_extent __user *fi_extents_start; /* Start of
1712 fiemap_extent array */
1714 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1715 u64 phys, u64 len, u32 flags);
1716 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1719 * This is the "filldir" function type, used by readdir() to let
1720 * the kernel specify what kind of dirent layout it wants to have.
1721 * This allows the kernel to read directories into kernel space or
1722 * to have different dirent layouts depending on the binary type.
1725 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1728 struct dir_context {
1733 struct block_device_operations;
1735 /* These macros are for out of kernel modules to test that
1736 * the kernel supports the unlocked_ioctl and compat_ioctl
1737 * fields in struct file_operations. */
1738 #define HAVE_COMPAT_IOCTL 1
1739 #define HAVE_UNLOCKED_IOCTL 1
1742 * These flags let !MMU mmap() govern direct device mapping vs immediate
1743 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1745 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1746 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1747 * NOMMU_MAP_READ: Can be mapped for reading
1748 * NOMMU_MAP_WRITE: Can be mapped for writing
1749 * NOMMU_MAP_EXEC: Can be mapped for execution
1751 #define NOMMU_MAP_COPY 0x00000001
1752 #define NOMMU_MAP_DIRECT 0x00000008
1753 #define NOMMU_MAP_READ VM_MAYREAD
1754 #define NOMMU_MAP_WRITE VM_MAYWRITE
1755 #define NOMMU_MAP_EXEC VM_MAYEXEC
1757 #define NOMMU_VMFLAGS \
1758 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1761 * These flags control the behavior of the remap_file_range function pointer.
1762 * If it is called with len == 0 that means "remap to end of source file".
1763 * See Documentation/filesystems/vfs.txt for more details about this call.
1765 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
1766 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
1768 #define REMAP_FILE_DEDUP (1 << 0)
1769 #define REMAP_FILE_CAN_SHORTEN (1 << 1)
1772 * These flags signal that the caller is ok with altering various aspects of
1773 * the behavior of the remap operation. The changes must be made by the
1774 * implementation; the vfs remap helper functions can take advantage of them.
1775 * Flags in this category exist to preserve the quirky behavior of the hoisted
1776 * btrfs clone/dedupe ioctls.
1778 #define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
1782 struct file_operations {
1783 struct module *owner;
1784 loff_t (*llseek) (struct file *, loff_t, int);
1785 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1786 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1787 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1788 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1789 int (*iopoll)(struct kiocb *kiocb, bool spin);
1790 int (*iterate) (struct file *, struct dir_context *);
1791 int (*iterate_shared) (struct file *, struct dir_context *);
1792 __poll_t (*poll) (struct file *, struct poll_table_struct *);
1793 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1794 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1795 int (*mmap) (struct file *, struct vm_area_struct *);
1796 unsigned long mmap_supported_flags;
1797 int (*open) (struct inode *, struct file *);
1798 int (*flush) (struct file *, fl_owner_t id);
1799 int (*release) (struct inode *, struct file *);
1800 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1801 int (*fasync) (int, struct file *, int);
1802 int (*lock) (struct file *, int, struct file_lock *);
1803 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1804 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1805 int (*check_flags)(int);
1806 int (*flock) (struct file *, int, struct file_lock *);
1807 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1808 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1809 int (*setlease)(struct file *, long, struct file_lock **, void **);
1810 long (*fallocate)(struct file *file, int mode, loff_t offset,
1812 void (*show_fdinfo)(struct seq_file *m, struct file *f);
1814 unsigned (*mmap_capabilities)(struct file *);
1816 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1817 loff_t, size_t, unsigned int);
1818 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1819 struct file *file_out, loff_t pos_out,
1820 loff_t len, unsigned int remap_flags);
1821 int (*fadvise)(struct file *, loff_t, loff_t, int);
1822 } __randomize_layout;
1824 struct inode_operations {
1825 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1826 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1827 int (*permission) (struct inode *, int);
1828 struct posix_acl * (*get_acl)(struct inode *, int);
1830 int (*readlink) (struct dentry *, char __user *,int);
1832 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1833 int (*link) (struct dentry *,struct inode *,struct dentry *);
1834 int (*unlink) (struct inode *,struct dentry *);
1835 int (*symlink) (struct inode *,struct dentry *,const char *);
1836 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1837 int (*rmdir) (struct inode *,struct dentry *);
1838 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1839 int (*rename) (struct inode *, struct dentry *,
1840 struct inode *, struct dentry *, unsigned int);
1841 int (*setattr) (struct dentry *, struct iattr *);
1842 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1843 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1844 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1846 int (*update_time)(struct inode *, struct timespec64 *, int);
1847 int (*atomic_open)(struct inode *, struct dentry *,
1848 struct file *, unsigned open_flag,
1849 umode_t create_mode);
1850 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1851 int (*set_acl)(struct inode *, struct posix_acl *, int);
1852 } ____cacheline_aligned;
1854 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1855 struct iov_iter *iter)
1857 return file->f_op->read_iter(kio, iter);
1860 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1861 struct iov_iter *iter)
1863 return file->f_op->write_iter(kio, iter);
1866 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1868 return file->f_op->mmap(file, vma);
1871 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1872 unsigned long nr_segs, unsigned long fast_segs,
1873 struct iovec *fast_pointer,
1874 struct iovec **ret_pointer);
1876 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1877 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1878 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1879 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1880 unsigned long, loff_t *, rwf_t);
1881 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1882 loff_t, size_t, unsigned int);
1883 extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
1884 struct file *file_out, loff_t pos_out,
1886 unsigned int remap_flags);
1887 extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
1888 struct file *file_out, loff_t pos_out,
1889 loff_t len, unsigned int remap_flags);
1890 extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1891 struct file *file_out, loff_t pos_out,
1892 loff_t len, unsigned int remap_flags);
1893 extern int vfs_dedupe_file_range(struct file *file,
1894 struct file_dedupe_range *same);
1895 extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1896 struct file *dst_file, loff_t dst_pos,
1897 loff_t len, unsigned int remap_flags);
1900 struct super_operations {
1901 struct inode *(*alloc_inode)(struct super_block *sb);
1902 void (*destroy_inode)(struct inode *);
1904 void (*dirty_inode) (struct inode *, int flags);
1905 int (*write_inode) (struct inode *, struct writeback_control *wbc);
1906 int (*drop_inode) (struct inode *);
1907 void (*evict_inode) (struct inode *);
1908 void (*put_super) (struct super_block *);
1909 int (*sync_fs)(struct super_block *sb, int wait);
1910 int (*freeze_super) (struct super_block *);
1911 int (*freeze_fs) (struct super_block *);
1912 int (*thaw_super) (struct super_block *);
1913 int (*unfreeze_fs) (struct super_block *);
1914 int (*statfs) (struct dentry *, struct kstatfs *);
1915 int (*remount_fs) (struct super_block *, int *, char *);
1916 void (*umount_begin) (struct super_block *);
1918 int (*show_options)(struct seq_file *, struct dentry *);
1919 int (*show_devname)(struct seq_file *, struct dentry *);
1920 int (*show_path)(struct seq_file *, struct dentry *);
1921 int (*show_stats)(struct seq_file *, struct dentry *);
1923 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1924 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1925 struct dquot **(*get_dquots)(struct inode *);
1927 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1928 long (*nr_cached_objects)(struct super_block *,
1929 struct shrink_control *);
1930 long (*free_cached_objects)(struct super_block *,
1931 struct shrink_control *);
1935 * Inode flags - they have no relation to superblock flags now
1937 #define S_SYNC 1 /* Writes are synced at once */
1938 #define S_NOATIME 2 /* Do not update access times */
1939 #define S_APPEND 4 /* Append-only file */
1940 #define S_IMMUTABLE 8 /* Immutable file */
1941 #define S_DEAD 16 /* removed, but still open directory */
1942 #define S_NOQUOTA 32 /* Inode is not counted to quota */
1943 #define S_DIRSYNC 64 /* Directory modifications are synchronous */
1944 #define S_NOCMTIME 128 /* Do not update file c/mtime */
1945 #define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1946 #define S_PRIVATE 512 /* Inode is fs-internal */
1947 #define S_IMA 1024 /* Inode has an associated IMA struct */
1948 #define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1949 #define S_NOSEC 4096 /* no suid or xattr security attributes */
1950 #ifdef CONFIG_FS_DAX
1951 #define S_DAX 8192 /* Direct Access, avoiding the page cache */
1953 #define S_DAX 0 /* Make all the DAX code disappear */
1955 #define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
1958 * Note that nosuid etc flags are inode-specific: setting some file-system
1959 * flags just means all the inodes inherit those flags by default. It might be
1960 * possible to override it selectively if you really wanted to with some
1961 * ioctl() that is not currently implemented.
1963 * Exception: SB_RDONLY is always applied to the entire file system.
1965 * Unfortunately, it is possible to change a filesystems flags with it mounted
1966 * with files in use. This means that all of the inodes will not have their
1967 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1970 #define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1972 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
1973 #define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
1974 #define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
1975 ((inode)->i_flags & S_SYNC))
1976 #define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
1977 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1978 #define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
1979 #define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1980 #define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
1982 #define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1983 #define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1984 #define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1985 #define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
1987 #define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1988 #define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1989 #define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1990 #define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1991 #define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1992 #define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1993 #define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
1994 #define IS_DAX(inode) ((inode)->i_flags & S_DAX)
1995 #define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
1997 #define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1998 (inode)->i_rdev == WHITEOUT_DEV)
2000 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2002 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2005 static inline enum rw_hint file_write_hint(struct file *file)
2007 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2008 return file->f_write_hint;
2010 return file_inode(file)->i_write_hint;
2013 static inline int iocb_flags(struct file *file);
2015 static inline u16 ki_hint_validate(enum rw_hint hint)
2017 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2019 if (hint <= max_hint)
2024 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2026 *kiocb = (struct kiocb) {
2028 .ki_flags = iocb_flags(filp),
2029 .ki_hint = ki_hint_validate(file_write_hint(filp)),
2030 .ki_ioprio = get_current_ioprio(),
2035 * Inode state bits. Protected by inode->i_lock
2037 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2038 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2040 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2041 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2042 * various stages of removing an inode.
2044 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
2046 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2047 * fdatasync(). i_atime is the usual cause.
2048 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2049 * these changes separately from I_DIRTY_SYNC so that we
2050 * don't have to write inode on fdatasync() when only
2051 * mtime has changed in it.
2052 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
2053 * I_NEW Serves as both a mutex and completion notification.
2054 * New inodes set I_NEW. If two processes both create
2055 * the same inode, one of them will release its inode and
2056 * wait for I_NEW to be released before returning.
2057 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2058 * also cause waiting on I_NEW, without I_NEW actually
2059 * being set. find_inode() uses this to prevent returning
2060 * nearly-dead inodes.
2061 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2062 * is zero. I_FREEING must be set when I_WILL_FREE is
2064 * I_FREEING Set when inode is about to be freed but still has dirty
2065 * pages or buffers attached or the inode itself is still
2067 * I_CLEAR Added by clear_inode(). In this state the inode is
2068 * clean and can be destroyed. Inode keeps I_FREEING.
2070 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2071 * prohibited for many purposes. iget() must wait for
2072 * the inode to be completely released, then create it
2073 * anew. Other functions will just ignore such inodes,
2074 * if appropriate. I_NEW is used for waiting.
2076 * I_SYNC Writeback of inode is running. The bit is set during
2077 * data writeback, and cleared with a wakeup on the bit
2078 * address once it is done. The bit is also used to pin
2079 * the inode in memory for flusher thread.
2081 * I_REFERENCED Marks the inode as recently references on the LRU list.
2083 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2085 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2086 * synchronize competing switching instances and to tell
2087 * wb stat updates to grab the i_pages lock. See
2088 * inode_switch_wbs_work_fn() for details.
2090 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2091 * and work dirs among overlayfs mounts.
2093 * I_CREATING New object's inode in the middle of setting up.
2095 * Q: What is the difference between I_WILL_FREE and I_FREEING?
2097 #define I_DIRTY_SYNC (1 << 0)
2098 #define I_DIRTY_DATASYNC (1 << 1)
2099 #define I_DIRTY_PAGES (1 << 2)
2101 #define I_NEW (1 << __I_NEW)
2102 #define I_WILL_FREE (1 << 4)
2103 #define I_FREEING (1 << 5)
2104 #define I_CLEAR (1 << 6)
2106 #define I_SYNC (1 << __I_SYNC)
2107 #define I_REFERENCED (1 << 8)
2108 #define __I_DIO_WAKEUP 9
2109 #define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
2110 #define I_LINKABLE (1 << 10)
2111 #define I_DIRTY_TIME (1 << 11)
2112 #define __I_DIRTY_TIME_EXPIRED 12
2113 #define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
2114 #define I_WB_SWITCH (1 << 13)
2115 #define I_OVL_INUSE (1 << 14)
2116 #define I_CREATING (1 << 15)
2118 #define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2119 #define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2120 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
2122 extern void __mark_inode_dirty(struct inode *, int);
2123 static inline void mark_inode_dirty(struct inode *inode)
2125 __mark_inode_dirty(inode, I_DIRTY);
2128 static inline void mark_inode_dirty_sync(struct inode *inode)
2130 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2133 extern void inc_nlink(struct inode *inode);
2134 extern void drop_nlink(struct inode *inode);
2135 extern void clear_nlink(struct inode *inode);
2136 extern void set_nlink(struct inode *inode, unsigned int nlink);
2138 static inline void inode_inc_link_count(struct inode *inode)
2141 mark_inode_dirty(inode);
2144 static inline void inode_dec_link_count(struct inode *inode)
2147 mark_inode_dirty(inode);
2150 enum file_time_flags {
2157 extern bool atime_needs_update(const struct path *, struct inode *);
2158 extern void touch_atime(const struct path *);
2159 static inline void file_accessed(struct file *file)
2161 if (!(file->f_flags & O_NOATIME))
2162 touch_atime(&file->f_path);
2165 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2166 int sync_inode_metadata(struct inode *inode, int wait);
2168 struct file_system_type {
2171 #define FS_REQUIRES_DEV 1
2172 #define FS_BINARY_MOUNTDATA 2
2173 #define FS_HAS_SUBTYPE 4
2174 #define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
2175 #define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
2176 int (*init_fs_context)(struct fs_context *);
2177 const struct fs_parameter_description *parameters;
2178 struct dentry *(*mount) (struct file_system_type *, int,
2179 const char *, void *);
2180 void (*kill_sb) (struct super_block *);
2181 struct module *owner;
2182 struct file_system_type * next;
2183 struct hlist_head fs_supers;
2185 struct lock_class_key s_lock_key;
2186 struct lock_class_key s_umount_key;
2187 struct lock_class_key s_vfs_rename_key;
2188 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2190 struct lock_class_key i_lock_key;
2191 struct lock_class_key i_mutex_key;
2192 struct lock_class_key i_mutex_dir_key;
2195 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2197 extern struct dentry *mount_ns(struct file_system_type *fs_type,
2198 int flags, void *data, void *ns, struct user_namespace *user_ns,
2199 int (*fill_super)(struct super_block *, void *, int));
2201 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2202 int flags, const char *dev_name, void *data,
2203 int (*fill_super)(struct super_block *, void *, int));
2205 static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2206 int flags, const char *dev_name, void *data,
2207 int (*fill_super)(struct super_block *, void *, int))
2209 return ERR_PTR(-ENODEV);
2212 extern struct dentry *mount_single(struct file_system_type *fs_type,
2213 int flags, void *data,
2214 int (*fill_super)(struct super_block *, void *, int));
2215 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2216 int flags, void *data,
2217 int (*fill_super)(struct super_block *, void *, int));
2218 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2219 void generic_shutdown_super(struct super_block *sb);
2221 void kill_block_super(struct super_block *sb);
2223 static inline void kill_block_super(struct super_block *sb)
2228 void kill_anon_super(struct super_block *sb);
2229 void kill_litter_super(struct super_block *sb);
2230 void deactivate_super(struct super_block *sb);
2231 void deactivate_locked_super(struct super_block *sb);
2232 int set_anon_super(struct super_block *s, void *data);
2233 int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2234 int get_anon_bdev(dev_t *);
2235 void free_anon_bdev(dev_t);
2236 struct super_block *sget_fc(struct fs_context *fc,
2237 int (*test)(struct super_block *, struct fs_context *),
2238 int (*set)(struct super_block *, struct fs_context *));
2239 struct super_block *sget_userns(struct file_system_type *type,
2240 int (*test)(struct super_block *,void *),
2241 int (*set)(struct super_block *,void *),
2242 int flags, struct user_namespace *user_ns,
2244 struct super_block *sget(struct file_system_type *type,
2245 int (*test)(struct super_block *,void *),
2246 int (*set)(struct super_block *,void *),
2247 int flags, void *data);
2248 extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2249 const struct super_operations *ops,
2250 const struct xattr_handler **xattr,
2251 const struct dentry_operations *dops,
2254 static inline struct dentry *
2255 mount_pseudo(struct file_system_type *fs_type, char *name,
2256 const struct super_operations *ops,
2257 const struct dentry_operations *dops, unsigned long magic)
2259 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2262 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2263 #define fops_get(fops) \
2264 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2265 #define fops_put(fops) \
2266 do { if (fops) module_put((fops)->owner); } while(0)
2268 * This one is to be used *ONLY* from ->open() instances.
2269 * fops must be non-NULL, pinned down *and* module dependencies
2270 * should be sufficient to pin the caller down as well.
2272 #define replace_fops(f, fops) \
2274 struct file *__file = (f); \
2275 fops_put(__file->f_op); \
2276 BUG_ON(!(__file->f_op = (fops))); \
2279 extern int register_filesystem(struct file_system_type *);
2280 extern int unregister_filesystem(struct file_system_type *);
2281 extern struct vfsmount *kern_mount(struct file_system_type *);
2282 extern void kern_unmount(struct vfsmount *mnt);
2283 extern int may_umount_tree(struct vfsmount *);
2284 extern int may_umount(struct vfsmount *);
2285 extern long do_mount(const char *, const char __user *,
2286 const char *, unsigned long, void *);
2287 extern struct vfsmount *collect_mounts(const struct path *);
2288 extern void drop_collected_mounts(struct vfsmount *);
2289 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2291 extern int vfs_statfs(const struct path *, struct kstatfs *);
2292 extern int user_statfs(const char __user *, struct kstatfs *);
2293 extern int fd_statfs(int, struct kstatfs *);
2294 extern int freeze_super(struct super_block *super);
2295 extern int thaw_super(struct super_block *super);
2296 extern bool our_mnt(struct vfsmount *mnt);
2297 extern __printf(2, 3)
2298 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2299 extern int super_setup_bdi(struct super_block *sb);
2301 extern int current_umask(void);
2303 extern void ihold(struct inode * inode);
2304 extern void iput(struct inode *);
2305 extern int generic_update_time(struct inode *, struct timespec64 *, int);
2308 extern struct kobject *fs_kobj;
2310 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2312 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2313 extern int locks_mandatory_locked(struct file *);
2314 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2317 * Candidates for mandatory locking have the setgid bit set
2318 * but no group execute bit - an otherwise meaningless combination.
2321 static inline int __mandatory_lock(struct inode *ino)
2323 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2327 * ... and these candidates should be on SB_MANDLOCK mounted fs,
2328 * otherwise these will be advisory locks
2331 static inline int mandatory_lock(struct inode *ino)
2333 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2336 static inline int locks_verify_locked(struct file *file)
2338 if (mandatory_lock(locks_inode(file)))
2339 return locks_mandatory_locked(file);
2343 static inline int locks_verify_truncate(struct inode *inode,
2347 if (!inode->i_flctx || !mandatory_lock(inode))
2350 if (size < inode->i_size) {
2351 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2354 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2359 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2361 static inline int locks_mandatory_locked(struct file *file)
2366 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2367 loff_t start, loff_t end, unsigned char type)
2372 static inline int __mandatory_lock(struct inode *inode)
2377 static inline int mandatory_lock(struct inode *inode)
2382 static inline int locks_verify_locked(struct file *file)
2387 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2393 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2396 #ifdef CONFIG_FILE_LOCKING
2397 static inline int break_lease(struct inode *inode, unsigned int mode)
2400 * Since this check is lockless, we must ensure that any refcounts
2401 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2402 * could end up racing with tasks trying to set a new lease on this
2406 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2407 return __break_lease(inode, mode, FL_LEASE);
2411 static inline int break_deleg(struct inode *inode, unsigned int mode)
2414 * Since this check is lockless, we must ensure that any refcounts
2415 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2416 * could end up racing with tasks trying to set a new lease on this
2420 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2421 return __break_lease(inode, mode, FL_DELEG);
2425 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2429 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2430 if (ret == -EWOULDBLOCK && delegated_inode) {
2431 *delegated_inode = inode;
2437 static inline int break_deleg_wait(struct inode **delegated_inode)
2441 ret = break_deleg(*delegated_inode, O_WRONLY);
2442 iput(*delegated_inode);
2443 *delegated_inode = NULL;
2447 static inline int break_layout(struct inode *inode, bool wait)
2450 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2451 return __break_lease(inode,
2452 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2457 #else /* !CONFIG_FILE_LOCKING */
2458 static inline int break_lease(struct inode *inode, unsigned int mode)
2463 static inline int break_deleg(struct inode *inode, unsigned int mode)
2468 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2473 static inline int break_deleg_wait(struct inode **delegated_inode)
2479 static inline int break_layout(struct inode *inode, bool wait)
2484 #endif /* CONFIG_FILE_LOCKING */
2489 const char *name; /* pointer to actual string */
2490 const __user char *uptr; /* original userland pointer */
2492 struct audit_names *aname;
2495 static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
2497 extern long vfs_truncate(const struct path *, loff_t);
2498 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2500 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2502 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2504 extern struct file *file_open_name(struct filename *, int, umode_t);
2505 extern struct file *filp_open(const char *, int, umode_t);
2506 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2507 const char *, int, umode_t);
2508 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2509 extern struct file * open_with_fake_path(const struct path *, int,
2510 struct inode*, const struct cred *);
2511 static inline struct file *file_clone_open(struct file *file)
2513 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2515 extern int filp_close(struct file *, fl_owner_t id);
2517 extern struct filename *getname_flags(const char __user *, int, int *);
2518 extern struct filename *getname(const char __user *);
2519 extern struct filename *getname_kernel(const char *);
2520 extern void putname(struct filename *name);
2522 extern int finish_open(struct file *file, struct dentry *dentry,
2523 int (*open)(struct inode *, struct file *));
2524 extern int finish_no_open(struct file *file, struct dentry *dentry);
2528 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2531 extern void __init vfs_caches_init_early(void);
2532 extern void __init vfs_caches_init(void);
2534 extern struct kmem_cache *names_cachep;
2536 #define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
2537 #define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
2540 extern int register_blkdev(unsigned int, const char *);
2541 extern void unregister_blkdev(unsigned int, const char *);
2542 extern void bdev_unhash_inode(dev_t dev);
2543 extern struct block_device *bdget(dev_t);
2544 extern struct block_device *bdgrab(struct block_device *bdev);
2545 extern void bd_set_size(struct block_device *, loff_t size);
2546 extern void bd_forget(struct inode *inode);
2547 extern void bdput(struct block_device *);
2548 extern void invalidate_bdev(struct block_device *);
2549 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
2550 extern int sync_blockdev(struct block_device *bdev);
2551 extern void kill_bdev(struct block_device *);
2552 extern struct super_block *freeze_bdev(struct block_device *);
2553 extern void emergency_thaw_all(void);
2554 extern void emergency_thaw_bdev(struct super_block *sb);
2555 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2556 extern int fsync_bdev(struct block_device *);
2558 extern struct super_block *blockdev_superblock;
2560 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2562 return sb == blockdev_superblock;
2565 static inline void bd_forget(struct inode *inode) {}
2566 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2567 static inline void kill_bdev(struct block_device *bdev) {}
2568 static inline void invalidate_bdev(struct block_device *bdev) {}
2570 static inline struct super_block *freeze_bdev(struct block_device *sb)
2575 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2580 static inline int emergency_thaw_bdev(struct super_block *sb)
2585 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2589 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2594 extern int sync_filesystem(struct super_block *);
2595 extern const struct file_operations def_blk_fops;
2596 extern const struct file_operations def_chr_fops;
2598 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2599 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2600 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2601 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2602 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2604 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2606 extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2607 extern int __blkdev_reread_part(struct block_device *bdev);
2608 extern int blkdev_reread_part(struct block_device *bdev);
2611 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2612 extern void bd_unlink_disk_holder(struct block_device *bdev,
2613 struct gendisk *disk);
2615 static inline int bd_link_disk_holder(struct block_device *bdev,
2616 struct gendisk *disk)
2620 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2621 struct gendisk *disk)
2628 #define CHRDEV_MAJOR_MAX 512
2629 /* Marks the bottom of the first segment of free char majors */
2630 #define CHRDEV_MAJOR_DYN_END 234
2631 /* Marks the top and bottom of the second segment of free char majors */
2632 #define CHRDEV_MAJOR_DYN_EXT_START 511
2633 #define CHRDEV_MAJOR_DYN_EXT_END 384
2635 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2636 extern int register_chrdev_region(dev_t, unsigned, const char *);
2637 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2638 unsigned int count, const char *name,
2639 const struct file_operations *fops);
2640 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2641 unsigned int count, const char *name);
2642 extern void unregister_chrdev_region(dev_t, unsigned);
2643 extern void chrdev_show(struct seq_file *,off_t);
2645 static inline int register_chrdev(unsigned int major, const char *name,
2646 const struct file_operations *fops)
2648 return __register_chrdev(major, 0, 256, name, fops);
2651 static inline void unregister_chrdev(unsigned int major, const char *name)
2653 __unregister_chrdev(major, 0, 256, name);
2656 /* fs/block_dev.c */
2657 #define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
2658 #define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
2661 #define BLKDEV_MAJOR_MAX 512
2662 extern const char *__bdevname(dev_t, char *buffer);
2663 extern const char *bdevname(struct block_device *bdev, char *buffer);
2664 extern struct block_device *lookup_bdev(const char *);
2665 extern void blkdev_show(struct seq_file *,off_t);
2668 #define BLKDEV_MAJOR_MAX 0
2671 extern void init_special_inode(struct inode *, umode_t, dev_t);
2673 /* Invalid inode operations -- fs/bad_inode.c */
2674 extern void make_bad_inode(struct inode *);
2675 extern bool is_bad_inode(struct inode *);
2678 extern void check_disk_size_change(struct gendisk *disk,
2679 struct block_device *bdev, bool verbose);
2680 extern int revalidate_disk(struct gendisk *);
2681 extern int check_disk_change(struct block_device *);
2682 extern int __invalidate_device(struct block_device *, bool);
2683 extern int invalidate_partition(struct gendisk *, int);
2685 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2686 pgoff_t start, pgoff_t end);
2688 static inline void invalidate_remote_inode(struct inode *inode)
2690 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2691 S_ISLNK(inode->i_mode))
2692 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2694 extern int invalidate_inode_pages2(struct address_space *mapping);
2695 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2696 pgoff_t start, pgoff_t end);
2697 extern int write_inode_now(struct inode *, int);
2698 extern int filemap_fdatawrite(struct address_space *);
2699 extern int filemap_flush(struct address_space *);
2700 extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2701 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2704 static inline int filemap_fdatawait(struct address_space *mapping)
2706 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2709 extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2711 extern int filemap_write_and_wait(struct address_space *mapping);
2712 extern int filemap_write_and_wait_range(struct address_space *mapping,
2713 loff_t lstart, loff_t lend);
2714 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2715 loff_t start, loff_t end, int sync_mode);
2716 extern int filemap_fdatawrite_range(struct address_space *mapping,
2717 loff_t start, loff_t end);
2718 extern int filemap_check_errors(struct address_space *mapping);
2719 extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2721 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2723 extern int __must_check file_check_and_advance_wb_err(struct file *file);
2724 extern int __must_check file_write_and_wait_range(struct file *file,
2725 loff_t start, loff_t end);
2727 static inline int file_write_and_wait(struct file *file)
2729 return file_write_and_wait_range(file, 0, LLONG_MAX);
2733 * filemap_set_wb_err - set a writeback error on an address_space
2734 * @mapping: mapping in which to set writeback error
2735 * @err: error to be set in mapping
2737 * When writeback fails in some way, we must record that error so that
2738 * userspace can be informed when fsync and the like are called. We endeavor
2739 * to report errors on any file that was open at the time of the error. Some
2740 * internal callers also need to know when writeback errors have occurred.
2742 * When a writeback error occurs, most filesystems will want to call
2743 * filemap_set_wb_err to record the error in the mapping so that it will be
2744 * automatically reported whenever fsync is called on the file.
2746 static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2748 /* Fastpath for common case of no error */
2750 __filemap_set_wb_err(mapping, err);
2754 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2755 * @mapping: mapping to check for writeback errors
2756 * @since: previously-sampled errseq_t
2758 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2759 * the given value was sampled.
2761 * If it has then report the latest error set, otherwise return 0.
2763 static inline int filemap_check_wb_err(struct address_space *mapping,
2766 return errseq_check(&mapping->wb_err, since);
2770 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2771 * @mapping: mapping to be sampled
2773 * Writeback errors are always reported relative to a particular sample point
2774 * in the past. This function provides those sample points.
2776 static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2778 return errseq_sample(&mapping->wb_err);
2781 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2783 extern int vfs_fsync(struct file *file, int datasync);
2786 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2787 * to already be updated for the write, and will return either the amount
2788 * of bytes passed in, or an error if syncing the file failed.
2790 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2792 if (iocb->ki_flags & IOCB_DSYNC) {
2793 int ret = vfs_fsync_range(iocb->ki_filp,
2794 iocb->ki_pos - count, iocb->ki_pos - 1,
2795 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2803 extern void emergency_sync(void);
2804 extern void emergency_remount(void);
2806 extern sector_t bmap(struct inode *, sector_t);
2808 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2809 extern int inode_permission(struct inode *, int);
2810 extern int generic_permission(struct inode *, int);
2811 extern int __check_sticky(struct inode *dir, struct inode *inode);
2813 static inline bool execute_ok(struct inode *inode)
2815 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2818 static inline void file_start_write(struct file *file)
2820 if (!S_ISREG(file_inode(file)->i_mode))
2822 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2825 static inline bool file_start_write_trylock(struct file *file)
2827 if (!S_ISREG(file_inode(file)->i_mode))
2829 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2832 static inline void file_end_write(struct file *file)
2834 if (!S_ISREG(file_inode(file)->i_mode))
2836 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2840 * get_write_access() gets write permission for a file.
2841 * put_write_access() releases this write permission.
2842 * This is used for regular files.
2843 * We cannot support write (and maybe mmap read-write shared) accesses and
2844 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2845 * can have the following values:
2846 * 0: no writers, no VM_DENYWRITE mappings
2847 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2848 * > 0: (i_writecount) users are writing to the file.
2850 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2851 * except for the cases where we don't hold i_writecount yet. Then we need to
2852 * use {get,deny}_write_access() - these functions check the sign and refuse
2853 * to do the change if sign is wrong.
2855 static inline int get_write_access(struct inode *inode)
2857 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2859 static inline int deny_write_access(struct file *file)
2861 struct inode *inode = file_inode(file);
2862 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2864 static inline void put_write_access(struct inode * inode)
2866 atomic_dec(&inode->i_writecount);
2868 static inline void allow_write_access(struct file *file)
2871 atomic_inc(&file_inode(file)->i_writecount);
2873 static inline bool inode_is_open_for_write(const struct inode *inode)
2875 return atomic_read(&inode->i_writecount) > 0;
2879 static inline void i_readcount_dec(struct inode *inode)
2881 BUG_ON(!atomic_read(&inode->i_readcount));
2882 atomic_dec(&inode->i_readcount);
2884 static inline void i_readcount_inc(struct inode *inode)
2886 atomic_inc(&inode->i_readcount);
2889 static inline void i_readcount_dec(struct inode *inode)
2893 static inline void i_readcount_inc(struct inode *inode)
2898 extern int do_pipe_flags(int *, int);
2900 #define __kernel_read_file_id(id) \
2901 id(UNKNOWN, unknown) \
2902 id(FIRMWARE, firmware) \
2903 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
2904 id(MODULE, kernel-module) \
2905 id(KEXEC_IMAGE, kexec-image) \
2906 id(KEXEC_INITRAMFS, kexec-initramfs) \
2907 id(POLICY, security-policy) \
2908 id(X509_CERTIFICATE, x509-certificate) \
2911 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2912 #define __fid_stringify(dummy, str) #str,
2914 enum kernel_read_file_id {
2915 __kernel_read_file_id(__fid_enumify)
2918 static const char * const kernel_read_file_str[] = {
2919 __kernel_read_file_id(__fid_stringify)
2922 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2924 if ((unsigned)id >= READING_MAX_ID)
2925 return kernel_read_file_str[READING_UNKNOWN];
2927 return kernel_read_file_str[id];
2930 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2931 enum kernel_read_file_id);
2932 extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2933 enum kernel_read_file_id);
2934 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2935 enum kernel_read_file_id);
2936 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2937 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2938 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
2939 extern struct file * open_exec(const char *);
2941 /* fs/dcache.c -- generic fs support functions */
2942 extern bool is_subdir(struct dentry *, struct dentry *);
2943 extern bool path_is_under(const struct path *, const struct path *);
2945 extern char *file_path(struct file *, char *, int);
2947 #include <linux/err.h>
2949 /* needed for stackable file system support */
2950 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2952 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2954 extern int inode_init_always(struct super_block *, struct inode *);
2955 extern void inode_init_once(struct inode *);
2956 extern void address_space_init_once(struct address_space *mapping);
2957 extern struct inode * igrab(struct inode *);
2958 extern ino_t iunique(struct super_block *, ino_t);
2959 extern int inode_needs_sync(struct inode *inode);
2960 extern int generic_delete_inode(struct inode *inode);
2961 static inline int generic_drop_inode(struct inode *inode)
2963 return !inode->i_nlink || inode_unhashed(inode);
2966 extern struct inode *ilookup5_nowait(struct super_block *sb,
2967 unsigned long hashval, int (*test)(struct inode *, void *),
2969 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2970 int (*test)(struct inode *, void *), void *data);
2971 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2973 extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2974 int (*test)(struct inode *, void *),
2975 int (*set)(struct inode *, void *),
2977 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2978 extern struct inode * iget_locked(struct super_block *, unsigned long);
2979 extern struct inode *find_inode_nowait(struct super_block *,
2981 int (*match)(struct inode *,
2982 unsigned long, void *),
2984 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2985 extern int insert_inode_locked(struct inode *);
2986 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2987 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2989 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2991 extern void unlock_new_inode(struct inode *);
2992 extern void discard_new_inode(struct inode *);
2993 extern unsigned int get_next_ino(void);
2994 extern void evict_inodes(struct super_block *sb);
2996 extern void __iget(struct inode * inode);
2997 extern void iget_failed(struct inode *);
2998 extern void clear_inode(struct inode *);
2999 extern void __destroy_inode(struct inode *);
3000 extern struct inode *new_inode_pseudo(struct super_block *sb);
3001 extern struct inode *new_inode(struct super_block *sb);
3002 extern void free_inode_nonrcu(struct inode *inode);
3003 extern int should_remove_suid(struct dentry *);
3004 extern int file_remove_privs(struct file *);
3006 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
3007 static inline void insert_inode_hash(struct inode *inode)
3009 __insert_inode_hash(inode, inode->i_ino);
3012 extern void __remove_inode_hash(struct inode *);
3013 static inline void remove_inode_hash(struct inode *inode)
3015 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
3016 __remove_inode_hash(inode);
3019 extern void inode_sb_list_add(struct inode *inode);
3022 extern int bdev_read_only(struct block_device *);
3024 extern int set_blocksize(struct block_device *, int);
3025 extern int sb_set_blocksize(struct super_block *, int);
3026 extern int sb_min_blocksize(struct super_block *, int);
3028 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
3029 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3030 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
3031 extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
3032 struct file *file_out, loff_t pos_out,
3033 loff_t *count, unsigned int remap_flags);
3034 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
3035 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
3036 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
3037 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3038 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
3040 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
3042 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
3045 /* fs/block_dev.c */
3046 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
3047 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
3048 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3050 extern void block_sync_page(struct page *page);
3053 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
3054 struct pipe_inode_info *, size_t, unsigned int);
3055 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3056 struct file *, loff_t *, size_t, unsigned int);
3057 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
3058 struct file *out, loff_t *, size_t len, unsigned int flags);
3059 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3060 loff_t *opos, size_t len, unsigned int flags);
3064 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3065 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3066 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
3067 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3068 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
3069 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3070 int whence, loff_t maxsize, loff_t eof);
3071 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3072 int whence, loff_t size);
3073 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3074 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
3075 extern int generic_file_open(struct inode * inode, struct file * filp);
3076 extern int nonseekable_open(struct inode * inode, struct file * filp);
3079 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3080 loff_t file_offset);
3083 /* need locking between buffered and direct access */
3086 /* filesystem does not support filling holes */
3087 DIO_SKIP_HOLES = 0x02,
3090 void dio_end_io(struct bio *bio);
3091 void dio_warn_stale_pagecache(struct file *filp);
3093 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3094 struct block_device *bdev, struct iov_iter *iter,
3095 get_block_t get_block,
3096 dio_iodone_t end_io, dio_submit_t submit_io,
3099 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3100 struct inode *inode,
3101 struct iov_iter *iter,
3102 get_block_t get_block)
3104 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3105 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
3109 void inode_dio_wait(struct inode *inode);
3112 * inode_dio_begin - signal start of a direct I/O requests
3113 * @inode: inode the direct I/O happens on
3115 * This is called once we've finished processing a direct I/O request,
3116 * and is used to wake up callers waiting for direct I/O to be quiesced.
3118 static inline void inode_dio_begin(struct inode *inode)
3120 atomic_inc(&inode->i_dio_count);
3124 * inode_dio_end - signal finish of a direct I/O requests
3125 * @inode: inode the direct I/O happens on
3127 * This is called once we've finished processing a direct I/O request,
3128 * and is used to wake up callers waiting for direct I/O to be quiesced.
3130 static inline void inode_dio_end(struct inode *inode)
3132 if (atomic_dec_and_test(&inode->i_dio_count))
3133 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3136 extern void inode_set_flags(struct inode *inode, unsigned int flags,
3139 extern const struct file_operations generic_ro_fops;
3141 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3143 extern int readlink_copy(char __user *, int, const char *);
3144 extern int page_readlink(struct dentry *, char __user *, int);
3145 extern const char *page_get_link(struct dentry *, struct inode *,
3146 struct delayed_call *);
3147 extern void page_put_link(void *);
3148 extern int __page_symlink(struct inode *inode, const char *symname, int len,
3150 extern int page_symlink(struct inode *inode, const char *symname, int len);
3151 extern const struct inode_operations page_symlink_inode_operations;
3152 extern void kfree_link(void *);
3153 extern void generic_fillattr(struct inode *, struct kstat *);
3154 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3155 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3156 void __inode_add_bytes(struct inode *inode, loff_t bytes);
3157 void inode_add_bytes(struct inode *inode, loff_t bytes);
3158 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
3159 void inode_sub_bytes(struct inode *inode, loff_t bytes);
3160 static inline loff_t __inode_get_bytes(struct inode *inode)
3162 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3164 loff_t inode_get_bytes(struct inode *inode);
3165 void inode_set_bytes(struct inode *inode, loff_t bytes);
3166 const char *simple_get_link(struct dentry *, struct inode *,
3167 struct delayed_call *);
3168 extern const struct inode_operations simple_symlink_inode_operations;
3170 extern int iterate_dir(struct file *, struct dir_context *);
3172 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3173 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3175 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3177 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3178 stat, STATX_BASIC_STATS);
3180 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3182 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3183 stat, STATX_BASIC_STATS);
3185 static inline int vfs_fstatat(int dfd, const char __user *filename,
3186 struct kstat *stat, int flags)
3188 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3189 stat, STATX_BASIC_STATS);
3191 static inline int vfs_fstat(int fd, struct kstat *stat)
3193 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3197 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3198 extern int vfs_readlink(struct dentry *, char __user *, int);
3200 extern int __generic_block_fiemap(struct inode *inode,
3201 struct fiemap_extent_info *fieinfo,
3202 loff_t start, loff_t len,
3203 get_block_t *get_block);
3204 extern int generic_block_fiemap(struct inode *inode,
3205 struct fiemap_extent_info *fieinfo, u64 start,
3206 u64 len, get_block_t *get_block);
3208 extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3209 extern void put_filesystem(struct file_system_type *fs);
3210 extern struct file_system_type *get_fs_type(const char *name);
3211 extern struct super_block *get_super(struct block_device *);
3212 extern struct super_block *get_super_thawed(struct block_device *);
3213 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3214 extern struct super_block *get_active_super(struct block_device *bdev);
3215 extern void drop_super(struct super_block *sb);
3216 extern void drop_super_exclusive(struct super_block *sb);
3217 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
3218 extern void iterate_supers_type(struct file_system_type *,
3219 void (*)(struct super_block *, void *), void *);
3221 extern int dcache_dir_open(struct inode *, struct file *);
3222 extern int dcache_dir_close(struct inode *, struct file *);
3223 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3224 extern int dcache_readdir(struct file *, struct dir_context *);
3225 extern int simple_setattr(struct dentry *, struct iattr *);
3226 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3227 extern int simple_statfs(struct dentry *, struct kstatfs *);
3228 extern int simple_open(struct inode *inode, struct file *file);
3229 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3230 extern int simple_unlink(struct inode *, struct dentry *);
3231 extern int simple_rmdir(struct inode *, struct dentry *);
3232 extern int simple_rename(struct inode *, struct dentry *,
3233 struct inode *, struct dentry *, unsigned int);
3234 extern int noop_fsync(struct file *, loff_t, loff_t, int);
3235 extern int noop_set_page_dirty(struct page *page);
3236 extern void noop_invalidatepage(struct page *page, unsigned int offset,
3237 unsigned int length);
3238 extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
3239 extern int simple_empty(struct dentry *);
3240 extern int simple_readpage(struct file *file, struct page *page);
3241 extern int simple_write_begin(struct file *file, struct address_space *mapping,
3242 loff_t pos, unsigned len, unsigned flags,
3243 struct page **pagep, void **fsdata);
3244 extern int simple_write_end(struct file *file, struct address_space *mapping,
3245 loff_t pos, unsigned len, unsigned copied,
3246 struct page *page, void *fsdata);
3247 extern int always_delete_dentry(const struct dentry *);
3248 extern struct inode *alloc_anon_inode(struct super_block *);
3249 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3250 extern const struct dentry_operations simple_dentry_operations;
3252 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
3253 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3254 extern const struct file_operations simple_dir_operations;
3255 extern const struct inode_operations simple_dir_inode_operations;
3256 extern void make_empty_dir_inode(struct inode *inode);
3257 extern bool is_empty_dir_inode(struct inode *inode);
3258 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3259 struct dentry *d_alloc_name(struct dentry *, const char *);
3260 extern int simple_fill_super(struct super_block *, unsigned long,
3261 const struct tree_descr *);
3262 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3263 extern void simple_release_fs(struct vfsmount **mount, int *count);
3265 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3266 loff_t *ppos, const void *from, size_t available);
3267 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3268 const void __user *from, size_t count);
3270 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3271 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3273 extern int generic_check_addressable(unsigned, u64);
3275 #ifdef CONFIG_MIGRATION
3276 extern int buffer_migrate_page(struct address_space *,
3277 struct page *, struct page *,
3279 extern int buffer_migrate_page_norefs(struct address_space *,
3280 struct page *, struct page *,
3283 #define buffer_migrate_page NULL
3284 #define buffer_migrate_page_norefs NULL
3287 extern int setattr_prepare(struct dentry *, struct iattr *);
3288 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3289 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3291 extern int file_update_time(struct file *file);
3293 static inline bool io_is_direct(struct file *filp)
3295 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
3298 static inline bool vma_is_dax(struct vm_area_struct *vma)
3300 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3303 static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3305 struct inode *inode;
3309 if (!vma_is_dax(vma))
3311 inode = file_inode(vma->vm_file);
3312 if (S_ISCHR(inode->i_mode))
3313 return false; /* device-dax */
3317 static inline int iocb_flags(struct file *file)
3320 if (file->f_flags & O_APPEND)
3322 if (io_is_direct(file))
3324 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3326 if (file->f_flags & __O_SYNC)
3331 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3333 if (unlikely(flags & ~RWF_SUPPORTED))
3336 if (flags & RWF_NOWAIT) {
3337 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3339 ki->ki_flags |= IOCB_NOWAIT;
3341 if (flags & RWF_HIPRI)
3342 ki->ki_flags |= IOCB_HIPRI;
3343 if (flags & RWF_DSYNC)
3344 ki->ki_flags |= IOCB_DSYNC;
3345 if (flags & RWF_SYNC)
3346 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
3347 if (flags & RWF_APPEND)
3348 ki->ki_flags |= IOCB_APPEND;
3352 static inline ino_t parent_ino(struct dentry *dentry)
3357 * Don't strictly need d_lock here? If the parent ino could change
3358 * then surely we'd have a deeper race in the caller?
3360 spin_lock(&dentry->d_lock);
3361 res = dentry->d_parent->d_inode->i_ino;
3362 spin_unlock(&dentry->d_lock);
3366 /* Transaction based IO helpers */
3369 * An argresp is stored in an allocated page and holds the
3370 * size of the argument or response, along with its content
3372 struct simple_transaction_argresp {
3377 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3379 char *simple_transaction_get(struct file *file, const char __user *buf,
3381 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3382 size_t size, loff_t *pos);
3383 int simple_transaction_release(struct inode *inode, struct file *file);
3385 void simple_transaction_set(struct file *file, size_t n);
3388 * simple attribute files
3390 * These attributes behave similar to those in sysfs:
3392 * Writing to an attribute immediately sets a value, an open file can be
3393 * written to multiple times.
3395 * Reading from an attribute creates a buffer from the value that might get
3396 * read with multiple read calls. When the attribute has been read
3397 * completely, no further read calls are possible until the file is opened
3400 * All attributes contain a text representation of a numeric value
3401 * that are accessed with the get() and set() functions.
3403 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3404 static int __fops ## _open(struct inode *inode, struct file *file) \
3406 __simple_attr_check_format(__fmt, 0ull); \
3407 return simple_attr_open(inode, file, __get, __set, __fmt); \
3409 static const struct file_operations __fops = { \
3410 .owner = THIS_MODULE, \
3411 .open = __fops ## _open, \
3412 .release = simple_attr_release, \
3413 .read = simple_attr_read, \
3414 .write = simple_attr_write, \
3415 .llseek = generic_file_llseek, \
3418 static inline __printf(1, 2)
3419 void __simple_attr_check_format(const char *fmt, ...)
3421 /* don't do anything, just let the compiler check the arguments; */
3424 int simple_attr_open(struct inode *inode, struct file *file,
3425 int (*get)(void *, u64 *), int (*set)(void *, u64),
3427 int simple_attr_release(struct inode *inode, struct file *file);
3428 ssize_t simple_attr_read(struct file *file, char __user *buf,
3429 size_t len, loff_t *ppos);
3430 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3431 size_t len, loff_t *ppos);
3434 int proc_nr_files(struct ctl_table *table, int write,
3435 void __user *buffer, size_t *lenp, loff_t *ppos);
3436 int proc_nr_dentry(struct ctl_table *table, int write,
3437 void __user *buffer, size_t *lenp, loff_t *ppos);
3438 int proc_nr_inodes(struct ctl_table *table, int write,
3439 void __user *buffer, size_t *lenp, loff_t *ppos);
3440 int __init get_filesystem_list(char *buf);
3442 #define __FMODE_EXEC ((__force int) FMODE_EXEC)
3443 #define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3445 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3446 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3447 (flag & __FMODE_NONOTIFY)))
3449 static inline bool is_sxid(umode_t mode)
3451 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3454 static inline int check_sticky(struct inode *dir, struct inode *inode)
3456 if (!(dir->i_mode & S_ISVTX))
3459 return __check_sticky(dir, inode);
3462 static inline void inode_has_no_xattr(struct inode *inode)
3464 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3465 inode->i_flags |= S_NOSEC;
3468 static inline bool is_root_inode(struct inode *inode)
3470 return inode == inode->i_sb->s_root->d_inode;
3473 static inline bool dir_emit(struct dir_context *ctx,
3474 const char *name, int namelen,
3475 u64 ino, unsigned type)
3477 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3479 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3481 return ctx->actor(ctx, ".", 1, ctx->pos,
3482 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3484 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3486 return ctx->actor(ctx, "..", 2, ctx->pos,
3487 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3489 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3491 if (ctx->pos == 0) {
3492 if (!dir_emit_dot(file, ctx))
3496 if (ctx->pos == 1) {
3497 if (!dir_emit_dotdot(file, ctx))
3503 static inline bool dir_relax(struct inode *inode)
3505 inode_unlock(inode);
3507 return !IS_DEADDIR(inode);
3510 static inline bool dir_relax_shared(struct inode *inode)
3512 inode_unlock_shared(inode);
3513 inode_lock_shared(inode);
3514 return !IS_DEADDIR(inode);
3517 extern bool path_noexec(const struct path *path);
3518 extern void inode_nohighmem(struct inode *inode);
3521 extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3524 #if defined(CONFIG_IO_URING)
3525 extern struct sock *io_uring_get_socket(struct file *file);
3527 static inline struct sock *io_uring_get_socket(struct file *file)
3533 #endif /* _LINUX_FS_H */