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