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