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