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