vfs: Remove {get,set,remove}xattr inode operations
[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 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
228 /*
229  * Whiteout is represented by a char device.  The following constants define the
230  * mode and device number to use.
231  */
232 #define WHITEOUT_MODE 0
233 #define WHITEOUT_DEV 0
234
235 /*
236  * This is the Inode Attributes structure, used for notify_change().  It
237  * uses the above definitions as flags, to know which values have changed.
238  * Also, in this manner, a Filesystem can look at only the values it cares
239  * about.  Basically, these are the attributes that the VFS layer can
240  * request to change from the FS layer.
241  *
242  * Derek Atkins <warlord@MIT.EDU> 94-10-20
243  */
244 struct iattr {
245         unsigned int    ia_valid;
246         umode_t         ia_mode;
247         kuid_t          ia_uid;
248         kgid_t          ia_gid;
249         loff_t          ia_size;
250         struct timespec ia_atime;
251         struct timespec ia_mtime;
252         struct timespec ia_ctime;
253
254         /*
255          * Not an attribute, but an auxiliary info for filesystems wanting to
256          * implement an ftruncate() like method.  NOTE: filesystem should
257          * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
258          */
259         struct file     *ia_file;
260 };
261
262 /*
263  * Includes for diskquotas.
264  */
265 #include <linux/quota.h>
266
267 /*
268  * Maximum number of layers of fs stack.  Needs to be limited to
269  * prevent kernel stack overflow
270  */
271 #define FILESYSTEM_MAX_STACK_DEPTH 2
272
273 /** 
274  * enum positive_aop_returns - aop return codes with specific semantics
275  *
276  * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
277  *                          completed, that the page is still locked, and
278  *                          should be considered active.  The VM uses this hint
279  *                          to return the page to the active list -- it won't
280  *                          be a candidate for writeback again in the near
281  *                          future.  Other callers must be careful to unlock
282  *                          the page if they get this return.  Returned by
283  *                          writepage(); 
284  *
285  * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
286  *                      unlocked it and the page might have been truncated.
287  *                      The caller should back up to acquiring a new page and
288  *                      trying again.  The aop will be taking reasonable
289  *                      precautions not to livelock.  If the caller held a page
290  *                      reference, it should drop it before retrying.  Returned
291  *                      by readpage().
292  *
293  * address_space_operation functions return these large constants to indicate
294  * special semantics to the caller.  These are much larger than the bytes in a
295  * page to allow for functions that return the number of bytes operated on in a
296  * given page.
297  */
298
299 enum positive_aop_returns {
300         AOP_WRITEPAGE_ACTIVATE  = 0x80000,
301         AOP_TRUNCATED_PAGE      = 0x80001,
302 };
303
304 #define AOP_FLAG_UNINTERRUPTIBLE        0x0001 /* will not do a short write */
305 #define AOP_FLAG_CONT_EXPAND            0x0002 /* called from cont_expand */
306 #define AOP_FLAG_NOFS                   0x0004 /* used by filesystem to direct
307                                                 * helper code (eg buffer layer)
308                                                 * to clear GFP_FS from alloc */
309
310 /*
311  * oh the beauties of C type declarations.
312  */
313 struct page;
314 struct address_space;
315 struct writeback_control;
316
317 #define IOCB_EVENTFD            (1 << 0)
318 #define IOCB_APPEND             (1 << 1)
319 #define IOCB_DIRECT             (1 << 2)
320 #define IOCB_HIPRI              (1 << 3)
321 #define IOCB_DSYNC              (1 << 4)
322 #define IOCB_SYNC               (1 << 5)
323
324 struct kiocb {
325         struct file             *ki_filp;
326         loff_t                  ki_pos;
327         void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
328         void                    *private;
329         int                     ki_flags;
330 };
331
332 static inline bool is_sync_kiocb(struct kiocb *kiocb)
333 {
334         return kiocb->ki_complete == NULL;
335 }
336
337 static inline int iocb_flags(struct file *file);
338
339 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
340 {
341         *kiocb = (struct kiocb) {
342                 .ki_filp = filp,
343                 .ki_flags = iocb_flags(filp),
344         };
345 }
346
347 /*
348  * "descriptor" for what we're up to with a read.
349  * This allows us to use the same read code yet
350  * have multiple different users of the data that
351  * we read from a file.
352  *
353  * The simplest case just copies the data to user
354  * mode.
355  */
356 typedef struct {
357         size_t written;
358         size_t count;
359         union {
360                 char __user *buf;
361                 void *data;
362         } arg;
363         int error;
364 } read_descriptor_t;
365
366 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
367                 unsigned long, unsigned long);
368
369 struct address_space_operations {
370         int (*writepage)(struct page *page, struct writeback_control *wbc);
371         int (*readpage)(struct file *, struct page *);
372
373         /* Write back some dirty pages from this mapping. */
374         int (*writepages)(struct address_space *, struct writeback_control *);
375
376         /* Set a page dirty.  Return true if this dirtied it */
377         int (*set_page_dirty)(struct page *page);
378
379         int (*readpages)(struct file *filp, struct address_space *mapping,
380                         struct list_head *pages, unsigned nr_pages);
381
382         int (*write_begin)(struct file *, struct address_space *mapping,
383                                 loff_t pos, unsigned len, unsigned flags,
384                                 struct page **pagep, void **fsdata);
385         int (*write_end)(struct file *, struct address_space *mapping,
386                                 loff_t pos, unsigned len, unsigned copied,
387                                 struct page *page, void *fsdata);
388
389         /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
390         sector_t (*bmap)(struct address_space *, sector_t);
391         void (*invalidatepage) (struct page *, unsigned int, unsigned int);
392         int (*releasepage) (struct page *, gfp_t);
393         void (*freepage)(struct page *);
394         ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
395         /*
396          * migrate the contents of a page to the specified target. If
397          * migrate_mode is MIGRATE_ASYNC, it must not block.
398          */
399         int (*migratepage) (struct address_space *,
400                         struct page *, struct page *, enum migrate_mode);
401         bool (*isolate_page)(struct page *, isolate_mode_t);
402         void (*putback_page)(struct page *);
403         int (*launder_page) (struct page *);
404         int (*is_partially_uptodate) (struct page *, unsigned long,
405                                         unsigned long);
406         void (*is_dirty_writeback) (struct page *, bool *, bool *);
407         int (*error_remove_page)(struct address_space *, struct page *);
408
409         /* swapfile support */
410         int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
411                                 sector_t *span);
412         void (*swap_deactivate)(struct file *file);
413 };
414
415 extern const struct address_space_operations empty_aops;
416
417 /*
418  * pagecache_write_begin/pagecache_write_end must be used by general code
419  * to write into the pagecache.
420  */
421 int pagecache_write_begin(struct file *, struct address_space *mapping,
422                                 loff_t pos, unsigned len, unsigned flags,
423                                 struct page **pagep, void **fsdata);
424
425 int pagecache_write_end(struct file *, struct address_space *mapping,
426                                 loff_t pos, unsigned len, unsigned copied,
427                                 struct page *page, void *fsdata);
428
429 struct address_space {
430         struct inode            *host;          /* owner: inode, block_device */
431         struct radix_tree_root  page_tree;      /* radix tree of all pages */
432         spinlock_t              tree_lock;      /* and lock protecting it */
433         atomic_t                i_mmap_writable;/* count VM_SHARED mappings */
434         struct rb_root          i_mmap;         /* tree of private and shared mappings */
435         struct rw_semaphore     i_mmap_rwsem;   /* protect tree, count, list */
436         /* Protected by tree_lock together with the radix tree */
437         unsigned long           nrpages;        /* number of total pages */
438         /* number of shadow or DAX exceptional entries */
439         unsigned long           nrexceptional;
440         pgoff_t                 writeback_index;/* writeback starts here */
441         const struct address_space_operations *a_ops;   /* methods */
442         unsigned long           flags;          /* error bits/gfp mask */
443         spinlock_t              private_lock;   /* for use by the address_space */
444         struct list_head        private_list;   /* ditto */
445         void                    *private_data;  /* ditto */
446 } __attribute__((aligned(sizeof(long))));
447         /*
448          * On most architectures that alignment is already the case; but
449          * must be enforced here for CRIS, to let the least significant bit
450          * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
451          */
452 struct request_queue;
453
454 struct block_device {
455         dev_t                   bd_dev;  /* not a kdev_t - it's a search key */
456         int                     bd_openers;
457         struct inode *          bd_inode;       /* will die */
458         struct super_block *    bd_super;
459         struct mutex            bd_mutex;       /* open/close mutex */
460         void *                  bd_claiming;
461         void *                  bd_holder;
462         int                     bd_holders;
463         bool                    bd_write_holder;
464 #ifdef CONFIG_SYSFS
465         struct list_head        bd_holder_disks;
466 #endif
467         struct block_device *   bd_contains;
468         unsigned                bd_block_size;
469         struct hd_struct *      bd_part;
470         /* number of times partitions within this device have been opened. */
471         unsigned                bd_part_count;
472         int                     bd_invalidated;
473         struct gendisk *        bd_disk;
474         struct request_queue *  bd_queue;
475         struct list_head        bd_list;
476         /*
477          * Private data.  You must have bd_claim'ed the block_device
478          * to use this.  NOTE:  bd_claim allows an owner to claim
479          * the same device multiple times, the owner must take special
480          * care to not mess up bd_private for that case.
481          */
482         unsigned long           bd_private;
483
484         /* The counter of freeze processes */
485         int                     bd_fsfreeze_count;
486         /* Mutex for freeze */
487         struct mutex            bd_fsfreeze_mutex;
488 };
489
490 /*
491  * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
492  * radix trees
493  */
494 #define PAGECACHE_TAG_DIRTY     0
495 #define PAGECACHE_TAG_WRITEBACK 1
496 #define PAGECACHE_TAG_TOWRITE   2
497
498 int mapping_tagged(struct address_space *mapping, int tag);
499
500 static inline void i_mmap_lock_write(struct address_space *mapping)
501 {
502         down_write(&mapping->i_mmap_rwsem);
503 }
504
505 static inline void i_mmap_unlock_write(struct address_space *mapping)
506 {
507         up_write(&mapping->i_mmap_rwsem);
508 }
509
510 static inline void i_mmap_lock_read(struct address_space *mapping)
511 {
512         down_read(&mapping->i_mmap_rwsem);
513 }
514
515 static inline void i_mmap_unlock_read(struct address_space *mapping)
516 {
517         up_read(&mapping->i_mmap_rwsem);
518 }
519
520 /*
521  * Might pages of this file be mapped into userspace?
522  */
523 static inline int mapping_mapped(struct address_space *mapping)
524 {
525         return  !RB_EMPTY_ROOT(&mapping->i_mmap);
526 }
527
528 /*
529  * Might pages of this file have been modified in userspace?
530  * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
531  * marks vma as VM_SHARED if it is shared, and the file was opened for
532  * writing i.e. vma may be mprotected writable even if now readonly.
533  *
534  * If i_mmap_writable is negative, no new writable mappings are allowed. You
535  * can only deny writable mappings, if none exists right now.
536  */
537 static inline int mapping_writably_mapped(struct address_space *mapping)
538 {
539         return atomic_read(&mapping->i_mmap_writable) > 0;
540 }
541
542 static inline int mapping_map_writable(struct address_space *mapping)
543 {
544         return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
545                 0 : -EPERM;
546 }
547
548 static inline void mapping_unmap_writable(struct address_space *mapping)
549 {
550         atomic_dec(&mapping->i_mmap_writable);
551 }
552
553 static inline int mapping_deny_writable(struct address_space *mapping)
554 {
555         return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
556                 0 : -EBUSY;
557 }
558
559 static inline void mapping_allow_writable(struct address_space *mapping)
560 {
561         atomic_inc(&mapping->i_mmap_writable);
562 }
563
564 /*
565  * Use sequence counter to get consistent i_size on 32-bit processors.
566  */
567 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
568 #include <linux/seqlock.h>
569 #define __NEED_I_SIZE_ORDERED
570 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
571 #else
572 #define i_size_ordered_init(inode) do { } while (0)
573 #endif
574
575 struct posix_acl;
576 #define ACL_NOT_CACHED ((void *)(-1))
577 #define ACL_DONT_CACHE ((void *)(-3))
578
579 static inline struct posix_acl *
580 uncached_acl_sentinel(struct task_struct *task)
581 {
582         return (void *)task + 1;
583 }
584
585 static inline bool
586 is_uncached_acl(struct posix_acl *acl)
587 {
588         return (long)acl & 1;
589 }
590
591 #define IOP_FASTPERM    0x0001
592 #define IOP_LOOKUP      0x0002
593 #define IOP_NOFOLLOW    0x0004
594 #define IOP_XATTR       0x0008
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 #ifdef CONFIG_FILE_LOCKING
1069 extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
1070 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1071                         struct flock __user *);
1072
1073 #if BITS_PER_LONG == 32
1074 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
1075 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1076                         struct flock64 __user *);
1077 #endif
1078
1079 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1080 extern int fcntl_getlease(struct file *filp);
1081
1082 /* fs/locks.c */
1083 void locks_free_lock_context(struct inode *inode);
1084 void locks_free_lock(struct file_lock *fl);
1085 extern void locks_init_lock(struct file_lock *);
1086 extern struct file_lock * locks_alloc_lock(void);
1087 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1088 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1089 extern void locks_remove_posix(struct file *, fl_owner_t);
1090 extern void locks_remove_file(struct file *);
1091 extern void locks_release_private(struct file_lock *);
1092 extern void posix_test_lock(struct file *, struct file_lock *);
1093 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1094 extern int posix_unblock_lock(struct file_lock *);
1095 extern int vfs_test_lock(struct file *, struct file_lock *);
1096 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1097 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1098 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
1099 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1100 extern void lease_get_mtime(struct inode *, struct timespec *time);
1101 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1102 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1103 extern int lease_modify(struct file_lock *, int, struct list_head *);
1104 struct files_struct;
1105 extern void show_fd_locks(struct seq_file *f,
1106                          struct file *filp, struct files_struct *files);
1107 #else /* !CONFIG_FILE_LOCKING */
1108 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1109                               struct flock __user *user)
1110 {
1111         return -EINVAL;
1112 }
1113
1114 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1115                               unsigned int cmd, struct flock __user *user)
1116 {
1117         return -EACCES;
1118 }
1119
1120 #if BITS_PER_LONG == 32
1121 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1122                                 struct flock64 __user *user)
1123 {
1124         return -EINVAL;
1125 }
1126
1127 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1128                                 unsigned int cmd, struct flock64 __user *user)
1129 {
1130         return -EACCES;
1131 }
1132 #endif
1133 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1134 {
1135         return -EINVAL;
1136 }
1137
1138 static inline int fcntl_getlease(struct file *filp)
1139 {
1140         return F_UNLCK;
1141 }
1142
1143 static inline void
1144 locks_free_lock_context(struct inode *inode)
1145 {
1146 }
1147
1148 static inline void locks_init_lock(struct file_lock *fl)
1149 {
1150         return;
1151 }
1152
1153 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1154 {
1155         return;
1156 }
1157
1158 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1159 {
1160         return;
1161 }
1162
1163 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1164 {
1165         return;
1166 }
1167
1168 static inline void locks_remove_file(struct file *filp)
1169 {
1170         return;
1171 }
1172
1173 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1174 {
1175         return;
1176 }
1177
1178 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1179                                   struct file_lock *conflock)
1180 {
1181         return -ENOLCK;
1182 }
1183
1184 static inline int posix_unblock_lock(struct file_lock *waiter)
1185 {
1186         return -ENOENT;
1187 }
1188
1189 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1190 {
1191         return 0;
1192 }
1193
1194 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1195                                 struct file_lock *fl, struct file_lock *conf)
1196 {
1197         return -ENOLCK;
1198 }
1199
1200 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1201 {
1202         return 0;
1203 }
1204
1205 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1206 {
1207         return -ENOLCK;
1208 }
1209
1210 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1211 {
1212         return 0;
1213 }
1214
1215 static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1216 {
1217         return;
1218 }
1219
1220 static inline int generic_setlease(struct file *filp, long arg,
1221                                     struct file_lock **flp, void **priv)
1222 {
1223         return -EINVAL;
1224 }
1225
1226 static inline int vfs_setlease(struct file *filp, long arg,
1227                                struct file_lock **lease, void **priv)
1228 {
1229         return -EINVAL;
1230 }
1231
1232 static inline int lease_modify(struct file_lock *fl, int arg,
1233                                struct list_head *dispose)
1234 {
1235         return -EINVAL;
1236 }
1237
1238 struct files_struct;
1239 static inline void show_fd_locks(struct seq_file *f,
1240                         struct file *filp, struct files_struct *files) {}
1241 #endif /* !CONFIG_FILE_LOCKING */
1242
1243 static inline struct inode *file_inode(const struct file *f)
1244 {
1245         return f->f_inode;
1246 }
1247
1248 static inline struct dentry *file_dentry(const struct file *file)
1249 {
1250         return d_real(file->f_path.dentry, file_inode(file), 0);
1251 }
1252
1253 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1254 {
1255         return locks_lock_inode_wait(file_inode(filp), fl);
1256 }
1257
1258 struct fasync_struct {
1259         spinlock_t              fa_lock;
1260         int                     magic;
1261         int                     fa_fd;
1262         struct fasync_struct    *fa_next; /* singly linked list */
1263         struct file             *fa_file;
1264         struct rcu_head         fa_rcu;
1265 };
1266
1267 #define FASYNC_MAGIC 0x4601
1268
1269 /* SMP safe fasync helpers: */
1270 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1271 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1272 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1273 extern struct fasync_struct *fasync_alloc(void);
1274 extern void fasync_free(struct fasync_struct *);
1275
1276 /* can be called from interrupts */
1277 extern void kill_fasync(struct fasync_struct **, int, int);
1278
1279 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1280 extern void f_setown(struct file *filp, unsigned long arg, int force);
1281 extern void f_delown(struct file *filp);
1282 extern pid_t f_getown(struct file *filp);
1283 extern int send_sigurg(struct fown_struct *fown);
1284
1285 struct mm_struct;
1286
1287 /*
1288  *      Umount options
1289  */
1290
1291 #define MNT_FORCE       0x00000001      /* Attempt to forcibily umount */
1292 #define MNT_DETACH      0x00000002      /* Just detach from the tree */
1293 #define MNT_EXPIRE      0x00000004      /* Mark for expiry */
1294 #define UMOUNT_NOFOLLOW 0x00000008      /* Don't follow symlink on umount */
1295 #define UMOUNT_UNUSED   0x80000000      /* Flag guaranteed to be unused */
1296
1297 /* sb->s_iflags */
1298 #define SB_I_CGROUPWB   0x00000001      /* cgroup-aware writeback enabled */
1299 #define SB_I_NOEXEC     0x00000002      /* Ignore executables on this fs */
1300 #define SB_I_NODEV      0x00000004      /* Ignore devices on this fs */
1301
1302 /* sb->s_iflags to limit user namespace mounts */
1303 #define SB_I_USERNS_VISIBLE             0x00000010 /* fstype already mounted */
1304
1305 /* Possible states of 'frozen' field */
1306 enum {
1307         SB_UNFROZEN = 0,                /* FS is unfrozen */
1308         SB_FREEZE_WRITE = 1,            /* Writes, dir ops, ioctls frozen */
1309         SB_FREEZE_PAGEFAULT = 2,        /* Page faults stopped as well */
1310         SB_FREEZE_FS = 3,               /* For internal FS use (e.g. to stop
1311                                          * internal threads if needed) */
1312         SB_FREEZE_COMPLETE = 4,         /* ->freeze_fs finished successfully */
1313 };
1314
1315 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1316
1317 struct sb_writers {
1318         int                             frozen;         /* Is sb frozen? */
1319         wait_queue_head_t               wait_unfrozen;  /* for get_super_thawed() */
1320         struct percpu_rw_semaphore      rw_sem[SB_FREEZE_LEVELS];
1321 };
1322
1323 struct super_block {
1324         struct list_head        s_list;         /* Keep this first */
1325         dev_t                   s_dev;          /* search index; _not_ kdev_t */
1326         unsigned char           s_blocksize_bits;
1327         unsigned long           s_blocksize;
1328         loff_t                  s_maxbytes;     /* Max file size */
1329         struct file_system_type *s_type;
1330         const struct super_operations   *s_op;
1331         const struct dquot_operations   *dq_op;
1332         const struct quotactl_ops       *s_qcop;
1333         const struct export_operations *s_export_op;
1334         unsigned long           s_flags;
1335         unsigned long           s_iflags;       /* internal SB_I_* flags */
1336         unsigned long           s_magic;
1337         struct dentry           *s_root;
1338         struct rw_semaphore     s_umount;
1339         int                     s_count;
1340         atomic_t                s_active;
1341 #ifdef CONFIG_SECURITY
1342         void                    *s_security;
1343 #endif
1344         const struct xattr_handler **s_xattr;
1345
1346         const struct fscrypt_operations *s_cop;
1347
1348         struct hlist_bl_head    s_anon;         /* anonymous dentries for (nfs) exporting */
1349         struct list_head        s_mounts;       /* list of mounts; _not_ for fs use */
1350         struct block_device     *s_bdev;
1351         struct backing_dev_info *s_bdi;
1352         struct mtd_info         *s_mtd;
1353         struct hlist_node       s_instances;
1354         unsigned int            s_quota_types;  /* Bitmask of supported quota types */
1355         struct quota_info       s_dquot;        /* Diskquota specific options */
1356
1357         struct sb_writers       s_writers;
1358
1359         char s_id[32];                          /* Informational name */
1360         u8 s_uuid[16];                          /* UUID */
1361
1362         void                    *s_fs_info;     /* Filesystem private info */
1363         unsigned int            s_max_links;
1364         fmode_t                 s_mode;
1365
1366         /* Granularity of c/m/atime in ns.
1367            Cannot be worse than a second */
1368         u32                s_time_gran;
1369
1370         /*
1371          * The next field is for VFS *only*. No filesystems have any business
1372          * even looking at it. You had been warned.
1373          */
1374         struct mutex s_vfs_rename_mutex;        /* Kludge */
1375
1376         /*
1377          * Filesystem subtype.  If non-empty the filesystem type field
1378          * in /proc/mounts will be "type.subtype"
1379          */
1380         char *s_subtype;
1381
1382         /*
1383          * Saved mount options for lazy filesystems using
1384          * generic_show_options()
1385          */
1386         char __rcu *s_options;
1387         const struct dentry_operations *s_d_op; /* default d_op for dentries */
1388
1389         /*
1390          * Saved pool identifier for cleancache (-1 means none)
1391          */
1392         int cleancache_poolid;
1393
1394         struct shrinker s_shrink;       /* per-sb shrinker handle */
1395
1396         /* Number of inodes with nlink == 0 but still referenced */
1397         atomic_long_t s_remove_count;
1398
1399         /* Being remounted read-only */
1400         int s_readonly_remount;
1401
1402         /* AIO completions deferred from interrupt context */
1403         struct workqueue_struct *s_dio_done_wq;
1404         struct hlist_head s_pins;
1405
1406         /*
1407          * Owning user namespace and default context in which to
1408          * interpret filesystem uids, gids, quotas, device nodes,
1409          * xattrs and security labels.
1410          */
1411         struct user_namespace *s_user_ns;
1412
1413         /*
1414          * Keep the lru lists last in the structure so they always sit on their
1415          * own individual cachelines.
1416          */
1417         struct list_lru         s_dentry_lru ____cacheline_aligned_in_smp;
1418         struct list_lru         s_inode_lru ____cacheline_aligned_in_smp;
1419         struct rcu_head         rcu;
1420         struct work_struct      destroy_work;
1421
1422         struct mutex            s_sync_lock;    /* sync serialisation lock */
1423
1424         /*
1425          * Indicates how deep in a filesystem stack this SB is
1426          */
1427         int s_stack_depth;
1428
1429         /* s_inode_list_lock protects s_inodes */
1430         spinlock_t              s_inode_list_lock ____cacheline_aligned_in_smp;
1431         struct list_head        s_inodes;       /* all inodes */
1432
1433         spinlock_t              s_inode_wblist_lock;
1434         struct list_head        s_inodes_wb;    /* writeback inodes */
1435 };
1436
1437 /* Helper functions so that in most cases filesystems will
1438  * not need to deal directly with kuid_t and kgid_t and can
1439  * instead deal with the raw numeric values that are stored
1440  * in the filesystem.
1441  */
1442 static inline uid_t i_uid_read(const struct inode *inode)
1443 {
1444         return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1445 }
1446
1447 static inline gid_t i_gid_read(const struct inode *inode)
1448 {
1449         return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1450 }
1451
1452 static inline void i_uid_write(struct inode *inode, uid_t uid)
1453 {
1454         inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1455 }
1456
1457 static inline void i_gid_write(struct inode *inode, gid_t gid)
1458 {
1459         inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1460 }
1461
1462 extern struct timespec current_fs_time(struct super_block *sb);
1463
1464 /*
1465  * Snapshotting support.
1466  */
1467
1468 void __sb_end_write(struct super_block *sb, int level);
1469 int __sb_start_write(struct super_block *sb, int level, bool wait);
1470
1471 #define __sb_writers_acquired(sb, lev)  \
1472         percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1473 #define __sb_writers_release(sb, lev)   \
1474         percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1475
1476 /**
1477  * sb_end_write - drop write access to a superblock
1478  * @sb: the super we wrote to
1479  *
1480  * Decrement number of writers to the filesystem. Wake up possible waiters
1481  * wanting to freeze the filesystem.
1482  */
1483 static inline void sb_end_write(struct super_block *sb)
1484 {
1485         __sb_end_write(sb, SB_FREEZE_WRITE);
1486 }
1487
1488 /**
1489  * sb_end_pagefault - drop write access to a superblock from a page fault
1490  * @sb: the super we wrote to
1491  *
1492  * Decrement number of processes handling write page fault to the filesystem.
1493  * Wake up possible waiters wanting to freeze the filesystem.
1494  */
1495 static inline void sb_end_pagefault(struct super_block *sb)
1496 {
1497         __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1498 }
1499
1500 /**
1501  * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1502  * @sb: the super we wrote to
1503  *
1504  * Decrement fs-internal number of writers to the filesystem.  Wake up possible
1505  * waiters wanting to freeze the filesystem.
1506  */
1507 static inline void sb_end_intwrite(struct super_block *sb)
1508 {
1509         __sb_end_write(sb, SB_FREEZE_FS);
1510 }
1511
1512 /**
1513  * sb_start_write - get write access to a superblock
1514  * @sb: the super we write to
1515  *
1516  * When a process wants to write data or metadata to a file system (i.e. dirty
1517  * a page or an inode), it should embed the operation in a sb_start_write() -
1518  * sb_end_write() pair to get exclusion against file system freezing. This
1519  * function increments number of writers preventing freezing. If the file
1520  * system is already frozen, the function waits until the file system is
1521  * thawed.
1522  *
1523  * Since freeze protection behaves as a lock, users have to preserve
1524  * ordering of freeze protection and other filesystem locks. Generally,
1525  * freeze protection should be the outermost lock. In particular, we have:
1526  *
1527  * sb_start_write
1528  *   -> i_mutex                 (write path, truncate, directory ops, ...)
1529  *   -> s_umount                (freeze_super, thaw_super)
1530  */
1531 static inline void sb_start_write(struct super_block *sb)
1532 {
1533         __sb_start_write(sb, SB_FREEZE_WRITE, true);
1534 }
1535
1536 static inline int sb_start_write_trylock(struct super_block *sb)
1537 {
1538         return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1539 }
1540
1541 /**
1542  * sb_start_pagefault - get write access to a superblock from a page fault
1543  * @sb: the super we write to
1544  *
1545  * When a process starts handling write page fault, it should embed the
1546  * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1547  * exclusion against file system freezing. This is needed since the page fault
1548  * is going to dirty a page. This function increments number of running page
1549  * faults preventing freezing. If the file system is already frozen, the
1550  * function waits until the file system is thawed.
1551  *
1552  * Since page fault freeze protection behaves as a lock, users have to preserve
1553  * ordering of freeze protection and other filesystem locks. It is advised to
1554  * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1555  * handling code implies lock dependency:
1556  *
1557  * mmap_sem
1558  *   -> sb_start_pagefault
1559  */
1560 static inline void sb_start_pagefault(struct super_block *sb)
1561 {
1562         __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1563 }
1564
1565 /*
1566  * sb_start_intwrite - get write access to a superblock for internal fs purposes
1567  * @sb: the super we write to
1568  *
1569  * This is the third level of protection against filesystem freezing. It is
1570  * free for use by a filesystem. The only requirement is that it must rank
1571  * below sb_start_pagefault.
1572  *
1573  * For example filesystem can call sb_start_intwrite() when starting a
1574  * transaction which somewhat eases handling of freezing for internal sources
1575  * of filesystem changes (internal fs threads, discarding preallocation on file
1576  * close, etc.).
1577  */
1578 static inline void sb_start_intwrite(struct super_block *sb)
1579 {
1580         __sb_start_write(sb, SB_FREEZE_FS, true);
1581 }
1582
1583
1584 extern bool inode_owner_or_capable(const struct inode *inode);
1585
1586 /*
1587  * VFS helper functions..
1588  */
1589 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1590 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1591 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1592 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1593 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1594 extern int vfs_rmdir(struct inode *, struct dentry *);
1595 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1596 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1597 extern int vfs_whiteout(struct inode *, struct dentry *);
1598
1599 /*
1600  * VFS file helper functions.
1601  */
1602 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1603                         umode_t mode);
1604 extern bool may_open_dev(const struct path *path);
1605 /*
1606  * VFS FS_IOC_FIEMAP helper definitions.
1607  */
1608 struct fiemap_extent_info {
1609         unsigned int fi_flags;          /* Flags as passed from user */
1610         unsigned int fi_extents_mapped; /* Number of mapped extents */
1611         unsigned int fi_extents_max;    /* Size of fiemap_extent array */
1612         struct fiemap_extent __user *fi_extents_start; /* Start of
1613                                                         fiemap_extent array */
1614 };
1615 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1616                             u64 phys, u64 len, u32 flags);
1617 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1618
1619 /*
1620  * File types
1621  *
1622  * NOTE! These match bits 12..15 of stat.st_mode
1623  * (ie "(i_mode >> 12) & 15").
1624  */
1625 #define DT_UNKNOWN      0
1626 #define DT_FIFO         1
1627 #define DT_CHR          2
1628 #define DT_DIR          4
1629 #define DT_BLK          6
1630 #define DT_REG          8
1631 #define DT_LNK          10
1632 #define DT_SOCK         12
1633 #define DT_WHT          14
1634
1635 /*
1636  * This is the "filldir" function type, used by readdir() to let
1637  * the kernel specify what kind of dirent layout it wants to have.
1638  * This allows the kernel to read directories into kernel space or
1639  * to have different dirent layouts depending on the binary type.
1640  */
1641 struct dir_context;
1642 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1643                          unsigned);
1644
1645 struct dir_context {
1646         const filldir_t actor;
1647         loff_t pos;
1648 };
1649
1650 struct block_device_operations;
1651
1652 /* These macros are for out of kernel modules to test that
1653  * the kernel supports the unlocked_ioctl and compat_ioctl
1654  * fields in struct file_operations. */
1655 #define HAVE_COMPAT_IOCTL 1
1656 #define HAVE_UNLOCKED_IOCTL 1
1657
1658 /*
1659  * These flags let !MMU mmap() govern direct device mapping vs immediate
1660  * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1661  *
1662  * NOMMU_MAP_COPY:      Copy can be mapped (MAP_PRIVATE)
1663  * NOMMU_MAP_DIRECT:    Can be mapped directly (MAP_SHARED)
1664  * NOMMU_MAP_READ:      Can be mapped for reading
1665  * NOMMU_MAP_WRITE:     Can be mapped for writing
1666  * NOMMU_MAP_EXEC:      Can be mapped for execution
1667  */
1668 #define NOMMU_MAP_COPY          0x00000001
1669 #define NOMMU_MAP_DIRECT        0x00000008
1670 #define NOMMU_MAP_READ          VM_MAYREAD
1671 #define NOMMU_MAP_WRITE         VM_MAYWRITE
1672 #define NOMMU_MAP_EXEC          VM_MAYEXEC
1673
1674 #define NOMMU_VMFLAGS \
1675         (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1676
1677
1678 struct iov_iter;
1679
1680 struct file_operations {
1681         struct module *owner;
1682         loff_t (*llseek) (struct file *, loff_t, int);
1683         ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1684         ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1685         ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1686         ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1687         int (*iterate) (struct file *, struct dir_context *);
1688         int (*iterate_shared) (struct file *, struct dir_context *);
1689         unsigned int (*poll) (struct file *, struct poll_table_struct *);
1690         long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1691         long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1692         int (*mmap) (struct file *, struct vm_area_struct *);
1693         int (*open) (struct inode *, struct file *);
1694         int (*flush) (struct file *, fl_owner_t id);
1695         int (*release) (struct inode *, struct file *);
1696         int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1697         int (*aio_fsync) (struct kiocb *, int datasync);
1698         int (*fasync) (int, struct file *, int);
1699         int (*lock) (struct file *, int, struct file_lock *);
1700         ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1701         unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1702         int (*check_flags)(int);
1703         int (*flock) (struct file *, int, struct file_lock *);
1704         ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1705         ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1706         int (*setlease)(struct file *, long, struct file_lock **, void **);
1707         long (*fallocate)(struct file *file, int mode, loff_t offset,
1708                           loff_t len);
1709         void (*show_fdinfo)(struct seq_file *m, struct file *f);
1710 #ifndef CONFIG_MMU
1711         unsigned (*mmap_capabilities)(struct file *);
1712 #endif
1713         ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1714                         loff_t, size_t, unsigned int);
1715         int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1716                         u64);
1717         ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1718                         u64);
1719 };
1720
1721 struct inode_operations {
1722         struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1723         const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1724         int (*permission) (struct inode *, int);
1725         struct posix_acl * (*get_acl)(struct inode *, int);
1726
1727         int (*readlink) (struct dentry *, char __user *,int);
1728
1729         int (*create) (struct inode *,struct dentry *, umode_t, bool);
1730         int (*link) (struct dentry *,struct inode *,struct dentry *);
1731         int (*unlink) (struct inode *,struct dentry *);
1732         int (*symlink) (struct inode *,struct dentry *,const char *);
1733         int (*mkdir) (struct inode *,struct dentry *,umode_t);
1734         int (*rmdir) (struct inode *,struct dentry *);
1735         int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1736         int (*rename) (struct inode *, struct dentry *,
1737                         struct inode *, struct dentry *);
1738         int (*rename2) (struct inode *, struct dentry *,
1739                         struct inode *, struct dentry *, unsigned int);
1740         int (*setattr) (struct dentry *, struct iattr *);
1741         int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
1742         ssize_t (*listxattr) (struct dentry *, char *, size_t);
1743         int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1744                       u64 len);
1745         int (*update_time)(struct inode *, struct timespec *, int);
1746         int (*atomic_open)(struct inode *, struct dentry *,
1747                            struct file *, unsigned open_flag,
1748                            umode_t create_mode, int *opened);
1749         int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1750         int (*set_acl)(struct inode *, struct posix_acl *, int);
1751 } ____cacheline_aligned;
1752
1753 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1754                               unsigned long nr_segs, unsigned long fast_segs,
1755                               struct iovec *fast_pointer,
1756                               struct iovec **ret_pointer);
1757
1758 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1759 extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
1760 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1761 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1762 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1763                 unsigned long, loff_t *, int);
1764 extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1765                 unsigned long, loff_t *, int);
1766 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1767                                    loff_t, size_t, unsigned int);
1768 extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1769                 struct file *file_out, loff_t pos_out, u64 len);
1770 extern int vfs_dedupe_file_range(struct file *file,
1771                                  struct file_dedupe_range *same);
1772
1773 struct super_operations {
1774         struct inode *(*alloc_inode)(struct super_block *sb);
1775         void (*destroy_inode)(struct inode *);
1776
1777         void (*dirty_inode) (struct inode *, int flags);
1778         int (*write_inode) (struct inode *, struct writeback_control *wbc);
1779         int (*drop_inode) (struct inode *);
1780         void (*evict_inode) (struct inode *);
1781         void (*put_super) (struct super_block *);
1782         int (*sync_fs)(struct super_block *sb, int wait);
1783         int (*freeze_super) (struct super_block *);
1784         int (*freeze_fs) (struct super_block *);
1785         int (*thaw_super) (struct super_block *);
1786         int (*unfreeze_fs) (struct super_block *);
1787         int (*statfs) (struct dentry *, struct kstatfs *);
1788         int (*remount_fs) (struct super_block *, int *, char *);
1789         void (*umount_begin) (struct super_block *);
1790
1791         int (*show_options)(struct seq_file *, struct dentry *);
1792         int (*show_devname)(struct seq_file *, struct dentry *);
1793         int (*show_path)(struct seq_file *, struct dentry *);
1794         int (*show_stats)(struct seq_file *, struct dentry *);
1795 #ifdef CONFIG_QUOTA
1796         ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1797         ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1798         struct dquot **(*get_dquots)(struct inode *);
1799 #endif
1800         int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1801         long (*nr_cached_objects)(struct super_block *,
1802                                   struct shrink_control *);
1803         long (*free_cached_objects)(struct super_block *,
1804                                     struct shrink_control *);
1805 };
1806
1807 /*
1808  * Inode flags - they have no relation to superblock flags now
1809  */
1810 #define S_SYNC          1       /* Writes are synced at once */
1811 #define S_NOATIME       2       /* Do not update access times */
1812 #define S_APPEND        4       /* Append-only file */
1813 #define S_IMMUTABLE     8       /* Immutable file */
1814 #define S_DEAD          16      /* removed, but still open directory */
1815 #define S_NOQUOTA       32      /* Inode is not counted to quota */
1816 #define S_DIRSYNC       64      /* Directory modifications are synchronous */
1817 #define S_NOCMTIME      128     /* Do not update file c/mtime */
1818 #define S_SWAPFILE      256     /* Do not truncate: swapon got its bmaps */
1819 #define S_PRIVATE       512     /* Inode is fs-internal */
1820 #define S_IMA           1024    /* Inode has an associated IMA struct */
1821 #define S_AUTOMOUNT     2048    /* Automount/referral quasi-directory */
1822 #define S_NOSEC         4096    /* no suid or xattr security attributes */
1823 #ifdef CONFIG_FS_DAX
1824 #define S_DAX           8192    /* Direct Access, avoiding the page cache */
1825 #else
1826 #define S_DAX           0       /* Make all the DAX code disappear */
1827 #endif
1828
1829 /*
1830  * Note that nosuid etc flags are inode-specific: setting some file-system
1831  * flags just means all the inodes inherit those flags by default. It might be
1832  * possible to override it selectively if you really wanted to with some
1833  * ioctl() that is not currently implemented.
1834  *
1835  * Exception: MS_RDONLY is always applied to the entire file system.
1836  *
1837  * Unfortunately, it is possible to change a filesystems flags with it mounted
1838  * with files in use.  This means that all of the inodes will not have their
1839  * i_flags updated.  Hence, i_flags no longer inherit the superblock mount
1840  * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1841  */
1842 #define __IS_FLG(inode, flg)    ((inode)->i_sb->s_flags & (flg))
1843
1844 #define IS_RDONLY(inode)        ((inode)->i_sb->s_flags & MS_RDONLY)
1845 #define IS_SYNC(inode)          (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1846                                         ((inode)->i_flags & S_SYNC))
1847 #define IS_DIRSYNC(inode)       (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1848                                         ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1849 #define IS_MANDLOCK(inode)      __IS_FLG(inode, MS_MANDLOCK)
1850 #define IS_NOATIME(inode)       __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1851 #define IS_I_VERSION(inode)     __IS_FLG(inode, MS_I_VERSION)
1852
1853 #define IS_NOQUOTA(inode)       ((inode)->i_flags & S_NOQUOTA)
1854 #define IS_APPEND(inode)        ((inode)->i_flags & S_APPEND)
1855 #define IS_IMMUTABLE(inode)     ((inode)->i_flags & S_IMMUTABLE)
1856 #define IS_POSIXACL(inode)      __IS_FLG(inode, MS_POSIXACL)
1857
1858 #define IS_DEADDIR(inode)       ((inode)->i_flags & S_DEAD)
1859 #define IS_NOCMTIME(inode)      ((inode)->i_flags & S_NOCMTIME)
1860 #define IS_SWAPFILE(inode)      ((inode)->i_flags & S_SWAPFILE)
1861 #define IS_PRIVATE(inode)       ((inode)->i_flags & S_PRIVATE)
1862 #define IS_IMA(inode)           ((inode)->i_flags & S_IMA)
1863 #define IS_AUTOMOUNT(inode)     ((inode)->i_flags & S_AUTOMOUNT)
1864 #define IS_NOSEC(inode)         ((inode)->i_flags & S_NOSEC)
1865 #define IS_DAX(inode)           ((inode)->i_flags & S_DAX)
1866
1867 #define IS_WHITEOUT(inode)      (S_ISCHR(inode->i_mode) && \
1868                                  (inode)->i_rdev == WHITEOUT_DEV)
1869
1870 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1871 {
1872         return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1873 }
1874
1875 /*
1876  * Inode state bits.  Protected by inode->i_lock
1877  *
1878  * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1879  * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1880  *
1881  * Four bits define the lifetime of an inode.  Initially, inodes are I_NEW,
1882  * until that flag is cleared.  I_WILL_FREE, I_FREEING and I_CLEAR are set at
1883  * various stages of removing an inode.
1884  *
1885  * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1886  *
1887  * I_DIRTY_SYNC         Inode is dirty, but doesn't have to be written on
1888  *                      fdatasync().  i_atime is the usual cause.
1889  * I_DIRTY_DATASYNC     Data-related inode changes pending. We keep track of
1890  *                      these changes separately from I_DIRTY_SYNC so that we
1891  *                      don't have to write inode on fdatasync() when only
1892  *                      mtime has changed in it.
1893  * I_DIRTY_PAGES        Inode has dirty pages.  Inode itself may be clean.
1894  * I_NEW                Serves as both a mutex and completion notification.
1895  *                      New inodes set I_NEW.  If two processes both create
1896  *                      the same inode, one of them will release its inode and
1897  *                      wait for I_NEW to be released before returning.
1898  *                      Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1899  *                      also cause waiting on I_NEW, without I_NEW actually
1900  *                      being set.  find_inode() uses this to prevent returning
1901  *                      nearly-dead inodes.
1902  * I_WILL_FREE          Must be set when calling write_inode_now() if i_count
1903  *                      is zero.  I_FREEING must be set when I_WILL_FREE is
1904  *                      cleared.
1905  * I_FREEING            Set when inode is about to be freed but still has dirty
1906  *                      pages or buffers attached or the inode itself is still
1907  *                      dirty.
1908  * I_CLEAR              Added by clear_inode().  In this state the inode is
1909  *                      clean and can be destroyed.  Inode keeps I_FREEING.
1910  *
1911  *                      Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1912  *                      prohibited for many purposes.  iget() must wait for
1913  *                      the inode to be completely released, then create it
1914  *                      anew.  Other functions will just ignore such inodes,
1915  *                      if appropriate.  I_NEW is used for waiting.
1916  *
1917  * I_SYNC               Writeback of inode is running. The bit is set during
1918  *                      data writeback, and cleared with a wakeup on the bit
1919  *                      address once it is done. The bit is also used to pin
1920  *                      the inode in memory for flusher thread.
1921  *
1922  * I_REFERENCED         Marks the inode as recently references on the LRU list.
1923  *
1924  * I_DIO_WAKEUP         Never set.  Only used as a key for wait_on_bit().
1925  *
1926  * I_WB_SWITCH          Cgroup bdi_writeback switching in progress.  Used to
1927  *                      synchronize competing switching instances and to tell
1928  *                      wb stat updates to grab mapping->tree_lock.  See
1929  *                      inode_switch_wb_work_fn() for details.
1930  *
1931  * Q: What is the difference between I_WILL_FREE and I_FREEING?
1932  */
1933 #define I_DIRTY_SYNC            (1 << 0)
1934 #define I_DIRTY_DATASYNC        (1 << 1)
1935 #define I_DIRTY_PAGES           (1 << 2)
1936 #define __I_NEW                 3
1937 #define I_NEW                   (1 << __I_NEW)
1938 #define I_WILL_FREE             (1 << 4)
1939 #define I_FREEING               (1 << 5)
1940 #define I_CLEAR                 (1 << 6)
1941 #define __I_SYNC                7
1942 #define I_SYNC                  (1 << __I_SYNC)
1943 #define I_REFERENCED            (1 << 8)
1944 #define __I_DIO_WAKEUP          9
1945 #define I_DIO_WAKEUP            (1 << __I_DIO_WAKEUP)
1946 #define I_LINKABLE              (1 << 10)
1947 #define I_DIRTY_TIME            (1 << 11)
1948 #define __I_DIRTY_TIME_EXPIRED  12
1949 #define I_DIRTY_TIME_EXPIRED    (1 << __I_DIRTY_TIME_EXPIRED)
1950 #define I_WB_SWITCH             (1 << 13)
1951
1952 #define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
1953 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
1954
1955 extern void __mark_inode_dirty(struct inode *, int);
1956 static inline void mark_inode_dirty(struct inode *inode)
1957 {
1958         __mark_inode_dirty(inode, I_DIRTY);
1959 }
1960
1961 static inline void mark_inode_dirty_sync(struct inode *inode)
1962 {
1963         __mark_inode_dirty(inode, I_DIRTY_SYNC);
1964 }
1965
1966 extern void inc_nlink(struct inode *inode);
1967 extern void drop_nlink(struct inode *inode);
1968 extern void clear_nlink(struct inode *inode);
1969 extern void set_nlink(struct inode *inode, unsigned int nlink);
1970
1971 static inline void inode_inc_link_count(struct inode *inode)
1972 {
1973         inc_nlink(inode);
1974         mark_inode_dirty(inode);
1975 }
1976
1977 static inline void inode_dec_link_count(struct inode *inode)
1978 {
1979         drop_nlink(inode);
1980         mark_inode_dirty(inode);
1981 }
1982
1983 /**
1984  * inode_inc_iversion - increments i_version
1985  * @inode: inode that need to be updated
1986  *
1987  * Every time the inode is modified, the i_version field will be incremented.
1988  * The filesystem has to be mounted with i_version flag
1989  */
1990
1991 static inline void inode_inc_iversion(struct inode *inode)
1992 {
1993        spin_lock(&inode->i_lock);
1994        inode->i_version++;
1995        spin_unlock(&inode->i_lock);
1996 }
1997
1998 enum file_time_flags {
1999         S_ATIME = 1,
2000         S_MTIME = 2,
2001         S_CTIME = 4,
2002         S_VERSION = 8,
2003 };
2004
2005 extern bool atime_needs_update(const struct path *, struct inode *);
2006 extern void touch_atime(const struct path *);
2007 static inline void file_accessed(struct file *file)
2008 {
2009         if (!(file->f_flags & O_NOATIME))
2010                 touch_atime(&file->f_path);
2011 }
2012
2013 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2014 int sync_inode_metadata(struct inode *inode, int wait);
2015
2016 struct file_system_type {
2017         const char *name;
2018         int fs_flags;
2019 #define FS_REQUIRES_DEV         1 
2020 #define FS_BINARY_MOUNTDATA     2
2021 #define FS_HAS_SUBTYPE          4
2022 #define FS_USERNS_MOUNT         8       /* Can be mounted by userns root */
2023 #define FS_RENAME_DOES_D_MOVE   32768   /* FS will handle d_move() during rename() internally. */
2024         struct dentry *(*mount) (struct file_system_type *, int,
2025                        const char *, void *);
2026         void (*kill_sb) (struct super_block *);
2027         struct module *owner;
2028         struct file_system_type * next;
2029         struct hlist_head fs_supers;
2030
2031         struct lock_class_key s_lock_key;
2032         struct lock_class_key s_umount_key;
2033         struct lock_class_key s_vfs_rename_key;
2034         struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2035
2036         struct lock_class_key i_lock_key;
2037         struct lock_class_key i_mutex_key;
2038         struct lock_class_key i_mutex_dir_key;
2039 };
2040
2041 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2042
2043 extern struct dentry *mount_ns(struct file_system_type *fs_type,
2044         int flags, void *data, void *ns, struct user_namespace *user_ns,
2045         int (*fill_super)(struct super_block *, void *, int));
2046 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2047         int flags, const char *dev_name, void *data,
2048         int (*fill_super)(struct super_block *, void *, int));
2049 extern struct dentry *mount_single(struct file_system_type *fs_type,
2050         int flags, void *data,
2051         int (*fill_super)(struct super_block *, void *, int));
2052 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2053         int flags, void *data,
2054         int (*fill_super)(struct super_block *, void *, int));
2055 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2056 void generic_shutdown_super(struct super_block *sb);
2057 void kill_block_super(struct super_block *sb);
2058 void kill_anon_super(struct super_block *sb);
2059 void kill_litter_super(struct super_block *sb);
2060 void deactivate_super(struct super_block *sb);
2061 void deactivate_locked_super(struct super_block *sb);
2062 int set_anon_super(struct super_block *s, void *data);
2063 int get_anon_bdev(dev_t *);
2064 void free_anon_bdev(dev_t);
2065 struct super_block *sget_userns(struct file_system_type *type,
2066                         int (*test)(struct super_block *,void *),
2067                         int (*set)(struct super_block *,void *),
2068                         int flags, struct user_namespace *user_ns,
2069                         void *data);
2070 struct super_block *sget(struct file_system_type *type,
2071                         int (*test)(struct super_block *,void *),
2072                         int (*set)(struct super_block *,void *),
2073                         int flags, void *data);
2074 extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2075                                          const struct super_operations *ops,
2076                                          const struct xattr_handler **xattr,
2077                                          const struct dentry_operations *dops,
2078                                          unsigned long);
2079
2080 static inline struct dentry *
2081 mount_pseudo(struct file_system_type *fs_type, char *name,
2082              const struct super_operations *ops,
2083              const struct dentry_operations *dops, unsigned long magic)
2084 {
2085         return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2086 }
2087
2088 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2089 #define fops_get(fops) \
2090         (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2091 #define fops_put(fops) \
2092         do { if (fops) module_put((fops)->owner); } while(0)
2093 /*
2094  * This one is to be used *ONLY* from ->open() instances.
2095  * fops must be non-NULL, pinned down *and* module dependencies
2096  * should be sufficient to pin the caller down as well.
2097  */
2098 #define replace_fops(f, fops) \
2099         do {    \
2100                 struct file *__file = (f); \
2101                 fops_put(__file->f_op); \
2102                 BUG_ON(!(__file->f_op = (fops))); \
2103         } while(0)
2104
2105 extern int register_filesystem(struct file_system_type *);
2106 extern int unregister_filesystem(struct file_system_type *);
2107 extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2108 #define kern_mount(type) kern_mount_data(type, NULL)
2109 extern void kern_unmount(struct vfsmount *mnt);
2110 extern int may_umount_tree(struct vfsmount *);
2111 extern int may_umount(struct vfsmount *);
2112 extern long do_mount(const char *, const char __user *,
2113                      const char *, unsigned long, void *);
2114 extern struct vfsmount *collect_mounts(struct path *);
2115 extern void drop_collected_mounts(struct vfsmount *);
2116 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2117                           struct vfsmount *);
2118 extern int vfs_statfs(struct path *, struct kstatfs *);
2119 extern int user_statfs(const char __user *, struct kstatfs *);
2120 extern int fd_statfs(int, struct kstatfs *);
2121 extern int vfs_ustat(dev_t, struct kstatfs *);
2122 extern int freeze_super(struct super_block *super);
2123 extern int thaw_super(struct super_block *super);
2124 extern bool our_mnt(struct vfsmount *mnt);
2125
2126 extern int current_umask(void);
2127
2128 extern void ihold(struct inode * inode);
2129 extern void iput(struct inode *);
2130 extern int generic_update_time(struct inode *, struct timespec *, int);
2131
2132 /* /sys/fs */
2133 extern struct kobject *fs_kobj;
2134
2135 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2136
2137 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2138 extern int locks_mandatory_locked(struct file *);
2139 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2140
2141 /*
2142  * Candidates for mandatory locking have the setgid bit set
2143  * but no group execute bit -  an otherwise meaningless combination.
2144  */
2145
2146 static inline int __mandatory_lock(struct inode *ino)
2147 {
2148         return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2149 }
2150
2151 /*
2152  * ... and these candidates should be on MS_MANDLOCK mounted fs,
2153  * otherwise these will be advisory locks
2154  */
2155
2156 static inline int mandatory_lock(struct inode *ino)
2157 {
2158         return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2159 }
2160
2161 static inline int locks_verify_locked(struct file *file)
2162 {
2163         if (mandatory_lock(file_inode(file)))
2164                 return locks_mandatory_locked(file);
2165         return 0;
2166 }
2167
2168 static inline int locks_verify_truncate(struct inode *inode,
2169                                     struct file *f,
2170                                     loff_t size)
2171 {
2172         if (!inode->i_flctx || !mandatory_lock(inode))
2173                 return 0;
2174
2175         if (size < inode->i_size) {
2176                 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2177                                 F_WRLCK);
2178         } else {
2179                 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2180                                 F_WRLCK);
2181         }
2182 }
2183
2184 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2185
2186 static inline int locks_mandatory_locked(struct file *file)
2187 {
2188         return 0;
2189 }
2190
2191 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2192                                        loff_t start, loff_t end, unsigned char type)
2193 {
2194         return 0;
2195 }
2196
2197 static inline int __mandatory_lock(struct inode *inode)
2198 {
2199         return 0;
2200 }
2201
2202 static inline int mandatory_lock(struct inode *inode)
2203 {
2204         return 0;
2205 }
2206
2207 static inline int locks_verify_locked(struct file *file)
2208 {
2209         return 0;
2210 }
2211
2212 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2213                                         size_t size)
2214 {
2215         return 0;
2216 }
2217
2218 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2219
2220
2221 #ifdef CONFIG_FILE_LOCKING
2222 static inline int break_lease(struct inode *inode, unsigned int mode)
2223 {
2224         /*
2225          * Since this check is lockless, we must ensure that any refcounts
2226          * taken are done before checking i_flctx->flc_lease. Otherwise, we
2227          * could end up racing with tasks trying to set a new lease on this
2228          * file.
2229          */
2230         smp_mb();
2231         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2232                 return __break_lease(inode, mode, FL_LEASE);
2233         return 0;
2234 }
2235
2236 static inline int break_deleg(struct inode *inode, unsigned int mode)
2237 {
2238         /*
2239          * Since this check is lockless, we must ensure that any refcounts
2240          * taken are done before checking i_flctx->flc_lease. Otherwise, we
2241          * could end up racing with tasks trying to set a new lease on this
2242          * file.
2243          */
2244         smp_mb();
2245         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2246                 return __break_lease(inode, mode, FL_DELEG);
2247         return 0;
2248 }
2249
2250 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2251 {
2252         int ret;
2253
2254         ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2255         if (ret == -EWOULDBLOCK && delegated_inode) {
2256                 *delegated_inode = inode;
2257                 ihold(inode);
2258         }
2259         return ret;
2260 }
2261
2262 static inline int break_deleg_wait(struct inode **delegated_inode)
2263 {
2264         int ret;
2265
2266         ret = break_deleg(*delegated_inode, O_WRONLY);
2267         iput(*delegated_inode);
2268         *delegated_inode = NULL;
2269         return ret;
2270 }
2271
2272 static inline int break_layout(struct inode *inode, bool wait)
2273 {
2274         smp_mb();
2275         if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2276                 return __break_lease(inode,
2277                                 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2278                                 FL_LAYOUT);
2279         return 0;
2280 }
2281
2282 #else /* !CONFIG_FILE_LOCKING */
2283 static inline int break_lease(struct inode *inode, unsigned int mode)
2284 {
2285         return 0;
2286 }
2287
2288 static inline int break_deleg(struct inode *inode, unsigned int mode)
2289 {
2290         return 0;
2291 }
2292
2293 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2294 {
2295         return 0;
2296 }
2297
2298 static inline int break_deleg_wait(struct inode **delegated_inode)
2299 {
2300         BUG();
2301         return 0;
2302 }
2303
2304 static inline int break_layout(struct inode *inode, bool wait)
2305 {
2306         return 0;
2307 }
2308
2309 #endif /* CONFIG_FILE_LOCKING */
2310
2311 /* fs/open.c */
2312 struct audit_names;
2313 struct filename {
2314         const char              *name;  /* pointer to actual string */
2315         const __user char       *uptr;  /* original userland pointer */
2316         struct audit_names      *aname;
2317         int                     refcnt;
2318         const char              iname[];
2319 };
2320
2321 extern long vfs_truncate(const struct path *, loff_t);
2322 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2323                        struct file *filp);
2324 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2325                         loff_t len);
2326 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2327                         umode_t mode);
2328 extern struct file *file_open_name(struct filename *, int, umode_t);
2329 extern struct file *filp_open(const char *, int, umode_t);
2330 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2331                                    const char *, int, umode_t);
2332 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2333 extern int filp_close(struct file *, fl_owner_t id);
2334
2335 extern struct filename *getname_flags(const char __user *, int, int *);
2336 extern struct filename *getname(const char __user *);
2337 extern struct filename *getname_kernel(const char *);
2338 extern void putname(struct filename *name);
2339
2340 enum {
2341         FILE_CREATED = 1,
2342         FILE_OPENED = 2
2343 };
2344 extern int finish_open(struct file *file, struct dentry *dentry,
2345                         int (*open)(struct inode *, struct file *),
2346                         int *opened);
2347 extern int finish_no_open(struct file *file, struct dentry *dentry);
2348
2349 /* fs/ioctl.c */
2350
2351 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2352
2353 /* fs/dcache.c */
2354 extern void __init vfs_caches_init_early(void);
2355 extern void __init vfs_caches_init(void);
2356
2357 extern struct kmem_cache *names_cachep;
2358
2359 #define __getname()             kmem_cache_alloc(names_cachep, GFP_KERNEL)
2360 #define __putname(name)         kmem_cache_free(names_cachep, (void *)(name))
2361
2362 #ifdef CONFIG_BLOCK
2363 extern int register_blkdev(unsigned int, const char *);
2364 extern void unregister_blkdev(unsigned int, const char *);
2365 extern struct block_device *bdget(dev_t);
2366 extern struct block_device *bdgrab(struct block_device *bdev);
2367 extern void bd_set_size(struct block_device *, loff_t size);
2368 extern void bd_forget(struct inode *inode);
2369 extern void bdput(struct block_device *);
2370 extern void invalidate_bdev(struct block_device *);
2371 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
2372 extern int sync_blockdev(struct block_device *bdev);
2373 extern void kill_bdev(struct block_device *);
2374 extern struct super_block *freeze_bdev(struct block_device *);
2375 extern void emergency_thaw_all(void);
2376 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2377 extern int fsync_bdev(struct block_device *);
2378
2379 extern struct super_block *blockdev_superblock;
2380
2381 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2382 {
2383         return sb == blockdev_superblock;
2384 }
2385 #else
2386 static inline void bd_forget(struct inode *inode) {}
2387 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2388 static inline void kill_bdev(struct block_device *bdev) {}
2389 static inline void invalidate_bdev(struct block_device *bdev) {}
2390
2391 static inline struct super_block *freeze_bdev(struct block_device *sb)
2392 {
2393         return NULL;
2394 }
2395
2396 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2397 {
2398         return 0;
2399 }
2400
2401 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2402 {
2403 }
2404
2405 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2406 {
2407         return false;
2408 }
2409 #endif
2410 extern int sync_filesystem(struct super_block *);
2411 extern const struct file_operations def_blk_fops;
2412 extern const struct file_operations def_chr_fops;
2413 #ifdef CONFIG_BLOCK
2414 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2415 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2416 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2417 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2418 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2419                                                void *holder);
2420 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2421                                               void *holder);
2422 extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2423 extern int __blkdev_reread_part(struct block_device *bdev);
2424 extern int blkdev_reread_part(struct block_device *bdev);
2425
2426 #ifdef CONFIG_SYSFS
2427 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2428 extern void bd_unlink_disk_holder(struct block_device *bdev,
2429                                   struct gendisk *disk);
2430 #else
2431 static inline int bd_link_disk_holder(struct block_device *bdev,
2432                                       struct gendisk *disk)
2433 {
2434         return 0;
2435 }
2436 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2437                                          struct gendisk *disk)
2438 {
2439 }
2440 #endif
2441 #endif
2442
2443 /* fs/char_dev.c */
2444 #define CHRDEV_MAJOR_HASH_SIZE  255
2445 /* Marks the bottom of the first segment of free char majors */
2446 #define CHRDEV_MAJOR_DYN_END 234
2447 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2448 extern int register_chrdev_region(dev_t, unsigned, const char *);
2449 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2450                              unsigned int count, const char *name,
2451                              const struct file_operations *fops);
2452 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2453                                 unsigned int count, const char *name);
2454 extern void unregister_chrdev_region(dev_t, unsigned);
2455 extern void chrdev_show(struct seq_file *,off_t);
2456
2457 static inline int register_chrdev(unsigned int major, const char *name,
2458                                   const struct file_operations *fops)
2459 {
2460         return __register_chrdev(major, 0, 256, name, fops);
2461 }
2462
2463 static inline void unregister_chrdev(unsigned int major, const char *name)
2464 {
2465         __unregister_chrdev(major, 0, 256, name);
2466 }
2467
2468 /* fs/block_dev.c */
2469 #define BDEVNAME_SIZE   32      /* Largest string for a blockdev identifier */
2470 #define BDEVT_SIZE      10      /* Largest string for MAJ:MIN for blkdev */
2471
2472 #ifdef CONFIG_BLOCK
2473 #define BLKDEV_MAJOR_HASH_SIZE  255
2474 extern const char *__bdevname(dev_t, char *buffer);
2475 extern const char *bdevname(struct block_device *bdev, char *buffer);
2476 extern struct block_device *lookup_bdev(const char *);
2477 extern void blkdev_show(struct seq_file *,off_t);
2478
2479 #else
2480 #define BLKDEV_MAJOR_HASH_SIZE  0
2481 #endif
2482
2483 extern void init_special_inode(struct inode *, umode_t, dev_t);
2484
2485 /* Invalid inode operations -- fs/bad_inode.c */
2486 extern void make_bad_inode(struct inode *);
2487 extern bool is_bad_inode(struct inode *);
2488
2489 #ifdef CONFIG_BLOCK
2490 static inline bool op_is_write(unsigned int op)
2491 {
2492         return op == REQ_OP_READ ? false : true;
2493 }
2494
2495 /*
2496  * return data direction, READ or WRITE
2497  */
2498 static inline int bio_data_dir(struct bio *bio)
2499 {
2500         return op_is_write(bio_op(bio)) ? WRITE : READ;
2501 }
2502
2503 extern void check_disk_size_change(struct gendisk *disk,
2504                                    struct block_device *bdev);
2505 extern int revalidate_disk(struct gendisk *);
2506 extern int check_disk_change(struct block_device *);
2507 extern int __invalidate_device(struct block_device *, bool);
2508 extern int invalidate_partition(struct gendisk *, int);
2509 #endif
2510 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2511                                         pgoff_t start, pgoff_t end);
2512
2513 static inline void invalidate_remote_inode(struct inode *inode)
2514 {
2515         if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2516             S_ISLNK(inode->i_mode))
2517                 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2518 }
2519 extern int invalidate_inode_pages2(struct address_space *mapping);
2520 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2521                                          pgoff_t start, pgoff_t end);
2522 extern int write_inode_now(struct inode *, int);
2523 extern int filemap_fdatawrite(struct address_space *);
2524 extern int filemap_flush(struct address_space *);
2525 extern int filemap_fdatawait(struct address_space *);
2526 extern void filemap_fdatawait_keep_errors(struct address_space *);
2527 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2528                                    loff_t lend);
2529 extern int filemap_write_and_wait(struct address_space *mapping);
2530 extern int filemap_write_and_wait_range(struct address_space *mapping,
2531                                         loff_t lstart, loff_t lend);
2532 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2533                                 loff_t start, loff_t end, int sync_mode);
2534 extern int filemap_fdatawrite_range(struct address_space *mapping,
2535                                 loff_t start, loff_t end);
2536 extern int filemap_check_errors(struct address_space *mapping);
2537
2538 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2539                            int datasync);
2540 extern int vfs_fsync(struct file *file, int datasync);
2541
2542 /*
2543  * Sync the bytes written if this was a synchronous write.  Expect ki_pos
2544  * to already be updated for the write, and will return either the amount
2545  * of bytes passed in, or an error if syncing the file failed.
2546  */
2547 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2548 {
2549         if (iocb->ki_flags & IOCB_DSYNC) {
2550                 int ret = vfs_fsync_range(iocb->ki_filp,
2551                                 iocb->ki_pos - count, iocb->ki_pos - 1,
2552                                 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2553                 if (ret)
2554                         return ret;
2555         }
2556
2557         return count;
2558 }
2559
2560 extern void emergency_sync(void);
2561 extern void emergency_remount(void);
2562 #ifdef CONFIG_BLOCK
2563 extern sector_t bmap(struct inode *, sector_t);
2564 #endif
2565 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2566 extern int inode_permission(struct inode *, int);
2567 extern int __inode_permission(struct inode *, int);
2568 extern int generic_permission(struct inode *, int);
2569 extern int __check_sticky(struct inode *dir, struct inode *inode);
2570
2571 static inline bool execute_ok(struct inode *inode)
2572 {
2573         return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2574 }
2575
2576 static inline void file_start_write(struct file *file)
2577 {
2578         if (!S_ISREG(file_inode(file)->i_mode))
2579                 return;
2580         __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2581 }
2582
2583 static inline bool file_start_write_trylock(struct file *file)
2584 {
2585         if (!S_ISREG(file_inode(file)->i_mode))
2586                 return true;
2587         return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2588 }
2589
2590 static inline void file_end_write(struct file *file)
2591 {
2592         if (!S_ISREG(file_inode(file)->i_mode))
2593                 return;
2594         __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2595 }
2596
2597 /*
2598  * get_write_access() gets write permission for a file.
2599  * put_write_access() releases this write permission.
2600  * This is used for regular files.
2601  * We cannot support write (and maybe mmap read-write shared) accesses and
2602  * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2603  * can have the following values:
2604  * 0: no writers, no VM_DENYWRITE mappings
2605  * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2606  * > 0: (i_writecount) users are writing to the file.
2607  *
2608  * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2609  * except for the cases where we don't hold i_writecount yet. Then we need to
2610  * use {get,deny}_write_access() - these functions check the sign and refuse
2611  * to do the change if sign is wrong.
2612  */
2613 static inline int get_write_access(struct inode *inode)
2614 {
2615         return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2616 }
2617 static inline int deny_write_access(struct file *file)
2618 {
2619         struct inode *inode = file_inode(file);
2620         return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2621 }
2622 static inline void put_write_access(struct inode * inode)
2623 {
2624         atomic_dec(&inode->i_writecount);
2625 }
2626 static inline void allow_write_access(struct file *file)
2627 {
2628         if (file)
2629                 atomic_inc(&file_inode(file)->i_writecount);
2630 }
2631 static inline bool inode_is_open_for_write(const struct inode *inode)
2632 {
2633         return atomic_read(&inode->i_writecount) > 0;
2634 }
2635
2636 #ifdef CONFIG_IMA
2637 static inline void i_readcount_dec(struct inode *inode)
2638 {
2639         BUG_ON(!atomic_read(&inode->i_readcount));
2640         atomic_dec(&inode->i_readcount);
2641 }
2642 static inline void i_readcount_inc(struct inode *inode)
2643 {
2644         atomic_inc(&inode->i_readcount);
2645 }
2646 #else
2647 static inline void i_readcount_dec(struct inode *inode)
2648 {
2649         return;
2650 }
2651 static inline void i_readcount_inc(struct inode *inode)
2652 {
2653         return;
2654 }
2655 #endif
2656 extern int do_pipe_flags(int *, int);
2657
2658 #define __kernel_read_file_id(id) \
2659         id(UNKNOWN, unknown)            \
2660         id(FIRMWARE, firmware)          \
2661         id(FIRMWARE_PREALLOC_BUFFER, firmware)  \
2662         id(MODULE, kernel-module)               \
2663         id(KEXEC_IMAGE, kexec-image)            \
2664         id(KEXEC_INITRAMFS, kexec-initramfs)    \
2665         id(POLICY, security-policy)             \
2666         id(MAX_ID, )
2667
2668 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2669 #define __fid_stringify(dummy, str) #str,
2670
2671 enum kernel_read_file_id {
2672         __kernel_read_file_id(__fid_enumify)
2673 };
2674
2675 static const char * const kernel_read_file_str[] = {
2676         __kernel_read_file_id(__fid_stringify)
2677 };
2678
2679 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2680 {
2681         if (id < 0 || id >= READING_MAX_ID)
2682                 return kernel_read_file_str[READING_UNKNOWN];
2683
2684         return kernel_read_file_str[id];
2685 }
2686
2687 extern int kernel_read(struct file *, loff_t, char *, unsigned long);
2688 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2689                             enum kernel_read_file_id);
2690 extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2691                                       enum kernel_read_file_id);
2692 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2693                                     enum kernel_read_file_id);
2694 extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
2695 extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
2696 extern struct file * open_exec(const char *);
2697  
2698 /* fs/dcache.c -- generic fs support functions */
2699 extern bool is_subdir(struct dentry *, struct dentry *);
2700 extern bool path_is_under(struct path *, struct path *);
2701
2702 extern char *file_path(struct file *, char *, int);
2703
2704 #include <linux/err.h>
2705
2706 /* needed for stackable file system support */
2707 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2708
2709 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2710
2711 extern int inode_init_always(struct super_block *, struct inode *);
2712 extern void inode_init_once(struct inode *);
2713 extern void address_space_init_once(struct address_space *mapping);
2714 extern struct inode * igrab(struct inode *);
2715 extern ino_t iunique(struct super_block *, ino_t);
2716 extern int inode_needs_sync(struct inode *inode);
2717 extern int generic_delete_inode(struct inode *inode);
2718 static inline int generic_drop_inode(struct inode *inode)
2719 {
2720         return !inode->i_nlink || inode_unhashed(inode);
2721 }
2722
2723 extern struct inode *ilookup5_nowait(struct super_block *sb,
2724                 unsigned long hashval, int (*test)(struct inode *, void *),
2725                 void *data);
2726 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2727                 int (*test)(struct inode *, void *), void *data);
2728 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2729
2730 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2731 extern struct inode * iget_locked(struct super_block *, unsigned long);
2732 extern struct inode *find_inode_nowait(struct super_block *,
2733                                        unsigned long,
2734                                        int (*match)(struct inode *,
2735                                                     unsigned long, void *),
2736                                        void *data);
2737 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2738 extern int insert_inode_locked(struct inode *);
2739 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2740 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2741 #else
2742 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2743 #endif
2744 extern void unlock_new_inode(struct inode *);
2745 extern unsigned int get_next_ino(void);
2746
2747 extern void __iget(struct inode * inode);
2748 extern void iget_failed(struct inode *);
2749 extern void clear_inode(struct inode *);
2750 extern void __destroy_inode(struct inode *);
2751 extern struct inode *new_inode_pseudo(struct super_block *sb);
2752 extern struct inode *new_inode(struct super_block *sb);
2753 extern void free_inode_nonrcu(struct inode *inode);
2754 extern int should_remove_suid(struct dentry *);
2755 extern int file_remove_privs(struct file *);
2756
2757 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2758 static inline void insert_inode_hash(struct inode *inode)
2759 {
2760         __insert_inode_hash(inode, inode->i_ino);
2761 }
2762
2763 extern void __remove_inode_hash(struct inode *);
2764 static inline void remove_inode_hash(struct inode *inode)
2765 {
2766         if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
2767                 __remove_inode_hash(inode);
2768 }
2769
2770 extern void inode_sb_list_add(struct inode *inode);
2771
2772 #ifdef CONFIG_BLOCK
2773 extern blk_qc_t submit_bio(struct bio *);
2774 extern int bdev_read_only(struct block_device *);
2775 #endif
2776 extern int set_blocksize(struct block_device *, int);
2777 extern int sb_set_blocksize(struct super_block *, int);
2778 extern int sb_min_blocksize(struct super_block *, int);
2779
2780 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2781 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2782 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
2783 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
2784 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
2785 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
2786 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
2787 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
2788
2789 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2790 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2791
2792 /* fs/block_dev.c */
2793 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
2794 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
2795 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2796                         int datasync);
2797 extern void block_sync_page(struct page *page);
2798
2799 /* fs/splice.c */
2800 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
2801                 struct pipe_inode_info *, size_t, unsigned int);
2802 extern ssize_t default_file_splice_read(struct file *, loff_t *,
2803                 struct pipe_inode_info *, size_t, unsigned int);
2804 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
2805                 struct file *, loff_t *, size_t, unsigned int);
2806 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
2807                 struct file *out, loff_t *, size_t len, unsigned int flags);
2808 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2809                 loff_t *opos, size_t len, unsigned int flags);
2810
2811
2812 extern void
2813 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
2814 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2815 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
2816 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
2817 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
2818 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
2819                 int whence, loff_t maxsize, loff_t eof);
2820 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2821                 int whence, loff_t size);
2822 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2823 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
2824 extern int generic_file_open(struct inode * inode, struct file * filp);
2825 extern int nonseekable_open(struct inode * inode, struct file * filp);
2826
2827 #ifdef CONFIG_BLOCK
2828 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
2829                             loff_t file_offset);
2830
2831 enum {
2832         /* need locking between buffered and direct access */
2833         DIO_LOCKING     = 0x01,
2834
2835         /* filesystem does not support filling holes */
2836         DIO_SKIP_HOLES  = 0x02,
2837
2838         /* filesystem can handle aio writes beyond i_size */
2839         DIO_ASYNC_EXTEND = 0x04,
2840
2841         /* inode/fs/bdev does not need truncate protection */
2842         DIO_SKIP_DIO_COUNT = 0x08,
2843 };
2844
2845 void dio_end_io(struct bio *bio, int error);
2846
2847 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2848                              struct block_device *bdev, struct iov_iter *iter,
2849                              get_block_t get_block,
2850                              dio_iodone_t end_io, dio_submit_t submit_io,
2851                              int flags);
2852
2853 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2854                                          struct inode *inode,
2855                                          struct iov_iter *iter,
2856                                          get_block_t get_block)
2857 {
2858         return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
2859                         get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
2860 }
2861 #endif
2862
2863 void inode_dio_wait(struct inode *inode);
2864
2865 /*
2866  * inode_dio_begin - signal start of a direct I/O requests
2867  * @inode: inode the direct I/O happens on
2868  *
2869  * This is called once we've finished processing a direct I/O request,
2870  * and is used to wake up callers waiting for direct I/O to be quiesced.
2871  */
2872 static inline void inode_dio_begin(struct inode *inode)
2873 {
2874         atomic_inc(&inode->i_dio_count);
2875 }
2876
2877 /*
2878  * inode_dio_end - signal finish of a direct I/O requests
2879  * @inode: inode the direct I/O happens on
2880  *
2881  * This is called once we've finished processing a direct I/O request,
2882  * and is used to wake up callers waiting for direct I/O to be quiesced.
2883  */
2884 static inline void inode_dio_end(struct inode *inode)
2885 {
2886         if (atomic_dec_and_test(&inode->i_dio_count))
2887                 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2888 }
2889
2890 extern void inode_set_flags(struct inode *inode, unsigned int flags,
2891                             unsigned int mask);
2892
2893 extern const struct file_operations generic_ro_fops;
2894
2895 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2896
2897 extern int readlink_copy(char __user *, int, const char *);
2898 extern int page_readlink(struct dentry *, char __user *, int);
2899 extern const char *page_get_link(struct dentry *, struct inode *,
2900                                  struct delayed_call *);
2901 extern void page_put_link(void *);
2902 extern int __page_symlink(struct inode *inode, const char *symname, int len,
2903                 int nofs);
2904 extern int page_symlink(struct inode *inode, const char *symname, int len);
2905 extern const struct inode_operations page_symlink_inode_operations;
2906 extern void kfree_link(void *);
2907 extern int generic_readlink(struct dentry *, char __user *, int);
2908 extern void generic_fillattr(struct inode *, struct kstat *);
2909 int vfs_getattr_nosec(struct path *path, struct kstat *stat);
2910 extern int vfs_getattr(struct path *, struct kstat *);
2911 void __inode_add_bytes(struct inode *inode, loff_t bytes);
2912 void inode_add_bytes(struct inode *inode, loff_t bytes);
2913 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
2914 void inode_sub_bytes(struct inode *inode, loff_t bytes);
2915 loff_t inode_get_bytes(struct inode *inode);
2916 void inode_set_bytes(struct inode *inode, loff_t bytes);
2917 const char *simple_get_link(struct dentry *, struct inode *,
2918                             struct delayed_call *);
2919 extern const struct inode_operations simple_symlink_inode_operations;
2920
2921 extern int iterate_dir(struct file *, struct dir_context *);
2922
2923 extern int vfs_stat(const char __user *, struct kstat *);
2924 extern int vfs_lstat(const char __user *, struct kstat *);
2925 extern int vfs_fstat(unsigned int, struct kstat *);
2926 extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
2927
2928 extern int __generic_block_fiemap(struct inode *inode,
2929                                   struct fiemap_extent_info *fieinfo,
2930                                   loff_t start, loff_t len,
2931                                   get_block_t *get_block);
2932 extern int generic_block_fiemap(struct inode *inode,
2933                                 struct fiemap_extent_info *fieinfo, u64 start,
2934                                 u64 len, get_block_t *get_block);
2935
2936 extern void get_filesystem(struct file_system_type *fs);
2937 extern void put_filesystem(struct file_system_type *fs);
2938 extern struct file_system_type *get_fs_type(const char *name);
2939 extern struct super_block *get_super(struct block_device *);
2940 extern struct super_block *get_super_thawed(struct block_device *);
2941 extern struct super_block *get_active_super(struct block_device *bdev);
2942 extern void drop_super(struct super_block *sb);
2943 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
2944 extern void iterate_supers_type(struct file_system_type *,
2945                                 void (*)(struct super_block *, void *), void *);
2946
2947 extern int dcache_dir_open(struct inode *, struct file *);
2948 extern int dcache_dir_close(struct inode *, struct file *);
2949 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
2950 extern int dcache_readdir(struct file *, struct dir_context *);
2951 extern int simple_setattr(struct dentry *, struct iattr *);
2952 extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
2953 extern int simple_statfs(struct dentry *, struct kstatfs *);
2954 extern int simple_open(struct inode *inode, struct file *file);
2955 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2956 extern int simple_unlink(struct inode *, struct dentry *);
2957 extern int simple_rmdir(struct inode *, struct dentry *);
2958 extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
2959 extern int noop_fsync(struct file *, loff_t, loff_t, int);
2960 extern int simple_empty(struct dentry *);
2961 extern int simple_readpage(struct file *file, struct page *page);
2962 extern int simple_write_begin(struct file *file, struct address_space *mapping,
2963                         loff_t pos, unsigned len, unsigned flags,
2964                         struct page **pagep, void **fsdata);
2965 extern int simple_write_end(struct file *file, struct address_space *mapping,
2966                         loff_t pos, unsigned len, unsigned copied,
2967                         struct page *page, void *fsdata);
2968 extern int always_delete_dentry(const struct dentry *);
2969 extern struct inode *alloc_anon_inode(struct super_block *);
2970 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
2971 extern const struct dentry_operations simple_dentry_operations;
2972
2973 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
2974 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
2975 extern const struct file_operations simple_dir_operations;
2976 extern const struct inode_operations simple_dir_inode_operations;
2977 extern void make_empty_dir_inode(struct inode *inode);
2978 extern bool is_empty_dir_inode(struct inode *inode);
2979 struct tree_descr { char *name; const struct file_operations *ops; int mode; };
2980 struct dentry *d_alloc_name(struct dentry *, const char *);
2981 extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
2982 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
2983 extern void simple_release_fs(struct vfsmount **mount, int *count);
2984
2985 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2986                         loff_t *ppos, const void *from, size_t available);
2987 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
2988                 const void __user *from, size_t count);
2989
2990 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
2991 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
2992
2993 extern int generic_check_addressable(unsigned, u64);
2994
2995 #ifdef CONFIG_MIGRATION
2996 extern int buffer_migrate_page(struct address_space *,
2997                                 struct page *, struct page *,
2998                                 enum migrate_mode);
2999 #else
3000 #define buffer_migrate_page NULL
3001 #endif
3002
3003 extern int inode_change_ok(const struct inode *, struct iattr *);
3004 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3005 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3006
3007 extern int file_update_time(struct file *file);
3008
3009 extern int generic_show_options(struct seq_file *m, struct dentry *root);
3010 extern void save_mount_options(struct super_block *sb, char *options);
3011 extern void replace_mount_options(struct super_block *sb, char *options);
3012
3013 static inline bool io_is_direct(struct file *filp)
3014 {
3015         return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
3016 }
3017
3018 static inline int iocb_flags(struct file *file)
3019 {
3020         int res = 0;
3021         if (file->f_flags & O_APPEND)
3022                 res |= IOCB_APPEND;
3023         if (io_is_direct(file))
3024                 res |= IOCB_DIRECT;
3025         if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3026                 res |= IOCB_DSYNC;
3027         if (file->f_flags & __O_SYNC)
3028                 res |= IOCB_SYNC;
3029         return res;
3030 }
3031
3032 static inline ino_t parent_ino(struct dentry *dentry)
3033 {
3034         ino_t res;
3035
3036         /*
3037          * Don't strictly need d_lock here? If the parent ino could change
3038          * then surely we'd have a deeper race in the caller?
3039          */
3040         spin_lock(&dentry->d_lock);
3041         res = dentry->d_parent->d_inode->i_ino;
3042         spin_unlock(&dentry->d_lock);
3043         return res;
3044 }
3045
3046 /* Transaction based IO helpers */
3047
3048 /*
3049  * An argresp is stored in an allocated page and holds the
3050  * size of the argument or response, along with its content
3051  */
3052 struct simple_transaction_argresp {
3053         ssize_t size;
3054         char data[0];
3055 };
3056
3057 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3058
3059 char *simple_transaction_get(struct file *file, const char __user *buf,
3060                                 size_t size);
3061 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3062                                 size_t size, loff_t *pos);
3063 int simple_transaction_release(struct inode *inode, struct file *file);
3064
3065 void simple_transaction_set(struct file *file, size_t n);
3066
3067 /*
3068  * simple attribute files
3069  *
3070  * These attributes behave similar to those in sysfs:
3071  *
3072  * Writing to an attribute immediately sets a value, an open file can be
3073  * written to multiple times.
3074  *
3075  * Reading from an attribute creates a buffer from the value that might get
3076  * read with multiple read calls. When the attribute has been read
3077  * completely, no further read calls are possible until the file is opened
3078  * again.
3079  *
3080  * All attributes contain a text representation of a numeric value
3081  * that are accessed with the get() and set() functions.
3082  */
3083 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)            \
3084 static int __fops ## _open(struct inode *inode, struct file *file)      \
3085 {                                                                       \
3086         __simple_attr_check_format(__fmt, 0ull);                        \
3087         return simple_attr_open(inode, file, __get, __set, __fmt);      \
3088 }                                                                       \
3089 static const struct file_operations __fops = {                          \
3090         .owner   = THIS_MODULE,                                         \
3091         .open    = __fops ## _open,                                     \
3092         .release = simple_attr_release,                                 \
3093         .read    = simple_attr_read,                                    \
3094         .write   = simple_attr_write,                                   \
3095         .llseek  = generic_file_llseek,                                 \
3096 }
3097
3098 static inline __printf(1, 2)
3099 void __simple_attr_check_format(const char *fmt, ...)
3100 {
3101         /* don't do anything, just let the compiler check the arguments; */
3102 }
3103
3104 int simple_attr_open(struct inode *inode, struct file *file,
3105                      int (*get)(void *, u64 *), int (*set)(void *, u64),
3106                      const char *fmt);
3107 int simple_attr_release(struct inode *inode, struct file *file);
3108 ssize_t simple_attr_read(struct file *file, char __user *buf,
3109                          size_t len, loff_t *ppos);
3110 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3111                           size_t len, loff_t *ppos);
3112
3113 struct ctl_table;
3114 int proc_nr_files(struct ctl_table *table, int write,
3115                   void __user *buffer, size_t *lenp, loff_t *ppos);
3116 int proc_nr_dentry(struct ctl_table *table, int write,
3117                   void __user *buffer, size_t *lenp, loff_t *ppos);
3118 int proc_nr_inodes(struct ctl_table *table, int write,
3119                    void __user *buffer, size_t *lenp, loff_t *ppos);
3120 int __init get_filesystem_list(char *buf);
3121
3122 #define __FMODE_EXEC            ((__force int) FMODE_EXEC)
3123 #define __FMODE_NONOTIFY        ((__force int) FMODE_NONOTIFY)
3124
3125 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3126 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3127                                             (flag & __FMODE_NONOTIFY)))
3128
3129 static inline bool is_sxid(umode_t mode)
3130 {
3131         return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3132 }
3133
3134 static inline int check_sticky(struct inode *dir, struct inode *inode)
3135 {
3136         if (!(dir->i_mode & S_ISVTX))
3137                 return 0;
3138
3139         return __check_sticky(dir, inode);
3140 }
3141
3142 static inline void inode_has_no_xattr(struct inode *inode)
3143 {
3144         if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
3145                 inode->i_flags |= S_NOSEC;
3146 }
3147
3148 static inline bool is_root_inode(struct inode *inode)
3149 {
3150         return inode == inode->i_sb->s_root->d_inode;
3151 }
3152
3153 static inline bool dir_emit(struct dir_context *ctx,
3154                             const char *name, int namelen,
3155                             u64 ino, unsigned type)
3156 {
3157         return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3158 }
3159 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3160 {
3161         return ctx->actor(ctx, ".", 1, ctx->pos,
3162                           file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3163 }
3164 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3165 {
3166         return ctx->actor(ctx, "..", 2, ctx->pos,
3167                           parent_ino(file->f_path.dentry), DT_DIR) == 0;
3168 }
3169 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3170 {
3171         if (ctx->pos == 0) {
3172                 if (!dir_emit_dot(file, ctx))
3173                         return false;
3174                 ctx->pos = 1;
3175         }
3176         if (ctx->pos == 1) {
3177                 if (!dir_emit_dotdot(file, ctx))
3178                         return false;
3179                 ctx->pos = 2;
3180         }
3181         return true;
3182 }
3183 static inline bool dir_relax(struct inode *inode)
3184 {
3185         inode_unlock(inode);
3186         inode_lock(inode);
3187         return !IS_DEADDIR(inode);
3188 }
3189
3190 static inline bool dir_relax_shared(struct inode *inode)
3191 {
3192         inode_unlock_shared(inode);
3193         inode_lock_shared(inode);
3194         return !IS_DEADDIR(inode);
3195 }
3196
3197 extern bool path_noexec(const struct path *path);
3198 extern void inode_nohighmem(struct inode *inode);
3199
3200 #endif /* _LINUX_FS_H */