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