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