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