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