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