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