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