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