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