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