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