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