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