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