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