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