xref: /linux-6.15/include/linux/fs.h (revision f6bcbf2e)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_FS_H
3 #define _LINUX_FS_H
4 
5 #include <linux/linkage.h>
6 #include <linux/wait_bit.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/rwsem.h>
22 #include <linux/mm_types.h>
23 #include <linux/capability.h>
24 #include <linux/semaphore.h>
25 #include <linux/fcntl.h>
26 #include <linux/fiemap.h>
27 #include <linux/rculist_bl.h>
28 #include <linux/atomic.h>
29 #include <linux/shrinker.h>
30 #include <linux/migrate_mode.h>
31 #include <linux/uidgid.h>
32 #include <linux/lockdep.h>
33 #include <linux/percpu-rwsem.h>
34 #include <linux/workqueue.h>
35 #include <linux/delayed_call.h>
36 #include <linux/uuid.h>
37 #include <linux/errseq.h>
38 
39 #include <asm/byteorder.h>
40 #include <uapi/linux/fs.h>
41 
42 struct backing_dev_info;
43 struct bdi_writeback;
44 struct bio;
45 struct export_operations;
46 struct hd_geometry;
47 struct iovec;
48 struct kiocb;
49 struct kobject;
50 struct pipe_inode_info;
51 struct poll_table_struct;
52 struct kstatfs;
53 struct vm_area_struct;
54 struct vfsmount;
55 struct cred;
56 struct swap_info_struct;
57 struct seq_file;
58 struct workqueue_struct;
59 struct iov_iter;
60 struct fscrypt_info;
61 struct fscrypt_operations;
62 
63 extern void __init inode_init(void);
64 extern void __init inode_init_early(void);
65 extern void __init files_init(void);
66 extern void __init files_maxfiles_init(void);
67 
68 extern struct files_stat_struct files_stat;
69 extern unsigned long get_max_files(void);
70 extern unsigned int sysctl_nr_open;
71 extern struct inodes_stat_t inodes_stat;
72 extern int leases_enable, lease_break_time;
73 extern int sysctl_protected_symlinks;
74 extern int sysctl_protected_hardlinks;
75 
76 typedef __kernel_rwf_t rwf_t;
77 
78 struct buffer_head;
79 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
80 			struct buffer_head *bh_result, int create);
81 typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
82 			ssize_t bytes, void *private);
83 
84 #define MAY_EXEC		0x00000001
85 #define MAY_WRITE		0x00000002
86 #define MAY_READ		0x00000004
87 #define MAY_APPEND		0x00000008
88 #define MAY_ACCESS		0x00000010
89 #define MAY_OPEN		0x00000020
90 #define MAY_CHDIR		0x00000040
91 /* called from RCU mode, don't block */
92 #define MAY_NOT_BLOCK		0x00000080
93 
94 /*
95  * flags in file.f_mode.  Note that FMODE_READ and FMODE_WRITE must correspond
96  * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
97  */
98 
99 /* file is open for reading */
100 #define FMODE_READ		((__force fmode_t)0x1)
101 /* file is open for writing */
102 #define FMODE_WRITE		((__force fmode_t)0x2)
103 /* file is seekable */
104 #define FMODE_LSEEK		((__force fmode_t)0x4)
105 /* file can be accessed using pread */
106 #define FMODE_PREAD		((__force fmode_t)0x8)
107 /* file can be accessed using pwrite */
108 #define FMODE_PWRITE		((__force fmode_t)0x10)
109 /* File is opened for execution with sys_execve / sys_uselib */
110 #define FMODE_EXEC		((__force fmode_t)0x20)
111 /* File is opened with O_NDELAY (only set for block devices) */
112 #define FMODE_NDELAY		((__force fmode_t)0x40)
113 /* File is opened with O_EXCL (only set for block devices) */
114 #define FMODE_EXCL		((__force fmode_t)0x80)
115 /* File is opened using open(.., 3, ..) and is writeable only for ioctls
116    (specialy hack for floppy.c) */
117 #define FMODE_WRITE_IOCTL	((__force fmode_t)0x100)
118 /* 32bit hashes as llseek() offset (for directories) */
119 #define FMODE_32BITHASH         ((__force fmode_t)0x200)
120 /* 64bit hashes as llseek() offset (for directories) */
121 #define FMODE_64BITHASH         ((__force fmode_t)0x400)
122 
123 /*
124  * Don't update ctime and mtime.
125  *
126  * Currently a special hack for the XFS open_by_handle ioctl, but we'll
127  * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
128  */
129 #define FMODE_NOCMTIME		((__force fmode_t)0x800)
130 
131 /* Expect random access pattern */
132 #define FMODE_RANDOM		((__force fmode_t)0x1000)
133 
134 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
135 #define FMODE_UNSIGNED_OFFSET	((__force fmode_t)0x2000)
136 
137 /* File is opened with O_PATH; almost nothing can be done with it */
138 #define FMODE_PATH		((__force fmode_t)0x4000)
139 
140 /* File needs atomic accesses to f_pos */
141 #define FMODE_ATOMIC_POS	((__force fmode_t)0x8000)
142 /* Write access to underlying fs */
143 #define FMODE_WRITER		((__force fmode_t)0x10000)
144 /* Has read method(s) */
145 #define FMODE_CAN_READ          ((__force fmode_t)0x20000)
146 /* Has write method(s) */
147 #define FMODE_CAN_WRITE         ((__force fmode_t)0x40000)
148 
149 /* File was opened by fanotify and shouldn't generate fanotify events */
150 #define FMODE_NONOTIFY		((__force fmode_t)0x4000000)
151 
152 /* File is capable of returning -EAGAIN if I/O will block */
153 #define FMODE_NOWAIT	((__force fmode_t)0x8000000)
154 
155 /*
156  * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
157  * that indicates that they should check the contents of the iovec are
158  * valid, but not check the memory that the iovec elements
159  * points too.
160  */
161 #define CHECK_IOVEC_ONLY -1
162 
163 /*
164  * Attribute flags.  These should be or-ed together to figure out what
165  * has been changed!
166  */
167 #define ATTR_MODE	(1 << 0)
168 #define ATTR_UID	(1 << 1)
169 #define ATTR_GID	(1 << 2)
170 #define ATTR_SIZE	(1 << 3)
171 #define ATTR_ATIME	(1 << 4)
172 #define ATTR_MTIME	(1 << 5)
173 #define ATTR_CTIME	(1 << 6)
174 #define ATTR_ATIME_SET	(1 << 7)
175 #define ATTR_MTIME_SET	(1 << 8)
176 #define ATTR_FORCE	(1 << 9) /* Not a change, but a change it */
177 #define ATTR_ATTR_FLAG	(1 << 10)
178 #define ATTR_KILL_SUID	(1 << 11)
179 #define ATTR_KILL_SGID	(1 << 12)
180 #define ATTR_FILE	(1 << 13)
181 #define ATTR_KILL_PRIV	(1 << 14)
182 #define ATTR_OPEN	(1 << 15) /* Truncating from open(O_TRUNC) */
183 #define ATTR_TIMES_SET	(1 << 16)
184 #define ATTR_TOUCH	(1 << 17)
185 
186 /*
187  * Whiteout is represented by a char device.  The following constants define the
188  * mode and device number to use.
189  */
190 #define WHITEOUT_MODE 0
191 #define WHITEOUT_DEV 0
192 
193 /*
194  * This is the Inode Attributes structure, used for notify_change().  It
195  * uses the above definitions as flags, to know which values have changed.
196  * Also, in this manner, a Filesystem can look at only the values it cares
197  * about.  Basically, these are the attributes that the VFS layer can
198  * request to change from the FS layer.
199  *
200  * Derek Atkins <[email protected]> 94-10-20
201  */
202 struct iattr {
203 	unsigned int	ia_valid;
204 	umode_t		ia_mode;
205 	kuid_t		ia_uid;
206 	kgid_t		ia_gid;
207 	loff_t		ia_size;
208 	struct timespec	ia_atime;
209 	struct timespec	ia_mtime;
210 	struct timespec	ia_ctime;
211 
212 	/*
213 	 * Not an attribute, but an auxiliary info for filesystems wanting to
214 	 * implement an ftruncate() like method.  NOTE: filesystem should
215 	 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
216 	 */
217 	struct file	*ia_file;
218 };
219 
220 /*
221  * Includes for diskquotas.
222  */
223 #include <linux/quota.h>
224 
225 /*
226  * Maximum number of layers of fs stack.  Needs to be limited to
227  * prevent kernel stack overflow
228  */
229 #define FILESYSTEM_MAX_STACK_DEPTH 2
230 
231 /**
232  * enum positive_aop_returns - aop return codes with specific semantics
233  *
234  * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
235  * 			    completed, that the page is still locked, and
236  * 			    should be considered active.  The VM uses this hint
237  * 			    to return the page to the active list -- it won't
238  * 			    be a candidate for writeback again in the near
239  * 			    future.  Other callers must be careful to unlock
240  * 			    the page if they get this return.  Returned by
241  * 			    writepage();
242  *
243  * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
244  *  			unlocked it and the page might have been truncated.
245  *  			The caller should back up to acquiring a new page and
246  *  			trying again.  The aop will be taking reasonable
247  *  			precautions not to livelock.  If the caller held a page
248  *  			reference, it should drop it before retrying.  Returned
249  *  			by readpage().
250  *
251  * address_space_operation functions return these large constants to indicate
252  * special semantics to the caller.  These are much larger than the bytes in a
253  * page to allow for functions that return the number of bytes operated on in a
254  * given page.
255  */
256 
257 enum positive_aop_returns {
258 	AOP_WRITEPAGE_ACTIVATE	= 0x80000,
259 	AOP_TRUNCATED_PAGE	= 0x80001,
260 };
261 
262 #define AOP_FLAG_CONT_EXPAND		0x0001 /* called from cont_expand */
263 #define AOP_FLAG_NOFS			0x0002 /* used by filesystem to direct
264 						* helper code (eg buffer layer)
265 						* to clear GFP_FS from alloc */
266 
267 /*
268  * oh the beauties of C type declarations.
269  */
270 struct page;
271 struct address_space;
272 struct writeback_control;
273 
274 /*
275  * Write life time hint values.
276  */
277 enum rw_hint {
278 	WRITE_LIFE_NOT_SET	= 0,
279 	WRITE_LIFE_NONE		= RWH_WRITE_LIFE_NONE,
280 	WRITE_LIFE_SHORT	= RWH_WRITE_LIFE_SHORT,
281 	WRITE_LIFE_MEDIUM	= RWH_WRITE_LIFE_MEDIUM,
282 	WRITE_LIFE_LONG		= RWH_WRITE_LIFE_LONG,
283 	WRITE_LIFE_EXTREME	= RWH_WRITE_LIFE_EXTREME,
284 };
285 
286 #define IOCB_EVENTFD		(1 << 0)
287 #define IOCB_APPEND		(1 << 1)
288 #define IOCB_DIRECT		(1 << 2)
289 #define IOCB_HIPRI		(1 << 3)
290 #define IOCB_DSYNC		(1 << 4)
291 #define IOCB_SYNC		(1 << 5)
292 #define IOCB_WRITE		(1 << 6)
293 #define IOCB_NOWAIT		(1 << 7)
294 
295 struct kiocb {
296 	struct file		*ki_filp;
297 	loff_t			ki_pos;
298 	void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
299 	void			*private;
300 	int			ki_flags;
301 	enum rw_hint		ki_hint;
302 } __randomize_layout;
303 
304 static inline bool is_sync_kiocb(struct kiocb *kiocb)
305 {
306 	return kiocb->ki_complete == NULL;
307 }
308 
309 /*
310  * "descriptor" for what we're up to with a read.
311  * This allows us to use the same read code yet
312  * have multiple different users of the data that
313  * we read from a file.
314  *
315  * The simplest case just copies the data to user
316  * mode.
317  */
318 typedef struct {
319 	size_t written;
320 	size_t count;
321 	union {
322 		char __user *buf;
323 		void *data;
324 	} arg;
325 	int error;
326 } read_descriptor_t;
327 
328 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
329 		unsigned long, unsigned long);
330 
331 struct address_space_operations {
332 	int (*writepage)(struct page *page, struct writeback_control *wbc);
333 	int (*readpage)(struct file *, struct page *);
334 
335 	/* Write back some dirty pages from this mapping. */
336 	int (*writepages)(struct address_space *, struct writeback_control *);
337 
338 	/* Set a page dirty.  Return true if this dirtied it */
339 	int (*set_page_dirty)(struct page *page);
340 
341 	int (*readpages)(struct file *filp, struct address_space *mapping,
342 			struct list_head *pages, unsigned nr_pages);
343 
344 	int (*write_begin)(struct file *, struct address_space *mapping,
345 				loff_t pos, unsigned len, unsigned flags,
346 				struct page **pagep, void **fsdata);
347 	int (*write_end)(struct file *, struct address_space *mapping,
348 				loff_t pos, unsigned len, unsigned copied,
349 				struct page *page, void *fsdata);
350 
351 	/* Unfortunately this kludge is needed for FIBMAP. Don't use it */
352 	sector_t (*bmap)(struct address_space *, sector_t);
353 	void (*invalidatepage) (struct page *, unsigned int, unsigned int);
354 	int (*releasepage) (struct page *, gfp_t);
355 	void (*freepage)(struct page *);
356 	ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
357 	/*
358 	 * migrate the contents of a page to the specified target. If
359 	 * migrate_mode is MIGRATE_ASYNC, it must not block.
360 	 */
361 	int (*migratepage) (struct address_space *,
362 			struct page *, struct page *, enum migrate_mode);
363 	bool (*isolate_page)(struct page *, isolate_mode_t);
364 	void (*putback_page)(struct page *);
365 	int (*launder_page) (struct page *);
366 	int (*is_partially_uptodate) (struct page *, unsigned long,
367 					unsigned long);
368 	void (*is_dirty_writeback) (struct page *, bool *, bool *);
369 	int (*error_remove_page)(struct address_space *, struct page *);
370 
371 	/* swapfile support */
372 	int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
373 				sector_t *span);
374 	void (*swap_deactivate)(struct file *file);
375 };
376 
377 extern const struct address_space_operations empty_aops;
378 
379 /*
380  * pagecache_write_begin/pagecache_write_end must be used by general code
381  * to write into the pagecache.
382  */
383 int pagecache_write_begin(struct file *, struct address_space *mapping,
384 				loff_t pos, unsigned len, unsigned flags,
385 				struct page **pagep, void **fsdata);
386 
387 int pagecache_write_end(struct file *, struct address_space *mapping,
388 				loff_t pos, unsigned len, unsigned copied,
389 				struct page *page, void *fsdata);
390 
391 struct address_space {
392 	struct inode		*host;		/* owner: inode, block_device */
393 	struct radix_tree_root	page_tree;	/* radix tree of all pages */
394 	spinlock_t		tree_lock;	/* and lock protecting it */
395 	atomic_t		i_mmap_writable;/* count VM_SHARED mappings */
396 	struct rb_root_cached	i_mmap;		/* tree of private and shared mappings */
397 	struct rw_semaphore	i_mmap_rwsem;	/* protect tree, count, list */
398 	/* Protected by tree_lock together with the radix tree */
399 	unsigned long		nrpages;	/* number of total pages */
400 	/* number of shadow or DAX exceptional entries */
401 	unsigned long		nrexceptional;
402 	pgoff_t			writeback_index;/* writeback starts here */
403 	const struct address_space_operations *a_ops;	/* methods */
404 	unsigned long		flags;		/* error bits */
405 	spinlock_t		private_lock;	/* for use by the address_space */
406 	gfp_t			gfp_mask;	/* implicit gfp mask for allocations */
407 	struct list_head	private_list;	/* for use by the address_space */
408 	void			*private_data;	/* ditto */
409 	errseq_t		wb_err;
410 } __attribute__((aligned(sizeof(long)))) __randomize_layout;
411 	/*
412 	 * On most architectures that alignment is already the case; but
413 	 * must be enforced here for CRIS, to let the least significant bit
414 	 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
415 	 */
416 struct request_queue;
417 
418 struct block_device {
419 	dev_t			bd_dev;  /* not a kdev_t - it's a search key */
420 	int			bd_openers;
421 	struct inode *		bd_inode;	/* will die */
422 	struct super_block *	bd_super;
423 	struct mutex		bd_mutex;	/* open/close mutex */
424 	void *			bd_claiming;
425 	void *			bd_holder;
426 	int			bd_holders;
427 	bool			bd_write_holder;
428 #ifdef CONFIG_SYSFS
429 	struct list_head	bd_holder_disks;
430 #endif
431 	struct block_device *	bd_contains;
432 	unsigned		bd_block_size;
433 	u8			bd_partno;
434 	struct hd_struct *	bd_part;
435 	/* number of times partitions within this device have been opened. */
436 	unsigned		bd_part_count;
437 	int			bd_invalidated;
438 	struct gendisk *	bd_disk;
439 	struct request_queue *  bd_queue;
440 	struct backing_dev_info *bd_bdi;
441 	struct list_head	bd_list;
442 	/*
443 	 * Private data.  You must have bd_claim'ed the block_device
444 	 * to use this.  NOTE:  bd_claim allows an owner to claim
445 	 * the same device multiple times, the owner must take special
446 	 * care to not mess up bd_private for that case.
447 	 */
448 	unsigned long		bd_private;
449 
450 	/* The counter of freeze processes */
451 	int			bd_fsfreeze_count;
452 	/* Mutex for freeze */
453 	struct mutex		bd_fsfreeze_mutex;
454 } __randomize_layout;
455 
456 /*
457  * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
458  * radix trees
459  */
460 #define PAGECACHE_TAG_DIRTY	0
461 #define PAGECACHE_TAG_WRITEBACK	1
462 #define PAGECACHE_TAG_TOWRITE	2
463 
464 int mapping_tagged(struct address_space *mapping, int tag);
465 
466 static inline void i_mmap_lock_write(struct address_space *mapping)
467 {
468 	down_write(&mapping->i_mmap_rwsem);
469 }
470 
471 static inline void i_mmap_unlock_write(struct address_space *mapping)
472 {
473 	up_write(&mapping->i_mmap_rwsem);
474 }
475 
476 static inline void i_mmap_lock_read(struct address_space *mapping)
477 {
478 	down_read(&mapping->i_mmap_rwsem);
479 }
480 
481 static inline void i_mmap_unlock_read(struct address_space *mapping)
482 {
483 	up_read(&mapping->i_mmap_rwsem);
484 }
485 
486 /*
487  * Might pages of this file be mapped into userspace?
488  */
489 static inline int mapping_mapped(struct address_space *mapping)
490 {
491 	return	!RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
492 }
493 
494 /*
495  * Might pages of this file have been modified in userspace?
496  * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
497  * marks vma as VM_SHARED if it is shared, and the file was opened for
498  * writing i.e. vma may be mprotected writable even if now readonly.
499  *
500  * If i_mmap_writable is negative, no new writable mappings are allowed. You
501  * can only deny writable mappings, if none exists right now.
502  */
503 static inline int mapping_writably_mapped(struct address_space *mapping)
504 {
505 	return atomic_read(&mapping->i_mmap_writable) > 0;
506 }
507 
508 static inline int mapping_map_writable(struct address_space *mapping)
509 {
510 	return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
511 		0 : -EPERM;
512 }
513 
514 static inline void mapping_unmap_writable(struct address_space *mapping)
515 {
516 	atomic_dec(&mapping->i_mmap_writable);
517 }
518 
519 static inline int mapping_deny_writable(struct address_space *mapping)
520 {
521 	return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
522 		0 : -EBUSY;
523 }
524 
525 static inline void mapping_allow_writable(struct address_space *mapping)
526 {
527 	atomic_inc(&mapping->i_mmap_writable);
528 }
529 
530 /*
531  * Use sequence counter to get consistent i_size on 32-bit processors.
532  */
533 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
534 #include <linux/seqlock.h>
535 #define __NEED_I_SIZE_ORDERED
536 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
537 #else
538 #define i_size_ordered_init(inode) do { } while (0)
539 #endif
540 
541 struct posix_acl;
542 #define ACL_NOT_CACHED ((void *)(-1))
543 #define ACL_DONT_CACHE ((void *)(-3))
544 
545 static inline struct posix_acl *
546 uncached_acl_sentinel(struct task_struct *task)
547 {
548 	return (void *)task + 1;
549 }
550 
551 static inline bool
552 is_uncached_acl(struct posix_acl *acl)
553 {
554 	return (long)acl & 1;
555 }
556 
557 #define IOP_FASTPERM	0x0001
558 #define IOP_LOOKUP	0x0002
559 #define IOP_NOFOLLOW	0x0004
560 #define IOP_XATTR	0x0008
561 #define IOP_DEFAULT_READLINK	0x0010
562 
563 struct fsnotify_mark_connector;
564 
565 /*
566  * Keep mostly read-only and often accessed (especially for
567  * the RCU path lookup and 'stat' data) fields at the beginning
568  * of the 'struct inode'
569  */
570 struct inode {
571 	umode_t			i_mode;
572 	unsigned short		i_opflags;
573 	kuid_t			i_uid;
574 	kgid_t			i_gid;
575 	unsigned int		i_flags;
576 
577 #ifdef CONFIG_FS_POSIX_ACL
578 	struct posix_acl	*i_acl;
579 	struct posix_acl	*i_default_acl;
580 #endif
581 
582 	const struct inode_operations	*i_op;
583 	struct super_block	*i_sb;
584 	struct address_space	*i_mapping;
585 
586 #ifdef CONFIG_SECURITY
587 	void			*i_security;
588 #endif
589 
590 	/* Stat data, not accessed from path walking */
591 	unsigned long		i_ino;
592 	/*
593 	 * Filesystems may only read i_nlink directly.  They shall use the
594 	 * following functions for modification:
595 	 *
596 	 *    (set|clear|inc|drop)_nlink
597 	 *    inode_(inc|dec)_link_count
598 	 */
599 	union {
600 		const unsigned int i_nlink;
601 		unsigned int __i_nlink;
602 	};
603 	dev_t			i_rdev;
604 	loff_t			i_size;
605 	struct timespec		i_atime;
606 	struct timespec		i_mtime;
607 	struct timespec		i_ctime;
608 	spinlock_t		i_lock;	/* i_blocks, i_bytes, maybe i_size */
609 	unsigned short          i_bytes;
610 	unsigned int		i_blkbits;
611 	enum rw_hint		i_write_hint;
612 	blkcnt_t		i_blocks;
613 
614 #ifdef __NEED_I_SIZE_ORDERED
615 	seqcount_t		i_size_seqcount;
616 #endif
617 
618 	/* Misc */
619 	unsigned long		i_state;
620 	struct rw_semaphore	i_rwsem;
621 
622 	unsigned long		dirtied_when;	/* jiffies of first dirtying */
623 	unsigned long		dirtied_time_when;
624 
625 	struct hlist_node	i_hash;
626 	struct list_head	i_io_list;	/* backing dev IO list */
627 #ifdef CONFIG_CGROUP_WRITEBACK
628 	struct bdi_writeback	*i_wb;		/* the associated cgroup wb */
629 
630 	/* foreign inode detection, see wbc_detach_inode() */
631 	int			i_wb_frn_winner;
632 	u16			i_wb_frn_avg_time;
633 	u16			i_wb_frn_history;
634 #endif
635 	struct list_head	i_lru;		/* inode LRU list */
636 	struct list_head	i_sb_list;
637 	struct list_head	i_wb_list;	/* backing dev writeback list */
638 	union {
639 		struct hlist_head	i_dentry;
640 		struct rcu_head		i_rcu;
641 	};
642 	atomic64_t		i_version;
643 	atomic_t		i_count;
644 	atomic_t		i_dio_count;
645 	atomic_t		i_writecount;
646 #ifdef CONFIG_IMA
647 	atomic_t		i_readcount; /* struct files open RO */
648 #endif
649 	const struct file_operations	*i_fop;	/* former ->i_op->default_file_ops */
650 	struct file_lock_context	*i_flctx;
651 	struct address_space	i_data;
652 	struct list_head	i_devices;
653 	union {
654 		struct pipe_inode_info	*i_pipe;
655 		struct block_device	*i_bdev;
656 		struct cdev		*i_cdev;
657 		char			*i_link;
658 		unsigned		i_dir_seq;
659 	};
660 
661 	__u32			i_generation;
662 
663 #ifdef CONFIG_FSNOTIFY
664 	__u32			i_fsnotify_mask; /* all events this inode cares about */
665 	struct fsnotify_mark_connector __rcu	*i_fsnotify_marks;
666 #endif
667 
668 #if IS_ENABLED(CONFIG_FS_ENCRYPTION)
669 	struct fscrypt_info	*i_crypt_info;
670 #endif
671 
672 	void			*i_private; /* fs or device private pointer */
673 } __randomize_layout;
674 
675 static inline unsigned int i_blocksize(const struct inode *node)
676 {
677 	return (1 << node->i_blkbits);
678 }
679 
680 static inline int inode_unhashed(struct inode *inode)
681 {
682 	return hlist_unhashed(&inode->i_hash);
683 }
684 
685 /*
686  * inode->i_mutex nesting subclasses for the lock validator:
687  *
688  * 0: the object of the current VFS operation
689  * 1: parent
690  * 2: child/target
691  * 3: xattr
692  * 4: second non-directory
693  * 5: second parent (when locking independent directories in rename)
694  *
695  * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
696  * non-directories at once.
697  *
698  * The locking order between these classes is
699  * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
700  */
701 enum inode_i_mutex_lock_class
702 {
703 	I_MUTEX_NORMAL,
704 	I_MUTEX_PARENT,
705 	I_MUTEX_CHILD,
706 	I_MUTEX_XATTR,
707 	I_MUTEX_NONDIR2,
708 	I_MUTEX_PARENT2,
709 };
710 
711 static inline void inode_lock(struct inode *inode)
712 {
713 	down_write(&inode->i_rwsem);
714 }
715 
716 static inline void inode_unlock(struct inode *inode)
717 {
718 	up_write(&inode->i_rwsem);
719 }
720 
721 static inline void inode_lock_shared(struct inode *inode)
722 {
723 	down_read(&inode->i_rwsem);
724 }
725 
726 static inline void inode_unlock_shared(struct inode *inode)
727 {
728 	up_read(&inode->i_rwsem);
729 }
730 
731 static inline int inode_trylock(struct inode *inode)
732 {
733 	return down_write_trylock(&inode->i_rwsem);
734 }
735 
736 static inline int inode_trylock_shared(struct inode *inode)
737 {
738 	return down_read_trylock(&inode->i_rwsem);
739 }
740 
741 static inline int inode_is_locked(struct inode *inode)
742 {
743 	return rwsem_is_locked(&inode->i_rwsem);
744 }
745 
746 static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
747 {
748 	down_write_nested(&inode->i_rwsem, subclass);
749 }
750 
751 static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
752 {
753 	down_read_nested(&inode->i_rwsem, subclass);
754 }
755 
756 void lock_two_nondirectories(struct inode *, struct inode*);
757 void unlock_two_nondirectories(struct inode *, struct inode*);
758 
759 /*
760  * NOTE: in a 32bit arch with a preemptable kernel and
761  * an UP compile the i_size_read/write must be atomic
762  * with respect to the local cpu (unlike with preempt disabled),
763  * but they don't need to be atomic with respect to other cpus like in
764  * true SMP (so they need either to either locally disable irq around
765  * the read or for example on x86 they can be still implemented as a
766  * cmpxchg8b without the need of the lock prefix). For SMP compiles
767  * and 64bit archs it makes no difference if preempt is enabled or not.
768  */
769 static inline loff_t i_size_read(const struct inode *inode)
770 {
771 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
772 	loff_t i_size;
773 	unsigned int seq;
774 
775 	do {
776 		seq = read_seqcount_begin(&inode->i_size_seqcount);
777 		i_size = inode->i_size;
778 	} while (read_seqcount_retry(&inode->i_size_seqcount, seq));
779 	return i_size;
780 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
781 	loff_t i_size;
782 
783 	preempt_disable();
784 	i_size = inode->i_size;
785 	preempt_enable();
786 	return i_size;
787 #else
788 	return inode->i_size;
789 #endif
790 }
791 
792 /*
793  * NOTE: unlike i_size_read(), i_size_write() does need locking around it
794  * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
795  * can be lost, resulting in subsequent i_size_read() calls spinning forever.
796  */
797 static inline void i_size_write(struct inode *inode, loff_t i_size)
798 {
799 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
800 	preempt_disable();
801 	write_seqcount_begin(&inode->i_size_seqcount);
802 	inode->i_size = i_size;
803 	write_seqcount_end(&inode->i_size_seqcount);
804 	preempt_enable();
805 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
806 	preempt_disable();
807 	inode->i_size = i_size;
808 	preempt_enable();
809 #else
810 	inode->i_size = i_size;
811 #endif
812 }
813 
814 static inline unsigned iminor(const struct inode *inode)
815 {
816 	return MINOR(inode->i_rdev);
817 }
818 
819 static inline unsigned imajor(const struct inode *inode)
820 {
821 	return MAJOR(inode->i_rdev);
822 }
823 
824 extern struct block_device *I_BDEV(struct inode *inode);
825 
826 struct fown_struct {
827 	rwlock_t lock;          /* protects pid, uid, euid fields */
828 	struct pid *pid;	/* pid or -pgrp where SIGIO should be sent */
829 	enum pid_type pid_type;	/* Kind of process group SIGIO should be sent to */
830 	kuid_t uid, euid;	/* uid/euid of process setting the owner */
831 	int signum;		/* posix.1b rt signal to be delivered on IO */
832 };
833 
834 /*
835  * Track a single file's readahead state
836  */
837 struct file_ra_state {
838 	pgoff_t start;			/* where readahead started */
839 	unsigned int size;		/* # of readahead pages */
840 	unsigned int async_size;	/* do asynchronous readahead when
841 					   there are only # of pages ahead */
842 
843 	unsigned int ra_pages;		/* Maximum readahead window */
844 	unsigned int mmap_miss;		/* Cache miss stat for mmap accesses */
845 	loff_t prev_pos;		/* Cache last read() position */
846 };
847 
848 /*
849  * Check if @index falls in the readahead windows.
850  */
851 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
852 {
853 	return (index >= ra->start &&
854 		index <  ra->start + ra->size);
855 }
856 
857 struct file {
858 	union {
859 		struct llist_node	fu_llist;
860 		struct rcu_head 	fu_rcuhead;
861 	} f_u;
862 	struct path		f_path;
863 	struct inode		*f_inode;	/* cached value */
864 	const struct file_operations	*f_op;
865 
866 	/*
867 	 * Protects f_ep_links, f_flags.
868 	 * Must not be taken from IRQ context.
869 	 */
870 	spinlock_t		f_lock;
871 	enum rw_hint		f_write_hint;
872 	atomic_long_t		f_count;
873 	unsigned int 		f_flags;
874 	fmode_t			f_mode;
875 	struct mutex		f_pos_lock;
876 	loff_t			f_pos;
877 	struct fown_struct	f_owner;
878 	const struct cred	*f_cred;
879 	struct file_ra_state	f_ra;
880 
881 	u64			f_version;
882 #ifdef CONFIG_SECURITY
883 	void			*f_security;
884 #endif
885 	/* needed for tty driver, and maybe others */
886 	void			*private_data;
887 
888 #ifdef CONFIG_EPOLL
889 	/* Used by fs/eventpoll.c to link all the hooks to this file */
890 	struct list_head	f_ep_links;
891 	struct list_head	f_tfile_llink;
892 #endif /* #ifdef CONFIG_EPOLL */
893 	struct address_space	*f_mapping;
894 	errseq_t		f_wb_err;
895 } __randomize_layout
896   __attribute__((aligned(4)));	/* lest something weird decides that 2 is OK */
897 
898 struct file_handle {
899 	__u32 handle_bytes;
900 	int handle_type;
901 	/* file identifier */
902 	unsigned char f_handle[0];
903 };
904 
905 static inline struct file *get_file(struct file *f)
906 {
907 	atomic_long_inc(&f->f_count);
908 	return f;
909 }
910 #define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
911 #define fput_atomic(x)	atomic_long_add_unless(&(x)->f_count, -1, 1)
912 #define file_count(x)	atomic_long_read(&(x)->f_count)
913 
914 #define	MAX_NON_LFS	((1UL<<31) - 1)
915 
916 /* Page cache limit. The filesystems should put that into their s_maxbytes
917    limits, otherwise bad things can happen in VM. */
918 #if BITS_PER_LONG==32
919 #define MAX_LFS_FILESIZE	((loff_t)ULONG_MAX << PAGE_SHIFT)
920 #elif BITS_PER_LONG==64
921 #define MAX_LFS_FILESIZE 	((loff_t)LLONG_MAX)
922 #endif
923 
924 #define FL_POSIX	1
925 #define FL_FLOCK	2
926 #define FL_DELEG	4	/* NFSv4 delegation */
927 #define FL_ACCESS	8	/* not trying to lock, just looking */
928 #define FL_EXISTS	16	/* when unlocking, test for existence */
929 #define FL_LEASE	32	/* lease held on this file */
930 #define FL_CLOSE	64	/* unlock on close */
931 #define FL_SLEEP	128	/* A blocking lock */
932 #define FL_DOWNGRADE_PENDING	256 /* Lease is being downgraded */
933 #define FL_UNLOCK_PENDING	512 /* Lease is being broken */
934 #define FL_OFDLCK	1024	/* lock is "owned" by struct file */
935 #define FL_LAYOUT	2048	/* outstanding pNFS layout */
936 
937 #define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
938 
939 /*
940  * Special return value from posix_lock_file() and vfs_lock_file() for
941  * asynchronous locking.
942  */
943 #define FILE_LOCK_DEFERRED 1
944 
945 /* legacy typedef, should eventually be removed */
946 typedef void *fl_owner_t;
947 
948 struct file_lock;
949 
950 struct file_lock_operations {
951 	void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
952 	void (*fl_release_private)(struct file_lock *);
953 };
954 
955 struct lock_manager_operations {
956 	int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
957 	unsigned long (*lm_owner_key)(struct file_lock *);
958 	fl_owner_t (*lm_get_owner)(fl_owner_t);
959 	void (*lm_put_owner)(fl_owner_t);
960 	void (*lm_notify)(struct file_lock *);	/* unblock callback */
961 	int (*lm_grant)(struct file_lock *, int);
962 	bool (*lm_break)(struct file_lock *);
963 	int (*lm_change)(struct file_lock *, int, struct list_head *);
964 	void (*lm_setup)(struct file_lock *, void **);
965 };
966 
967 struct lock_manager {
968 	struct list_head list;
969 	/*
970 	 * NFSv4 and up also want opens blocked during the grace period;
971 	 * NLM doesn't care:
972 	 */
973 	bool block_opens;
974 };
975 
976 struct net;
977 void locks_start_grace(struct net *, struct lock_manager *);
978 void locks_end_grace(struct lock_manager *);
979 bool locks_in_grace(struct net *);
980 bool opens_in_grace(struct net *);
981 
982 /* that will die - we need it for nfs_lock_info */
983 #include <linux/nfs_fs_i.h>
984 
985 /*
986  * struct file_lock represents a generic "file lock". It's used to represent
987  * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
988  * note that the same struct is used to represent both a request for a lock and
989  * the lock itself, but the same object is never used for both.
990  *
991  * FIXME: should we create a separate "struct lock_request" to help distinguish
992  * these two uses?
993  *
994  * The varous i_flctx lists are ordered by:
995  *
996  * 1) lock owner
997  * 2) lock range start
998  * 3) lock range end
999  *
1000  * Obviously, the last two criteria only matter for POSIX locks.
1001  */
1002 struct file_lock {
1003 	struct file_lock *fl_next;	/* singly linked list for this inode  */
1004 	struct list_head fl_list;	/* link into file_lock_context */
1005 	struct hlist_node fl_link;	/* node in global lists */
1006 	struct list_head fl_block;	/* circular list of blocked processes */
1007 	fl_owner_t fl_owner;
1008 	unsigned int fl_flags;
1009 	unsigned char fl_type;
1010 	unsigned int fl_pid;
1011 	int fl_link_cpu;		/* what cpu's list is this on? */
1012 	wait_queue_head_t fl_wait;
1013 	struct file *fl_file;
1014 	loff_t fl_start;
1015 	loff_t fl_end;
1016 
1017 	struct fasync_struct *	fl_fasync; /* for lease break notifications */
1018 	/* for lease breaks: */
1019 	unsigned long fl_break_time;
1020 	unsigned long fl_downgrade_time;
1021 
1022 	const struct file_lock_operations *fl_ops;	/* Callbacks for filesystems */
1023 	const struct lock_manager_operations *fl_lmops;	/* Callbacks for lockmanagers */
1024 	union {
1025 		struct nfs_lock_info	nfs_fl;
1026 		struct nfs4_lock_info	nfs4_fl;
1027 		struct {
1028 			struct list_head link;	/* link in AFS vnode's pending_locks list */
1029 			int state;		/* state of grant or error if -ve */
1030 		} afs;
1031 	} fl_u;
1032 } __randomize_layout;
1033 
1034 struct file_lock_context {
1035 	spinlock_t		flc_lock;
1036 	struct list_head	flc_flock;
1037 	struct list_head	flc_posix;
1038 	struct list_head	flc_lease;
1039 };
1040 
1041 /* The following constant reflects the upper bound of the file/locking space */
1042 #ifndef OFFSET_MAX
1043 #define INT_LIMIT(x)	(~((x)1 << (sizeof(x)*8 - 1)))
1044 #define OFFSET_MAX	INT_LIMIT(loff_t)
1045 #define OFFT_OFFSET_MAX	INT_LIMIT(off_t)
1046 #endif
1047 
1048 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1049 
1050 /*
1051  * Return the inode to use for locking
1052  *
1053  * For overlayfs this should be the overlay inode, not the real inode returned
1054  * by file_inode().  For any other fs file_inode(filp) and locks_inode(filp) are
1055  * equal.
1056  */
1057 static inline struct inode *locks_inode(const struct file *f)
1058 {
1059 	return f->f_path.dentry->d_inode;
1060 }
1061 
1062 #ifdef CONFIG_FILE_LOCKING
1063 extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1064 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1065 			struct flock *);
1066 
1067 #if BITS_PER_LONG == 32
1068 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1069 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1070 			struct flock64 *);
1071 #endif
1072 
1073 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1074 extern int fcntl_getlease(struct file *filp);
1075 
1076 /* fs/locks.c */
1077 void locks_free_lock_context(struct inode *inode);
1078 void locks_free_lock(struct file_lock *fl);
1079 extern void locks_init_lock(struct file_lock *);
1080 extern struct file_lock * locks_alloc_lock(void);
1081 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1082 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1083 extern void locks_remove_posix(struct file *, fl_owner_t);
1084 extern void locks_remove_file(struct file *);
1085 extern void locks_release_private(struct file_lock *);
1086 extern void posix_test_lock(struct file *, struct file_lock *);
1087 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1088 extern int posix_unblock_lock(struct file_lock *);
1089 extern int vfs_test_lock(struct file *, struct file_lock *);
1090 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1091 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1092 extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
1093 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1094 extern void lease_get_mtime(struct inode *, struct timespec *time);
1095 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1096 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1097 extern int lease_modify(struct file_lock *, int, struct list_head *);
1098 struct files_struct;
1099 extern void show_fd_locks(struct seq_file *f,
1100 			 struct file *filp, struct files_struct *files);
1101 #else /* !CONFIG_FILE_LOCKING */
1102 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1103 			      struct flock __user *user)
1104 {
1105 	return -EINVAL;
1106 }
1107 
1108 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1109 			      unsigned int cmd, struct flock __user *user)
1110 {
1111 	return -EACCES;
1112 }
1113 
1114 #if BITS_PER_LONG == 32
1115 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1116 				struct flock64 __user *user)
1117 {
1118 	return -EINVAL;
1119 }
1120 
1121 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1122 				unsigned int cmd, struct flock64 __user *user)
1123 {
1124 	return -EACCES;
1125 }
1126 #endif
1127 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1128 {
1129 	return -EINVAL;
1130 }
1131 
1132 static inline int fcntl_getlease(struct file *filp)
1133 {
1134 	return F_UNLCK;
1135 }
1136 
1137 static inline void
1138 locks_free_lock_context(struct inode *inode)
1139 {
1140 }
1141 
1142 static inline void locks_init_lock(struct file_lock *fl)
1143 {
1144 	return;
1145 }
1146 
1147 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1148 {
1149 	return;
1150 }
1151 
1152 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1153 {
1154 	return;
1155 }
1156 
1157 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1158 {
1159 	return;
1160 }
1161 
1162 static inline void locks_remove_file(struct file *filp)
1163 {
1164 	return;
1165 }
1166 
1167 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1168 {
1169 	return;
1170 }
1171 
1172 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1173 				  struct file_lock *conflock)
1174 {
1175 	return -ENOLCK;
1176 }
1177 
1178 static inline int posix_unblock_lock(struct file_lock *waiter)
1179 {
1180 	return -ENOENT;
1181 }
1182 
1183 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1184 {
1185 	return 0;
1186 }
1187 
1188 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1189 				struct file_lock *fl, struct file_lock *conf)
1190 {
1191 	return -ENOLCK;
1192 }
1193 
1194 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1195 {
1196 	return 0;
1197 }
1198 
1199 static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1200 {
1201 	return -ENOLCK;
1202 }
1203 
1204 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1205 {
1206 	return 0;
1207 }
1208 
1209 static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1210 {
1211 	return;
1212 }
1213 
1214 static inline int generic_setlease(struct file *filp, long arg,
1215 				    struct file_lock **flp, void **priv)
1216 {
1217 	return -EINVAL;
1218 }
1219 
1220 static inline int vfs_setlease(struct file *filp, long arg,
1221 			       struct file_lock **lease, void **priv)
1222 {
1223 	return -EINVAL;
1224 }
1225 
1226 static inline int lease_modify(struct file_lock *fl, int arg,
1227 			       struct list_head *dispose)
1228 {
1229 	return -EINVAL;
1230 }
1231 
1232 struct files_struct;
1233 static inline void show_fd_locks(struct seq_file *f,
1234 			struct file *filp, struct files_struct *files) {}
1235 #endif /* !CONFIG_FILE_LOCKING */
1236 
1237 static inline struct inode *file_inode(const struct file *f)
1238 {
1239 	return f->f_inode;
1240 }
1241 
1242 static inline struct dentry *file_dentry(const struct file *file)
1243 {
1244 	return d_real(file->f_path.dentry, file_inode(file), 0, 0);
1245 }
1246 
1247 static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1248 {
1249 	return locks_lock_inode_wait(locks_inode(filp), fl);
1250 }
1251 
1252 struct fasync_struct {
1253 	spinlock_t		fa_lock;
1254 	int			magic;
1255 	int			fa_fd;
1256 	struct fasync_struct	*fa_next; /* singly linked list */
1257 	struct file		*fa_file;
1258 	struct rcu_head		fa_rcu;
1259 };
1260 
1261 #define FASYNC_MAGIC 0x4601
1262 
1263 /* SMP safe fasync helpers: */
1264 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1265 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1266 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1267 extern struct fasync_struct *fasync_alloc(void);
1268 extern void fasync_free(struct fasync_struct *);
1269 
1270 /* can be called from interrupts */
1271 extern void kill_fasync(struct fasync_struct **, int, int);
1272 
1273 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1274 extern int f_setown(struct file *filp, unsigned long arg, int force);
1275 extern void f_delown(struct file *filp);
1276 extern pid_t f_getown(struct file *filp);
1277 extern int send_sigurg(struct fown_struct *fown);
1278 
1279 /*
1280  * sb->s_flags.  Note that these mirror the equivalent MS_* flags where
1281  * represented in both.
1282  */
1283 #define SB_RDONLY	 1	/* Mount read-only */
1284 #define SB_NOSUID	 2	/* Ignore suid and sgid bits */
1285 #define SB_NODEV	 4	/* Disallow access to device special files */
1286 #define SB_NOEXEC	 8	/* Disallow program execution */
1287 #define SB_SYNCHRONOUS	16	/* Writes are synced at once */
1288 #define SB_MANDLOCK	64	/* Allow mandatory locks on an FS */
1289 #define SB_DIRSYNC	128	/* Directory modifications are synchronous */
1290 #define SB_NOATIME	1024	/* Do not update access times. */
1291 #define SB_NODIRATIME	2048	/* Do not update directory access times */
1292 #define SB_SILENT	32768
1293 #define SB_POSIXACL	(1<<16)	/* VFS does not apply the umask */
1294 #define SB_KERNMOUNT	(1<<22) /* this is a kern_mount call */
1295 #define SB_I_VERSION	(1<<23) /* Update inode I_version field */
1296 #define SB_LAZYTIME	(1<<25) /* Update the on-disk [acm]times lazily */
1297 
1298 /* These sb flags are internal to the kernel */
1299 #define SB_SUBMOUNT     (1<<26)
1300 #define SB_NOREMOTELOCK	(1<<27)
1301 #define SB_NOSEC	(1<<28)
1302 #define SB_BORN		(1<<29)
1303 #define SB_ACTIVE	(1<<30)
1304 #define SB_NOUSER	(1<<31)
1305 
1306 /*
1307  *	Umount options
1308  */
1309 
1310 #define MNT_FORCE	0x00000001	/* Attempt to forcibily umount */
1311 #define MNT_DETACH	0x00000002	/* Just detach from the tree */
1312 #define MNT_EXPIRE	0x00000004	/* Mark for expiry */
1313 #define UMOUNT_NOFOLLOW	0x00000008	/* Don't follow symlink on umount */
1314 #define UMOUNT_UNUSED	0x80000000	/* Flag guaranteed to be unused */
1315 
1316 /* sb->s_iflags */
1317 #define SB_I_CGROUPWB	0x00000001	/* cgroup-aware writeback enabled */
1318 #define SB_I_NOEXEC	0x00000002	/* Ignore executables on this fs */
1319 #define SB_I_NODEV	0x00000004	/* Ignore devices on this fs */
1320 
1321 /* sb->s_iflags to limit user namespace mounts */
1322 #define SB_I_USERNS_VISIBLE		0x00000010 /* fstype already mounted */
1323 
1324 /* Possible states of 'frozen' field */
1325 enum {
1326 	SB_UNFROZEN = 0,		/* FS is unfrozen */
1327 	SB_FREEZE_WRITE	= 1,		/* Writes, dir ops, ioctls frozen */
1328 	SB_FREEZE_PAGEFAULT = 2,	/* Page faults stopped as well */
1329 	SB_FREEZE_FS = 3,		/* For internal FS use (e.g. to stop
1330 					 * internal threads if needed) */
1331 	SB_FREEZE_COMPLETE = 4,		/* ->freeze_fs finished successfully */
1332 };
1333 
1334 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1335 
1336 struct sb_writers {
1337 	int				frozen;		/* Is sb frozen? */
1338 	wait_queue_head_t		wait_unfrozen;	/* for get_super_thawed() */
1339 	struct percpu_rw_semaphore	rw_sem[SB_FREEZE_LEVELS];
1340 };
1341 
1342 struct super_block {
1343 	struct list_head	s_list;		/* Keep this first */
1344 	dev_t			s_dev;		/* search index; _not_ kdev_t */
1345 	unsigned char		s_blocksize_bits;
1346 	unsigned long		s_blocksize;
1347 	loff_t			s_maxbytes;	/* Max file size */
1348 	struct file_system_type	*s_type;
1349 	const struct super_operations	*s_op;
1350 	const struct dquot_operations	*dq_op;
1351 	const struct quotactl_ops	*s_qcop;
1352 	const struct export_operations *s_export_op;
1353 	unsigned long		s_flags;
1354 	unsigned long		s_iflags;	/* internal SB_I_* flags */
1355 	unsigned long		s_magic;
1356 	struct dentry		*s_root;
1357 	struct rw_semaphore	s_umount;
1358 	int			s_count;
1359 	atomic_t		s_active;
1360 #ifdef CONFIG_SECURITY
1361 	void                    *s_security;
1362 #endif
1363 	const struct xattr_handler **s_xattr;
1364 
1365 	const struct fscrypt_operations	*s_cop;
1366 
1367 	struct hlist_bl_head	s_roots;	/* alternate root dentries for NFS */
1368 	struct list_head	s_mounts;	/* list of mounts; _not_ for fs use */
1369 	struct block_device	*s_bdev;
1370 	struct backing_dev_info *s_bdi;
1371 	struct mtd_info		*s_mtd;
1372 	struct hlist_node	s_instances;
1373 	unsigned int		s_quota_types;	/* Bitmask of supported quota types */
1374 	struct quota_info	s_dquot;	/* Diskquota specific options */
1375 
1376 	struct sb_writers	s_writers;
1377 
1378 	char			s_id[32];	/* Informational name */
1379 	uuid_t			s_uuid;		/* UUID */
1380 
1381 	void 			*s_fs_info;	/* Filesystem private info */
1382 	unsigned int		s_max_links;
1383 	fmode_t			s_mode;
1384 
1385 	/* Granularity of c/m/atime in ns.
1386 	   Cannot be worse than a second */
1387 	u32		   s_time_gran;
1388 
1389 	/*
1390 	 * The next field is for VFS *only*. No filesystems have any business
1391 	 * even looking at it. You had been warned.
1392 	 */
1393 	struct mutex s_vfs_rename_mutex;	/* Kludge */
1394 
1395 	/*
1396 	 * Filesystem subtype.  If non-empty the filesystem type field
1397 	 * in /proc/mounts will be "type.subtype"
1398 	 */
1399 	char *s_subtype;
1400 
1401 	const struct dentry_operations *s_d_op; /* default d_op for dentries */
1402 
1403 	/*
1404 	 * Saved pool identifier for cleancache (-1 means none)
1405 	 */
1406 	int cleancache_poolid;
1407 
1408 	struct shrinker s_shrink;	/* per-sb shrinker handle */
1409 
1410 	/* Number of inodes with nlink == 0 but still referenced */
1411 	atomic_long_t s_remove_count;
1412 
1413 	/* Being remounted read-only */
1414 	int s_readonly_remount;
1415 
1416 	/* AIO completions deferred from interrupt context */
1417 	struct workqueue_struct *s_dio_done_wq;
1418 	struct hlist_head s_pins;
1419 
1420 	/*
1421 	 * Owning user namespace and default context in which to
1422 	 * interpret filesystem uids, gids, quotas, device nodes,
1423 	 * xattrs and security labels.
1424 	 */
1425 	struct user_namespace *s_user_ns;
1426 
1427 	/*
1428 	 * Keep the lru lists last in the structure so they always sit on their
1429 	 * own individual cachelines.
1430 	 */
1431 	struct list_lru		s_dentry_lru ____cacheline_aligned_in_smp;
1432 	struct list_lru		s_inode_lru ____cacheline_aligned_in_smp;
1433 	struct rcu_head		rcu;
1434 	struct work_struct	destroy_work;
1435 
1436 	struct mutex		s_sync_lock;	/* sync serialisation lock */
1437 
1438 	/*
1439 	 * Indicates how deep in a filesystem stack this SB is
1440 	 */
1441 	int s_stack_depth;
1442 
1443 	/* s_inode_list_lock protects s_inodes */
1444 	spinlock_t		s_inode_list_lock ____cacheline_aligned_in_smp;
1445 	struct list_head	s_inodes;	/* all inodes */
1446 
1447 	spinlock_t		s_inode_wblist_lock;
1448 	struct list_head	s_inodes_wb;	/* writeback inodes */
1449 } __randomize_layout;
1450 
1451 /* Helper functions so that in most cases filesystems will
1452  * not need to deal directly with kuid_t and kgid_t and can
1453  * instead deal with the raw numeric values that are stored
1454  * in the filesystem.
1455  */
1456 static inline uid_t i_uid_read(const struct inode *inode)
1457 {
1458 	return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1459 }
1460 
1461 static inline gid_t i_gid_read(const struct inode *inode)
1462 {
1463 	return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1464 }
1465 
1466 static inline void i_uid_write(struct inode *inode, uid_t uid)
1467 {
1468 	inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1469 }
1470 
1471 static inline void i_gid_write(struct inode *inode, gid_t gid)
1472 {
1473 	inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1474 }
1475 
1476 extern struct timespec current_time(struct inode *inode);
1477 
1478 /*
1479  * Snapshotting support.
1480  */
1481 
1482 void __sb_end_write(struct super_block *sb, int level);
1483 int __sb_start_write(struct super_block *sb, int level, bool wait);
1484 
1485 #define __sb_writers_acquired(sb, lev)	\
1486 	percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1487 #define __sb_writers_release(sb, lev)	\
1488 	percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1489 
1490 /**
1491  * sb_end_write - drop write access to a superblock
1492  * @sb: the super we wrote to
1493  *
1494  * Decrement number of writers to the filesystem. Wake up possible waiters
1495  * wanting to freeze the filesystem.
1496  */
1497 static inline void sb_end_write(struct super_block *sb)
1498 {
1499 	__sb_end_write(sb, SB_FREEZE_WRITE);
1500 }
1501 
1502 /**
1503  * sb_end_pagefault - drop write access to a superblock from a page fault
1504  * @sb: the super we wrote to
1505  *
1506  * Decrement number of processes handling write page fault to the filesystem.
1507  * Wake up possible waiters wanting to freeze the filesystem.
1508  */
1509 static inline void sb_end_pagefault(struct super_block *sb)
1510 {
1511 	__sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1512 }
1513 
1514 /**
1515  * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1516  * @sb: the super we wrote to
1517  *
1518  * Decrement fs-internal number of writers to the filesystem.  Wake up possible
1519  * waiters wanting to freeze the filesystem.
1520  */
1521 static inline void sb_end_intwrite(struct super_block *sb)
1522 {
1523 	__sb_end_write(sb, SB_FREEZE_FS);
1524 }
1525 
1526 /**
1527  * sb_start_write - get write access to a superblock
1528  * @sb: the super we write to
1529  *
1530  * When a process wants to write data or metadata to a file system (i.e. dirty
1531  * a page or an inode), it should embed the operation in a sb_start_write() -
1532  * sb_end_write() pair to get exclusion against file system freezing. This
1533  * function increments number of writers preventing freezing. If the file
1534  * system is already frozen, the function waits until the file system is
1535  * thawed.
1536  *
1537  * Since freeze protection behaves as a lock, users have to preserve
1538  * ordering of freeze protection and other filesystem locks. Generally,
1539  * freeze protection should be the outermost lock. In particular, we have:
1540  *
1541  * sb_start_write
1542  *   -> i_mutex			(write path, truncate, directory ops, ...)
1543  *   -> s_umount		(freeze_super, thaw_super)
1544  */
1545 static inline void sb_start_write(struct super_block *sb)
1546 {
1547 	__sb_start_write(sb, SB_FREEZE_WRITE, true);
1548 }
1549 
1550 static inline int sb_start_write_trylock(struct super_block *sb)
1551 {
1552 	return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1553 }
1554 
1555 /**
1556  * sb_start_pagefault - get write access to a superblock from a page fault
1557  * @sb: the super we write to
1558  *
1559  * When a process starts handling write page fault, it should embed the
1560  * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1561  * exclusion against file system freezing. This is needed since the page fault
1562  * is going to dirty a page. This function increments number of running page
1563  * faults preventing freezing. If the file system is already frozen, the
1564  * function waits until the file system is thawed.
1565  *
1566  * Since page fault freeze protection behaves as a lock, users have to preserve
1567  * ordering of freeze protection and other filesystem locks. It is advised to
1568  * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1569  * handling code implies lock dependency:
1570  *
1571  * mmap_sem
1572  *   -> sb_start_pagefault
1573  */
1574 static inline void sb_start_pagefault(struct super_block *sb)
1575 {
1576 	__sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1577 }
1578 
1579 /*
1580  * sb_start_intwrite - get write access to a superblock for internal fs purposes
1581  * @sb: the super we write to
1582  *
1583  * This is the third level of protection against filesystem freezing. It is
1584  * free for use by a filesystem. The only requirement is that it must rank
1585  * below sb_start_pagefault.
1586  *
1587  * For example filesystem can call sb_start_intwrite() when starting a
1588  * transaction which somewhat eases handling of freezing for internal sources
1589  * of filesystem changes (internal fs threads, discarding preallocation on file
1590  * close, etc.).
1591  */
1592 static inline void sb_start_intwrite(struct super_block *sb)
1593 {
1594 	__sb_start_write(sb, SB_FREEZE_FS, true);
1595 }
1596 
1597 
1598 extern bool inode_owner_or_capable(const struct inode *inode);
1599 
1600 /*
1601  * VFS helper functions..
1602  */
1603 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1604 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1605 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1606 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1607 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1608 extern int vfs_rmdir(struct inode *, struct dentry *);
1609 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1610 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1611 extern int vfs_whiteout(struct inode *, struct dentry *);
1612 
1613 extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1614 				  int open_flag);
1615 
1616 int vfs_mkobj(struct dentry *, umode_t,
1617 		int (*f)(struct dentry *, umode_t, void *),
1618 		void *);
1619 
1620 /*
1621  * VFS file helper functions.
1622  */
1623 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1624 			umode_t mode);
1625 extern bool may_open_dev(const struct path *path);
1626 /*
1627  * VFS FS_IOC_FIEMAP helper definitions.
1628  */
1629 struct fiemap_extent_info {
1630 	unsigned int fi_flags;		/* Flags as passed from user */
1631 	unsigned int fi_extents_mapped;	/* Number of mapped extents */
1632 	unsigned int fi_extents_max;	/* Size of fiemap_extent array */
1633 	struct fiemap_extent __user *fi_extents_start; /* Start of
1634 							fiemap_extent array */
1635 };
1636 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1637 			    u64 phys, u64 len, u32 flags);
1638 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1639 
1640 /*
1641  * File types
1642  *
1643  * NOTE! These match bits 12..15 of stat.st_mode
1644  * (ie "(i_mode >> 12) & 15").
1645  */
1646 #define DT_UNKNOWN	0
1647 #define DT_FIFO		1
1648 #define DT_CHR		2
1649 #define DT_DIR		4
1650 #define DT_BLK		6
1651 #define DT_REG		8
1652 #define DT_LNK		10
1653 #define DT_SOCK		12
1654 #define DT_WHT		14
1655 
1656 /*
1657  * This is the "filldir" function type, used by readdir() to let
1658  * the kernel specify what kind of dirent layout it wants to have.
1659  * This allows the kernel to read directories into kernel space or
1660  * to have different dirent layouts depending on the binary type.
1661  */
1662 struct dir_context;
1663 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1664 			 unsigned);
1665 
1666 struct dir_context {
1667 	const filldir_t actor;
1668 	loff_t pos;
1669 };
1670 
1671 struct block_device_operations;
1672 
1673 /* These macros are for out of kernel modules to test that
1674  * the kernel supports the unlocked_ioctl and compat_ioctl
1675  * fields in struct file_operations. */
1676 #define HAVE_COMPAT_IOCTL 1
1677 #define HAVE_UNLOCKED_IOCTL 1
1678 
1679 /*
1680  * These flags let !MMU mmap() govern direct device mapping vs immediate
1681  * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1682  *
1683  * NOMMU_MAP_COPY:	Copy can be mapped (MAP_PRIVATE)
1684  * NOMMU_MAP_DIRECT:	Can be mapped directly (MAP_SHARED)
1685  * NOMMU_MAP_READ:	Can be mapped for reading
1686  * NOMMU_MAP_WRITE:	Can be mapped for writing
1687  * NOMMU_MAP_EXEC:	Can be mapped for execution
1688  */
1689 #define NOMMU_MAP_COPY		0x00000001
1690 #define NOMMU_MAP_DIRECT	0x00000008
1691 #define NOMMU_MAP_READ		VM_MAYREAD
1692 #define NOMMU_MAP_WRITE		VM_MAYWRITE
1693 #define NOMMU_MAP_EXEC		VM_MAYEXEC
1694 
1695 #define NOMMU_VMFLAGS \
1696 	(NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1697 
1698 
1699 struct iov_iter;
1700 
1701 struct file_operations {
1702 	struct module *owner;
1703 	loff_t (*llseek) (struct file *, loff_t, int);
1704 	ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1705 	ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1706 	ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1707 	ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1708 	int (*iterate) (struct file *, struct dir_context *);
1709 	int (*iterate_shared) (struct file *, struct dir_context *);
1710 	__poll_t (*poll) (struct file *, struct poll_table_struct *);
1711 	long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1712 	long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1713 	int (*mmap) (struct file *, struct vm_area_struct *);
1714 	unsigned long mmap_supported_flags;
1715 	int (*open) (struct inode *, struct file *);
1716 	int (*flush) (struct file *, fl_owner_t id);
1717 	int (*release) (struct inode *, struct file *);
1718 	int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1719 	int (*fasync) (int, struct file *, int);
1720 	int (*lock) (struct file *, int, struct file_lock *);
1721 	ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1722 	unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1723 	int (*check_flags)(int);
1724 	int (*flock) (struct file *, int, struct file_lock *);
1725 	ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1726 	ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1727 	int (*setlease)(struct file *, long, struct file_lock **, void **);
1728 	long (*fallocate)(struct file *file, int mode, loff_t offset,
1729 			  loff_t len);
1730 	void (*show_fdinfo)(struct seq_file *m, struct file *f);
1731 #ifndef CONFIG_MMU
1732 	unsigned (*mmap_capabilities)(struct file *);
1733 #endif
1734 	ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1735 			loff_t, size_t, unsigned int);
1736 	int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1737 			u64);
1738 	ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1739 			u64);
1740 } __randomize_layout;
1741 
1742 struct inode_operations {
1743 	struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1744 	const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1745 	int (*permission) (struct inode *, int);
1746 	struct posix_acl * (*get_acl)(struct inode *, int);
1747 
1748 	int (*readlink) (struct dentry *, char __user *,int);
1749 
1750 	int (*create) (struct inode *,struct dentry *, umode_t, bool);
1751 	int (*link) (struct dentry *,struct inode *,struct dentry *);
1752 	int (*unlink) (struct inode *,struct dentry *);
1753 	int (*symlink) (struct inode *,struct dentry *,const char *);
1754 	int (*mkdir) (struct inode *,struct dentry *,umode_t);
1755 	int (*rmdir) (struct inode *,struct dentry *);
1756 	int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1757 	int (*rename) (struct inode *, struct dentry *,
1758 			struct inode *, struct dentry *, unsigned int);
1759 	int (*setattr) (struct dentry *, struct iattr *);
1760 	int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1761 	ssize_t (*listxattr) (struct dentry *, char *, size_t);
1762 	int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1763 		      u64 len);
1764 	int (*update_time)(struct inode *, struct timespec *, int);
1765 	int (*atomic_open)(struct inode *, struct dentry *,
1766 			   struct file *, unsigned open_flag,
1767 			   umode_t create_mode, int *opened);
1768 	int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1769 	int (*set_acl)(struct inode *, struct posix_acl *, int);
1770 } ____cacheline_aligned;
1771 
1772 static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1773 				     struct iov_iter *iter)
1774 {
1775 	return file->f_op->read_iter(kio, iter);
1776 }
1777 
1778 static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1779 				      struct iov_iter *iter)
1780 {
1781 	return file->f_op->write_iter(kio, iter);
1782 }
1783 
1784 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1785 {
1786 	return file->f_op->mmap(file, vma);
1787 }
1788 
1789 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1790 			      unsigned long nr_segs, unsigned long fast_segs,
1791 			      struct iovec *fast_pointer,
1792 			      struct iovec **ret_pointer);
1793 
1794 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1795 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1796 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1797 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1798 		unsigned long, loff_t *, rwf_t);
1799 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1800 				   loff_t, size_t, unsigned int);
1801 extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1802 				      struct inode *inode_out, loff_t pos_out,
1803 				      u64 *len, bool is_dedupe);
1804 extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1805 		struct file *file_out, loff_t pos_out, u64 len);
1806 extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1807 					 struct inode *dest, loff_t destoff,
1808 					 loff_t len, bool *is_same);
1809 extern int vfs_dedupe_file_range(struct file *file,
1810 				 struct file_dedupe_range *same);
1811 
1812 struct super_operations {
1813    	struct inode *(*alloc_inode)(struct super_block *sb);
1814 	void (*destroy_inode)(struct inode *);
1815 
1816    	void (*dirty_inode) (struct inode *, int flags);
1817 	int (*write_inode) (struct inode *, struct writeback_control *wbc);
1818 	int (*drop_inode) (struct inode *);
1819 	void (*evict_inode) (struct inode *);
1820 	void (*put_super) (struct super_block *);
1821 	int (*sync_fs)(struct super_block *sb, int wait);
1822 	int (*freeze_super) (struct super_block *);
1823 	int (*freeze_fs) (struct super_block *);
1824 	int (*thaw_super) (struct super_block *);
1825 	int (*unfreeze_fs) (struct super_block *);
1826 	int (*statfs) (struct dentry *, struct kstatfs *);
1827 	int (*remount_fs) (struct super_block *, int *, char *);
1828 	void (*umount_begin) (struct super_block *);
1829 
1830 	int (*show_options)(struct seq_file *, struct dentry *);
1831 	int (*show_devname)(struct seq_file *, struct dentry *);
1832 	int (*show_path)(struct seq_file *, struct dentry *);
1833 	int (*show_stats)(struct seq_file *, struct dentry *);
1834 #ifdef CONFIG_QUOTA
1835 	ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1836 	ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1837 	struct dquot **(*get_dquots)(struct inode *);
1838 #endif
1839 	int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1840 	long (*nr_cached_objects)(struct super_block *,
1841 				  struct shrink_control *);
1842 	long (*free_cached_objects)(struct super_block *,
1843 				    struct shrink_control *);
1844 };
1845 
1846 /*
1847  * Inode flags - they have no relation to superblock flags now
1848  */
1849 #define S_SYNC		1	/* Writes are synced at once */
1850 #define S_NOATIME	2	/* Do not update access times */
1851 #define S_APPEND	4	/* Append-only file */
1852 #define S_IMMUTABLE	8	/* Immutable file */
1853 #define S_DEAD		16	/* removed, but still open directory */
1854 #define S_NOQUOTA	32	/* Inode is not counted to quota */
1855 #define S_DIRSYNC	64	/* Directory modifications are synchronous */
1856 #define S_NOCMTIME	128	/* Do not update file c/mtime */
1857 #define S_SWAPFILE	256	/* Do not truncate: swapon got its bmaps */
1858 #define S_PRIVATE	512	/* Inode is fs-internal */
1859 #define S_IMA		1024	/* Inode has an associated IMA struct */
1860 #define S_AUTOMOUNT	2048	/* Automount/referral quasi-directory */
1861 #define S_NOSEC		4096	/* no suid or xattr security attributes */
1862 #ifdef CONFIG_FS_DAX
1863 #define S_DAX		8192	/* Direct Access, avoiding the page cache */
1864 #else
1865 #define S_DAX		0	/* Make all the DAX code disappear */
1866 #endif
1867 #define S_ENCRYPTED	16384	/* Encrypted file (using fs/crypto/) */
1868 
1869 /*
1870  * Note that nosuid etc flags are inode-specific: setting some file-system
1871  * flags just means all the inodes inherit those flags by default. It might be
1872  * possible to override it selectively if you really wanted to with some
1873  * ioctl() that is not currently implemented.
1874  *
1875  * Exception: SB_RDONLY is always applied to the entire file system.
1876  *
1877  * Unfortunately, it is possible to change a filesystems flags with it mounted
1878  * with files in use.  This means that all of the inodes will not have their
1879  * i_flags updated.  Hence, i_flags no longer inherit the superblock mount
1880  * flags, so these have to be checked separately. -- [email protected]
1881  */
1882 #define __IS_FLG(inode, flg)	((inode)->i_sb->s_flags & (flg))
1883 
1884 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
1885 #define IS_RDONLY(inode)	sb_rdonly((inode)->i_sb)
1886 #define IS_SYNC(inode)		(__IS_FLG(inode, SB_SYNCHRONOUS) || \
1887 					((inode)->i_flags & S_SYNC))
1888 #define IS_DIRSYNC(inode)	(__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
1889 					((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1890 #define IS_MANDLOCK(inode)	__IS_FLG(inode, SB_MANDLOCK)
1891 #define IS_NOATIME(inode)	__IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1892 #define IS_I_VERSION(inode)	__IS_FLG(inode, SB_I_VERSION)
1893 
1894 #define IS_NOQUOTA(inode)	((inode)->i_flags & S_NOQUOTA)
1895 #define IS_APPEND(inode)	((inode)->i_flags & S_APPEND)
1896 #define IS_IMMUTABLE(inode)	((inode)->i_flags & S_IMMUTABLE)
1897 #define IS_POSIXACL(inode)	__IS_FLG(inode, SB_POSIXACL)
1898 
1899 #define IS_DEADDIR(inode)	((inode)->i_flags & S_DEAD)
1900 #define IS_NOCMTIME(inode)	((inode)->i_flags & S_NOCMTIME)
1901 #define IS_SWAPFILE(inode)	((inode)->i_flags & S_SWAPFILE)
1902 #define IS_PRIVATE(inode)	((inode)->i_flags & S_PRIVATE)
1903 #define IS_IMA(inode)		((inode)->i_flags & S_IMA)
1904 #define IS_AUTOMOUNT(inode)	((inode)->i_flags & S_AUTOMOUNT)
1905 #define IS_NOSEC(inode)		((inode)->i_flags & S_NOSEC)
1906 #define IS_DAX(inode)		((inode)->i_flags & S_DAX)
1907 #define IS_ENCRYPTED(inode)	((inode)->i_flags & S_ENCRYPTED)
1908 
1909 #define IS_WHITEOUT(inode)	(S_ISCHR(inode->i_mode) && \
1910 				 (inode)->i_rdev == WHITEOUT_DEV)
1911 
1912 static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1913 {
1914 	return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1915 }
1916 
1917 static inline enum rw_hint file_write_hint(struct file *file)
1918 {
1919 	if (file->f_write_hint != WRITE_LIFE_NOT_SET)
1920 		return file->f_write_hint;
1921 
1922 	return file_inode(file)->i_write_hint;
1923 }
1924 
1925 static inline int iocb_flags(struct file *file);
1926 
1927 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
1928 {
1929 	*kiocb = (struct kiocb) {
1930 		.ki_filp = filp,
1931 		.ki_flags = iocb_flags(filp),
1932 		.ki_hint = file_write_hint(filp),
1933 	};
1934 }
1935 
1936 /*
1937  * Inode state bits.  Protected by inode->i_lock
1938  *
1939  * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1940  * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1941  *
1942  * Four bits define the lifetime of an inode.  Initially, inodes are I_NEW,
1943  * until that flag is cleared.  I_WILL_FREE, I_FREEING and I_CLEAR are set at
1944  * various stages of removing an inode.
1945  *
1946  * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1947  *
1948  * I_DIRTY_SYNC		Inode is dirty, but doesn't have to be written on
1949  *			fdatasync().  i_atime is the usual cause.
1950  * I_DIRTY_DATASYNC	Data-related inode changes pending. We keep track of
1951  *			these changes separately from I_DIRTY_SYNC so that we
1952  *			don't have to write inode on fdatasync() when only
1953  *			mtime has changed in it.
1954  * I_DIRTY_PAGES	Inode has dirty pages.  Inode itself may be clean.
1955  * I_NEW		Serves as both a mutex and completion notification.
1956  *			New inodes set I_NEW.  If two processes both create
1957  *			the same inode, one of them will release its inode and
1958  *			wait for I_NEW to be released before returning.
1959  *			Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1960  *			also cause waiting on I_NEW, without I_NEW actually
1961  *			being set.  find_inode() uses this to prevent returning
1962  *			nearly-dead inodes.
1963  * I_WILL_FREE		Must be set when calling write_inode_now() if i_count
1964  *			is zero.  I_FREEING must be set when I_WILL_FREE is
1965  *			cleared.
1966  * I_FREEING		Set when inode is about to be freed but still has dirty
1967  *			pages or buffers attached or the inode itself is still
1968  *			dirty.
1969  * I_CLEAR		Added by clear_inode().  In this state the inode is
1970  *			clean and can be destroyed.  Inode keeps I_FREEING.
1971  *
1972  *			Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1973  *			prohibited for many purposes.  iget() must wait for
1974  *			the inode to be completely released, then create it
1975  *			anew.  Other functions will just ignore such inodes,
1976  *			if appropriate.  I_NEW is used for waiting.
1977  *
1978  * I_SYNC		Writeback of inode is running. The bit is set during
1979  *			data writeback, and cleared with a wakeup on the bit
1980  *			address once it is done. The bit is also used to pin
1981  *			the inode in memory for flusher thread.
1982  *
1983  * I_REFERENCED		Marks the inode as recently references on the LRU list.
1984  *
1985  * I_DIO_WAKEUP		Never set.  Only used as a key for wait_on_bit().
1986  *
1987  * I_WB_SWITCH		Cgroup bdi_writeback switching in progress.  Used to
1988  *			synchronize competing switching instances and to tell
1989  *			wb stat updates to grab mapping->tree_lock.  See
1990  *			inode_switch_wb_work_fn() for details.
1991  *
1992  * I_OVL_INUSE		Used by overlayfs to get exclusive ownership on upper
1993  *			and work dirs among overlayfs mounts.
1994  *
1995  * Q: What is the difference between I_WILL_FREE and I_FREEING?
1996  */
1997 #define I_DIRTY_SYNC		(1 << 0)
1998 #define I_DIRTY_DATASYNC	(1 << 1)
1999 #define I_DIRTY_PAGES		(1 << 2)
2000 #define __I_NEW			3
2001 #define I_NEW			(1 << __I_NEW)
2002 #define I_WILL_FREE		(1 << 4)
2003 #define I_FREEING		(1 << 5)
2004 #define I_CLEAR			(1 << 6)
2005 #define __I_SYNC		7
2006 #define I_SYNC			(1 << __I_SYNC)
2007 #define I_REFERENCED		(1 << 8)
2008 #define __I_DIO_WAKEUP		9
2009 #define I_DIO_WAKEUP		(1 << __I_DIO_WAKEUP)
2010 #define I_LINKABLE		(1 << 10)
2011 #define I_DIRTY_TIME		(1 << 11)
2012 #define __I_DIRTY_TIME_EXPIRED	12
2013 #define I_DIRTY_TIME_EXPIRED	(1 << __I_DIRTY_TIME_EXPIRED)
2014 #define I_WB_SWITCH		(1 << 13)
2015 #define I_OVL_INUSE			(1 << 14)
2016 
2017 #define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
2018 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
2019 
2020 extern void __mark_inode_dirty(struct inode *, int);
2021 static inline void mark_inode_dirty(struct inode *inode)
2022 {
2023 	__mark_inode_dirty(inode, I_DIRTY);
2024 }
2025 
2026 static inline void mark_inode_dirty_sync(struct inode *inode)
2027 {
2028 	__mark_inode_dirty(inode, I_DIRTY_SYNC);
2029 }
2030 
2031 extern void inc_nlink(struct inode *inode);
2032 extern void drop_nlink(struct inode *inode);
2033 extern void clear_nlink(struct inode *inode);
2034 extern void set_nlink(struct inode *inode, unsigned int nlink);
2035 
2036 static inline void inode_inc_link_count(struct inode *inode)
2037 {
2038 	inc_nlink(inode);
2039 	mark_inode_dirty(inode);
2040 }
2041 
2042 static inline void inode_dec_link_count(struct inode *inode)
2043 {
2044 	drop_nlink(inode);
2045 	mark_inode_dirty(inode);
2046 }
2047 
2048 enum file_time_flags {
2049 	S_ATIME = 1,
2050 	S_MTIME = 2,
2051 	S_CTIME = 4,
2052 	S_VERSION = 8,
2053 };
2054 
2055 extern void touch_atime(const struct path *);
2056 static inline void file_accessed(struct file *file)
2057 {
2058 	if (!(file->f_flags & O_NOATIME))
2059 		touch_atime(&file->f_path);
2060 }
2061 
2062 int sync_inode(struct inode *inode, struct writeback_control *wbc);
2063 int sync_inode_metadata(struct inode *inode, int wait);
2064 
2065 struct file_system_type {
2066 	const char *name;
2067 	int fs_flags;
2068 #define FS_REQUIRES_DEV		1
2069 #define FS_BINARY_MOUNTDATA	2
2070 #define FS_HAS_SUBTYPE		4
2071 #define FS_USERNS_MOUNT		8	/* Can be mounted by userns root */
2072 #define FS_RENAME_DOES_D_MOVE	32768	/* FS will handle d_move() during rename() internally. */
2073 	struct dentry *(*mount) (struct file_system_type *, int,
2074 		       const char *, void *);
2075 	void (*kill_sb) (struct super_block *);
2076 	struct module *owner;
2077 	struct file_system_type * next;
2078 	struct hlist_head fs_supers;
2079 
2080 	struct lock_class_key s_lock_key;
2081 	struct lock_class_key s_umount_key;
2082 	struct lock_class_key s_vfs_rename_key;
2083 	struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2084 
2085 	struct lock_class_key i_lock_key;
2086 	struct lock_class_key i_mutex_key;
2087 	struct lock_class_key i_mutex_dir_key;
2088 };
2089 
2090 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2091 
2092 extern struct dentry *mount_ns(struct file_system_type *fs_type,
2093 	int flags, void *data, void *ns, struct user_namespace *user_ns,
2094 	int (*fill_super)(struct super_block *, void *, int));
2095 #ifdef CONFIG_BLOCK
2096 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2097 	int flags, const char *dev_name, void *data,
2098 	int (*fill_super)(struct super_block *, void *, int));
2099 #else
2100 static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2101 	int flags, const char *dev_name, void *data,
2102 	int (*fill_super)(struct super_block *, void *, int))
2103 {
2104 	return ERR_PTR(-ENODEV);
2105 }
2106 #endif
2107 extern struct dentry *mount_single(struct file_system_type *fs_type,
2108 	int flags, void *data,
2109 	int (*fill_super)(struct super_block *, void *, int));
2110 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2111 	int flags, void *data,
2112 	int (*fill_super)(struct super_block *, void *, int));
2113 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2114 void generic_shutdown_super(struct super_block *sb);
2115 #ifdef CONFIG_BLOCK
2116 void kill_block_super(struct super_block *sb);
2117 #else
2118 static inline void kill_block_super(struct super_block *sb)
2119 {
2120 	BUG();
2121 }
2122 #endif
2123 void kill_anon_super(struct super_block *sb);
2124 void kill_litter_super(struct super_block *sb);
2125 void deactivate_super(struct super_block *sb);
2126 void deactivate_locked_super(struct super_block *sb);
2127 int set_anon_super(struct super_block *s, void *data);
2128 int get_anon_bdev(dev_t *);
2129 void free_anon_bdev(dev_t);
2130 struct super_block *sget_userns(struct file_system_type *type,
2131 			int (*test)(struct super_block *,void *),
2132 			int (*set)(struct super_block *,void *),
2133 			int flags, struct user_namespace *user_ns,
2134 			void *data);
2135 struct super_block *sget(struct file_system_type *type,
2136 			int (*test)(struct super_block *,void *),
2137 			int (*set)(struct super_block *,void *),
2138 			int flags, void *data);
2139 extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2140 					 const struct super_operations *ops,
2141 					 const struct xattr_handler **xattr,
2142 					 const struct dentry_operations *dops,
2143 					 unsigned long);
2144 
2145 static inline struct dentry *
2146 mount_pseudo(struct file_system_type *fs_type, char *name,
2147 	     const struct super_operations *ops,
2148 	     const struct dentry_operations *dops, unsigned long magic)
2149 {
2150 	return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2151 }
2152 
2153 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2154 #define fops_get(fops) \
2155 	(((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2156 #define fops_put(fops) \
2157 	do { if (fops) module_put((fops)->owner); } while(0)
2158 /*
2159  * This one is to be used *ONLY* from ->open() instances.
2160  * fops must be non-NULL, pinned down *and* module dependencies
2161  * should be sufficient to pin the caller down as well.
2162  */
2163 #define replace_fops(f, fops) \
2164 	do {	\
2165 		struct file *__file = (f); \
2166 		fops_put(__file->f_op); \
2167 		BUG_ON(!(__file->f_op = (fops))); \
2168 	} while(0)
2169 
2170 extern int register_filesystem(struct file_system_type *);
2171 extern int unregister_filesystem(struct file_system_type *);
2172 extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2173 #define kern_mount(type) kern_mount_data(type, NULL)
2174 extern void kern_unmount(struct vfsmount *mnt);
2175 extern int may_umount_tree(struct vfsmount *);
2176 extern int may_umount(struct vfsmount *);
2177 extern long do_mount(const char *, const char __user *,
2178 		     const char *, unsigned long, void *);
2179 extern struct vfsmount *collect_mounts(const struct path *);
2180 extern void drop_collected_mounts(struct vfsmount *);
2181 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2182 			  struct vfsmount *);
2183 extern int vfs_statfs(const struct path *, struct kstatfs *);
2184 extern int user_statfs(const char __user *, struct kstatfs *);
2185 extern int fd_statfs(int, struct kstatfs *);
2186 extern int freeze_super(struct super_block *super);
2187 extern int thaw_super(struct super_block *super);
2188 extern bool our_mnt(struct vfsmount *mnt);
2189 extern __printf(2, 3)
2190 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2191 extern int super_setup_bdi(struct super_block *sb);
2192 
2193 extern int current_umask(void);
2194 
2195 extern void ihold(struct inode * inode);
2196 extern void iput(struct inode *);
2197 extern int generic_update_time(struct inode *, struct timespec *, int);
2198 
2199 /* /sys/fs */
2200 extern struct kobject *fs_kobj;
2201 
2202 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2203 
2204 #ifdef CONFIG_MANDATORY_FILE_LOCKING
2205 extern int locks_mandatory_locked(struct file *);
2206 extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
2207 
2208 /*
2209  * Candidates for mandatory locking have the setgid bit set
2210  * but no group execute bit -  an otherwise meaningless combination.
2211  */
2212 
2213 static inline int __mandatory_lock(struct inode *ino)
2214 {
2215 	return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2216 }
2217 
2218 /*
2219  * ... and these candidates should be on SB_MANDLOCK mounted fs,
2220  * otherwise these will be advisory locks
2221  */
2222 
2223 static inline int mandatory_lock(struct inode *ino)
2224 {
2225 	return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2226 }
2227 
2228 static inline int locks_verify_locked(struct file *file)
2229 {
2230 	if (mandatory_lock(locks_inode(file)))
2231 		return locks_mandatory_locked(file);
2232 	return 0;
2233 }
2234 
2235 static inline int locks_verify_truncate(struct inode *inode,
2236 				    struct file *f,
2237 				    loff_t size)
2238 {
2239 	if (!inode->i_flctx || !mandatory_lock(inode))
2240 		return 0;
2241 
2242 	if (size < inode->i_size) {
2243 		return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2244 				F_WRLCK);
2245 	} else {
2246 		return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2247 				F_WRLCK);
2248 	}
2249 }
2250 
2251 #else /* !CONFIG_MANDATORY_FILE_LOCKING */
2252 
2253 static inline int locks_mandatory_locked(struct file *file)
2254 {
2255 	return 0;
2256 }
2257 
2258 static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2259                                        loff_t start, loff_t end, unsigned char type)
2260 {
2261 	return 0;
2262 }
2263 
2264 static inline int __mandatory_lock(struct inode *inode)
2265 {
2266 	return 0;
2267 }
2268 
2269 static inline int mandatory_lock(struct inode *inode)
2270 {
2271 	return 0;
2272 }
2273 
2274 static inline int locks_verify_locked(struct file *file)
2275 {
2276 	return 0;
2277 }
2278 
2279 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2280 					size_t size)
2281 {
2282 	return 0;
2283 }
2284 
2285 #endif /* CONFIG_MANDATORY_FILE_LOCKING */
2286 
2287 
2288 #ifdef CONFIG_FILE_LOCKING
2289 static inline int break_lease(struct inode *inode, unsigned int mode)
2290 {
2291 	/*
2292 	 * Since this check is lockless, we must ensure that any refcounts
2293 	 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2294 	 * could end up racing with tasks trying to set a new lease on this
2295 	 * file.
2296 	 */
2297 	smp_mb();
2298 	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2299 		return __break_lease(inode, mode, FL_LEASE);
2300 	return 0;
2301 }
2302 
2303 static inline int break_deleg(struct inode *inode, unsigned int mode)
2304 {
2305 	/*
2306 	 * Since this check is lockless, we must ensure that any refcounts
2307 	 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2308 	 * could end up racing with tasks trying to set a new lease on this
2309 	 * file.
2310 	 */
2311 	smp_mb();
2312 	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2313 		return __break_lease(inode, mode, FL_DELEG);
2314 	return 0;
2315 }
2316 
2317 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2318 {
2319 	int ret;
2320 
2321 	ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2322 	if (ret == -EWOULDBLOCK && delegated_inode) {
2323 		*delegated_inode = inode;
2324 		ihold(inode);
2325 	}
2326 	return ret;
2327 }
2328 
2329 static inline int break_deleg_wait(struct inode **delegated_inode)
2330 {
2331 	int ret;
2332 
2333 	ret = break_deleg(*delegated_inode, O_WRONLY);
2334 	iput(*delegated_inode);
2335 	*delegated_inode = NULL;
2336 	return ret;
2337 }
2338 
2339 static inline int break_layout(struct inode *inode, bool wait)
2340 {
2341 	smp_mb();
2342 	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2343 		return __break_lease(inode,
2344 				wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2345 				FL_LAYOUT);
2346 	return 0;
2347 }
2348 
2349 #else /* !CONFIG_FILE_LOCKING */
2350 static inline int break_lease(struct inode *inode, unsigned int mode)
2351 {
2352 	return 0;
2353 }
2354 
2355 static inline int break_deleg(struct inode *inode, unsigned int mode)
2356 {
2357 	return 0;
2358 }
2359 
2360 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2361 {
2362 	return 0;
2363 }
2364 
2365 static inline int break_deleg_wait(struct inode **delegated_inode)
2366 {
2367 	BUG();
2368 	return 0;
2369 }
2370 
2371 static inline int break_layout(struct inode *inode, bool wait)
2372 {
2373 	return 0;
2374 }
2375 
2376 #endif /* CONFIG_FILE_LOCKING */
2377 
2378 /* fs/open.c */
2379 struct audit_names;
2380 struct filename {
2381 	const char		*name;	/* pointer to actual string */
2382 	const __user char	*uptr;	/* original userland pointer */
2383 	struct audit_names	*aname;
2384 	int			refcnt;
2385 	const char		iname[];
2386 };
2387 
2388 extern long vfs_truncate(const struct path *, loff_t);
2389 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2390 		       struct file *filp);
2391 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2392 			loff_t len);
2393 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2394 			umode_t mode);
2395 extern struct file *file_open_name(struct filename *, int, umode_t);
2396 extern struct file *filp_open(const char *, int, umode_t);
2397 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2398 				   const char *, int, umode_t);
2399 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2400 extern int filp_close(struct file *, fl_owner_t id);
2401 
2402 extern struct filename *getname_flags(const char __user *, int, int *);
2403 extern struct filename *getname(const char __user *);
2404 extern struct filename *getname_kernel(const char *);
2405 extern void putname(struct filename *name);
2406 
2407 enum {
2408 	FILE_CREATED = 1,
2409 	FILE_OPENED = 2
2410 };
2411 extern int finish_open(struct file *file, struct dentry *dentry,
2412 			int (*open)(struct inode *, struct file *),
2413 			int *opened);
2414 extern int finish_no_open(struct file *file, struct dentry *dentry);
2415 
2416 /* fs/ioctl.c */
2417 
2418 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2419 
2420 /* fs/dcache.c */
2421 extern void __init vfs_caches_init_early(void);
2422 extern void __init vfs_caches_init(void);
2423 
2424 extern struct kmem_cache *names_cachep;
2425 
2426 #define __getname()		kmem_cache_alloc(names_cachep, GFP_KERNEL)
2427 #define __putname(name)		kmem_cache_free(names_cachep, (void *)(name))
2428 
2429 #ifdef CONFIG_BLOCK
2430 extern int register_blkdev(unsigned int, const char *);
2431 extern void unregister_blkdev(unsigned int, const char *);
2432 extern void bdev_unhash_inode(dev_t dev);
2433 extern struct block_device *bdget(dev_t);
2434 extern struct block_device *bdgrab(struct block_device *bdev);
2435 extern void bd_set_size(struct block_device *, loff_t size);
2436 extern void bd_forget(struct inode *inode);
2437 extern void bdput(struct block_device *);
2438 extern void invalidate_bdev(struct block_device *);
2439 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
2440 extern int sync_blockdev(struct block_device *bdev);
2441 extern void kill_bdev(struct block_device *);
2442 extern struct super_block *freeze_bdev(struct block_device *);
2443 extern void emergency_thaw_all(void);
2444 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2445 extern int fsync_bdev(struct block_device *);
2446 
2447 extern struct super_block *blockdev_superblock;
2448 
2449 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2450 {
2451 	return sb == blockdev_superblock;
2452 }
2453 #else
2454 static inline void bd_forget(struct inode *inode) {}
2455 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2456 static inline void kill_bdev(struct block_device *bdev) {}
2457 static inline void invalidate_bdev(struct block_device *bdev) {}
2458 
2459 static inline struct super_block *freeze_bdev(struct block_device *sb)
2460 {
2461 	return NULL;
2462 }
2463 
2464 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2465 {
2466 	return 0;
2467 }
2468 
2469 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2470 {
2471 }
2472 
2473 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2474 {
2475 	return false;
2476 }
2477 #endif
2478 extern int sync_filesystem(struct super_block *);
2479 extern const struct file_operations def_blk_fops;
2480 extern const struct file_operations def_chr_fops;
2481 #ifdef CONFIG_BLOCK
2482 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2483 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2484 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2485 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2486 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2487 					       void *holder);
2488 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2489 					      void *holder);
2490 extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2491 extern int __blkdev_reread_part(struct block_device *bdev);
2492 extern int blkdev_reread_part(struct block_device *bdev);
2493 
2494 #ifdef CONFIG_SYSFS
2495 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2496 extern void bd_unlink_disk_holder(struct block_device *bdev,
2497 				  struct gendisk *disk);
2498 #else
2499 static inline int bd_link_disk_holder(struct block_device *bdev,
2500 				      struct gendisk *disk)
2501 {
2502 	return 0;
2503 }
2504 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2505 					 struct gendisk *disk)
2506 {
2507 }
2508 #endif
2509 #endif
2510 
2511 /* fs/char_dev.c */
2512 #define CHRDEV_MAJOR_MAX 512
2513 /* Marks the bottom of the first segment of free char majors */
2514 #define CHRDEV_MAJOR_DYN_END 234
2515 /* Marks the top and bottom of the second segment of free char majors */
2516 #define CHRDEV_MAJOR_DYN_EXT_START 511
2517 #define CHRDEV_MAJOR_DYN_EXT_END 384
2518 
2519 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2520 extern int register_chrdev_region(dev_t, unsigned, const char *);
2521 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2522 			     unsigned int count, const char *name,
2523 			     const struct file_operations *fops);
2524 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2525 				unsigned int count, const char *name);
2526 extern void unregister_chrdev_region(dev_t, unsigned);
2527 extern void chrdev_show(struct seq_file *,off_t);
2528 
2529 static inline int register_chrdev(unsigned int major, const char *name,
2530 				  const struct file_operations *fops)
2531 {
2532 	return __register_chrdev(major, 0, 256, name, fops);
2533 }
2534 
2535 static inline void unregister_chrdev(unsigned int major, const char *name)
2536 {
2537 	__unregister_chrdev(major, 0, 256, name);
2538 }
2539 
2540 /* fs/block_dev.c */
2541 #define BDEVNAME_SIZE	32	/* Largest string for a blockdev identifier */
2542 #define BDEVT_SIZE	10	/* Largest string for MAJ:MIN for blkdev */
2543 
2544 #ifdef CONFIG_BLOCK
2545 #define BLKDEV_MAJOR_MAX	512
2546 extern const char *__bdevname(dev_t, char *buffer);
2547 extern const char *bdevname(struct block_device *bdev, char *buffer);
2548 extern struct block_device *lookup_bdev(const char *);
2549 extern void blkdev_show(struct seq_file *,off_t);
2550 
2551 #else
2552 #define BLKDEV_MAJOR_MAX	0
2553 #endif
2554 
2555 extern void init_special_inode(struct inode *, umode_t, dev_t);
2556 
2557 /* Invalid inode operations -- fs/bad_inode.c */
2558 extern void make_bad_inode(struct inode *);
2559 extern bool is_bad_inode(struct inode *);
2560 
2561 #ifdef CONFIG_BLOCK
2562 extern void check_disk_size_change(struct gendisk *disk,
2563 				   struct block_device *bdev);
2564 extern int revalidate_disk(struct gendisk *);
2565 extern int check_disk_change(struct block_device *);
2566 extern int __invalidate_device(struct block_device *, bool);
2567 extern int invalidate_partition(struct gendisk *, int);
2568 #endif
2569 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2570 					pgoff_t start, pgoff_t end);
2571 
2572 static inline void invalidate_remote_inode(struct inode *inode)
2573 {
2574 	if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2575 	    S_ISLNK(inode->i_mode))
2576 		invalidate_mapping_pages(inode->i_mapping, 0, -1);
2577 }
2578 extern int invalidate_inode_pages2(struct address_space *mapping);
2579 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2580 					 pgoff_t start, pgoff_t end);
2581 extern int write_inode_now(struct inode *, int);
2582 extern int filemap_fdatawrite(struct address_space *);
2583 extern int filemap_flush(struct address_space *);
2584 extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2585 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2586 				   loff_t lend);
2587 
2588 static inline int filemap_fdatawait(struct address_space *mapping)
2589 {
2590 	return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2591 }
2592 
2593 extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2594 				  loff_t lend);
2595 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2596 						loff_t lend);
2597 extern int filemap_write_and_wait(struct address_space *mapping);
2598 extern int filemap_write_and_wait_range(struct address_space *mapping,
2599 				        loff_t lstart, loff_t lend);
2600 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2601 				loff_t start, loff_t end, int sync_mode);
2602 extern int filemap_fdatawrite_range(struct address_space *mapping,
2603 				loff_t start, loff_t end);
2604 extern int filemap_check_errors(struct address_space *mapping);
2605 extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2606 
2607 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2608 						loff_t lend);
2609 extern int __must_check file_check_and_advance_wb_err(struct file *file);
2610 extern int __must_check file_write_and_wait_range(struct file *file,
2611 						loff_t start, loff_t end);
2612 
2613 static inline int file_write_and_wait(struct file *file)
2614 {
2615 	return file_write_and_wait_range(file, 0, LLONG_MAX);
2616 }
2617 
2618 /**
2619  * filemap_set_wb_err - set a writeback error on an address_space
2620  * @mapping: mapping in which to set writeback error
2621  * @err: error to be set in mapping
2622  *
2623  * When writeback fails in some way, we must record that error so that
2624  * userspace can be informed when fsync and the like are called.  We endeavor
2625  * to report errors on any file that was open at the time of the error.  Some
2626  * internal callers also need to know when writeback errors have occurred.
2627  *
2628  * When a writeback error occurs, most filesystems will want to call
2629  * filemap_set_wb_err to record the error in the mapping so that it will be
2630  * automatically reported whenever fsync is called on the file.
2631  */
2632 static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2633 {
2634 	/* Fastpath for common case of no error */
2635 	if (unlikely(err))
2636 		__filemap_set_wb_err(mapping, err);
2637 }
2638 
2639 /**
2640  * filemap_check_wb_error - has an error occurred since the mark was sampled?
2641  * @mapping: mapping to check for writeback errors
2642  * @since: previously-sampled errseq_t
2643  *
2644  * Grab the errseq_t value from the mapping, and see if it has changed "since"
2645  * the given value was sampled.
2646  *
2647  * If it has then report the latest error set, otherwise return 0.
2648  */
2649 static inline int filemap_check_wb_err(struct address_space *mapping,
2650 					errseq_t since)
2651 {
2652 	return errseq_check(&mapping->wb_err, since);
2653 }
2654 
2655 /**
2656  * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2657  * @mapping: mapping to be sampled
2658  *
2659  * Writeback errors are always reported relative to a particular sample point
2660  * in the past. This function provides those sample points.
2661  */
2662 static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2663 {
2664 	return errseq_sample(&mapping->wb_err);
2665 }
2666 
2667 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2668 			   int datasync);
2669 extern int vfs_fsync(struct file *file, int datasync);
2670 
2671 /*
2672  * Sync the bytes written if this was a synchronous write.  Expect ki_pos
2673  * to already be updated for the write, and will return either the amount
2674  * of bytes passed in, or an error if syncing the file failed.
2675  */
2676 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2677 {
2678 	if (iocb->ki_flags & IOCB_DSYNC) {
2679 		int ret = vfs_fsync_range(iocb->ki_filp,
2680 				iocb->ki_pos - count, iocb->ki_pos - 1,
2681 				(iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2682 		if (ret)
2683 			return ret;
2684 	}
2685 
2686 	return count;
2687 }
2688 
2689 extern void emergency_sync(void);
2690 extern void emergency_remount(void);
2691 #ifdef CONFIG_BLOCK
2692 extern sector_t bmap(struct inode *, sector_t);
2693 #endif
2694 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2695 extern int inode_permission(struct inode *, int);
2696 extern int generic_permission(struct inode *, int);
2697 extern int __check_sticky(struct inode *dir, struct inode *inode);
2698 
2699 static inline bool execute_ok(struct inode *inode)
2700 {
2701 	return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2702 }
2703 
2704 static inline void file_start_write(struct file *file)
2705 {
2706 	if (!S_ISREG(file_inode(file)->i_mode))
2707 		return;
2708 	__sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2709 }
2710 
2711 static inline bool file_start_write_trylock(struct file *file)
2712 {
2713 	if (!S_ISREG(file_inode(file)->i_mode))
2714 		return true;
2715 	return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2716 }
2717 
2718 static inline void file_end_write(struct file *file)
2719 {
2720 	if (!S_ISREG(file_inode(file)->i_mode))
2721 		return;
2722 	__sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2723 }
2724 
2725 static inline int do_clone_file_range(struct file *file_in, loff_t pos_in,
2726 				      struct file *file_out, loff_t pos_out,
2727 				      u64 len)
2728 {
2729 	int ret;
2730 
2731 	file_start_write(file_out);
2732 	ret = vfs_clone_file_range(file_in, pos_in, file_out, pos_out, len);
2733 	file_end_write(file_out);
2734 
2735 	return ret;
2736 }
2737 
2738 /*
2739  * get_write_access() gets write permission for a file.
2740  * put_write_access() releases this write permission.
2741  * This is used for regular files.
2742  * We cannot support write (and maybe mmap read-write shared) accesses and
2743  * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2744  * can have the following values:
2745  * 0: no writers, no VM_DENYWRITE mappings
2746  * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2747  * > 0: (i_writecount) users are writing to the file.
2748  *
2749  * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2750  * except for the cases where we don't hold i_writecount yet. Then we need to
2751  * use {get,deny}_write_access() - these functions check the sign and refuse
2752  * to do the change if sign is wrong.
2753  */
2754 static inline int get_write_access(struct inode *inode)
2755 {
2756 	return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2757 }
2758 static inline int deny_write_access(struct file *file)
2759 {
2760 	struct inode *inode = file_inode(file);
2761 	return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2762 }
2763 static inline void put_write_access(struct inode * inode)
2764 {
2765 	atomic_dec(&inode->i_writecount);
2766 }
2767 static inline void allow_write_access(struct file *file)
2768 {
2769 	if (file)
2770 		atomic_inc(&file_inode(file)->i_writecount);
2771 }
2772 static inline bool inode_is_open_for_write(const struct inode *inode)
2773 {
2774 	return atomic_read(&inode->i_writecount) > 0;
2775 }
2776 
2777 #ifdef CONFIG_IMA
2778 static inline void i_readcount_dec(struct inode *inode)
2779 {
2780 	BUG_ON(!atomic_read(&inode->i_readcount));
2781 	atomic_dec(&inode->i_readcount);
2782 }
2783 static inline void i_readcount_inc(struct inode *inode)
2784 {
2785 	atomic_inc(&inode->i_readcount);
2786 }
2787 #else
2788 static inline void i_readcount_dec(struct inode *inode)
2789 {
2790 	return;
2791 }
2792 static inline void i_readcount_inc(struct inode *inode)
2793 {
2794 	return;
2795 }
2796 #endif
2797 extern int do_pipe_flags(int *, int);
2798 
2799 #define __kernel_read_file_id(id) \
2800 	id(UNKNOWN, unknown)		\
2801 	id(FIRMWARE, firmware)		\
2802 	id(FIRMWARE_PREALLOC_BUFFER, firmware)	\
2803 	id(MODULE, kernel-module)		\
2804 	id(KEXEC_IMAGE, kexec-image)		\
2805 	id(KEXEC_INITRAMFS, kexec-initramfs)	\
2806 	id(POLICY, security-policy)		\
2807 	id(X509_CERTIFICATE, x509-certificate)	\
2808 	id(MAX_ID, )
2809 
2810 #define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2811 #define __fid_stringify(dummy, str) #str,
2812 
2813 enum kernel_read_file_id {
2814 	__kernel_read_file_id(__fid_enumify)
2815 };
2816 
2817 static const char * const kernel_read_file_str[] = {
2818 	__kernel_read_file_id(__fid_stringify)
2819 };
2820 
2821 static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2822 {
2823 	if ((unsigned)id >= READING_MAX_ID)
2824 		return kernel_read_file_str[READING_UNKNOWN];
2825 
2826 	return kernel_read_file_str[id];
2827 }
2828 
2829 extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2830 			    enum kernel_read_file_id);
2831 extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2832 				      enum kernel_read_file_id);
2833 extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2834 				    enum kernel_read_file_id);
2835 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2836 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2837 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
2838 extern struct file * open_exec(const char *);
2839 
2840 /* fs/dcache.c -- generic fs support functions */
2841 extern bool is_subdir(struct dentry *, struct dentry *);
2842 extern bool path_is_under(const struct path *, const struct path *);
2843 
2844 extern char *file_path(struct file *, char *, int);
2845 
2846 #include <linux/err.h>
2847 
2848 /* needed for stackable file system support */
2849 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2850 
2851 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2852 
2853 extern int inode_init_always(struct super_block *, struct inode *);
2854 extern void inode_init_once(struct inode *);
2855 extern void address_space_init_once(struct address_space *mapping);
2856 extern struct inode * igrab(struct inode *);
2857 extern ino_t iunique(struct super_block *, ino_t);
2858 extern int inode_needs_sync(struct inode *inode);
2859 extern int generic_delete_inode(struct inode *inode);
2860 static inline int generic_drop_inode(struct inode *inode)
2861 {
2862 	return !inode->i_nlink || inode_unhashed(inode);
2863 }
2864 
2865 extern struct inode *ilookup5_nowait(struct super_block *sb,
2866 		unsigned long hashval, int (*test)(struct inode *, void *),
2867 		void *data);
2868 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2869 		int (*test)(struct inode *, void *), void *data);
2870 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2871 
2872 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2873 extern struct inode * iget_locked(struct super_block *, unsigned long);
2874 extern struct inode *find_inode_nowait(struct super_block *,
2875 				       unsigned long,
2876 				       int (*match)(struct inode *,
2877 						    unsigned long, void *),
2878 				       void *data);
2879 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2880 extern int insert_inode_locked(struct inode *);
2881 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2882 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2883 #else
2884 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2885 #endif
2886 extern void unlock_new_inode(struct inode *);
2887 extern unsigned int get_next_ino(void);
2888 extern void evict_inodes(struct super_block *sb);
2889 
2890 extern void __iget(struct inode * inode);
2891 extern void iget_failed(struct inode *);
2892 extern void clear_inode(struct inode *);
2893 extern void __destroy_inode(struct inode *);
2894 extern struct inode *new_inode_pseudo(struct super_block *sb);
2895 extern struct inode *new_inode(struct super_block *sb);
2896 extern void free_inode_nonrcu(struct inode *inode);
2897 extern int should_remove_suid(struct dentry *);
2898 extern int file_remove_privs(struct file *);
2899 
2900 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2901 static inline void insert_inode_hash(struct inode *inode)
2902 {
2903 	__insert_inode_hash(inode, inode->i_ino);
2904 }
2905 
2906 extern void __remove_inode_hash(struct inode *);
2907 static inline void remove_inode_hash(struct inode *inode)
2908 {
2909 	if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
2910 		__remove_inode_hash(inode);
2911 }
2912 
2913 extern void inode_sb_list_add(struct inode *inode);
2914 
2915 #ifdef CONFIG_BLOCK
2916 extern int bdev_read_only(struct block_device *);
2917 #endif
2918 extern int set_blocksize(struct block_device *, int);
2919 extern int sb_set_blocksize(struct super_block *, int);
2920 extern int sb_min_blocksize(struct super_block *, int);
2921 
2922 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2923 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2924 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
2925 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
2926 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
2927 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
2928 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
2929 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
2930 
2931 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
2932 		rwf_t flags);
2933 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
2934 		rwf_t flags);
2935 
2936 /* fs/block_dev.c */
2937 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
2938 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
2939 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2940 			int datasync);
2941 extern void block_sync_page(struct page *page);
2942 
2943 /* fs/splice.c */
2944 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
2945 		struct pipe_inode_info *, size_t, unsigned int);
2946 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
2947 		struct file *, loff_t *, size_t, unsigned int);
2948 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
2949 		struct file *out, loff_t *, size_t len, unsigned int flags);
2950 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2951 		loff_t *opos, size_t len, unsigned int flags);
2952 
2953 
2954 extern void
2955 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
2956 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2957 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
2958 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
2959 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
2960 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
2961 		int whence, loff_t maxsize, loff_t eof);
2962 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2963 		int whence, loff_t size);
2964 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2965 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
2966 extern int generic_file_open(struct inode * inode, struct file * filp);
2967 extern int nonseekable_open(struct inode * inode, struct file * filp);
2968 
2969 #ifdef CONFIG_BLOCK
2970 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
2971 			    loff_t file_offset);
2972 
2973 enum {
2974 	/* need locking between buffered and direct access */
2975 	DIO_LOCKING	= 0x01,
2976 
2977 	/* filesystem does not support filling holes */
2978 	DIO_SKIP_HOLES	= 0x02,
2979 
2980 	/* filesystem can handle aio writes beyond i_size */
2981 	DIO_ASYNC_EXTEND = 0x04,
2982 
2983 	/* inode/fs/bdev does not need truncate protection */
2984 	DIO_SKIP_DIO_COUNT = 0x08,
2985 };
2986 
2987 void dio_end_io(struct bio *bio);
2988 void dio_warn_stale_pagecache(struct file *filp);
2989 
2990 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2991 			     struct block_device *bdev, struct iov_iter *iter,
2992 			     get_block_t get_block,
2993 			     dio_iodone_t end_io, dio_submit_t submit_io,
2994 			     int flags);
2995 
2996 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2997 					 struct inode *inode,
2998 					 struct iov_iter *iter,
2999 					 get_block_t get_block)
3000 {
3001 	return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3002 			get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
3003 }
3004 #endif
3005 
3006 void inode_dio_wait(struct inode *inode);
3007 
3008 /*
3009  * inode_dio_begin - signal start of a direct I/O requests
3010  * @inode: inode the direct I/O happens on
3011  *
3012  * This is called once we've finished processing a direct I/O request,
3013  * and is used to wake up callers waiting for direct I/O to be quiesced.
3014  */
3015 static inline void inode_dio_begin(struct inode *inode)
3016 {
3017 	atomic_inc(&inode->i_dio_count);
3018 }
3019 
3020 /*
3021  * inode_dio_end - signal finish of a direct I/O requests
3022  * @inode: inode the direct I/O happens on
3023  *
3024  * This is called once we've finished processing a direct I/O request,
3025  * and is used to wake up callers waiting for direct I/O to be quiesced.
3026  */
3027 static inline void inode_dio_end(struct inode *inode)
3028 {
3029 	if (atomic_dec_and_test(&inode->i_dio_count))
3030 		wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3031 }
3032 
3033 extern void inode_set_flags(struct inode *inode, unsigned int flags,
3034 			    unsigned int mask);
3035 
3036 extern const struct file_operations generic_ro_fops;
3037 
3038 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3039 
3040 extern int readlink_copy(char __user *, int, const char *);
3041 extern int page_readlink(struct dentry *, char __user *, int);
3042 extern const char *page_get_link(struct dentry *, struct inode *,
3043 				 struct delayed_call *);
3044 extern void page_put_link(void *);
3045 extern int __page_symlink(struct inode *inode, const char *symname, int len,
3046 		int nofs);
3047 extern int page_symlink(struct inode *inode, const char *symname, int len);
3048 extern const struct inode_operations page_symlink_inode_operations;
3049 extern void kfree_link(void *);
3050 extern void generic_fillattr(struct inode *, struct kstat *);
3051 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3052 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3053 void __inode_add_bytes(struct inode *inode, loff_t bytes);
3054 void inode_add_bytes(struct inode *inode, loff_t bytes);
3055 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
3056 void inode_sub_bytes(struct inode *inode, loff_t bytes);
3057 static inline loff_t __inode_get_bytes(struct inode *inode)
3058 {
3059 	return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3060 }
3061 loff_t inode_get_bytes(struct inode *inode);
3062 void inode_set_bytes(struct inode *inode, loff_t bytes);
3063 const char *simple_get_link(struct dentry *, struct inode *,
3064 			    struct delayed_call *);
3065 extern const struct inode_operations simple_symlink_inode_operations;
3066 
3067 extern int iterate_dir(struct file *, struct dir_context *);
3068 
3069 extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3070 extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3071 
3072 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3073 {
3074 	return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3075 			 stat, STATX_BASIC_STATS);
3076 }
3077 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3078 {
3079 	return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3080 			 stat, STATX_BASIC_STATS);
3081 }
3082 static inline int vfs_fstatat(int dfd, const char __user *filename,
3083 			      struct kstat *stat, int flags)
3084 {
3085 	return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3086 			 stat, STATX_BASIC_STATS);
3087 }
3088 static inline int vfs_fstat(int fd, struct kstat *stat)
3089 {
3090 	return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3091 }
3092 
3093 
3094 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3095 extern int vfs_readlink(struct dentry *, char __user *, int);
3096 
3097 extern int __generic_block_fiemap(struct inode *inode,
3098 				  struct fiemap_extent_info *fieinfo,
3099 				  loff_t start, loff_t len,
3100 				  get_block_t *get_block);
3101 extern int generic_block_fiemap(struct inode *inode,
3102 				struct fiemap_extent_info *fieinfo, u64 start,
3103 				u64 len, get_block_t *get_block);
3104 
3105 extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3106 extern void put_filesystem(struct file_system_type *fs);
3107 extern struct file_system_type *get_fs_type(const char *name);
3108 extern struct super_block *get_super(struct block_device *);
3109 extern struct super_block *get_super_thawed(struct block_device *);
3110 extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3111 extern struct super_block *get_active_super(struct block_device *bdev);
3112 extern void drop_super(struct super_block *sb);
3113 extern void drop_super_exclusive(struct super_block *sb);
3114 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
3115 extern void iterate_supers_type(struct file_system_type *,
3116 			        void (*)(struct super_block *, void *), void *);
3117 
3118 extern int dcache_dir_open(struct inode *, struct file *);
3119 extern int dcache_dir_close(struct inode *, struct file *);
3120 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3121 extern int dcache_readdir(struct file *, struct dir_context *);
3122 extern int simple_setattr(struct dentry *, struct iattr *);
3123 extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3124 extern int simple_statfs(struct dentry *, struct kstatfs *);
3125 extern int simple_open(struct inode *inode, struct file *file);
3126 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3127 extern int simple_unlink(struct inode *, struct dentry *);
3128 extern int simple_rmdir(struct inode *, struct dentry *);
3129 extern int simple_rename(struct inode *, struct dentry *,
3130 			 struct inode *, struct dentry *, unsigned int);
3131 extern int noop_fsync(struct file *, loff_t, loff_t, int);
3132 extern int simple_empty(struct dentry *);
3133 extern int simple_readpage(struct file *file, struct page *page);
3134 extern int simple_write_begin(struct file *file, struct address_space *mapping,
3135 			loff_t pos, unsigned len, unsigned flags,
3136 			struct page **pagep, void **fsdata);
3137 extern int simple_write_end(struct file *file, struct address_space *mapping,
3138 			loff_t pos, unsigned len, unsigned copied,
3139 			struct page *page, void *fsdata);
3140 extern int always_delete_dentry(const struct dentry *);
3141 extern struct inode *alloc_anon_inode(struct super_block *);
3142 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3143 extern const struct dentry_operations simple_dentry_operations;
3144 
3145 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
3146 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3147 extern const struct file_operations simple_dir_operations;
3148 extern const struct inode_operations simple_dir_inode_operations;
3149 extern void make_empty_dir_inode(struct inode *inode);
3150 extern bool is_empty_dir_inode(struct inode *inode);
3151 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3152 struct dentry *d_alloc_name(struct dentry *, const char *);
3153 extern int simple_fill_super(struct super_block *, unsigned long,
3154 			     const struct tree_descr *);
3155 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3156 extern void simple_release_fs(struct vfsmount **mount, int *count);
3157 
3158 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3159 			loff_t *ppos, const void *from, size_t available);
3160 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3161 		const void __user *from, size_t count);
3162 
3163 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3164 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3165 
3166 extern int generic_check_addressable(unsigned, u64);
3167 
3168 #ifdef CONFIG_MIGRATION
3169 extern int buffer_migrate_page(struct address_space *,
3170 				struct page *, struct page *,
3171 				enum migrate_mode);
3172 #else
3173 #define buffer_migrate_page NULL
3174 #endif
3175 
3176 extern int setattr_prepare(struct dentry *, struct iattr *);
3177 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3178 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
3179 
3180 extern int file_update_time(struct file *file);
3181 
3182 static inline bool io_is_direct(struct file *filp)
3183 {
3184 	return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
3185 }
3186 
3187 static inline bool vma_is_dax(struct vm_area_struct *vma)
3188 {
3189 	return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3190 }
3191 
3192 static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3193 {
3194 	struct inode *inode;
3195 
3196 	if (!vma->vm_file)
3197 		return false;
3198 	if (!vma_is_dax(vma))
3199 		return false;
3200 	inode = file_inode(vma->vm_file);
3201 	if (inode->i_mode == S_IFCHR)
3202 		return false; /* device-dax */
3203 	return true;
3204 }
3205 
3206 static inline int iocb_flags(struct file *file)
3207 {
3208 	int res = 0;
3209 	if (file->f_flags & O_APPEND)
3210 		res |= IOCB_APPEND;
3211 	if (io_is_direct(file))
3212 		res |= IOCB_DIRECT;
3213 	if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3214 		res |= IOCB_DSYNC;
3215 	if (file->f_flags & __O_SYNC)
3216 		res |= IOCB_SYNC;
3217 	return res;
3218 }
3219 
3220 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3221 {
3222 	if (unlikely(flags & ~RWF_SUPPORTED))
3223 		return -EOPNOTSUPP;
3224 
3225 	if (flags & RWF_NOWAIT) {
3226 		if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3227 			return -EOPNOTSUPP;
3228 		ki->ki_flags |= IOCB_NOWAIT;
3229 	}
3230 	if (flags & RWF_HIPRI)
3231 		ki->ki_flags |= IOCB_HIPRI;
3232 	if (flags & RWF_DSYNC)
3233 		ki->ki_flags |= IOCB_DSYNC;
3234 	if (flags & RWF_SYNC)
3235 		ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
3236 	if (flags & RWF_APPEND)
3237 		ki->ki_flags |= IOCB_APPEND;
3238 	return 0;
3239 }
3240 
3241 static inline ino_t parent_ino(struct dentry *dentry)
3242 {
3243 	ino_t res;
3244 
3245 	/*
3246 	 * Don't strictly need d_lock here? If the parent ino could change
3247 	 * then surely we'd have a deeper race in the caller?
3248 	 */
3249 	spin_lock(&dentry->d_lock);
3250 	res = dentry->d_parent->d_inode->i_ino;
3251 	spin_unlock(&dentry->d_lock);
3252 	return res;
3253 }
3254 
3255 /* Transaction based IO helpers */
3256 
3257 /*
3258  * An argresp is stored in an allocated page and holds the
3259  * size of the argument or response, along with its content
3260  */
3261 struct simple_transaction_argresp {
3262 	ssize_t size;
3263 	char data[0];
3264 };
3265 
3266 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3267 
3268 char *simple_transaction_get(struct file *file, const char __user *buf,
3269 				size_t size);
3270 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3271 				size_t size, loff_t *pos);
3272 int simple_transaction_release(struct inode *inode, struct file *file);
3273 
3274 void simple_transaction_set(struct file *file, size_t n);
3275 
3276 /*
3277  * simple attribute files
3278  *
3279  * These attributes behave similar to those in sysfs:
3280  *
3281  * Writing to an attribute immediately sets a value, an open file can be
3282  * written to multiple times.
3283  *
3284  * Reading from an attribute creates a buffer from the value that might get
3285  * read with multiple read calls. When the attribute has been read
3286  * completely, no further read calls are possible until the file is opened
3287  * again.
3288  *
3289  * All attributes contain a text representation of a numeric value
3290  * that are accessed with the get() and set() functions.
3291  */
3292 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)		\
3293 static int __fops ## _open(struct inode *inode, struct file *file)	\
3294 {									\
3295 	__simple_attr_check_format(__fmt, 0ull);			\
3296 	return simple_attr_open(inode, file, __get, __set, __fmt);	\
3297 }									\
3298 static const struct file_operations __fops = {				\
3299 	.owner	 = THIS_MODULE,						\
3300 	.open	 = __fops ## _open,					\
3301 	.release = simple_attr_release,					\
3302 	.read	 = simple_attr_read,					\
3303 	.write	 = simple_attr_write,					\
3304 	.llseek	 = generic_file_llseek,					\
3305 }
3306 
3307 static inline __printf(1, 2)
3308 void __simple_attr_check_format(const char *fmt, ...)
3309 {
3310 	/* don't do anything, just let the compiler check the arguments; */
3311 }
3312 
3313 int simple_attr_open(struct inode *inode, struct file *file,
3314 		     int (*get)(void *, u64 *), int (*set)(void *, u64),
3315 		     const char *fmt);
3316 int simple_attr_release(struct inode *inode, struct file *file);
3317 ssize_t simple_attr_read(struct file *file, char __user *buf,
3318 			 size_t len, loff_t *ppos);
3319 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3320 			  size_t len, loff_t *ppos);
3321 
3322 struct ctl_table;
3323 int proc_nr_files(struct ctl_table *table, int write,
3324 		  void __user *buffer, size_t *lenp, loff_t *ppos);
3325 int proc_nr_dentry(struct ctl_table *table, int write,
3326 		  void __user *buffer, size_t *lenp, loff_t *ppos);
3327 int proc_nr_inodes(struct ctl_table *table, int write,
3328 		   void __user *buffer, size_t *lenp, loff_t *ppos);
3329 int __init get_filesystem_list(char *buf);
3330 
3331 #define __FMODE_EXEC		((__force int) FMODE_EXEC)
3332 #define __FMODE_NONOTIFY	((__force int) FMODE_NONOTIFY)
3333 
3334 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3335 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3336 					    (flag & __FMODE_NONOTIFY)))
3337 
3338 static inline bool is_sxid(umode_t mode)
3339 {
3340 	return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3341 }
3342 
3343 static inline int check_sticky(struct inode *dir, struct inode *inode)
3344 {
3345 	if (!(dir->i_mode & S_ISVTX))
3346 		return 0;
3347 
3348 	return __check_sticky(dir, inode);
3349 }
3350 
3351 static inline void inode_has_no_xattr(struct inode *inode)
3352 {
3353 	if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3354 		inode->i_flags |= S_NOSEC;
3355 }
3356 
3357 static inline bool is_root_inode(struct inode *inode)
3358 {
3359 	return inode == inode->i_sb->s_root->d_inode;
3360 }
3361 
3362 static inline bool dir_emit(struct dir_context *ctx,
3363 			    const char *name, int namelen,
3364 			    u64 ino, unsigned type)
3365 {
3366 	return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3367 }
3368 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3369 {
3370 	return ctx->actor(ctx, ".", 1, ctx->pos,
3371 			  file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3372 }
3373 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3374 {
3375 	return ctx->actor(ctx, "..", 2, ctx->pos,
3376 			  parent_ino(file->f_path.dentry), DT_DIR) == 0;
3377 }
3378 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3379 {
3380 	if (ctx->pos == 0) {
3381 		if (!dir_emit_dot(file, ctx))
3382 			return false;
3383 		ctx->pos = 1;
3384 	}
3385 	if (ctx->pos == 1) {
3386 		if (!dir_emit_dotdot(file, ctx))
3387 			return false;
3388 		ctx->pos = 2;
3389 	}
3390 	return true;
3391 }
3392 static inline bool dir_relax(struct inode *inode)
3393 {
3394 	inode_unlock(inode);
3395 	inode_lock(inode);
3396 	return !IS_DEADDIR(inode);
3397 }
3398 
3399 static inline bool dir_relax_shared(struct inode *inode)
3400 {
3401 	inode_unlock_shared(inode);
3402 	inode_lock_shared(inode);
3403 	return !IS_DEADDIR(inode);
3404 }
3405 
3406 extern bool path_noexec(const struct path *path);
3407 extern void inode_nohighmem(struct inode *inode);
3408 
3409 #endif /* _LINUX_FS_H */
3410