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