GNU Linux-libre 4.14.328-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_many(x, cnt)       \
912         atomic_long_add_unless(&(x)->f_count, (cnt), 0)
913 #define get_file_rcu(x) get_file_rcu_many((x), 1)
914 #define fput_atomic(x)  atomic_long_add_unless(&(x)->f_count, -1, 1)
915 #define file_count(x)   atomic_long_read(&(x)->f_count)
916
917 #define MAX_NON_LFS     ((1UL<<31) - 1)
918
919 /* Page cache limit. The filesystems should put that into their s_maxbytes 
920    limits, otherwise bad things can happen in VM. */ 
921 #if BITS_PER_LONG==32
922 #define MAX_LFS_FILESIZE        ((loff_t)ULONG_MAX << PAGE_SHIFT)
923 #elif BITS_PER_LONG==64
924 #define MAX_LFS_FILESIZE        ((loff_t)LLONG_MAX)
925 #endif
926
927 #define FL_POSIX        1
928 #define FL_FLOCK        2
929 #define FL_DELEG        4       /* NFSv4 delegation */
930 #define FL_ACCESS       8       /* not trying to lock, just looking */
931 #define FL_EXISTS       16      /* when unlocking, test for existence */
932 #define FL_LEASE        32      /* lease held on this file */
933 #define FL_CLOSE        64      /* unlock on close */
934 #define FL_SLEEP        128     /* A blocking lock */
935 #define FL_DOWNGRADE_PENDING    256 /* Lease is being downgraded */
936 #define FL_UNLOCK_PENDING       512 /* Lease is being broken */
937 #define FL_OFDLCK       1024    /* lock is "owned" by struct file */
938 #define FL_LAYOUT       2048    /* outstanding pNFS layout */
939
940 #define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
941
942 /*
943  * Special return value from posix_lock_file() and vfs_lock_file() for
944  * asynchronous locking.
945  */
946 #define FILE_LOCK_DEFERRED 1
947
948 /* legacy typedef, should eventually be removed */
949 typedef void *fl_owner_t;
950
951 struct file_lock;
952
953 struct file_lock_operations {
954         void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
955         void (*fl_release_private)(struct file_lock *);
956 };
957
958 struct lock_manager_operations {
959         int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
960         unsigned long (*lm_owner_key)(struct file_lock *);
961         fl_owner_t (*lm_get_owner)(fl_owner_t);
962         void (*lm_put_owner)(fl_owner_t);
963         void (*lm_notify)(struct file_lock *);  /* unblock callback */
964         int (*lm_grant)(struct file_lock *, int);
965         bool (*lm_break)(struct file_lock *);
966         int (*lm_change)(struct file_lock *, int, struct list_head *);
967         void (*lm_setup)(struct file_lock *, void **);
968 };
969
970 struct lock_manager {
971         struct list_head list;
972         /*
973          * NFSv4 and up also want opens blocked during the grace period;
974          * NLM doesn't care:
975          */
976         bool block_opens;
977 };
978
979 struct net;
980 void locks_start_grace(struct net *, struct lock_manager *);
981 void locks_end_grace(struct lock_manager *);
982 int locks_in_grace(struct net *);
983 int opens_in_grace(struct net *);
984
985 /* that will die - we need it for nfs_lock_info */
986 #include <linux/nfs_fs_i.h>
987
988 /*
989  * struct file_lock represents a generic "file lock". It's used to represent
990  * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
991  * note that the same struct is used to represent both a request for a lock and
992  * the lock itself, but the same object is never used for both.
993  *
994  * FIXME: should we create a separate "struct lock_request" to help distinguish
995  * these two uses?
996  *
997  * The varous i_flctx lists are ordered by:
998  *
999  * 1) lock owner
1000  * 2) lock range start
1001  * 3) lock range end
1002  *
1003  * Obviously, the last two criteria only matter for POSIX locks.
1004  */
1005 struct file_lock {
1006         struct file_lock *fl_next;      /* singly linked list for this inode  */
1007         struct list_head fl_list;       /* link into file_lock_context */
1008         struct hlist_node fl_link;      /* node in global lists */
1009         struct list_head fl_block;      /* circular list of blocked processes */
1010         fl_owner_t fl_owner;
1011         unsigned int fl_flags;
1012         unsigned char fl_type;
1013         unsigned int fl_pid;
1014         int fl_link_cpu;                /* what cpu's list is this on? */
1015         wait_queue_head_t fl_wait;
1016         struct file *fl_file;
1017         loff_t fl_start;
1018         loff_t fl_end;
1019
1020         struct fasync_struct *  fl_fasync; /* for lease break notifications */
1021         /* for lease breaks: */
1022         unsigned long fl_break_time;
1023         unsigned long fl_downgrade_time;
1024
1025         const struct file_lock_operations *fl_ops;      /* Callbacks for filesystems */
1026         const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
1027         union {
1028                 struct nfs_lock_info    nfs_fl;
1029                 struct nfs4_lock_info   nfs4_fl;
1030                 struct {
1031                         struct list_head link;  /* link in AFS vnode's pending_locks list */
1032                         int state;              /* state of grant or error if -ve */
1033                 } afs;
1034         } fl_u;
1035 } __randomize_layout;
1036
1037 struct file_lock_context {
1038         spinlock_t              flc_lock;
1039         struct list_head        flc_flock;
1040         struct list_head        flc_posix;
1041         struct list_head        flc_lease;
1042 };
1043
1044 /* The following constant reflects the upper bound of the file/locking space */
1045 #ifndef OFFSET_MAX
1046 #define INT_LIMIT(x)    (~((x)1 << (sizeof(x)*8 - 1)))
1047 #define OFFSET_MAX      INT_LIMIT(loff_t)
1048 #define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1049 #endif
1050
1051 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1052
1053 /*
1054  * Return the inode to use for locking
1055  *
1056  * For overlayfs this should be the overlay inode, not the real inode returned
1057  * by file_inode().  For any other fs file_inode(filp) and locks_inode(filp) are
1058  * equal.
1059  */
1060 static inline struct inode *locks_inode(const struct file *f)
1061 {
1062         return f->f_path.dentry->d_inode;
1063 }
1064
1065 #ifdef CONFIG_FILE_LOCKING
1066 extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1067 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1068                         struct flock *);
1069
1070 #if BITS_PER_LONG == 32
1071 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1072 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1073                         struct flock64 *);
1074 #endif
1075
1076 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1077 extern int fcntl_getlease(struct file *filp);
1078
1079 /* fs/locks.c */
1080 void locks_free_lock_context(struct inode *inode);
1081 void locks_free_lock(struct file_lock *fl);
1082 extern void locks_init_lock(struct file_lock *);
1083 extern struct file_lock * locks_alloc_lock(void);
1084 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1085 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1086 extern void locks_remove_posix(struct file *, fl_owner_t);
1087 extern void locks_remove_file(struct file *);
1088 extern void locks_release_private(struct file_lock *);
1089 extern void posix_test_lock(struct file *, struct file_lock *);
1090 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1091 extern int posix_unblock_lock(struct file_lock *);
1092 extern int vfs_test_lock(struct file *, struct file_lock *);
1093 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1094 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1095 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
1096 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1097 extern void lease_get_mtime(struct inode *, struct timespec *time);
1098 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1099 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1100 extern int lease_modify(struct file_lock *, int, struct list_head *);
1101 struct files_struct;
1102 extern void show_fd_locks(struct seq_file *f,
1103                          struct file *filp, struct files_struct *files);
1104 #else /* !CONFIG_FILE_LOCKING */
1105 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1106                               struct flock __user *user)
1107 {
1108         return -EINVAL;
1109 }
1110
1111 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1112                               unsigned int cmd, struct flock __user *user)
1113 {
1114         return -EACCES;
1115 }
1116
1117 #if BITS_PER_LONG == 32
1118 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1119                                 struct flock64 __user *user)
1120 {
1121         return -EINVAL;
1122 }
1123
1124 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1125                                 unsigned int cmd, struct flock64 __user *user)
1126 {
1127         return -EACCES;
1128 }
1129 #endif
1130 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1131 {
1132         return -EINVAL;
1133 }
1134
1135 static inline int fcntl_getlease(struct file *filp)
1136 {
1137         return F_UNLCK;
1138 }
1139
1140 static inline void
1141 locks_free_lock_context(struct inode *inode)
1142 {
1143 }
1144
1145 static inline void locks_init_lock(struct file_lock *fl)
1146 {
1147         return;
1148 }
1149
1150 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1151 {
1152         return;
1153 }
1154
1155 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1156 {
1157         return;
1158 }
1159
1160 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1161 {
1162         return;
1163 }
1164
1165 static inline void locks_remove_file(struct file *filp)
1166 {
1167         return;
1168 }
1169
1170 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1171 {
1172         return;
1173 }
1174
1175 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1176                                   struct file_lock *conflock)
1177 {
1178         return -ENOLCK;
1179 }
1180
1181 static inline int posix_unblock_lock(struct file_lock *waiter)
1182 {
1183         return -ENOENT;
1184 }
1185
1186 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1187 {
1188         return 0;
1189 }
1190
1191 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1192                                 struct file_lock *fl, struct file_lock *conf)
1193 {
1194         return -ENOLCK;
1195 }
1196
1197 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1198 {
1199         return 0;
1200 }
1201
1202 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1203 {
1204         return -ENOLCK;
1205 }
1206
1207 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1208 {
1209         return 0;
1210 }
1211
1212 static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1213 {
1214         return;
1215 }
1216
1217 static inline int generic_setlease(struct file *filp, long arg,
1218                                     struct file_lock **flp, void **priv)
1219 {
1220         return -EINVAL;
1221 }
1222
1223 static inline int vfs_setlease(struct file *filp, long arg,
1224                                struct file_lock **lease, void **priv)
1225 {
1226         return -EINVAL;
1227 }
1228
1229 static inline int lease_modify(struct file_lock *fl, int arg,
1230                                struct list_head *dispose)
1231 {
1232         return -EINVAL;
1233 }
1234
1235 struct files_struct;
1236 static inline void show_fd_locks(struct seq_file *f,
1237                         struct file *filp, struct files_struct *files) {}
1238 #endif /* !CONFIG_FILE_LOCKING */
1239
1240 static inline struct inode *file_inode(const struct file *f)
1241 {
1242         return f->f_inode;
1243 }
1244
1245 static inline struct dentry *file_dentry(const struct file *file)
1246 {
1247         return d_real(file->f_path.dentry, file_inode(file), 0, 0);
1248 }
1249
1250 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1251 {
1252         return locks_lock_inode_wait(locks_inode(filp), fl);
1253 }
1254
1255 struct fasync_struct {
1256         spinlock_t              fa_lock;
1257         int                     magic;
1258         int                     fa_fd;
1259         struct fasync_struct    *fa_next; /* singly linked list */
1260         struct file             *fa_file;
1261         struct rcu_head         fa_rcu;
1262 };
1263
1264 #define FASYNC_MAGIC 0x4601
1265
1266 /* SMP safe fasync helpers: */
1267 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1268 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1269 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1270 extern struct fasync_struct *fasync_alloc(void);
1271 extern void fasync_free(struct fasync_struct *);
1272
1273 /* can be called from interrupts */
1274 extern void kill_fasync(struct fasync_struct **, int, int);
1275
1276 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1277 extern int f_setown(struct file *filp, unsigned long arg, int force);
1278 extern void f_delown(struct file *filp);
1279 extern pid_t f_getown(struct file *filp);
1280 extern int send_sigurg(struct fown_struct *fown);
1281
1282 /*
1283  * sb->s_flags.  Note that these mirror the equivalent MS_* flags where
1284  * represented in both.
1285  */
1286 #define SB_RDONLY        1      /* Mount read-only */
1287 #define SB_NOSUID        2      /* Ignore suid and sgid bits */
1288 #define SB_NODEV         4      /* Disallow access to device special files */
1289 #define SB_NOEXEC        8      /* Disallow program execution */
1290 #define SB_SYNCHRONOUS  16      /* Writes are synced at once */
1291 #define SB_MANDLOCK     64      /* Allow mandatory locks on an FS */
1292 #define SB_DIRSYNC      128     /* Directory modifications are synchronous */
1293 #define SB_NOATIME      1024    /* Do not update access times. */
1294 #define SB_NODIRATIME   2048    /* Do not update directory access times */
1295 #define SB_SILENT       32768
1296 #define SB_POSIXACL     (1<<16) /* VFS does not apply the umask */
1297 #define SB_KERNMOUNT    (1<<22) /* this is a kern_mount call */
1298 #define SB_I_VERSION    (1<<23) /* Update inode I_version field */
1299 #define SB_LAZYTIME     (1<<25) /* Update the on-disk [acm]times lazily */
1300
1301 /* These sb flags are internal to the kernel */
1302 #define SB_SUBMOUNT     (1<<26)
1303 #define SB_NOREMOTELOCK (1<<27)
1304 #define SB_NOSEC        (1<<28)
1305 #define SB_BORN         (1<<29)
1306 #define SB_ACTIVE       (1<<30)
1307 #define SB_NOUSER       (1<<31)
1308
1309 /*
1310  *      Umount options
1311  */
1312
1313 #define MNT_FORCE       0x00000001      /* Attempt to forcibily umount */
1314 #define MNT_DETACH      0x00000002      /* Just detach from the tree */
1315 #define MNT_EXPIRE      0x00000004      /* Mark for expiry */
1316 #define UMOUNT_NOFOLLOW 0x00000008      /* Don't follow symlink on umount */
1317 #define UMOUNT_UNUSED   0x80000000      /* Flag guaranteed to be unused */
1318
1319 /* sb->s_iflags */
1320 #define SB_I_CGROUPWB   0x00000001      /* cgroup-aware writeback enabled */
1321 #define SB_I_NOEXEC     0x00000002      /* Ignore executables on this fs */
1322 #define SB_I_NODEV      0x00000004      /* Ignore devices on this fs */
1323 #define SB_I_MULTIROOT  0x00000008      /* Multiple roots to the dentry tree */
1324
1325 /* sb->s_iflags to limit user namespace mounts */
1326 #define SB_I_USERNS_VISIBLE             0x00000010 /* fstype already mounted */
1327
1328 /* Possible states of 'frozen' field */
1329 enum {
1330         SB_UNFROZEN = 0,                /* FS is unfrozen */
1331         SB_FREEZE_WRITE = 1,            /* Writes, dir ops, ioctls frozen */
1332         SB_FREEZE_PAGEFAULT = 2,        /* Page faults stopped as well */
1333         SB_FREEZE_FS = 3,               /* For internal FS use (e.g. to stop
1334                                          * internal threads if needed) */
1335         SB_FREEZE_COMPLETE = 4,         /* ->freeze_fs finished successfully */
1336 };
1337
1338 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1339
1340 struct sb_writers {
1341         int                             frozen;         /* Is sb frozen? */
1342         wait_queue_head_t               wait_unfrozen;  /* for get_super_thawed() */
1343         struct percpu_rw_semaphore      rw_sem[SB_FREEZE_LEVELS];
1344 };
1345
1346 struct super_block {
1347         struct list_head        s_list;         /* Keep this first */
1348         dev_t                   s_dev;          /* search index; _not_ kdev_t */
1349         unsigned char           s_blocksize_bits;
1350         unsigned long           s_blocksize;
1351         loff_t                  s_maxbytes;     /* Max file size */
1352         struct file_system_type *s_type;
1353         const struct super_operations   *s_op;
1354         const struct dquot_operations   *dq_op;
1355         const struct quotactl_ops       *s_qcop;
1356         const struct export_operations *s_export_op;
1357         unsigned long           s_flags;
1358         unsigned long           s_iflags;       /* internal SB_I_* flags */
1359         unsigned long           s_magic;
1360         struct dentry           *s_root;
1361         struct rw_semaphore     s_umount;
1362         int                     s_count;
1363         atomic_t                s_active;
1364 #ifdef CONFIG_SECURITY
1365         void                    *s_security;
1366 #endif
1367         const struct xattr_handler **s_xattr;
1368
1369         const struct fscrypt_operations *s_cop;
1370
1371         struct hlist_bl_head    s_anon;         /* anonymous dentries for (nfs) exporting */
1372         struct list_head        s_mounts;       /* list of mounts; _not_ for fs use */
1373         struct block_device     *s_bdev;
1374         struct backing_dev_info *s_bdi;
1375         struct mtd_info         *s_mtd;
1376         struct hlist_node       s_instances;
1377         unsigned int            s_quota_types;  /* Bitmask of supported quota types */
1378         struct quota_info       s_dquot;        /* Diskquota specific options */
1379
1380         struct sb_writers       s_writers;
1381
1382         char                    s_id[32];       /* Informational name */
1383         uuid_t                  s_uuid;         /* UUID */
1384
1385         void                    *s_fs_info;     /* Filesystem private info */
1386         unsigned int            s_max_links;
1387         fmode_t                 s_mode;
1388
1389         /* Granularity of c/m/atime in ns.
1390            Cannot be worse than a second */
1391         u32                s_time_gran;
1392
1393         /*
1394          * The next field is for VFS *only*. No filesystems have any business
1395          * even looking at it. You had been warned.
1396          */
1397         struct mutex s_vfs_rename_mutex;        /* Kludge */
1398
1399         /*
1400          * Filesystem subtype.  If non-empty the filesystem type field
1401          * in /proc/mounts will be "type.subtype"
1402          */
1403         char *s_subtype;
1404
1405         const struct dentry_operations *s_d_op; /* default d_op for dentries */
1406
1407         /*
1408          * Saved pool identifier for cleancache (-1 means none)
1409          */
1410         int cleancache_poolid;
1411
1412         struct shrinker s_shrink;       /* per-sb shrinker handle */
1413
1414         /* Number of inodes with nlink == 0 but still referenced */
1415         atomic_long_t s_remove_count;
1416
1417         /* Being remounted read-only */
1418         int s_readonly_remount;
1419
1420         /* AIO completions deferred from interrupt context */
1421         struct workqueue_struct *s_dio_done_wq;
1422         struct hlist_head s_pins;
1423
1424         /*
1425          * Owning user namespace and default context in which to
1426          * interpret filesystem uids, gids, quotas, device nodes,
1427          * xattrs and security labels.
1428          */
1429         struct user_namespace *s_user_ns;
1430
1431         /*
1432          * Keep the lru lists last in the structure so they always sit on their
1433          * own individual cachelines.
1434          */
1435         struct list_lru         s_dentry_lru ____cacheline_aligned_in_smp;
1436         struct list_lru         s_inode_lru ____cacheline_aligned_in_smp;
1437         struct rcu_head         rcu;
1438         struct work_struct      destroy_work;
1439
1440         struct mutex            s_sync_lock;    /* sync serialisation lock */
1441
1442         /*
1443          * Indicates how deep in a filesystem stack this SB is
1444          */
1445         int s_stack_depth;
1446
1447         /* s_inode_list_lock protects s_inodes */
1448         spinlock_t              s_inode_list_lock ____cacheline_aligned_in_smp;
1449         struct list_head        s_inodes;       /* all inodes */
1450
1451         spinlock_t              s_inode_wblist_lock;
1452         struct list_head        s_inodes_wb;    /* writeback inodes */
1453 } __randomize_layout;
1454
1455 /* Helper functions so that in most cases filesystems will
1456  * not need to deal directly with kuid_t and kgid_t and can
1457  * instead deal with the raw numeric values that are stored
1458  * in the filesystem.
1459  */
1460 static inline uid_t i_uid_read(const struct inode *inode)
1461 {
1462         return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1463 }
1464
1465 static inline gid_t i_gid_read(const struct inode *inode)
1466 {
1467         return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1468 }
1469
1470 static inline void i_uid_write(struct inode *inode, uid_t uid)
1471 {
1472         inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1473 }
1474
1475 static inline void i_gid_write(struct inode *inode, gid_t gid)
1476 {
1477         inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1478 }
1479
1480 extern struct timespec current_time(struct inode *inode);
1481
1482 /*
1483  * Snapshotting support.
1484  */
1485
1486 void __sb_end_write(struct super_block *sb, int level);
1487 int __sb_start_write(struct super_block *sb, int level, bool wait);
1488
1489 #define __sb_writers_acquired(sb, lev)  \
1490         percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1491 #define __sb_writers_release(sb, lev)   \
1492         percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1493
1494 /**
1495  * sb_end_write - drop write access to a superblock
1496  * @sb: the super we wrote to
1497  *
1498  * Decrement number of writers to the filesystem. Wake up possible waiters
1499  * wanting to freeze the filesystem.
1500  */
1501 static inline void sb_end_write(struct super_block *sb)
1502 {
1503         __sb_end_write(sb, SB_FREEZE_WRITE);
1504 }
1505
1506 /**
1507  * sb_end_pagefault - drop write access to a superblock from a page fault
1508  * @sb: the super we wrote to
1509  *
1510  * Decrement number of processes handling write page fault to the filesystem.
1511  * Wake up possible waiters wanting to freeze the filesystem.
1512  */
1513 static inline void sb_end_pagefault(struct super_block *sb)
1514 {
1515         __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1516 }
1517
1518 /**
1519  * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1520  * @sb: the super we wrote to
1521  *
1522  * Decrement fs-internal number of writers to the filesystem.  Wake up possible
1523  * waiters wanting to freeze the filesystem.
1524  */
1525 static inline void sb_end_intwrite(struct super_block *sb)
1526 {
1527         __sb_end_write(sb, SB_FREEZE_FS);
1528 }
1529
1530 /**
1531  * sb_start_write - get write access to a superblock
1532  * @sb: the super we write to
1533  *
1534  * When a process wants to write data or metadata to a file system (i.e. dirty
1535  * a page or an inode), it should embed the operation in a sb_start_write() -
1536  * sb_end_write() pair to get exclusion against file system freezing. This
1537  * function increments number of writers preventing freezing. If the file
1538  * system is already frozen, the function waits until the file system is
1539  * thawed.
1540  *
1541  * Since freeze protection behaves as a lock, users have to preserve
1542  * ordering of freeze protection and other filesystem locks. Generally,
1543  * freeze protection should be the outermost lock. In particular, we have:
1544  *
1545  * sb_start_write
1546  *   -> i_mutex                 (write path, truncate, directory ops, ...)
1547  *   -> s_umount                (freeze_super, thaw_super)
1548  */
1549 static inline void sb_start_write(struct super_block *sb)
1550 {
1551         __sb_start_write(sb, SB_FREEZE_WRITE, true);
1552 }
1553
1554 static inline int sb_start_write_trylock(struct super_block *sb)
1555 {
1556         return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1557 }
1558
1559 /**
1560  * sb_start_pagefault - get write access to a superblock from a page fault
1561  * @sb: the super we write to
1562  *
1563  * When a process starts handling write page fault, it should embed the
1564  * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1565  * exclusion against file system freezing. This is needed since the page fault
1566  * is going to dirty a page. This function increments number of running page
1567  * faults preventing freezing. If the file system is already frozen, the
1568  * function waits until the file system is thawed.
1569  *
1570  * Since page fault freeze protection behaves as a lock, users have to preserve
1571  * ordering of freeze protection and other filesystem locks. It is advised to
1572  * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1573  * handling code implies lock dependency:
1574  *
1575  * mmap_sem
1576  *   -> sb_start_pagefault
1577  */
1578 static inline void sb_start_pagefault(struct super_block *sb)
1579 {
1580         __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1581 }
1582
1583 /*
1584  * sb_start_intwrite - get write access to a superblock for internal fs purposes
1585  * @sb: the super we write to
1586  *
1587  * This is the third level of protection against filesystem freezing. It is
1588  * free for use by a filesystem. The only requirement is that it must rank
1589  * below sb_start_pagefault.
1590  *
1591  * For example filesystem can call sb_start_intwrite() when starting a
1592  * transaction which somewhat eases handling of freezing for internal sources
1593  * of filesystem changes (internal fs threads, discarding preallocation on file
1594  * close, etc.).
1595  */
1596 static inline void sb_start_intwrite(struct super_block *sb)
1597 {
1598         __sb_start_write(sb, SB_FREEZE_FS, true);
1599 }
1600
1601
1602 extern bool inode_owner_or_capable(const struct inode *inode);
1603
1604 /*
1605  * VFS helper functions..
1606  */
1607 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1608 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1609 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1610 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1611 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1612 extern int vfs_rmdir(struct inode *, struct dentry *);
1613 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1614 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1615 extern int vfs_whiteout(struct inode *, struct dentry *);
1616
1617 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1618                                   int open_flag);
1619
1620 /*
1621  * VFS file helper functions.
1622  */
1623 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1624                         umode_t mode);
1625 extern bool may_open_dev(const struct path *path);
1626 /*
1627  * VFS FS_IOC_FIEMAP helper definitions.
1628  */
1629 struct fiemap_extent_info {
1630         unsigned int fi_flags;          /* Flags as passed from user */
1631         unsigned int fi_extents_mapped; /* Number of mapped extents */
1632         unsigned int fi_extents_max;    /* Size of fiemap_extent array */
1633         struct fiemap_extent __user *fi_extents_start; /* Start of
1634                                                         fiemap_extent array */
1635 };
1636 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1637                             u64 phys, u64 len, u32 flags);
1638 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1639
1640 /*
1641  * File types
1642  *
1643  * NOTE! These match bits 12..15 of stat.st_mode
1644  * (ie "(i_mode >> 12) & 15").
1645  */
1646 #define DT_UNKNOWN      0
1647 #define DT_FIFO         1
1648 #define DT_CHR          2
1649 #define DT_DIR          4
1650 #define DT_BLK          6
1651 #define DT_REG          8
1652 #define DT_LNK          10
1653 #define DT_SOCK         12
1654 #define DT_WHT          14
1655
1656 /*
1657  * This is the "filldir" function type, used by readdir() to let
1658  * the kernel specify what kind of dirent layout it wants to have.
1659  * This allows the kernel to read directories into kernel space or
1660  * to have different dirent layouts depending on the binary type.
1661  */
1662 struct dir_context;
1663 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1664                          unsigned);
1665
1666 struct dir_context {
1667         const filldir_t actor;
1668         loff_t pos;
1669 };
1670
1671 struct block_device_operations;
1672
1673 /* These macros are for out of kernel modules to test that
1674  * the kernel supports the unlocked_ioctl and compat_ioctl
1675  * fields in struct file_operations. */
1676 #define HAVE_COMPAT_IOCTL 1
1677 #define HAVE_UNLOCKED_IOCTL 1
1678
1679 /*
1680  * These flags let !MMU mmap() govern direct device mapping vs immediate
1681  * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1682  *
1683  * NOMMU_MAP_COPY:      Copy can be mapped (MAP_PRIVATE)
1684  * NOMMU_MAP_DIRECT:    Can be mapped directly (MAP_SHARED)
1685  * NOMMU_MAP_READ:      Can be mapped for reading
1686  * NOMMU_MAP_WRITE:     Can be mapped for writing
1687  * NOMMU_MAP_EXEC:      Can be mapped for execution
1688  */
1689 #define NOMMU_MAP_COPY          0x00000001
1690 #define NOMMU_MAP_DIRECT        0x00000008
1691 #define NOMMU_MAP_READ          VM_MAYREAD
1692 #define NOMMU_MAP_WRITE         VM_MAYWRITE
1693 #define NOMMU_MAP_EXEC          VM_MAYEXEC
1694
1695 #define NOMMU_VMFLAGS \
1696         (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1697
1698
1699 struct iov_iter;
1700
1701 struct file_operations {
1702         struct module *owner;
1703         loff_t (*llseek) (struct file *, loff_t, int);
1704         ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1705         ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1706         ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1707         ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1708         int (*iterate) (struct file *, struct dir_context *);
1709         int (*iterate_shared) (struct file *, struct dir_context *);
1710         unsigned int (*poll) (struct file *, struct poll_table_struct *);
1711         long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1712         long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1713         int (*mmap) (struct file *, struct vm_area_struct *);
1714         int (*open) (struct inode *, struct file *);
1715         int (*flush) (struct file *, fl_owner_t id);
1716         int (*release) (struct inode *, struct file *);
1717         int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1718         int (*fasync) (int, struct file *, int);
1719         int (*lock) (struct file *, int, struct file_lock *);
1720         ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1721         unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1722         int (*check_flags)(int);
1723         int (*flock) (struct file *, int, struct file_lock *);
1724         ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1725         ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1726         int (*setlease)(struct file *, long, struct file_lock **, void **);
1727         long (*fallocate)(struct file *file, int mode, loff_t offset,
1728                           loff_t len);
1729         void (*show_fdinfo)(struct seq_file *m, struct file *f);
1730 #ifndef CONFIG_MMU
1731         unsigned (*mmap_capabilities)(struct file *);
1732 #endif
1733         ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1734                         loff_t, size_t, unsigned int);
1735         int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1736                         u64);
1737         ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1738                         u64);
1739 } __randomize_layout;
1740
1741 struct inode_operations {
1742         struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1743         const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1744         int (*permission) (struct inode *, int);
1745         struct posix_acl * (*get_acl)(struct inode *, int);
1746
1747         int (*readlink) (struct dentry *, char __user *,int);
1748
1749         int (*create) (struct inode *,struct dentry *, umode_t, bool);
1750         int (*link) (struct dentry *,struct inode *,struct dentry *);
1751         int (*unlink) (struct inode *,struct dentry *);
1752         int (*symlink) (struct inode *,struct dentry *,const char *);
1753         int (*mkdir) (struct inode *,struct dentry *,umode_t);
1754         int (*rmdir) (struct inode *,struct dentry *);
1755         int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1756         int (*rename) (struct inode *, struct dentry *,
1757                         struct inode *, struct dentry *, unsigned int);
1758         int (*setattr) (struct dentry *, struct iattr *);
1759         int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1760         ssize_t (*listxattr) (struct dentry *, char *, size_t);
1761         int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1762                       u64 len);
1763         int (*update_time)(struct inode *, struct timespec *, int);
1764         int (*atomic_open)(struct inode *, struct dentry *,
1765                            struct file *, unsigned open_flag,
1766                            umode_t create_mode, int *opened);
1767         int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1768         int (*set_acl)(struct inode *, struct posix_acl *, int);
1769 } ____cacheline_aligned;
1770
1771 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1772                                      struct iov_iter *iter)
1773 {
1774         return file->f_op->read_iter(kio, iter);
1775 }
1776
1777 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1778                                       struct iov_iter *iter)
1779 {
1780         return file->f_op->write_iter(kio, iter);
1781 }
1782
1783 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1784 {
1785         return file->f_op->mmap(file, vma);
1786 }
1787
1788 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1789                               unsigned long nr_segs, unsigned long fast_segs,
1790                               struct iovec *fast_pointer,
1791                               struct iovec **ret_pointer);
1792
1793 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1794 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1795 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1796 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1797                 unsigned long, loff_t *, rwf_t);
1798 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1799                                    loff_t, size_t, unsigned int);
1800 extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1801                                       struct inode *inode_out, loff_t pos_out,
1802                                       u64 *len, bool is_dedupe);
1803 extern int do_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_clone_file_range(struct file *file_in, loff_t pos_in,
1806                                 struct file *file_out, loff_t pos_out, u64 len);
1807 extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1808                                          struct inode *dest, loff_t destoff,
1809                                          loff_t len, bool *is_same);
1810 extern int vfs_dedupe_file_range(struct file *file,
1811                                  struct file_dedupe_range *same);
1812
1813 struct super_operations {
1814         struct inode *(*alloc_inode)(struct super_block *sb);
1815         void (*destroy_inode)(struct inode *);
1816
1817         void (*dirty_inode) (struct inode *, int flags);
1818         int (*write_inode) (struct inode *, struct writeback_control *wbc);
1819         int (*drop_inode) (struct inode *);
1820         void (*evict_inode) (struct inode *);
1821         void (*put_super) (struct super_block *);
1822         int (*sync_fs)(struct super_block *sb, int wait);
1823         int (*freeze_super) (struct super_block *);
1824         int (*freeze_fs) (struct super_block *);
1825         int (*thaw_super) (struct super_block *);
1826         int (*unfreeze_fs) (struct super_block *);
1827         int (*statfs) (struct dentry *, struct kstatfs *);
1828         int (*remount_fs) (struct super_block *, int *, char *);
1829         void (*umount_begin) (struct super_block *);
1830
1831         int (*show_options)(struct seq_file *, struct dentry *);
1832         int (*show_devname)(struct seq_file *, struct dentry *);
1833         int (*show_path)(struct seq_file *, struct dentry *);
1834         int (*show_stats)(struct seq_file *, struct dentry *);
1835 #ifdef CONFIG_QUOTA
1836         ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1837         ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1838         struct dquot **(*get_dquots)(struct inode *);
1839 #endif
1840         int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1841         long (*nr_cached_objects)(struct super_block *,
1842                                   struct shrink_control *);
1843         long (*free_cached_objects)(struct super_block *,
1844                                     struct shrink_control *);
1845 };
1846
1847 /*
1848  * Inode flags - they have no relation to superblock flags now
1849  */
1850 #define S_SYNC          1       /* Writes are synced at once */
1851 #define S_NOATIME       2       /* Do not update access times */
1852 #define S_APPEND        4       /* Append-only file */
1853 #define S_IMMUTABLE     8       /* Immutable file */
1854 #define S_DEAD          16      /* removed, but still open directory */
1855 #define S_NOQUOTA       32      /* Inode is not counted to quota */
1856 #define S_DIRSYNC       64      /* Directory modifications are synchronous */
1857 #define S_NOCMTIME      128     /* Do not update file c/mtime */
1858 #define S_SWAPFILE      256     /* Do not truncate: swapon got its bmaps */
1859 #define S_PRIVATE       512     /* Inode is fs-internal */
1860 #define S_IMA           1024    /* Inode has an associated IMA struct */
1861 #define S_AUTOMOUNT     2048    /* Automount/referral quasi-directory */
1862 #define S_NOSEC         4096    /* no suid or xattr security attributes */
1863 #ifdef CONFIG_FS_DAX
1864 #define S_DAX           8192    /* Direct Access, avoiding the page cache */
1865 #else
1866 #define S_DAX           0       /* Make all the DAX code disappear */
1867 #endif
1868
1869 /*
1870  * Note that nosuid etc flags are inode-specific: setting some file-system
1871  * flags just means all the inodes inherit those flags by default. It might be
1872  * possible to override it selectively if you really wanted to with some
1873  * ioctl() that is not currently implemented.
1874  *
1875  * Exception: SB_RDONLY is always applied to the entire file system.
1876  *
1877  * Unfortunately, it is possible to change a filesystems flags with it mounted
1878  * with files in use.  This means that all of the inodes will not have their
1879  * i_flags updated.  Hence, i_flags no longer inherit the superblock mount
1880  * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1881  */
1882 #define __IS_FLG(inode, flg)    ((inode)->i_sb->s_flags & (flg))
1883
1884 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & MS_RDONLY; }
1885 #define IS_RDONLY(inode)        sb_rdonly((inode)->i_sb)
1886 #define IS_SYNC(inode)          (__IS_FLG(inode, SB_SYNCHRONOUS) || \
1887                                         ((inode)->i_flags & S_SYNC))
1888 #define IS_DIRSYNC(inode)       (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
1889                                         ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1890 #define IS_MANDLOCK(inode)      __IS_FLG(inode, SB_MANDLOCK)
1891 #define IS_NOATIME(inode)       __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1892 #define IS_I_VERSION(inode)     __IS_FLG(inode, SB_I_VERSION)
1893
1894 #define IS_NOQUOTA(inode)       ((inode)->i_flags & S_NOQUOTA)
1895 #define IS_APPEND(inode)        ((inode)->i_flags & S_APPEND)
1896 #define IS_IMMUTABLE(inode)     ((inode)->i_flags & S_IMMUTABLE)
1897 #define IS_POSIXACL(inode)      __IS_FLG(inode, SB_POSIXACL)
1898
1899 #define IS_DEADDIR(inode)       ((inode)->i_flags & S_DEAD)
1900 #define IS_NOCMTIME(inode)      ((inode)->i_flags & S_NOCMTIME)
1901 #define IS_SWAPFILE(inode)      ((inode)->i_flags & S_SWAPFILE)
1902 #define IS_PRIVATE(inode)       ((inode)->i_flags & S_PRIVATE)
1903 #define IS_IMA(inode)           ((inode)->i_flags & S_IMA)
1904 #define IS_AUTOMOUNT(inode)     ((inode)->i_flags & S_AUTOMOUNT)
1905 #define IS_NOSEC(inode)         ((inode)->i_flags & S_NOSEC)
1906 #define IS_DAX(inode)           ((inode)->i_flags & S_DAX)
1907
1908 #define IS_WHITEOUT(inode)      (S_ISCHR(inode->i_mode) && \
1909                                  (inode)->i_rdev == WHITEOUT_DEV)
1910
1911 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1912 {
1913         return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1914 }
1915
1916 static inline enum rw_hint file_write_hint(struct file *file)
1917 {
1918         if (file->f_write_hint != WRITE_LIFE_NOT_SET)
1919                 return file->f_write_hint;
1920
1921         return file_inode(file)->i_write_hint;
1922 }
1923
1924 static inline int iocb_flags(struct file *file);
1925
1926 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
1927 {
1928         *kiocb = (struct kiocb) {
1929                 .ki_filp = filp,
1930                 .ki_flags = iocb_flags(filp),
1931                 .ki_hint = file_write_hint(filp),
1932         };
1933 }
1934
1935 /*
1936  * Inode state bits.  Protected by inode->i_lock
1937  *
1938  * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1939  * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1940  *
1941  * Four bits define the lifetime of an inode.  Initially, inodes are I_NEW,
1942  * until that flag is cleared.  I_WILL_FREE, I_FREEING and I_CLEAR are set at
1943  * various stages of removing an inode.
1944  *
1945  * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1946  *
1947  * I_DIRTY_SYNC         Inode is dirty, but doesn't have to be written on
1948  *                      fdatasync().  i_atime is the usual cause.
1949  * I_DIRTY_DATASYNC     Data-related inode changes pending. We keep track of
1950  *                      these changes separately from I_DIRTY_SYNC so that we
1951  *                      don't have to write inode on fdatasync() when only
1952  *                      mtime has changed in it.
1953  * I_DIRTY_PAGES        Inode has dirty pages.  Inode itself may be clean.
1954  * I_NEW                Serves as both a mutex and completion notification.
1955  *                      New inodes set I_NEW.  If two processes both create
1956  *                      the same inode, one of them will release its inode and
1957  *                      wait for I_NEW to be released before returning.
1958  *                      Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1959  *                      also cause waiting on I_NEW, without I_NEW actually
1960  *                      being set.  find_inode() uses this to prevent returning
1961  *                      nearly-dead inodes.
1962  * I_WILL_FREE          Must be set when calling write_inode_now() if i_count
1963  *                      is zero.  I_FREEING must be set when I_WILL_FREE is
1964  *                      cleared.
1965  * I_FREEING            Set when inode is about to be freed but still has dirty
1966  *                      pages or buffers attached or the inode itself is still
1967  *                      dirty.
1968  * I_CLEAR              Added by clear_inode().  In this state the inode is
1969  *                      clean and can be destroyed.  Inode keeps I_FREEING.
1970  *
1971  *                      Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1972  *                      prohibited for many purposes.  iget() must wait for
1973  *                      the inode to be completely released, then create it
1974  *                      anew.  Other functions will just ignore such inodes,
1975  *                      if appropriate.  I_NEW is used for waiting.
1976  *
1977  * I_SYNC               Writeback of inode is running. The bit is set during
1978  *                      data writeback, and cleared with a wakeup on the bit
1979  *                      address once it is done. The bit is also used to pin
1980  *                      the inode in memory for flusher thread.
1981  *
1982  * I_REFERENCED         Marks the inode as recently references on the LRU list.
1983  *
1984  * I_DIO_WAKEUP         Never set.  Only used as a key for wait_on_bit().
1985  *
1986  * I_WB_SWITCH          Cgroup bdi_writeback switching in progress.  Used to
1987  *                      synchronize competing switching instances and to tell
1988  *                      wb stat updates to grab mapping->tree_lock.  See
1989  *                      inode_switch_wb_work_fn() for details.
1990  *
1991  * I_OVL_INUSE          Used by overlayfs to get exclusive ownership on upper
1992  *                      and work dirs among overlayfs mounts.
1993  *
1994  * I_SYNC_QUEUED        Inode is queued in b_io or b_more_io writeback lists.
1995  *                      Used to detect that mark_inode_dirty() should not move
1996  *                      inode between dirty lists.
1997  *
1998  * Q: What is the difference between I_WILL_FREE and I_FREEING?
1999  */
2000 #define I_DIRTY_SYNC            (1 << 0)
2001 #define I_DIRTY_DATASYNC        (1 << 1)
2002 #define I_DIRTY_PAGES           (1 << 2)
2003 #define __I_NEW                 3
2004 #define I_NEW                   (1 << __I_NEW)
2005 #define I_WILL_FREE             (1 << 4)
2006 #define I_FREEING               (1 << 5)
2007 #define I_CLEAR                 (1 << 6)
2008 #define __I_SYNC                7
2009 #define I_SYNC                  (1 << __I_SYNC)
2010 #define I_REFERENCED            (1 << 8)
2011 #define __I_DIO_WAKEUP          9
2012 #define I_DIO_WAKEUP            (1 << __I_DIO_WAKEUP)
2013 #define I_LINKABLE              (1 << 10)
2014 #define I_DIRTY_TIME            (1 << 11)
2015 #define I_WB_SWITCH             (1 << 13)
2016 #define I_OVL_INUSE                     (1 << 14)
2017 #define I_SYNC_QUEUED           (1 << 17)
2018
2019 #define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2020 #define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2021 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
2022
2023 extern void __mark_inode_dirty(struct inode *, int);
2024 static inline void mark_inode_dirty(struct inode *inode)
2025 {
2026         __mark_inode_dirty(inode, I_DIRTY);
2027 }
2028
2029 static inline void mark_inode_dirty_sync(struct inode *inode)
2030 {
2031         __mark_inode_dirty(inode, I_DIRTY_SYNC);
2032 }
2033
2034 extern void inc_nlink(struct inode *inode);
2035 extern void drop_nlink(struct inode *inode);
2036 extern void clear_nlink(struct inode *inode);
2037 extern void set_nlink(struct inode *inode, unsigned int nlink);
2038
2039 static inline void inode_inc_link_count(struct inode *inode)
2040 {
2041         inc_nlink(inode);
2042         mark_inode_dirty(inode);
2043 }
2044
2045 static inline void inode_dec_link_count(struct inode *inode)
2046 {
2047         drop_nlink(inode);
2048         mark_inode_dirty(inode);
2049 }
2050
2051 /**
2052  * inode_inc_iversion - increments i_version
2053  * @inode: inode that need to be updated
2054  *
2055  * Every time the inode is modified, the i_version field will be incremented.
2056  * The filesystem has to be mounted with i_version flag
2057  */
2058
2059 static inline void inode_inc_iversion(struct inode *inode)
2060 {
2061        spin_lock(&inode->i_lock);
2062        inode->i_version++;
2063        spin_unlock(&inode->i_lock);
2064 }
2065
2066 enum file_time_flags {
2067         S_ATIME = 1,
2068         S_MTIME = 2,
2069         S_CTIME = 4,
2070         S_VERSION = 8,
2071 };
2072
2073 extern void touch_atime(const struct path *);
2074 static inline void file_accessed(struct file *file)
2075 {
2076         if (!(file->f_flags & O_NOATIME))
2077                 touch_atime(&file->f_path);
2078 }
2079
2080 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2081 int sync_inode_metadata(struct inode *inode, int wait);
2082
2083 struct file_system_type {
2084         const char *name;
2085         int fs_flags;
2086 #define FS_REQUIRES_DEV         1 
2087 #define FS_BINARY_MOUNTDATA     2
2088 #define FS_HAS_SUBTYPE          4
2089 #define FS_USERNS_MOUNT         8       /* Can be mounted by userns root */
2090 #define FS_RENAME_DOES_D_MOVE   32768   /* FS will handle d_move() during rename() internally. */
2091         struct dentry *(*mount) (struct file_system_type *, int,
2092                        const char *, void *);
2093         void (*kill_sb) (struct super_block *);
2094         struct module *owner;
2095         struct file_system_type * next;
2096         struct hlist_head fs_supers;
2097
2098         struct lock_class_key s_lock_key;
2099         struct lock_class_key s_umount_key;
2100         struct lock_class_key s_vfs_rename_key;
2101         struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2102
2103         struct lock_class_key i_lock_key;
2104         struct lock_class_key i_mutex_key;
2105         struct lock_class_key i_mutex_dir_key;
2106 };
2107
2108 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2109
2110 extern struct dentry *mount_ns(struct file_system_type *fs_type,
2111         int flags, void *data, void *ns, struct user_namespace *user_ns,
2112         int (*fill_super)(struct super_block *, void *, int));
2113 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2114         int flags, const char *dev_name, void *data,
2115         int (*fill_super)(struct super_block *, void *, int));
2116 extern struct dentry *mount_single(struct file_system_type *fs_type,
2117         int flags, void *data,
2118         int (*fill_super)(struct super_block *, void *, int));
2119 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2120         int flags, void *data,
2121         int (*fill_super)(struct super_block *, void *, int));
2122 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2123 void generic_shutdown_super(struct super_block *sb);
2124 void kill_block_super(struct super_block *sb);
2125 void kill_anon_super(struct super_block *sb);
2126 void kill_litter_super(struct super_block *sb);
2127 void deactivate_super(struct super_block *sb);
2128 void deactivate_locked_super(struct super_block *sb);
2129 int set_anon_super(struct super_block *s, void *data);
2130 int get_anon_bdev(dev_t *);
2131 void free_anon_bdev(dev_t);
2132 struct super_block *sget_userns(struct file_system_type *type,
2133                         int (*test)(struct super_block *,void *),
2134                         int (*set)(struct super_block *,void *),
2135                         int flags, struct user_namespace *user_ns,
2136                         void *data);
2137 struct super_block *sget(struct file_system_type *type,
2138                         int (*test)(struct super_block *,void *),
2139                         int (*set)(struct super_block *,void *),
2140                         int flags, void *data);
2141 extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2142                                          const struct super_operations *ops,
2143                                          const struct xattr_handler **xattr,
2144                                          const struct dentry_operations *dops,
2145                                          unsigned long);
2146
2147 static inline struct dentry *
2148 mount_pseudo(struct file_system_type *fs_type, char *name,
2149              const struct super_operations *ops,
2150              const struct dentry_operations *dops, unsigned long magic)
2151 {
2152         return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2153 }
2154
2155 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2156 #define fops_get(fops) \
2157         (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2158 #define fops_put(fops) \
2159         do { if (fops) module_put((fops)->owner); } while(0)
2160 /*
2161  * This one is to be used *ONLY* from ->open() instances.
2162  * fops must be non-NULL, pinned down *and* module dependencies
2163  * should be sufficient to pin the caller down as well.
2164  */
2165 #define replace_fops(f, fops) \
2166         do {    \
2167                 struct file *__file = (f); \
2168                 fops_put(__file->f_op); \
2169                 BUG_ON(!(__file->f_op = (fops))); \
2170         } while(0)
2171
2172 extern int register_filesystem(struct file_system_type *);
2173 extern int unregister_filesystem(struct file_system_type *);
2174 extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2175 #define kern_mount(type) kern_mount_data(type, NULL)
2176 extern void kern_unmount(struct vfsmount *mnt);
2177 extern int may_umount_tree(struct vfsmount *);
2178 extern int may_umount(struct vfsmount *);
2179 extern long do_mount(const char *, const char __user *,
2180                      const char *, unsigned long, void *);
2181 extern struct vfsmount *collect_mounts(const struct path *);
2182 extern void drop_collected_mounts(struct vfsmount *);
2183 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2184                           struct vfsmount *);
2185 extern int vfs_statfs(const struct path *, struct kstatfs *);
2186 extern int user_statfs(const char __user *, struct kstatfs *);
2187 extern int fd_statfs(int, struct kstatfs *);
2188 extern int vfs_ustat(dev_t, struct kstatfs *);
2189 extern int freeze_super(struct super_block *super);
2190 extern int thaw_super(struct super_block *super);
2191 extern bool our_mnt(struct vfsmount *mnt);
2192 extern __printf(2, 3)
2193 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2194 extern int super_setup_bdi(struct super_block *sb);
2195
2196 extern int current_umask(void);
2197
2198 extern void ihold(struct inode * inode);
2199 extern void iput(struct inode *);
2200 extern int generic_update_time(struct inode *, struct timespec *, int);
2201
2202 /* /sys/fs */
2203 extern struct kobject *fs_kobj;
2204
2205 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2206
2207 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2208 extern int locks_mandatory_locked(struct file *);
2209 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2210
2211 /*
2212  * Candidates for mandatory locking have the setgid bit set
2213  * but no group execute bit -  an otherwise meaningless combination.
2214  */
2215
2216 static inline int __mandatory_lock(struct inode *ino)
2217 {
2218         return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2219 }
2220
2221 /*
2222  * ... and these candidates should be on SB_MANDLOCK mounted fs,
2223  * otherwise these will be advisory locks
2224  */
2225
2226 static inline int mandatory_lock(struct inode *ino)
2227 {
2228         return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2229 }
2230
2231 static inline int locks_verify_locked(struct file *file)
2232 {
2233         if (mandatory_lock(locks_inode(file)))
2234                 return locks_mandatory_locked(file);
2235         return 0;
2236 }
2237
2238 static inline int locks_verify_truncate(struct inode *inode,
2239                                     struct file *f,
2240                                     loff_t size)
2241 {
2242         if (!inode->i_flctx || !mandatory_lock(inode))
2243                 return 0;
2244
2245         if (size < inode->i_size) {
2246                 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2247                                 F_WRLCK);
2248         } else {
2249                 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2250                                 F_WRLCK);
2251         }
2252 }
2253
2254 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2255
2256 static inline int locks_mandatory_locked(struct file *file)
2257 {
2258         return 0;
2259 }
2260
2261 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2262                                        loff_t start, loff_t end, unsigned char type)
2263 {
2264         return 0;
2265 }
2266
2267 static inline int __mandatory_lock(struct inode *inode)
2268 {
2269         return 0;
2270 }
2271
2272 static inline int mandatory_lock(struct inode *inode)
2273 {
2274         return 0;
2275 }
2276
2277 static inline int locks_verify_locked(struct file *file)
2278 {
2279         return 0;
2280 }
2281
2282 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2283                                         size_t size)
2284 {
2285         return 0;
2286 }
2287
2288 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2289
2290
2291 #ifdef CONFIG_FILE_LOCKING
2292 static inline int break_lease(struct inode *inode, unsigned int mode)
2293 {
2294         /*
2295          * Since this check is lockless, we must ensure that any refcounts
2296          * taken are done before checking i_flctx->flc_lease. Otherwise, we
2297          * could end up racing with tasks trying to set a new lease on this
2298          * file.
2299          */
2300         smp_mb();
2301         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2302                 return __break_lease(inode, mode, FL_LEASE);
2303         return 0;
2304 }
2305
2306 static inline int break_deleg(struct inode *inode, unsigned int mode)
2307 {
2308         /*
2309          * Since this check is lockless, we must ensure that any refcounts
2310          * taken are done before checking i_flctx->flc_lease. Otherwise, we
2311          * could end up racing with tasks trying to set a new lease on this
2312          * file.
2313          */
2314         smp_mb();
2315         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2316                 return __break_lease(inode, mode, FL_DELEG);
2317         return 0;
2318 }
2319
2320 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2321 {
2322         int ret;
2323
2324         ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2325         if (ret == -EWOULDBLOCK && delegated_inode) {
2326                 *delegated_inode = inode;
2327                 ihold(inode);
2328         }
2329         return ret;
2330 }
2331
2332 static inline int break_deleg_wait(struct inode **delegated_inode)
2333 {
2334         int ret;
2335
2336         ret = break_deleg(*delegated_inode, O_WRONLY);
2337         iput(*delegated_inode);
2338         *delegated_inode = NULL;
2339         return ret;
2340 }
2341
2342 static inline int break_layout(struct inode *inode, bool wait)
2343 {
2344         smp_mb();
2345         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2346                 return __break_lease(inode,
2347                                 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2348                                 FL_LAYOUT);
2349         return 0;
2350 }
2351
2352 #else /* !CONFIG_FILE_LOCKING */
2353 static inline int break_lease(struct inode *inode, unsigned int mode)
2354 {
2355         return 0;
2356 }
2357
2358 static inline int break_deleg(struct inode *inode, unsigned int mode)
2359 {
2360         return 0;
2361 }
2362
2363 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2364 {
2365         return 0;
2366 }
2367
2368 static inline int break_deleg_wait(struct inode **delegated_inode)
2369 {
2370         BUG();
2371         return 0;
2372 }
2373
2374 static inline int break_layout(struct inode *inode, bool wait)
2375 {
2376         return 0;
2377 }
2378
2379 #endif /* CONFIG_FILE_LOCKING */
2380
2381 /* fs/open.c */
2382 struct audit_names;
2383 struct filename {
2384         const char              *name;  /* pointer to actual string */
2385         const __user char       *uptr;  /* original userland pointer */
2386         struct audit_names      *aname;
2387         int                     refcnt;
2388         const char              iname[];
2389 };
2390
2391 extern long vfs_truncate(const struct path *, loff_t);
2392 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2393                        struct file *filp);
2394 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2395                         loff_t len);
2396 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2397                         umode_t mode);
2398 extern struct file *file_open_name(struct filename *, int, umode_t);
2399 extern struct file *filp_open(const char *, int, umode_t);
2400 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2401                                    const char *, int, umode_t);
2402 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2403 extern int filp_close(struct file *, fl_owner_t id);
2404
2405 extern struct filename *getname_flags(const char __user *, int, int *);
2406 extern struct filename *getname(const char __user *);
2407 extern struct filename *getname_kernel(const char *);
2408 extern void putname(struct filename *name);
2409
2410 enum {
2411         FILE_CREATED = 1,
2412         FILE_OPENED = 2
2413 };
2414 extern int finish_open(struct file *file, struct dentry *dentry,
2415                         int (*open)(struct inode *, struct file *),
2416                         int *opened);
2417 extern int finish_no_open(struct file *file, struct dentry *dentry);
2418
2419 /* fs/ioctl.c */
2420
2421 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2422
2423 /* fs/dcache.c */
2424 extern void __init vfs_caches_init_early(void);
2425 extern void __init vfs_caches_init(void);
2426
2427 extern struct kmem_cache *names_cachep;
2428
2429 #define __getname()             kmem_cache_alloc(names_cachep, GFP_KERNEL)
2430 #define __putname(name)         kmem_cache_free(names_cachep, (void *)(name))
2431
2432 #ifdef CONFIG_BLOCK
2433 extern int register_blkdev(unsigned int, const char *);
2434 extern void unregister_blkdev(unsigned int, const char *);
2435 extern void bdev_unhash_inode(dev_t dev);
2436 extern struct block_device *bdget(dev_t);
2437 extern struct block_device *bdgrab(struct block_device *bdev);
2438 extern void bd_set_size(struct block_device *, loff_t size);
2439 extern void bd_forget(struct inode *inode);
2440 extern void bdput(struct block_device *);
2441 extern void invalidate_bdev(struct block_device *);
2442 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
2443 extern int sync_blockdev(struct block_device *bdev);
2444 extern void kill_bdev(struct block_device *);
2445 extern struct super_block *freeze_bdev(struct block_device *);
2446 extern void emergency_thaw_all(void);
2447 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2448 extern int fsync_bdev(struct block_device *);
2449
2450 extern struct super_block *blockdev_superblock;
2451
2452 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2453 {
2454         return sb == blockdev_superblock;
2455 }
2456 #else
2457 static inline void bd_forget(struct inode *inode) {}
2458 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2459 static inline void kill_bdev(struct block_device *bdev) {}
2460 static inline void invalidate_bdev(struct block_device *bdev) {}
2461
2462 static inline struct super_block *freeze_bdev(struct block_device *sb)
2463 {
2464         return NULL;
2465 }
2466
2467 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2468 {
2469         return 0;
2470 }
2471
2472 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2473 {
2474 }
2475
2476 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2477 {
2478         return false;
2479 }
2480 #endif
2481 extern int sync_filesystem(struct super_block *);
2482 extern const struct file_operations def_blk_fops;
2483 extern const struct file_operations def_chr_fops;
2484 #ifdef CONFIG_BLOCK
2485 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2486 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2487 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2488 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2489 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2490                                                void *holder);
2491 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2492                                               void *holder);
2493 extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2494 extern int __blkdev_reread_part(struct block_device *bdev);
2495 extern int blkdev_reread_part(struct block_device *bdev);
2496
2497 #ifdef CONFIG_SYSFS
2498 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2499 extern void bd_unlink_disk_holder(struct block_device *bdev,
2500                                   struct gendisk *disk);
2501 #else
2502 static inline int bd_link_disk_holder(struct block_device *bdev,
2503                                       struct gendisk *disk)
2504 {
2505         return 0;
2506 }
2507 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2508                                          struct gendisk *disk)
2509 {
2510 }
2511 #endif
2512 #endif
2513
2514 /* fs/char_dev.c */
2515 #define CHRDEV_MAJOR_MAX 512
2516 /* Marks the bottom of the first segment of free char majors */
2517 #define CHRDEV_MAJOR_DYN_END 234
2518 /* Marks the top and bottom of the second segment of free char majors */
2519 #define CHRDEV_MAJOR_DYN_EXT_START 511
2520 #define CHRDEV_MAJOR_DYN_EXT_END 384
2521
2522 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2523 extern int register_chrdev_region(dev_t, unsigned, const char *);
2524 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2525                              unsigned int count, const char *name,
2526                              const struct file_operations *fops);
2527 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2528                                 unsigned int count, const char *name);
2529 extern void unregister_chrdev_region(dev_t, unsigned);
2530 extern void chrdev_show(struct seq_file *,off_t);
2531
2532 static inline int register_chrdev(unsigned int major, const char *name,
2533                                   const struct file_operations *fops)
2534 {
2535         return __register_chrdev(major, 0, 256, name, fops);
2536 }
2537
2538 static inline void unregister_chrdev(unsigned int major, const char *name)
2539 {
2540         __unregister_chrdev(major, 0, 256, name);
2541 }
2542
2543 /* fs/block_dev.c */
2544 #define BDEVNAME_SIZE   32      /* Largest string for a blockdev identifier */
2545 #define BDEVT_SIZE      10      /* Largest string for MAJ:MIN for blkdev */
2546
2547 #ifdef CONFIG_BLOCK
2548 #define BLKDEV_MAJOR_MAX        512
2549 extern const char *__bdevname(dev_t, char *buffer);
2550 extern const char *bdevname(struct block_device *bdev, char *buffer);
2551 extern struct block_device *lookup_bdev(const char *);
2552 extern void blkdev_show(struct seq_file *,off_t);
2553
2554 #else
2555 #define BLKDEV_MAJOR_MAX        0
2556 #endif
2557
2558 extern void init_special_inode(struct inode *, umode_t, dev_t);
2559
2560 /* Invalid inode operations -- fs/bad_inode.c */
2561 extern void make_bad_inode(struct inode *);
2562 extern bool is_bad_inode(struct inode *);
2563
2564 #ifdef CONFIG_BLOCK
2565 extern void check_disk_size_change(struct gendisk *disk,
2566                                    struct block_device *bdev);
2567 extern int revalidate_disk(struct gendisk *);
2568 extern int check_disk_change(struct block_device *);
2569 extern int __invalidate_device(struct block_device *, bool);
2570 extern int invalidate_partition(struct gendisk *, int);
2571 #endif
2572 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2573                                         pgoff_t start, pgoff_t end);
2574
2575 static inline void invalidate_remote_inode(struct inode *inode)
2576 {
2577         if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2578             S_ISLNK(inode->i_mode))
2579                 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2580 }
2581 extern int invalidate_inode_pages2(struct address_space *mapping);
2582 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2583                                          pgoff_t start, pgoff_t end);
2584 extern int write_inode_now(struct inode *, int);
2585 extern int filemap_fdatawrite(struct address_space *);
2586 extern int filemap_flush(struct address_space *);
2587 extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2588 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2589                                    loff_t lend);
2590 extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2591                 loff_t start_byte, loff_t end_byte);
2592
2593 static inline int filemap_fdatawait(struct address_space *mapping)
2594 {
2595         return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2596 }
2597
2598 extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2599                                   loff_t lend);
2600 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2601                                                 loff_t lend);
2602 extern int filemap_write_and_wait(struct address_space *mapping);
2603 extern int filemap_write_and_wait_range(struct address_space *mapping,
2604                                         loff_t lstart, loff_t lend);
2605 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2606                                 loff_t start, loff_t end, int sync_mode);
2607 extern int filemap_fdatawrite_range(struct address_space *mapping,
2608                                 loff_t start, loff_t end);
2609 extern int filemap_check_errors(struct address_space *mapping);
2610 extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2611
2612 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2613                                                 loff_t lend);
2614 extern int __must_check file_check_and_advance_wb_err(struct file *file);
2615 extern int __must_check file_write_and_wait_range(struct file *file,
2616                                                 loff_t start, loff_t end);
2617
2618 static inline int file_write_and_wait(struct file *file)
2619 {
2620         return file_write_and_wait_range(file, 0, LLONG_MAX);
2621 }
2622
2623 /**
2624  * filemap_set_wb_err - set a writeback error on an address_space
2625  * @mapping: mapping in which to set writeback error
2626  * @err: error to be set in mapping
2627  *
2628  * When writeback fails in some way, we must record that error so that
2629  * userspace can be informed when fsync and the like are called.  We endeavor
2630  * to report errors on any file that was open at the time of the error.  Some
2631  * internal callers also need to know when writeback errors have occurred.
2632  *
2633  * When a writeback error occurs, most filesystems will want to call
2634  * filemap_set_wb_err to record the error in the mapping so that it will be
2635  * automatically reported whenever fsync is called on the file.
2636  */
2637 static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2638 {
2639         /* Fastpath for common case of no error */
2640         if (unlikely(err))
2641                 __filemap_set_wb_err(mapping, err);
2642 }
2643
2644 /**
2645  * filemap_check_wb_error - has an error occurred since the mark was sampled?
2646  * @mapping: mapping to check for writeback errors
2647  * @since: previously-sampled errseq_t
2648  *
2649  * Grab the errseq_t value from the mapping, and see if it has changed "since"
2650  * the given value was sampled.
2651  *
2652  * If it has then report the latest error set, otherwise return 0.
2653  */
2654 static inline int filemap_check_wb_err(struct address_space *mapping,
2655                                         errseq_t since)
2656 {
2657         return errseq_check(&mapping->wb_err, since);
2658 }
2659
2660 /**
2661  * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2662  * @mapping: mapping to be sampled
2663  *
2664  * Writeback errors are always reported relative to a particular sample point
2665  * in the past. This function provides those sample points.
2666  */
2667 static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2668 {
2669         return errseq_sample(&mapping->wb_err);
2670 }
2671
2672 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2673                            int datasync);
2674 extern int vfs_fsync(struct file *file, int datasync);
2675
2676 /*
2677  * Sync the bytes written if this was a synchronous write.  Expect ki_pos
2678  * to already be updated for the write, and will return either the amount
2679  * of bytes passed in, or an error if syncing the file failed.
2680  */
2681 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2682 {
2683         if (iocb->ki_flags & IOCB_DSYNC) {
2684                 int ret = vfs_fsync_range(iocb->ki_filp,
2685                                 iocb->ki_pos - count, iocb->ki_pos - 1,
2686                                 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2687                 if (ret)
2688                         return ret;
2689         }
2690
2691         return count;
2692 }
2693
2694 extern void emergency_sync(void);
2695 extern void emergency_remount(void);
2696 #ifdef CONFIG_BLOCK
2697 extern sector_t bmap(struct inode *, sector_t);
2698 #endif
2699 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2700 extern int inode_permission(struct inode *, int);
2701 extern int __inode_permission(struct inode *, int);
2702 extern int generic_permission(struct inode *, int);
2703 extern int __check_sticky(struct inode *dir, struct inode *inode);
2704
2705 static inline bool execute_ok(struct inode *inode)
2706 {
2707         return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2708 }
2709
2710 static inline void file_start_write(struct file *file)
2711 {
2712         if (!S_ISREG(file_inode(file)->i_mode))
2713                 return;
2714         __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2715 }
2716
2717 static inline bool file_start_write_trylock(struct file *file)
2718 {
2719         if (!S_ISREG(file_inode(file)->i_mode))
2720                 return true;
2721         return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2722 }
2723
2724 static inline void file_end_write(struct file *file)
2725 {
2726         if (!S_ISREG(file_inode(file)->i_mode))
2727                 return;
2728         __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2729 }
2730
2731 /*
2732  * get_write_access() gets write permission for a file.
2733  * put_write_access() releases this write permission.
2734  * This is used for regular files.
2735  * We cannot support write (and maybe mmap read-write shared) accesses and
2736  * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2737  * can have the following values:
2738  * 0: no writers, no VM_DENYWRITE mappings
2739  * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2740  * > 0: (i_writecount) users are writing to the file.
2741  *
2742  * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2743  * except for the cases where we don't hold i_writecount yet. Then we need to
2744  * use {get,deny}_write_access() - these functions check the sign and refuse
2745  * to do the change if sign is wrong.
2746  */
2747 static inline int get_write_access(struct inode *inode)
2748 {
2749         return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2750 }
2751 static inline int deny_write_access(struct file *file)
2752 {
2753         struct inode *inode = file_inode(file);
2754         return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2755 }
2756 static inline void put_write_access(struct inode * inode)
2757 {
2758         atomic_dec(&inode->i_writecount);
2759 }
2760 static inline void allow_write_access(struct file *file)
2761 {
2762         if (file)
2763                 atomic_inc(&file_inode(file)->i_writecount);
2764 }
2765 static inline bool inode_is_open_for_write(const struct inode *inode)
2766 {
2767         return atomic_read(&inode->i_writecount) > 0;
2768 }
2769
2770 #ifdef CONFIG_IMA
2771 static inline void i_readcount_dec(struct inode *inode)
2772 {
2773         BUG_ON(!atomic_read(&inode->i_readcount));
2774         atomic_dec(&inode->i_readcount);
2775 }
2776 static inline void i_readcount_inc(struct inode *inode)
2777 {
2778         atomic_inc(&inode->i_readcount);
2779 }
2780 #else
2781 static inline void i_readcount_dec(struct inode *inode)
2782 {
2783         return;
2784 }
2785 static inline void i_readcount_inc(struct inode *inode)
2786 {
2787         return;
2788 }
2789 #endif
2790 extern int do_pipe_flags(int *, int);
2791
2792 #define __kernel_read_file_id(id) \
2793         id(UNKNOWN, unknown)            \
2794         id(FIRMWARE, firmware)          \
2795         id(FIRMWARE_PREALLOC_BUFFER, firmware)  \
2796         id(MODULE, kernel-module)               \
2797         id(KEXEC_IMAGE, kexec-image)            \
2798         id(KEXEC_INITRAMFS, kexec-initramfs)    \
2799         id(POLICY, security-policy)             \
2800         id(MAX_ID, )
2801
2802 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2803 #define __fid_stringify(dummy, str) #str,
2804
2805 enum kernel_read_file_id {
2806         __kernel_read_file_id(__fid_enumify)
2807 };
2808
2809 static const char * const kernel_read_file_str[] = {
2810         __kernel_read_file_id(__fid_stringify)
2811 };
2812
2813 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2814 {
2815         if ((unsigned)id >= READING_MAX_ID)
2816                 return kernel_read_file_str[READING_UNKNOWN];
2817
2818         return kernel_read_file_str[id];
2819 }
2820
2821 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2822                             enum kernel_read_file_id);
2823 extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2824                                       enum kernel_read_file_id);
2825 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2826                                     enum kernel_read_file_id);
2827 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2828 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2829 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
2830 extern struct file * open_exec(const char *);
2831  
2832 /* fs/dcache.c -- generic fs support functions */
2833 extern bool is_subdir(struct dentry *, struct dentry *);
2834 extern bool path_is_under(const struct path *, const struct path *);
2835
2836 extern char *file_path(struct file *, char *, int);
2837
2838 #include <linux/err.h>
2839
2840 /* needed for stackable file system support */
2841 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2842
2843 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2844
2845 extern int inode_init_always(struct super_block *, struct inode *);
2846 extern void inode_init_once(struct inode *);
2847 extern void address_space_init_once(struct address_space *mapping);
2848 extern struct inode * igrab(struct inode *);
2849 extern ino_t iunique(struct super_block *, ino_t);
2850 extern int inode_needs_sync(struct inode *inode);
2851 extern int generic_delete_inode(struct inode *inode);
2852 static inline int generic_drop_inode(struct inode *inode)
2853 {
2854         return !inode->i_nlink || inode_unhashed(inode);
2855 }
2856
2857 extern struct inode *ilookup5_nowait(struct super_block *sb,
2858                 unsigned long hashval, int (*test)(struct inode *, void *),
2859                 void *data);
2860 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2861                 int (*test)(struct inode *, void *), void *data);
2862 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2863
2864 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2865 extern struct inode * iget_locked(struct super_block *, unsigned long);
2866 extern struct inode *find_inode_nowait(struct super_block *,
2867                                        unsigned long,
2868                                        int (*match)(struct inode *,
2869                                                     unsigned long, void *),
2870                                        void *data);
2871 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2872 extern int insert_inode_locked(struct inode *);
2873 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2874 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2875 #else
2876 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2877 #endif
2878 extern void unlock_new_inode(struct inode *);
2879 extern unsigned int get_next_ino(void);
2880 extern void evict_inodes(struct super_block *sb);
2881
2882 extern void __iget(struct inode * inode);
2883 extern void iget_failed(struct inode *);
2884 extern void clear_inode(struct inode *);
2885 extern void __destroy_inode(struct inode *);
2886 extern struct inode *new_inode_pseudo(struct super_block *sb);
2887 extern struct inode *new_inode(struct super_block *sb);
2888 extern void free_inode_nonrcu(struct inode *inode);
2889 extern int should_remove_suid(struct dentry *);
2890 extern int file_remove_privs(struct file *);
2891
2892 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2893 static inline void insert_inode_hash(struct inode *inode)
2894 {
2895         __insert_inode_hash(inode, inode->i_ino);
2896 }
2897
2898 extern void __remove_inode_hash(struct inode *);
2899 static inline void remove_inode_hash(struct inode *inode)
2900 {
2901         if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
2902                 __remove_inode_hash(inode);
2903 }
2904
2905 extern void inode_sb_list_add(struct inode *inode);
2906
2907 #ifdef CONFIG_BLOCK
2908 extern int bdev_read_only(struct block_device *);
2909 #endif
2910 extern int set_blocksize(struct block_device *, int);
2911 extern int sb_set_blocksize(struct super_block *, int);
2912 extern int sb_min_blocksize(struct super_block *, int);
2913
2914 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2915 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2916 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
2917 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
2918 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
2919 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
2920 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
2921 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
2922
2923 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
2924                 rwf_t flags);
2925 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
2926                 rwf_t flags);
2927
2928 /* fs/block_dev.c */
2929 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
2930 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
2931 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2932                         int datasync);
2933 extern void block_sync_page(struct page *page);
2934
2935 /* fs/splice.c */
2936 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
2937                 struct pipe_inode_info *, size_t, unsigned int);
2938 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
2939                 struct file *, loff_t *, size_t, unsigned int);
2940 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
2941                 struct file *out, loff_t *, size_t len, unsigned int flags);
2942 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2943                 loff_t *opos, size_t len, unsigned int flags);
2944
2945
2946 extern void
2947 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
2948 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2949 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
2950 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
2951 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
2952 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
2953                 int whence, loff_t maxsize, loff_t eof);
2954 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2955                 int whence, loff_t size);
2956 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2957 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
2958 extern int generic_file_open(struct inode * inode, struct file * filp);
2959 extern int nonseekable_open(struct inode * inode, struct file * filp);
2960 extern int stream_open(struct inode * inode, struct file * filp);
2961
2962 #ifdef CONFIG_BLOCK
2963 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
2964                             loff_t file_offset);
2965
2966 enum {
2967         /* need locking between buffered and direct access */
2968         DIO_LOCKING     = 0x01,
2969
2970         /* filesystem does not support filling holes */
2971         DIO_SKIP_HOLES  = 0x02,
2972
2973         /* filesystem can handle aio writes beyond i_size */
2974         DIO_ASYNC_EXTEND = 0x04,
2975
2976         /* inode/fs/bdev does not need truncate protection */
2977         DIO_SKIP_DIO_COUNT = 0x08,
2978 };
2979
2980 void dio_end_io(struct bio *bio);
2981 void dio_warn_stale_pagecache(struct file *filp);
2982
2983 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2984                              struct block_device *bdev, struct iov_iter *iter,
2985                              get_block_t get_block,
2986                              dio_iodone_t end_io, dio_submit_t submit_io,
2987                              int flags);
2988
2989 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2990                                          struct inode *inode,
2991                                          struct iov_iter *iter,
2992                                          get_block_t get_block)
2993 {
2994         return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
2995                         get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
2996 }
2997 #endif
2998
2999 void inode_dio_wait(struct inode *inode);
3000
3001 /*
3002  * inode_dio_begin - signal start of a direct I/O requests
3003  * @inode: inode the direct I/O happens on
3004  *
3005  * This is called once we've finished processing a direct I/O request,
3006  * and is used to wake up callers waiting for direct I/O to be quiesced.
3007  */
3008 static inline void inode_dio_begin(struct inode *inode)
3009 {
3010         atomic_inc(&inode->i_dio_count);
3011 }
3012
3013 /*
3014  * inode_dio_end - signal finish of a direct I/O requests
3015  * @inode: inode the direct I/O happens on
3016  *
3017  * This is called once we've finished processing a direct I/O request,
3018  * and is used to wake up callers waiting for direct I/O to be quiesced.
3019  */
3020 static inline void inode_dio_end(struct inode *inode)
3021 {
3022         if (atomic_dec_and_test(&inode->i_dio_count))
3023                 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3024 }
3025
3026 extern void inode_set_flags(struct inode *inode, unsigned int flags,
3027                             unsigned int mask);
3028
3029 extern const struct file_operations generic_ro_fops;
3030
3031 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3032
3033 extern int readlink_copy(char __user *, int, const char *);
3034 extern int page_readlink(struct dentry *, char __user *, int);
3035 extern const char *page_get_link(struct dentry *, struct inode *,
3036                                  struct delayed_call *);
3037 extern void page_put_link(void *);
3038 extern int __page_symlink(struct inode *inode, const char *symname, int len,
3039                 int nofs);
3040 extern int page_symlink(struct inode *inode, const char *symname, int len);
3041 extern const struct inode_operations page_symlink_inode_operations;
3042 extern void kfree_link(void *);
3043 extern void generic_fillattr(struct inode *, struct kstat *);
3044 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3045 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3046 void __inode_add_bytes(struct inode *inode, loff_t bytes);
3047 void inode_add_bytes(struct inode *inode, loff_t bytes);
3048 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
3049 void inode_sub_bytes(struct inode *inode, loff_t bytes);
3050 static inline loff_t __inode_get_bytes(struct inode *inode)
3051 {
3052         return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3053 }
3054 loff_t inode_get_bytes(struct inode *inode);
3055 void inode_set_bytes(struct inode *inode, loff_t bytes);
3056 const char *simple_get_link(struct dentry *, struct inode *,
3057                             struct delayed_call *);
3058 extern const struct inode_operations simple_symlink_inode_operations;
3059
3060 extern int iterate_dir(struct file *, struct dir_context *);
3061
3062 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3063 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3064
3065 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3066 {
3067         return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3068                          stat, STATX_BASIC_STATS);
3069 }
3070 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3071 {
3072         return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3073                          stat, STATX_BASIC_STATS);
3074 }
3075 static inline int vfs_fstatat(int dfd, const char __user *filename,
3076                               struct kstat *stat, int flags)
3077 {
3078         return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3079                          stat, STATX_BASIC_STATS);
3080 }
3081 static inline int vfs_fstat(int fd, struct kstat *stat)
3082 {
3083         return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3084 }
3085
3086
3087 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3088 extern int vfs_readlink(struct dentry *, char __user *, int);
3089
3090 extern int __generic_block_fiemap(struct inode *inode,
3091                                   struct fiemap_extent_info *fieinfo,
3092                                   loff_t start, loff_t len,
3093                                   get_block_t *get_block);
3094 extern int generic_block_fiemap(struct inode *inode,
3095                                 struct fiemap_extent_info *fieinfo, u64 start,
3096                                 u64 len, get_block_t *get_block);
3097
3098 extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3099 extern void put_filesystem(struct file_system_type *fs);
3100 extern struct file_system_type *get_fs_type(const char *name);
3101 extern struct super_block *get_super(struct block_device *);
3102 extern struct super_block *get_super_thawed(struct block_device *);
3103 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3104 extern struct super_block *get_active_super(struct block_device *bdev);
3105 extern void drop_super(struct super_block *sb);
3106 extern void drop_super_exclusive(struct super_block *sb);
3107 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
3108 extern void iterate_supers_type(struct file_system_type *,
3109                                 void (*)(struct super_block *, void *), void *);
3110
3111 extern int dcache_dir_open(struct inode *, struct file *);
3112 extern int dcache_dir_close(struct inode *, struct file *);
3113 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3114 extern int dcache_readdir(struct file *, struct dir_context *);
3115 extern int simple_setattr(struct dentry *, struct iattr *);
3116 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3117 extern int simple_statfs(struct dentry *, struct kstatfs *);
3118 extern int simple_open(struct inode *inode, struct file *file);
3119 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3120 extern int simple_unlink(struct inode *, struct dentry *);
3121 extern int simple_rmdir(struct inode *, struct dentry *);
3122 extern int simple_rename(struct inode *, struct dentry *,
3123                          struct inode *, struct dentry *, unsigned int);
3124 extern int noop_fsync(struct file *, loff_t, loff_t, int);
3125 extern int simple_empty(struct dentry *);
3126 extern int simple_readpage(struct file *file, struct page *page);
3127 extern int simple_write_begin(struct file *file, struct address_space *mapping,
3128                         loff_t pos, unsigned len, unsigned flags,
3129                         struct page **pagep, void **fsdata);
3130 extern int simple_write_end(struct file *file, struct address_space *mapping,
3131                         loff_t pos, unsigned len, unsigned copied,
3132                         struct page *page, void *fsdata);
3133 extern int always_delete_dentry(const struct dentry *);
3134 extern struct inode *alloc_anon_inode(struct super_block *);
3135 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3136 extern const struct dentry_operations simple_dentry_operations;
3137
3138 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
3139 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3140 extern const struct file_operations simple_dir_operations;
3141 extern const struct inode_operations simple_dir_inode_operations;
3142 extern void make_empty_dir_inode(struct inode *inode);
3143 extern bool is_empty_dir_inode(struct inode *inode);
3144 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3145 struct dentry *d_alloc_name(struct dentry *, const char *);
3146 extern int simple_fill_super(struct super_block *, unsigned long,
3147                              const struct tree_descr *);
3148 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3149 extern void simple_release_fs(struct vfsmount **mount, int *count);
3150
3151 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3152                         loff_t *ppos, const void *from, size_t available);
3153 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3154                 const void __user *from, size_t count);
3155
3156 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3157 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3158
3159 extern int generic_check_addressable(unsigned, u64);
3160
3161 #ifdef CONFIG_MIGRATION
3162 extern int buffer_migrate_page(struct address_space *,
3163                                 struct page *, struct page *,
3164                                 enum migrate_mode);
3165 #else
3166 #define buffer_migrate_page NULL
3167 #endif
3168
3169 extern int setattr_prepare(struct dentry *, struct iattr *);
3170 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3171 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3172
3173 extern int file_update_time(struct file *file);
3174
3175 static inline bool io_is_direct(struct file *filp)
3176 {
3177         return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
3178 }
3179
3180 static inline bool vma_is_dax(struct vm_area_struct *vma)
3181 {
3182         return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3183 }
3184
3185 static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3186 {
3187         struct inode *inode;
3188
3189         if (!vma->vm_file)
3190                 return false;
3191         if (!vma_is_dax(vma))
3192                 return false;
3193         inode = file_inode(vma->vm_file);
3194         if (S_ISCHR(inode->i_mode))
3195                 return false; /* device-dax */
3196         return true;
3197 }
3198
3199 static inline int iocb_flags(struct file *file)
3200 {
3201         int res = 0;
3202         if (file->f_flags & O_APPEND)
3203                 res |= IOCB_APPEND;
3204         if (io_is_direct(file))
3205                 res |= IOCB_DIRECT;
3206         if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3207                 res |= IOCB_DSYNC;
3208         if (file->f_flags & __O_SYNC)
3209                 res |= IOCB_SYNC;
3210         return res;
3211 }
3212
3213 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3214 {
3215         if (unlikely(flags & ~RWF_SUPPORTED))
3216                 return -EOPNOTSUPP;
3217
3218         if (flags & RWF_NOWAIT) {
3219                 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3220                         return -EOPNOTSUPP;
3221                 ki->ki_flags |= IOCB_NOWAIT;
3222         }
3223         if (flags & RWF_HIPRI)
3224                 ki->ki_flags |= IOCB_HIPRI;
3225         if (flags & RWF_DSYNC)
3226                 ki->ki_flags |= IOCB_DSYNC;
3227         if (flags & RWF_SYNC)
3228                 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
3229         return 0;
3230 }
3231
3232 static inline ino_t parent_ino(struct dentry *dentry)
3233 {
3234         ino_t res;
3235
3236         /*
3237          * Don't strictly need d_lock here? If the parent ino could change
3238          * then surely we'd have a deeper race in the caller?
3239          */
3240         spin_lock(&dentry->d_lock);
3241         res = dentry->d_parent->d_inode->i_ino;
3242         spin_unlock(&dentry->d_lock);
3243         return res;
3244 }
3245
3246 /* Transaction based IO helpers */
3247
3248 /*
3249  * An argresp is stored in an allocated page and holds the
3250  * size of the argument or response, along with its content
3251  */
3252 struct simple_transaction_argresp {
3253         ssize_t size;
3254         char data[0];
3255 };
3256
3257 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3258
3259 char *simple_transaction_get(struct file *file, const char __user *buf,
3260                                 size_t size);
3261 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3262                                 size_t size, loff_t *pos);
3263 int simple_transaction_release(struct inode *inode, struct file *file);
3264
3265 void simple_transaction_set(struct file *file, size_t n);
3266
3267 /*
3268  * simple attribute files
3269  *
3270  * These attributes behave similar to those in sysfs:
3271  *
3272  * Writing to an attribute immediately sets a value, an open file can be
3273  * written to multiple times.
3274  *
3275  * Reading from an attribute creates a buffer from the value that might get
3276  * read with multiple read calls. When the attribute has been read
3277  * completely, no further read calls are possible until the file is opened
3278  * again.
3279  *
3280  * All attributes contain a text representation of a numeric value
3281  * that are accessed with the get() and set() functions.
3282  */
3283 #define DEFINE_SIMPLE_ATTRIBUTE_XSIGNED(__fops, __get, __set, __fmt, __is_signed)       \
3284 static int __fops ## _open(struct inode *inode, struct file *file)      \
3285 {                                                                       \
3286         __simple_attr_check_format(__fmt, 0ull);                        \
3287         return simple_attr_open(inode, file, __get, __set, __fmt);      \
3288 }                                                                       \
3289 static const struct file_operations __fops = {                          \
3290         .owner   = THIS_MODULE,                                         \
3291         .open    = __fops ## _open,                                     \
3292         .release = simple_attr_release,                                 \
3293         .read    = simple_attr_read,                                    \
3294         .write   = (__is_signed) ? simple_attr_write_signed : simple_attr_write,        \
3295         .llseek  = generic_file_llseek,                                 \
3296 }
3297
3298 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)            \
3299         DEFINE_SIMPLE_ATTRIBUTE_XSIGNED(__fops, __get, __set, __fmt, false)
3300
3301 #define DEFINE_SIMPLE_ATTRIBUTE_SIGNED(__fops, __get, __set, __fmt)     \
3302         DEFINE_SIMPLE_ATTRIBUTE_XSIGNED(__fops, __get, __set, __fmt, true)
3303
3304 static inline __printf(1, 2)
3305 void __simple_attr_check_format(const char *fmt, ...)
3306 {
3307         /* don't do anything, just let the compiler check the arguments; */
3308 }
3309
3310 int simple_attr_open(struct inode *inode, struct file *file,
3311                      int (*get)(void *, u64 *), int (*set)(void *, u64),
3312                      const char *fmt);
3313 int simple_attr_release(struct inode *inode, struct file *file);
3314 ssize_t simple_attr_read(struct file *file, char __user *buf,
3315                          size_t len, loff_t *ppos);
3316 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3317                           size_t len, loff_t *ppos);
3318 ssize_t simple_attr_write_signed(struct file *file, const char __user *buf,
3319                                  size_t len, loff_t *ppos);
3320
3321 struct ctl_table;
3322 int proc_nr_files(struct ctl_table *table, int write,
3323                   void __user *buffer, size_t *lenp, loff_t *ppos);
3324 int proc_nr_dentry(struct ctl_table *table, int write,
3325                   void __user *buffer, size_t *lenp, loff_t *ppos);
3326 int proc_nr_inodes(struct ctl_table *table, int write,
3327                    void __user *buffer, size_t *lenp, loff_t *ppos);
3328 int __init get_filesystem_list(char *buf);
3329
3330 #define __FMODE_EXEC            ((__force int) FMODE_EXEC)
3331 #define __FMODE_NONOTIFY        ((__force int) FMODE_NONOTIFY)
3332
3333 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3334 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3335                                             (flag & __FMODE_NONOTIFY)))
3336
3337 static inline bool is_sxid(umode_t mode)
3338 {
3339         return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3340 }
3341
3342 static inline int check_sticky(struct inode *dir, struct inode *inode)
3343 {
3344         if (!(dir->i_mode & S_ISVTX))
3345                 return 0;
3346
3347         return __check_sticky(dir, inode);
3348 }
3349
3350 static inline void inode_has_no_xattr(struct inode *inode)
3351 {
3352         if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3353                 inode->i_flags |= S_NOSEC;
3354 }
3355
3356 static inline bool is_root_inode(struct inode *inode)
3357 {
3358         return inode == inode->i_sb->s_root->d_inode;
3359 }
3360
3361 static inline bool dir_emit(struct dir_context *ctx,
3362                             const char *name, int namelen,
3363                             u64 ino, unsigned type)
3364 {
3365         return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3366 }
3367 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3368 {
3369         return ctx->actor(ctx, ".", 1, ctx->pos,
3370                           file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3371 }
3372 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3373 {
3374         return ctx->actor(ctx, "..", 2, ctx->pos,
3375                           parent_ino(file->f_path.dentry), DT_DIR) == 0;
3376 }
3377 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3378 {
3379         if (ctx->pos == 0) {
3380                 if (!dir_emit_dot(file, ctx))
3381                         return false;
3382                 ctx->pos = 1;
3383         }
3384         if (ctx->pos == 1) {
3385                 if (!dir_emit_dotdot(file, ctx))
3386                         return false;
3387                 ctx->pos = 2;
3388         }
3389         return true;
3390 }
3391 static inline bool dir_relax(struct inode *inode)
3392 {
3393         inode_unlock(inode);
3394         inode_lock(inode);
3395         return !IS_DEADDIR(inode);
3396 }
3397
3398 static inline bool dir_relax_shared(struct inode *inode)
3399 {
3400         inode_unlock_shared(inode);
3401         inode_lock_shared(inode);
3402         return !IS_DEADDIR(inode);
3403 }
3404
3405 extern bool path_noexec(const struct path *path);
3406 extern void inode_nohighmem(struct inode *inode);
3407
3408 #endif /* _LINUX_FS_H */