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