Merge tag 'nfs-for-4.20-1' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
[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         char                    s_id[32];       /* Informational name */
1397         uuid_t                  s_uuid;         /* UUID */
1398
1399         void                    *s_fs_info;     /* Filesystem private info */
1400         unsigned int            s_max_links;
1401         fmode_t                 s_mode;
1402
1403         /* Granularity of c/m/atime in ns.
1404            Cannot be worse than a second */
1405         u32                s_time_gran;
1406
1407         /*
1408          * The next field is for VFS *only*. No filesystems have any business
1409          * even looking at it. You had been warned.
1410          */
1411         struct mutex s_vfs_rename_mutex;        /* Kludge */
1412
1413         /*
1414          * Filesystem subtype.  If non-empty the filesystem type field
1415          * in /proc/mounts will be "type.subtype"
1416          */
1417         char *s_subtype;
1418
1419         const struct dentry_operations *s_d_op; /* default d_op for dentries */
1420
1421         /*
1422          * Saved pool identifier for cleancache (-1 means none)
1423          */
1424         int cleancache_poolid;
1425
1426         struct shrinker s_shrink;       /* per-sb shrinker handle */
1427
1428         /* Number of inodes with nlink == 0 but still referenced */
1429         atomic_long_t s_remove_count;
1430
1431         /* Being remounted read-only */
1432         int s_readonly_remount;
1433
1434         /* AIO completions deferred from interrupt context */
1435         struct workqueue_struct *s_dio_done_wq;
1436         struct hlist_head s_pins;
1437
1438         /*
1439          * Owning user namespace and default context in which to
1440          * interpret filesystem uids, gids, quotas, device nodes,
1441          * xattrs and security labels.
1442          */
1443         struct user_namespace *s_user_ns;
1444
1445         /*
1446          * Keep the lru lists last in the structure so they always sit on their
1447          * own individual cachelines.
1448          */
1449         struct list_lru         s_dentry_lru ____cacheline_aligned_in_smp;
1450         struct list_lru         s_inode_lru ____cacheline_aligned_in_smp;
1451         struct rcu_head         rcu;
1452         struct work_struct      destroy_work;
1453
1454         struct mutex            s_sync_lock;    /* sync serialisation lock */
1455
1456         /*
1457          * Indicates how deep in a filesystem stack this SB is
1458          */
1459         int s_stack_depth;
1460
1461         /* s_inode_list_lock protects s_inodes */
1462         spinlock_t              s_inode_list_lock ____cacheline_aligned_in_smp;
1463         struct list_head        s_inodes;       /* all inodes */
1464
1465         spinlock_t              s_inode_wblist_lock;
1466         struct list_head        s_inodes_wb;    /* writeback inodes */
1467 } __randomize_layout;
1468
1469 /* Helper functions so that in most cases filesystems will
1470  * not need to deal directly with kuid_t and kgid_t and can
1471  * instead deal with the raw numeric values that are stored
1472  * in the filesystem.
1473  */
1474 static inline uid_t i_uid_read(const struct inode *inode)
1475 {
1476         return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1477 }
1478
1479 static inline gid_t i_gid_read(const struct inode *inode)
1480 {
1481         return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1482 }
1483
1484 static inline void i_uid_write(struct inode *inode, uid_t uid)
1485 {
1486         inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1487 }
1488
1489 static inline void i_gid_write(struct inode *inode, gid_t gid)
1490 {
1491         inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1492 }
1493
1494 extern struct timespec64 timespec64_trunc(struct timespec64 t, unsigned gran);
1495 extern struct timespec64 current_time(struct inode *inode);
1496
1497 /*
1498  * Snapshotting support.
1499  */
1500
1501 void __sb_end_write(struct super_block *sb, int level);
1502 int __sb_start_write(struct super_block *sb, int level, bool wait);
1503
1504 #define __sb_writers_acquired(sb, lev)  \
1505         percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1506 #define __sb_writers_release(sb, lev)   \
1507         percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1508
1509 /**
1510  * sb_end_write - drop write access to a superblock
1511  * @sb: the super we wrote to
1512  *
1513  * Decrement number of writers to the filesystem. Wake up possible waiters
1514  * wanting to freeze the filesystem.
1515  */
1516 static inline void sb_end_write(struct super_block *sb)
1517 {
1518         __sb_end_write(sb, SB_FREEZE_WRITE);
1519 }
1520
1521 /**
1522  * sb_end_pagefault - drop write access to a superblock from a page fault
1523  * @sb: the super we wrote to
1524  *
1525  * Decrement number of processes handling write page fault to the filesystem.
1526  * Wake up possible waiters wanting to freeze the filesystem.
1527  */
1528 static inline void sb_end_pagefault(struct super_block *sb)
1529 {
1530         __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1531 }
1532
1533 /**
1534  * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1535  * @sb: the super we wrote to
1536  *
1537  * Decrement fs-internal number of writers to the filesystem.  Wake up possible
1538  * waiters wanting to freeze the filesystem.
1539  */
1540 static inline void sb_end_intwrite(struct super_block *sb)
1541 {
1542         __sb_end_write(sb, SB_FREEZE_FS);
1543 }
1544
1545 /**
1546  * sb_start_write - get write access to a superblock
1547  * @sb: the super we write to
1548  *
1549  * When a process wants to write data or metadata to a file system (i.e. dirty
1550  * a page or an inode), it should embed the operation in a sb_start_write() -
1551  * sb_end_write() pair to get exclusion against file system freezing. This
1552  * function increments number of writers preventing freezing. If the file
1553  * system is already frozen, the function waits until the file system is
1554  * thawed.
1555  *
1556  * Since freeze protection behaves as a lock, users have to preserve
1557  * ordering of freeze protection and other filesystem locks. Generally,
1558  * freeze protection should be the outermost lock. In particular, we have:
1559  *
1560  * sb_start_write
1561  *   -> i_mutex                 (write path, truncate, directory ops, ...)
1562  *   -> s_umount                (freeze_super, thaw_super)
1563  */
1564 static inline void sb_start_write(struct super_block *sb)
1565 {
1566         __sb_start_write(sb, SB_FREEZE_WRITE, true);
1567 }
1568
1569 static inline int sb_start_write_trylock(struct super_block *sb)
1570 {
1571         return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1572 }
1573
1574 /**
1575  * sb_start_pagefault - get write access to a superblock from a page fault
1576  * @sb: the super we write to
1577  *
1578  * When a process starts handling write page fault, it should embed the
1579  * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1580  * exclusion against file system freezing. This is needed since the page fault
1581  * is going to dirty a page. This function increments number of running page
1582  * faults preventing freezing. If the file system is already frozen, the
1583  * function waits until the file system is thawed.
1584  *
1585  * Since page fault freeze protection behaves as a lock, users have to preserve
1586  * ordering of freeze protection and other filesystem locks. It is advised to
1587  * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1588  * handling code implies lock dependency:
1589  *
1590  * mmap_sem
1591  *   -> sb_start_pagefault
1592  */
1593 static inline void sb_start_pagefault(struct super_block *sb)
1594 {
1595         __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1596 }
1597
1598 /*
1599  * sb_start_intwrite - get write access to a superblock for internal fs purposes
1600  * @sb: the super we write to
1601  *
1602  * This is the third level of protection against filesystem freezing. It is
1603  * free for use by a filesystem. The only requirement is that it must rank
1604  * below sb_start_pagefault.
1605  *
1606  * For example filesystem can call sb_start_intwrite() when starting a
1607  * transaction which somewhat eases handling of freezing for internal sources
1608  * of filesystem changes (internal fs threads, discarding preallocation on file
1609  * close, etc.).
1610  */
1611 static inline void sb_start_intwrite(struct super_block *sb)
1612 {
1613         __sb_start_write(sb, SB_FREEZE_FS, true);
1614 }
1615
1616 static inline int sb_start_intwrite_trylock(struct super_block *sb)
1617 {
1618         return __sb_start_write(sb, SB_FREEZE_FS, false);
1619 }
1620
1621
1622 extern bool inode_owner_or_capable(const struct inode *inode);
1623
1624 /*
1625  * VFS helper functions..
1626  */
1627 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1628 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1629 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1630 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1631 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1632 extern int vfs_rmdir(struct inode *, struct dentry *);
1633 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1634 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1635 extern int vfs_whiteout(struct inode *, struct dentry *);
1636
1637 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1638                                   int open_flag);
1639
1640 int vfs_mkobj(struct dentry *, umode_t,
1641                 int (*f)(struct dentry *, umode_t, void *),
1642                 void *);
1643
1644 extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1645
1646 /*
1647  * VFS file helper functions.
1648  */
1649 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1650                         umode_t mode);
1651 extern bool may_open_dev(const struct path *path);
1652 /*
1653  * VFS FS_IOC_FIEMAP helper definitions.
1654  */
1655 struct fiemap_extent_info {
1656         unsigned int fi_flags;          /* Flags as passed from user */
1657         unsigned int fi_extents_mapped; /* Number of mapped extents */
1658         unsigned int fi_extents_max;    /* Size of fiemap_extent array */
1659         struct fiemap_extent __user *fi_extents_start; /* Start of
1660                                                         fiemap_extent array */
1661 };
1662 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1663                             u64 phys, u64 len, u32 flags);
1664 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1665
1666 /*
1667  * File types
1668  *
1669  * NOTE! These match bits 12..15 of stat.st_mode
1670  * (ie "(i_mode >> 12) & 15").
1671  */
1672 #define DT_UNKNOWN      0
1673 #define DT_FIFO         1
1674 #define DT_CHR          2
1675 #define DT_DIR          4
1676 #define DT_BLK          6
1677 #define DT_REG          8
1678 #define DT_LNK          10
1679 #define DT_SOCK         12
1680 #define DT_WHT          14
1681
1682 /*
1683  * This is the "filldir" function type, used by readdir() to let
1684  * the kernel specify what kind of dirent layout it wants to have.
1685  * This allows the kernel to read directories into kernel space or
1686  * to have different dirent layouts depending on the binary type.
1687  */
1688 struct dir_context;
1689 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1690                          unsigned);
1691
1692 struct dir_context {
1693         filldir_t actor;
1694         loff_t pos;
1695 };
1696
1697 struct block_device_operations;
1698
1699 /* These macros are for out of kernel modules to test that
1700  * the kernel supports the unlocked_ioctl and compat_ioctl
1701  * fields in struct file_operations. */
1702 #define HAVE_COMPAT_IOCTL 1
1703 #define HAVE_UNLOCKED_IOCTL 1
1704
1705 /*
1706  * These flags let !MMU mmap() govern direct device mapping vs immediate
1707  * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1708  *
1709  * NOMMU_MAP_COPY:      Copy can be mapped (MAP_PRIVATE)
1710  * NOMMU_MAP_DIRECT:    Can be mapped directly (MAP_SHARED)
1711  * NOMMU_MAP_READ:      Can be mapped for reading
1712  * NOMMU_MAP_WRITE:     Can be mapped for writing
1713  * NOMMU_MAP_EXEC:      Can be mapped for execution
1714  */
1715 #define NOMMU_MAP_COPY          0x00000001
1716 #define NOMMU_MAP_DIRECT        0x00000008
1717 #define NOMMU_MAP_READ          VM_MAYREAD
1718 #define NOMMU_MAP_WRITE         VM_MAYWRITE
1719 #define NOMMU_MAP_EXEC          VM_MAYEXEC
1720
1721 #define NOMMU_VMFLAGS \
1722         (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1723
1724
1725 struct iov_iter;
1726
1727 struct file_operations {
1728         struct module *owner;
1729         loff_t (*llseek) (struct file *, loff_t, int);
1730         ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1731         ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1732         ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1733         ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1734         int (*iterate) (struct file *, struct dir_context *);
1735         int (*iterate_shared) (struct file *, struct dir_context *);
1736         __poll_t (*poll) (struct file *, struct poll_table_struct *);
1737         long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1738         long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1739         int (*mmap) (struct file *, struct vm_area_struct *);
1740         unsigned long mmap_supported_flags;
1741         int (*open) (struct inode *, struct file *);
1742         int (*flush) (struct file *, fl_owner_t id);
1743         int (*release) (struct inode *, struct file *);
1744         int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1745         int (*fasync) (int, struct file *, int);
1746         int (*lock) (struct file *, int, struct file_lock *);
1747         ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1748         unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1749         int (*check_flags)(int);
1750         int (*flock) (struct file *, int, struct file_lock *);
1751         ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1752         ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1753         int (*setlease)(struct file *, long, struct file_lock **, void **);
1754         long (*fallocate)(struct file *file, int mode, loff_t offset,
1755                           loff_t len);
1756         void (*show_fdinfo)(struct seq_file *m, struct file *f);
1757 #ifndef CONFIG_MMU
1758         unsigned (*mmap_capabilities)(struct file *);
1759 #endif
1760         ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1761                         loff_t, size_t, unsigned int);
1762         int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1763                         u64);
1764         int (*dedupe_file_range)(struct file *, loff_t, struct file *, loff_t,
1765                         u64);
1766         int (*fadvise)(struct file *, loff_t, loff_t, int);
1767 } __randomize_layout;
1768
1769 struct inode_operations {
1770         struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1771         const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1772         int (*permission) (struct inode *, int);
1773         struct posix_acl * (*get_acl)(struct inode *, int);
1774
1775         int (*readlink) (struct dentry *, char __user *,int);
1776
1777         int (*create) (struct inode *,struct dentry *, umode_t, bool);
1778         int (*link) (struct dentry *,struct inode *,struct dentry *);
1779         int (*unlink) (struct inode *,struct dentry *);
1780         int (*symlink) (struct inode *,struct dentry *,const char *);
1781         int (*mkdir) (struct inode *,struct dentry *,umode_t);
1782         int (*rmdir) (struct inode *,struct dentry *);
1783         int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1784         int (*rename) (struct inode *, struct dentry *,
1785                         struct inode *, struct dentry *, unsigned int);
1786         int (*setattr) (struct dentry *, struct iattr *);
1787         int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1788         ssize_t (*listxattr) (struct dentry *, char *, size_t);
1789         int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1790                       u64 len);
1791         int (*update_time)(struct inode *, struct timespec64 *, int);
1792         int (*atomic_open)(struct inode *, struct dentry *,
1793                            struct file *, unsigned open_flag,
1794                            umode_t create_mode);
1795         int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1796         int (*set_acl)(struct inode *, struct posix_acl *, int);
1797 } ____cacheline_aligned;
1798
1799 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1800                                      struct iov_iter *iter)
1801 {
1802         return file->f_op->read_iter(kio, iter);
1803 }
1804
1805 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1806                                       struct iov_iter *iter)
1807 {
1808         return file->f_op->write_iter(kio, iter);
1809 }
1810
1811 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1812 {
1813         return file->f_op->mmap(file, vma);
1814 }
1815
1816 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1817                               unsigned long nr_segs, unsigned long fast_segs,
1818                               struct iovec *fast_pointer,
1819                               struct iovec **ret_pointer);
1820
1821 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1822 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1823 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1824 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1825                 unsigned long, loff_t *, rwf_t);
1826 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1827                                    loff_t, size_t, unsigned int);
1828 extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1829                                       struct inode *inode_out, loff_t pos_out,
1830                                       u64 *len, bool is_dedupe);
1831 extern int do_clone_file_range(struct file *file_in, loff_t pos_in,
1832                                struct file *file_out, loff_t pos_out, u64 len);
1833 extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1834                                 struct file *file_out, loff_t pos_out, u64 len);
1835 extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1836                                          struct inode *dest, loff_t destoff,
1837                                          loff_t len, bool *is_same);
1838 extern int vfs_dedupe_file_range(struct file *file,
1839                                  struct file_dedupe_range *same);
1840 extern int vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1841                                      struct file *dst_file, loff_t dst_pos,
1842                                      u64 len);
1843
1844
1845 struct super_operations {
1846         struct inode *(*alloc_inode)(struct super_block *sb);
1847         void (*destroy_inode)(struct inode *);
1848
1849         void (*dirty_inode) (struct inode *, int flags);
1850         int (*write_inode) (struct inode *, struct writeback_control *wbc);
1851         int (*drop_inode) (struct inode *);
1852         void (*evict_inode) (struct inode *);
1853         void (*put_super) (struct super_block *);
1854         int (*sync_fs)(struct super_block *sb, int wait);
1855         int (*freeze_super) (struct super_block *);
1856         int (*freeze_fs) (struct super_block *);
1857         int (*thaw_super) (struct super_block *);
1858         int (*unfreeze_fs) (struct super_block *);
1859         int (*statfs) (struct dentry *, struct kstatfs *);
1860         int (*remount_fs) (struct super_block *, int *, char *);
1861         void (*umount_begin) (struct super_block *);
1862
1863         int (*show_options)(struct seq_file *, struct dentry *);
1864         int (*show_devname)(struct seq_file *, struct dentry *);
1865         int (*show_path)(struct seq_file *, struct dentry *);
1866         int (*show_stats)(struct seq_file *, struct dentry *);
1867 #ifdef CONFIG_QUOTA
1868         ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1869         ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1870         struct dquot **(*get_dquots)(struct inode *);
1871 #endif
1872         int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1873         long (*nr_cached_objects)(struct super_block *,
1874                                   struct shrink_control *);
1875         long (*free_cached_objects)(struct super_block *,
1876                                     struct shrink_control *);
1877 };
1878
1879 /*
1880  * Inode flags - they have no relation to superblock flags now
1881  */
1882 #define S_SYNC          1       /* Writes are synced at once */
1883 #define S_NOATIME       2       /* Do not update access times */
1884 #define S_APPEND        4       /* Append-only file */
1885 #define S_IMMUTABLE     8       /* Immutable file */
1886 #define S_DEAD          16      /* removed, but still open directory */
1887 #define S_NOQUOTA       32      /* Inode is not counted to quota */
1888 #define S_DIRSYNC       64      /* Directory modifications are synchronous */
1889 #define S_NOCMTIME      128     /* Do not update file c/mtime */
1890 #define S_SWAPFILE      256     /* Do not truncate: swapon got its bmaps */
1891 #define S_PRIVATE       512     /* Inode is fs-internal */
1892 #define S_IMA           1024    /* Inode has an associated IMA struct */
1893 #define S_AUTOMOUNT     2048    /* Automount/referral quasi-directory */
1894 #define S_NOSEC         4096    /* no suid or xattr security attributes */
1895 #ifdef CONFIG_FS_DAX
1896 #define S_DAX           8192    /* Direct Access, avoiding the page cache */
1897 #else
1898 #define S_DAX           0       /* Make all the DAX code disappear */
1899 #endif
1900 #define S_ENCRYPTED     16384   /* Encrypted file (using fs/crypto/) */
1901
1902 /*
1903  * Note that nosuid etc flags are inode-specific: setting some file-system
1904  * flags just means all the inodes inherit those flags by default. It might be
1905  * possible to override it selectively if you really wanted to with some
1906  * ioctl() that is not currently implemented.
1907  *
1908  * Exception: SB_RDONLY is always applied to the entire file system.
1909  *
1910  * Unfortunately, it is possible to change a filesystems flags with it mounted
1911  * with files in use.  This means that all of the inodes will not have their
1912  * i_flags updated.  Hence, i_flags no longer inherit the superblock mount
1913  * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1914  */
1915 #define __IS_FLG(inode, flg)    ((inode)->i_sb->s_flags & (flg))
1916
1917 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
1918 #define IS_RDONLY(inode)        sb_rdonly((inode)->i_sb)
1919 #define IS_SYNC(inode)          (__IS_FLG(inode, SB_SYNCHRONOUS) || \
1920                                         ((inode)->i_flags & S_SYNC))
1921 #define IS_DIRSYNC(inode)       (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
1922                                         ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1923 #define IS_MANDLOCK(inode)      __IS_FLG(inode, SB_MANDLOCK)
1924 #define IS_NOATIME(inode)       __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1925 #define IS_I_VERSION(inode)     __IS_FLG(inode, SB_I_VERSION)
1926
1927 #define IS_NOQUOTA(inode)       ((inode)->i_flags & S_NOQUOTA)
1928 #define IS_APPEND(inode)        ((inode)->i_flags & S_APPEND)
1929 #define IS_IMMUTABLE(inode)     ((inode)->i_flags & S_IMMUTABLE)
1930 #define IS_POSIXACL(inode)      __IS_FLG(inode, SB_POSIXACL)
1931
1932 #define IS_DEADDIR(inode)       ((inode)->i_flags & S_DEAD)
1933 #define IS_NOCMTIME(inode)      ((inode)->i_flags & S_NOCMTIME)
1934 #define IS_SWAPFILE(inode)      ((inode)->i_flags & S_SWAPFILE)
1935 #define IS_PRIVATE(inode)       ((inode)->i_flags & S_PRIVATE)
1936 #define IS_IMA(inode)           ((inode)->i_flags & S_IMA)
1937 #define IS_AUTOMOUNT(inode)     ((inode)->i_flags & S_AUTOMOUNT)
1938 #define IS_NOSEC(inode)         ((inode)->i_flags & S_NOSEC)
1939 #define IS_DAX(inode)           ((inode)->i_flags & S_DAX)
1940 #define IS_ENCRYPTED(inode)     ((inode)->i_flags & S_ENCRYPTED)
1941
1942 #define IS_WHITEOUT(inode)      (S_ISCHR(inode->i_mode) && \
1943                                  (inode)->i_rdev == WHITEOUT_DEV)
1944
1945 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1946 {
1947         return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1948 }
1949
1950 static inline enum rw_hint file_write_hint(struct file *file)
1951 {
1952         if (file->f_write_hint != WRITE_LIFE_NOT_SET)
1953                 return file->f_write_hint;
1954
1955         return file_inode(file)->i_write_hint;
1956 }
1957
1958 static inline int iocb_flags(struct file *file);
1959
1960 static inline u16 ki_hint_validate(enum rw_hint hint)
1961 {
1962         typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
1963
1964         if (hint <= max_hint)
1965                 return hint;
1966         return 0;
1967 }
1968
1969 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
1970 {
1971         *kiocb = (struct kiocb) {
1972                 .ki_filp = filp,
1973                 .ki_flags = iocb_flags(filp),
1974                 .ki_hint = ki_hint_validate(file_write_hint(filp)),
1975                 .ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0),
1976         };
1977 }
1978
1979 /*
1980  * Inode state bits.  Protected by inode->i_lock
1981  *
1982  * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1983  * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1984  *
1985  * Four bits define the lifetime of an inode.  Initially, inodes are I_NEW,
1986  * until that flag is cleared.  I_WILL_FREE, I_FREEING and I_CLEAR are set at
1987  * various stages of removing an inode.
1988  *
1989  * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1990  *
1991  * I_DIRTY_SYNC         Inode is dirty, but doesn't have to be written on
1992  *                      fdatasync().  i_atime is the usual cause.
1993  * I_DIRTY_DATASYNC     Data-related inode changes pending. We keep track of
1994  *                      these changes separately from I_DIRTY_SYNC so that we
1995  *                      don't have to write inode on fdatasync() when only
1996  *                      mtime has changed in it.
1997  * I_DIRTY_PAGES        Inode has dirty pages.  Inode itself may be clean.
1998  * I_NEW                Serves as both a mutex and completion notification.
1999  *                      New inodes set I_NEW.  If two processes both create
2000  *                      the same inode, one of them will release its inode and
2001  *                      wait for I_NEW to be released before returning.
2002  *                      Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2003  *                      also cause waiting on I_NEW, without I_NEW actually
2004  *                      being set.  find_inode() uses this to prevent returning
2005  *                      nearly-dead inodes.
2006  * I_WILL_FREE          Must be set when calling write_inode_now() if i_count
2007  *                      is zero.  I_FREEING must be set when I_WILL_FREE is
2008  *                      cleared.
2009  * I_FREEING            Set when inode is about to be freed but still has dirty
2010  *                      pages or buffers attached or the inode itself is still
2011  *                      dirty.
2012  * I_CLEAR              Added by clear_inode().  In this state the inode is
2013  *                      clean and can be destroyed.  Inode keeps I_FREEING.
2014  *
2015  *                      Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2016  *                      prohibited for many purposes.  iget() must wait for
2017  *                      the inode to be completely released, then create it
2018  *                      anew.  Other functions will just ignore such inodes,
2019  *                      if appropriate.  I_NEW is used for waiting.
2020  *
2021  * I_SYNC               Writeback of inode is running. The bit is set during
2022  *                      data writeback, and cleared with a wakeup on the bit
2023  *                      address once it is done. The bit is also used to pin
2024  *                      the inode in memory for flusher thread.
2025  *
2026  * I_REFERENCED         Marks the inode as recently references on the LRU list.
2027  *
2028  * I_DIO_WAKEUP         Never set.  Only used as a key for wait_on_bit().
2029  *
2030  * I_WB_SWITCH          Cgroup bdi_writeback switching in progress.  Used to
2031  *                      synchronize competing switching instances and to tell
2032  *                      wb stat updates to grab the i_pages lock.  See
2033  *                      inode_switch_wb_work_fn() for details.
2034  *
2035  * I_OVL_INUSE          Used by overlayfs to get exclusive ownership on upper
2036  *                      and work dirs among overlayfs mounts.
2037  *
2038  * I_CREATING           New object's inode in the middle of setting up.
2039  *
2040  * Q: What is the difference between I_WILL_FREE and I_FREEING?
2041  */
2042 #define I_DIRTY_SYNC            (1 << 0)
2043 #define I_DIRTY_DATASYNC        (1 << 1)
2044 #define I_DIRTY_PAGES           (1 << 2)
2045 #define __I_NEW                 3
2046 #define I_NEW                   (1 << __I_NEW)
2047 #define I_WILL_FREE             (1 << 4)
2048 #define I_FREEING               (1 << 5)
2049 #define I_CLEAR                 (1 << 6)
2050 #define __I_SYNC                7
2051 #define I_SYNC                  (1 << __I_SYNC)
2052 #define I_REFERENCED            (1 << 8)
2053 #define __I_DIO_WAKEUP          9
2054 #define I_DIO_WAKEUP            (1 << __I_DIO_WAKEUP)
2055 #define I_LINKABLE              (1 << 10)
2056 #define I_DIRTY_TIME            (1 << 11)
2057 #define __I_DIRTY_TIME_EXPIRED  12
2058 #define I_DIRTY_TIME_EXPIRED    (1 << __I_DIRTY_TIME_EXPIRED)
2059 #define I_WB_SWITCH             (1 << 13)
2060 #define I_OVL_INUSE             (1 << 14)
2061 #define I_CREATING              (1 << 15)
2062
2063 #define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2064 #define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2065 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
2066
2067 extern void __mark_inode_dirty(struct inode *, int);
2068 static inline void mark_inode_dirty(struct inode *inode)
2069 {
2070         __mark_inode_dirty(inode, I_DIRTY);
2071 }
2072
2073 static inline void mark_inode_dirty_sync(struct inode *inode)
2074 {
2075         __mark_inode_dirty(inode, I_DIRTY_SYNC);
2076 }
2077
2078 extern void inc_nlink(struct inode *inode);
2079 extern void drop_nlink(struct inode *inode);
2080 extern void clear_nlink(struct inode *inode);
2081 extern void set_nlink(struct inode *inode, unsigned int nlink);
2082
2083 static inline void inode_inc_link_count(struct inode *inode)
2084 {
2085         inc_nlink(inode);
2086         mark_inode_dirty(inode);
2087 }
2088
2089 static inline void inode_dec_link_count(struct inode *inode)
2090 {
2091         drop_nlink(inode);
2092         mark_inode_dirty(inode);
2093 }
2094
2095 enum file_time_flags {
2096         S_ATIME = 1,
2097         S_MTIME = 2,
2098         S_CTIME = 4,
2099         S_VERSION = 8,
2100 };
2101
2102 extern bool atime_needs_update(const struct path *, struct inode *);
2103 extern void touch_atime(const struct path *);
2104 static inline void file_accessed(struct file *file)
2105 {
2106         if (!(file->f_flags & O_NOATIME))
2107                 touch_atime(&file->f_path);
2108 }
2109
2110 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2111 int sync_inode_metadata(struct inode *inode, int wait);
2112
2113 struct file_system_type {
2114         const char *name;
2115         int fs_flags;
2116 #define FS_REQUIRES_DEV         1 
2117 #define FS_BINARY_MOUNTDATA     2
2118 #define FS_HAS_SUBTYPE          4
2119 #define FS_USERNS_MOUNT         8       /* Can be mounted by userns root */
2120 #define FS_RENAME_DOES_D_MOVE   32768   /* FS will handle d_move() during rename() internally. */
2121         struct dentry *(*mount) (struct file_system_type *, int,
2122                        const char *, void *);
2123         void (*kill_sb) (struct super_block *);
2124         struct module *owner;
2125         struct file_system_type * next;
2126         struct hlist_head fs_supers;
2127
2128         struct lock_class_key s_lock_key;
2129         struct lock_class_key s_umount_key;
2130         struct lock_class_key s_vfs_rename_key;
2131         struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2132
2133         struct lock_class_key i_lock_key;
2134         struct lock_class_key i_mutex_key;
2135         struct lock_class_key i_mutex_dir_key;
2136 };
2137
2138 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2139
2140 extern struct dentry *mount_ns(struct file_system_type *fs_type,
2141         int flags, void *data, void *ns, struct user_namespace *user_ns,
2142         int (*fill_super)(struct super_block *, void *, int));
2143 #ifdef CONFIG_BLOCK
2144 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2145         int flags, const char *dev_name, void *data,
2146         int (*fill_super)(struct super_block *, void *, int));
2147 #else
2148 static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2149         int flags, const char *dev_name, void *data,
2150         int (*fill_super)(struct super_block *, void *, int))
2151 {
2152         return ERR_PTR(-ENODEV);
2153 }
2154 #endif
2155 extern struct dentry *mount_single(struct file_system_type *fs_type,
2156         int flags, void *data,
2157         int (*fill_super)(struct super_block *, void *, int));
2158 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2159         int flags, void *data,
2160         int (*fill_super)(struct super_block *, void *, int));
2161 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2162 void generic_shutdown_super(struct super_block *sb);
2163 #ifdef CONFIG_BLOCK
2164 void kill_block_super(struct super_block *sb);
2165 #else
2166 static inline void kill_block_super(struct super_block *sb)
2167 {
2168         BUG();
2169 }
2170 #endif
2171 void kill_anon_super(struct super_block *sb);
2172 void kill_litter_super(struct super_block *sb);
2173 void deactivate_super(struct super_block *sb);
2174 void deactivate_locked_super(struct super_block *sb);
2175 int set_anon_super(struct super_block *s, void *data);
2176 int get_anon_bdev(dev_t *);
2177 void free_anon_bdev(dev_t);
2178 struct super_block *sget_userns(struct file_system_type *type,
2179                         int (*test)(struct super_block *,void *),
2180                         int (*set)(struct super_block *,void *),
2181                         int flags, struct user_namespace *user_ns,
2182                         void *data);
2183 struct super_block *sget(struct file_system_type *type,
2184                         int (*test)(struct super_block *,void *),
2185                         int (*set)(struct super_block *,void *),
2186                         int flags, void *data);
2187 extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2188                                          const struct super_operations *ops,
2189                                          const struct xattr_handler **xattr,
2190                                          const struct dentry_operations *dops,
2191                                          unsigned long);
2192
2193 static inline struct dentry *
2194 mount_pseudo(struct file_system_type *fs_type, char *name,
2195              const struct super_operations *ops,
2196              const struct dentry_operations *dops, unsigned long magic)
2197 {
2198         return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2199 }
2200
2201 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2202 #define fops_get(fops) \
2203         (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2204 #define fops_put(fops) \
2205         do { if (fops) module_put((fops)->owner); } while(0)
2206 /*
2207  * This one is to be used *ONLY* from ->open() instances.
2208  * fops must be non-NULL, pinned down *and* module dependencies
2209  * should be sufficient to pin the caller down as well.
2210  */
2211 #define replace_fops(f, fops) \
2212         do {    \
2213                 struct file *__file = (f); \
2214                 fops_put(__file->f_op); \
2215                 BUG_ON(!(__file->f_op = (fops))); \
2216         } while(0)
2217
2218 extern int register_filesystem(struct file_system_type *);
2219 extern int unregister_filesystem(struct file_system_type *);
2220 extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2221 #define kern_mount(type) kern_mount_data(type, NULL)
2222 extern void kern_unmount(struct vfsmount *mnt);
2223 extern int may_umount_tree(struct vfsmount *);
2224 extern int may_umount(struct vfsmount *);
2225 extern long do_mount(const char *, const char __user *,
2226                      const char *, unsigned long, void *);
2227 extern struct vfsmount *collect_mounts(const struct path *);
2228 extern void drop_collected_mounts(struct vfsmount *);
2229 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2230                           struct vfsmount *);
2231 extern int vfs_statfs(const struct path *, struct kstatfs *);
2232 extern int user_statfs(const char __user *, struct kstatfs *);
2233 extern int fd_statfs(int, struct kstatfs *);
2234 extern int freeze_super(struct super_block *super);
2235 extern int thaw_super(struct super_block *super);
2236 extern bool our_mnt(struct vfsmount *mnt);
2237 extern __printf(2, 3)
2238 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2239 extern int super_setup_bdi(struct super_block *sb);
2240
2241 extern int current_umask(void);
2242
2243 extern void ihold(struct inode * inode);
2244 extern void iput(struct inode *);
2245 extern int generic_update_time(struct inode *, struct timespec64 *, int);
2246
2247 /* /sys/fs */
2248 extern struct kobject *fs_kobj;
2249
2250 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2251
2252 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2253 extern int locks_mandatory_locked(struct file *);
2254 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2255
2256 /*
2257  * Candidates for mandatory locking have the setgid bit set
2258  * but no group execute bit -  an otherwise meaningless combination.
2259  */
2260
2261 static inline int __mandatory_lock(struct inode *ino)
2262 {
2263         return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2264 }
2265
2266 /*
2267  * ... and these candidates should be on SB_MANDLOCK mounted fs,
2268  * otherwise these will be advisory locks
2269  */
2270
2271 static inline int mandatory_lock(struct inode *ino)
2272 {
2273         return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2274 }
2275
2276 static inline int locks_verify_locked(struct file *file)
2277 {
2278         if (mandatory_lock(locks_inode(file)))
2279                 return locks_mandatory_locked(file);
2280         return 0;
2281 }
2282
2283 static inline int locks_verify_truncate(struct inode *inode,
2284                                     struct file *f,
2285                                     loff_t size)
2286 {
2287         if (!inode->i_flctx || !mandatory_lock(inode))
2288                 return 0;
2289
2290         if (size < inode->i_size) {
2291                 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2292                                 F_WRLCK);
2293         } else {
2294                 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2295                                 F_WRLCK);
2296         }
2297 }
2298
2299 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2300
2301 static inline int locks_mandatory_locked(struct file *file)
2302 {
2303         return 0;
2304 }
2305
2306 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2307                                        loff_t start, loff_t end, unsigned char type)
2308 {
2309         return 0;
2310 }
2311
2312 static inline int __mandatory_lock(struct inode *inode)
2313 {
2314         return 0;
2315 }
2316
2317 static inline int mandatory_lock(struct inode *inode)
2318 {
2319         return 0;
2320 }
2321
2322 static inline int locks_verify_locked(struct file *file)
2323 {
2324         return 0;
2325 }
2326
2327 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2328                                         size_t size)
2329 {
2330         return 0;
2331 }
2332
2333 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2334
2335
2336 #ifdef CONFIG_FILE_LOCKING
2337 static inline int break_lease(struct inode *inode, unsigned int mode)
2338 {
2339         /*
2340          * Since this check is lockless, we must ensure that any refcounts
2341          * taken are done before checking i_flctx->flc_lease. Otherwise, we
2342          * could end up racing with tasks trying to set a new lease on this
2343          * file.
2344          */
2345         smp_mb();
2346         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2347                 return __break_lease(inode, mode, FL_LEASE);
2348         return 0;
2349 }
2350
2351 static inline int break_deleg(struct inode *inode, unsigned int mode)
2352 {
2353         /*
2354          * Since this check is lockless, we must ensure that any refcounts
2355          * taken are done before checking i_flctx->flc_lease. Otherwise, we
2356          * could end up racing with tasks trying to set a new lease on this
2357          * file.
2358          */
2359         smp_mb();
2360         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2361                 return __break_lease(inode, mode, FL_DELEG);
2362         return 0;
2363 }
2364
2365 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2366 {
2367         int ret;
2368
2369         ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2370         if (ret == -EWOULDBLOCK && delegated_inode) {
2371                 *delegated_inode = inode;
2372                 ihold(inode);
2373         }
2374         return ret;
2375 }
2376
2377 static inline int break_deleg_wait(struct inode **delegated_inode)
2378 {
2379         int ret;
2380
2381         ret = break_deleg(*delegated_inode, O_WRONLY);
2382         iput(*delegated_inode);
2383         *delegated_inode = NULL;
2384         return ret;
2385 }
2386
2387 static inline int break_layout(struct inode *inode, bool wait)
2388 {
2389         smp_mb();
2390         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2391                 return __break_lease(inode,
2392                                 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2393                                 FL_LAYOUT);
2394         return 0;
2395 }
2396
2397 #else /* !CONFIG_FILE_LOCKING */
2398 static inline int break_lease(struct inode *inode, unsigned int mode)
2399 {
2400         return 0;
2401 }
2402
2403 static inline int break_deleg(struct inode *inode, unsigned int mode)
2404 {
2405         return 0;
2406 }
2407
2408 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2409 {
2410         return 0;
2411 }
2412
2413 static inline int break_deleg_wait(struct inode **delegated_inode)
2414 {
2415         BUG();
2416         return 0;
2417 }
2418
2419 static inline int break_layout(struct inode *inode, bool wait)
2420 {
2421         return 0;
2422 }
2423
2424 #endif /* CONFIG_FILE_LOCKING */
2425
2426 /* fs/open.c */
2427 struct audit_names;
2428 struct filename {
2429         const char              *name;  /* pointer to actual string */
2430         const __user char       *uptr;  /* original userland pointer */
2431         int                     refcnt;
2432         struct audit_names      *aname;
2433         const char              iname[];
2434 };
2435
2436 extern long vfs_truncate(const struct path *, loff_t);
2437 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2438                        struct file *filp);
2439 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2440                         loff_t len);
2441 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2442                         umode_t mode);
2443 extern struct file *file_open_name(struct filename *, int, umode_t);
2444 extern struct file *filp_open(const char *, int, umode_t);
2445 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2446                                    const char *, int, umode_t);
2447 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2448 extern struct file * open_with_fake_path(const struct path *, int,
2449                                          struct inode*, const struct cred *);
2450 static inline struct file *file_clone_open(struct file *file)
2451 {
2452         return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2453 }
2454 extern int filp_close(struct file *, fl_owner_t id);
2455
2456 extern struct filename *getname_flags(const char __user *, int, int *);
2457 extern struct filename *getname(const char __user *);
2458 extern struct filename *getname_kernel(const char *);
2459 extern void putname(struct filename *name);
2460
2461 extern int finish_open(struct file *file, struct dentry *dentry,
2462                         int (*open)(struct inode *, struct file *));
2463 extern int finish_no_open(struct file *file, struct dentry *dentry);
2464
2465 /* fs/ioctl.c */
2466
2467 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2468
2469 /* fs/dcache.c */
2470 extern void __init vfs_caches_init_early(void);
2471 extern void __init vfs_caches_init(void);
2472
2473 extern struct kmem_cache *names_cachep;
2474
2475 #define __getname()             kmem_cache_alloc(names_cachep, GFP_KERNEL)
2476 #define __putname(name)         kmem_cache_free(names_cachep, (void *)(name))
2477
2478 #ifdef CONFIG_BLOCK
2479 extern int register_blkdev(unsigned int, const char *);
2480 extern void unregister_blkdev(unsigned int, const char *);
2481 extern void bdev_unhash_inode(dev_t dev);
2482 extern struct block_device *bdget(dev_t);
2483 extern struct block_device *bdgrab(struct block_device *bdev);
2484 extern void bd_set_size(struct block_device *, loff_t size);
2485 extern void bd_forget(struct inode *inode);
2486 extern void bdput(struct block_device *);
2487 extern void invalidate_bdev(struct block_device *);
2488 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
2489 extern int sync_blockdev(struct block_device *bdev);
2490 extern void kill_bdev(struct block_device *);
2491 extern struct super_block *freeze_bdev(struct block_device *);
2492 extern void emergency_thaw_all(void);
2493 extern void emergency_thaw_bdev(struct super_block *sb);
2494 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2495 extern int fsync_bdev(struct block_device *);
2496
2497 extern struct super_block *blockdev_superblock;
2498
2499 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2500 {
2501         return sb == blockdev_superblock;
2502 }
2503 #else
2504 static inline void bd_forget(struct inode *inode) {}
2505 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2506 static inline void kill_bdev(struct block_device *bdev) {}
2507 static inline void invalidate_bdev(struct block_device *bdev) {}
2508
2509 static inline struct super_block *freeze_bdev(struct block_device *sb)
2510 {
2511         return NULL;
2512 }
2513
2514 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2515 {
2516         return 0;
2517 }
2518
2519 static inline int emergency_thaw_bdev(struct super_block *sb)
2520 {
2521         return 0;
2522 }
2523
2524 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2525 {
2526 }
2527
2528 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2529 {
2530         return false;
2531 }
2532 #endif
2533 extern int sync_filesystem(struct super_block *);
2534 extern const struct file_operations def_blk_fops;
2535 extern const struct file_operations def_chr_fops;
2536 #ifdef CONFIG_BLOCK
2537 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2538 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2539 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2540 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2541 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2542                                                void *holder);
2543 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2544                                               void *holder);
2545 extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2546 extern int __blkdev_reread_part(struct block_device *bdev);
2547 extern int blkdev_reread_part(struct block_device *bdev);
2548
2549 #ifdef CONFIG_SYSFS
2550 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2551 extern void bd_unlink_disk_holder(struct block_device *bdev,
2552                                   struct gendisk *disk);
2553 #else
2554 static inline int bd_link_disk_holder(struct block_device *bdev,
2555                                       struct gendisk *disk)
2556 {
2557         return 0;
2558 }
2559 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2560                                          struct gendisk *disk)
2561 {
2562 }
2563 #endif
2564 #endif
2565
2566 /* fs/char_dev.c */
2567 #define CHRDEV_MAJOR_MAX 512
2568 /* Marks the bottom of the first segment of free char majors */
2569 #define CHRDEV_MAJOR_DYN_END 234
2570 /* Marks the top and bottom of the second segment of free char majors */
2571 #define CHRDEV_MAJOR_DYN_EXT_START 511
2572 #define CHRDEV_MAJOR_DYN_EXT_END 384
2573
2574 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2575 extern int register_chrdev_region(dev_t, unsigned, const char *);
2576 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2577                              unsigned int count, const char *name,
2578                              const struct file_operations *fops);
2579 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2580                                 unsigned int count, const char *name);
2581 extern void unregister_chrdev_region(dev_t, unsigned);
2582 extern void chrdev_show(struct seq_file *,off_t);
2583
2584 static inline int register_chrdev(unsigned int major, const char *name,
2585                                   const struct file_operations *fops)
2586 {
2587         return __register_chrdev(major, 0, 256, name, fops);
2588 }
2589
2590 static inline void unregister_chrdev(unsigned int major, const char *name)
2591 {
2592         __unregister_chrdev(major, 0, 256, name);
2593 }
2594
2595 /* fs/block_dev.c */
2596 #define BDEVNAME_SIZE   32      /* Largest string for a blockdev identifier */
2597 #define BDEVT_SIZE      10      /* Largest string for MAJ:MIN for blkdev */
2598
2599 #ifdef CONFIG_BLOCK
2600 #define BLKDEV_MAJOR_MAX        512
2601 extern const char *__bdevname(dev_t, char *buffer);
2602 extern const char *bdevname(struct block_device *bdev, char *buffer);
2603 extern struct block_device *lookup_bdev(const char *);
2604 extern void blkdev_show(struct seq_file *,off_t);
2605
2606 #else
2607 #define BLKDEV_MAJOR_MAX        0
2608 #endif
2609
2610 extern void init_special_inode(struct inode *, umode_t, dev_t);
2611
2612 /* Invalid inode operations -- fs/bad_inode.c */
2613 extern void make_bad_inode(struct inode *);
2614 extern bool is_bad_inode(struct inode *);
2615
2616 #ifdef CONFIG_BLOCK
2617 extern void check_disk_size_change(struct gendisk *disk,
2618                 struct block_device *bdev, bool verbose);
2619 extern int revalidate_disk(struct gendisk *);
2620 extern int check_disk_change(struct block_device *);
2621 extern int __invalidate_device(struct block_device *, bool);
2622 extern int invalidate_partition(struct gendisk *, int);
2623 #endif
2624 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2625                                         pgoff_t start, pgoff_t end);
2626
2627 static inline void invalidate_remote_inode(struct inode *inode)
2628 {
2629         if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2630             S_ISLNK(inode->i_mode))
2631                 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2632 }
2633 extern int invalidate_inode_pages2(struct address_space *mapping);
2634 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2635                                          pgoff_t start, pgoff_t end);
2636 extern int write_inode_now(struct inode *, int);
2637 extern int filemap_fdatawrite(struct address_space *);
2638 extern int filemap_flush(struct address_space *);
2639 extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2640 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2641                                    loff_t lend);
2642
2643 static inline int filemap_fdatawait(struct address_space *mapping)
2644 {
2645         return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2646 }
2647
2648 extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2649                                   loff_t lend);
2650 extern int filemap_write_and_wait(struct address_space *mapping);
2651 extern int filemap_write_and_wait_range(struct address_space *mapping,
2652                                         loff_t lstart, loff_t lend);
2653 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2654                                 loff_t start, loff_t end, int sync_mode);
2655 extern int filemap_fdatawrite_range(struct address_space *mapping,
2656                                 loff_t start, loff_t end);
2657 extern int filemap_check_errors(struct address_space *mapping);
2658 extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2659
2660 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2661                                                 loff_t lend);
2662 extern int __must_check file_check_and_advance_wb_err(struct file *file);
2663 extern int __must_check file_write_and_wait_range(struct file *file,
2664                                                 loff_t start, loff_t end);
2665
2666 static inline int file_write_and_wait(struct file *file)
2667 {
2668         return file_write_and_wait_range(file, 0, LLONG_MAX);
2669 }
2670
2671 /**
2672  * filemap_set_wb_err - set a writeback error on an address_space
2673  * @mapping: mapping in which to set writeback error
2674  * @err: error to be set in mapping
2675  *
2676  * When writeback fails in some way, we must record that error so that
2677  * userspace can be informed when fsync and the like are called.  We endeavor
2678  * to report errors on any file that was open at the time of the error.  Some
2679  * internal callers also need to know when writeback errors have occurred.
2680  *
2681  * When a writeback error occurs, most filesystems will want to call
2682  * filemap_set_wb_err to record the error in the mapping so that it will be
2683  * automatically reported whenever fsync is called on the file.
2684  */
2685 static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2686 {
2687         /* Fastpath for common case of no error */
2688         if (unlikely(err))
2689                 __filemap_set_wb_err(mapping, err);
2690 }
2691
2692 /**
2693  * filemap_check_wb_error - has an error occurred since the mark was sampled?
2694  * @mapping: mapping to check for writeback errors
2695  * @since: previously-sampled errseq_t
2696  *
2697  * Grab the errseq_t value from the mapping, and see if it has changed "since"
2698  * the given value was sampled.
2699  *
2700  * If it has then report the latest error set, otherwise return 0.
2701  */
2702 static inline int filemap_check_wb_err(struct address_space *mapping,
2703                                         errseq_t since)
2704 {
2705         return errseq_check(&mapping->wb_err, since);
2706 }
2707
2708 /**
2709  * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2710  * @mapping: mapping to be sampled
2711  *
2712  * Writeback errors are always reported relative to a particular sample point
2713  * in the past. This function provides those sample points.
2714  */
2715 static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2716 {
2717         return errseq_sample(&mapping->wb_err);
2718 }
2719
2720 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2721                            int datasync);
2722 extern int vfs_fsync(struct file *file, int datasync);
2723
2724 /*
2725  * Sync the bytes written if this was a synchronous write.  Expect ki_pos
2726  * to already be updated for the write, and will return either the amount
2727  * of bytes passed in, or an error if syncing the file failed.
2728  */
2729 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2730 {
2731         if (iocb->ki_flags & IOCB_DSYNC) {
2732                 int ret = vfs_fsync_range(iocb->ki_filp,
2733                                 iocb->ki_pos - count, iocb->ki_pos - 1,
2734                                 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2735                 if (ret)
2736                         return ret;
2737         }
2738
2739         return count;
2740 }
2741
2742 extern void emergency_sync(void);
2743 extern void emergency_remount(void);
2744 #ifdef CONFIG_BLOCK
2745 extern sector_t bmap(struct inode *, sector_t);
2746 #endif
2747 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2748 extern int inode_permission(struct inode *, int);
2749 extern int generic_permission(struct inode *, int);
2750 extern int __check_sticky(struct inode *dir, struct inode *inode);
2751
2752 static inline bool execute_ok(struct inode *inode)
2753 {
2754         return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2755 }
2756
2757 static inline void file_start_write(struct file *file)
2758 {
2759         if (!S_ISREG(file_inode(file)->i_mode))
2760                 return;
2761         __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2762 }
2763
2764 static inline bool file_start_write_trylock(struct file *file)
2765 {
2766         if (!S_ISREG(file_inode(file)->i_mode))
2767                 return true;
2768         return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2769 }
2770
2771 static inline void file_end_write(struct file *file)
2772 {
2773         if (!S_ISREG(file_inode(file)->i_mode))
2774                 return;
2775         __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2776 }
2777
2778 /*
2779  * get_write_access() gets write permission for a file.
2780  * put_write_access() releases this write permission.
2781  * This is used for regular files.
2782  * We cannot support write (and maybe mmap read-write shared) accesses and
2783  * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2784  * can have the following values:
2785  * 0: no writers, no VM_DENYWRITE mappings
2786  * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2787  * > 0: (i_writecount) users are writing to the file.
2788  *
2789  * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2790  * except for the cases where we don't hold i_writecount yet. Then we need to
2791  * use {get,deny}_write_access() - these functions check the sign and refuse
2792  * to do the change if sign is wrong.
2793  */
2794 static inline int get_write_access(struct inode *inode)
2795 {
2796         return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2797 }
2798 static inline int deny_write_access(struct file *file)
2799 {
2800         struct inode *inode = file_inode(file);
2801         return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2802 }
2803 static inline void put_write_access(struct inode * inode)
2804 {
2805         atomic_dec(&inode->i_writecount);
2806 }
2807 static inline void allow_write_access(struct file *file)
2808 {
2809         if (file)
2810                 atomic_inc(&file_inode(file)->i_writecount);
2811 }
2812 static inline bool inode_is_open_for_write(const struct inode *inode)
2813 {
2814         return atomic_read(&inode->i_writecount) > 0;
2815 }
2816
2817 #ifdef CONFIG_IMA
2818 static inline void i_readcount_dec(struct inode *inode)
2819 {
2820         BUG_ON(!atomic_read(&inode->i_readcount));
2821         atomic_dec(&inode->i_readcount);
2822 }
2823 static inline void i_readcount_inc(struct inode *inode)
2824 {
2825         atomic_inc(&inode->i_readcount);
2826 }
2827 #else
2828 static inline void i_readcount_dec(struct inode *inode)
2829 {
2830         return;
2831 }
2832 static inline void i_readcount_inc(struct inode *inode)
2833 {
2834         return;
2835 }
2836 #endif
2837 extern int do_pipe_flags(int *, int);
2838
2839 #define __kernel_read_file_id(id) \
2840         id(UNKNOWN, unknown)            \
2841         id(FIRMWARE, firmware)          \
2842         id(FIRMWARE_PREALLOC_BUFFER, firmware)  \
2843         id(MODULE, kernel-module)               \
2844         id(KEXEC_IMAGE, kexec-image)            \
2845         id(KEXEC_INITRAMFS, kexec-initramfs)    \
2846         id(POLICY, security-policy)             \
2847         id(X509_CERTIFICATE, x509-certificate)  \
2848         id(MAX_ID, )
2849
2850 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2851 #define __fid_stringify(dummy, str) #str,
2852
2853 enum kernel_read_file_id {
2854         __kernel_read_file_id(__fid_enumify)
2855 };
2856
2857 static const char * const kernel_read_file_str[] = {
2858         __kernel_read_file_id(__fid_stringify)
2859 };
2860
2861 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2862 {
2863         if ((unsigned)id >= READING_MAX_ID)
2864                 return kernel_read_file_str[READING_UNKNOWN];
2865
2866         return kernel_read_file_str[id];
2867 }
2868
2869 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2870                             enum kernel_read_file_id);
2871 extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2872                                       enum kernel_read_file_id);
2873 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2874                                     enum kernel_read_file_id);
2875 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2876 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2877 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
2878 extern struct file * open_exec(const char *);
2879  
2880 /* fs/dcache.c -- generic fs support functions */
2881 extern bool is_subdir(struct dentry *, struct dentry *);
2882 extern bool path_is_under(const struct path *, const struct path *);
2883
2884 extern char *file_path(struct file *, char *, int);
2885
2886 #include <linux/err.h>
2887
2888 /* needed for stackable file system support */
2889 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2890
2891 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2892
2893 extern int inode_init_always(struct super_block *, struct inode *);
2894 extern void inode_init_once(struct inode *);
2895 extern void address_space_init_once(struct address_space *mapping);
2896 extern struct inode * igrab(struct inode *);
2897 extern ino_t iunique(struct super_block *, ino_t);
2898 extern int inode_needs_sync(struct inode *inode);
2899 extern int generic_delete_inode(struct inode *inode);
2900 static inline int generic_drop_inode(struct inode *inode)
2901 {
2902         return !inode->i_nlink || inode_unhashed(inode);
2903 }
2904
2905 extern struct inode *ilookup5_nowait(struct super_block *sb,
2906                 unsigned long hashval, int (*test)(struct inode *, void *),
2907                 void *data);
2908 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2909                 int (*test)(struct inode *, void *), void *data);
2910 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2911
2912 extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2913                 int (*test)(struct inode *, void *),
2914                 int (*set)(struct inode *, void *),
2915                 void *data);
2916 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2917 extern struct inode * iget_locked(struct super_block *, unsigned long);
2918 extern struct inode *find_inode_nowait(struct super_block *,
2919                                        unsigned long,
2920                                        int (*match)(struct inode *,
2921                                                     unsigned long, void *),
2922                                        void *data);
2923 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2924 extern int insert_inode_locked(struct inode *);
2925 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2926 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2927 #else
2928 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2929 #endif
2930 extern void unlock_new_inode(struct inode *);
2931 extern void discard_new_inode(struct inode *);
2932 extern unsigned int get_next_ino(void);
2933 extern void evict_inodes(struct super_block *sb);
2934
2935 extern void __iget(struct inode * inode);
2936 extern void iget_failed(struct inode *);
2937 extern void clear_inode(struct inode *);
2938 extern void __destroy_inode(struct inode *);
2939 extern struct inode *new_inode_pseudo(struct super_block *sb);
2940 extern struct inode *new_inode(struct super_block *sb);
2941 extern void free_inode_nonrcu(struct inode *inode);
2942 extern int should_remove_suid(struct dentry *);
2943 extern int file_remove_privs(struct file *);
2944
2945 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2946 static inline void insert_inode_hash(struct inode *inode)
2947 {
2948         __insert_inode_hash(inode, inode->i_ino);
2949 }
2950
2951 extern void __remove_inode_hash(struct inode *);
2952 static inline void remove_inode_hash(struct inode *inode)
2953 {
2954         if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
2955                 __remove_inode_hash(inode);
2956 }
2957
2958 extern void inode_sb_list_add(struct inode *inode);
2959
2960 #ifdef CONFIG_BLOCK
2961 extern int bdev_read_only(struct block_device *);
2962 #endif
2963 extern int set_blocksize(struct block_device *, int);
2964 extern int sb_set_blocksize(struct super_block *, int);
2965 extern int sb_min_blocksize(struct super_block *, int);
2966
2967 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2968 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2969 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
2970 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
2971 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
2972 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
2973 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
2974 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
2975
2976 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
2977                 rwf_t flags);
2978 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
2979                 rwf_t flags);
2980
2981 /* fs/block_dev.c */
2982 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
2983 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
2984 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2985                         int datasync);
2986 extern void block_sync_page(struct page *page);
2987
2988 /* fs/splice.c */
2989 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
2990                 struct pipe_inode_info *, size_t, unsigned int);
2991 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
2992                 struct file *, loff_t *, size_t, unsigned int);
2993 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
2994                 struct file *out, loff_t *, size_t len, unsigned int flags);
2995 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2996                 loff_t *opos, size_t len, unsigned int flags);
2997
2998
2999 extern void
3000 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3001 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3002 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
3003 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3004 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
3005 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3006                 int whence, loff_t maxsize, loff_t eof);
3007 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3008                 int whence, loff_t size);
3009 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3010 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
3011 extern int generic_file_open(struct inode * inode, struct file * filp);
3012 extern int nonseekable_open(struct inode * inode, struct file * filp);
3013
3014 #ifdef CONFIG_BLOCK
3015 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3016                             loff_t file_offset);
3017
3018 enum {
3019         /* need locking between buffered and direct access */
3020         DIO_LOCKING     = 0x01,
3021
3022         /* filesystem does not support filling holes */
3023         DIO_SKIP_HOLES  = 0x02,
3024 };
3025
3026 void dio_end_io(struct bio *bio);
3027 void dio_warn_stale_pagecache(struct file *filp);
3028
3029 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3030                              struct block_device *bdev, struct iov_iter *iter,
3031                              get_block_t get_block,
3032                              dio_iodone_t end_io, dio_submit_t submit_io,
3033                              int flags);
3034
3035 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3036                                          struct inode *inode,
3037                                          struct iov_iter *iter,
3038                                          get_block_t get_block)
3039 {
3040         return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3041                         get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
3042 }
3043 #endif
3044
3045 void inode_dio_wait(struct inode *inode);
3046
3047 /*
3048  * inode_dio_begin - signal start of a direct I/O requests
3049  * @inode: inode the direct I/O happens on
3050  *
3051  * This is called once we've finished processing a direct I/O request,
3052  * and is used to wake up callers waiting for direct I/O to be quiesced.
3053  */
3054 static inline void inode_dio_begin(struct inode *inode)
3055 {
3056         atomic_inc(&inode->i_dio_count);
3057 }
3058
3059 /*
3060  * inode_dio_end - signal finish of a direct I/O requests
3061  * @inode: inode the direct I/O happens on
3062  *
3063  * This is called once we've finished processing a direct I/O request,
3064  * and is used to wake up callers waiting for direct I/O to be quiesced.
3065  */
3066 static inline void inode_dio_end(struct inode *inode)
3067 {
3068         if (atomic_dec_and_test(&inode->i_dio_count))
3069                 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3070 }
3071
3072 extern void inode_set_flags(struct inode *inode, unsigned int flags,
3073                             unsigned int mask);
3074
3075 extern const struct file_operations generic_ro_fops;
3076
3077 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3078
3079 extern int readlink_copy(char __user *, int, const char *);
3080 extern int page_readlink(struct dentry *, char __user *, int);
3081 extern const char *page_get_link(struct dentry *, struct inode *,
3082                                  struct delayed_call *);
3083 extern void page_put_link(void *);
3084 extern int __page_symlink(struct inode *inode, const char *symname, int len,
3085                 int nofs);
3086 extern int page_symlink(struct inode *inode, const char *symname, int len);
3087 extern const struct inode_operations page_symlink_inode_operations;
3088 extern void kfree_link(void *);
3089 extern void generic_fillattr(struct inode *, struct kstat *);
3090 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3091 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3092 void __inode_add_bytes(struct inode *inode, loff_t bytes);
3093 void inode_add_bytes(struct inode *inode, loff_t bytes);
3094 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
3095 void inode_sub_bytes(struct inode *inode, loff_t bytes);
3096 static inline loff_t __inode_get_bytes(struct inode *inode)
3097 {
3098         return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3099 }
3100 loff_t inode_get_bytes(struct inode *inode);
3101 void inode_set_bytes(struct inode *inode, loff_t bytes);
3102 const char *simple_get_link(struct dentry *, struct inode *,
3103                             struct delayed_call *);
3104 extern const struct inode_operations simple_symlink_inode_operations;
3105
3106 extern int iterate_dir(struct file *, struct dir_context *);
3107
3108 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3109 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3110
3111 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3112 {
3113         return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3114                          stat, STATX_BASIC_STATS);
3115 }
3116 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3117 {
3118         return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3119                          stat, STATX_BASIC_STATS);
3120 }
3121 static inline int vfs_fstatat(int dfd, const char __user *filename,
3122                               struct kstat *stat, int flags)
3123 {
3124         return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3125                          stat, STATX_BASIC_STATS);
3126 }
3127 static inline int vfs_fstat(int fd, struct kstat *stat)
3128 {
3129         return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3130 }
3131
3132
3133 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3134 extern int vfs_readlink(struct dentry *, char __user *, int);
3135
3136 extern int __generic_block_fiemap(struct inode *inode,
3137                                   struct fiemap_extent_info *fieinfo,
3138                                   loff_t start, loff_t len,
3139                                   get_block_t *get_block);
3140 extern int generic_block_fiemap(struct inode *inode,
3141                                 struct fiemap_extent_info *fieinfo, u64 start,
3142                                 u64 len, get_block_t *get_block);
3143
3144 extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3145 extern void put_filesystem(struct file_system_type *fs);
3146 extern struct file_system_type *get_fs_type(const char *name);
3147 extern struct super_block *get_super(struct block_device *);
3148 extern struct super_block *get_super_thawed(struct block_device *);
3149 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3150 extern struct super_block *get_active_super(struct block_device *bdev);
3151 extern void drop_super(struct super_block *sb);
3152 extern void drop_super_exclusive(struct super_block *sb);
3153 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
3154 extern void iterate_supers_type(struct file_system_type *,
3155                                 void (*)(struct super_block *, void *), void *);
3156
3157 extern int dcache_dir_open(struct inode *, struct file *);
3158 extern int dcache_dir_close(struct inode *, struct file *);
3159 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3160 extern int dcache_readdir(struct file *, struct dir_context *);
3161 extern int simple_setattr(struct dentry *, struct iattr *);
3162 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3163 extern int simple_statfs(struct dentry *, struct kstatfs *);
3164 extern int simple_open(struct inode *inode, struct file *file);
3165 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3166 extern int simple_unlink(struct inode *, struct dentry *);
3167 extern int simple_rmdir(struct inode *, struct dentry *);
3168 extern int simple_rename(struct inode *, struct dentry *,
3169                          struct inode *, struct dentry *, unsigned int);
3170 extern int noop_fsync(struct file *, loff_t, loff_t, int);
3171 extern int noop_set_page_dirty(struct page *page);
3172 extern void noop_invalidatepage(struct page *page, unsigned int offset,
3173                 unsigned int length);
3174 extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
3175 extern int simple_empty(struct dentry *);
3176 extern int simple_readpage(struct file *file, struct page *page);
3177 extern int simple_write_begin(struct file *file, struct address_space *mapping,
3178                         loff_t pos, unsigned len, unsigned flags,
3179                         struct page **pagep, void **fsdata);
3180 extern int simple_write_end(struct file *file, struct address_space *mapping,
3181                         loff_t pos, unsigned len, unsigned copied,
3182                         struct page *page, void *fsdata);
3183 extern int always_delete_dentry(const struct dentry *);
3184 extern struct inode *alloc_anon_inode(struct super_block *);
3185 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3186 extern const struct dentry_operations simple_dentry_operations;
3187
3188 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
3189 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3190 extern const struct file_operations simple_dir_operations;
3191 extern const struct inode_operations simple_dir_inode_operations;
3192 extern void make_empty_dir_inode(struct inode *inode);
3193 extern bool is_empty_dir_inode(struct inode *inode);
3194 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3195 struct dentry *d_alloc_name(struct dentry *, const char *);
3196 extern int simple_fill_super(struct super_block *, unsigned long,
3197                              const struct tree_descr *);
3198 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3199 extern void simple_release_fs(struct vfsmount **mount, int *count);
3200
3201 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3202                         loff_t *ppos, const void *from, size_t available);
3203 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3204                 const void __user *from, size_t count);
3205
3206 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3207 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3208
3209 extern int generic_check_addressable(unsigned, u64);
3210
3211 #ifdef CONFIG_MIGRATION
3212 extern int buffer_migrate_page(struct address_space *,
3213                                 struct page *, struct page *,
3214                                 enum migrate_mode);
3215 #else
3216 #define buffer_migrate_page NULL
3217 #endif
3218
3219 extern int setattr_prepare(struct dentry *, struct iattr *);
3220 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3221 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3222
3223 extern int file_update_time(struct file *file);
3224
3225 static inline bool io_is_direct(struct file *filp)
3226 {
3227         return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
3228 }
3229
3230 static inline bool vma_is_dax(struct vm_area_struct *vma)
3231 {
3232         return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3233 }
3234
3235 static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3236 {
3237         struct inode *inode;
3238
3239         if (!vma->vm_file)
3240                 return false;
3241         if (!vma_is_dax(vma))
3242                 return false;
3243         inode = file_inode(vma->vm_file);
3244         if (S_ISCHR(inode->i_mode))
3245                 return false; /* device-dax */
3246         return true;
3247 }
3248
3249 static inline int iocb_flags(struct file *file)
3250 {
3251         int res = 0;
3252         if (file->f_flags & O_APPEND)
3253                 res |= IOCB_APPEND;
3254         if (io_is_direct(file))
3255                 res |= IOCB_DIRECT;
3256         if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3257                 res |= IOCB_DSYNC;
3258         if (file->f_flags & __O_SYNC)
3259                 res |= IOCB_SYNC;
3260         return res;
3261 }
3262
3263 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3264 {
3265         if (unlikely(flags & ~RWF_SUPPORTED))
3266                 return -EOPNOTSUPP;
3267
3268         if (flags & RWF_NOWAIT) {
3269                 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3270                         return -EOPNOTSUPP;
3271                 ki->ki_flags |= IOCB_NOWAIT;
3272         }
3273         if (flags & RWF_HIPRI)
3274                 ki->ki_flags |= IOCB_HIPRI;
3275         if (flags & RWF_DSYNC)
3276                 ki->ki_flags |= IOCB_DSYNC;
3277         if (flags & RWF_SYNC)
3278                 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
3279         if (flags & RWF_APPEND)
3280                 ki->ki_flags |= IOCB_APPEND;
3281         return 0;
3282 }
3283
3284 static inline ino_t parent_ino(struct dentry *dentry)
3285 {
3286         ino_t res;
3287
3288         /*
3289          * Don't strictly need d_lock here? If the parent ino could change
3290          * then surely we'd have a deeper race in the caller?
3291          */
3292         spin_lock(&dentry->d_lock);
3293         res = dentry->d_parent->d_inode->i_ino;
3294         spin_unlock(&dentry->d_lock);
3295         return res;
3296 }
3297
3298 /* Transaction based IO helpers */
3299
3300 /*
3301  * An argresp is stored in an allocated page and holds the
3302  * size of the argument or response, along with its content
3303  */
3304 struct simple_transaction_argresp {
3305         ssize_t size;
3306         char data[0];
3307 };
3308
3309 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3310
3311 char *simple_transaction_get(struct file *file, const char __user *buf,
3312                                 size_t size);
3313 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3314                                 size_t size, loff_t *pos);
3315 int simple_transaction_release(struct inode *inode, struct file *file);
3316
3317 void simple_transaction_set(struct file *file, size_t n);
3318
3319 /*
3320  * simple attribute files
3321  *
3322  * These attributes behave similar to those in sysfs:
3323  *
3324  * Writing to an attribute immediately sets a value, an open file can be
3325  * written to multiple times.
3326  *
3327  * Reading from an attribute creates a buffer from the value that might get
3328  * read with multiple read calls. When the attribute has been read
3329  * completely, no further read calls are possible until the file is opened
3330  * again.
3331  *
3332  * All attributes contain a text representation of a numeric value
3333  * that are accessed with the get() and set() functions.
3334  */
3335 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)            \
3336 static int __fops ## _open(struct inode *inode, struct file *file)      \
3337 {                                                                       \
3338         __simple_attr_check_format(__fmt, 0ull);                        \
3339         return simple_attr_open(inode, file, __get, __set, __fmt);      \
3340 }                                                                       \
3341 static const struct file_operations __fops = {                          \
3342         .owner   = THIS_MODULE,                                         \
3343         .open    = __fops ## _open,                                     \
3344         .release = simple_attr_release,                                 \
3345         .read    = simple_attr_read,                                    \
3346         .write   = simple_attr_write,                                   \
3347         .llseek  = generic_file_llseek,                                 \
3348 }
3349
3350 static inline __printf(1, 2)
3351 void __simple_attr_check_format(const char *fmt, ...)
3352 {
3353         /* don't do anything, just let the compiler check the arguments; */
3354 }
3355
3356 int simple_attr_open(struct inode *inode, struct file *file,
3357                      int (*get)(void *, u64 *), int (*set)(void *, u64),
3358                      const char *fmt);
3359 int simple_attr_release(struct inode *inode, struct file *file);
3360 ssize_t simple_attr_read(struct file *file, char __user *buf,
3361                          size_t len, loff_t *ppos);
3362 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3363                           size_t len, loff_t *ppos);
3364
3365 struct ctl_table;
3366 int proc_nr_files(struct ctl_table *table, int write,
3367                   void __user *buffer, size_t *lenp, loff_t *ppos);
3368 int proc_nr_dentry(struct ctl_table *table, int write,
3369                   void __user *buffer, size_t *lenp, loff_t *ppos);
3370 int proc_nr_inodes(struct ctl_table *table, int write,
3371                    void __user *buffer, size_t *lenp, loff_t *ppos);
3372 int __init get_filesystem_list(char *buf);
3373
3374 #define __FMODE_EXEC            ((__force int) FMODE_EXEC)
3375 #define __FMODE_NONOTIFY        ((__force int) FMODE_NONOTIFY)
3376
3377 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3378 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3379                                             (flag & __FMODE_NONOTIFY)))
3380
3381 static inline bool is_sxid(umode_t mode)
3382 {
3383         return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3384 }
3385
3386 static inline int check_sticky(struct inode *dir, struct inode *inode)
3387 {
3388         if (!(dir->i_mode & S_ISVTX))
3389                 return 0;
3390
3391         return __check_sticky(dir, inode);
3392 }
3393
3394 static inline void inode_has_no_xattr(struct inode *inode)
3395 {
3396         if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3397                 inode->i_flags |= S_NOSEC;
3398 }
3399
3400 static inline bool is_root_inode(struct inode *inode)
3401 {
3402         return inode == inode->i_sb->s_root->d_inode;
3403 }
3404
3405 static inline bool dir_emit(struct dir_context *ctx,
3406                             const char *name, int namelen,
3407                             u64 ino, unsigned type)
3408 {
3409         return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3410 }
3411 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3412 {
3413         return ctx->actor(ctx, ".", 1, ctx->pos,
3414                           file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3415 }
3416 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3417 {
3418         return ctx->actor(ctx, "..", 2, ctx->pos,
3419                           parent_ino(file->f_path.dentry), DT_DIR) == 0;
3420 }
3421 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3422 {
3423         if (ctx->pos == 0) {
3424                 if (!dir_emit_dot(file, ctx))
3425                         return false;
3426                 ctx->pos = 1;
3427         }
3428         if (ctx->pos == 1) {
3429                 if (!dir_emit_dotdot(file, ctx))
3430                         return false;
3431                 ctx->pos = 2;
3432         }
3433         return true;
3434 }
3435 static inline bool dir_relax(struct inode *inode)
3436 {
3437         inode_unlock(inode);
3438         inode_lock(inode);
3439         return !IS_DEADDIR(inode);
3440 }
3441
3442 static inline bool dir_relax_shared(struct inode *inode)
3443 {
3444         inode_unlock_shared(inode);
3445         inode_lock_shared(inode);
3446         return !IS_DEADDIR(inode);
3447 }
3448
3449 extern bool path_noexec(const struct path *path);
3450 extern void inode_nohighmem(struct inode *inode);
3451
3452 /* mm/fadvise.c */
3453 extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3454                        int advice);
3455
3456 #endif /* _LINUX_FS_H */