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