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