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