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