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