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