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