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