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