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