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