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