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