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