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