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