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