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