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