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