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