4 #include <linux/linkage.h>
5 #include <linux/wait.h>
6 #include <linux/kdev_t.h>
7 #include <linux/dcache.h>
8 #include <linux/path.h>
9 #include <linux/stat.h>
10 #include <linux/cache.h>
11 #include <linux/list.h>
12 #include <linux/list_lru.h>
13 #include <linux/llist.h>
14 #include <linux/radix-tree.h>
15 #include <linux/rbtree.h>
16 #include <linux/init.h>
17 #include <linux/pid.h>
18 #include <linux/bug.h>
19 #include <linux/mutex.h>
20 #include <linux/rwsem.h>
21 #include <linux/capability.h>
22 #include <linux/semaphore.h>
23 #include <linux/fiemap.h>
24 #include <linux/rculist_bl.h>
25 #include <linux/atomic.h>
26 #include <linux/shrinker.h>
27 #include <linux/migrate_mode.h>
28 #include <linux/uidgid.h>
29 #include <linux/lockdep.h>
30 #include <linux/percpu-rwsem.h>
31 #include <linux/workqueue.h>
32 #include <linux/delayed_call.h>
34 #include <asm/byteorder.h>
35 #include <uapi/linux/fs.h>
37 struct backing_dev_info;
40 struct export_operations;
45 struct pipe_inode_info;
46 struct poll_table_struct;
48 struct vm_area_struct;
51 struct swap_info_struct;
53 struct workqueue_struct;
56 struct fscrypt_operations;
58 extern void __init inode_init(void);
59 extern void __init inode_init_early(void);
60 extern void __init files_init(void);
61 extern void __init files_maxfiles_init(void);
63 extern struct files_stat_struct files_stat;
64 extern unsigned long get_max_files(void);
65 extern unsigned int sysctl_nr_open;
66 extern struct inodes_stat_t inodes_stat;
67 extern int leases_enable, lease_break_time;
68 extern int sysctl_protected_symlinks;
69 extern int sysctl_protected_hardlinks;
72 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
73 struct buffer_head *bh_result, int create);
74 typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
75 ssize_t bytes, void *private);
77 #define MAY_EXEC 0x00000001
78 #define MAY_WRITE 0x00000002
79 #define MAY_READ 0x00000004
80 #define MAY_APPEND 0x00000008
81 #define MAY_ACCESS 0x00000010
82 #define MAY_OPEN 0x00000020
83 #define MAY_CHDIR 0x00000040
84 /* called from RCU mode, don't block */
85 #define MAY_NOT_BLOCK 0x00000080
88 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
89 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
92 /* file is open for reading */
93 #define FMODE_READ ((__force fmode_t)0x1)
94 /* file is open for writing */
95 #define FMODE_WRITE ((__force fmode_t)0x2)
96 /* file is seekable */
97 #define FMODE_LSEEK ((__force fmode_t)0x4)
98 /* file can be accessed using pread */
99 #define FMODE_PREAD ((__force fmode_t)0x8)
100 /* file can be accessed using pwrite */
101 #define FMODE_PWRITE ((__force fmode_t)0x10)
102 /* File is opened for execution with sys_execve / sys_uselib */
103 #define FMODE_EXEC ((__force fmode_t)0x20)
104 /* File is opened with O_NDELAY (only set for block devices) */
105 #define FMODE_NDELAY ((__force fmode_t)0x40)
106 /* File is opened with O_EXCL (only set for block devices) */
107 #define FMODE_EXCL ((__force fmode_t)0x80)
108 /* File is opened using open(.., 3, ..) and is writeable only for ioctls
109 (specialy hack for floppy.c) */
110 #define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
111 /* 32bit hashes as llseek() offset (for directories) */
112 #define FMODE_32BITHASH ((__force fmode_t)0x200)
113 /* 64bit hashes as llseek() offset (for directories) */
114 #define FMODE_64BITHASH ((__force fmode_t)0x400)
117 * Don't update ctime and mtime.
119 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
120 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
122 #define FMODE_NOCMTIME ((__force fmode_t)0x800)
124 /* Expect random access pattern */
125 #define FMODE_RANDOM ((__force fmode_t)0x1000)
127 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
128 #define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
130 /* File is opened with O_PATH; almost nothing can be done with it */
131 #define FMODE_PATH ((__force fmode_t)0x4000)
133 /* File needs atomic accesses to f_pos */
134 #define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
135 /* Write access to underlying fs */
136 #define FMODE_WRITER ((__force fmode_t)0x10000)
137 /* Has read method(s) */
138 #define FMODE_CAN_READ ((__force fmode_t)0x20000)
139 /* Has write method(s) */
140 #define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
142 /* File was opened by fanotify and shouldn't generate fanotify events */
143 #define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
146 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
147 * that indicates that they should check the contents of the iovec are
148 * valid, but not check the memory that the iovec elements
151 #define CHECK_IOVEC_ONLY -1
154 * Attribute flags. These should be or-ed together to figure out what
157 #define ATTR_MODE (1 << 0)
158 #define ATTR_UID (1 << 1)
159 #define ATTR_GID (1 << 2)
160 #define ATTR_SIZE (1 << 3)
161 #define ATTR_ATIME (1 << 4)
162 #define ATTR_MTIME (1 << 5)
163 #define ATTR_CTIME (1 << 6)
164 #define ATTR_ATIME_SET (1 << 7)
165 #define ATTR_MTIME_SET (1 << 8)
166 #define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
167 #define ATTR_ATTR_FLAG (1 << 10)
168 #define ATTR_KILL_SUID (1 << 11)
169 #define ATTR_KILL_SGID (1 << 12)
170 #define ATTR_FILE (1 << 13)
171 #define ATTR_KILL_PRIV (1 << 14)
172 #define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
173 #define ATTR_TIMES_SET (1 << 16)
174 #define ATTR_TOUCH (1 << 17)
177 * Whiteout is represented by a char device. The following constants define the
178 * mode and device number to use.
180 #define WHITEOUT_MODE 0
181 #define WHITEOUT_DEV 0
184 * This is the Inode Attributes structure, used for notify_change(). It
185 * uses the above definitions as flags, to know which values have changed.
186 * Also, in this manner, a Filesystem can look at only the values it cares
187 * about. Basically, these are the attributes that the VFS layer can
188 * request to change from the FS layer.
190 * Derek Atkins <warlord@MIT.EDU> 94-10-20
193 unsigned int ia_valid;
198 struct timespec ia_atime;
199 struct timespec ia_mtime;
200 struct timespec ia_ctime;
203 * Not an attribute, but an auxiliary info for filesystems wanting to
204 * implement an ftruncate() like method. NOTE: filesystem should
205 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
207 struct file *ia_file;
211 * Includes for diskquotas.
213 #include <linux/quota.h>
216 * Maximum number of layers of fs stack. Needs to be limited to
217 * prevent kernel stack overflow
219 #define FILESYSTEM_MAX_STACK_DEPTH 2
222 * enum positive_aop_returns - aop return codes with specific semantics
224 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
225 * completed, that the page is still locked, and
226 * should be considered active. The VM uses this hint
227 * to return the page to the active list -- it won't
228 * be a candidate for writeback again in the near
229 * future. Other callers must be careful to unlock
230 * the page if they get this return. Returned by
233 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
234 * unlocked it and the page might have been truncated.
235 * The caller should back up to acquiring a new page and
236 * trying again. The aop will be taking reasonable
237 * precautions not to livelock. If the caller held a page
238 * reference, it should drop it before retrying. Returned
241 * address_space_operation functions return these large constants to indicate
242 * special semantics to the caller. These are much larger than the bytes in a
243 * page to allow for functions that return the number of bytes operated on in a
247 enum positive_aop_returns {
248 AOP_WRITEPAGE_ACTIVATE = 0x80000,
249 AOP_TRUNCATED_PAGE = 0x80001,
252 #define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
253 #define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
254 * helper code (eg buffer layer)
255 * to clear GFP_FS from alloc */
258 * oh the beauties of C type declarations.
261 struct address_space;
262 struct writeback_control;
264 #define IOCB_EVENTFD (1 << 0)
265 #define IOCB_APPEND (1 << 1)
266 #define IOCB_DIRECT (1 << 2)
267 #define IOCB_HIPRI (1 << 3)
268 #define IOCB_DSYNC (1 << 4)
269 #define IOCB_SYNC (1 << 5)
270 #define IOCB_WRITE (1 << 6)
273 struct file *ki_filp;
275 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
280 static inline bool is_sync_kiocb(struct kiocb *kiocb)
282 return kiocb->ki_complete == NULL;
285 static inline int iocb_flags(struct file *file);
287 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
289 *kiocb = (struct kiocb) {
291 .ki_flags = iocb_flags(filp),
296 * "descriptor" for what we're up to with a read.
297 * This allows us to use the same read code yet
298 * have multiple different users of the data that
299 * we read from a file.
301 * The simplest case just copies the data to user
314 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
315 unsigned long, unsigned long);
317 struct address_space_operations {
318 int (*writepage)(struct page *page, struct writeback_control *wbc);
319 int (*readpage)(struct file *, struct page *);
321 /* Write back some dirty pages from this mapping. */
322 int (*writepages)(struct address_space *, struct writeback_control *);
324 /* Set a page dirty. Return true if this dirtied it */
325 int (*set_page_dirty)(struct page *page);
327 int (*readpages)(struct file *filp, struct address_space *mapping,
328 struct list_head *pages, unsigned nr_pages);
330 int (*write_begin)(struct file *, struct address_space *mapping,
331 loff_t pos, unsigned len, unsigned flags,
332 struct page **pagep, void **fsdata);
333 int (*write_end)(struct file *, struct address_space *mapping,
334 loff_t pos, unsigned len, unsigned copied,
335 struct page *page, void *fsdata);
337 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
338 sector_t (*bmap)(struct address_space *, sector_t);
339 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
340 int (*releasepage) (struct page *, gfp_t);
341 void (*freepage)(struct page *);
342 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
344 * migrate the contents of a page to the specified target. If
345 * migrate_mode is MIGRATE_ASYNC, it must not block.
347 int (*migratepage) (struct address_space *,
348 struct page *, struct page *, enum migrate_mode);
349 bool (*isolate_page)(struct page *, isolate_mode_t);
350 void (*putback_page)(struct page *);
351 int (*launder_page) (struct page *);
352 int (*is_partially_uptodate) (struct page *, unsigned long,
354 void (*is_dirty_writeback) (struct page *, bool *, bool *);
355 int (*error_remove_page)(struct address_space *, struct page *);
357 /* swapfile support */
358 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
360 void (*swap_deactivate)(struct file *file);
363 extern const struct address_space_operations empty_aops;
366 * pagecache_write_begin/pagecache_write_end must be used by general code
367 * to write into the pagecache.
369 int pagecache_write_begin(struct file *, struct address_space *mapping,
370 loff_t pos, unsigned len, unsigned flags,
371 struct page **pagep, void **fsdata);
373 int pagecache_write_end(struct file *, struct address_space *mapping,
374 loff_t pos, unsigned len, unsigned copied,
375 struct page *page, void *fsdata);
377 struct address_space {
378 struct inode *host; /* owner: inode, block_device */
379 struct radix_tree_root page_tree; /* radix tree of all pages */
380 spinlock_t tree_lock; /* and lock protecting it */
381 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
382 struct rb_root i_mmap; /* tree of private and shared mappings */
383 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
384 /* Protected by tree_lock together with the radix tree */
385 unsigned long nrpages; /* number of total pages */
386 /* number of shadow or DAX exceptional entries */
387 unsigned long nrexceptional;
388 pgoff_t writeback_index;/* writeback starts here */
389 const struct address_space_operations *a_ops; /* methods */
390 unsigned long flags; /* error bits */
391 spinlock_t private_lock; /* for use by the address_space */
392 gfp_t gfp_mask; /* implicit gfp mask for allocations */
393 struct list_head private_list; /* ditto */
394 void *private_data; /* ditto */
395 } __attribute__((aligned(sizeof(long))));
397 * On most architectures that alignment is already the case; but
398 * must be enforced here for CRIS, to let the least significant bit
399 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
401 struct request_queue;
403 struct block_device {
404 dev_t bd_dev; /* not a kdev_t - it's a search key */
406 struct inode * bd_inode; /* will die */
407 struct super_block * bd_super;
408 struct mutex bd_mutex; /* open/close mutex */
412 bool bd_write_holder;
414 struct list_head bd_holder_disks;
416 struct block_device * bd_contains;
417 unsigned bd_block_size;
418 struct hd_struct * bd_part;
419 /* number of times partitions within this device have been opened. */
420 unsigned bd_part_count;
422 struct gendisk * bd_disk;
423 struct request_queue * bd_queue;
424 struct backing_dev_info *bd_bdi;
425 struct list_head bd_list;
427 * Private data. You must have bd_claim'ed the block_device
428 * to use this. NOTE: bd_claim allows an owner to claim
429 * the same device multiple times, the owner must take special
430 * care to not mess up bd_private for that case.
432 unsigned long bd_private;
434 /* The counter of freeze processes */
435 int bd_fsfreeze_count;
436 /* Mutex for freeze */
437 struct mutex bd_fsfreeze_mutex;
441 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
444 #define PAGECACHE_TAG_DIRTY 0
445 #define PAGECACHE_TAG_WRITEBACK 1
446 #define PAGECACHE_TAG_TOWRITE 2
448 int mapping_tagged(struct address_space *mapping, int tag);
450 static inline void i_mmap_lock_write(struct address_space *mapping)
452 down_write(&mapping->i_mmap_rwsem);
455 static inline void i_mmap_unlock_write(struct address_space *mapping)
457 up_write(&mapping->i_mmap_rwsem);
460 static inline void i_mmap_lock_read(struct address_space *mapping)
462 down_read(&mapping->i_mmap_rwsem);
465 static inline void i_mmap_unlock_read(struct address_space *mapping)
467 up_read(&mapping->i_mmap_rwsem);
471 * Might pages of this file be mapped into userspace?
473 static inline int mapping_mapped(struct address_space *mapping)
475 return !RB_EMPTY_ROOT(&mapping->i_mmap);
479 * Might pages of this file have been modified in userspace?
480 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
481 * marks vma as VM_SHARED if it is shared, and the file was opened for
482 * writing i.e. vma may be mprotected writable even if now readonly.
484 * If i_mmap_writable is negative, no new writable mappings are allowed. You
485 * can only deny writable mappings, if none exists right now.
487 static inline int mapping_writably_mapped(struct address_space *mapping)
489 return atomic_read(&mapping->i_mmap_writable) > 0;
492 static inline int mapping_map_writable(struct address_space *mapping)
494 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
498 static inline void mapping_unmap_writable(struct address_space *mapping)
500 atomic_dec(&mapping->i_mmap_writable);
503 static inline int mapping_deny_writable(struct address_space *mapping)
505 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
509 static inline void mapping_allow_writable(struct address_space *mapping)
511 atomic_inc(&mapping->i_mmap_writable);
515 * Use sequence counter to get consistent i_size on 32-bit processors.
517 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
518 #include <linux/seqlock.h>
519 #define __NEED_I_SIZE_ORDERED
520 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
522 #define i_size_ordered_init(inode) do { } while (0)
526 #define ACL_NOT_CACHED ((void *)(-1))
527 #define ACL_DONT_CACHE ((void *)(-3))
529 static inline struct posix_acl *
530 uncached_acl_sentinel(struct task_struct *task)
532 return (void *)task + 1;
536 is_uncached_acl(struct posix_acl *acl)
538 return (long)acl & 1;
541 #define IOP_FASTPERM 0x0001
542 #define IOP_LOOKUP 0x0002
543 #define IOP_NOFOLLOW 0x0004
544 #define IOP_XATTR 0x0008
545 #define IOP_DEFAULT_READLINK 0x0010
547 struct fsnotify_mark_connector;
550 * Keep mostly read-only and often accessed (especially for
551 * the RCU path lookup and 'stat' data) fields at the beginning
552 * of the 'struct inode'
556 unsigned short i_opflags;
559 unsigned int i_flags;
561 #ifdef CONFIG_FS_POSIX_ACL
562 struct posix_acl *i_acl;
563 struct posix_acl *i_default_acl;
566 const struct inode_operations *i_op;
567 struct super_block *i_sb;
568 struct address_space *i_mapping;
570 #ifdef CONFIG_SECURITY
574 /* Stat data, not accessed from path walking */
577 * Filesystems may only read i_nlink directly. They shall use the
578 * following functions for modification:
580 * (set|clear|inc|drop)_nlink
581 * inode_(inc|dec)_link_count
584 const unsigned int i_nlink;
585 unsigned int __i_nlink;
589 struct timespec i_atime;
590 struct timespec i_mtime;
591 struct timespec i_ctime;
592 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
593 unsigned short i_bytes;
594 unsigned int i_blkbits;
597 #ifdef __NEED_I_SIZE_ORDERED
598 seqcount_t i_size_seqcount;
602 unsigned long i_state;
603 struct rw_semaphore i_rwsem;
605 unsigned long dirtied_when; /* jiffies of first dirtying */
606 unsigned long dirtied_time_when;
608 struct hlist_node i_hash;
609 struct list_head i_io_list; /* backing dev IO list */
610 #ifdef CONFIG_CGROUP_WRITEBACK
611 struct bdi_writeback *i_wb; /* the associated cgroup wb */
613 /* foreign inode detection, see wbc_detach_inode() */
615 u16 i_wb_frn_avg_time;
616 u16 i_wb_frn_history;
618 struct list_head i_lru; /* inode LRU list */
619 struct list_head i_sb_list;
620 struct list_head i_wb_list; /* backing dev writeback list */
622 struct hlist_head i_dentry;
623 struct rcu_head i_rcu;
627 atomic_t i_dio_count;
628 atomic_t i_writecount;
630 atomic_t i_readcount; /* struct files open RO */
632 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
633 struct file_lock_context *i_flctx;
634 struct address_space i_data;
635 struct list_head i_devices;
637 struct pipe_inode_info *i_pipe;
638 struct block_device *i_bdev;
646 #ifdef CONFIG_FSNOTIFY
647 __u32 i_fsnotify_mask; /* all events this inode cares about */
648 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
651 #if IS_ENABLED(CONFIG_FS_ENCRYPTION)
652 struct fscrypt_info *i_crypt_info;
655 void *i_private; /* fs or device private pointer */
658 static inline unsigned int i_blocksize(const struct inode *node)
660 return (1 << node->i_blkbits);
663 static inline int inode_unhashed(struct inode *inode)
665 return hlist_unhashed(&inode->i_hash);
669 * inode->i_mutex nesting subclasses for the lock validator:
671 * 0: the object of the current VFS operation
675 * 4: second non-directory
676 * 5: second parent (when locking independent directories in rename)
678 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
679 * non-directories at once.
681 * The locking order between these classes is
682 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
684 enum inode_i_mutex_lock_class
694 static inline void inode_lock(struct inode *inode)
696 down_write(&inode->i_rwsem);
699 static inline void inode_unlock(struct inode *inode)
701 up_write(&inode->i_rwsem);
704 static inline void inode_lock_shared(struct inode *inode)
706 down_read(&inode->i_rwsem);
709 static inline void inode_unlock_shared(struct inode *inode)
711 up_read(&inode->i_rwsem);
714 static inline int inode_trylock(struct inode *inode)
716 return down_write_trylock(&inode->i_rwsem);
719 static inline int inode_trylock_shared(struct inode *inode)
721 return down_read_trylock(&inode->i_rwsem);
724 static inline int inode_is_locked(struct inode *inode)
726 return rwsem_is_locked(&inode->i_rwsem);
729 static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
731 down_write_nested(&inode->i_rwsem, subclass);
734 void lock_two_nondirectories(struct inode *, struct inode*);
735 void unlock_two_nondirectories(struct inode *, struct inode*);
738 * NOTE: in a 32bit arch with a preemptable kernel and
739 * an UP compile the i_size_read/write must be atomic
740 * with respect to the local cpu (unlike with preempt disabled),
741 * but they don't need to be atomic with respect to other cpus like in
742 * true SMP (so they need either to either locally disable irq around
743 * the read or for example on x86 they can be still implemented as a
744 * cmpxchg8b without the need of the lock prefix). For SMP compiles
745 * and 64bit archs it makes no difference if preempt is enabled or not.
747 static inline loff_t i_size_read(const struct inode *inode)
749 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
754 seq = read_seqcount_begin(&inode->i_size_seqcount);
755 i_size = inode->i_size;
756 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
758 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
762 i_size = inode->i_size;
766 return inode->i_size;
771 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
772 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
773 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
775 static inline void i_size_write(struct inode *inode, loff_t i_size)
777 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
779 write_seqcount_begin(&inode->i_size_seqcount);
780 inode->i_size = i_size;
781 write_seqcount_end(&inode->i_size_seqcount);
783 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
785 inode->i_size = i_size;
788 inode->i_size = i_size;
792 static inline unsigned iminor(const struct inode *inode)
794 return MINOR(inode->i_rdev);
797 static inline unsigned imajor(const struct inode *inode)
799 return MAJOR(inode->i_rdev);
802 extern struct block_device *I_BDEV(struct inode *inode);
805 rwlock_t lock; /* protects pid, uid, euid fields */
806 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
807 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
808 kuid_t uid, euid; /* uid/euid of process setting the owner */
809 int signum; /* posix.1b rt signal to be delivered on IO */
813 * Track a single file's readahead state
815 struct file_ra_state {
816 pgoff_t start; /* where readahead started */
817 unsigned int size; /* # of readahead pages */
818 unsigned int async_size; /* do asynchronous readahead when
819 there are only # of pages ahead */
821 unsigned int ra_pages; /* Maximum readahead window */
822 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
823 loff_t prev_pos; /* Cache last read() position */
827 * Check if @index falls in the readahead windows.
829 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
831 return (index >= ra->start &&
832 index < ra->start + ra->size);
837 struct llist_node fu_llist;
838 struct rcu_head fu_rcuhead;
841 struct inode *f_inode; /* cached value */
842 const struct file_operations *f_op;
845 * Protects f_ep_links, f_flags.
846 * Must not be taken from IRQ context.
849 atomic_long_t f_count;
850 unsigned int f_flags;
852 struct mutex f_pos_lock;
854 struct fown_struct f_owner;
855 const struct cred *f_cred;
856 struct file_ra_state f_ra;
859 #ifdef CONFIG_SECURITY
862 /* needed for tty driver, and maybe others */
866 /* Used by fs/eventpoll.c to link all the hooks to this file */
867 struct list_head f_ep_links;
868 struct list_head f_tfile_llink;
869 #endif /* #ifdef CONFIG_EPOLL */
870 struct address_space *f_mapping;
871 } __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
876 /* file identifier */
877 unsigned char f_handle[0];
880 static inline struct file *get_file(struct file *f)
882 atomic_long_inc(&f->f_count);
885 #define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
886 #define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
887 #define file_count(x) atomic_long_read(&(x)->f_count)
889 #define MAX_NON_LFS ((1UL<<31) - 1)
891 /* Page cache limit. The filesystems should put that into their s_maxbytes
892 limits, otherwise bad things can happen in VM. */
893 #if BITS_PER_LONG==32
894 #define MAX_LFS_FILESIZE (((loff_t)PAGE_SIZE << (BITS_PER_LONG-1))-1)
895 #elif BITS_PER_LONG==64
896 #define MAX_LFS_FILESIZE ((loff_t)0x7fffffffffffffffLL)
901 #define FL_DELEG 4 /* NFSv4 delegation */
902 #define FL_ACCESS 8 /* not trying to lock, just looking */
903 #define FL_EXISTS 16 /* when unlocking, test for existence */
904 #define FL_LEASE 32 /* lease held on this file */
905 #define FL_CLOSE 64 /* unlock on close */
906 #define FL_SLEEP 128 /* A blocking lock */
907 #define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
908 #define FL_UNLOCK_PENDING 512 /* Lease is being broken */
909 #define FL_OFDLCK 1024 /* lock is "owned" by struct file */
910 #define FL_LAYOUT 2048 /* outstanding pNFS layout */
913 * Special return value from posix_lock_file() and vfs_lock_file() for
914 * asynchronous locking.
916 #define FILE_LOCK_DEFERRED 1
918 /* legacy typedef, should eventually be removed */
919 typedef void *fl_owner_t;
923 struct file_lock_operations {
924 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
925 void (*fl_release_private)(struct file_lock *);
928 struct lock_manager_operations {
929 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
930 unsigned long (*lm_owner_key)(struct file_lock *);
931 fl_owner_t (*lm_get_owner)(fl_owner_t);
932 void (*lm_put_owner)(fl_owner_t);
933 void (*lm_notify)(struct file_lock *); /* unblock callback */
934 int (*lm_grant)(struct file_lock *, int);
935 bool (*lm_break)(struct file_lock *);
936 int (*lm_change)(struct file_lock *, int, struct list_head *);
937 void (*lm_setup)(struct file_lock *, void **);
940 struct lock_manager {
941 struct list_head list;
943 * NFSv4 and up also want opens blocked during the grace period;
950 void locks_start_grace(struct net *, struct lock_manager *);
951 void locks_end_grace(struct lock_manager *);
952 int locks_in_grace(struct net *);
953 int opens_in_grace(struct net *);
955 /* that will die - we need it for nfs_lock_info */
956 #include <linux/nfs_fs_i.h>
959 * struct file_lock represents a generic "file lock". It's used to represent
960 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
961 * note that the same struct is used to represent both a request for a lock and
962 * the lock itself, but the same object is never used for both.
964 * FIXME: should we create a separate "struct lock_request" to help distinguish
967 * The varous i_flctx lists are ordered by:
970 * 2) lock range start
973 * Obviously, the last two criteria only matter for POSIX locks.
976 struct file_lock *fl_next; /* singly linked list for this inode */
977 struct list_head fl_list; /* link into file_lock_context */
978 struct hlist_node fl_link; /* node in global lists */
979 struct list_head fl_block; /* circular list of blocked processes */
981 unsigned int fl_flags;
982 unsigned char fl_type;
984 int fl_link_cpu; /* what cpu's list is this on? */
985 struct pid *fl_nspid;
986 wait_queue_head_t fl_wait;
987 struct file *fl_file;
991 struct fasync_struct * fl_fasync; /* for lease break notifications */
992 /* for lease breaks: */
993 unsigned long fl_break_time;
994 unsigned long fl_downgrade_time;
996 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
997 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
999 struct nfs_lock_info nfs_fl;
1000 struct nfs4_lock_info nfs4_fl;
1002 struct list_head link; /* link in AFS vnode's pending_locks list */
1003 int state; /* state of grant or error if -ve */
1008 struct file_lock_context {
1009 spinlock_t flc_lock;
1010 struct list_head flc_flock;
1011 struct list_head flc_posix;
1012 struct list_head flc_lease;
1015 /* The following constant reflects the upper bound of the file/locking space */
1017 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1018 #define OFFSET_MAX INT_LIMIT(loff_t)
1019 #define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1022 #include <linux/fcntl.h>
1024 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1027 * Return the inode to use for locking
1029 * For overlayfs this should be the overlay inode, not the real inode returned
1030 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1033 static inline struct inode *locks_inode(const struct file *f)
1035 return f->f_path.dentry->d_inode;
1038 #ifdef CONFIG_FILE_LOCKING
1039 extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
1040 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1041 struct flock __user *);
1043 #if BITS_PER_LONG == 32
1044 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
1045 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1046 struct flock64 __user *);
1049 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1050 extern int fcntl_getlease(struct file *filp);
1053 void locks_free_lock_context(struct inode *inode);
1054 void locks_free_lock(struct file_lock *fl);
1055 extern void locks_init_lock(struct file_lock *);
1056 extern struct file_lock * locks_alloc_lock(void);
1057 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1058 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1059 extern void locks_remove_posix(struct file *, fl_owner_t);
1060 extern void locks_remove_file(struct file *);
1061 extern void locks_release_private(struct file_lock *);
1062 extern void posix_test_lock(struct file *, struct file_lock *);
1063 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1064 extern int posix_unblock_lock(struct file_lock *);
1065 extern int vfs_test_lock(struct file *, struct file_lock *);
1066 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1067 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1068 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
1069 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1070 extern void lease_get_mtime(struct inode *, struct timespec *time);
1071 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1072 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1073 extern int lease_modify(struct file_lock *, int, struct list_head *);
1074 struct files_struct;
1075 extern void show_fd_locks(struct seq_file *f,
1076 struct file *filp, struct files_struct *files);
1077 #else /* !CONFIG_FILE_LOCKING */
1078 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1079 struct flock __user *user)
1084 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1085 unsigned int cmd, struct flock __user *user)
1090 #if BITS_PER_LONG == 32
1091 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1092 struct flock64 __user *user)
1097 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1098 unsigned int cmd, struct flock64 __user *user)
1103 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1108 static inline int fcntl_getlease(struct file *filp)
1114 locks_free_lock_context(struct inode *inode)
1118 static inline void locks_init_lock(struct file_lock *fl)
1123 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1128 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1133 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1138 static inline void locks_remove_file(struct file *filp)
1143 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1148 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1149 struct file_lock *conflock)
1154 static inline int posix_unblock_lock(struct file_lock *waiter)
1159 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1164 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1165 struct file_lock *fl, struct file_lock *conf)
1170 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1175 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1180 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1185 static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1190 static inline int generic_setlease(struct file *filp, long arg,
1191 struct file_lock **flp, void **priv)
1196 static inline int vfs_setlease(struct file *filp, long arg,
1197 struct file_lock **lease, void **priv)
1202 static inline int lease_modify(struct file_lock *fl, int arg,
1203 struct list_head *dispose)
1208 struct files_struct;
1209 static inline void show_fd_locks(struct seq_file *f,
1210 struct file *filp, struct files_struct *files) {}
1211 #endif /* !CONFIG_FILE_LOCKING */
1213 static inline struct inode *file_inode(const struct file *f)
1218 static inline struct dentry *file_dentry(const struct file *file)
1220 return d_real(file->f_path.dentry, file_inode(file), 0);
1223 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1225 return locks_lock_inode_wait(locks_inode(filp), fl);
1228 struct fasync_struct {
1232 struct fasync_struct *fa_next; /* singly linked list */
1233 struct file *fa_file;
1234 struct rcu_head fa_rcu;
1237 #define FASYNC_MAGIC 0x4601
1239 /* SMP safe fasync helpers: */
1240 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1241 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1242 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1243 extern struct fasync_struct *fasync_alloc(void);
1244 extern void fasync_free(struct fasync_struct *);
1246 /* can be called from interrupts */
1247 extern void kill_fasync(struct fasync_struct **, int, int);
1249 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1250 extern void f_setown(struct file *filp, unsigned long arg, int force);
1251 extern void f_delown(struct file *filp);
1252 extern pid_t f_getown(struct file *filp);
1253 extern int send_sigurg(struct fown_struct *fown);
1261 #define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1262 #define MNT_DETACH 0x00000002 /* Just detach from the tree */
1263 #define MNT_EXPIRE 0x00000004 /* Mark for expiry */
1264 #define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1265 #define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1268 #define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
1269 #define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
1270 #define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
1272 /* sb->s_iflags to limit user namespace mounts */
1273 #define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
1275 /* Possible states of 'frozen' field */
1277 SB_UNFROZEN = 0, /* FS is unfrozen */
1278 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
1279 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1280 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1281 * internal threads if needed) */
1282 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1285 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1288 int frozen; /* Is sb frozen? */
1289 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1290 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
1293 struct super_block {
1294 struct list_head s_list; /* Keep this first */
1295 dev_t s_dev; /* search index; _not_ kdev_t */
1296 unsigned char s_blocksize_bits;
1297 unsigned long s_blocksize;
1298 loff_t s_maxbytes; /* Max file size */
1299 struct file_system_type *s_type;
1300 const struct super_operations *s_op;
1301 const struct dquot_operations *dq_op;
1302 const struct quotactl_ops *s_qcop;
1303 const struct export_operations *s_export_op;
1304 unsigned long s_flags;
1305 unsigned long s_iflags; /* internal SB_I_* flags */
1306 unsigned long s_magic;
1307 struct dentry *s_root;
1308 struct rw_semaphore s_umount;
1311 #ifdef CONFIG_SECURITY
1314 const struct xattr_handler **s_xattr;
1316 const struct fscrypt_operations *s_cop;
1318 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
1319 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1320 struct block_device *s_bdev;
1321 struct backing_dev_info *s_bdi;
1322 struct mtd_info *s_mtd;
1323 struct hlist_node s_instances;
1324 unsigned int s_quota_types; /* Bitmask of supported quota types */
1325 struct quota_info s_dquot; /* Diskquota specific options */
1327 struct sb_writers s_writers;
1329 char s_id[32]; /* Informational name */
1330 u8 s_uuid[16]; /* UUID */
1332 void *s_fs_info; /* Filesystem private info */
1333 unsigned int s_max_links;
1336 /* Granularity of c/m/atime in ns.
1337 Cannot be worse than a second */
1341 * The next field is for VFS *only*. No filesystems have any business
1342 * even looking at it. You had been warned.
1344 struct mutex s_vfs_rename_mutex; /* Kludge */
1347 * Filesystem subtype. If non-empty the filesystem type field
1348 * in /proc/mounts will be "type.subtype"
1353 * Saved mount options for lazy filesystems using
1354 * generic_show_options()
1356 char __rcu *s_options;
1357 const struct dentry_operations *s_d_op; /* default d_op for dentries */
1360 * Saved pool identifier for cleancache (-1 means none)
1362 int cleancache_poolid;
1364 struct shrinker s_shrink; /* per-sb shrinker handle */
1366 /* Number of inodes with nlink == 0 but still referenced */
1367 atomic_long_t s_remove_count;
1369 /* Being remounted read-only */
1370 int s_readonly_remount;
1372 /* AIO completions deferred from interrupt context */
1373 struct workqueue_struct *s_dio_done_wq;
1374 struct hlist_head s_pins;
1377 * Owning user namespace and default context in which to
1378 * interpret filesystem uids, gids, quotas, device nodes,
1379 * xattrs and security labels.
1381 struct user_namespace *s_user_ns;
1384 * Keep the lru lists last in the structure so they always sit on their
1385 * own individual cachelines.
1387 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1388 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
1389 struct rcu_head rcu;
1390 struct work_struct destroy_work;
1392 struct mutex s_sync_lock; /* sync serialisation lock */
1395 * Indicates how deep in a filesystem stack this SB is
1399 /* s_inode_list_lock protects s_inodes */
1400 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1401 struct list_head s_inodes; /* all inodes */
1403 spinlock_t s_inode_wblist_lock;
1404 struct list_head s_inodes_wb; /* writeback inodes */
1407 /* Helper functions so that in most cases filesystems will
1408 * not need to deal directly with kuid_t and kgid_t and can
1409 * instead deal with the raw numeric values that are stored
1410 * in the filesystem.
1412 static inline uid_t i_uid_read(const struct inode *inode)
1414 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1417 static inline gid_t i_gid_read(const struct inode *inode)
1419 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1422 static inline void i_uid_write(struct inode *inode, uid_t uid)
1424 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1427 static inline void i_gid_write(struct inode *inode, gid_t gid)
1429 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1432 extern struct timespec current_fs_time(struct super_block *sb);
1433 extern struct timespec current_time(struct inode *inode);
1436 * Snapshotting support.
1439 void __sb_end_write(struct super_block *sb, int level);
1440 int __sb_start_write(struct super_block *sb, int level, bool wait);
1442 #define __sb_writers_acquired(sb, lev) \
1443 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1444 #define __sb_writers_release(sb, lev) \
1445 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1448 * sb_end_write - drop write access to a superblock
1449 * @sb: the super we wrote to
1451 * Decrement number of writers to the filesystem. Wake up possible waiters
1452 * wanting to freeze the filesystem.
1454 static inline void sb_end_write(struct super_block *sb)
1456 __sb_end_write(sb, SB_FREEZE_WRITE);
1460 * sb_end_pagefault - drop write access to a superblock from a page fault
1461 * @sb: the super we wrote to
1463 * Decrement number of processes handling write page fault to the filesystem.
1464 * Wake up possible waiters wanting to freeze the filesystem.
1466 static inline void sb_end_pagefault(struct super_block *sb)
1468 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1472 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1473 * @sb: the super we wrote to
1475 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1476 * waiters wanting to freeze the filesystem.
1478 static inline void sb_end_intwrite(struct super_block *sb)
1480 __sb_end_write(sb, SB_FREEZE_FS);
1484 * sb_start_write - get write access to a superblock
1485 * @sb: the super we write to
1487 * When a process wants to write data or metadata to a file system (i.e. dirty
1488 * a page or an inode), it should embed the operation in a sb_start_write() -
1489 * sb_end_write() pair to get exclusion against file system freezing. This
1490 * function increments number of writers preventing freezing. If the file
1491 * system is already frozen, the function waits until the file system is
1494 * Since freeze protection behaves as a lock, users have to preserve
1495 * ordering of freeze protection and other filesystem locks. Generally,
1496 * freeze protection should be the outermost lock. In particular, we have:
1499 * -> i_mutex (write path, truncate, directory ops, ...)
1500 * -> s_umount (freeze_super, thaw_super)
1502 static inline void sb_start_write(struct super_block *sb)
1504 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1507 static inline int sb_start_write_trylock(struct super_block *sb)
1509 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1513 * sb_start_pagefault - get write access to a superblock from a page fault
1514 * @sb: the super we write to
1516 * When a process starts handling write page fault, it should embed the
1517 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1518 * exclusion against file system freezing. This is needed since the page fault
1519 * is going to dirty a page. This function increments number of running page
1520 * faults preventing freezing. If the file system is already frozen, the
1521 * function waits until the file system is thawed.
1523 * Since page fault freeze protection behaves as a lock, users have to preserve
1524 * ordering of freeze protection and other filesystem locks. It is advised to
1525 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1526 * handling code implies lock dependency:
1529 * -> sb_start_pagefault
1531 static inline void sb_start_pagefault(struct super_block *sb)
1533 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1537 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1538 * @sb: the super we write to
1540 * This is the third level of protection against filesystem freezing. It is
1541 * free for use by a filesystem. The only requirement is that it must rank
1542 * below sb_start_pagefault.
1544 * For example filesystem can call sb_start_intwrite() when starting a
1545 * transaction which somewhat eases handling of freezing for internal sources
1546 * of filesystem changes (internal fs threads, discarding preallocation on file
1549 static inline void sb_start_intwrite(struct super_block *sb)
1551 __sb_start_write(sb, SB_FREEZE_FS, true);
1555 extern bool inode_owner_or_capable(const struct inode *inode);
1558 * VFS helper functions..
1560 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1561 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1562 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1563 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1564 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1565 extern int vfs_rmdir(struct inode *, struct dentry *);
1566 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1567 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1568 extern int vfs_whiteout(struct inode *, struct dentry *);
1570 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1574 * VFS file helper functions.
1576 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1578 extern bool may_open_dev(const struct path *path);
1580 * VFS FS_IOC_FIEMAP helper definitions.
1582 struct fiemap_extent_info {
1583 unsigned int fi_flags; /* Flags as passed from user */
1584 unsigned int fi_extents_mapped; /* Number of mapped extents */
1585 unsigned int fi_extents_max; /* Size of fiemap_extent array */
1586 struct fiemap_extent __user *fi_extents_start; /* Start of
1587 fiemap_extent array */
1589 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1590 u64 phys, u64 len, u32 flags);
1591 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1596 * NOTE! These match bits 12..15 of stat.st_mode
1597 * (ie "(i_mode >> 12) & 15").
1599 #define DT_UNKNOWN 0
1610 * This is the "filldir" function type, used by readdir() to let
1611 * the kernel specify what kind of dirent layout it wants to have.
1612 * This allows the kernel to read directories into kernel space or
1613 * to have different dirent layouts depending on the binary type.
1616 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1619 struct dir_context {
1620 const filldir_t actor;
1624 struct block_device_operations;
1626 /* These macros are for out of kernel modules to test that
1627 * the kernel supports the unlocked_ioctl and compat_ioctl
1628 * fields in struct file_operations. */
1629 #define HAVE_COMPAT_IOCTL 1
1630 #define HAVE_UNLOCKED_IOCTL 1
1633 * These flags let !MMU mmap() govern direct device mapping vs immediate
1634 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1636 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1637 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1638 * NOMMU_MAP_READ: Can be mapped for reading
1639 * NOMMU_MAP_WRITE: Can be mapped for writing
1640 * NOMMU_MAP_EXEC: Can be mapped for execution
1642 #define NOMMU_MAP_COPY 0x00000001
1643 #define NOMMU_MAP_DIRECT 0x00000008
1644 #define NOMMU_MAP_READ VM_MAYREAD
1645 #define NOMMU_MAP_WRITE VM_MAYWRITE
1646 #define NOMMU_MAP_EXEC VM_MAYEXEC
1648 #define NOMMU_VMFLAGS \
1649 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1654 struct file_operations {
1655 struct module *owner;
1656 loff_t (*llseek) (struct file *, loff_t, int);
1657 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1658 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1659 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1660 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1661 int (*iterate) (struct file *, struct dir_context *);
1662 int (*iterate_shared) (struct file *, struct dir_context *);
1663 unsigned int (*poll) (struct file *, struct poll_table_struct *);
1664 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1665 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1666 int (*mmap) (struct file *, struct vm_area_struct *);
1667 int (*open) (struct inode *, struct file *);
1668 int (*flush) (struct file *, fl_owner_t id);
1669 int (*release) (struct inode *, struct file *);
1670 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1671 int (*fasync) (int, struct file *, int);
1672 int (*lock) (struct file *, int, struct file_lock *);
1673 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1674 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1675 int (*check_flags)(int);
1676 int (*flock) (struct file *, int, struct file_lock *);
1677 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1678 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1679 int (*setlease)(struct file *, long, struct file_lock **, void **);
1680 long (*fallocate)(struct file *file, int mode, loff_t offset,
1682 void (*show_fdinfo)(struct seq_file *m, struct file *f);
1684 unsigned (*mmap_capabilities)(struct file *);
1686 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1687 loff_t, size_t, unsigned int);
1688 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1690 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1694 struct inode_operations {
1695 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1696 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1697 int (*permission) (struct inode *, int);
1698 struct posix_acl * (*get_acl)(struct inode *, int);
1700 int (*readlink) (struct dentry *, char __user *,int);
1702 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1703 int (*link) (struct dentry *,struct inode *,struct dentry *);
1704 int (*unlink) (struct inode *,struct dentry *);
1705 int (*symlink) (struct inode *,struct dentry *,const char *);
1706 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1707 int (*rmdir) (struct inode *,struct dentry *);
1708 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1709 int (*rename) (struct inode *, struct dentry *,
1710 struct inode *, struct dentry *, unsigned int);
1711 int (*setattr) (struct dentry *, struct iattr *);
1712 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1713 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1714 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1716 int (*update_time)(struct inode *, struct timespec *, int);
1717 int (*atomic_open)(struct inode *, struct dentry *,
1718 struct file *, unsigned open_flag,
1719 umode_t create_mode, int *opened);
1720 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1721 int (*set_acl)(struct inode *, struct posix_acl *, int);
1722 } ____cacheline_aligned;
1724 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1725 struct iov_iter *iter)
1727 return file->f_op->read_iter(kio, iter);
1730 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1731 struct iov_iter *iter)
1733 return file->f_op->write_iter(kio, iter);
1736 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1738 return file->f_op->mmap(file, vma);
1741 static inline int call_fsync(struct file *file, loff_t start, loff_t end,
1744 return file->f_op->fsync(file, start, end, datasync);
1747 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1748 unsigned long nr_segs, unsigned long fast_segs,
1749 struct iovec *fast_pointer,
1750 struct iovec **ret_pointer);
1752 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1753 extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
1754 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1755 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1756 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1757 unsigned long, loff_t *, int);
1758 extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1759 unsigned long, loff_t *, int);
1760 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1761 loff_t, size_t, unsigned int);
1762 extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1763 struct inode *inode_out, loff_t pos_out,
1764 u64 *len, bool is_dedupe);
1765 extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1766 struct file *file_out, loff_t pos_out, u64 len);
1767 extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1768 struct inode *dest, loff_t destoff,
1769 loff_t len, bool *is_same);
1770 extern int vfs_dedupe_file_range(struct file *file,
1771 struct file_dedupe_range *same);
1773 struct super_operations {
1774 struct inode *(*alloc_inode)(struct super_block *sb);
1775 void (*destroy_inode)(struct inode *);
1777 void (*dirty_inode) (struct inode *, int flags);
1778 int (*write_inode) (struct inode *, struct writeback_control *wbc);
1779 int (*drop_inode) (struct inode *);
1780 void (*evict_inode) (struct inode *);
1781 void (*put_super) (struct super_block *);
1782 int (*sync_fs)(struct super_block *sb, int wait);
1783 int (*freeze_super) (struct super_block *);
1784 int (*freeze_fs) (struct super_block *);
1785 int (*thaw_super) (struct super_block *);
1786 int (*unfreeze_fs) (struct super_block *);
1787 int (*statfs) (struct dentry *, struct kstatfs *);
1788 int (*remount_fs) (struct super_block *, int *, char *);
1789 void (*umount_begin) (struct super_block *);
1791 int (*show_options)(struct seq_file *, struct dentry *);
1792 int (*show_devname)(struct seq_file *, struct dentry *);
1793 int (*show_path)(struct seq_file *, struct dentry *);
1794 int (*show_stats)(struct seq_file *, struct dentry *);
1796 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1797 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1798 struct dquot **(*get_dquots)(struct inode *);
1800 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1801 long (*nr_cached_objects)(struct super_block *,
1802 struct shrink_control *);
1803 long (*free_cached_objects)(struct super_block *,
1804 struct shrink_control *);
1808 * Inode flags - they have no relation to superblock flags now
1810 #define S_SYNC 1 /* Writes are synced at once */
1811 #define S_NOATIME 2 /* Do not update access times */
1812 #define S_APPEND 4 /* Append-only file */
1813 #define S_IMMUTABLE 8 /* Immutable file */
1814 #define S_DEAD 16 /* removed, but still open directory */
1815 #define S_NOQUOTA 32 /* Inode is not counted to quota */
1816 #define S_DIRSYNC 64 /* Directory modifications are synchronous */
1817 #define S_NOCMTIME 128 /* Do not update file c/mtime */
1818 #define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1819 #define S_PRIVATE 512 /* Inode is fs-internal */
1820 #define S_IMA 1024 /* Inode has an associated IMA struct */
1821 #define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1822 #define S_NOSEC 4096 /* no suid or xattr security attributes */
1823 #ifdef CONFIG_FS_DAX
1824 #define S_DAX 8192 /* Direct Access, avoiding the page cache */
1826 #define S_DAX 0 /* Make all the DAX code disappear */
1830 * Note that nosuid etc flags are inode-specific: setting some file-system
1831 * flags just means all the inodes inherit those flags by default. It might be
1832 * possible to override it selectively if you really wanted to with some
1833 * ioctl() that is not currently implemented.
1835 * Exception: MS_RDONLY is always applied to the entire file system.
1837 * Unfortunately, it is possible to change a filesystems flags with it mounted
1838 * with files in use. This means that all of the inodes will not have their
1839 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1840 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1842 #define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1844 #define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1845 #define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1846 ((inode)->i_flags & S_SYNC))
1847 #define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1848 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1849 #define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1850 #define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1851 #define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1853 #define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1854 #define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1855 #define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1856 #define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1858 #define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1859 #define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1860 #define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1861 #define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1862 #define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1863 #define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1864 #define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
1865 #define IS_DAX(inode) ((inode)->i_flags & S_DAX)
1867 #define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1868 (inode)->i_rdev == WHITEOUT_DEV)
1870 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1872 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1876 * Inode state bits. Protected by inode->i_lock
1878 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1879 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1881 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1882 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1883 * various stages of removing an inode.
1885 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1887 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1888 * fdatasync(). i_atime is the usual cause.
1889 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1890 * these changes separately from I_DIRTY_SYNC so that we
1891 * don't have to write inode on fdatasync() when only
1892 * mtime has changed in it.
1893 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
1894 * I_NEW Serves as both a mutex and completion notification.
1895 * New inodes set I_NEW. If two processes both create
1896 * the same inode, one of them will release its inode and
1897 * wait for I_NEW to be released before returning.
1898 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1899 * also cause waiting on I_NEW, without I_NEW actually
1900 * being set. find_inode() uses this to prevent returning
1901 * nearly-dead inodes.
1902 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1903 * is zero. I_FREEING must be set when I_WILL_FREE is
1905 * I_FREEING Set when inode is about to be freed but still has dirty
1906 * pages or buffers attached or the inode itself is still
1908 * I_CLEAR Added by clear_inode(). In this state the inode is
1909 * clean and can be destroyed. Inode keeps I_FREEING.
1911 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1912 * prohibited for many purposes. iget() must wait for
1913 * the inode to be completely released, then create it
1914 * anew. Other functions will just ignore such inodes,
1915 * if appropriate. I_NEW is used for waiting.
1917 * I_SYNC Writeback of inode is running. The bit is set during
1918 * data writeback, and cleared with a wakeup on the bit
1919 * address once it is done. The bit is also used to pin
1920 * the inode in memory for flusher thread.
1922 * I_REFERENCED Marks the inode as recently references on the LRU list.
1924 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1926 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1927 * synchronize competing switching instances and to tell
1928 * wb stat updates to grab mapping->tree_lock. See
1929 * inode_switch_wb_work_fn() for details.
1931 * Q: What is the difference between I_WILL_FREE and I_FREEING?
1933 #define I_DIRTY_SYNC (1 << 0)
1934 #define I_DIRTY_DATASYNC (1 << 1)
1935 #define I_DIRTY_PAGES (1 << 2)
1937 #define I_NEW (1 << __I_NEW)
1938 #define I_WILL_FREE (1 << 4)
1939 #define I_FREEING (1 << 5)
1940 #define I_CLEAR (1 << 6)
1942 #define I_SYNC (1 << __I_SYNC)
1943 #define I_REFERENCED (1 << 8)
1944 #define __I_DIO_WAKEUP 9
1945 #define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
1946 #define I_LINKABLE (1 << 10)
1947 #define I_DIRTY_TIME (1 << 11)
1948 #define __I_DIRTY_TIME_EXPIRED 12
1949 #define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
1950 #define I_WB_SWITCH (1 << 13)
1952 #define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
1953 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
1955 extern void __mark_inode_dirty(struct inode *, int);
1956 static inline void mark_inode_dirty(struct inode *inode)
1958 __mark_inode_dirty(inode, I_DIRTY);
1961 static inline void mark_inode_dirty_sync(struct inode *inode)
1963 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1966 extern void inc_nlink(struct inode *inode);
1967 extern void drop_nlink(struct inode *inode);
1968 extern void clear_nlink(struct inode *inode);
1969 extern void set_nlink(struct inode *inode, unsigned int nlink);
1971 static inline void inode_inc_link_count(struct inode *inode)
1974 mark_inode_dirty(inode);
1977 static inline void inode_dec_link_count(struct inode *inode)
1980 mark_inode_dirty(inode);
1984 * inode_inc_iversion - increments i_version
1985 * @inode: inode that need to be updated
1987 * Every time the inode is modified, the i_version field will be incremented.
1988 * The filesystem has to be mounted with i_version flag
1991 static inline void inode_inc_iversion(struct inode *inode)
1993 spin_lock(&inode->i_lock);
1995 spin_unlock(&inode->i_lock);
1998 enum file_time_flags {
2005 extern void touch_atime(const struct path *);
2006 static inline void file_accessed(struct file *file)
2008 if (!(file->f_flags & O_NOATIME))
2009 touch_atime(&file->f_path);
2012 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2013 int sync_inode_metadata(struct inode *inode, int wait);
2015 struct file_system_type {
2018 #define FS_REQUIRES_DEV 1
2019 #define FS_BINARY_MOUNTDATA 2
2020 #define FS_HAS_SUBTYPE 4
2021 #define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
2022 #define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
2023 struct dentry *(*mount) (struct file_system_type *, int,
2024 const char *, void *);
2025 void (*kill_sb) (struct super_block *);
2026 struct module *owner;
2027 struct file_system_type * next;
2028 struct hlist_head fs_supers;
2030 struct lock_class_key s_lock_key;
2031 struct lock_class_key s_umount_key;
2032 struct lock_class_key s_vfs_rename_key;
2033 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2035 struct lock_class_key i_lock_key;
2036 struct lock_class_key i_mutex_key;
2037 struct lock_class_key i_mutex_dir_key;
2040 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2042 extern struct dentry *mount_ns(struct file_system_type *fs_type,
2043 int flags, void *data, void *ns, struct user_namespace *user_ns,
2044 int (*fill_super)(struct super_block *, void *, int));
2045 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2046 int flags, const char *dev_name, void *data,
2047 int (*fill_super)(struct super_block *, void *, int));
2048 extern struct dentry *mount_single(struct file_system_type *fs_type,
2049 int flags, void *data,
2050 int (*fill_super)(struct super_block *, void *, int));
2051 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2052 int flags, void *data,
2053 int (*fill_super)(struct super_block *, void *, int));
2054 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2055 void generic_shutdown_super(struct super_block *sb);
2056 void kill_block_super(struct super_block *sb);
2057 void kill_anon_super(struct super_block *sb);
2058 void kill_litter_super(struct super_block *sb);
2059 void deactivate_super(struct super_block *sb);
2060 void deactivate_locked_super(struct super_block *sb);
2061 int set_anon_super(struct super_block *s, void *data);
2062 int get_anon_bdev(dev_t *);
2063 void free_anon_bdev(dev_t);
2064 struct super_block *sget_userns(struct file_system_type *type,
2065 int (*test)(struct super_block *,void *),
2066 int (*set)(struct super_block *,void *),
2067 int flags, struct user_namespace *user_ns,
2069 struct super_block *sget(struct file_system_type *type,
2070 int (*test)(struct super_block *,void *),
2071 int (*set)(struct super_block *,void *),
2072 int flags, void *data);
2073 extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2074 const struct super_operations *ops,
2075 const struct xattr_handler **xattr,
2076 const struct dentry_operations *dops,
2079 static inline struct dentry *
2080 mount_pseudo(struct file_system_type *fs_type, char *name,
2081 const struct super_operations *ops,
2082 const struct dentry_operations *dops, unsigned long magic)
2084 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2087 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2088 #define fops_get(fops) \
2089 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2090 #define fops_put(fops) \
2091 do { if (fops) module_put((fops)->owner); } while(0)
2093 * This one is to be used *ONLY* from ->open() instances.
2094 * fops must be non-NULL, pinned down *and* module dependencies
2095 * should be sufficient to pin the caller down as well.
2097 #define replace_fops(f, fops) \
2099 struct file *__file = (f); \
2100 fops_put(__file->f_op); \
2101 BUG_ON(!(__file->f_op = (fops))); \
2104 extern int register_filesystem(struct file_system_type *);
2105 extern int unregister_filesystem(struct file_system_type *);
2106 extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2107 #define kern_mount(type) kern_mount_data(type, NULL)
2108 extern void kern_unmount(struct vfsmount *mnt);
2109 extern int may_umount_tree(struct vfsmount *);
2110 extern int may_umount(struct vfsmount *);
2111 extern long do_mount(const char *, const char __user *,
2112 const char *, unsigned long, void *);
2113 extern struct vfsmount *collect_mounts(const struct path *);
2114 extern void drop_collected_mounts(struct vfsmount *);
2115 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2117 extern int vfs_statfs(const struct path *, struct kstatfs *);
2118 extern int user_statfs(const char __user *, struct kstatfs *);
2119 extern int fd_statfs(int, struct kstatfs *);
2120 extern int vfs_ustat(dev_t, struct kstatfs *);
2121 extern int freeze_super(struct super_block *super);
2122 extern int thaw_super(struct super_block *super);
2123 extern bool our_mnt(struct vfsmount *mnt);
2124 extern __printf(2, 3)
2125 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2126 extern int super_setup_bdi(struct super_block *sb);
2128 extern int current_umask(void);
2130 extern void ihold(struct inode * inode);
2131 extern void iput(struct inode *);
2132 extern int generic_update_time(struct inode *, struct timespec *, int);
2135 extern struct kobject *fs_kobj;
2137 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2139 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2140 extern int locks_mandatory_locked(struct file *);
2141 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2144 * Candidates for mandatory locking have the setgid bit set
2145 * but no group execute bit - an otherwise meaningless combination.
2148 static inline int __mandatory_lock(struct inode *ino)
2150 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2154 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2155 * otherwise these will be advisory locks
2158 static inline int mandatory_lock(struct inode *ino)
2160 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2163 static inline int locks_verify_locked(struct file *file)
2165 if (mandatory_lock(locks_inode(file)))
2166 return locks_mandatory_locked(file);
2170 static inline int locks_verify_truncate(struct inode *inode,
2174 if (!inode->i_flctx || !mandatory_lock(inode))
2177 if (size < inode->i_size) {
2178 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2181 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2186 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2188 static inline int locks_mandatory_locked(struct file *file)
2193 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2194 loff_t start, loff_t end, unsigned char type)
2199 static inline int __mandatory_lock(struct inode *inode)
2204 static inline int mandatory_lock(struct inode *inode)
2209 static inline int locks_verify_locked(struct file *file)
2214 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2220 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2223 #ifdef CONFIG_FILE_LOCKING
2224 static inline int break_lease(struct inode *inode, unsigned int mode)
2227 * Since this check is lockless, we must ensure that any refcounts
2228 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2229 * could end up racing with tasks trying to set a new lease on this
2233 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2234 return __break_lease(inode, mode, FL_LEASE);
2238 static inline int break_deleg(struct inode *inode, unsigned int mode)
2241 * Since this check is lockless, we must ensure that any refcounts
2242 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2243 * could end up racing with tasks trying to set a new lease on this
2247 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2248 return __break_lease(inode, mode, FL_DELEG);
2252 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2256 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2257 if (ret == -EWOULDBLOCK && delegated_inode) {
2258 *delegated_inode = inode;
2264 static inline int break_deleg_wait(struct inode **delegated_inode)
2268 ret = break_deleg(*delegated_inode, O_WRONLY);
2269 iput(*delegated_inode);
2270 *delegated_inode = NULL;
2274 static inline int break_layout(struct inode *inode, bool wait)
2277 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2278 return __break_lease(inode,
2279 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2284 #else /* !CONFIG_FILE_LOCKING */
2285 static inline int break_lease(struct inode *inode, unsigned int mode)
2290 static inline int break_deleg(struct inode *inode, unsigned int mode)
2295 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2300 static inline int break_deleg_wait(struct inode **delegated_inode)
2306 static inline int break_layout(struct inode *inode, bool wait)
2311 #endif /* CONFIG_FILE_LOCKING */
2316 const char *name; /* pointer to actual string */
2317 const __user char *uptr; /* original userland pointer */
2318 struct audit_names *aname;
2323 extern long vfs_truncate(const struct path *, loff_t);
2324 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2326 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2328 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2330 extern struct file *file_open_name(struct filename *, int, umode_t);
2331 extern struct file *filp_open(const char *, int, umode_t);
2332 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2333 const char *, int, umode_t);
2334 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2335 extern int filp_close(struct file *, fl_owner_t id);
2337 extern struct filename *getname_flags(const char __user *, int, int *);
2338 extern struct filename *getname(const char __user *);
2339 extern struct filename *getname_kernel(const char *);
2340 extern void putname(struct filename *name);
2346 extern int finish_open(struct file *file, struct dentry *dentry,
2347 int (*open)(struct inode *, struct file *),
2349 extern int finish_no_open(struct file *file, struct dentry *dentry);
2353 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2356 extern void __init vfs_caches_init_early(void);
2357 extern void __init vfs_caches_init(void);
2359 extern struct kmem_cache *names_cachep;
2361 #define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
2362 #define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
2365 extern int register_blkdev(unsigned int, const char *);
2366 extern void unregister_blkdev(unsigned int, const char *);
2367 extern void bdev_unhash_inode(dev_t dev);
2368 extern struct block_device *bdget(dev_t);
2369 extern struct block_device *bdgrab(struct block_device *bdev);
2370 extern void bd_set_size(struct block_device *, loff_t size);
2371 extern void bd_forget(struct inode *inode);
2372 extern void bdput(struct block_device *);
2373 extern void invalidate_bdev(struct block_device *);
2374 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
2375 extern int sync_blockdev(struct block_device *bdev);
2376 extern void kill_bdev(struct block_device *);
2377 extern struct super_block *freeze_bdev(struct block_device *);
2378 extern void emergency_thaw_all(void);
2379 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2380 extern int fsync_bdev(struct block_device *);
2382 extern struct super_block *blockdev_superblock;
2384 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2386 return sb == blockdev_superblock;
2389 static inline void bd_forget(struct inode *inode) {}
2390 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2391 static inline void kill_bdev(struct block_device *bdev) {}
2392 static inline void invalidate_bdev(struct block_device *bdev) {}
2394 static inline struct super_block *freeze_bdev(struct block_device *sb)
2399 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2404 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2408 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2413 extern int sync_filesystem(struct super_block *);
2414 extern const struct file_operations def_blk_fops;
2415 extern const struct file_operations def_chr_fops;
2417 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2418 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2419 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2420 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2421 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2423 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2425 extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2426 extern int __blkdev_reread_part(struct block_device *bdev);
2427 extern int blkdev_reread_part(struct block_device *bdev);
2430 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2431 extern void bd_unlink_disk_holder(struct block_device *bdev,
2432 struct gendisk *disk);
2434 static inline int bd_link_disk_holder(struct block_device *bdev,
2435 struct gendisk *disk)
2439 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2440 struct gendisk *disk)
2447 #define CHRDEV_MAJOR_HASH_SIZE 255
2448 /* Marks the bottom of the first segment of free char majors */
2449 #define CHRDEV_MAJOR_DYN_END 234
2450 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2451 extern int register_chrdev_region(dev_t, unsigned, const char *);
2452 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2453 unsigned int count, const char *name,
2454 const struct file_operations *fops);
2455 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2456 unsigned int count, const char *name);
2457 extern void unregister_chrdev_region(dev_t, unsigned);
2458 extern void chrdev_show(struct seq_file *,off_t);
2460 static inline int register_chrdev(unsigned int major, const char *name,
2461 const struct file_operations *fops)
2463 return __register_chrdev(major, 0, 256, name, fops);
2466 static inline void unregister_chrdev(unsigned int major, const char *name)
2468 __unregister_chrdev(major, 0, 256, name);
2471 /* fs/block_dev.c */
2472 #define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
2473 #define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
2476 #define BLKDEV_MAJOR_HASH_SIZE 255
2477 extern const char *__bdevname(dev_t, char *buffer);
2478 extern const char *bdevname(struct block_device *bdev, char *buffer);
2479 extern struct block_device *lookup_bdev(const char *);
2480 extern void blkdev_show(struct seq_file *,off_t);
2483 #define BLKDEV_MAJOR_HASH_SIZE 0
2486 extern void init_special_inode(struct inode *, umode_t, dev_t);
2488 /* Invalid inode operations -- fs/bad_inode.c */
2489 extern void make_bad_inode(struct inode *);
2490 extern bool is_bad_inode(struct inode *);
2493 extern void check_disk_size_change(struct gendisk *disk,
2494 struct block_device *bdev);
2495 extern int revalidate_disk(struct gendisk *);
2496 extern int check_disk_change(struct block_device *);
2497 extern int __invalidate_device(struct block_device *, bool);
2498 extern int invalidate_partition(struct gendisk *, int);
2500 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2501 pgoff_t start, pgoff_t end);
2503 static inline void invalidate_remote_inode(struct inode *inode)
2505 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2506 S_ISLNK(inode->i_mode))
2507 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2509 extern int invalidate_inode_pages2(struct address_space *mapping);
2510 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2511 pgoff_t start, pgoff_t end);
2512 extern int write_inode_now(struct inode *, int);
2513 extern int filemap_fdatawrite(struct address_space *);
2514 extern int filemap_flush(struct address_space *);
2515 extern int filemap_fdatawait(struct address_space *);
2516 extern void filemap_fdatawait_keep_errors(struct address_space *);
2517 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2519 extern int filemap_write_and_wait(struct address_space *mapping);
2520 extern int filemap_write_and_wait_range(struct address_space *mapping,
2521 loff_t lstart, loff_t lend);
2522 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2523 loff_t start, loff_t end, int sync_mode);
2524 extern int filemap_fdatawrite_range(struct address_space *mapping,
2525 loff_t start, loff_t end);
2526 extern int filemap_check_errors(struct address_space *mapping);
2528 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2530 extern int vfs_fsync(struct file *file, int datasync);
2533 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2534 * to already be updated for the write, and will return either the amount
2535 * of bytes passed in, or an error if syncing the file failed.
2537 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2539 if (iocb->ki_flags & IOCB_DSYNC) {
2540 int ret = vfs_fsync_range(iocb->ki_filp,
2541 iocb->ki_pos - count, iocb->ki_pos - 1,
2542 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2550 extern void emergency_sync(void);
2551 extern void emergency_remount(void);
2553 extern sector_t bmap(struct inode *, sector_t);
2555 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2556 extern int inode_permission(struct inode *, int);
2557 extern int __inode_permission(struct inode *, int);
2558 extern int generic_permission(struct inode *, int);
2559 extern int __check_sticky(struct inode *dir, struct inode *inode);
2561 static inline bool execute_ok(struct inode *inode)
2563 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2566 static inline void file_start_write(struct file *file)
2568 if (!S_ISREG(file_inode(file)->i_mode))
2570 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2573 static inline bool file_start_write_trylock(struct file *file)
2575 if (!S_ISREG(file_inode(file)->i_mode))
2577 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2580 static inline void file_end_write(struct file *file)
2582 if (!S_ISREG(file_inode(file)->i_mode))
2584 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2587 static inline int do_clone_file_range(struct file *file_in, loff_t pos_in,
2588 struct file *file_out, loff_t pos_out,
2593 file_start_write(file_out);
2594 ret = vfs_clone_file_range(file_in, pos_in, file_out, pos_out, len);
2595 file_end_write(file_out);
2601 * get_write_access() gets write permission for a file.
2602 * put_write_access() releases this write permission.
2603 * This is used for regular files.
2604 * We cannot support write (and maybe mmap read-write shared) accesses and
2605 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2606 * can have the following values:
2607 * 0: no writers, no VM_DENYWRITE mappings
2608 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2609 * > 0: (i_writecount) users are writing to the file.
2611 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2612 * except for the cases where we don't hold i_writecount yet. Then we need to
2613 * use {get,deny}_write_access() - these functions check the sign and refuse
2614 * to do the change if sign is wrong.
2616 static inline int get_write_access(struct inode *inode)
2618 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2620 static inline int deny_write_access(struct file *file)
2622 struct inode *inode = file_inode(file);
2623 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2625 static inline void put_write_access(struct inode * inode)
2627 atomic_dec(&inode->i_writecount);
2629 static inline void allow_write_access(struct file *file)
2632 atomic_inc(&file_inode(file)->i_writecount);
2634 static inline bool inode_is_open_for_write(const struct inode *inode)
2636 return atomic_read(&inode->i_writecount) > 0;
2640 static inline void i_readcount_dec(struct inode *inode)
2642 BUG_ON(!atomic_read(&inode->i_readcount));
2643 atomic_dec(&inode->i_readcount);
2645 static inline void i_readcount_inc(struct inode *inode)
2647 atomic_inc(&inode->i_readcount);
2650 static inline void i_readcount_dec(struct inode *inode)
2654 static inline void i_readcount_inc(struct inode *inode)
2659 extern int do_pipe_flags(int *, int);
2661 #define __kernel_read_file_id(id) \
2662 id(UNKNOWN, unknown) \
2663 id(FIRMWARE, firmware) \
2664 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
2665 id(MODULE, kernel-module) \
2666 id(KEXEC_IMAGE, kexec-image) \
2667 id(KEXEC_INITRAMFS, kexec-initramfs) \
2668 id(POLICY, security-policy) \
2671 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2672 #define __fid_stringify(dummy, str) #str,
2674 enum kernel_read_file_id {
2675 __kernel_read_file_id(__fid_enumify)
2678 static const char * const kernel_read_file_str[] = {
2679 __kernel_read_file_id(__fid_stringify)
2682 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2684 if ((unsigned)id >= READING_MAX_ID)
2685 return kernel_read_file_str[READING_UNKNOWN];
2687 return kernel_read_file_str[id];
2690 extern int kernel_read(struct file *, loff_t, char *, unsigned long);
2691 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2692 enum kernel_read_file_id);
2693 extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2694 enum kernel_read_file_id);
2695 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2696 enum kernel_read_file_id);
2697 extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
2698 extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
2699 extern struct file * open_exec(const char *);
2701 /* fs/dcache.c -- generic fs support functions */
2702 extern bool is_subdir(struct dentry *, struct dentry *);
2703 extern bool path_is_under(const struct path *, const struct path *);
2705 extern char *file_path(struct file *, char *, int);
2707 #include <linux/err.h>
2709 /* needed for stackable file system support */
2710 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2712 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2714 extern int inode_init_always(struct super_block *, struct inode *);
2715 extern void inode_init_once(struct inode *);
2716 extern void address_space_init_once(struct address_space *mapping);
2717 extern struct inode * igrab(struct inode *);
2718 extern ino_t iunique(struct super_block *, ino_t);
2719 extern int inode_needs_sync(struct inode *inode);
2720 extern int generic_delete_inode(struct inode *inode);
2721 static inline int generic_drop_inode(struct inode *inode)
2723 return !inode->i_nlink || inode_unhashed(inode);
2726 extern struct inode *ilookup5_nowait(struct super_block *sb,
2727 unsigned long hashval, int (*test)(struct inode *, void *),
2729 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2730 int (*test)(struct inode *, void *), void *data);
2731 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2733 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2734 extern struct inode * iget_locked(struct super_block *, unsigned long);
2735 extern struct inode *find_inode_nowait(struct super_block *,
2737 int (*match)(struct inode *,
2738 unsigned long, void *),
2740 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2741 extern int insert_inode_locked(struct inode *);
2742 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2743 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2745 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2747 extern void unlock_new_inode(struct inode *);
2748 extern unsigned int get_next_ino(void);
2750 extern void __iget(struct inode * inode);
2751 extern void iget_failed(struct inode *);
2752 extern void clear_inode(struct inode *);
2753 extern void __destroy_inode(struct inode *);
2754 extern struct inode *new_inode_pseudo(struct super_block *sb);
2755 extern struct inode *new_inode(struct super_block *sb);
2756 extern void free_inode_nonrcu(struct inode *inode);
2757 extern int should_remove_suid(struct dentry *);
2758 extern int file_remove_privs(struct file *);
2760 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2761 static inline void insert_inode_hash(struct inode *inode)
2763 __insert_inode_hash(inode, inode->i_ino);
2766 extern void __remove_inode_hash(struct inode *);
2767 static inline void remove_inode_hash(struct inode *inode)
2769 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
2770 __remove_inode_hash(inode);
2773 extern void inode_sb_list_add(struct inode *inode);
2776 extern int bdev_read_only(struct block_device *);
2778 extern int set_blocksize(struct block_device *, int);
2779 extern int sb_set_blocksize(struct super_block *, int);
2780 extern int sb_min_blocksize(struct super_block *, int);
2782 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2783 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2784 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
2785 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
2786 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
2787 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
2788 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
2789 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
2791 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2792 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2794 /* fs/block_dev.c */
2795 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
2796 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
2797 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2799 extern void block_sync_page(struct page *page);
2802 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
2803 struct pipe_inode_info *, size_t, unsigned int);
2804 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
2805 struct file *, loff_t *, size_t, unsigned int);
2806 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
2807 struct file *out, loff_t *, size_t len, unsigned int flags);
2808 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2809 loff_t *opos, size_t len, unsigned int flags);
2813 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
2814 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2815 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
2816 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
2817 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
2818 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
2819 int whence, loff_t maxsize, loff_t eof);
2820 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2821 int whence, loff_t size);
2822 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2823 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
2824 extern int generic_file_open(struct inode * inode, struct file * filp);
2825 extern int nonseekable_open(struct inode * inode, struct file * filp);
2828 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
2829 loff_t file_offset);
2832 /* need locking between buffered and direct access */
2835 /* filesystem does not support filling holes */
2836 DIO_SKIP_HOLES = 0x02,
2838 /* filesystem can handle aio writes beyond i_size */
2839 DIO_ASYNC_EXTEND = 0x04,
2841 /* inode/fs/bdev does not need truncate protection */
2842 DIO_SKIP_DIO_COUNT = 0x08,
2845 void dio_end_io(struct bio *bio, int error);
2847 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2848 struct block_device *bdev, struct iov_iter *iter,
2849 get_block_t get_block,
2850 dio_iodone_t end_io, dio_submit_t submit_io,
2853 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2854 struct inode *inode,
2855 struct iov_iter *iter,
2856 get_block_t get_block)
2858 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
2859 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
2863 void inode_dio_wait(struct inode *inode);
2866 * inode_dio_begin - signal start of a direct I/O requests
2867 * @inode: inode the direct I/O happens on
2869 * This is called once we've finished processing a direct I/O request,
2870 * and is used to wake up callers waiting for direct I/O to be quiesced.
2872 static inline void inode_dio_begin(struct inode *inode)
2874 atomic_inc(&inode->i_dio_count);
2878 * inode_dio_end - signal finish of a direct I/O requests
2879 * @inode: inode the direct I/O happens on
2881 * This is called once we've finished processing a direct I/O request,
2882 * and is used to wake up callers waiting for direct I/O to be quiesced.
2884 static inline void inode_dio_end(struct inode *inode)
2886 if (atomic_dec_and_test(&inode->i_dio_count))
2887 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2890 extern void inode_set_flags(struct inode *inode, unsigned int flags,
2893 extern const struct file_operations generic_ro_fops;
2895 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2897 extern int readlink_copy(char __user *, int, const char *);
2898 extern int page_readlink(struct dentry *, char __user *, int);
2899 extern const char *page_get_link(struct dentry *, struct inode *,
2900 struct delayed_call *);
2901 extern void page_put_link(void *);
2902 extern int __page_symlink(struct inode *inode, const char *symname, int len,
2904 extern int page_symlink(struct inode *inode, const char *symname, int len);
2905 extern const struct inode_operations page_symlink_inode_operations;
2906 extern void kfree_link(void *);
2907 extern void generic_fillattr(struct inode *, struct kstat *);
2908 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
2909 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
2910 void __inode_add_bytes(struct inode *inode, loff_t bytes);
2911 void inode_add_bytes(struct inode *inode, loff_t bytes);
2912 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
2913 void inode_sub_bytes(struct inode *inode, loff_t bytes);
2914 loff_t inode_get_bytes(struct inode *inode);
2915 void inode_set_bytes(struct inode *inode, loff_t bytes);
2916 const char *simple_get_link(struct dentry *, struct inode *,
2917 struct delayed_call *);
2918 extern const struct inode_operations simple_symlink_inode_operations;
2920 extern int iterate_dir(struct file *, struct dir_context *);
2922 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
2923 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
2925 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
2927 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
2928 stat, STATX_BASIC_STATS);
2930 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
2932 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
2933 stat, STATX_BASIC_STATS);
2935 static inline int vfs_fstatat(int dfd, const char __user *filename,
2936 struct kstat *stat, int flags)
2938 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
2939 stat, STATX_BASIC_STATS);
2941 static inline int vfs_fstat(int fd, struct kstat *stat)
2943 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
2947 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
2948 extern int vfs_readlink(struct dentry *, char __user *, int);
2950 extern int __generic_block_fiemap(struct inode *inode,
2951 struct fiemap_extent_info *fieinfo,
2952 loff_t start, loff_t len,
2953 get_block_t *get_block);
2954 extern int generic_block_fiemap(struct inode *inode,
2955 struct fiemap_extent_info *fieinfo, u64 start,
2956 u64 len, get_block_t *get_block);
2958 extern void get_filesystem(struct file_system_type *fs);
2959 extern void put_filesystem(struct file_system_type *fs);
2960 extern struct file_system_type *get_fs_type(const char *name);
2961 extern struct super_block *get_super(struct block_device *);
2962 extern struct super_block *get_super_thawed(struct block_device *);
2963 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
2964 extern struct super_block *get_active_super(struct block_device *bdev);
2965 extern void drop_super(struct super_block *sb);
2966 extern void drop_super_exclusive(struct super_block *sb);
2967 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
2968 extern void iterate_supers_type(struct file_system_type *,
2969 void (*)(struct super_block *, void *), void *);
2971 extern int dcache_dir_open(struct inode *, struct file *);
2972 extern int dcache_dir_close(struct inode *, struct file *);
2973 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
2974 extern int dcache_readdir(struct file *, struct dir_context *);
2975 extern int simple_setattr(struct dentry *, struct iattr *);
2976 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
2977 extern int simple_statfs(struct dentry *, struct kstatfs *);
2978 extern int simple_open(struct inode *inode, struct file *file);
2979 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2980 extern int simple_unlink(struct inode *, struct dentry *);
2981 extern int simple_rmdir(struct inode *, struct dentry *);
2982 extern int simple_rename(struct inode *, struct dentry *,
2983 struct inode *, struct dentry *, unsigned int);
2984 extern int noop_fsync(struct file *, loff_t, loff_t, int);
2985 extern int simple_empty(struct dentry *);
2986 extern int simple_readpage(struct file *file, struct page *page);
2987 extern int simple_write_begin(struct file *file, struct address_space *mapping,
2988 loff_t pos, unsigned len, unsigned flags,
2989 struct page **pagep, void **fsdata);
2990 extern int simple_write_end(struct file *file, struct address_space *mapping,
2991 loff_t pos, unsigned len, unsigned copied,
2992 struct page *page, void *fsdata);
2993 extern int always_delete_dentry(const struct dentry *);
2994 extern struct inode *alloc_anon_inode(struct super_block *);
2995 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
2996 extern const struct dentry_operations simple_dentry_operations;
2998 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
2999 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3000 extern const struct file_operations simple_dir_operations;
3001 extern const struct inode_operations simple_dir_inode_operations;
3002 extern void make_empty_dir_inode(struct inode *inode);
3003 extern bool is_empty_dir_inode(struct inode *inode);
3004 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3005 struct dentry *d_alloc_name(struct dentry *, const char *);
3006 extern int simple_fill_super(struct super_block *, unsigned long,
3007 const struct tree_descr *);
3008 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3009 extern void simple_release_fs(struct vfsmount **mount, int *count);
3011 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3012 loff_t *ppos, const void *from, size_t available);
3013 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3014 const void __user *from, size_t count);
3016 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3017 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3019 extern int generic_check_addressable(unsigned, u64);
3021 #ifdef CONFIG_MIGRATION
3022 extern int buffer_migrate_page(struct address_space *,
3023 struct page *, struct page *,
3026 #define buffer_migrate_page NULL
3029 extern int setattr_prepare(struct dentry *, struct iattr *);
3030 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3031 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3033 extern int file_update_time(struct file *file);
3035 extern int generic_show_options(struct seq_file *m, struct dentry *root);
3036 extern void save_mount_options(struct super_block *sb, char *options);
3037 extern void replace_mount_options(struct super_block *sb, char *options);
3039 static inline bool io_is_direct(struct file *filp)
3041 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
3044 static inline int iocb_flags(struct file *file)
3047 if (file->f_flags & O_APPEND)
3049 if (io_is_direct(file))
3051 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3053 if (file->f_flags & __O_SYNC)
3058 static inline ino_t parent_ino(struct dentry *dentry)
3063 * Don't strictly need d_lock here? If the parent ino could change
3064 * then surely we'd have a deeper race in the caller?
3066 spin_lock(&dentry->d_lock);
3067 res = dentry->d_parent->d_inode->i_ino;
3068 spin_unlock(&dentry->d_lock);
3072 /* Transaction based IO helpers */
3075 * An argresp is stored in an allocated page and holds the
3076 * size of the argument or response, along with its content
3078 struct simple_transaction_argresp {
3083 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3085 char *simple_transaction_get(struct file *file, const char __user *buf,
3087 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3088 size_t size, loff_t *pos);
3089 int simple_transaction_release(struct inode *inode, struct file *file);
3091 void simple_transaction_set(struct file *file, size_t n);
3094 * simple attribute files
3096 * These attributes behave similar to those in sysfs:
3098 * Writing to an attribute immediately sets a value, an open file can be
3099 * written to multiple times.
3101 * Reading from an attribute creates a buffer from the value that might get
3102 * read with multiple read calls. When the attribute has been read
3103 * completely, no further read calls are possible until the file is opened
3106 * All attributes contain a text representation of a numeric value
3107 * that are accessed with the get() and set() functions.
3109 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3110 static int __fops ## _open(struct inode *inode, struct file *file) \
3112 __simple_attr_check_format(__fmt, 0ull); \
3113 return simple_attr_open(inode, file, __get, __set, __fmt); \
3115 static const struct file_operations __fops = { \
3116 .owner = THIS_MODULE, \
3117 .open = __fops ## _open, \
3118 .release = simple_attr_release, \
3119 .read = simple_attr_read, \
3120 .write = simple_attr_write, \
3121 .llseek = generic_file_llseek, \
3124 static inline __printf(1, 2)
3125 void __simple_attr_check_format(const char *fmt, ...)
3127 /* don't do anything, just let the compiler check the arguments; */
3130 int simple_attr_open(struct inode *inode, struct file *file,
3131 int (*get)(void *, u64 *), int (*set)(void *, u64),
3133 int simple_attr_release(struct inode *inode, struct file *file);
3134 ssize_t simple_attr_read(struct file *file, char __user *buf,
3135 size_t len, loff_t *ppos);
3136 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3137 size_t len, loff_t *ppos);
3140 int proc_nr_files(struct ctl_table *table, int write,
3141 void __user *buffer, size_t *lenp, loff_t *ppos);
3142 int proc_nr_dentry(struct ctl_table *table, int write,
3143 void __user *buffer, size_t *lenp, loff_t *ppos);
3144 int proc_nr_inodes(struct ctl_table *table, int write,
3145 void __user *buffer, size_t *lenp, loff_t *ppos);
3146 int __init get_filesystem_list(char *buf);
3148 #define __FMODE_EXEC ((__force int) FMODE_EXEC)
3149 #define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3151 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3152 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3153 (flag & __FMODE_NONOTIFY)))
3155 static inline bool is_sxid(umode_t mode)
3157 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3160 static inline int check_sticky(struct inode *dir, struct inode *inode)
3162 if (!(dir->i_mode & S_ISVTX))
3165 return __check_sticky(dir, inode);
3168 static inline void inode_has_no_xattr(struct inode *inode)
3170 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
3171 inode->i_flags |= S_NOSEC;
3174 static inline bool is_root_inode(struct inode *inode)
3176 return inode == inode->i_sb->s_root->d_inode;
3179 static inline bool dir_emit(struct dir_context *ctx,
3180 const char *name, int namelen,
3181 u64 ino, unsigned type)
3183 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3185 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3187 return ctx->actor(ctx, ".", 1, ctx->pos,
3188 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3190 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3192 return ctx->actor(ctx, "..", 2, ctx->pos,
3193 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3195 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3197 if (ctx->pos == 0) {
3198 if (!dir_emit_dot(file, ctx))
3202 if (ctx->pos == 1) {
3203 if (!dir_emit_dotdot(file, ctx))
3209 static inline bool dir_relax(struct inode *inode)
3211 inode_unlock(inode);
3213 return !IS_DEADDIR(inode);
3216 static inline bool dir_relax_shared(struct inode *inode)
3218 inode_unlock_shared(inode);
3219 inode_lock_shared(inode);
3220 return !IS_DEADDIR(inode);
3223 extern bool path_noexec(const struct path *path);
3224 extern void inode_nohighmem(struct inode *inode);
3226 #endif /* _LINUX_FS_H */