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