blob: 018d382f6f92beebf4d3ee22d0166541bd8f53b6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#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
David Howells01bf4662006-07-10 04:44:53 -070029#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 */
Chris Snook1ae70752007-05-08 00:24:15 -070032#define SEEK_MAX SEEK_END
David Howells01bf4662006-07-10 04:44:53 -070033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034/* 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};
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41struct inodes_stat_t {
42 int nr_inodes;
43 int nr_unused;
Stefan Richter9e7bf242007-07-15 23:40:25 -070044 int dummy[5]; /* padding for sysctl ABI compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045};
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
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
Al Viroe6305c42008-07-15 21:03:57 -040054#define MAY_ACCESS 16
Al Viroa1103432008-07-17 09:19:08 -040055#define MAY_OPEN 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Paul Turner55ec8212009-02-18 14:48:15 -080057/*
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
Christoph Hellwigfc9161e2008-11-05 14:58:46 +010062/* file is open for reading */
Andrew Morton19adf9c2010-03-05 13:42:03 -080063#define FMODE_READ ((__force fmode_t)0x1)
Christoph Hellwigfc9161e2008-11-05 14:58:46 +010064/* file is open for writing */
Andrew Morton19adf9c2010-03-05 13:42:03 -080065#define FMODE_WRITE ((__force fmode_t)0x2)
Christoph Hellwigfc9161e2008-11-05 14:58:46 +010066/* file is seekable */
Andrew Morton19adf9c2010-03-05 13:42:03 -080067#define FMODE_LSEEK ((__force fmode_t)0x4)
Paul Turner55ec8212009-02-18 14:48:15 -080068/* file can be accessed using pread */
Andrew Morton19adf9c2010-03-05 13:42:03 -080069#define FMODE_PREAD ((__force fmode_t)0x8)
Paul Turner55ec8212009-02-18 14:48:15 -080070/* file can be accessed using pwrite */
Andrew Morton19adf9c2010-03-05 13:42:03 -080071#define FMODE_PWRITE ((__force fmode_t)0x10)
Christoph Hellwigfc9161e2008-11-05 14:58:46 +010072/* File is opened for execution with sys_execve / sys_uselib */
Andrew Morton19adf9c2010-03-05 13:42:03 -080073#define FMODE_EXEC ((__force fmode_t)0x20)
Christoph Hellwigfc9161e2008-11-05 14:58:46 +010074/* File is opened with O_NDELAY (only set for block devices) */
Andrew Morton19adf9c2010-03-05 13:42:03 -080075#define FMODE_NDELAY ((__force fmode_t)0x40)
Christoph Hellwigfc9161e2008-11-05 14:58:46 +010076/* File is opened with O_EXCL (only set for block devices) */
Andrew Morton19adf9c2010-03-05 13:42:03 -080077#define FMODE_EXCL ((__force fmode_t)0x80)
Christoph Hellwigfc9161e2008-11-05 14:58:46 +010078/* File is opened using open(.., 3, ..) and is writeable only for ioctls
79 (specialy hack for floppy.c) */
Andrew Morton19adf9c2010-03-05 13:42:03 -080080#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
Oleg Drokinb5005312006-03-25 03:07:01 -080081
Christoph Hellwig4d4be482008-12-09 04:47:33 -050082/*
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 */
Andrew Morton19adf9c2010-03-05 13:42:03 -080088#define FMODE_NOCMTIME ((__force fmode_t)0x800)
Christoph Hellwig4d4be482008-12-09 04:47:33 -050089
Wu Fengguang01414502010-03-05 13:42:03 -080090/* Expect random access pattern */
Andrew Morton19adf9c2010-03-05 13:42:03 -080091#define FMODE_RANDOM ((__force fmode_t)0x1000)
Wu Fengguang01414502010-03-05 13:42:03 -080092
Jens Axboe48e70bc2009-04-14 08:19:27 +020093/*
94 * The below are the various read and write types that we support. Some of
95 * them include behavioral modifiers that send information down to the
96 * block layer and IO scheduler. Terminology:
97 *
98 * The block layer uses device plugging to defer IO a little bit, in
99 * the hope that we will see more IO very shortly. This increases
100 * coalescing of adjacent IO and thus reduces the number of IOs we
101 * have to send to the device. It also allows for better queuing,
102 * if the IO isn't mergeable. If the caller is going to be waiting
103 * for the IO, then he must ensure that the device is unplugged so
104 * that the IO is dispatched to the driver.
105 *
106 * All IO is handled async in Linux. This is fine for background
107 * writes, but for reads or writes that someone waits for completion
108 * on, we want to notify the block layer and IO scheduler so that they
109 * know about it. That allows them to make better scheduling
110 * decisions. So when the below references 'sync' and 'async', it
111 * is referencing this priority hint.
112 *
113 * With that in mind, the available types are:
114 *
115 * READ A normal read operation. Device will be plugged.
116 * READ_SYNC A synchronous read. Device is not plugged, caller can
117 * immediately wait on this read without caring about
118 * unplugging.
119 * READA Used for read-ahead operations. Lower priority, and the
120 * block layer could (in theory) choose to ignore this
121 * request if it runs into resource problems.
122 * WRITE A normal async write. Device will be plugged.
123 * SWRITE Like WRITE, but a special case for ll_rw_block() that
124 * tells it to lock the buffer first. Normally a buffer
125 * must be locked before doing IO.
126 * WRITE_SYNC_PLUG Synchronous write. Identical to WRITE, but passes down
127 * the hint that someone will be waiting on this IO
128 * shortly. The device must still be unplugged explicitly,
129 * WRITE_SYNC_PLUG does not do this as we could be
130 * submitting more writes before we actually wait on any
131 * of them.
132 * WRITE_SYNC Like WRITE_SYNC_PLUG, but also unplugs the device
133 * immediately after submission. The write equivalent
134 * of READ_SYNC.
Vivek Goyald9449ce2009-11-26 09:45:40 +0100135 * WRITE_ODIRECT_PLUG Special case write for O_DIRECT only.
Jens Axboe48e70bc2009-04-14 08:19:27 +0200136 * SWRITE_SYNC
137 * SWRITE_SYNC_PLUG Like WRITE_SYNC/WRITE_SYNC_PLUG, but locks the buffer.
138 * See SWRITE.
139 * WRITE_BARRIER Like WRITE, but tells the block layer that all
140 * previously submitted writes must be safely on storage
141 * before this one is started. Also guarantees that when
142 * this write is complete, it itself is also safely on
143 * storage. Prevents reordering of writes on both sides
144 * of this IO.
145 *
146 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147#define RW_MASK 1
148#define RWA_MASK 2
149#define READ 0
150#define WRITE 1
151#define READA 2 /* read-ahead - don't block if no resources */
Jan Karaa7662232005-09-06 15:19:10 -0700152#define SWRITE 3 /* for ll_rw_block() - wait for buffer lock */
Jens Axboe93dbb392009-02-16 10:25:40 +0100153#define READ_SYNC (READ | (1 << BIO_RW_SYNCIO) | (1 << BIO_RW_UNPLUG))
Jens Axboe5404bc72006-08-10 09:01:02 +0200154#define READ_META (READ | (1 << BIO_RW_META))
Jens Axboeaeb6faf2009-04-06 14:48:07 +0200155#define WRITE_SYNC_PLUG (WRITE | (1 << BIO_RW_SYNCIO) | (1 << BIO_RW_NOIDLE))
156#define WRITE_SYNC (WRITE_SYNC_PLUG | (1 << BIO_RW_UNPLUG))
Vivek Goyald9449ce2009-11-26 09:45:40 +0100157#define WRITE_ODIRECT_PLUG (WRITE | (1 << BIO_RW_SYNCIO))
Dave Chinner2ee1aba2009-11-24 18:03:15 +0000158#define WRITE_META (WRITE | (1 << BIO_RW_META))
Jens Axboea1f24252009-04-06 14:48:02 +0200159#define SWRITE_SYNC_PLUG \
Jens Axboeaeb6faf2009-04-06 14:48:07 +0200160 (SWRITE | (1 << BIO_RW_SYNCIO) | (1 << BIO_RW_NOIDLE))
161#define SWRITE_SYNC (SWRITE_SYNC_PLUG | (1 << BIO_RW_UNPLUG))
David Woodhousefb2dce82008-08-05 18:01:53 +0100162#define WRITE_BARRIER (WRITE | (1 << BIO_RW_BARRIER))
Jens Axboe48e70bc2009-04-14 08:19:27 +0200163
164/*
165 * These aren't really reads or writes, they pass down information about
166 * parts of device that are now unused by the file system.
167 */
David Woodhouse3d2257f2009-09-12 07:35:37 +0200168#define DISCARD_NOBARRIER (WRITE | (1 << BIO_RW_DISCARD))
169#define DISCARD_BARRIER (DISCARD_NOBARRIER | (1 << BIO_RW_BARRIER))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171#define SEL_IN 1
172#define SEL_OUT 2
173#define SEL_EX 4
174
175/* public flags for file_system_type */
176#define FS_REQUIRES_DEV 1
177#define FS_BINARY_MOUNTDATA 2
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -0700178#define FS_HAS_SUBTYPE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179#define FS_REVAL_DOT 16384 /* Check the paths ".", ".." for staleness */
Mark Fasheh349457c2006-09-08 14:22:21 -0700180#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move()
181 * during rename() internally.
182 */
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184/*
185 * These are the fs-independent mount-flags: up to 32 flags are supported
186 */
187#define MS_RDONLY 1 /* Mount read-only */
188#define MS_NOSUID 2 /* Ignore suid and sgid bits */
189#define MS_NODEV 4 /* Disallow access to device special files */
190#define MS_NOEXEC 8 /* Disallow program execution */
191#define MS_SYNCHRONOUS 16 /* Writes are synced at once */
192#define MS_REMOUNT 32 /* Alter flags of a mounted FS */
193#define MS_MANDLOCK 64 /* Allow mandatory locks on an FS */
194#define MS_DIRSYNC 128 /* Directory modifications are synchronous */
195#define MS_NOATIME 1024 /* Do not update access times. */
196#define MS_NODIRATIME 2048 /* Do not update directory access times */
197#define MS_BIND 4096
198#define MS_MOVE 8192
199#define MS_REC 16384
Theodore Ts'o9b04c992006-03-24 03:15:10 -0800200#define MS_VERBOSE 32768 /* War is peace. Verbosity is silence.
201 MS_VERBOSE is deprecated. */
202#define MS_SILENT 32768
Miklos Szeredibf066c72006-01-08 01:03:19 -0800203#define MS_POSIXACL (1<<16) /* VFS does not apply the umask */
Ram Pai9676f0c2005-11-07 17:21:20 -0500204#define MS_UNBINDABLE (1<<17) /* change to unbindable */
Ram Pai07b20882005-11-07 17:19:07 -0500205#define MS_PRIVATE (1<<18) /* change to private */
Ram Paia58b0eb2005-11-07 17:20:48 -0500206#define MS_SLAVE (1<<19) /* change to slave */
Ram Pai03e06e62005-11-07 17:19:33 -0500207#define MS_SHARED (1<<20) /* change to shared */
Valerie Henson47ae32d2006-12-13 00:34:34 -0800208#define MS_RELATIME (1<<21) /* Update atime relative to mtime/ctime. */
Pavel Emelyanov8bf97252007-10-18 23:40:02 -0700209#define MS_KERNMOUNT (1<<22) /* this is a kern_mount call */
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500210#define MS_I_VERSION (1<<23) /* Update inode I_version field */
Matthew Garrettd0adde52009-03-26 17:49:56 +0000211#define MS_STRICTATIME (1<<24) /* Always perform atime updates */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212#define MS_ACTIVE (1<<30)
213#define MS_NOUSER (1<<31)
214
215/*
216 * Superblock flags that can be altered by MS_REMOUNT
217 */
Mimi Zohar08b9fe62008-10-13 00:09:50 -0400218#define MS_RMT_MASK (MS_RDONLY|MS_SYNCHRONOUS|MS_MANDLOCK|MS_I_VERSION)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220/*
221 * Old magic mount flag and mask
222 */
223#define MS_MGC_VAL 0xC0ED0000
224#define MS_MGC_MSK 0xffff0000
225
226/* Inode flags - they have nothing to superblock flags now */
227
228#define S_SYNC 1 /* Writes are synced at once */
229#define S_NOATIME 2 /* Do not update access times */
230#define S_APPEND 4 /* Append-only file */
231#define S_IMMUTABLE 8 /* Immutable file */
232#define S_DEAD 16 /* removed, but still open directory */
233#define S_NOQUOTA 32 /* Inode is not counted to quota */
234#define S_DIRSYNC 64 /* Directory modifications are synchronous */
235#define S_NOCMTIME 128 /* Do not update file c/mtime */
236#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
237#define S_PRIVATE 512 /* Inode is fs-internal */
238
239/*
240 * Note that nosuid etc flags are inode-specific: setting some file-system
241 * flags just means all the inodes inherit those flags by default. It might be
242 * possible to override it selectively if you really wanted to with some
243 * ioctl() that is not currently implemented.
244 *
245 * Exception: MS_RDONLY is always applied to the entire file system.
246 *
247 * Unfortunately, it is possible to change a filesystems flags with it mounted
248 * with files in use. This means that all of the inodes will not have their
249 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
250 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
251 */
252#define __IS_FLG(inode,flg) ((inode)->i_sb->s_flags & (flg))
253
254#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
255#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
256 ((inode)->i_flags & S_SYNC))
257#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
258 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
259#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
Eric Dumazet37756ce2007-02-10 01:44:49 -0800260#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500261#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
264#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
265#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
267
268#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
269#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
270#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
271#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
272
273/* the read-only stuff doesn't really belong here, but any other place is
274 probably as bad and I don't want to create yet another include file. */
275
276#define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */
277#define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */
278#define BLKRRPART _IO(0x12,95) /* re-read partition table */
279#define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
280#define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */
281#define BLKRASET _IO(0x12,98) /* set read ahead for block device */
282#define BLKRAGET _IO(0x12,99) /* get current read ahead setting */
283#define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
284#define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
285#define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
286#define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
287#define BLKSSZGET _IO(0x12,104)/* get block device sector size */
288#if 0
289#define BLKPG _IO(0x12,105)/* See blkpg.h */
290
291/* Some people are morons. Do not use sizeof! */
292
293#define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */
294#define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */
295/* This was here just to show that the number is taken -
296 probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
297#endif
298/* A jump here: 108-111 have been used for various private purposes. */
299#define BLKBSZGET _IOR(0x12,112,size_t)
300#define BLKBSZSET _IOW(0x12,113,size_t)
301#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
Jens Axboe2056a782006-03-23 20:00:26 +0100302#define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
303#define BLKTRACESTART _IO(0x12,116)
304#define BLKTRACESTOP _IO(0x12,117)
305#define BLKTRACETEARDOWN _IO(0x12,118)
David Woodhoused30a2602008-08-11 15:58:42 +0100306#define BLKDISCARD _IO(0x12,119)
Martin K. Petersenac481c22009-10-03 20:52:01 +0200307#define BLKIOMIN _IO(0x12,120)
308#define BLKIOOPT _IO(0x12,121)
309#define BLKALIGNOFF _IO(0x12,122)
310#define BLKPBSZGET _IO(0x12,123)
Martin K. Petersen98262f22009-12-03 09:24:48 +0100311#define BLKDISCARDZEROES _IO(0x12,124)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
313#define BMAP_IOCTL 1 /* obsolete - kept for compatibility */
314#define FIBMAP _IO(0x00,1) /* bmap access */
315#define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */
Takashi Satofcccf502009-01-09 16:40:59 -0800316#define FIFREEZE _IOWR('X', 119, int) /* Freeze */
317#define FITHAW _IOWR('X', 120, int) /* Thaw */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
David Howells36695672006-08-29 19:06:16 +0100319#define FS_IOC_GETFLAGS _IOR('f', 1, long)
320#define FS_IOC_SETFLAGS _IOW('f', 2, long)
321#define FS_IOC_GETVERSION _IOR('v', 1, long)
322#define FS_IOC_SETVERSION _IOW('v', 2, long)
Mark Fashehc4b929b2008-10-08 19:44:18 -0400323#define FS_IOC_FIEMAP _IOWR('f', 11, struct fiemap)
David Howells36695672006-08-29 19:06:16 +0100324#define FS_IOC32_GETFLAGS _IOR('f', 1, int)
325#define FS_IOC32_SETFLAGS _IOW('f', 2, int)
326#define FS_IOC32_GETVERSION _IOR('v', 1, int)
327#define FS_IOC32_SETVERSION _IOW('v', 2, int)
328
329/*
330 * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
331 */
332#define FS_SECRM_FL 0x00000001 /* Secure deletion */
333#define FS_UNRM_FL 0x00000002 /* Undelete */
334#define FS_COMPR_FL 0x00000004 /* Compress file */
335#define FS_SYNC_FL 0x00000008 /* Synchronous updates */
336#define FS_IMMUTABLE_FL 0x00000010 /* Immutable file */
337#define FS_APPEND_FL 0x00000020 /* writes to file may only append */
338#define FS_NODUMP_FL 0x00000040 /* do not dump file */
339#define FS_NOATIME_FL 0x00000080 /* do not update atime */
340/* Reserved for compression usage... */
341#define FS_DIRTY_FL 0x00000100
342#define FS_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
343#define FS_NOCOMP_FL 0x00000400 /* Don't compress */
344#define FS_ECOMPR_FL 0x00000800 /* Compression error */
345/* End compression flags --- maybe not all used */
346#define FS_BTREE_FL 0x00001000 /* btree format dir */
347#define FS_INDEX_FL 0x00001000 /* hash-indexed directory */
348#define FS_IMAGIC_FL 0x00002000 /* AFS directory */
349#define FS_JOURNAL_DATA_FL 0x00004000 /* Reserved for ext3 */
350#define FS_NOTAIL_FL 0x00008000 /* file tail should not be merged */
351#define FS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
352#define FS_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
Steven Whitehouse128e5eb2006-10-02 11:24:43 -0400353#define FS_EXTENT_FL 0x00080000 /* Extents */
354#define FS_DIRECTIO_FL 0x00100000 /* Use direct i/o */
David Howells36695672006-08-29 19:06:16 +0100355#define FS_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
356
357#define FS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
358#define FS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
359
360
Andrew Mortone46e4902006-05-22 22:35:24 -0700361#define SYNC_FILE_RANGE_WAIT_BEFORE 1
362#define SYNC_FILE_RANGE_WRITE 2
363#define SYNC_FILE_RANGE_WAIT_AFTER 4
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365#ifdef __KERNEL__
366
367#include <linux/linkage.h>
368#include <linux/wait.h>
369#include <linux/types.h>
370#include <linux/kdev_t.h>
371#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -0400372#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373#include <linux/stat.h>
374#include <linux/cache.h>
375#include <linux/kobject.h>
376#include <linux/list.h>
377#include <linux/radix-tree.h>
378#include <linux/prio_tree.h>
379#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -0400380#include <linux/pid.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800381#include <linux/mutex.h>
Satyam Sharma3bd858a2007-07-17 15:00:08 +0530382#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -0400383#include <linux/semaphore.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -0400384#include <linux/fiemap.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
386#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387#include <asm/byteorder.h>
388
Christoph Hellwiga5694252007-07-17 04:04:28 -0700389struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -0800390struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391struct iovec;
392struct nameidata;
Christoph Hellwig92198f72005-06-23 22:00:59 -0700393struct kiocb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394struct pipe_inode_info;
395struct poll_table_struct;
396struct kstatfs;
397struct vm_area_struct;
398struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +1100399struct cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
Denis Cheng74bf17c2007-10-16 23:26:30 -0700401extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402extern void __init inode_init_early(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403extern void __init files_init(unsigned long);
404
Jan Engelhardtdded4f42008-12-01 14:34:50 -0800405extern struct files_stat_struct files_stat;
406extern int get_max_files(void);
407extern int sysctl_nr_open;
408extern struct inodes_stat_t inodes_stat;
409extern int leases_enable, lease_break_time;
410#ifdef CONFIG_DNOTIFY
411extern int dir_notify_enable;
412#endif
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414struct buffer_head;
415typedef int (get_block_t)(struct inode *inode, sector_t iblock,
416 struct buffer_head *bh_result, int create);
Christoph Hellwig92198f72005-06-23 22:00:59 -0700417typedef void (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 ssize_t bytes, void *private);
419
420/*
421 * Attribute flags. These should be or-ed together to figure out what
422 * has been changed!
423 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200424#define ATTR_MODE (1 << 0)
425#define ATTR_UID (1 << 1)
426#define ATTR_GID (1 << 2)
427#define ATTR_SIZE (1 << 3)
428#define ATTR_ATIME (1 << 4)
429#define ATTR_MTIME (1 << 5)
430#define ATTR_CTIME (1 << 6)
431#define ATTR_ATIME_SET (1 << 7)
432#define ATTR_MTIME_SET (1 << 8)
433#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
434#define ATTR_ATTR_FLAG (1 << 10)
435#define ATTR_KILL_SUID (1 << 11)
436#define ATTR_KILL_SGID (1 << 12)
437#define ATTR_FILE (1 << 13)
438#define ATTR_KILL_PRIV (1 << 14)
439#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
440#define ATTR_TIMES_SET (1 << 16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442/*
443 * This is the Inode Attributes structure, used for notify_change(). It
444 * uses the above definitions as flags, to know which values have changed.
445 * Also, in this manner, a Filesystem can look at only the values it cares
446 * about. Basically, these are the attributes that the VFS layer can
447 * request to change from the FS layer.
448 *
449 * Derek Atkins <warlord@MIT.EDU> 94-10-20
450 */
451struct iattr {
452 unsigned int ia_valid;
453 umode_t ia_mode;
454 uid_t ia_uid;
455 gid_t ia_gid;
456 loff_t ia_size;
457 struct timespec ia_atime;
458 struct timespec ia_mtime;
459 struct timespec ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800460
461 /*
462 * Not an attribute, but an auxilary info for filesystems wanting to
463 * implement an ftruncate() like method. NOTE: filesystem should
464 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
465 */
466 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467};
468
469/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 * Includes for diskquotas.
471 */
472#include <linux/quota.h>
473
Zach Brown994fc28c2005-12-15 14:28:17 -0800474/**
475 * enum positive_aop_returns - aop return codes with specific semantics
476 *
477 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
478 * completed, that the page is still locked, and
479 * should be considered active. The VM uses this hint
480 * to return the page to the active list -- it won't
481 * be a candidate for writeback again in the near
482 * future. Other callers must be careful to unlock
483 * the page if they get this return. Returned by
484 * writepage();
485 *
486 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
487 * unlocked it and the page might have been truncated.
488 * The caller should back up to acquiring a new page and
489 * trying again. The aop will be taking reasonable
490 * precautions not to livelock. If the caller held a page
491 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700492 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800493 *
494 * address_space_operation functions return these large constants to indicate
495 * special semantics to the caller. These are much larger than the bytes in a
496 * page to allow for functions that return the number of bytes operated on in a
497 * given page.
498 */
499
500enum positive_aop_returns {
501 AOP_WRITEPAGE_ACTIVATE = 0x80000,
502 AOP_TRUNCATED_PAGE = 0x80001,
503};
504
Nick Pigginafddba42007-10-16 01:25:01 -0700505#define AOP_FLAG_UNINTERRUPTIBLE 0x0001 /* will not do a short write */
Nick Piggin89e10782007-10-16 01:25:07 -0700506#define AOP_FLAG_CONT_EXPAND 0x0002 /* called from cont_expand */
Nick Piggin54566b22009-01-04 12:00:53 -0800507#define AOP_FLAG_NOFS 0x0004 /* used by filesystem to direct
508 * helper code (eg buffer layer)
509 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700510
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511/*
512 * oh the beauties of C type declarations.
513 */
514struct page;
515struct address_space;
516struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Nick Piggin2f718ff2007-10-16 01:24:59 -0700518struct iov_iter {
519 const struct iovec *iov;
520 unsigned long nr_segs;
521 size_t iov_offset;
522 size_t count;
523};
524
525size_t iov_iter_copy_from_user_atomic(struct page *page,
526 struct iov_iter *i, unsigned long offset, size_t bytes);
527size_t iov_iter_copy_from_user(struct page *page,
528 struct iov_iter *i, unsigned long offset, size_t bytes);
529void iov_iter_advance(struct iov_iter *i, size_t bytes);
Nick Pigginafddba42007-10-16 01:25:01 -0700530int iov_iter_fault_in_readable(struct iov_iter *i, size_t bytes);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700531size_t iov_iter_single_seg_count(struct iov_iter *i);
532
533static inline void iov_iter_init(struct iov_iter *i,
534 const struct iovec *iov, unsigned long nr_segs,
535 size_t count, size_t written)
536{
537 i->iov = iov;
538 i->nr_segs = nr_segs;
539 i->iov_offset = 0;
540 i->count = count + written;
541
542 iov_iter_advance(i, written);
543}
544
545static inline size_t iov_iter_count(struct iov_iter *i)
546{
547 return i->count;
548}
549
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700550/*
551 * "descriptor" for what we're up to with a read.
552 * This allows us to use the same read code yet
553 * have multiple different users of the data that
554 * we read from a file.
555 *
556 * The simplest case just copies the data to user
557 * mode.
558 */
559typedef struct {
560 size_t written;
561 size_t count;
562 union {
563 char __user *buf;
564 void *data;
565 } arg;
566 int error;
567} read_descriptor_t;
568
569typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
570 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572struct address_space_operations {
573 int (*writepage)(struct page *page, struct writeback_control *wbc);
574 int (*readpage)(struct file *, struct page *);
NeilBrown3978d712006-03-26 01:37:17 -0800575 void (*sync_page)(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577 /* Write back some dirty pages from this mapping. */
578 int (*writepages)(struct address_space *, struct writeback_control *);
579
Andrew Morton4741c9f2006-03-24 03:18:11 -0800580 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 int (*set_page_dirty)(struct page *page);
582
583 int (*readpages)(struct file *filp, struct address_space *mapping,
584 struct list_head *pages, unsigned nr_pages);
585
Nick Pigginafddba42007-10-16 01:25:01 -0700586 int (*write_begin)(struct file *, struct address_space *mapping,
587 loff_t pos, unsigned len, unsigned flags,
588 struct page **pagep, void **fsdata);
589 int (*write_end)(struct file *, struct address_space *mapping,
590 loff_t pos, unsigned len, unsigned copied,
591 struct page *page, void *fsdata);
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
594 sector_t (*bmap)(struct address_space *, sector_t);
NeilBrown2ff28e22006-03-26 01:37:18 -0800595 void (*invalidatepage) (struct page *, unsigned long);
Al Viro27496a82005-10-21 03:20:48 -0400596 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 ssize_t (*direct_IO)(int, struct kiocb *, const struct iovec *iov,
598 loff_t offset, unsigned long nr_segs);
Nick Piggin70688e42008-04-28 02:13:02 -0700599 int (*get_xip_mem)(struct address_space *, pgoff_t, int,
600 void **, unsigned long *);
Christoph Lametere965f962006-02-01 03:05:41 -0800601 /* migrate the contents of a page to the specified target */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700602 int (*migratepage) (struct address_space *,
603 struct page *, struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800604 int (*launder_page) (struct page *);
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700605 int (*is_partially_uptodate) (struct page *, read_descriptor_t *,
606 unsigned long);
Andi Kleen25718732009-09-16 11:50:13 +0200607 int (*error_remove_page)(struct address_space *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608};
609
Nick Pigginafddba42007-10-16 01:25:01 -0700610/*
611 * pagecache_write_begin/pagecache_write_end must be used by general code
612 * to write into the pagecache.
613 */
614int pagecache_write_begin(struct file *, struct address_space *mapping,
615 loff_t pos, unsigned len, unsigned flags,
616 struct page **pagep, void **fsdata);
617
618int pagecache_write_end(struct file *, struct address_space *mapping,
619 loff_t pos, unsigned len, unsigned copied,
620 struct page *page, void *fsdata);
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622struct backing_dev_info;
623struct address_space {
624 struct inode *host; /* owner: inode, block_device */
625 struct radix_tree_root page_tree; /* radix tree of all pages */
Nick Piggin19fd6232008-07-25 19:45:32 -0700626 spinlock_t tree_lock; /* and lock protecting it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 unsigned int i_mmap_writable;/* count VM_SHARED mappings */
628 struct prio_tree_root i_mmap; /* tree of private and shared mappings */
629 struct list_head i_mmap_nonlinear;/*list VM_NONLINEAR mappings */
630 spinlock_t i_mmap_lock; /* protect tree, count, list */
631 unsigned int truncate_count; /* Cover race condition with truncate */
632 unsigned long nrpages; /* number of total pages */
633 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700634 const struct address_space_operations *a_ops; /* methods */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 unsigned long flags; /* error bits/gfp mask */
636 struct backing_dev_info *backing_dev_info; /* device readahead, etc */
637 spinlock_t private_lock; /* for use by the address_space */
638 struct list_head private_list; /* ditto */
639 struct address_space *assoc_mapping; /* ditto */
640} __attribute__((aligned(sizeof(long))));
641 /*
642 * On most architectures that alignment is already the case; but
643 * must be enforced here for CRIS, to let the least signficant bit
644 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
645 */
646
647struct block_device {
648 dev_t bd_dev; /* not a kdev_t - it's a search key */
649 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500650 struct super_block * bd_super;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 int bd_openers;
Arjan van de Venc039e312006-03-23 03:00:28 -0800652 struct mutex bd_mutex; /* open/close mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 struct list_head bd_inodes;
654 void * bd_holder;
655 int bd_holders;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800656#ifdef CONFIG_SYSFS
657 struct list_head bd_holder_list;
658#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 struct block_device * bd_contains;
660 unsigned bd_block_size;
661 struct hd_struct * bd_part;
662 /* number of times partitions within this device have been opened. */
663 unsigned bd_part_count;
664 int bd_invalidated;
665 struct gendisk * bd_disk;
666 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 /*
668 * Private data. You must have bd_claim'ed the block_device
669 * to use this. NOTE: bd_claim allows an owner to claim
670 * the same device multiple times, the owner must take special
671 * care to not mess up bd_private for that case.
672 */
673 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800674
675 /* The counter of freeze processes */
676 int bd_fsfreeze_count;
677 /* Mutex for freeze */
678 struct mutex bd_fsfreeze_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679};
680
681/*
682 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
683 * radix trees
684 */
685#define PAGECACHE_TAG_DIRTY 0
686#define PAGECACHE_TAG_WRITEBACK 1
687
688int mapping_tagged(struct address_space *mapping, int tag);
689
690/*
691 * Might pages of this file be mapped into userspace?
692 */
693static inline int mapping_mapped(struct address_space *mapping)
694{
695 return !prio_tree_empty(&mapping->i_mmap) ||
696 !list_empty(&mapping->i_mmap_nonlinear);
697}
698
699/*
700 * Might pages of this file have been modified in userspace?
701 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
702 * marks vma as VM_SHARED if it is shared, and the file was opened for
703 * writing i.e. vma may be mprotected writable even if now readonly.
704 */
705static inline int mapping_writably_mapped(struct address_space *mapping)
706{
707 return mapping->i_mmap_writable != 0;
708}
709
710/*
711 * Use sequence counter to get consistent i_size on 32-bit processors.
712 */
713#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
714#include <linux/seqlock.h>
715#define __NEED_I_SIZE_ORDERED
716#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
717#else
718#define i_size_ordered_init(inode) do { } while (0)
719#endif
720
Al Virof19d4a82009-06-08 19:50:45 -0400721struct posix_acl;
722#define ACL_NOT_CACHED ((void *)(-1))
723
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724struct inode {
725 struct hlist_node i_hash;
Jens Axboe66f3b8e2009-09-02 09:19:46 +0200726 struct list_head i_list; /* backing dev IO list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 struct list_head i_sb_list;
728 struct list_head i_dentry;
729 unsigned long i_ino;
730 atomic_t i_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 unsigned int i_nlink;
732 uid_t i_uid;
733 gid_t i_gid;
734 dev_t i_rdev;
Richard Kennedy4e70af52010-02-15 11:16:11 +0000735 unsigned int i_blkbits;
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500736 u64 i_version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 loff_t i_size;
Eric Dumazet83b7b442006-12-06 20:38:53 -0800738#ifdef __NEED_I_SIZE_ORDERED
739 seqcount_t i_size_seqcount;
740#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 struct timespec i_atime;
742 struct timespec i_mtime;
743 struct timespec i_ctime;
Takashi Satoa0f62ac2006-03-26 01:37:52 -0800744 blkcnt_t i_blocks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 unsigned short i_bytes;
Arnaldo Carvalho de Melo12d40e42006-12-06 20:39:53 -0800746 umode_t i_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800748 struct mutex i_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 struct rw_semaphore i_alloc_sem;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800750 const struct inode_operations *i_op;
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800751 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 struct super_block *i_sb;
753 struct file_lock *i_flock;
754 struct address_space *i_mapping;
755 struct address_space i_data;
756#ifdef CONFIG_QUOTA
757 struct dquot *i_dquot[MAXQUOTAS];
758#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700760 union {
761 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700762 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700763 struct cdev *i_cdev;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700764 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
766 __u32 i_generation;
767
Eric Paris3be25f42009-05-21 17:01:26 -0400768#ifdef CONFIG_FSNOTIFY
769 __u32 i_fsnotify_mask; /* all events this inode cares about */
770 struct hlist_head i_fsnotify_mark_entries; /* fsnotify mark entries */
771#endif
772
Robert Love0eeca282005-07-12 17:06:03 -0400773#ifdef CONFIG_INOTIFY
774 struct list_head inotify_watches; /* watches on this inode */
Ingo Molnard4f9af92006-03-23 03:00:30 -0800775 struct mutex inotify_mutex; /* protects the watches list */
Robert Love0eeca282005-07-12 17:06:03 -0400776#endif
777
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 unsigned long i_state;
779 unsigned long dirtied_when; /* jiffies of first dirtying */
780
781 unsigned int i_flags;
782
783 atomic_t i_writecount;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700784#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 void *i_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700786#endif
Al Virof19d4a82009-06-08 19:50:45 -0400787#ifdef CONFIG_FS_POSIX_ACL
788 struct posix_acl *i_acl;
789 struct posix_acl *i_default_acl;
790#endif
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700791 void *i_private; /* fs or device private pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792};
793
794/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700795 * inode->i_mutex nesting subclasses for the lock validator:
796 *
797 * 0: the object of the current VFS operation
798 * 1: parent
799 * 2: child/target
800 * 3: quota file
801 *
802 * The locking order between these classes is
Ingo Molnar4df46242006-08-27 01:23:56 -0700803 * parent -> child -> normal -> xattr -> quota
Ingo Molnarf2eace22006-07-03 00:25:05 -0700804 */
805enum inode_i_mutex_lock_class
806{
807 I_MUTEX_NORMAL,
808 I_MUTEX_PARENT,
809 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700810 I_MUTEX_XATTR,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700811 I_MUTEX_QUOTA
812};
813
814/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 * NOTE: in a 32bit arch with a preemptable kernel and
816 * an UP compile the i_size_read/write must be atomic
817 * with respect to the local cpu (unlike with preempt disabled),
818 * but they don't need to be atomic with respect to other cpus like in
819 * true SMP (so they need either to either locally disable irq around
820 * the read or for example on x86 they can be still implemented as a
821 * cmpxchg8b without the need of the lock prefix). For SMP compiles
822 * and 64bit archs it makes no difference if preempt is enabled or not.
823 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800824static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
826#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
827 loff_t i_size;
828 unsigned int seq;
829
830 do {
831 seq = read_seqcount_begin(&inode->i_size_seqcount);
832 i_size = inode->i_size;
833 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
834 return i_size;
835#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
836 loff_t i_size;
837
838 preempt_disable();
839 i_size = inode->i_size;
840 preempt_enable();
841 return i_size;
842#else
843 return inode->i_size;
844#endif
845}
846
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700847/*
848 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
849 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
850 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
851 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852static inline void i_size_write(struct inode *inode, loff_t i_size)
853{
854#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
855 write_seqcount_begin(&inode->i_size_seqcount);
856 inode->i_size = i_size;
857 write_seqcount_end(&inode->i_size_seqcount);
858#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
859 preempt_disable();
860 inode->i_size = i_size;
861 preempt_enable();
862#else
863 inode->i_size = i_size;
864#endif
865}
866
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800867static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868{
869 return MINOR(inode->i_rdev);
870}
871
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800872static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873{
874 return MAJOR(inode->i_rdev);
875}
876
877extern struct block_device *I_BDEV(struct inode *inode);
878
879struct fown_struct {
880 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700881 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
882 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 uid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 int signum; /* posix.1b rt signal to be delivered on IO */
885};
886
887/*
888 * Track a single file's readahead state
889 */
890struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700891 pgoff_t start; /* where readahead started */
892 unsigned int size; /* # of readahead pages */
893 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700894 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700895
Fengguang Wu937085a2007-10-16 01:24:31 -0700896 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700897 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700898 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Fengguang Wu5ce11102007-07-19 01:47:59 -0700901/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700902 * Check if @index falls in the readahead windows.
903 */
904static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
905{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700906 return (index >= ra->start &&
907 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700908}
909
Dave Hansenad775f52008-02-15 14:38:01 -0800910#define FILE_MNT_WRITE_TAKEN 1
911#define FILE_MNT_WRITE_RELEASED 2
912
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800914 /*
915 * fu_list becomes invalid after file_free is called and queued via
916 * fu_rcuhead for RCU freeing
917 */
918 union {
919 struct list_head fu_list;
920 struct rcu_head fu_rcuhead;
921 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800922 struct path f_path;
923#define f_dentry f_path.dentry
924#define f_vfsmnt f_path.mnt
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800925 const struct file_operations *f_op;
Jonathan Corbet4a6a4492009-03-27 12:24:31 -0600926 spinlock_t f_lock; /* f_ep_links, f_flags, no IRQ */
Al Viro516e0cc2008-07-26 00:39:17 -0400927 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400929 fmode_t f_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 loff_t f_pos;
931 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100932 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 struct file_ra_state f_ra;
934
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700935 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700936#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700938#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 /* needed for tty driver, and maybe others */
940 void *private_data;
941
942#ifdef CONFIG_EPOLL
943 /* Used by fs/eventpoll.c to link all the hooks to this file */
944 struct list_head f_ep_links;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945#endif /* #ifdef CONFIG_EPOLL */
946 struct address_space *f_mapping;
Dave Hansenad775f52008-02-15 14:38:01 -0800947#ifdef CONFIG_DEBUG_WRITECOUNT
948 unsigned long f_mnt_write_state;
949#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950};
951extern spinlock_t files_lock;
952#define file_list_lock() spin_lock(&files_lock);
953#define file_list_unlock() spin_unlock(&files_lock);
954
Al Viro516e0cc2008-07-26 00:39:17 -0400955#define get_file(x) atomic_long_inc(&(x)->f_count)
956#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Dave Hansenad775f52008-02-15 14:38:01 -0800958#ifdef CONFIG_DEBUG_WRITECOUNT
959static inline void file_take_write(struct file *f)
960{
961 WARN_ON(f->f_mnt_write_state != 0);
962 f->f_mnt_write_state = FILE_MNT_WRITE_TAKEN;
963}
964static inline void file_release_write(struct file *f)
965{
966 f->f_mnt_write_state |= FILE_MNT_WRITE_RELEASED;
967}
968static inline void file_reset_write(struct file *f)
969{
970 f->f_mnt_write_state = 0;
971}
972static inline void file_check_state(struct file *f)
973{
974 /*
975 * At this point, either both or neither of these bits
976 * should be set.
977 */
978 WARN_ON(f->f_mnt_write_state == FILE_MNT_WRITE_TAKEN);
979 WARN_ON(f->f_mnt_write_state == FILE_MNT_WRITE_RELEASED);
980}
981static inline int file_check_writeable(struct file *f)
982{
983 if (f->f_mnt_write_state == FILE_MNT_WRITE_TAKEN)
984 return 0;
985 printk(KERN_WARNING "writeable file with no "
986 "mnt_want_write()\n");
987 WARN_ON(1);
988 return -EINVAL;
989}
990#else /* !CONFIG_DEBUG_WRITECOUNT */
991static inline void file_take_write(struct file *filp) {}
992static inline void file_release_write(struct file *filp) {}
993static inline void file_reset_write(struct file *filp) {}
994static inline void file_check_state(struct file *filp) {}
995static inline int file_check_writeable(struct file *filp)
996{
997 return 0;
998}
999#endif /* CONFIG_DEBUG_WRITECOUNT */
1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001#define MAX_NON_LFS ((1UL<<31) - 1)
1002
1003/* Page cache limit. The filesystems should put that into their s_maxbytes
1004 limits, otherwise bad things can happen in VM. */
1005#if BITS_PER_LONG==32
1006#define MAX_LFS_FILESIZE (((u64)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1)
1007#elif BITS_PER_LONG==64
1008#define MAX_LFS_FILESIZE 0x7fffffffffffffffUL
1009#endif
1010
1011#define FL_POSIX 1
1012#define FL_FLOCK 2
1013#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -04001014#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001016#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017#define FL_SLEEP 128 /* A blocking lock */
1018
1019/*
Miklos Szeredibde74e42008-07-25 01:48:57 -07001020 * Special return value from posix_lock_file() and vfs_lock_file() for
1021 * asynchronous locking.
1022 */
1023#define FILE_LOCK_DEFERRED 1
1024
1025/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 * The POSIX file lock owner is determined by
1027 * the "struct files_struct" in the thread group
1028 * (or NULL for no owner - BSD locks).
1029 *
1030 * Lockd stuffs a "host" pointer into this.
1031 */
1032typedef struct files_struct *fl_owner_t;
1033
1034struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1036 void (*fl_release_private)(struct file_lock *);
1037};
1038
1039struct lock_manager_operations {
1040 int (*fl_compare_owner)(struct file_lock *, struct file_lock *);
1041 void (*fl_notify)(struct file_lock *); /* unblock callback */
Marc Eshel2beb6612006-12-05 23:31:28 -05001042 int (*fl_grant)(struct file_lock *, struct file_lock *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1044 void (*fl_release_private)(struct file_lock *);
1045 void (*fl_break)(struct file_lock *);
1046 int (*fl_mylease)(struct file_lock *, struct file_lock *);
1047 int (*fl_change)(struct file_lock **, int);
1048};
1049
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001050struct lock_manager {
1051 struct list_head list;
1052};
1053
1054void locks_start_grace(struct lock_manager *);
1055void locks_end_grace(struct lock_manager *);
1056int locks_in_grace(void);
1057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058/* that will die - we need it for nfs_lock_info */
1059#include <linux/nfs_fs_i.h>
1060
1061struct file_lock {
1062 struct file_lock *fl_next; /* singly linked list for this inode */
1063 struct list_head fl_link; /* doubly linked list of all locks */
1064 struct list_head fl_block; /* circular list of blocked processes */
1065 fl_owner_t fl_owner;
Richard Kennedyafc12462008-07-11 17:20:49 -07001066 unsigned char fl_flags;
1067 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 unsigned int fl_pid;
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00001069 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 wait_queue_head_t fl_wait;
1071 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 loff_t fl_start;
1073 loff_t fl_end;
1074
1075 struct fasync_struct * fl_fasync; /* for lease break notifications */
1076 unsigned long fl_break_time; /* for nonblocking lease breaks */
1077
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001078 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001079 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 union {
1081 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001082 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001083 struct {
1084 struct list_head link; /* link in AFS vnode's pending_locks list */
1085 int state; /* state of grant or error if -ve */
1086 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 } fl_u;
1088};
1089
1090/* The following constant reflects the upper bound of the file/locking space */
1091#ifndef OFFSET_MAX
1092#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1093#define OFFSET_MAX INT_LIMIT(loff_t)
1094#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1095#endif
1096
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097#include <linux/fcntl.h>
1098
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001099extern void send_sigio(struct fown_struct *fown, int fd, int band);
1100
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001101#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102extern int fcntl_getlk(struct file *, struct flock __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001103extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1104 struct flock __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
1106#if BITS_PER_LONG == 32
1107extern int fcntl_getlk64(struct file *, struct flock64 __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001108extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1109 struct flock64 __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110#endif
1111
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112extern 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 *);
J. Bruce Fields1a747ee2008-04-24 10:08:22 -04001118extern void __locks_copy_lock(struct file_lock *, const struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119extern void locks_remove_posix(struct file *, fl_owner_t);
1120extern void locks_remove_flock(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001121extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001122extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001123extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124extern int posix_lock_file_wait(struct file *, struct file_lock *);
J. Bruce Fields64a318e2006-01-03 09:55:46 +01001125extern int posix_unblock_lock(struct file *, struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001126extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001127extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001128extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129extern 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);
Christoph Hellwig0af1a452007-07-31 00:39:22 -07001132extern int generic_setlease(struct file *, long, struct file_lock **);
J. Bruce Fieldsa9933ce2007-06-07 17:09:49 -04001133extern int vfs_setlease(struct file *, long, struct file_lock **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134extern 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);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001137#else /* !CONFIG_FILE_LOCKING */
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001138static 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
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001149#if BITS_PER_LONG == 32
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001150static 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}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001160#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001161static 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
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001279#endif /* !CONFIG_FILE_LOCKING */
1280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
1282struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001283 spinlock_t fa_lock;
1284 int magic;
1285 int fa_fd;
1286 struct fasync_struct *fa_next; /* singly linked list */
1287 struct file *fa_file;
1288 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289};
1290
1291#define FASYNC_MAGIC 0x4601
1292
1293/* SMP safe fasync helpers: */
1294extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1295/* can be called from interrupts */
1296extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001298extern int __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299extern int f_setown(struct file *filp, unsigned long arg, int force);
1300extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001301extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302extern 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 */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001311#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1312#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
1314extern struct list_head super_blocks;
1315extern spinlock_t sb_lock;
1316
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001317#define sb_entry(list) list_entry((list), struct super_block, s_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318#define S_BIAS (1<<30)
1319struct super_block {
1320 struct list_head s_list; /* Keep this first */
1321 dev_t s_dev; /* search index; _not_ kdev_t */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 unsigned char s_dirt;
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001323 unsigned char s_blocksize_bits;
1324 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001325 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001327 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001328 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001329 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001330 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 unsigned long s_flags;
1332 unsigned long s_magic;
1333 struct dentry *s_root;
1334 struct rw_semaphore s_umount;
Ingo Molnar7892f2f42006-01-09 15:59:25 -08001335 struct mutex s_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 int s_count;
Jan Kara5cee5812009-04-27 16:43:51 +02001337 int s_need_sync;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001339#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001341#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 struct xattr_handler **s_xattr;
1343
1344 struct list_head s_inodes; /* all inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 struct hlist_head s_anon; /* anonymous dentries for (nfs) exporting */
1346 struct list_head s_files;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001347 /* s_dentry_lru and s_nr_dentry_unused are protected by dcache_lock */
1348 struct list_head s_dentry_lru; /* unused dentry lru */
1349 int s_nr_dentry_unused; /* # of dentry on lru */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
1351 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001352 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001353 struct mtd_info *s_mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 struct list_head s_instances;
1355 struct quota_info s_dquot; /* Diskquota specific options */
1356
1357 int s_frozen;
1358 wait_queue_head_t s_wait_unfrozen;
1359
1360 char s_id[32]; /* Informational name */
1361
1362 void *s_fs_info; /* Filesystem private info */
Al Viro30c40d22008-02-22 19:50:45 -05001363 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001365 /* Granularity of c/m/atime in ns.
1366 Cannot be worse than a second */
1367 u32 s_time_gran;
1368
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 /*
1370 * The next field is for VFS *only*. No filesystems have any business
1371 * even looking at it. You had been warned.
1372 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001373 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001375 /*
1376 * Filesystem subtype. If non-empty the filesystem type field
1377 * in /proc/mounts will be "type.subtype"
1378 */
1379 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001380
1381 /*
1382 * Saved mount options for lazy filesystems using
1383 * generic_show_options()
1384 */
1385 char *s_options;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386};
1387
1388extern struct timespec current_fs_time(struct super_block *sb);
1389
1390/*
1391 * Snapshotting support.
1392 */
1393enum {
1394 SB_UNFROZEN = 0,
1395 SB_FREEZE_WRITE = 1,
1396 SB_FREEZE_TRANS = 2,
1397};
1398
1399#define vfs_check_frozen(sb, level) \
1400 wait_event((sb)->s_wait_unfrozen, ((sb)->s_frozen < (level)))
1401
Al Viro914e2632006-10-18 13:55:46 -04001402#define get_fs_excl() atomic_inc(&current->fs_excl)
1403#define put_fs_excl() atomic_dec(&current->fs_excl)
1404#define has_fs_excl() atomic_read(&current->fs_excl)
Jens Axboe22e2c502005-06-27 10:55:12 +02001405
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301406#define is_owner_or_cap(inode) \
David Howellsda9592e2008-11-14 10:39:05 +11001407 ((current_fsuid() == (inode)->i_uid) || capable(CAP_FOWNER))
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301408
Al Viro914e2632006-10-18 13:55:46 -04001409/* not quite ready to be deprecated, but... */
1410extern void lock_super(struct super_block *);
1411extern void unlock_super(struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
1413/*
1414 * VFS helper functions..
1415 */
1416extern int vfs_create(struct inode *, struct dentry *, int, struct nameidata *);
1417extern int vfs_mkdir(struct inode *, struct dentry *, int);
1418extern int vfs_mknod(struct inode *, struct dentry *, int, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001419extern int vfs_symlink(struct inode *, struct dentry *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420extern int vfs_link(struct dentry *, struct inode *, struct dentry *);
1421extern int vfs_rmdir(struct inode *, struct dentry *);
1422extern int vfs_unlink(struct inode *, struct dentry *);
1423extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
1424
1425/*
1426 * VFS dentry helper functions.
1427 */
1428extern void dentry_unhash(struct dentry *dentry);
1429
1430/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001431 * VFS file helper functions.
1432 */
1433extern int file_permission(struct file *, int);
1434
1435/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001436 * VFS FS_IOC_FIEMAP helper definitions.
1437 */
1438struct fiemap_extent_info {
1439 unsigned int fi_flags; /* Flags as passed from user */
1440 unsigned int fi_extents_mapped; /* Number of mapped extents */
1441 unsigned int fi_extents_max; /* Size of fiemap_extent array */
1442 struct fiemap_extent *fi_extents_start; /* Start of fiemap_extent
1443 * array */
1444};
1445int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1446 u64 phys, u64 len, u32 flags);
1447int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1448
1449/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 * File types
1451 *
1452 * NOTE! These match bits 12..15 of stat.st_mode
1453 * (ie "(i_mode >> 12) & 15").
1454 */
1455#define DT_UNKNOWN 0
1456#define DT_FIFO 1
1457#define DT_CHR 2
1458#define DT_DIR 4
1459#define DT_BLK 6
1460#define DT_REG 8
1461#define DT_LNK 10
1462#define DT_SOCK 12
1463#define DT_WHT 14
1464
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465/*
1466 * This is the "filldir" function type, used by readdir() to let
1467 * the kernel specify what kind of dirent layout it wants to have.
1468 * This allows the kernel to read directories into kernel space or
1469 * to have different dirent layouts depending on the binary type.
1470 */
David Howellsafefdbb2006-10-03 01:13:46 -07001471typedef int (*filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
Al Viro08f85852007-10-08 13:26:20 -04001472struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474/* These macros are for out of kernel modules to test that
1475 * the kernel supports the unlocked_ioctl and compat_ioctl
1476 * fields in struct file_operations. */
1477#define HAVE_COMPAT_IOCTL 1
1478#define HAVE_UNLOCKED_IOCTL 1
1479
1480/*
1481 * NOTE:
1482 * read, write, poll, fsync, readv, writev, unlocked_ioctl and compat_ioctl
1483 * can be called without the big kernel lock held in all filesystems.
1484 */
1485struct file_operations {
1486 struct module *owner;
1487 loff_t (*llseek) (struct file *, loff_t, int);
1488 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Badari Pulavarty027445c2006-09-30 23:28:46 -07001490 ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
1491 ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 int (*readdir) (struct file *, void *, filldir_t);
1493 unsigned int (*poll) (struct file *, struct poll_table_struct *);
1494 int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long);
1495 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1496 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1497 int (*mmap) (struct file *, struct vm_area_struct *);
1498 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001499 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 int (*release) (struct inode *, struct file *);
1501 int (*fsync) (struct file *, struct dentry *, int datasync);
1502 int (*aio_fsync) (struct kiocb *, int datasync);
1503 int (*fasync) (int, struct file *, int);
1504 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1506 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1507 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001509 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1510 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
J. Bruce Fieldsf9ffed22006-11-14 15:51:40 -05001511 int (*setlease)(struct file *, long, struct file_lock **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512};
1513
1514struct inode_operations {
1515 int (*create) (struct inode *,struct dentry *,int, struct nameidata *);
1516 struct dentry * (*lookup) (struct inode *,struct dentry *, struct nameidata *);
1517 int (*link) (struct dentry *,struct inode *,struct dentry *);
1518 int (*unlink) (struct inode *,struct dentry *);
1519 int (*symlink) (struct inode *,struct dentry *,const char *);
1520 int (*mkdir) (struct inode *,struct dentry *,int);
1521 int (*rmdir) (struct inode *,struct dentry *);
1522 int (*mknod) (struct inode *,struct dentry *,int,dev_t);
1523 int (*rename) (struct inode *, struct dentry *,
1524 struct inode *, struct dentry *);
1525 int (*readlink) (struct dentry *, char __user *,int);
Linus Torvaldscc314ee2005-08-19 18:02:56 -07001526 void * (*follow_link) (struct dentry *, struct nameidata *);
1527 void (*put_link) (struct dentry *, struct nameidata *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 void (*truncate) (struct inode *);
Al Viroe6305c42008-07-15 21:03:57 -04001529 int (*permission) (struct inode *, int);
Linus Torvalds5909ccaa2009-08-28 11:51:25 -07001530 int (*check_acl)(struct inode *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 int (*setattr) (struct dentry *, struct iattr *);
1532 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
1533 int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
1534 ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
1535 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1536 int (*removexattr) (struct dentry *, const char *);
Badari Pulavartyf6b3ec22006-01-06 00:10:38 -08001537 void (*truncate_range)(struct inode *, loff_t, loff_t);
Amit Arora97ac7352007-07-17 21:42:44 -04001538 long (*fallocate)(struct inode *inode, int mode, loff_t offset,
1539 loff_t len);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001540 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1541 u64 len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542};
1543
1544struct seq_file;
1545
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001546ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1547 unsigned long nr_segs, unsigned long fast_segs,
1548 struct iovec *fast_pointer,
1549 struct iovec **ret_pointer);
1550
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1552extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1553extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1554 unsigned long, loff_t *);
1555extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1556 unsigned long, loff_t *);
1557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558struct super_operations {
1559 struct inode *(*alloc_inode)(struct super_block *sb);
1560 void (*destroy_inode)(struct inode *);
1561
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 void (*dirty_inode) (struct inode *);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001563 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 void (*drop_inode) (struct inode *);
1565 void (*delete_inode) (struct inode *);
1566 void (*put_super) (struct super_block *);
1567 void (*write_super) (struct super_block *);
1568 int (*sync_fs)(struct super_block *sb, int wait);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001569 int (*freeze_fs) (struct super_block *);
1570 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001571 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 int (*remount_fs) (struct super_block *, int *, char *);
1573 void (*clear_inode) (struct inode *);
Al Viro42faad92008-04-24 07:21:56 -04001574 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
1576 int (*show_options)(struct seq_file *, struct vfsmount *);
Chuck Leverb4629fe2006-03-20 13:44:12 -05001577 int (*show_stats)(struct seq_file *, struct vfsmount *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001578#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1580 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001581#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001582 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583};
1584
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001585/*
1586 * Inode state bits. Protected by inode_lock.
1587 *
1588 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1589 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1590 *
1591 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1592 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1593 * various stages of removing an inode.
1594 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001595 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001596 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001597 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1598 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001599 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1600 * these changes separately from I_DIRTY_SYNC so that we
1601 * don't have to write inode on fdatasync() when only
1602 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001603 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001604 * I_NEW Serves as both a mutex and completion notification.
1605 * New inodes set I_NEW. If two processes both create
1606 * the same inode, one of them will release its inode and
1607 * wait for I_NEW to be released before returning.
1608 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1609 * also cause waiting on I_NEW, without I_NEW actually
1610 * being set. find_inode() uses this to prevent returning
1611 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001612 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1613 * is zero. I_FREEING must be set when I_WILL_FREE is
1614 * cleared.
1615 * I_FREEING Set when inode is about to be freed but still has dirty
1616 * pages or buffers attached or the inode itself is still
1617 * dirty.
1618 * I_CLEAR Set by clear_inode(). In this state the inode is clean
1619 * and can be destroyed.
1620 *
1621 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1622 * prohibited for many purposes. iget() must wait for
1623 * the inode to be completely released, then create it
1624 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001625 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001626 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001627 * I_SYNC Synchonized write of dirty inode data. The bits is
1628 * set during data writeback, and cleared with a wakeup
1629 * on the bit address once it is done.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001630 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001631 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001632 */
1633#define I_DIRTY_SYNC 1
1634#define I_DIRTY_DATASYNC 2
1635#define I_DIRTY_PAGES 4
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001636#define __I_NEW 3
1637#define I_NEW (1 << __I_NEW)
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001638#define I_WILL_FREE 16
1639#define I_FREEING 32
1640#define I_CLEAR 64
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001641#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001642#define I_SYNC (1 << __I_SYNC)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
1644#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
1645
1646extern void __mark_inode_dirty(struct inode *, int);
1647static inline void mark_inode_dirty(struct inode *inode)
1648{
1649 __mark_inode_dirty(inode, I_DIRTY);
1650}
1651
1652static inline void mark_inode_dirty_sync(struct inode *inode)
1653{
1654 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1655}
1656
Dave Hansen71c42152007-06-23 17:16:42 -07001657/**
1658 * inc_nlink - directly increment an inode's link count
1659 * @inode: inode
1660 *
1661 * This is a low-level filesystem helper to replace any
1662 * direct filesystem manipulation of i_nlink. Currently,
1663 * it is only here for parity with dec_nlink().
1664 */
Dave Hansend8c76e62006-09-30 23:29:04 -07001665static inline void inc_nlink(struct inode *inode)
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001666{
1667 inode->i_nlink++;
Dave Hansend8c76e62006-09-30 23:29:04 -07001668}
1669
1670static inline void inode_inc_link_count(struct inode *inode)
1671{
1672 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001673 mark_inode_dirty(inode);
1674}
1675
Dave Hansen71c42152007-06-23 17:16:42 -07001676/**
1677 * drop_nlink - directly drop an inode's link count
1678 * @inode: inode
1679 *
1680 * This is a low-level filesystem helper to replace any
1681 * direct filesystem manipulation of i_nlink. In cases
1682 * where we are attempting to track writes to the
1683 * filesystem, a decrement to zero means an imminent
1684 * write when the file is truncated and actually unlinked
1685 * on the filesystem.
1686 */
Dave Hansen9a53c3a2006-09-30 23:29:03 -07001687static inline void drop_nlink(struct inode *inode)
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001688{
1689 inode->i_nlink--;
Dave Hansen9a53c3a2006-09-30 23:29:03 -07001690}
1691
Dave Hansen71c42152007-06-23 17:16:42 -07001692/**
1693 * clear_nlink - directly zero an inode's link count
1694 * @inode: inode
1695 *
1696 * This is a low-level filesystem helper to replace any
1697 * direct filesystem manipulation of i_nlink. See
1698 * drop_nlink() for why we care about i_nlink hitting zero.
1699 */
Dave Hansence71ec32006-09-30 23:29:06 -07001700static inline void clear_nlink(struct inode *inode)
1701{
1702 inode->i_nlink = 0;
1703}
1704
Dave Hansen9a53c3a2006-09-30 23:29:03 -07001705static inline void inode_dec_link_count(struct inode *inode)
1706{
1707 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001708 mark_inode_dirty(inode);
1709}
1710
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05001711/**
1712 * inode_inc_iversion - increments i_version
1713 * @inode: inode that need to be updated
1714 *
1715 * Every time the inode is modified, the i_version field will be incremented.
1716 * The filesystem has to be mounted with i_version flag
1717 */
1718
1719static inline void inode_inc_iversion(struct inode *inode)
1720{
1721 spin_lock(&inode->i_lock);
1722 inode->i_version++;
1723 spin_unlock(&inode->i_lock);
1724}
1725
Christoph Hellwig869243a2006-01-09 20:52:03 -08001726extern void touch_atime(struct vfsmount *mnt, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727static inline void file_accessed(struct file *file)
1728{
1729 if (!(file->f_flags & O_NOATIME))
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001730 touch_atime(file->f_path.mnt, file->f_path.dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731}
1732
1733int sync_inode(struct inode *inode, struct writeback_control *wbc);
1734
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735struct file_system_type {
1736 const char *name;
1737 int fs_flags;
David Howells454e2392006-06-23 02:02:57 -07001738 int (*get_sb) (struct file_system_type *, int,
1739 const char *, void *, struct vfsmount *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 void (*kill_sb) (struct super_block *);
1741 struct module *owner;
1742 struct file_system_type * next;
1743 struct list_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02001744
Ingo Molnarcf516242006-07-03 00:25:27 -07001745 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07001746 struct lock_class_key s_umount_key;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02001747
1748 struct lock_class_key i_lock_key;
1749 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02001750 struct lock_class_key i_mutex_dir_key;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02001751 struct lock_class_key i_alloc_sem_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752};
1753
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001754extern int get_sb_ns(struct file_system_type *fs_type, int flags, void *data,
1755 int (*fill_super)(struct super_block *, void *, int),
1756 struct vfsmount *mnt);
David Howells454e2392006-06-23 02:02:57 -07001757extern int get_sb_bdev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 int flags, const char *dev_name, void *data,
David Howells454e2392006-06-23 02:02:57 -07001759 int (*fill_super)(struct super_block *, void *, int),
1760 struct vfsmount *mnt);
1761extern int get_sb_single(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 int flags, void *data,
David Howells454e2392006-06-23 02:02:57 -07001763 int (*fill_super)(struct super_block *, void *, int),
1764 struct vfsmount *mnt);
1765extern int get_sb_nodev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 int flags, void *data,
David Howells454e2392006-06-23 02:02:57 -07001767 int (*fill_super)(struct super_block *, void *, int),
1768 struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769void generic_shutdown_super(struct super_block *sb);
1770void kill_block_super(struct super_block *sb);
1771void kill_anon_super(struct super_block *sb);
1772void kill_litter_super(struct super_block *sb);
1773void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04001774void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775int set_anon_super(struct super_block *s, void *data);
1776struct super_block *sget(struct file_system_type *type,
1777 int (*test)(struct super_block *,void *),
1778 int (*set)(struct super_block *,void *),
1779 void *data);
David Howells454e2392006-06-23 02:02:57 -07001780extern int get_sb_pseudo(struct file_system_type *, char *,
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001781 const struct super_operations *ops, unsigned long,
David Howells454e2392006-06-23 02:02:57 -07001782 struct vfsmount *mnt);
Sukadev Bhattiprolua3ec9472009-03-04 12:06:34 -08001783extern void simple_set_mnt(struct vfsmount *mnt, struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784int __put_super_and_need_restart(struct super_block *sb);
Jens Axboe03ba3782009-09-09 09:08:54 +02001785void put_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
1787/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
1788#define fops_get(fops) \
1789 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
1790#define fops_put(fops) \
1791 do { if (fops) module_put((fops)->owner); } while(0)
1792
1793extern int register_filesystem(struct file_system_type *);
1794extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07001795extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
1796#define kern_mount(type) kern_mount_data(type, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797extern int may_umount_tree(struct vfsmount *);
1798extern int may_umount(struct vfsmount *);
1799extern long do_mount(char *, char *, char *, unsigned long, void *);
Al Viro589ff872009-04-18 03:28:19 -04001800extern struct vfsmount *collect_mounts(struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04001801extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05001802extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
1803 struct vfsmount *);
David Howells726c3342006-06-23 02:02:58 -07001804extern int vfs_statfs(struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805
Al Viroce3b0f82009-03-29 19:08:22 -04001806extern int current_umask(void);
1807
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08001808/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06001809extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08001810
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001811extern int rw_verify_area(int, struct file *, loff_t *, size_t);
1812
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813#define FLOCK_VERIFY_READ 1
1814#define FLOCK_VERIFY_WRITE 2
1815
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001816#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817extern int locks_mandatory_locked(struct inode *);
1818extern int locks_mandatory_area(int, struct inode *, struct file *, loff_t, size_t);
1819
1820/*
1821 * Candidates for mandatory locking have the setgid bit set
1822 * but no group execute bit - an otherwise meaningless combination.
1823 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001824
1825static inline int __mandatory_lock(struct inode *ino)
1826{
1827 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
1828}
1829
1830/*
1831 * ... and these candidates should be on MS_MANDLOCK mounted fs,
1832 * otherwise these will be advisory locks
1833 */
1834
1835static inline int mandatory_lock(struct inode *ino)
1836{
1837 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
1838}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839
1840static inline int locks_verify_locked(struct inode *inode)
1841{
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001842 if (mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 return locks_mandatory_locked(inode);
1844 return 0;
1845}
1846
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847static inline int locks_verify_truncate(struct inode *inode,
1848 struct file *filp,
1849 loff_t size)
1850{
Pavel Emelyanova16877c2007-10-01 14:41:11 -07001851 if (inode->i_flock && mandatory_lock(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 return locks_mandatory_area(
1853 FLOCK_VERIFY_WRITE, inode, filp,
1854 size < inode->i_size ? size : inode->i_size,
1855 (size < inode->i_size ? inode->i_size - size
1856 : size - inode->i_size)
1857 );
1858 return 0;
1859}
1860
1861static inline int break_lease(struct inode *inode, unsigned int mode)
1862{
1863 if (inode->i_flock)
1864 return __break_lease(inode, mode);
1865 return 0;
1866}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001867#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00001868static inline int locks_mandatory_locked(struct inode *inode)
1869{
1870 return 0;
1871}
1872
1873static inline int locks_mandatory_area(int rw, struct inode *inode,
1874 struct file *filp, loff_t offset,
1875 size_t count)
1876{
1877 return 0;
1878}
1879
1880static inline int __mandatory_lock(struct inode *inode)
1881{
1882 return 0;
1883}
1884
1885static inline int mandatory_lock(struct inode *inode)
1886{
1887 return 0;
1888}
1889
1890static inline int locks_verify_locked(struct inode *inode)
1891{
1892 return 0;
1893}
1894
1895static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
1896 size_t size)
1897{
1898 return 0;
1899}
1900
1901static inline int break_lease(struct inode *inode, unsigned int mode)
1902{
1903 return 0;
1904}
1905
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001906#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907
1908/* fs/open.c */
1909
NeilBrown4a301312006-01-08 01:02:39 -08001910extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
1911 struct file *filp);
Ankit Jain3e63cbb2009-06-19 14:28:07 -04001912extern int do_fallocate(struct file *file, int mode, loff_t offset,
1913 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02001914extern long do_sys_open(int dfd, const char __user *filename, int flags,
Ulrich Drepper5590ff02006-01-18 17:43:53 -08001915 int mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916extern struct file *filp_open(const char *, int, int);
David Howells745ca242008-11-14 10:39:22 +11001917extern struct file * dentry_open(struct dentry *, struct vfsmount *, int,
1918 const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919extern int filp_close(struct file *, fl_owner_t id);
1920extern char * getname(const char __user *);
1921
Ankit Jain3e63cbb2009-06-19 14:28:07 -04001922/* fs/ioctl.c */
1923
1924extern int ioctl_preallocate(struct file *filp, void __user *argp);
1925
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926/* fs/dcache.c */
1927extern void __init vfs_caches_init_early(void);
1928extern void __init vfs_caches_init(unsigned long);
1929
Christoph Lameterb86c0892006-12-06 20:32:57 -08001930extern struct kmem_cache *names_cachep;
1931
Vegard Nossum3446a8a2009-05-16 11:22:14 +02001932#define __getname_gfp(gfp) kmem_cache_alloc(names_cachep, (gfp))
1933#define __getname() __getname_gfp(GFP_KERNEL)
1934#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935#ifndef CONFIG_AUDITSYSCALL
1936#define putname(name) __putname(name)
1937#else
1938extern void putname(const char *name);
1939#endif
1940
David Howells93614012006-09-30 20:45:40 +02001941#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07001943extern void unregister_blkdev(unsigned int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02001945extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946extern void bd_set_size(struct block_device *, loff_t size);
1947extern void bd_forget(struct inode *inode);
1948extern void bdput(struct block_device *);
Al Viroaeb5d722008-09-02 15:28:45 -04001949extern struct block_device *open_by_devnum(dev_t, fmode_t);
Nick Piggin585d3bc2009-02-25 10:44:19 +01001950extern void invalidate_bdev(struct block_device *);
1951extern int sync_blockdev(struct block_device *bdev);
1952extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07001953extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01001954extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
1955extern int fsync_bdev(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02001956#else
1957static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04001958static inline int sync_blockdev(struct block_device *bdev) { return 0; }
1959static inline void invalidate_bdev(struct block_device *bdev) {}
1960
1961static inline struct super_block *freeze_bdev(struct block_device *sb)
1962{
1963 return NULL;
1964}
1965
1966static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
1967{
1968 return 0;
1969}
David Howells93614012006-09-30 20:45:40 +02001970#endif
Jan Kara60b06802009-04-27 16:43:53 +02001971extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02001972extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08001973extern const struct file_operations def_chr_fops;
1974extern const struct file_operations bad_sock_fops;
1975extern const struct file_operations def_fifo_fops;
David Howells93614012006-09-30 20:45:40 +02001976#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04001978extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Al Viro572c4892007-10-08 13:24:05 -04001980extern int blkdev_get(struct block_device *, fmode_t);
Al Viro9a1c3542008-02-22 20:40:24 -05001981extern int blkdev_put(struct block_device *, fmode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982extern int bd_claim(struct block_device *, void *);
1983extern void bd_release(struct block_device *);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08001984#ifdef CONFIG_SYSFS
1985extern int bd_claim_by_disk(struct block_device *, void *, struct gendisk *);
1986extern void bd_release_from_disk(struct block_device *, struct gendisk *);
1987#else
1988#define bd_claim_by_disk(bdev, holder, disk) bd_claim(bdev, holder)
1989#define bd_release_from_disk(bdev, disk) bd_release(bdev)
1990#endif
David Howells93614012006-09-30 20:45:40 +02001991#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992
1993/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08001994#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
1996extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09001997extern int __register_chrdev(unsigned int major, unsigned int baseminor,
1998 unsigned int count, const char *name,
1999 const struct file_operations *fops);
2000extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2001 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002003extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004
Tejun Heo1905b1b2009-08-06 18:13:23 +09002005static inline int register_chrdev(unsigned int major, const char *name,
2006 const struct file_operations *fops)
2007{
2008 return __register_chrdev(major, 0, 256, name, fops);
2009}
2010
2011static inline void unregister_chrdev(unsigned int major, const char *name)
2012{
2013 __unregister_chrdev(major, 0, 256, name);
2014}
2015
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016/* fs/block_dev.c */
2017#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002018#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002019
2020#ifdef CONFIG_BLOCK
2021#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022extern const char *__bdevname(dev_t, char *buffer);
2023extern const char *bdevname(struct block_device *bdev, char *buffer);
2024extern struct block_device *lookup_bdev(const char *);
Al Viro30c40d22008-02-22 19:50:45 -05002025extern struct block_device *open_bdev_exclusive(const char *, fmode_t, void *);
2026extern void close_bdev_exclusive(struct block_device *, fmode_t);
Joe Korty68eef3b2006-03-31 02:30:32 -08002027extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002028
David Howells93614012006-09-30 20:45:40 +02002029#else
2030#define BLKDEV_MAJOR_HASH_SIZE 0
2031#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032
2033extern void init_special_inode(struct inode *, umode_t, dev_t);
2034
2035/* Invalid inode operations -- fs/bad_inode.c */
2036extern void make_bad_inode(struct inode *);
2037extern int is_bad_inode(struct inode *);
2038
Denys Vlasenkod2d96482008-07-01 14:16:09 +02002039extern const struct file_operations read_pipefifo_fops;
2040extern const struct file_operations write_pipefifo_fops;
2041extern const struct file_operations rdwr_pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
2043extern int fs_may_remount_ro(struct super_block *);
2044
David Howells93614012006-09-30 20:45:40 +02002045#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046/*
2047 * return READ, READA, or WRITE
2048 */
2049#define bio_rw(bio) ((bio)->bi_rw & (RW_MASK | RWA_MASK))
2050
2051/*
2052 * return data direction, READ or WRITE
2053 */
2054#define bio_data_dir(bio) ((bio)->bi_rw & 1)
2055
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002056extern void check_disk_size_change(struct gendisk *disk,
2057 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002058extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059extern int check_disk_change(struct block_device *);
Christoph Hellwig2ef41632005-05-05 16:15:59 -07002060extern int __invalidate_device(struct block_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002062#endif
2063extern int invalidate_inodes(struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064unsigned long invalidate_mapping_pages(struct address_space *mapping,
2065 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002066
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067static inline void invalidate_remote_inode(struct inode *inode)
2068{
2069 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2070 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002071 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072}
2073extern int invalidate_inode_pages2(struct address_space *mapping);
2074extern int invalidate_inode_pages2_range(struct address_space *mapping,
2075 pgoff_t start, pgoff_t end);
2076extern int write_inode_now(struct inode *, int);
2077extern int filemap_fdatawrite(struct address_space *);
2078extern int filemap_flush(struct address_space *);
2079extern int filemap_fdatawait(struct address_space *);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002080extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2081 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082extern int filemap_write_and_wait(struct address_space *mapping);
2083extern int filemap_write_and_wait_range(struct address_space *mapping,
2084 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002085extern int __filemap_fdatawrite_range(struct address_space *mapping,
2086 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002087extern int filemap_fdatawrite_range(struct address_space *mapping,
2088 loff_t start, loff_t end);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002089
Jan Kara148f9482009-08-17 19:52:36 +02002090extern int vfs_fsync_range(struct file *file, struct dentry *dentry,
2091 loff_t start, loff_t end, int datasync);
Christoph Hellwig4c728ef2008-12-22 21:11:15 +01002092extern int vfs_fsync(struct file *file, struct dentry *dentry, int datasync);
Jan Kara148f9482009-08-17 19:52:36 +02002093extern int generic_write_sync(struct file *file, loff_t pos, loff_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094extern void sync_supers(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095extern void emergency_sync(void);
2096extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002097#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002099#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100extern int notify_change(struct dentry *, struct iattr *);
Al Virof419a2e2008-07-22 00:07:17 -04002101extern int inode_permission(struct inode *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102extern int generic_permission(struct inode *, int,
2103 int (*check_acl)(struct inode *, int));
2104
Miklos Szeredif696a362008-07-31 13:41:58 +02002105static inline bool execute_ok(struct inode *inode)
2106{
2107 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2108}
2109
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110extern int get_write_access(struct inode *);
2111extern int deny_write_access(struct file *);
2112static inline void put_write_access(struct inode * inode)
2113{
2114 atomic_dec(&inode->i_writecount);
2115}
2116static inline void allow_write_access(struct file *file)
2117{
2118 if (file)
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08002119 atomic_inc(&file->f_path.dentry->d_inode->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120}
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002121extern int do_pipe_flags(int *, int);
Ulrich Drepperbe61a862008-07-23 21:29:40 -07002122extern struct file *create_read_pipe(struct file *f, int flags);
2123extern struct file *create_write_pipe(int flags);
Andi Kleend6cbd282006-09-30 23:29:26 -07002124extern void free_write_pipe(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125
Christoph Hellwiga70e65d2008-02-15 14:37:28 -08002126extern struct file *do_filp_open(int dfd, const char *pathname,
Al Viro6e8341a2009-04-06 11:16:22 -04002127 int open_flag, int mode, int acc_mode);
Christoph Hellwig3fb64192008-10-24 09:58:10 +02002128extern int may_open(struct path *, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129
Mimi Zohar6777d772009-08-21 14:32:48 -04002130extern int kernel_read(struct file *, loff_t, char *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131extern struct file * open_exec(const char *);
2132
2133/* fs/dcache.c -- generic fs support functions */
2134extern int is_subdir(struct dentry *, struct dentry *);
Al Viro2096f752010-01-30 13:16:21 -05002135extern int path_is_under(struct path *, struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136extern ino_t find_inode_number(struct dentry *, struct qstr *);
2137
2138#include <linux/err.h>
2139
2140/* needed for stackable file system support */
2141extern loff_t default_llseek(struct file *file, loff_t offset, int origin);
2142
2143extern loff_t vfs_llseek(struct file *file, loff_t offset, int origin);
2144
Christoph Hellwig54e34622009-08-07 14:38:25 -03002145extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146extern void inode_init_once(struct inode *);
David Chinner8290c352008-10-30 17:35:24 +11002147extern void inode_add_to_lists(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148extern void iput(struct inode *);
2149extern struct inode * igrab(struct inode *);
2150extern ino_t iunique(struct super_block *, ino_t);
2151extern int inode_needs_sync(struct inode *inode);
2152extern void generic_delete_inode(struct inode *inode);
Mark Fashehcb2c0232005-07-07 17:56:03 -07002153extern void generic_drop_inode(struct inode *inode);
Jan Kara22fe40422009-09-18 13:05:44 -07002154extern int generic_detach_inode(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002156extern struct inode *ilookup5_nowait(struct super_block *sb,
2157 unsigned long hashval, int (*test)(struct inode *, void *),
2158 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2160 int (*test)(struct inode *, void *), void *data);
2161extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2162
2163extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2164extern struct inode * iget_locked(struct super_block *, unsigned long);
Al Viro261bca82008-12-30 01:48:21 -05002165extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2166extern int insert_inode_locked(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167extern void unlock_new_inode(struct inode *);
2168
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002170extern void iget_failed(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171extern void clear_inode(struct inode *);
2172extern void destroy_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002173extern void __destroy_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174extern struct inode *new_inode(struct super_block *);
Jens Axboe01de85e2006-10-17 19:50:36 +02002175extern int should_remove_suid(struct dentry *);
Miklos Szeredi2f1936b2008-06-24 16:50:14 +02002176extern int file_remove_suid(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177
2178extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2179extern void remove_inode_hash(struct inode *);
2180static inline void insert_inode_hash(struct inode *inode) {
2181 __insert_inode_hash(inode, inode->i_ino);
2182}
2183
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184extern void file_move(struct file *f, struct list_head *list);
2185extern void file_kill(struct file *f);
David Howells93614012006-09-30 20:45:40 +02002186#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187struct bio;
2188extern void submit_bio(int, struct bio *);
2189extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002190#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191extern int set_blocksize(struct block_device *, int);
2192extern int sb_set_blocksize(struct super_block *, int);
2193extern int sb_min_blocksize(struct super_block *, int);
2194
2195extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2196extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2197extern int file_read_actor(read_descriptor_t * desc, struct page *page, unsigned long offset, unsigned long size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198int generic_write_checks(struct file *file, loff_t *pos, size_t *count, int isblk);
Badari Pulavarty027445c2006-09-30 23:28:46 -07002199extern ssize_t generic_file_aio_read(struct kiocb *, const struct iovec *, unsigned long, loff_t);
Jan Karae4dd9de2009-08-17 18:10:06 +02002200extern ssize_t __generic_file_aio_write(struct kiocb *, const struct iovec *, unsigned long,
2201 loff_t *);
Badari Pulavarty027445c2006-09-30 23:28:46 -07002202extern ssize_t generic_file_aio_write(struct kiocb *, const struct iovec *, unsigned long, loff_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203extern ssize_t generic_file_direct_write(struct kiocb *, const struct iovec *,
2204 unsigned long *, loff_t, loff_t *, size_t, size_t);
2205extern ssize_t generic_file_buffered_write(struct kiocb *, const struct iovec *,
2206 unsigned long, loff_t, loff_t *, size_t, ssize_t);
2207extern ssize_t do_sync_read(struct file *filp, char __user *buf, size_t len, loff_t *ppos);
2208extern ssize_t do_sync_write(struct file *filp, const char __user *buf, size_t len, loff_t *ppos);
Dmitriy Monakhov0ceb3312007-05-08 00:23:02 -07002209extern int generic_segment_checks(const struct iovec *iov,
2210 unsigned long *nr_segs, size_t *count, int access_flags);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002211
Christoph Hellwigeef99382009-08-20 17:43:41 +02002212/* fs/block_dev.c */
2213extern ssize_t blkdev_aio_write(struct kiocb *iocb, const struct iovec *iov,
2214 unsigned long nr_segs, loff_t pos);
Andrew Mortonb1dd3b22010-04-06 14:35:00 -07002215extern int blkdev_fsync(struct file *filp, struct dentry *dentry, int datasync);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002216
Andrew Morton88e6fae2006-04-11 13:59:36 +02002217/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002218extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002219 struct pipe_inode_info *, size_t, unsigned int);
Miklos Szeredi68181732009-05-07 15:37:36 +02002220extern ssize_t default_file_splice_read(struct file *, loff_t *,
2221 struct pipe_inode_info *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002222extern ssize_t generic_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002223 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002224extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002225 struct file *out, loff_t *, size_t len, unsigned int flags);
2226extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002227 size_t len, unsigned int flags);
2228
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229extern void
2230file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231extern loff_t no_llseek(struct file *file, loff_t offset, int origin);
2232extern loff_t generic_file_llseek(struct file *file, loff_t offset, int origin);
Andi Kleen9465efc2008-06-27 11:05:24 +02002233extern loff_t generic_file_llseek_unlocked(struct file *file, loff_t offset,
2234 int origin);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235extern int generic_file_open(struct inode * inode, struct file * filp);
2236extern int nonseekable_open(struct inode * inode, struct file * filp);
2237
Carsten Otteceffc072005-06-23 22:05:25 -07002238#ifdef CONFIG_FS_XIP
Carsten Otteeb6fe0c2005-06-23 22:05:28 -07002239extern ssize_t xip_file_read(struct file *filp, char __user *buf, size_t len,
2240 loff_t *ppos);
Carsten Otteceffc072005-06-23 22:05:25 -07002241extern int xip_file_mmap(struct file * file, struct vm_area_struct * vma);
Carsten Otteeb6fe0c2005-06-23 22:05:28 -07002242extern ssize_t xip_file_write(struct file *filp, const char __user *buf,
2243 size_t len, loff_t *ppos);
Carsten Otteceffc072005-06-23 22:05:25 -07002244extern int xip_truncate_page(struct address_space *mapping, loff_t from);
Carsten Otte6d791252005-06-23 22:05:26 -07002245#else
2246static inline int xip_truncate_page(struct address_space *mapping, loff_t from)
2247{
2248 return 0;
2249}
Carsten Otteceffc072005-06-23 22:05:25 -07002250#endif
2251
David Howells93614012006-09-30 20:45:40 +02002252#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253ssize_t __blockdev_direct_IO(int rw, struct kiocb *iocb, struct inode *inode,
2254 struct block_device *bdev, const struct iovec *iov, loff_t offset,
Badari Pulavarty1d8fa7a2006-03-26 01:38:02 -08002255 unsigned long nr_segs, get_block_t get_block, dio_iodone_t end_io,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 int lock_type);
2257
2258enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002259 /* need locking between buffered and direct access */
2260 DIO_LOCKING = 0x01,
2261
2262 /* filesystem does not support filling holes */
2263 DIO_SKIP_HOLES = 0x02,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264};
2265
2266static inline ssize_t blockdev_direct_IO(int rw, struct kiocb *iocb,
2267 struct inode *inode, struct block_device *bdev, const struct iovec *iov,
Badari Pulavarty1d8fa7a2006-03-26 01:38:02 -08002268 loff_t offset, unsigned long nr_segs, get_block_t get_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 dio_iodone_t end_io)
2270{
2271 return __blockdev_direct_IO(rw, iocb, inode, bdev, iov, offset,
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002272 nr_segs, get_block, end_io,
2273 DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274}
2275
2276static inline ssize_t blockdev_direct_IO_no_locking(int rw, struct kiocb *iocb,
2277 struct inode *inode, struct block_device *bdev, const struct iovec *iov,
Badari Pulavarty1d8fa7a2006-03-26 01:38:02 -08002278 loff_t offset, unsigned long nr_segs, get_block_t get_block,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 dio_iodone_t end_io)
2280{
2281 return __blockdev_direct_IO(rw, iocb, inode, bdev, iov, offset,
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002282 nr_segs, get_block, end_io, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283}
David Howells93614012006-09-30 20:45:40 +02002284#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002286extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
2288#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2289
2290extern int vfs_readlink(struct dentry *, char __user *, int, const char *);
2291extern int vfs_follow_link(struct nameidata *, const char *);
2292extern int page_readlink(struct dentry *, char __user *, int);
Linus Torvaldscc314ee2005-08-19 18:02:56 -07002293extern void *page_follow_link_light(struct dentry *, struct nameidata *);
2294extern void page_put_link(struct dentry *, struct nameidata *, void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002295extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002296 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002298extern const struct inode_operations page_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299extern int generic_readlink(struct dentry *, char __user *, int);
2300extern void generic_fillattr(struct inode *, struct kstat *);
2301extern int vfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002302void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303void inode_add_bytes(struct inode *inode, loff_t bytes);
2304void inode_sub_bytes(struct inode *inode, loff_t bytes);
2305loff_t inode_get_bytes(struct inode *inode);
2306void inode_set_bytes(struct inode *inode, loff_t bytes);
2307
2308extern int vfs_readdir(struct file *, filldir_t, void *);
2309
2310extern int vfs_stat(char __user *, struct kstat *);
2311extern int vfs_lstat(char __user *, struct kstat *);
2312extern int vfs_fstat(unsigned int, struct kstat *);
Oleg Drokin0112fc22009-04-08 20:05:42 +04002313extern int vfs_fstatat(int , char __user *, struct kstat *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314
Erez Zadokdeb21db2008-02-07 00:13:25 -08002315extern int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
2316 unsigned long arg);
Steven Whitehousee9079cc2008-10-14 14:43:29 +01002317extern int __generic_block_fiemap(struct inode *inode,
2318 struct fiemap_extent_info *fieinfo, u64 start,
2319 u64 len, get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04002320extern int generic_block_fiemap(struct inode *inode,
2321 struct fiemap_extent_info *fieinfo, u64 start,
2322 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323
Miklos Szeredic18479f2007-10-18 23:39:11 -07002324extern void get_filesystem(struct file_system_type *fs);
2325extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326extern struct file_system_type *get_fs_type(const char *name);
2327extern struct super_block *get_super(struct block_device *);
Christoph Hellwig45042302009-08-03 23:28:35 +02002328extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329extern struct super_block *user_get_super(dev_t);
2330extern void drop_super(struct super_block *sb);
2331
2332extern int dcache_dir_open(struct inode *, struct file *);
2333extern int dcache_dir_close(struct inode *, struct file *);
2334extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
2335extern int dcache_readdir(struct file *, void *, filldir_t);
2336extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
David Howells726c3342006-06-23 02:02:58 -07002337extern int simple_statfs(struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2339extern int simple_unlink(struct inode *, struct dentry *);
2340extern int simple_rmdir(struct inode *, struct dentry *);
2341extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
2342extern int simple_sync_file(struct file *, struct dentry *, int);
2343extern int simple_empty(struct dentry *);
2344extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07002345extern int simple_write_begin(struct file *file, struct address_space *mapping,
2346 loff_t pos, unsigned len, unsigned flags,
2347 struct page **pagep, void **fsdata);
2348extern int simple_write_end(struct file *file, struct address_space *mapping,
2349 loff_t pos, unsigned len, unsigned copied,
2350 struct page *page, void *fsdata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
2352extern struct dentry *simple_lookup(struct inode *, struct dentry *, struct nameidata *);
2353extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002354extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002355extern const struct inode_operations simple_dir_inode_operations;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002356struct tree_descr { char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357struct dentry *d_alloc_name(struct dentry *, const char *);
2358extern int simple_fill_super(struct super_block *, int, struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04002359extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360extern void simple_release_fs(struct vfsmount **mount, int *count);
2361
Akinobu Mita93b07112008-06-05 22:46:21 -07002362extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2363 loff_t *ppos, const void *from, size_t available);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364
Al Virod5aacad2009-06-07 14:56:44 -04002365extern int simple_fsync(struct file *, struct dentry *, int);
2366
Christoph Lametere965f962006-02-01 03:05:41 -08002367#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07002368extern int buffer_migrate_page(struct address_space *,
2369 struct page *, struct page *);
Christoph Lametere965f962006-02-01 03:05:41 -08002370#else
2371#define buffer_migrate_page NULL
2372#endif
2373
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10002374extern int inode_change_ok(const struct inode *, struct iattr *);
2375extern int inode_newsize_ok(const struct inode *, loff_t offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376extern int __must_check inode_setattr(struct inode *, struct iattr *);
2377
Christoph Hellwig870f4812006-01-09 20:52:01 -08002378extern void file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379
Miklos Szeredib3b304a2008-02-08 04:21:35 -08002380extern int generic_show_options(struct seq_file *m, struct vfsmount *mnt);
2381extern void save_mount_options(struct super_block *sb, char *options);
Al Viro2a32ceb2009-05-08 16:05:57 -04002382extern void replace_mount_options(struct super_block *sb, char *options);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08002383
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384static inline ino_t parent_ino(struct dentry *dentry)
2385{
2386 ino_t res;
2387
2388 spin_lock(&dentry->d_lock);
2389 res = dentry->d_parent->d_inode->i_ino;
2390 spin_unlock(&dentry->d_lock);
2391 return res;
2392}
2393
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394/* Transaction based IO helpers */
2395
2396/*
2397 * An argresp is stored in an allocated page and holds the
2398 * size of the argument or response, along with its content
2399 */
2400struct simple_transaction_argresp {
2401 ssize_t size;
2402 char data[0];
2403};
2404
2405#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
2406
2407char *simple_transaction_get(struct file *file, const char __user *buf,
2408 size_t size);
2409ssize_t simple_transaction_read(struct file *file, char __user *buf,
2410 size_t size, loff_t *pos);
2411int simple_transaction_release(struct inode *inode, struct file *file);
2412
Ingo Molnar76791ab2009-03-25 16:48:35 +01002413void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002415/*
2416 * simple attribute files
2417 *
2418 * These attributes behave similar to those in sysfs:
2419 *
2420 * Writing to an attribute immediately sets a value, an open file can be
2421 * written to multiple times.
2422 *
2423 * Reading from an attribute creates a buffer from the value that might get
2424 * read with multiple read calls. When the attribute has been read
2425 * completely, no further read calls are possible until the file is opened
2426 * again.
2427 *
2428 * All attributes contain a text representation of a numeric value
2429 * that are accessed with the get() and set() functions.
2430 */
2431#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
2432static int __fops ## _open(struct inode *inode, struct file *file) \
2433{ \
2434 __simple_attr_check_format(__fmt, 0ull); \
2435 return simple_attr_open(inode, file, __get, __set, __fmt); \
2436} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002437static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002438 .owner = THIS_MODULE, \
2439 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08002440 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002441 .read = simple_attr_read, \
2442 .write = simple_attr_write, \
2443};
2444
2445static inline void __attribute__((format(printf, 1, 2)))
2446__simple_attr_check_format(const char *fmt, ...)
2447{
2448 /* don't do anything, just let the compiler check the arguments; */
2449}
2450
2451int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08002452 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002453 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08002454int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02002455ssize_t simple_attr_read(struct file *file, char __user *buf,
2456 size_t len, loff_t *ppos);
2457ssize_t simple_attr_write(struct file *file, const char __user *buf,
2458 size_t len, loff_t *ppos);
2459
Alexey Dobriyan4be28542007-10-16 23:26:21 -07002460struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07002461int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07002462 void __user *buffer, size_t *lenp, loff_t *ppos);
2463
Tetsuo Handa38e23c92009-04-09 20:17:52 +09002464int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07002465
Al Viro6d125522009-12-24 06:58:56 -05002466#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Al Viro53009902009-12-19 10:15:07 -05002467#define OPEN_FMODE(flag) ((__force fmode_t)((flag + 1) & O_ACCMODE))
2468
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469#endif /* __KERNEL__ */
2470#endif /* _LINUX_FS_H */