c1884e974ff4bfd65e6d56df46c5736a3944fdc4
[linux-2.6.git] / include / linux / fs.h
1 #ifndef _LINUX_FS_H
2 #define _LINUX_FS_H
3
4 /*
5  * This file has definitions for some important file table
6  * structures etc.
7  */
8
9 #include <linux/limits.h>
10 #include <linux/ioctl.h>
11 #include <linux/blk_types.h>
12 #include <linux/types.h>
13
14 /*
15  * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
16  * the file limit at runtime and only root can increase the per-process
17  * nr_file rlimit, so it's safe to set up a ridiculously high absolute
18  * upper limit on files-per-process.
19  *
20  * Some programs (notably those using select()) may have to be 
21  * recompiled to take full advantage of the new limits..  
22  */
23
24 /* Fixed constants first: */
25 #undef NR_OPEN
26 #define INR_OPEN_CUR 1024       /* Initial setting for nfile rlimits */
27 #define INR_OPEN_MAX 4096       /* Hard limit for nfile rlimits */
28
29 #define BLOCK_SIZE_BITS 10
30 #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
31
32 #define SEEK_SET        0       /* seek relative to beginning of file */
33 #define SEEK_CUR        1       /* seek relative to current file position */
34 #define SEEK_END        2       /* seek relative to end of file */
35 #define SEEK_DATA       3       /* seek to the next data */
36 #define SEEK_HOLE       4       /* seek to the next hole */
37 #define SEEK_MAX        SEEK_HOLE
38
39 struct fstrim_range {
40         __u64 start;
41         __u64 len;
42         __u64 minlen;
43 };
44
45 /* And dynamically-tunable limits and defaults: */
46 struct files_stat_struct {
47         unsigned long nr_files;         /* read only */
48         unsigned long nr_free_files;    /* read only */
49         unsigned long max_files;                /* tunable */
50 };
51
52 struct inodes_stat_t {
53         int nr_inodes;
54         int nr_unused;
55         int dummy[5];           /* padding for sysctl ABI compatibility */
56 };
57
58
59 #define NR_FILE  8192   /* this can well be larger on a larger system */
60
61 #define MAY_EXEC                0x00000001
62 #define MAY_WRITE               0x00000002
63 #define MAY_READ                0x00000004
64 #define MAY_APPEND              0x00000008
65 #define MAY_ACCESS              0x00000010
66 #define MAY_OPEN                0x00000020
67 #define MAY_CHDIR               0x00000040
68 /* called from RCU mode, don't block */
69 #define MAY_NOT_BLOCK           0x00000080
70
71 /*
72  * flags in file.f_mode.  Note that FMODE_READ and FMODE_WRITE must correspond
73  * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
74  */
75
76 /* file is open for reading */
77 #define FMODE_READ              ((__force fmode_t)0x1)
78 /* file is open for writing */
79 #define FMODE_WRITE             ((__force fmode_t)0x2)
80 /* file is seekable */
81 #define FMODE_LSEEK             ((__force fmode_t)0x4)
82 /* file can be accessed using pread */
83 #define FMODE_PREAD             ((__force fmode_t)0x8)
84 /* file can be accessed using pwrite */
85 #define FMODE_PWRITE            ((__force fmode_t)0x10)
86 /* File is opened for execution with sys_execve / sys_uselib */
87 #define FMODE_EXEC              ((__force fmode_t)0x20)
88 /* File is opened with O_NDELAY (only set for block devices) */
89 #define FMODE_NDELAY            ((__force fmode_t)0x40)
90 /* File is opened with O_EXCL (only set for block devices) */
91 #define FMODE_EXCL              ((__force fmode_t)0x80)
92 /* File is opened using open(.., 3, ..) and is writeable only for ioctls
93    (specialy hack for floppy.c) */
94 #define FMODE_WRITE_IOCTL       ((__force fmode_t)0x100)
95
96 /*
97  * Don't update ctime and mtime.
98  *
99  * Currently a special hack for the XFS open_by_handle ioctl, but we'll
100  * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
101  */
102 #define FMODE_NOCMTIME          ((__force fmode_t)0x800)
103
104 /* Expect random access pattern */
105 #define FMODE_RANDOM            ((__force fmode_t)0x1000)
106
107 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
108 #define FMODE_UNSIGNED_OFFSET   ((__force fmode_t)0x2000)
109
110 /* File is opened with O_PATH; almost nothing can be done with it */
111 #define FMODE_PATH              ((__force fmode_t)0x4000)
112
113 /* File was opened by fanotify and shouldn't generate fanotify events */
114 #define FMODE_NONOTIFY          ((__force fmode_t)0x1000000)
115
116 /*
117  * The below are the various read and write types that we support. Some of
118  * them include behavioral modifiers that send information down to the
119  * block layer and IO scheduler. Terminology:
120  *
121  *      The block layer uses device plugging to defer IO a little bit, in
122  *      the hope that we will see more IO very shortly. This increases
123  *      coalescing of adjacent IO and thus reduces the number of IOs we
124  *      have to send to the device. It also allows for better queuing,
125  *      if the IO isn't mergeable. If the caller is going to be waiting
126  *      for the IO, then he must ensure that the device is unplugged so
127  *      that the IO is dispatched to the driver.
128  *
129  *      All IO is handled async in Linux. This is fine for background
130  *      writes, but for reads or writes that someone waits for completion
131  *      on, we want to notify the block layer and IO scheduler so that they
132  *      know about it. That allows them to make better scheduling
133  *      decisions. So when the below references 'sync' and 'async', it
134  *      is referencing this priority hint.
135  *
136  * With that in mind, the available types are:
137  *
138  * READ                 A normal read operation. Device will be plugged.
139  * READ_SYNC            A synchronous read. Device is not plugged, caller can
140  *                      immediately wait on this read without caring about
141  *                      unplugging.
142  * READA                Used for read-ahead operations. Lower priority, and the
143  *                      block layer could (in theory) choose to ignore this
144  *                      request if it runs into resource problems.
145  * WRITE                A normal async write. Device will be plugged.
146  * WRITE_SYNC           Synchronous write. Identical to WRITE, but passes down
147  *                      the hint that someone will be waiting on this IO
148  *                      shortly. The write equivalent of READ_SYNC.
149  * WRITE_ODIRECT        Special case write for O_DIRECT only.
150  * WRITE_FLUSH          Like WRITE_SYNC but with preceding cache flush.
151  * WRITE_FUA            Like WRITE_SYNC but data is guaranteed to be on
152  *                      non-volatile media on completion.
153  * WRITE_FLUSH_FUA      Combination of WRITE_FLUSH and FUA. The IO is preceded
154  *                      by a cache flush and data is guaranteed to be on
155  *                      non-volatile media on completion.
156  *
157  */
158 #define RW_MASK                 REQ_WRITE
159 #define RWA_MASK                REQ_RAHEAD
160
161 #define READ                    0
162 #define WRITE                   RW_MASK
163 #define READA                   RWA_MASK
164
165 #define READ_SYNC               (READ | REQ_SYNC)
166 #define WRITE_SYNC              (WRITE | REQ_SYNC | REQ_NOIDLE)
167 #define WRITE_ODIRECT           (WRITE | REQ_SYNC)
168 #define WRITE_FLUSH             (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FLUSH)
169 #define WRITE_FUA               (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FUA)
170 #define WRITE_FLUSH_FUA         (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FLUSH | REQ_FUA)
171
172 #define SEL_IN          1
173 #define SEL_OUT         2
174 #define SEL_EX          4
175
176 /* public flags for file_system_type */
177 #define FS_REQUIRES_DEV 1 
178 #define FS_BINARY_MOUNTDATA 2
179 #define FS_HAS_SUBTYPE 4
180 #define FS_REVAL_DOT    16384   /* Check the paths ".", ".." for staleness */
181 #define FS_RENAME_DOES_D_MOVE   32768   /* FS will handle d_move()
182                                          * during rename() internally.
183                                          */
184
185 /*
186  * These are the fs-independent mount-flags: up to 32 flags are supported
187  */
188 #define MS_RDONLY        1      /* Mount read-only */
189 #define MS_NOSUID        2      /* Ignore suid and sgid bits */
190 #define MS_NODEV         4      /* Disallow access to device special files */
191 #define MS_NOEXEC        8      /* Disallow program execution */
192 #define MS_SYNCHRONOUS  16      /* Writes are synced at once */
193 #define MS_REMOUNT      32      /* Alter flags of a mounted FS */
194 #define MS_MANDLOCK     64      /* Allow mandatory locks on an FS */
195 #define MS_DIRSYNC      128     /* Directory modifications are synchronous */
196 #define MS_NOATIME      1024    /* Do not update access times. */
197 #define MS_NODIRATIME   2048    /* Do not update directory access times */
198 #define MS_BIND         4096
199 #define MS_MOVE         8192
200 #define MS_REC          16384
201 #define MS_VERBOSE      32768   /* War is peace. Verbosity is silence.
202                                    MS_VERBOSE is deprecated. */
203 #define MS_SILENT       32768
204 #define MS_POSIXACL     (1<<16) /* VFS does not apply the umask */
205 #define MS_UNBINDABLE   (1<<17) /* change to unbindable */
206 #define MS_PRIVATE      (1<<18) /* change to private */
207 #define MS_SLAVE        (1<<19) /* change to slave */
208 #define MS_SHARED       (1<<20) /* change to shared */
209 #define MS_RELATIME     (1<<21) /* Update atime relative to mtime/ctime. */
210 #define MS_KERNMOUNT    (1<<22) /* this is a kern_mount call */
211 #define MS_I_VERSION    (1<<23) /* Update inode I_version field */
212 #define MS_STRICTATIME  (1<<24) /* Always perform atime updates */
213 #define MS_NOSEC        (1<<28)
214 #define MS_BORN         (1<<29)
215 #define MS_ACTIVE       (1<<30)
216 #define MS_NOUSER       (1<<31)
217
218 /*
219  * Superblock flags that can be altered by MS_REMOUNT
220  */
221 #define MS_RMT_MASK     (MS_RDONLY|MS_SYNCHRONOUS|MS_MANDLOCK|MS_I_VERSION)
222
223 /*
224  * Old magic mount flag and mask
225  */
226 #define MS_MGC_VAL 0xC0ED0000
227 #define MS_MGC_MSK 0xffff0000
228
229 /* Inode flags - they have nothing to superblock flags now */
230
231 #define S_SYNC          1       /* Writes are synced at once */
232 #define S_NOATIME       2       /* Do not update access times */
233 #define S_APPEND        4       /* Append-only file */
234 #define S_IMMUTABLE     8       /* Immutable file */
235 #define S_DEAD          16      /* removed, but still open directory */
236 #define S_NOQUOTA       32      /* Inode is not counted to quota */
237 #define S_DIRSYNC       64      /* Directory modifications are synchronous */
238 #define S_NOCMTIME      128     /* Do not update file c/mtime */
239 #define S_SWAPFILE      256     /* Do not truncate: swapon got its bmaps */
240 #define S_PRIVATE       512     /* Inode is fs-internal */
241 #define S_IMA           1024    /* Inode has an associated IMA struct */
242 #define S_AUTOMOUNT     2048    /* Automount/referral quasi-directory */
243 #define S_NOSEC         4096    /* no suid or xattr security attributes */
244
245 /*
246  * Note that nosuid etc flags are inode-specific: setting some file-system
247  * flags just means all the inodes inherit those flags by default. It might be
248  * possible to override it selectively if you really wanted to with some
249  * ioctl() that is not currently implemented.
250  *
251  * Exception: MS_RDONLY is always applied to the entire file system.
252  *
253  * Unfortunately, it is possible to change a filesystems flags with it mounted
254  * with files in use.  This means that all of the inodes will not have their
255  * i_flags updated.  Hence, i_flags no longer inherit the superblock mount
256  * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
257  */
258 #define __IS_FLG(inode,flg) ((inode)->i_sb->s_flags & (flg))
259
260 #define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
261 #define IS_SYNC(inode)          (__IS_FLG(inode, MS_SYNCHRONOUS) || \
262                                         ((inode)->i_flags & S_SYNC))
263 #define IS_DIRSYNC(inode)       (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
264                                         ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
265 #define IS_MANDLOCK(inode)      __IS_FLG(inode, MS_MANDLOCK)
266 #define IS_NOATIME(inode)   __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
267 #define IS_I_VERSION(inode)   __IS_FLG(inode, MS_I_VERSION)
268
269 #define IS_NOQUOTA(inode)       ((inode)->i_flags & S_NOQUOTA)
270 #define IS_APPEND(inode)        ((inode)->i_flags & S_APPEND)
271 #define IS_IMMUTABLE(inode)     ((inode)->i_flags & S_IMMUTABLE)
272 #define IS_POSIXACL(inode)      __IS_FLG(inode, MS_POSIXACL)
273
274 #define IS_DEADDIR(inode)       ((inode)->i_flags & S_DEAD)
275 #define IS_NOCMTIME(inode)      ((inode)->i_flags & S_NOCMTIME)
276 #define IS_SWAPFILE(inode)      ((inode)->i_flags & S_SWAPFILE)
277 #define IS_PRIVATE(inode)       ((inode)->i_flags & S_PRIVATE)
278 #define IS_IMA(inode)           ((inode)->i_flags & S_IMA)
279 #define IS_AUTOMOUNT(inode)     ((inode)->i_flags & S_AUTOMOUNT)
280 #define IS_NOSEC(inode)         ((inode)->i_flags & S_NOSEC)
281
282 /* the read-only stuff doesn't really belong here, but any other place is
283    probably as bad and I don't want to create yet another include file. */
284
285 #define BLKROSET   _IO(0x12,93) /* set device read-only (0 = read-write) */
286 #define BLKROGET   _IO(0x12,94) /* get read-only status (0 = read_write) */
287 #define BLKRRPART  _IO(0x12,95) /* re-read partition table */
288 #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
289 #define BLKFLSBUF  _IO(0x12,97) /* flush buffer cache */
290 #define BLKRASET   _IO(0x12,98) /* set read ahead for block device */
291 #define BLKRAGET   _IO(0x12,99) /* get current read ahead setting */
292 #define BLKFRASET  _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
293 #define BLKFRAGET  _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
294 #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
295 #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
296 #define BLKSSZGET  _IO(0x12,104)/* get block device sector size */
297 #if 0
298 #define BLKPG      _IO(0x12,105)/* See blkpg.h */
299
300 /* Some people are morons.  Do not use sizeof! */
301
302 #define BLKELVGET  _IOR(0x12,106,size_t)/* elevator get */
303 #define BLKELVSET  _IOW(0x12,107,size_t)/* elevator set */
304 /* This was here just to show that the number is taken -
305    probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
306 #endif
307 /* A jump here: 108-111 have been used for various private purposes. */
308 #define BLKBSZGET  _IOR(0x12,112,size_t)
309 #define BLKBSZSET  _IOW(0x12,113,size_t)
310 #define BLKGETSIZE64 _IOR(0x12,114,size_t)      /* return device size in bytes (u64 *arg) */
311 #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
312 #define BLKTRACESTART _IO(0x12,116)
313 #define BLKTRACESTOP _IO(0x12,117)
314 #define BLKTRACETEARDOWN _IO(0x12,118)
315 #define BLKDISCARD _IO(0x12,119)
316 #define BLKIOMIN _IO(0x12,120)
317 #define BLKIOOPT _IO(0x12,121)
318 #define BLKALIGNOFF _IO(0x12,122)
319 #define BLKPBSZGET _IO(0x12,123)
320 #define BLKDISCARDZEROES _IO(0x12,124)
321 #define BLKSECDISCARD _IO(0x12,125)
322
323 #define BMAP_IOCTL 1            /* obsolete - kept for compatibility */
324 #define FIBMAP     _IO(0x00,1)  /* bmap access */
325 #define FIGETBSZ   _IO(0x00,2)  /* get the block size used for bmap */
326 #define FIFREEZE        _IOWR('X', 119, int)    /* Freeze */
327 #define FITHAW          _IOWR('X', 120, int)    /* Thaw */
328 #define FITRIM          _IOWR('X', 121, struct fstrim_range)    /* Trim */
329
330 #define FS_IOC_GETFLAGS                 _IOR('f', 1, long)
331 #define FS_IOC_SETFLAGS                 _IOW('f', 2, long)
332 #define FS_IOC_GETVERSION               _IOR('v', 1, long)
333 #define FS_IOC_SETVERSION               _IOW('v', 2, long)
334 #define FS_IOC_FIEMAP                   _IOWR('f', 11, struct fiemap)
335 #define FS_IOC32_GETFLAGS               _IOR('f', 1, int)
336 #define FS_IOC32_SETFLAGS               _IOW('f', 2, int)
337 #define FS_IOC32_GETVERSION             _IOR('v', 1, int)
338 #define FS_IOC32_SETVERSION             _IOW('v', 2, int)
339
340 /*
341  * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
342  */
343 #define FS_SECRM_FL                     0x00000001 /* Secure deletion */
344 #define FS_UNRM_FL                      0x00000002 /* Undelete */
345 #define FS_COMPR_FL                     0x00000004 /* Compress file */
346 #define FS_SYNC_FL                      0x00000008 /* Synchronous updates */
347 #define FS_IMMUTABLE_FL                 0x00000010 /* Immutable file */
348 #define FS_APPEND_FL                    0x00000020 /* writes to file may only append */
349 #define FS_NODUMP_FL                    0x00000040 /* do not dump file */
350 #define FS_NOATIME_FL                   0x00000080 /* do not update atime */
351 /* Reserved for compression usage... */
352 #define FS_DIRTY_FL                     0x00000100
353 #define FS_COMPRBLK_FL                  0x00000200 /* One or more compressed clusters */
354 #define FS_NOCOMP_FL                    0x00000400 /* Don't compress */
355 #define FS_ECOMPR_FL                    0x00000800 /* Compression error */
356 /* End compression flags --- maybe not all used */
357 #define FS_BTREE_FL                     0x00001000 /* btree format dir */
358 #define FS_INDEX_FL                     0x00001000 /* hash-indexed directory */
359 #define FS_IMAGIC_FL                    0x00002000 /* AFS directory */
360 #define FS_JOURNAL_DATA_FL              0x00004000 /* Reserved for ext3 */
361 #define FS_NOTAIL_FL                    0x00008000 /* file tail should not be merged */
362 #define FS_DIRSYNC_FL                   0x00010000 /* dirsync behaviour (directories only) */
363 #define FS_TOPDIR_FL                    0x00020000 /* Top of directory hierarchies*/
364 #define FS_EXTENT_FL                    0x00080000 /* Extents */
365 #define FS_DIRECTIO_FL                  0x00100000 /* Use direct i/o */
366 #define FS_NOCOW_FL                     0x00800000 /* Do not cow file */
367 #define FS_RESERVED_FL                  0x80000000 /* reserved for ext2 lib */
368
369 #define FS_FL_USER_VISIBLE              0x0003DFFF /* User visible flags */
370 #define FS_FL_USER_MODIFIABLE           0x000380FF /* User modifiable flags */
371
372
373 #define SYNC_FILE_RANGE_WAIT_BEFORE     1
374 #define SYNC_FILE_RANGE_WRITE           2
375 #define SYNC_FILE_RANGE_WAIT_AFTER      4
376
377 #ifdef __KERNEL__
378
379 #include <linux/linkage.h>
380 #include <linux/wait.h>
381 #include <linux/kdev_t.h>
382 #include <linux/dcache.h>
383 #include <linux/path.h>
384 #include <linux/stat.h>
385 #include <linux/cache.h>
386 #include <linux/list.h>
387 #include <linux/radix-tree.h>
388 #include <linux/prio_tree.h>
389 #include <linux/init.h>
390 #include <linux/pid.h>
391 #include <linux/mutex.h>
392 #include <linux/capability.h>
393 #include <linux/semaphore.h>
394 #include <linux/fiemap.h>
395 #include <linux/rculist_bl.h>
396 #include <linux/shrinker.h>
397 #include <linux/atomic.h>
398
399 #include <asm/byteorder.h>
400
401 struct export_operations;
402 struct hd_geometry;
403 struct iovec;
404 struct nameidata;
405 struct kiocb;
406 struct kobject;
407 struct pipe_inode_info;
408 struct poll_table_struct;
409 struct kstatfs;
410 struct vm_area_struct;
411 struct vfsmount;
412 struct cred;
413
414 extern void __init inode_init(void);
415 extern void __init inode_init_early(void);
416 extern void __init files_init(unsigned long);
417
418 extern struct files_stat_struct files_stat;
419 extern unsigned long get_max_files(void);
420 extern int sysctl_nr_open;
421 extern struct inodes_stat_t inodes_stat;
422 extern int leases_enable, lease_break_time;
423
424 struct buffer_head;
425 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
426                         struct buffer_head *bh_result, int create);
427 typedef void (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
428                         ssize_t bytes, void *private, int ret,
429                         bool is_async);
430
431 /*
432  * Attribute flags.  These should be or-ed together to figure out what
433  * has been changed!
434  */
435 #define ATTR_MODE       (1 << 0)
436 #define ATTR_UID        (1 << 1)
437 #define ATTR_GID        (1 << 2)
438 #define ATTR_SIZE       (1 << 3)
439 #define ATTR_ATIME      (1 << 4)
440 #define ATTR_MTIME      (1 << 5)
441 #define ATTR_CTIME      (1 << 6)
442 #define ATTR_ATIME_SET  (1 << 7)
443 #define ATTR_MTIME_SET  (1 << 8)
444 #define ATTR_FORCE      (1 << 9) /* Not a change, but a change it */
445 #define ATTR_ATTR_FLAG  (1 << 10)
446 #define ATTR_KILL_SUID  (1 << 11)
447 #define ATTR_KILL_SGID  (1 << 12)
448 #define ATTR_FILE       (1 << 13)
449 #define ATTR_KILL_PRIV  (1 << 14)
450 #define ATTR_OPEN       (1 << 15) /* Truncating from open(O_TRUNC) */
451 #define ATTR_TIMES_SET  (1 << 16)
452
453 /*
454  * This is the Inode Attributes structure, used for notify_change().  It
455  * uses the above definitions as flags, to know which values have changed.
456  * Also, in this manner, a Filesystem can look at only the values it cares
457  * about.  Basically, these are the attributes that the VFS layer can
458  * request to change from the FS layer.
459  *
460  * Derek Atkins <warlord@MIT.EDU> 94-10-20
461  */
462 struct iattr {
463         unsigned int    ia_valid;
464         umode_t         ia_mode;
465         uid_t           ia_uid;
466         gid_t           ia_gid;
467         loff_t          ia_size;
468         struct timespec ia_atime;
469         struct timespec ia_mtime;
470         struct timespec ia_ctime;
471
472         /*
473          * Not an attribute, but an auxiliary info for filesystems wanting to
474          * implement an ftruncate() like method.  NOTE: filesystem should
475          * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
476          */
477         struct file     *ia_file;
478 };
479
480 /*
481  * Includes for diskquotas.
482  */
483 #include <linux/quota.h>
484
485 /** 
486  * enum positive_aop_returns - aop return codes with specific semantics
487  *
488  * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
489  *                          completed, that the page is still locked, and
490  *                          should be considered active.  The VM uses this hint
491  *                          to return the page to the active list -- it won't
492  *                          be a candidate for writeback again in the near
493  *                          future.  Other callers must be careful to unlock
494  *                          the page if they get this return.  Returned by
495  *                          writepage(); 
496  *
497  * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
498  *                      unlocked it and the page might have been truncated.
499  *                      The caller should back up to acquiring a new page and
500  *                      trying again.  The aop will be taking reasonable
501  *                      precautions not to livelock.  If the caller held a page
502  *                      reference, it should drop it before retrying.  Returned
503  *                      by readpage().
504  *
505  * address_space_operation functions return these large constants to indicate
506  * special semantics to the caller.  These are much larger than the bytes in a
507  * page to allow for functions that return the number of bytes operated on in a
508  * given page.
509  */
510
511 enum positive_aop_returns {
512         AOP_WRITEPAGE_ACTIVATE  = 0x80000,
513         AOP_TRUNCATED_PAGE      = 0x80001,
514 };
515
516 #define AOP_FLAG_UNINTERRUPTIBLE        0x0001 /* will not do a short write */
517 #define AOP_FLAG_CONT_EXPAND            0x0002 /* called from cont_expand */
518 #define AOP_FLAG_NOFS                   0x0004 /* used by filesystem to direct
519                                                 * helper code (eg buffer layer)
520                                                 * to clear GFP_FS from alloc */
521
522 /*
523  * oh the beauties of C type declarations.
524  */
525 struct page;
526 struct address_space;
527 struct writeback_control;
528
529 struct iov_iter {
530         const struct iovec *iov;
531         unsigned long nr_segs;
532         size_t iov_offset;
533         size_t count;
534 };
535
536 size_t iov_iter_copy_from_user_atomic(struct page *page,
537                 struct iov_iter *i, unsigned long offset, size_t bytes);
538 size_t iov_iter_copy_from_user(struct page *page,
539                 struct iov_iter *i, unsigned long offset, size_t bytes);
540 void iov_iter_advance(struct iov_iter *i, size_t bytes);
541 int iov_iter_fault_in_readable(struct iov_iter *i, size_t bytes);
542 size_t iov_iter_single_seg_count(struct iov_iter *i);
543
544 static inline void iov_iter_init(struct iov_iter *i,
545                         const struct iovec *iov, unsigned long nr_segs,
546                         size_t count, size_t written)
547 {
548         i->iov = iov;
549         i->nr_segs = nr_segs;
550         i->iov_offset = 0;
551         i->count = count + written;
552
553         iov_iter_advance(i, written);
554 }
555
556 static inline size_t iov_iter_count(struct iov_iter *i)
557 {
558         return i->count;
559 }
560
561 /*
562  * "descriptor" for what we're up to with a read.
563  * This allows us to use the same read code yet
564  * have multiple different users of the data that
565  * we read from a file.
566  *
567  * The simplest case just copies the data to user
568  * mode.
569  */
570 typedef struct {
571         size_t written;
572         size_t count;
573         union {
574                 char __user *buf;
575                 void *data;
576         } arg;
577         int error;
578 } read_descriptor_t;
579
580 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
581                 unsigned long, unsigned long);
582
583 struct address_space_operations {
584         int (*writepage)(struct page *page, struct writeback_control *wbc);
585         int (*readpage)(struct file *, struct page *);
586
587         /* Write back some dirty pages from this mapping. */
588         int (*writepages)(struct address_space *, struct writeback_control *);
589
590         /* Set a page dirty.  Return true if this dirtied it */
591         int (*set_page_dirty)(struct page *page);
592
593         int (*readpages)(struct file *filp, struct address_space *mapping,
594                         struct list_head *pages, unsigned nr_pages);
595
596         int (*write_begin)(struct file *, struct address_space *mapping,
597                                 loff_t pos, unsigned len, unsigned flags,
598                                 struct page **pagep, void **fsdata);
599         int (*write_end)(struct file *, struct address_space *mapping,
600                                 loff_t pos, unsigned len, unsigned copied,
601                                 struct page *page, void *fsdata);
602
603         /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
604         sector_t (*bmap)(struct address_space *, sector_t);
605         void (*invalidatepage) (struct page *, unsigned long);
606         int (*releasepage) (struct page *, gfp_t);
607         void (*freepage)(struct page *);
608         ssize_t (*direct_IO)(int, struct kiocb *, const struct iovec *iov,
609                         loff_t offset, unsigned long nr_segs);
610         int (*get_xip_mem)(struct address_space *, pgoff_t, int,
611                                                 void **, unsigned long *);
612         /* migrate the contents of a page to the specified target */
613         int (*migratepage) (struct address_space *,
614                         struct page *, struct page *);
615         int (*launder_page) (struct page *);
616         int (*is_partially_uptodate) (struct page *, read_descriptor_t *,
617                                         unsigned long);
618         int (*error_remove_page)(struct address_space *, struct page *);
619 };
620
621 extern const struct address_space_operations empty_aops;
622
623 /*
624  * pagecache_write_begin/pagecache_write_end must be used by general code
625  * to write into the pagecache.
626  */
627 int pagecache_write_begin(struct file *, struct address_space *mapping,
628                                 loff_t pos, unsigned len, unsigned flags,
629                                 struct page **pagep, void **fsdata);
630
631 int pagecache_write_end(struct file *, struct address_space *mapping,
632                                 loff_t pos, unsigned len, unsigned copied,
633                                 struct page *page, void *fsdata);
634
635 struct backing_dev_info;
636 struct address_space {
637         struct inode            *host;          /* owner: inode, block_device */
638         struct radix_tree_root  page_tree;      /* radix tree of all pages */
639         spinlock_t              tree_lock;      /* and lock protecting it */
640         unsigned int            i_mmap_writable;/* count VM_SHARED mappings */
641         struct prio_tree_root   i_mmap;         /* tree of private and shared mappings */
642         struct list_head        i_mmap_nonlinear;/*list VM_NONLINEAR mappings */
643         struct mutex            i_mmap_mutex;   /* protect tree, count, list */
644         /* Protected by tree_lock together with the radix tree */
645         unsigned long           nrpages;        /* number of total pages */
646         pgoff_t                 writeback_index;/* writeback starts here */
647         const struct address_space_operations *a_ops;   /* methods */
648         unsigned long           flags;          /* error bits/gfp mask */
649         struct backing_dev_info *backing_dev_info; /* device readahead, etc */
650         spinlock_t              private_lock;   /* for use by the address_space */
651         struct list_head        private_list;   /* ditto */
652         struct address_space    *assoc_mapping; /* ditto */
653 } __attribute__((aligned(sizeof(long))));
654         /*
655          * On most architectures that alignment is already the case; but
656          * must be enforced here for CRIS, to let the least significant bit
657          * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
658          */
659
660 struct block_device {
661         dev_t                   bd_dev;  /* not a kdev_t - it's a search key */
662         int                     bd_openers;
663         struct inode *          bd_inode;       /* will die */
664         struct super_block *    bd_super;
665         struct mutex            bd_mutex;       /* open/close mutex */
666         struct list_head        bd_inodes;
667         void *                  bd_claiming;
668         void *                  bd_holder;
669         int                     bd_holders;
670         bool                    bd_write_holder;
671 #ifdef CONFIG_SYSFS
672         struct list_head        bd_holder_disks;
673 #endif
674         struct block_device *   bd_contains;
675         unsigned                bd_block_size;
676         struct hd_struct *      bd_part;
677         /* number of times partitions within this device have been opened. */
678         unsigned                bd_part_count;
679         int                     bd_invalidated;
680         struct gendisk *        bd_disk;
681         struct list_head        bd_list;
682         /*
683          * Private data.  You must have bd_claim'ed the block_device
684          * to use this.  NOTE:  bd_claim allows an owner to claim
685          * the same device multiple times, the owner must take special
686          * care to not mess up bd_private for that case.
687          */
688         unsigned long           bd_private;
689
690         /* The counter of freeze processes */
691         int                     bd_fsfreeze_count;
692         /* Mutex for freeze */
693         struct mutex            bd_fsfreeze_mutex;
694 };
695
696 /*
697  * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
698  * radix trees
699  */
700 #define PAGECACHE_TAG_DIRTY     0
701 #define PAGECACHE_TAG_WRITEBACK 1
702 #define PAGECACHE_TAG_TOWRITE   2
703
704 int mapping_tagged(struct address_space *mapping, int tag);
705
706 /*
707  * Might pages of this file be mapped into userspace?
708  */
709 static inline int mapping_mapped(struct address_space *mapping)
710 {
711         return  !prio_tree_empty(&mapping->i_mmap) ||
712                 !list_empty(&mapping->i_mmap_nonlinear);
713 }
714
715 /*
716  * Might pages of this file have been modified in userspace?
717  * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
718  * marks vma as VM_SHARED if it is shared, and the file was opened for
719  * writing i.e. vma may be mprotected writable even if now readonly.
720  */
721 static inline int mapping_writably_mapped(struct address_space *mapping)
722 {
723         return mapping->i_mmap_writable != 0;
724 }
725
726 /*
727  * Use sequence counter to get consistent i_size on 32-bit processors.
728  */
729 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
730 #include <linux/seqlock.h>
731 #define __NEED_I_SIZE_ORDERED
732 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
733 #else
734 #define i_size_ordered_init(inode) do { } while (0)
735 #endif
736
737 struct posix_acl;
738 #define ACL_NOT_CACHED ((void *)(-1))
739
740 #define IOP_FASTPERM    0x0001
741 #define IOP_LOOKUP      0x0002
742 #define IOP_NOFOLLOW    0x0004
743
744 /*
745  * Keep mostly read-only and often accessed (especially for
746  * the RCU path lookup and 'stat' data) fields at the beginning
747  * of the 'struct inode'
748  */
749 struct inode {
750         umode_t                 i_mode;
751         unsigned short          i_opflags;
752         uid_t                   i_uid;
753         gid_t                   i_gid;
754         unsigned int            i_flags;
755
756 #ifdef CONFIG_FS_POSIX_ACL
757         struct posix_acl        *i_acl;
758         struct posix_acl        *i_default_acl;
759 #endif
760
761         const struct inode_operations   *i_op;
762         struct super_block      *i_sb;
763         struct address_space    *i_mapping;
764
765 #ifdef CONFIG_SECURITY
766         void                    *i_security;
767 #endif
768
769         /* Stat data, not accessed from path walking */
770         unsigned long           i_ino;
771         unsigned int            i_nlink;
772         dev_t                   i_rdev;
773         loff_t                  i_size;
774         struct timespec         i_atime;
775         struct timespec         i_mtime;
776         struct timespec         i_ctime;
777         unsigned int            i_blkbits;
778         blkcnt_t                i_blocks;
779
780 #ifdef __NEED_I_SIZE_ORDERED
781         seqcount_t              i_size_seqcount;
782 #endif
783
784         /* Misc */
785         unsigned long           i_state;
786         spinlock_t              i_lock; /* i_blocks, i_bytes, maybe i_size */
787         struct mutex            i_mutex;
788
789         unsigned long           dirtied_when;   /* jiffies of first dirtying */
790
791         struct hlist_node       i_hash;
792         struct list_head        i_wb_list;      /* backing dev IO list */
793         struct list_head        i_lru;          /* inode LRU list */
794         struct list_head        i_sb_list;
795         union {
796                 struct list_head        i_dentry;
797                 struct rcu_head         i_rcu;
798         };
799         atomic_t                i_count;
800         u64                     i_version;
801         unsigned short          i_bytes;
802         atomic_t                i_dio_count;
803         const struct file_operations    *i_fop; /* former ->i_op->default_file_ops */
804         struct file_lock        *i_flock;
805         struct address_space    i_data;
806 #ifdef CONFIG_QUOTA
807         struct dquot            *i_dquot[MAXQUOTAS];
808 #endif
809         struct list_head        i_devices;
810         union {
811                 struct pipe_inode_info  *i_pipe;
812                 struct block_device     *i_bdev;
813                 struct cdev             *i_cdev;
814         };
815
816         __u32                   i_generation;
817
818 #ifdef CONFIG_FSNOTIFY
819         __u32                   i_fsnotify_mask; /* all events this inode cares about */
820         struct hlist_head       i_fsnotify_marks;
821 #endif
822
823 #ifdef CONFIG_IMA
824         atomic_t                i_readcount; /* struct files open RO */
825 #endif
826         atomic_t                i_writecount;
827         void                    *i_private; /* fs or device private pointer */
828 };
829
830 static inline int inode_unhashed(struct inode *inode)
831 {
832         return hlist_unhashed(&inode->i_hash);
833 }
834
835 /*
836  * inode->i_mutex nesting subclasses for the lock validator:
837  *
838  * 0: the object of the current VFS operation
839  * 1: parent
840  * 2: child/target
841  * 3: quota file
842  *
843  * The locking order between these classes is
844  * parent -> child -> normal -> xattr -> quota
845  */
846 enum inode_i_mutex_lock_class
847 {
848         I_MUTEX_NORMAL,
849         I_MUTEX_PARENT,
850         I_MUTEX_CHILD,
851         I_MUTEX_XATTR,
852         I_MUTEX_QUOTA
853 };
854
855 /*
856  * NOTE: in a 32bit arch with a preemptable kernel and
857  * an UP compile the i_size_read/write must be atomic
858  * with respect to the local cpu (unlike with preempt disabled),
859  * but they don't need to be atomic with respect to other cpus like in
860  * true SMP (so they need either to either locally disable irq around
861  * the read or for example on x86 they can be still implemented as a
862  * cmpxchg8b without the need of the lock prefix). For SMP compiles
863  * and 64bit archs it makes no difference if preempt is enabled or not.
864  */
865 static inline loff_t i_size_read(const struct inode *inode)
866 {
867 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
868         loff_t i_size;
869         unsigned int seq;
870
871         do {
872                 seq = read_seqcount_begin(&inode->i_size_seqcount);
873                 i_size = inode->i_size;
874         } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
875         return i_size;
876 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
877         loff_t i_size;
878
879         preempt_disable();
880         i_size = inode->i_size;
881         preempt_enable();
882         return i_size;
883 #else
884         return inode->i_size;
885 #endif
886 }
887
888 /*
889  * NOTE: unlike i_size_read(), i_size_write() does need locking around it
890  * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
891  * can be lost, resulting in subsequent i_size_read() calls spinning forever.
892  */
893 static inline void i_size_write(struct inode *inode, loff_t i_size)
894 {
895 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
896         write_seqcount_begin(&inode->i_size_seqcount);
897         inode->i_size = i_size;
898         write_seqcount_end(&inode->i_size_seqcount);
899 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
900         preempt_disable();
901         inode->i_size = i_size;
902         preempt_enable();
903 #else
904         inode->i_size = i_size;
905 #endif
906 }
907
908 static inline unsigned iminor(const struct inode *inode)
909 {
910         return MINOR(inode->i_rdev);
911 }
912
913 static inline unsigned imajor(const struct inode *inode)
914 {
915         return MAJOR(inode->i_rdev);
916 }
917
918 extern struct block_device *I_BDEV(struct inode *inode);
919
920 struct fown_struct {
921         rwlock_t lock;          /* protects pid, uid, euid fields */
922         struct pid *pid;        /* pid or -pgrp where SIGIO should be sent */
923         enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
924         uid_t uid, euid;        /* uid/euid of process setting the owner */
925         int signum;             /* posix.1b rt signal to be delivered on IO */
926 };
927
928 /*
929  * Track a single file's readahead state
930  */
931 struct file_ra_state {
932         pgoff_t start;                  /* where readahead started */
933         unsigned int size;              /* # of readahead pages */
934         unsigned int async_size;        /* do asynchronous readahead when
935                                            there are only # of pages ahead */
936
937         unsigned int ra_pages;          /* Maximum readahead window */
938         unsigned int mmap_miss;         /* Cache miss stat for mmap accesses */
939         loff_t prev_pos;                /* Cache last read() position */
940 };
941
942 /*
943  * Check if @index falls in the readahead windows.
944  */
945 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
946 {
947         return (index >= ra->start &&
948                 index <  ra->start + ra->size);
949 }
950
951 #define FILE_MNT_WRITE_TAKEN    1
952 #define FILE_MNT_WRITE_RELEASED 2
953
954 struct file {
955         /*
956          * fu_list becomes invalid after file_free is called and queued via
957          * fu_rcuhead for RCU freeing
958          */
959         union {
960                 struct list_head        fu_list;
961                 struct rcu_head         fu_rcuhead;
962         } f_u;
963         struct path             f_path;
964 #define f_dentry        f_path.dentry
965 #define f_vfsmnt        f_path.mnt
966         const struct file_operations    *f_op;
967         spinlock_t              f_lock;  /* f_ep_links, f_flags, no IRQ */
968 #ifdef CONFIG_SMP
969         int                     f_sb_list_cpu;
970 #endif
971         atomic_long_t           f_count;
972         unsigned int            f_flags;
973         fmode_t                 f_mode;
974         loff_t                  f_pos;
975         struct fown_struct      f_owner;
976         const struct cred       *f_cred;
977         struct file_ra_state    f_ra;
978
979         u64                     f_version;
980 #ifdef CONFIG_SECURITY
981         void                    *f_security;
982 #endif
983         /* needed for tty driver, and maybe others */
984         void                    *private_data;
985
986 #ifdef CONFIG_EPOLL
987         /* Used by fs/eventpoll.c to link all the hooks to this file */
988         struct list_head        f_ep_links;
989 #endif /* #ifdef CONFIG_EPOLL */
990         struct address_space    *f_mapping;
991 #ifdef CONFIG_DEBUG_WRITECOUNT
992         unsigned long f_mnt_write_state;
993 #endif
994 };
995
996 struct file_handle {
997         __u32 handle_bytes;
998         int handle_type;
999         /* file identifier */
1000         unsigned char f_handle[0];
1001 };
1002
1003 #define get_file(x)     atomic_long_inc(&(x)->f_count)
1004 #define fput_atomic(x)  atomic_long_add_unless(&(x)->f_count, -1, 1)
1005 #define file_count(x)   atomic_long_read(&(x)->f_count)
1006
1007 #ifdef CONFIG_DEBUG_WRITECOUNT
1008 static inline void file_take_write(struct file *f)
1009 {
1010         WARN_ON(f->f_mnt_write_state != 0);
1011         f->f_mnt_write_state = FILE_MNT_WRITE_TAKEN;
1012 }
1013 static inline void file_release_write(struct file *f)
1014 {
1015         f->f_mnt_write_state |= FILE_MNT_WRITE_RELEASED;
1016 }
1017 static inline void file_reset_write(struct file *f)
1018 {
1019         f->f_mnt_write_state = 0;
1020 }
1021 static inline void file_check_state(struct file *f)
1022 {
1023         /*
1024          * At this point, either both or neither of these bits
1025          * should be set.
1026          */
1027         WARN_ON(f->f_mnt_write_state == FILE_MNT_WRITE_TAKEN);
1028         WARN_ON(f->f_mnt_write_state == FILE_MNT_WRITE_RELEASED);
1029 }
1030 static inline int file_check_writeable(struct file *f)
1031 {
1032         if (f->f_mnt_write_state == FILE_MNT_WRITE_TAKEN)
1033                 return 0;
1034         printk(KERN_WARNING "writeable file with no "
1035                             "mnt_want_write()\n");
1036         WARN_ON(1);
1037         return -EINVAL;
1038 }
1039 #else /* !CONFIG_DEBUG_WRITECOUNT */
1040 static inline void file_take_write(struct file *filp) {}
1041 static inline void file_release_write(struct file *filp) {}
1042 static inline void file_reset_write(struct file *filp) {}
1043 static inline void file_check_state(struct file *filp) {}
1044 static inline int file_check_writeable(struct file *filp)
1045 {
1046         return 0;
1047 }
1048 #endif /* CONFIG_DEBUG_WRITECOUNT */
1049
1050 #define MAX_NON_LFS     ((1UL<<31) - 1)
1051
1052 /* Page cache limit. The filesystems should put that into their s_maxbytes 
1053    limits, otherwise bad things can happen in VM. */ 
1054 #if BITS_PER_LONG==32
1055 #define MAX_LFS_FILESIZE        (((u64)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1) 
1056 #elif BITS_PER_LONG==64
1057 #define MAX_LFS_FILESIZE        0x7fffffffffffffffUL
1058 #endif
1059
1060 #define FL_POSIX        1
1061 #define FL_FLOCK        2
1062 #define FL_ACCESS       8       /* not trying to lock, just looking */
1063 #define FL_EXISTS       16      /* when unlocking, test for existence */
1064 #define FL_LEASE        32      /* lease held on this file */
1065 #define FL_CLOSE        64      /* unlock on close */
1066 #define FL_SLEEP        128     /* A blocking lock */
1067
1068 /*
1069  * Special return value from posix_lock_file() and vfs_lock_file() for
1070  * asynchronous locking.
1071  */
1072 #define FILE_LOCK_DEFERRED 1
1073
1074 /*
1075  * The POSIX file lock owner is determined by
1076  * the "struct files_struct" in the thread group
1077  * (or NULL for no owner - BSD locks).
1078  *
1079  * Lockd stuffs a "host" pointer into this.
1080  */
1081 typedef struct files_struct *fl_owner_t;
1082
1083 struct file_lock_operations {
1084         void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1085         void (*fl_release_private)(struct file_lock *);
1086 };
1087
1088 struct lock_manager_operations {
1089         int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
1090         void (*lm_notify)(struct file_lock *);  /* unblock callback */
1091         int (*lm_grant)(struct file_lock *, struct file_lock *, int);
1092         void (*lm_release_private)(struct file_lock *);
1093         void (*lm_break)(struct file_lock *);
1094         int (*lm_change)(struct file_lock **, int);
1095 };
1096
1097 struct lock_manager {
1098         struct list_head list;
1099 };
1100
1101 void locks_start_grace(struct lock_manager *);
1102 void locks_end_grace(struct lock_manager *);
1103 int locks_in_grace(void);
1104
1105 /* that will die - we need it for nfs_lock_info */
1106 #include <linux/nfs_fs_i.h>
1107
1108 struct file_lock {
1109         struct file_lock *fl_next;      /* singly linked list for this inode  */
1110         struct list_head fl_link;       /* doubly linked list of all locks */
1111         struct list_head fl_block;      /* circular list of blocked processes */
1112         fl_owner_t fl_owner;
1113         unsigned char fl_flags;
1114         unsigned char fl_type;
1115         unsigned int fl_pid;
1116         struct pid *fl_nspid;
1117         wait_queue_head_t fl_wait;
1118         struct file *fl_file;
1119         loff_t fl_start;
1120         loff_t fl_end;
1121
1122         struct fasync_struct *  fl_fasync; /* for lease break notifications */
1123         unsigned long fl_break_time;    /* for nonblocking lease breaks */
1124
1125         const struct file_lock_operations *fl_ops;      /* Callbacks for filesystems */
1126         const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
1127         union {
1128                 struct nfs_lock_info    nfs_fl;
1129                 struct nfs4_lock_info   nfs4_fl;
1130                 struct {
1131                         struct list_head link;  /* link in AFS vnode's pending_locks list */
1132                         int state;              /* state of grant or error if -ve */
1133                 } afs;
1134         } fl_u;
1135 };
1136
1137 /* The following constant reflects the upper bound of the file/locking space */
1138 #ifndef OFFSET_MAX
1139 #define INT_LIMIT(x)    (~((x)1 << (sizeof(x)*8 - 1)))
1140 #define OFFSET_MAX      INT_LIMIT(loff_t)
1141 #define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1142 #endif
1143
1144 #include <linux/fcntl.h>
1145
1146 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1147
1148 #ifdef CONFIG_FILE_LOCKING
1149 extern int fcntl_getlk(struct file *, struct flock __user *);
1150 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1151                         struct flock __user *);
1152
1153 #if BITS_PER_LONG == 32
1154 extern int fcntl_getlk64(struct file *, struct flock64 __user *);
1155 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1156                         struct flock64 __user *);
1157 #endif
1158
1159 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1160 extern int fcntl_getlease(struct file *filp);
1161
1162 /* fs/locks.c */
1163 void locks_free_lock(struct file_lock *fl);
1164 extern void locks_init_lock(struct file_lock *);
1165 extern struct file_lock * locks_alloc_lock(void);
1166 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1167 extern void __locks_copy_lock(struct file_lock *, const struct file_lock *);
1168 extern void locks_remove_posix(struct file *, fl_owner_t);
1169 extern void locks_remove_flock(struct file *);
1170 extern void locks_release_private(struct file_lock *);
1171 extern void posix_test_lock(struct file *, struct file_lock *);
1172 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1173 extern int posix_lock_file_wait(struct file *, struct file_lock *);
1174 extern int posix_unblock_lock(struct file *, struct file_lock *);
1175 extern int vfs_test_lock(struct file *, struct file_lock *);
1176 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1177 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1178 extern int flock_lock_file_wait(struct file *filp, struct file_lock *fl);
1179 extern int __break_lease(struct inode *inode, unsigned int flags);
1180 extern void lease_get_mtime(struct inode *, struct timespec *time);
1181 extern int generic_setlease(struct file *, long, struct file_lock **);
1182 extern int vfs_setlease(struct file *, long, struct file_lock **);
1183 extern int lease_modify(struct file_lock **, int);
1184 extern int lock_may_read(struct inode *, loff_t start, unsigned long count);
1185 extern int lock_may_write(struct inode *, loff_t start, unsigned long count);
1186 extern void lock_flocks(void);
1187 extern void unlock_flocks(void);
1188 #else /* !CONFIG_FILE_LOCKING */
1189 static inline int fcntl_getlk(struct file *file, struct flock __user *user)
1190 {
1191         return -EINVAL;
1192 }
1193
1194 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1195                               unsigned int cmd, struct flock __user *user)
1196 {
1197         return -EACCES;
1198 }
1199
1200 #if BITS_PER_LONG == 32
1201 static inline int fcntl_getlk64(struct file *file, struct flock64 __user *user)
1202 {
1203         return -EINVAL;
1204 }
1205
1206 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1207                                 unsigned int cmd, struct flock64 __user *user)
1208 {
1209         return -EACCES;
1210 }
1211 #endif
1212 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1213 {
1214         return 0;
1215 }
1216
1217 static inline int fcntl_getlease(struct file *filp)
1218 {
1219         return 0;
1220 }
1221
1222 static inline void locks_init_lock(struct file_lock *fl)
1223 {
1224         return;
1225 }
1226
1227 static inline void __locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1228 {
1229         return;
1230 }
1231
1232 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1233 {
1234         return;
1235 }
1236
1237 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1238 {
1239         return;
1240 }
1241
1242 static inline void locks_remove_flock(struct file *filp)
1243 {
1244         return;
1245 }
1246
1247 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1248 {
1249         return;
1250 }
1251
1252 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1253                                   struct file_lock *conflock)
1254 {
1255         return -ENOLCK;
1256 }
1257
1258 static inline int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1259 {
1260         return -ENOLCK;
1261 }
1262
1263 static inline int posix_unblock_lock(struct file *filp,
1264                                      struct file_lock *waiter)
1265 {
1266         return -ENOENT;
1267 }
1268
1269 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1270 {
1271         return 0;
1272 }
1273
1274 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1275                                 struct file_lock *fl, struct file_lock *conf)
1276 {
1277         return -ENOLCK;
1278 }
1279
1280 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1281 {
1282         return 0;
1283 }
1284
1285 static inline int flock_lock_file_wait(struct file *filp,
1286                                        struct file_lock *request)
1287 {
1288         return -ENOLCK;
1289 }
1290
1291 static inline int __break_lease(struct inode *inode, unsigned int mode)
1292 {
1293         return 0;
1294 }
1295
1296 static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1297 {
1298         return;
1299 }
1300
1301 static inline int generic_setlease(struct file *filp, long arg,
1302                                     struct file_lock **flp)
1303 {
1304         return -EINVAL;
1305 }
1306
1307 static inline int vfs_setlease(struct file *filp, long arg,
1308                                struct file_lock **lease)
1309 {
1310         return -EINVAL;
1311 }
1312
1313 static inline int lease_modify(struct file_lock **before, int arg)
1314 {
1315         return -EINVAL;
1316 }
1317
1318 static inline int lock_may_read(struct inode *inode, loff_t start,
1319                                 unsigned long len)
1320 {
1321         return 1;
1322 }
1323
1324 static inline int lock_may_write(struct inode *inode, loff_t start,
1325                                  unsigned long len)
1326 {
1327         return 1;
1328 }
1329
1330 static inline void lock_flocks(void)
1331 {
1332 }
1333
1334 static inline void unlock_flocks(void)
1335 {
1336 }
1337
1338 #endif /* !CONFIG_FILE_LOCKING */
1339
1340
1341 struct fasync_struct {
1342         spinlock_t              fa_lock;
1343         int                     magic;
1344         int                     fa_fd;
1345         struct fasync_struct    *fa_next; /* singly linked list */
1346         struct file             *fa_file;
1347         struct rcu_head         fa_rcu;
1348 };
1349
1350 #define FASYNC_MAGIC 0x4601
1351
1352 /* SMP safe fasync helpers: */
1353 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1354 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1355 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1356 extern struct fasync_struct *fasync_alloc(void);
1357 extern void fasync_free(struct fasync_struct *);
1358
1359 /* can be called from interrupts */
1360 extern void kill_fasync(struct fasync_struct **, int, int);
1361
1362 extern int __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1363 extern int f_setown(struct file *filp, unsigned long arg, int force);
1364 extern void f_delown(struct file *filp);
1365 extern pid_t f_getown(struct file *filp);
1366 extern int send_sigurg(struct fown_struct *fown);
1367
1368 /*
1369  *      Umount options
1370  */
1371
1372 #define MNT_FORCE       0x00000001      /* Attempt to forcibily umount */
1373 #define MNT_DETACH      0x00000002      /* Just detach from the tree */
1374 #define MNT_EXPIRE      0x00000004      /* Mark for expiry */
1375 #define UMOUNT_NOFOLLOW 0x00000008      /* Don't follow symlink on umount */
1376 #define UMOUNT_UNUSED   0x80000000      /* Flag guaranteed to be unused */
1377
1378 extern struct list_head super_blocks;
1379 extern spinlock_t sb_lock;
1380
1381 struct super_block {
1382         struct list_head        s_list;         /* Keep this first */
1383         dev_t                   s_dev;          /* search index; _not_ kdev_t */
1384         unsigned char           s_dirt;
1385         unsigned char           s_blocksize_bits;
1386         unsigned long           s_blocksize;
1387         loff_t                  s_maxbytes;     /* Max file size */
1388         struct file_system_type *s_type;
1389         const struct super_operations   *s_op;
1390         const struct dquot_operations   *dq_op;
1391         const struct quotactl_ops       *s_qcop;
1392         const struct export_operations *s_export_op;
1393         unsigned long           s_flags;
1394         unsigned long           s_magic;
1395         struct dentry           *s_root;
1396         struct rw_semaphore     s_umount;
1397         struct mutex            s_lock;
1398         int                     s_count;
1399         atomic_t                s_active;
1400 #ifdef CONFIG_SECURITY
1401         void                    *s_security;
1402 #endif
1403         const struct xattr_handler **s_xattr;
1404
1405         struct list_head        s_inodes;       /* all inodes */
1406         struct hlist_bl_head    s_anon;         /* anonymous dentries for (nfs) exporting */
1407 #ifdef CONFIG_SMP
1408         struct list_head __percpu *s_files;
1409 #else
1410         struct list_head        s_files;
1411 #endif
1412         /* s_dentry_lru, s_nr_dentry_unused protected by dcache.c lru locks */
1413         struct list_head        s_dentry_lru;   /* unused dentry lru */
1414         int                     s_nr_dentry_unused;     /* # of dentry on lru */
1415
1416         /* s_inode_lru_lock protects s_inode_lru and s_nr_inodes_unused */
1417         spinlock_t              s_inode_lru_lock ____cacheline_aligned_in_smp;
1418         struct list_head        s_inode_lru;            /* unused inode lru */
1419         int                     s_nr_inodes_unused;     /* # of inodes on lru */
1420
1421         struct block_device     *s_bdev;
1422         struct backing_dev_info *s_bdi;
1423         struct mtd_info         *s_mtd;
1424         struct list_head        s_instances;
1425         struct quota_info       s_dquot;        /* Diskquota specific options */
1426
1427         int                     s_frozen;
1428         wait_queue_head_t       s_wait_unfrozen;
1429
1430         char s_id[32];                          /* Informational name */
1431         u8 s_uuid[16];                          /* UUID */
1432
1433         void                    *s_fs_info;     /* Filesystem private info */
1434         fmode_t                 s_mode;
1435
1436         /* Granularity of c/m/atime in ns.
1437            Cannot be worse than a second */
1438         u32                s_time_gran;
1439
1440         /*
1441          * The next field is for VFS *only*. No filesystems have any business
1442          * even looking at it. You had been warned.
1443          */
1444         struct mutex s_vfs_rename_mutex;        /* Kludge */
1445
1446         /*
1447          * Filesystem subtype.  If non-empty the filesystem type field
1448          * in /proc/mounts will be "type.subtype"
1449          */
1450         char *s_subtype;
1451
1452         /*
1453          * Saved mount options for lazy filesystems using
1454          * generic_show_options()
1455          */
1456         char __rcu *s_options;
1457         const struct dentry_operations *s_d_op; /* default d_op for dentries */
1458
1459         /*
1460          * Saved pool identifier for cleancache (-1 means none)
1461          */
1462         int cleancache_poolid;
1463
1464         struct shrinker s_shrink;       /* per-sb shrinker handle */
1465 };
1466
1467 /* superblock cache pruning functions */
1468 extern void prune_icache_sb(struct super_block *sb, int nr_to_scan);
1469 extern void prune_dcache_sb(struct super_block *sb, int nr_to_scan);
1470
1471 extern struct timespec current_fs_time(struct super_block *sb);
1472
1473 /*
1474  * Snapshotting support.
1475  */
1476 enum {
1477         SB_UNFROZEN = 0,
1478         SB_FREEZE_WRITE = 1,
1479         SB_FREEZE_TRANS = 2,
1480 };
1481
1482 #define vfs_check_frozen(sb, level) \
1483         wait_event((sb)->s_wait_unfrozen, ((sb)->s_frozen < (level)))
1484
1485 /*
1486  * until VFS tracks user namespaces for inodes, just make all files
1487  * belong to init_user_ns
1488  */
1489 extern struct user_namespace init_user_ns;
1490 #define inode_userns(inode) (&init_user_ns)
1491 extern bool inode_owner_or_capable(const struct inode *inode);
1492
1493 /* not quite ready to be deprecated, but... */
1494 extern void lock_super(struct super_block *);
1495 extern void unlock_super(struct super_block *);
1496
1497 /*
1498  * VFS helper functions..
1499  */
1500 extern int vfs_create(struct inode *, struct dentry *, int, struct nameidata *);
1501 extern int vfs_mkdir(struct inode *, struct dentry *, int);
1502 extern int vfs_mknod(struct inode *, struct dentry *, int, dev_t);
1503 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1504 extern int vfs_link(struct dentry *, struct inode *, struct dentry *);
1505 extern int vfs_rmdir(struct inode *, struct dentry *);
1506 extern int vfs_unlink(struct inode *, struct dentry *);
1507 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
1508
1509 /*
1510  * VFS dentry helper functions.
1511  */
1512 extern void dentry_unhash(struct dentry *dentry);
1513
1514 /*
1515  * VFS file helper functions.
1516  */
1517 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1518                         mode_t mode);
1519 /*
1520  * VFS FS_IOC_FIEMAP helper definitions.
1521  */
1522 struct fiemap_extent_info {
1523         unsigned int fi_flags;          /* Flags as passed from user */
1524         unsigned int fi_extents_mapped; /* Number of mapped extents */
1525         unsigned int fi_extents_max;    /* Size of fiemap_extent array */
1526         struct fiemap_extent __user *fi_extents_start; /* Start of
1527                                                         fiemap_extent array */
1528 };
1529 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1530                             u64 phys, u64 len, u32 flags);
1531 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1532
1533 /*
1534  * File types
1535  *
1536  * NOTE! These match bits 12..15 of stat.st_mode
1537  * (ie "(i_mode >> 12) & 15").
1538  */
1539 #define DT_UNKNOWN      0
1540 #define DT_FIFO         1
1541 #define DT_CHR          2
1542 #define DT_DIR          4
1543 #define DT_BLK          6
1544 #define DT_REG          8
1545 #define DT_LNK          10
1546 #define DT_SOCK         12
1547 #define DT_WHT          14
1548
1549 /*
1550  * This is the "filldir" function type, used by readdir() to let
1551  * the kernel specify what kind of dirent layout it wants to have.
1552  * This allows the kernel to read directories into kernel space or
1553  * to have different dirent layouts depending on the binary type.
1554  */
1555 typedef int (*filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
1556 struct block_device_operations;
1557
1558 /* These macros are for out of kernel modules to test that
1559  * the kernel supports the unlocked_ioctl and compat_ioctl
1560  * fields in struct file_operations. */
1561 #define HAVE_COMPAT_IOCTL 1
1562 #define HAVE_UNLOCKED_IOCTL 1
1563
1564 struct file_operations {
1565         struct module *owner;
1566         loff_t (*llseek) (struct file *, loff_t, int);
1567         ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1568         ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1569         ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
1570         ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
1571         int (*readdir) (struct file *, void *, filldir_t);
1572         unsigned int (*poll) (struct file *, struct poll_table_struct *);
1573         long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1574         long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1575         int (*mmap) (struct file *, struct vm_area_struct *);
1576         int (*open) (struct inode *, struct file *);
1577         int (*flush) (struct file *, fl_owner_t id);
1578         int (*release) (struct inode *, struct file *);
1579         int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1580         int (*aio_fsync) (struct kiocb *, int datasync);
1581         int (*fasync) (int, struct file *, int);
1582         int (*lock) (struct file *, int, struct file_lock *);
1583         ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1584         unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1585         int (*check_flags)(int);
1586         int (*flock) (struct file *, int, struct file_lock *);
1587         ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1588         ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1589         int (*setlease)(struct file *, long, struct file_lock **);
1590         long (*fallocate)(struct file *file, int mode, loff_t offset,
1591                           loff_t len);
1592 };
1593
1594 struct inode_operations {
1595         struct dentry * (*lookup) (struct inode *,struct dentry *, struct nameidata *);
1596         void * (*follow_link) (struct dentry *, struct nameidata *);
1597         int (*permission) (struct inode *, int);
1598         struct posix_acl * (*get_acl)(struct inode *, int);
1599
1600         int (*readlink) (struct dentry *, char __user *,int);
1601         void (*put_link) (struct dentry *, struct nameidata *, void *);
1602
1603         int (*create) (struct inode *,struct dentry *,int, struct nameidata *);
1604         int (*link) (struct dentry *,struct inode *,struct dentry *);
1605         int (*unlink) (struct inode *,struct dentry *);
1606         int (*symlink) (struct inode *,struct dentry *,const char *);
1607         int (*mkdir) (struct inode *,struct dentry *,int);
1608         int (*rmdir) (struct inode *,struct dentry *);
1609         int (*mknod) (struct inode *,struct dentry *,int,dev_t);
1610         int (*rename) (struct inode *, struct dentry *,
1611                         struct inode *, struct dentry *);
1612         void (*truncate) (struct inode *);
1613         int (*setattr) (struct dentry *, struct iattr *);
1614         int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
1615         int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
1616         ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
1617         ssize_t (*listxattr) (struct dentry *, char *, size_t);
1618         int (*removexattr) (struct dentry *, const char *);
1619         void (*truncate_range)(struct inode *, loff_t, loff_t);
1620         int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1621                       u64 len);
1622 } ____cacheline_aligned;
1623
1624 struct seq_file;
1625
1626 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1627                                 unsigned long nr_segs, unsigned long fast_segs,
1628                                 struct iovec *fast_pointer,
1629                                 struct iovec **ret_pointer);
1630
1631 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1632 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1633 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1634                 unsigned long, loff_t *);
1635 extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1636                 unsigned long, loff_t *);
1637
1638 struct super_operations {
1639         struct inode *(*alloc_inode)(struct super_block *sb);
1640         void (*destroy_inode)(struct inode *);
1641
1642         void (*dirty_inode) (struct inode *, int flags);
1643         int (*write_inode) (struct inode *, struct writeback_control *wbc);
1644         int (*drop_inode) (struct inode *);
1645         void (*evict_inode) (struct inode *);
1646         void (*put_super) (struct super_block *);
1647         void (*write_super) (struct super_block *);
1648         int (*sync_fs)(struct super_block *sb, int wait);
1649         int (*freeze_fs) (struct super_block *);
1650         int (*unfreeze_fs) (struct super_block *);
1651         int (*statfs) (struct dentry *, struct kstatfs *);
1652         int (*remount_fs) (struct super_block *, int *, char *);
1653         void (*umount_begin) (struct super_block *);
1654
1655         int (*show_options)(struct seq_file *, struct vfsmount *);
1656         int (*show_devname)(struct seq_file *, struct vfsmount *);
1657         int (*show_path)(struct seq_file *, struct vfsmount *);
1658         int (*show_stats)(struct seq_file *, struct vfsmount *);
1659 #ifdef CONFIG_QUOTA
1660         ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1661         ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1662 #endif
1663         int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1664         int (*nr_cached_objects)(struct super_block *);
1665         void (*free_cached_objects)(struct super_block *, int);
1666 };
1667
1668 /*
1669  * Inode state bits.  Protected by inode->i_lock
1670  *
1671  * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1672  * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1673  *
1674  * Four bits define the lifetime of an inode.  Initially, inodes are I_NEW,
1675  * until that flag is cleared.  I_WILL_FREE, I_FREEING and I_CLEAR are set at
1676  * various stages of removing an inode.
1677  *
1678  * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1679  *
1680  * I_DIRTY_SYNC         Inode is dirty, but doesn't have to be written on
1681  *                      fdatasync().  i_atime is the usual cause.
1682  * I_DIRTY_DATASYNC     Data-related inode changes pending. We keep track of
1683  *                      these changes separately from I_DIRTY_SYNC so that we
1684  *                      don't have to write inode on fdatasync() when only
1685  *                      mtime has changed in it.
1686  * I_DIRTY_PAGES        Inode has dirty pages.  Inode itself may be clean.
1687  * I_NEW                Serves as both a mutex and completion notification.
1688  *                      New inodes set I_NEW.  If two processes both create
1689  *                      the same inode, one of them will release its inode and
1690  *                      wait for I_NEW to be released before returning.
1691  *                      Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1692  *                      also cause waiting on I_NEW, without I_NEW actually
1693  *                      being set.  find_inode() uses this to prevent returning
1694  *                      nearly-dead inodes.
1695  * I_WILL_FREE          Must be set when calling write_inode_now() if i_count
1696  *                      is zero.  I_FREEING must be set when I_WILL_FREE is
1697  *                      cleared.
1698  * I_FREEING            Set when inode is about to be freed but still has dirty
1699  *                      pages or buffers attached or the inode itself is still
1700  *                      dirty.
1701  * I_CLEAR              Added by end_writeback().  In this state the inode is clean
1702  *                      and can be destroyed.  Inode keeps I_FREEING.
1703  *
1704  *                      Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1705  *                      prohibited for many purposes.  iget() must wait for
1706  *                      the inode to be completely released, then create it
1707  *                      anew.  Other functions will just ignore such inodes,
1708  *                      if appropriate.  I_NEW is used for waiting.
1709  *
1710  * I_SYNC               Synchonized write of dirty inode data.  The bits is
1711  *                      set during data writeback, and cleared with a wakeup
1712  *                      on the bit address once it is done.
1713  *
1714  * I_REFERENCED         Marks the inode as recently references on the LRU list.
1715  *
1716  * I_DIO_WAKEUP         Never set.  Only used as a key for wait_on_bit().
1717  *
1718  * Q: What is the difference between I_WILL_FREE and I_FREEING?
1719  */
1720 #define I_DIRTY_SYNC            (1 << 0)
1721 #define I_DIRTY_DATASYNC        (1 << 1)
1722 #define I_DIRTY_PAGES           (1 << 2)
1723 #define __I_NEW                 3
1724 #define I_NEW                   (1 << __I_NEW)
1725 #define I_WILL_FREE             (1 << 4)
1726 #define I_FREEING               (1 << 5)
1727 #define I_CLEAR                 (1 << 6)
1728 #define __I_SYNC                7
1729 #define I_SYNC                  (1 << __I_SYNC)
1730 #define I_REFERENCED            (1 << 8)
1731 #define __I_DIO_WAKEUP          9
1732 #define I_DIO_WAKEUP            (1 << I_DIO_WAKEUP)
1733
1734 #define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
1735
1736 extern void __mark_inode_dirty(struct inode *, int);
1737 static inline void mark_inode_dirty(struct inode *inode)
1738 {
1739         __mark_inode_dirty(inode, I_DIRTY);
1740 }
1741
1742 static inline void mark_inode_dirty_sync(struct inode *inode)
1743 {
1744         __mark_inode_dirty(inode, I_DIRTY_SYNC);
1745 }
1746
1747 /**
1748  * inc_nlink - directly increment an inode's link count
1749  * @inode: inode
1750  *
1751  * This is a low-level filesystem helper to replace any
1752  * direct filesystem manipulation of i_nlink.  Currently,
1753  * it is only here for parity with dec_nlink().
1754  */
1755 static inline void inc_nlink(struct inode *inode)
1756 {
1757         inode->i_nlink++;
1758 }
1759
1760 static inline void inode_inc_link_count(struct inode *inode)
1761 {
1762         inc_nlink(inode);
1763         mark_inode_dirty(inode);
1764 }
1765
1766 /**
1767  * drop_nlink - directly drop an inode's link count
1768  * @inode: inode
1769  *
1770  * This is a low-level filesystem helper to replace any
1771  * direct filesystem manipulation of i_nlink.  In cases
1772  * where we are attempting to track writes to the
1773  * filesystem, a decrement to zero means an imminent
1774  * write when the file is truncated and actually unlinked
1775  * on the filesystem.
1776  */
1777 static inline void drop_nlink(struct inode *inode)
1778 {
1779         inode->i_nlink--;
1780 }
1781
1782 /**
1783  * clear_nlink - directly zero an inode's link count
1784  * @inode: inode
1785  *
1786  * This is a low-level filesystem helper to replace any
1787  * direct filesystem manipulation of i_nlink.  See
1788  * drop_nlink() for why we care about i_nlink hitting zero.
1789  */
1790 static inline void clear_nlink(struct inode *inode)
1791 {
1792         inode->i_nlink = 0;
1793 }
1794
1795 static inline void inode_dec_link_count(struct inode *inode)
1796 {
1797         drop_nlink(inode);
1798         mark_inode_dirty(inode);
1799 }
1800
1801 /**
1802  * inode_inc_iversion - increments i_version
1803  * @inode: inode that need to be updated
1804  *
1805  * Every time the inode is modified, the i_version field will be incremented.
1806  * The filesystem has to be mounted with i_version flag
1807  */
1808
1809 static inline void inode_inc_iversion(struct inode *inode)
1810 {
1811        spin_lock(&inode->i_lock);
1812        inode->i_version++;
1813        spin_unlock(&inode->i_lock);
1814 }
1815
1816 extern void touch_atime(struct vfsmount *mnt, struct dentry *dentry);
1817 static inline void file_accessed(struct file *file)
1818 {
1819         if (!(file->f_flags & O_NOATIME))
1820                 touch_atime(file->f_path.mnt, file->f_path.dentry);
1821 }
1822
1823 int sync_inode(struct inode *inode, struct writeback_control *wbc);
1824 int sync_inode_metadata(struct inode *inode, int wait);
1825
1826 struct file_system_type {
1827         const char *name;
1828         int fs_flags;
1829         struct dentry *(*mount) (struct file_system_type *, int,
1830                        const char *, void *);
1831         void (*kill_sb) (struct super_block *);
1832         struct module *owner;
1833         struct file_system_type * next;
1834         struct list_head fs_supers;
1835
1836         struct lock_class_key s_lock_key;
1837         struct lock_class_key s_umount_key;
1838         struct lock_class_key s_vfs_rename_key;
1839
1840         struct lock_class_key i_lock_key;
1841         struct lock_class_key i_mutex_key;
1842         struct lock_class_key i_mutex_dir_key;
1843 };
1844
1845 extern struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
1846         void *data, int (*fill_super)(struct super_block *, void *, int));
1847 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
1848         int flags, const char *dev_name, void *data,
1849         int (*fill_super)(struct super_block *, void *, int));
1850 extern struct dentry *mount_single(struct file_system_type *fs_type,
1851         int flags, void *data,
1852         int (*fill_super)(struct super_block *, void *, int));
1853 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
1854         int flags, void *data,
1855         int (*fill_super)(struct super_block *, void *, int));
1856 void generic_shutdown_super(struct super_block *sb);
1857 void kill_block_super(struct super_block *sb);
1858 void kill_anon_super(struct super_block *sb);
1859 void kill_litter_super(struct super_block *sb);
1860 void deactivate_super(struct super_block *sb);
1861 void deactivate_locked_super(struct super_block *sb);
1862 int set_anon_super(struct super_block *s, void *data);
1863 int get_anon_bdev(dev_t *);
1864 void free_anon_bdev(dev_t);
1865 struct super_block *sget(struct file_system_type *type,
1866                         int (*test)(struct super_block *,void *),
1867                         int (*set)(struct super_block *,void *),
1868                         void *data);
1869 extern struct dentry *mount_pseudo(struct file_system_type *, char *,
1870         const struct super_operations *ops,
1871         const struct dentry_operations *dops,
1872         unsigned long);
1873
1874 static inline void sb_mark_dirty(struct super_block *sb)
1875 {
1876         sb->s_dirt = 1;
1877 }
1878 static inline void sb_mark_clean(struct super_block *sb)
1879 {
1880         sb->s_dirt = 0;
1881 }
1882 static inline int sb_is_dirty(struct super_block *sb)
1883 {
1884         return sb->s_dirt;
1885 }
1886
1887 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
1888 #define fops_get(fops) \
1889         (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
1890 #define fops_put(fops) \
1891         do { if (fops) module_put((fops)->owner); } while(0)
1892
1893 extern int register_filesystem(struct file_system_type *);
1894 extern int unregister_filesystem(struct file_system_type *);
1895 extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
1896 #define kern_mount(type) kern_mount_data(type, NULL)
1897 extern void kern_unmount(struct vfsmount *mnt);
1898 extern int may_umount_tree(struct vfsmount *);
1899 extern int may_umount(struct vfsmount *);
1900 extern long do_mount(char *, char *, char *, unsigned long, void *);
1901 extern struct vfsmount *collect_mounts(struct path *);
1902 extern void drop_collected_mounts(struct vfsmount *);
1903 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
1904                           struct vfsmount *);
1905 extern int vfs_statfs(struct path *, struct kstatfs *);
1906 extern int user_statfs(const char __user *, struct kstatfs *);
1907 extern int fd_statfs(int, struct kstatfs *);
1908 extern int statfs_by_dentry(struct dentry *, struct kstatfs *);
1909 extern int freeze_super(struct super_block *super);
1910 extern int thaw_super(struct super_block *super);
1911
1912 extern int current_umask(void);
1913
1914 /* /sys/fs */
1915 extern struct kobject *fs_kobj;
1916
1917 #define MAX_RW_COUNT (INT_MAX & PAGE_CACHE_MASK)
1918 extern int rw_verify_area(int, struct file *, loff_t *, size_t);
1919
1920 #define FLOCK_VERIFY_READ  1
1921 #define FLOCK_VERIFY_WRITE 2
1922
1923 #ifdef CONFIG_FILE_LOCKING
1924 extern int locks_mandatory_locked(struct inode *);
1925 extern int locks_mandatory_area(int, struct inode *, struct file *, loff_t, size_t);
1926
1927 /*
1928  * Candidates for mandatory locking have the setgid bit set
1929  * but no group execute bit -  an otherwise meaningless combination.
1930  */
1931
1932 static inline int __mandatory_lock(struct inode *ino)
1933 {
1934         return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
1935 }
1936
1937 /*
1938  * ... and these candidates should be on MS_MANDLOCK mounted fs,
1939  * otherwise these will be advisory locks
1940  */
1941
1942 static inline int mandatory_lock(struct inode *ino)
1943 {
1944         return IS_MANDLOCK(ino) && __mandatory_lock(ino);
1945 }
1946
1947 static inline int locks_verify_locked(struct inode *inode)
1948 {
1949         if (mandatory_lock(inode))
1950                 return locks_mandatory_locked(inode);
1951         return 0;
1952 }
1953
1954 static inline int locks_verify_truncate(struct inode *inode,
1955                                     struct file *filp,
1956                                     loff_t size)
1957 {
1958         if (inode->i_flock && mandatory_lock(inode))
1959                 return locks_mandatory_area(
1960                         FLOCK_VERIFY_WRITE, inode, filp,
1961                         size < inode->i_size ? size : inode->i_size,
1962                         (size < inode->i_size ? inode->i_size - size
1963                          : size - inode->i_size)
1964                 );
1965         return 0;
1966 }
1967
1968 static inline int break_lease(struct inode *inode, unsigned int mode)
1969 {
1970         if (inode->i_flock)
1971                 return __break_lease(inode, mode);
1972         return 0;
1973 }
1974 #else /* !CONFIG_FILE_LOCKING */
1975 static inline int locks_mandatory_locked(struct inode *inode)
1976 {
1977         return 0;
1978 }
1979
1980 static inline int locks_mandatory_area(int rw, struct inode *inode,
1981                                        struct file *filp, loff_t offset,
1982                                        size_t count)
1983 {
1984         return 0;
1985 }
1986
1987 static inline int __mandatory_lock(struct inode *inode)
1988 {
1989         return 0;
1990 }
1991
1992 static inline int mandatory_lock(struct inode *inode)
1993 {
1994         return 0;
1995 }
1996
1997 static inline int locks_verify_locked(struct inode *inode)
1998 {
1999         return 0;
2000 }
2001
2002 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2003                                         size_t size)
2004 {
2005         return 0;
2006 }
2007
2008 static inline int break_lease(struct inode *inode, unsigned int mode)
2009 {
2010         return 0;
2011 }
2012
2013 #endif /* CONFIG_FILE_LOCKING */
2014
2015 /* fs/open.c */
2016
2017 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2018                        struct file *filp);
2019 extern int do_fallocate(struct file *file, int mode, loff_t offset,
2020                         loff_t len);
2021 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2022                         int mode);
2023 extern struct file *filp_open(const char *, int, int);
2024 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2025                                    const char *, int);
2026 extern struct file * dentry_open(struct dentry *, struct vfsmount *, int,
2027                                  const struct cred *);
2028 extern int filp_close(struct file *, fl_owner_t id);
2029 extern char * getname(const char __user *);
2030
2031 /* fs/ioctl.c */
2032
2033 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2034
2035 /* fs/dcache.c */
2036 extern void __init vfs_caches_init_early(void);
2037 extern void __init vfs_caches_init(unsigned long);
2038
2039 extern struct kmem_cache *names_cachep;
2040
2041 #define __getname_gfp(gfp)      kmem_cache_alloc(names_cachep, (gfp))
2042 #define __getname()             __getname_gfp(GFP_KERNEL)
2043 #define __putname(name)         kmem_cache_free(names_cachep, (void *)(name))
2044 #ifndef CONFIG_AUDITSYSCALL
2045 #define putname(name)   __putname(name)
2046 #else
2047 extern void putname(const char *name);
2048 #endif
2049
2050 #ifdef CONFIG_BLOCK
2051 extern int register_blkdev(unsigned int, const char *);
2052 extern void unregister_blkdev(unsigned int, const char *);
2053 extern struct block_device *bdget(dev_t);
2054 extern struct block_device *bdgrab(struct block_device *bdev);
2055 extern void bd_set_size(struct block_device *, loff_t size);
2056 extern void bd_forget(struct inode *inode);
2057 extern void bdput(struct block_device *);
2058 extern void invalidate_bdev(struct block_device *);
2059 extern int sync_blockdev(struct block_device *bdev);
2060 extern struct super_block *freeze_bdev(struct block_device *);
2061 extern void emergency_thaw_all(void);
2062 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2063 extern int fsync_bdev(struct block_device *);
2064 #else
2065 static inline void bd_forget(struct inode *inode) {}
2066 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2067 static inline void invalidate_bdev(struct block_device *bdev) {}
2068
2069 static inline struct super_block *freeze_bdev(struct block_device *sb)
2070 {
2071         return NULL;
2072 }
2073
2074 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2075 {
2076         return 0;
2077 }
2078 #endif
2079 extern int sync_filesystem(struct super_block *);
2080 extern const struct file_operations def_blk_fops;
2081 extern const struct file_operations def_chr_fops;
2082 extern const struct file_operations bad_sock_fops;
2083 extern const struct file_operations def_fifo_fops;
2084 #ifdef CONFIG_BLOCK
2085 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2086 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2087 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2088 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2089 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2090                                                void *holder);
2091 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2092                                               void *holder);
2093 extern int blkdev_put(struct block_device *bdev, fmode_t mode);
2094 #ifdef CONFIG_SYSFS
2095 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2096 extern void bd_unlink_disk_holder(struct block_device *bdev,
2097                                   struct gendisk *disk);
2098 #else
2099 static inline int bd_link_disk_holder(struct block_device *bdev,
2100                                       struct gendisk *disk)
2101 {
2102         return 0;
2103 }
2104 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2105                                          struct gendisk *disk)
2106 {
2107 }
2108 #endif
2109 #endif
2110
2111 /* fs/char_dev.c */
2112 #define CHRDEV_MAJOR_HASH_SIZE  255
2113 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2114 extern int register_chrdev_region(dev_t, unsigned, const char *);
2115 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2116                              unsigned int count, const char *name,
2117                              const struct file_operations *fops);
2118 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2119                                 unsigned int count, const char *name);
2120 extern void unregister_chrdev_region(dev_t, unsigned);
2121 extern void chrdev_show(struct seq_file *,off_t);
2122
2123 static inline int register_chrdev(unsigned int major, const char *name,
2124                                   const struct file_operations *fops)
2125 {
2126         return __register_chrdev(major, 0, 256, name, fops);
2127 }
2128
2129 static inline void unregister_chrdev(unsigned int major, const char *name)
2130 {
2131         __unregister_chrdev(major, 0, 256, name);
2132 }
2133
2134 /* fs/block_dev.c */
2135 #define BDEVNAME_SIZE   32      /* Largest string for a blockdev identifier */
2136 #define BDEVT_SIZE      10      /* Largest string for MAJ:MIN for blkdev */
2137
2138 #ifdef CONFIG_BLOCK
2139 #define BLKDEV_MAJOR_HASH_SIZE  255
2140 extern const char *__bdevname(dev_t, char *buffer);
2141 extern const char *bdevname(struct block_device *bdev, char *buffer);
2142 extern struct block_device *lookup_bdev(const char *);
2143 extern void blkdev_show(struct seq_file *,off_t);
2144
2145 #else
2146 #define BLKDEV_MAJOR_HASH_SIZE  0
2147 #endif
2148
2149 extern void init_special_inode(struct inode *, umode_t, dev_t);
2150
2151 /* Invalid inode operations -- fs/bad_inode.c */
2152 extern void make_bad_inode(struct inode *);
2153 extern int is_bad_inode(struct inode *);
2154
2155 extern const struct file_operations read_pipefifo_fops;
2156 extern const struct file_operations write_pipefifo_fops;
2157 extern const struct file_operations rdwr_pipefifo_fops;
2158
2159 extern int fs_may_remount_ro(struct super_block *);
2160
2161 #ifdef CONFIG_BLOCK
2162 /*
2163  * return READ, READA, or WRITE
2164  */
2165 #define bio_rw(bio)             ((bio)->bi_rw & (RW_MASK | RWA_MASK))
2166
2167 /*
2168  * return data direction, READ or WRITE
2169  */
2170 #define bio_data_dir(bio)       ((bio)->bi_rw & 1)
2171
2172 extern void check_disk_size_change(struct gendisk *disk,
2173                                    struct block_device *bdev);
2174 extern int revalidate_disk(struct gendisk *);
2175 extern int check_disk_change(struct block_device *);
2176 extern int __invalidate_device(struct block_device *, bool);
2177 extern int invalidate_partition(struct gendisk *, int);
2178 #endif
2179 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2180                                         pgoff_t start, pgoff_t end);
2181
2182 static inline void invalidate_remote_inode(struct inode *inode)
2183 {
2184         if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2185             S_ISLNK(inode->i_mode))
2186                 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2187 }
2188 extern int invalidate_inode_pages2(struct address_space *mapping);
2189 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2190                                          pgoff_t start, pgoff_t end);
2191 extern int write_inode_now(struct inode *, int);
2192 extern int filemap_fdatawrite(struct address_space *);
2193 extern int filemap_flush(struct address_space *);
2194 extern int filemap_fdatawait(struct address_space *);
2195 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2196                                    loff_t lend);
2197 extern int filemap_write_and_wait(struct address_space *mapping);
2198 extern int filemap_write_and_wait_range(struct address_space *mapping,
2199                                         loff_t lstart, loff_t lend);
2200 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2201                                 loff_t start, loff_t end, int sync_mode);
2202 extern int filemap_fdatawrite_range(struct address_space *mapping,
2203                                 loff_t start, loff_t end);
2204
2205 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2206                            int datasync);
2207 extern int vfs_fsync(struct file *file, int datasync);
2208 extern int generic_write_sync(struct file *file, loff_t pos, loff_t count);
2209 extern void sync_supers(void);
2210 extern void emergency_sync(void);
2211 extern void emergency_remount(void);
2212 #ifdef CONFIG_BLOCK
2213 extern sector_t bmap(struct inode *, sector_t);
2214 #endif
2215 extern int notify_change(struct dentry *, struct iattr *);
2216 extern int inode_permission(struct inode *, int);
2217 extern int generic_permission(struct inode *, int);
2218
2219 static inline bool execute_ok(struct inode *inode)
2220 {
2221         return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2222 }
2223
2224 /*
2225  * get_write_access() gets write permission for a file.
2226  * put_write_access() releases this write permission.
2227  * This is used for regular files.
2228  * We cannot support write (and maybe mmap read-write shared) accesses and
2229  * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2230  * can have the following values:
2231  * 0: no writers, no VM_DENYWRITE mappings
2232  * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2233  * > 0: (i_writecount) users are writing to the file.
2234  *
2235  * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2236  * except for the cases where we don't hold i_writecount yet. Then we need to
2237  * use {get,deny}_write_access() - these functions check the sign and refuse
2238  * to do the change if sign is wrong.
2239  */
2240 static inline int get_write_access(struct inode *inode)
2241 {
2242         return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2243 }
2244 static inline int deny_write_access(struct file *file)
2245 {
2246         struct inode *inode = file->f_path.dentry->d_inode;
2247         return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2248 }
2249 static inline void put_write_access(struct inode * inode)
2250 {
2251         atomic_dec(&inode->i_writecount);
2252 }
2253 static inline void allow_write_access(struct file *file)
2254 {
2255         if (file)
2256                 atomic_inc(&file->f_path.dentry->d_inode->i_writecount);
2257 }
2258 #ifdef CONFIG_IMA
2259 static inline void i_readcount_dec(struct inode *inode)
2260 {
2261         BUG_ON(!atomic_read(&inode->i_readcount));
2262         atomic_dec(&inode->i_readcount);
2263 }
2264 static inline void i_readcount_inc(struct inode *inode)
2265 {
2266         atomic_inc(&inode->i_readcount);
2267 }
2268 #else
2269 static inline void i_readcount_dec(struct inode *inode)
2270 {
2271         return;
2272 }
2273 static inline void i_readcount_inc(struct inode *inode)
2274 {
2275         return;
2276 }
2277 #endif
2278 extern int do_pipe_flags(int *, int);
2279 extern struct file *create_read_pipe(struct file *f, int flags);
2280 extern struct file *create_write_pipe(int flags);
2281 extern void free_write_pipe(struct file *);
2282
2283 extern int kernel_read(struct file *, loff_t, char *, unsigned long);
2284 extern struct file * open_exec(const char *);
2285  
2286 /* fs/dcache.c -- generic fs support functions */
2287 extern int is_subdir(struct dentry *, struct dentry *);
2288 extern int path_is_under(struct path *, struct path *);
2289 extern ino_t find_inode_number(struct dentry *, struct qstr *);
2290
2291 #include <linux/err.h>
2292
2293 /* needed for stackable file system support */
2294 extern loff_t default_llseek(struct file *file, loff_t offset, int origin);
2295
2296 extern loff_t vfs_llseek(struct file *file, loff_t offset, int origin);
2297
2298 extern int inode_init_always(struct super_block *, struct inode *);
2299 extern void inode_init_once(struct inode *);
2300 extern void address_space_init_once(struct address_space *mapping);
2301 extern void ihold(struct inode * inode);
2302 extern void iput(struct inode *);
2303 extern struct inode * igrab(struct inode *);
2304 extern ino_t iunique(struct super_block *, ino_t);
2305 extern int inode_needs_sync(struct inode *inode);
2306 extern int generic_delete_inode(struct inode *inode);
2307 extern int generic_drop_inode(struct inode *inode);
2308
2309 extern struct inode *ilookup5_nowait(struct super_block *sb,
2310                 unsigned long hashval, int (*test)(struct inode *, void *),
2311                 void *data);
2312 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2313                 int (*test)(struct inode *, void *), void *data);
2314 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2315
2316 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2317 extern struct inode * iget_locked(struct super_block *, unsigned long);
2318 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2319 extern int insert_inode_locked(struct inode *);
2320 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2321 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2322 #else
2323 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2324 #endif
2325 extern void unlock_new_inode(struct inode *);
2326 extern unsigned int get_next_ino(void);
2327
2328 extern void __iget(struct inode * inode);
2329 extern void iget_failed(struct inode *);
2330 extern void end_writeback(struct inode *);
2331 extern void __destroy_inode(struct inode *);
2332 extern struct inode *new_inode_pseudo(struct super_block *sb);
2333 extern struct inode *new_inode(struct super_block *sb);
2334 extern void free_inode_nonrcu(struct inode *inode);
2335 extern int should_remove_suid(struct dentry *);
2336 extern int file_remove_suid(struct file *);
2337
2338 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2339 static inline void insert_inode_hash(struct inode *inode)
2340 {
2341         __insert_inode_hash(inode, inode->i_ino);
2342 }
2343
2344 extern void __remove_inode_hash(struct inode *);
2345 static inline void remove_inode_hash(struct inode *inode)
2346 {
2347         if (!inode_unhashed(inode))
2348                 __remove_inode_hash(inode);
2349 }
2350
2351 extern void inode_sb_list_add(struct inode *inode);
2352
2353 #ifdef CONFIG_BLOCK
2354 extern void submit_bio(int, struct bio *);
2355 extern int bdev_read_only(struct block_device *);
2356 #endif
2357 extern int set_blocksize(struct block_device *, int);
2358 extern int sb_set_blocksize(struct super_block *, int);
2359 extern int sb_min_blocksize(struct super_block *, int);
2360
2361 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2362 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2363 extern int file_read_actor(read_descriptor_t * desc, struct page *page, unsigned long offset, unsigned long size);
2364 int generic_write_checks(struct file *file, loff_t *pos, size_t *count, int isblk);
2365 extern ssize_t generic_file_aio_read(struct kiocb *, const struct iovec *, unsigned long, loff_t);
2366 extern ssize_t __generic_file_aio_write(struct kiocb *, const struct iovec *, unsigned long,
2367                 loff_t *);
2368 extern ssize_t generic_file_aio_write(struct kiocb *, const struct iovec *, unsigned long, loff_t);
2369 extern ssize_t generic_file_direct_write(struct kiocb *, const struct iovec *,
2370                 unsigned long *, loff_t, loff_t *, size_t, size_t);
2371 extern ssize_t generic_file_buffered_write(struct kiocb *, const struct iovec *,
2372                 unsigned long, loff_t, loff_t *, size_t, ssize_t);
2373 extern ssize_t do_sync_read(struct file *filp, char __user *buf, size_t len, loff_t *ppos);
2374 extern ssize_t do_sync_write(struct file *filp, const char __user *buf, size_t len, loff_t *ppos);
2375 extern int generic_segment_checks(const struct iovec *iov,
2376                 unsigned long *nr_segs, size_t *count, int access_flags);
2377
2378 /* fs/block_dev.c */
2379 extern ssize_t blkdev_aio_write(struct kiocb *iocb, const struct iovec *iov,
2380                                 unsigned long nr_segs, loff_t pos);
2381 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2382                         int datasync);
2383
2384 /* fs/splice.c */
2385 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
2386                 struct pipe_inode_info *, size_t, unsigned int);
2387 extern ssize_t default_file_splice_read(struct file *, loff_t *,
2388                 struct pipe_inode_info *, size_t, unsigned int);
2389 extern ssize_t generic_file_splice_write(struct pipe_inode_info *,
2390                 struct file *, loff_t *, size_t, unsigned int);
2391 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
2392                 struct file *out, loff_t *, size_t len, unsigned int flags);
2393 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2394                 size_t len, unsigned int flags);
2395
2396 extern void
2397 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
2398 extern loff_t noop_llseek(struct file *file, loff_t offset, int origin);
2399 extern loff_t no_llseek(struct file *file, loff_t offset, int origin);
2400 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int origin);
2401 extern loff_t generic_file_llseek_unlocked(struct file *file, loff_t offset,
2402                         int origin);
2403 extern int generic_file_open(struct inode * inode, struct file * filp);
2404 extern int nonseekable_open(struct inode * inode, struct file * filp);
2405
2406 #ifdef CONFIG_FS_XIP
2407 extern ssize_t xip_file_read(struct file *filp, char __user *buf, size_t len,
2408                              loff_t *ppos);
2409 extern int xip_file_mmap(struct file * file, struct vm_area_struct * vma);
2410 extern ssize_t xip_file_write(struct file *filp, const char __user *buf,
2411                               size_t len, loff_t *ppos);
2412 extern int xip_truncate_page(struct address_space *mapping, loff_t from);
2413 #else
2414 static inline int xip_truncate_page(struct address_space *mapping, loff_t from)
2415 {
2416         return 0;
2417 }
2418 #endif
2419
2420 #ifdef CONFIG_BLOCK
2421 typedef void (dio_submit_t)(int rw, struct bio *bio, struct inode *inode,
2422                             loff_t file_offset);
2423
2424 enum {
2425         /* need locking between buffered and direct access */
2426         DIO_LOCKING     = 0x01,
2427
2428         /* filesystem does not support filling holes */
2429         DIO_SKIP_HOLES  = 0x02,
2430 };
2431
2432 void dio_end_io(struct bio *bio, int error);
2433 void inode_dio_wait(struct inode *inode);
2434 void inode_dio_done(struct inode *inode);
2435
2436 ssize_t __blockdev_direct_IO(int rw, struct kiocb *iocb, struct inode *inode,
2437         struct block_device *bdev, const struct iovec *iov, loff_t offset,
2438         unsigned long nr_segs, get_block_t get_block, dio_iodone_t end_io,
2439         dio_submit_t submit_io, int flags);
2440
2441 static inline ssize_t blockdev_direct_IO(int rw, struct kiocb *iocb,
2442                 struct inode *inode, const struct iovec *iov, loff_t offset,
2443                 unsigned long nr_segs, get_block_t get_block)
2444 {
2445         return __blockdev_direct_IO(rw, iocb, inode, inode->i_sb->s_bdev, iov,
2446                                     offset, nr_segs, get_block, NULL, NULL,
2447                                     DIO_LOCKING | DIO_SKIP_HOLES);
2448 }
2449 #else
2450 static inline void inode_dio_wait(struct inode *inode)
2451 {
2452 }
2453 #endif
2454
2455 extern const struct file_operations generic_ro_fops;
2456
2457 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2458
2459 extern int vfs_readlink(struct dentry *, char __user *, int, const char *);
2460 extern int vfs_follow_link(struct nameidata *, const char *);
2461 extern int page_readlink(struct dentry *, char __user *, int);
2462 extern void *page_follow_link_light(struct dentry *, struct nameidata *);
2463 extern void page_put_link(struct dentry *, struct nameidata *, void *);
2464 extern int __page_symlink(struct inode *inode, const char *symname, int len,
2465                 int nofs);
2466 extern int page_symlink(struct inode *inode, const char *symname, int len);
2467 extern const struct inode_operations page_symlink_inode_operations;
2468 extern int generic_readlink(struct dentry *, char __user *, int);
2469 extern void generic_fillattr(struct inode *, struct kstat *);
2470 extern int vfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
2471 void __inode_add_bytes(struct inode *inode, loff_t bytes);
2472 void inode_add_bytes(struct inode *inode, loff_t bytes);
2473 void inode_sub_bytes(struct inode *inode, loff_t bytes);
2474 loff_t inode_get_bytes(struct inode *inode);
2475 void inode_set_bytes(struct inode *inode, loff_t bytes);
2476
2477 extern int vfs_readdir(struct file *, filldir_t, void *);
2478
2479 extern int vfs_stat(const char __user *, struct kstat *);
2480 extern int vfs_lstat(const char __user *, struct kstat *);
2481 extern int vfs_fstat(unsigned int, struct kstat *);
2482 extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
2483
2484 extern int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
2485                     unsigned long arg);
2486 extern int __generic_block_fiemap(struct inode *inode,
2487                                   struct fiemap_extent_info *fieinfo,
2488                                   loff_t start, loff_t len,
2489                                   get_block_t *get_block);
2490 extern int generic_block_fiemap(struct inode *inode,
2491                                 struct fiemap_extent_info *fieinfo, u64 start,
2492                                 u64 len, get_block_t *get_block);
2493
2494 extern void get_filesystem(struct file_system_type *fs);
2495 extern void put_filesystem(struct file_system_type *fs);
2496 extern struct file_system_type *get_fs_type(const char *name);
2497 extern struct super_block *get_super(struct block_device *);
2498 extern struct super_block *get_active_super(struct block_device *bdev);
2499 extern struct super_block *user_get_super(dev_t);
2500 extern void drop_super(struct super_block *sb);
2501 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
2502 extern void iterate_supers_type(struct file_system_type *,
2503                                 void (*)(struct super_block *, void *), void *);
2504
2505 extern int dcache_dir_open(struct inode *, struct file *);
2506 extern int dcache_dir_close(struct inode *, struct file *);
2507 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
2508 extern int dcache_readdir(struct file *, void *, filldir_t);
2509 extern int simple_setattr(struct dentry *, struct iattr *);
2510 extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
2511 extern int simple_statfs(struct dentry *, struct kstatfs *);
2512 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2513 extern int simple_unlink(struct inode *, struct dentry *);
2514 extern int simple_rmdir(struct inode *, struct dentry *);
2515 extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
2516 extern int noop_fsync(struct file *, loff_t, loff_t, int);
2517 extern int simple_empty(struct dentry *);
2518 extern int simple_readpage(struct file *file, struct page *page);
2519 extern int simple_write_begin(struct file *file, struct address_space *mapping,
2520                         loff_t pos, unsigned len, unsigned flags,
2521                         struct page **pagep, void **fsdata);
2522 extern int simple_write_end(struct file *file, struct address_space *mapping,
2523                         loff_t pos, unsigned len, unsigned copied,
2524                         struct page *page, void *fsdata);
2525
2526 extern struct dentry *simple_lookup(struct inode *, struct dentry *, struct nameidata *);
2527 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
2528 extern const struct file_operations simple_dir_operations;
2529 extern const struct inode_operations simple_dir_inode_operations;
2530 struct tree_descr { char *name; const struct file_operations *ops; int mode; };
2531 struct dentry *d_alloc_name(struct dentry *, const char *);
2532 extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
2533 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
2534 extern void simple_release_fs(struct vfsmount **mount, int *count);
2535
2536 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2537                         loff_t *ppos, const void *from, size_t available);
2538 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
2539                 const void __user *from, size_t count);
2540
2541 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
2542
2543 extern int generic_check_addressable(unsigned, u64);
2544
2545 #ifdef CONFIG_MIGRATION
2546 extern int buffer_migrate_page(struct address_space *,
2547                                 struct page *, struct page *);
2548 #else
2549 #define buffer_migrate_page NULL
2550 #endif
2551
2552 extern int inode_change_ok(const struct inode *, struct iattr *);
2553 extern int inode_newsize_ok(const struct inode *, loff_t offset);
2554 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
2555
2556 extern void file_update_time(struct file *file);
2557
2558 extern int generic_show_options(struct seq_file *m, struct vfsmount *mnt);
2559 extern void save_mount_options(struct super_block *sb, char *options);
2560 extern void replace_mount_options(struct super_block *sb, char *options);
2561
2562 static inline ino_t parent_ino(struct dentry *dentry)
2563 {
2564         ino_t res;
2565
2566         /*
2567          * Don't strictly need d_lock here? If the parent ino could change
2568          * then surely we'd have a deeper race in the caller?
2569          */
2570         spin_lock(&dentry->d_lock);
2571         res = dentry->d_parent->d_inode->i_ino;
2572         spin_unlock(&dentry->d_lock);
2573         return res;
2574 }
2575
2576 /* Transaction based IO helpers */
2577
2578 /*
2579  * An argresp is stored in an allocated page and holds the
2580  * size of the argument or response, along with its content
2581  */
2582 struct simple_transaction_argresp {
2583         ssize_t size;
2584         char data[0];
2585 };
2586
2587 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
2588
2589 char *simple_transaction_get(struct file *file, const char __user *buf,
2590                                 size_t size);
2591 ssize_t simple_transaction_read(struct file *file, char __user *buf,
2592                                 size_t size, loff_t *pos);
2593 int simple_transaction_release(struct inode *inode, struct file *file);
2594
2595 void simple_transaction_set(struct file *file, size_t n);
2596
2597 /*
2598  * simple attribute files
2599  *
2600  * These attributes behave similar to those in sysfs:
2601  *
2602  * Writing to an attribute immediately sets a value, an open file can be
2603  * written to multiple times.
2604  *
2605  * Reading from an attribute creates a buffer from the value that might get
2606  * read with multiple read calls. When the attribute has been read
2607  * completely, no further read calls are possible until the file is opened
2608  * again.
2609  *
2610  * All attributes contain a text representation of a numeric value
2611  * that are accessed with the get() and set() functions.
2612  */
2613 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)            \
2614 static int __fops ## _open(struct inode *inode, struct file *file)      \
2615 {                                                                       \
2616         __simple_attr_check_format(__fmt, 0ull);                        \
2617         return simple_attr_open(inode, file, __get, __set, __fmt);      \
2618 }                                                                       \
2619 static const struct file_operations __fops = {                          \
2620         .owner   = THIS_MODULE,                                         \
2621         .open    = __fops ## _open,                                     \
2622         .release = simple_attr_release,                                 \
2623         .read    = simple_attr_read,                                    \
2624         .write   = simple_attr_write,                                   \
2625         .llseek  = generic_file_llseek,                                 \
2626 };
2627
2628 static inline void __attribute__((format(printf, 1, 2)))
2629 __simple_attr_check_format(const char *fmt, ...)
2630 {
2631         /* don't do anything, just let the compiler check the arguments; */
2632 }
2633
2634 int simple_attr_open(struct inode *inode, struct file *file,
2635                      int (*get)(void *, u64 *), int (*set)(void *, u64),
2636                      const char *fmt);
2637 int simple_attr_release(struct inode *inode, struct file *file);
2638 ssize_t simple_attr_read(struct file *file, char __user *buf,
2639                          size_t len, loff_t *ppos);
2640 ssize_t simple_attr_write(struct file *file, const char __user *buf,
2641                           size_t len, loff_t *ppos);
2642
2643 struct ctl_table;
2644 int proc_nr_files(struct ctl_table *table, int write,
2645                   void __user *buffer, size_t *lenp, loff_t *ppos);
2646 int proc_nr_dentry(struct ctl_table *table, int write,
2647                   void __user *buffer, size_t *lenp, loff_t *ppos);
2648 int proc_nr_inodes(struct ctl_table *table, int write,
2649                    void __user *buffer, size_t *lenp, loff_t *ppos);
2650 int __init get_filesystem_list(char *buf);
2651
2652 #define __FMODE_EXEC            ((__force int) FMODE_EXEC)
2653 #define __FMODE_NONOTIFY        ((__force int) FMODE_NONOTIFY)
2654
2655 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
2656 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
2657                                             (flag & __FMODE_NONOTIFY)))
2658
2659 static inline int is_sxid(mode_t mode)
2660 {
2661         return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
2662 }
2663
2664 static inline void inode_has_no_xattr(struct inode *inode)
2665 {
2666         if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
2667                 inode->i_flags |= S_NOSEC;
2668 }
2669
2670 #endif /* __KERNEL__ */
2671 #endif /* _LINUX_FS_H */