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