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