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