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