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