fs.h 113.6 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
L
Linus Torvalds 已提交
2 3 4 5
#ifndef _LINUX_FS_H
#define _LINUX_FS_H

#include <linux/linkage.h>
6
#include <linux/wait_bit.h>
L
Linus Torvalds 已提交
7 8
#include <linux/kdev_t.h>
#include <linux/dcache.h>
9
#include <linux/path.h>
L
Linus Torvalds 已提交
10 11 12
#include <linux/stat.h>
#include <linux/cache.h>
#include <linux/list.h>
13
#include <linux/list_lru.h>
14
#include <linux/llist.h>
L
Linus Torvalds 已提交
15
#include <linux/radix-tree.h>
M
Matthew Wilcox 已提交
16
#include <linux/xarray.h>
17
#include <linux/rbtree.h>
L
Linus Torvalds 已提交
18
#include <linux/init.h>
19
#include <linux/pid.h>
20
#include <linux/bug.h>
21
#include <linux/mutex.h>
22
#include <linux/rwsem.h>
23
#include <linux/mm_types.h>
24
#include <linux/capability.h>
25
#include <linux/semaphore.h>
26
#include <linux/fcntl.h>
27
#include <linux/rculist_bl.h>
28
#include <linux/atomic.h>
29
#include <linux/shrinker.h>
30
#include <linux/migrate_mode.h>
31
#include <linux/uidgid.h>
32
#include <linux/lockdep.h>
33
#include <linux/percpu-rwsem.h>
34
#include <linux/workqueue.h>
35
#include <linux/delayed_call.h>
36
#include <linux/uuid.h>
37
#include <linux/errseq.h>
A
Adam Manzanares 已提交
38
#include <linux/ioprio.h>
39
#include <linux/fs_types.h>
40 41
#include <linux/build_bug.h>
#include <linux/stddef.h>
42
#include <linux/mount.h>
43
#include <linux/cred.h>
L
Linus Torvalds 已提交
44 45

#include <asm/byteorder.h>
46
#include <uapi/linux/fs.h>
L
Linus Torvalds 已提交
47

48
struct backing_dev_info;
49
struct bdi_writeback;
50
struct bio;
51
struct export_operations;
52
struct fiemap_extent_info;
53
struct hd_geometry;
L
Linus Torvalds 已提交
54
struct iovec;
55
struct kiocb;
A
Alexey Dobriyan 已提交
56
struct kobject;
L
Linus Torvalds 已提交
57 58 59 60 61
struct pipe_inode_info;
struct poll_table_struct;
struct kstatfs;
struct vm_area_struct;
struct vfsmount;
62
struct cred;
63
struct swap_info_struct;
64
struct seq_file;
65
struct workqueue_struct;
66
struct iov_iter;
67 68
struct fscrypt_info;
struct fscrypt_operations;
69 70
struct fsverity_info;
struct fsverity_operations;
A
Al Viro 已提交
71
struct fs_context;
72
struct fs_parameter_spec;
L
Linus Torvalds 已提交
73

74
extern void __init inode_init(void);
L
Linus Torvalds 已提交
75
extern void __init inode_init_early(void);
76 77
extern void __init files_init(void);
extern void __init files_maxfiles_init(void);
L
Linus Torvalds 已提交
78

79
extern struct files_stat_struct files_stat;
E
Eric Dumazet 已提交
80
extern unsigned long get_max_files(void);
81
extern unsigned int sysctl_nr_open;
82 83
extern struct inodes_stat_t inodes_stat;
extern int leases_enable, lease_break_time;
K
Kees Cook 已提交
84 85
extern int sysctl_protected_symlinks;
extern int sysctl_protected_hardlinks;
86 87
extern int sysctl_protected_fifos;
extern int sysctl_protected_regular;
88

C
Christoph Hellwig 已提交
89 90
typedef __kernel_rwf_t rwf_t;

L
Linus Torvalds 已提交
91 92 93
struct buffer_head;
typedef int (get_block_t)(struct inode *inode, sector_t iblock,
			struct buffer_head *bh_result, int create);
94
typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
95
			ssize_t bytes, void *private);
L
Linus Torvalds 已提交
96

D
David Howells 已提交
97 98 99 100 101 102 103 104 105 106 107 108
#define MAY_EXEC		0x00000001
#define MAY_WRITE		0x00000002
#define MAY_READ		0x00000004
#define MAY_APPEND		0x00000008
#define MAY_ACCESS		0x00000010
#define MAY_OPEN		0x00000020
#define MAY_CHDIR		0x00000040
/* called from RCU mode, don't block */
#define MAY_NOT_BLOCK		0x00000080

/*
 * flags in file.f_mode.  Note that FMODE_READ and FMODE_WRITE must correspond
109
 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
D
David Howells 已提交
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
 */

/* file is open for reading */
#define FMODE_READ		((__force fmode_t)0x1)
/* file is open for writing */
#define FMODE_WRITE		((__force fmode_t)0x2)
/* file is seekable */
#define FMODE_LSEEK		((__force fmode_t)0x4)
/* file can be accessed using pread */
#define FMODE_PREAD		((__force fmode_t)0x8)
/* file can be accessed using pwrite */
#define FMODE_PWRITE		((__force fmode_t)0x10)
/* File is opened for execution with sys_execve / sys_uselib */
#define FMODE_EXEC		((__force fmode_t)0x20)
/* File is opened with O_NDELAY (only set for block devices) */
#define FMODE_NDELAY		((__force fmode_t)0x40)
/* File is opened with O_EXCL (only set for block devices) */
#define FMODE_EXCL		((__force fmode_t)0x80)
/* File is opened using open(.., 3, ..) and is writeable only for ioctls
   (specialy hack for floppy.c) */
#define FMODE_WRITE_IOCTL	((__force fmode_t)0x100)
/* 32bit hashes as llseek() offset (for directories) */
#define FMODE_32BITHASH         ((__force fmode_t)0x200)
/* 64bit hashes as llseek() offset (for directories) */
#define FMODE_64BITHASH         ((__force fmode_t)0x400)

/*
 * Don't update ctime and mtime.
 *
 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
 */
#define FMODE_NOCMTIME		((__force fmode_t)0x800)

/* Expect random access pattern */
#define FMODE_RANDOM		((__force fmode_t)0x1000)

/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
#define FMODE_UNSIGNED_OFFSET	((__force fmode_t)0x2000)

/* File is opened with O_PATH; almost nothing can be done with it */
#define FMODE_PATH		((__force fmode_t)0x4000)

153 154
/* File needs atomic accesses to f_pos */
#define FMODE_ATOMIC_POS	((__force fmode_t)0x8000)
155 156
/* Write access to underlying fs */
#define FMODE_WRITER		((__force fmode_t)0x10000)
157 158 159 160
/* Has read method(s) */
#define FMODE_CAN_READ          ((__force fmode_t)0x20000)
/* Has write method(s) */
#define FMODE_CAN_WRITE         ((__force fmode_t)0x40000)
161

A
Al Viro 已提交
162
#define FMODE_OPENED		((__force fmode_t)0x80000)
163
#define FMODE_CREATED		((__force fmode_t)0x100000)
A
Al Viro 已提交
164

165 166 167
/* File is stream-like */
#define FMODE_STREAM		((__force fmode_t)0x200000)

D
David Howells 已提交
168
/* File was opened by fanotify and shouldn't generate fanotify events */
169
#define FMODE_NONOTIFY		((__force fmode_t)0x4000000)
D
David Howells 已提交
170

171
/* File is capable of returning -EAGAIN if I/O will block */
172 173 174 175
#define FMODE_NOWAIT		((__force fmode_t)0x8000000)

/* File represents mount that needs unmounting */
#define FMODE_NEED_UNMOUNT	((__force fmode_t)0x10000000)
176

177
/* File does not contribute to nr_files count */
178
#define FMODE_NOACCOUNT		((__force fmode_t)0x20000000)
179

J
Jens Axboe 已提交
180 181 182
/* File supports async buffered reads */
#define FMODE_BUF_RASYNC	((__force fmode_t)0x40000000)

L
Linus Torvalds 已提交
183 184 185 186
/*
 * Attribute flags.  These should be or-ed together to figure out what
 * has been changed!
 */
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
#define ATTR_MODE	(1 << 0)
#define ATTR_UID	(1 << 1)
#define ATTR_GID	(1 << 2)
#define ATTR_SIZE	(1 << 3)
#define ATTR_ATIME	(1 << 4)
#define ATTR_MTIME	(1 << 5)
#define ATTR_CTIME	(1 << 6)
#define ATTR_ATIME_SET	(1 << 7)
#define ATTR_MTIME_SET	(1 << 8)
#define ATTR_FORCE	(1 << 9) /* Not a change, but a change it */
#define ATTR_KILL_SUID	(1 << 11)
#define ATTR_KILL_SGID	(1 << 12)
#define ATTR_FILE	(1 << 13)
#define ATTR_KILL_PRIV	(1 << 14)
#define ATTR_OPEN	(1 << 15) /* Truncating from open(O_TRUNC) */
#define ATTR_TIMES_SET	(1 << 16)
203
#define ATTR_TOUCH	(1 << 17)
L
Linus Torvalds 已提交
204

M
Miklos Szeredi 已提交
205 206 207 208 209 210 211
/*
 * Whiteout is represented by a char device.  The following constants define the
 * mode and device number to use.
 */
#define WHITEOUT_MODE 0
#define WHITEOUT_DEV 0

L
Linus Torvalds 已提交
212 213 214 215 216 217 218 219 220 221 222 223
/*
 * This is the Inode Attributes structure, used for notify_change().  It
 * uses the above definitions as flags, to know which values have changed.
 * Also, in this manner, a Filesystem can look at only the values it cares
 * about.  Basically, these are the attributes that the VFS layer can
 * request to change from the FS layer.
 *
 * Derek Atkins <warlord@MIT.EDU> 94-10-20
 */
struct iattr {
	unsigned int	ia_valid;
	umode_t		ia_mode;
224 225
	kuid_t		ia_uid;
	kgid_t		ia_gid;
L
Linus Torvalds 已提交
226
	loff_t		ia_size;
227 228 229
	struct timespec64 ia_atime;
	struct timespec64 ia_mtime;
	struct timespec64 ia_ctime;
230 231

	/*
L
Lucas De Marchi 已提交
232
	 * Not an attribute, but an auxiliary info for filesystems wanting to
233 234 235 236
	 * implement an ftruncate() like method.  NOTE: filesystem should
	 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
	 */
	struct file	*ia_file;
L
Linus Torvalds 已提交
237 238 239 240 241 242 243
};

/*
 * Includes for diskquotas.
 */
#include <linux/quota.h>

244 245 246 247 248 249
/*
 * Maximum number of layers of fs stack.  Needs to be limited to
 * prevent kernel stack overflow
 */
#define FILESYSTEM_MAX_STACK_DEPTH 2

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
/** 
 * enum positive_aop_returns - aop return codes with specific semantics
 *
 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
 * 			    completed, that the page is still locked, and
 * 			    should be considered active.  The VM uses this hint
 * 			    to return the page to the active list -- it won't
 * 			    be a candidate for writeback again in the near
 * 			    future.  Other callers must be careful to unlock
 * 			    the page if they get this return.  Returned by
 * 			    writepage(); 
 *
 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
 *  			unlocked it and the page might have been truncated.
 *  			The caller should back up to acquiring a new page and
 *  			trying again.  The aop will be taking reasonable
 *  			precautions not to livelock.  If the caller held a page
 *  			reference, it should drop it before retrying.  Returned
N
Nick Piggin 已提交
268
 *  			by readpage().
269 270 271 272 273 274 275 276 277 278 279 280
 *
 * address_space_operation functions return these large constants to indicate
 * special semantics to the caller.  These are much larger than the bytes in a
 * page to allow for functions that return the number of bytes operated on in a
 * given page.
 */

enum positive_aop_returns {
	AOP_WRITEPAGE_ACTIVATE	= 0x80000,
	AOP_TRUNCATED_PAGE	= 0x80001,
};

281 282
#define AOP_FLAG_CONT_EXPAND		0x0001 /* called from cont_expand */
#define AOP_FLAG_NOFS			0x0002 /* used by filesystem to direct
283 284
						* helper code (eg buffer layer)
						* to clear GFP_FS from alloc */
285

L
Linus Torvalds 已提交
286 287 288 289 290 291
/*
 * oh the beauties of C type declarations.
 */
struct page;
struct address_space;
struct writeback_control;
292
struct readahead_control;
L
Linus Torvalds 已提交
293

294 295
/*
 * Write life time hint values.
296
 * Stored in struct inode as u8.
297 298 299 300 301 302 303 304 305 306
 */
enum rw_hint {
	WRITE_LIFE_NOT_SET	= 0,
	WRITE_LIFE_NONE		= RWH_WRITE_LIFE_NONE,
	WRITE_LIFE_SHORT	= RWH_WRITE_LIFE_SHORT,
	WRITE_LIFE_MEDIUM	= RWH_WRITE_LIFE_MEDIUM,
	WRITE_LIFE_LONG		= RWH_WRITE_LIFE_LONG,
	WRITE_LIFE_EXTREME	= RWH_WRITE_LIFE_EXTREME,
};

307 308 309 310 311 312 313 314 315 316 317
/* Match RWF_* bits to IOCB bits */
#define IOCB_HIPRI		(__force int) RWF_HIPRI
#define IOCB_DSYNC		(__force int) RWF_DSYNC
#define IOCB_SYNC		(__force int) RWF_SYNC
#define IOCB_NOWAIT		(__force int) RWF_NOWAIT
#define IOCB_APPEND		(__force int) RWF_APPEND

/* non-RWF related bits - start at 16 */
#define IOCB_EVENTFD		(1 << 16)
#define IOCB_DIRECT		(1 << 17)
#define IOCB_WRITE		(1 << 18)
318
/* iocb->ki_waitq is valid */
319 320
#define IOCB_WAITQ		(1 << 19)
#define IOCB_NOIO		(1 << 20)
321 322 323

struct kiocb {
	struct file		*ki_filp;
324 325 326 327

	/* The 'ki_filp' pointer is shared in a union for aio */
	randomized_struct_fields_start

328 329 330 331
	loff_t			ki_pos;
	void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
	void			*private;
	int			ki_flags;
332
	u16			ki_hint;
A
Adam Manzanares 已提交
333
	u16			ki_ioprio; /* See linux/ioprio.h */
334 335 336 337
	union {
		unsigned int		ki_cookie; /* for ->iopoll */
		struct wait_page_queue	*ki_waitq; /* for async buffered IO */
	};
338 339 340

	randomized_struct_fields_end
};
341 342 343 344 345 346

static inline bool is_sync_kiocb(struct kiocb *kiocb)
{
	return kiocb->ki_complete == NULL;
}

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
/*
 * "descriptor" for what we're up to with a read.
 * This allows us to use the same read code yet
 * have multiple different users of the data that
 * we read from a file.
 *
 * The simplest case just copies the data to user
 * mode.
 */
typedef struct {
	size_t written;
	size_t count;
	union {
		char __user *buf;
		void *data;
	} arg;
	int error;
} read_descriptor_t;

typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
		unsigned long, unsigned long);
N
Nick Piggin 已提交
368

L
Linus Torvalds 已提交
369 370 371 372 373 374 375
struct address_space_operations {
	int (*writepage)(struct page *page, struct writeback_control *wbc);
	int (*readpage)(struct file *, struct page *);

	/* Write back some dirty pages from this mapping. */
	int (*writepages)(struct address_space *, struct writeback_control *);

376
	/* Set a page dirty.  Return true if this dirtied it */
L
Linus Torvalds 已提交
377 378
	int (*set_page_dirty)(struct page *page);

379 380 381 382
	/*
	 * Reads in the requested pages. Unlike ->readpage(), this is
	 * PURELY used for read-ahead!.
	 */
L
Linus Torvalds 已提交
383 384
	int (*readpages)(struct file *filp, struct address_space *mapping,
			struct list_head *pages, unsigned nr_pages);
385
	void (*readahead)(struct readahead_control *);
L
Linus Torvalds 已提交
386

387 388 389 390 391 392 393
	int (*write_begin)(struct file *, struct address_space *mapping,
				loff_t pos, unsigned len, unsigned flags,
				struct page **pagep, void **fsdata);
	int (*write_end)(struct file *, struct address_space *mapping,
				loff_t pos, unsigned len, unsigned copied,
				struct page *page, void *fsdata);

L
Linus Torvalds 已提交
394 395
	/* Unfortunately this kludge is needed for FIBMAP. Don't use it */
	sector_t (*bmap)(struct address_space *, sector_t);
396
	void (*invalidatepage) (struct page *, unsigned int, unsigned int);
A
Al Viro 已提交
397
	int (*releasepage) (struct page *, gfp_t);
398
	void (*freepage)(struct page *);
399
	ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
400
	/*
401 402
	 * migrate the contents of a page to the specified target. If
	 * migrate_mode is MIGRATE_ASYNC, it must not block.
403
	 */
404
	int (*migratepage) (struct address_space *,
405
			struct page *, struct page *, enum migrate_mode);
406 407
	bool (*isolate_page)(struct page *, isolate_mode_t);
	void (*putback_page)(struct page *);
408
	int (*launder_page) (struct page *);
409
	int (*is_partially_uptodate) (struct page *, unsigned long,
410
					unsigned long);
411
	void (*is_dirty_writeback) (struct page *, bool *, bool *);
412
	int (*error_remove_page)(struct address_space *, struct page *);
413 414

	/* swapfile support */
415 416 417
	int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
				sector_t *span);
	void (*swap_deactivate)(struct file *file);
L
Linus Torvalds 已提交
418 419
};

J
Jens Axboe 已提交
420 421
extern const struct address_space_operations empty_aops;

422 423 424 425 426 427 428 429 430 431 432 433
/*
 * pagecache_write_begin/pagecache_write_end must be used by general code
 * to write into the pagecache.
 */
int pagecache_write_begin(struct file *, struct address_space *mapping,
				loff_t pos, unsigned len, unsigned flags,
				struct page **pagep, void **fsdata);

int pagecache_write_end(struct file *, struct address_space *mapping,
				loff_t pos, unsigned len, unsigned copied,
				struct page *page, void *fsdata);

434 435 436 437 438 439
/**
 * struct address_space - Contents of a cacheable, mappable object.
 * @host: Owner, either the inode or the block_device.
 * @i_pages: Cached pages.
 * @gfp_mask: Memory allocation flags to use for allocating pages.
 * @i_mmap_writable: Number of VM_SHARED mappings.
440
 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
441 442 443 444 445 446 447 448 449 450 451 452
 * @i_mmap: Tree of private and shared mappings.
 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
 * @nrpages: Number of page entries, protected by the i_pages lock.
 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
 * @writeback_index: Writeback starts here.
 * @a_ops: Methods.
 * @flags: Error bits and flags (AS_*).
 * @wb_err: The most recent error which has occurred.
 * @private_lock: For use by the owner of the address_space.
 * @private_list: For use by the owner of the address_space.
 * @private_data: For use by the owner of the address_space.
 */
L
Linus Torvalds 已提交
453
struct address_space {
454 455 456 457
	struct inode		*host;
	struct xarray		i_pages;
	gfp_t			gfp_mask;
	atomic_t		i_mmap_writable;
458 459 460 461
#ifdef CONFIG_READ_ONLY_THP_FOR_FS
	/* number of thp, only for non-shmem files */
	atomic_t		nr_thps;
#endif
462 463 464
	struct rb_root_cached	i_mmap;
	struct rw_semaphore	i_mmap_rwsem;
	unsigned long		nrpages;
465
	unsigned long		nrexceptional;
466 467 468
	pgoff_t			writeback_index;
	const struct address_space_operations *a_ops;
	unsigned long		flags;
469
	errseq_t		wb_err;
470 471 472
	spinlock_t		private_lock;
	struct list_head	private_list;
	void			*private_data;
473
} __attribute__((aligned(sizeof(long)))) __randomize_layout;
L
Linus Torvalds 已提交
474 475
	/*
	 * On most architectures that alignment is already the case; but
L
Lucas De Marchi 已提交
476
	 * must be enforced here for CRIS, to let the least significant bit
L
Linus Torvalds 已提交
477 478 479
	 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
	 */

480 481 482 483 484
/* XArray tags, for tagging dirty and writeback pages in the pagecache. */
#define PAGECACHE_TAG_DIRTY	XA_MARK_0
#define PAGECACHE_TAG_WRITEBACK	XA_MARK_1
#define PAGECACHE_TAG_TOWRITE	XA_MARK_2

L
Linus Torvalds 已提交
485
/*
486
 * Returns true if any of the pages in the mapping are marked with the tag.
L
Linus Torvalds 已提交
487
 */
488 489 490 491
static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
{
	return xa_marked(&mapping->i_pages, tag);
}
L
Linus Torvalds 已提交
492

493 494
static inline void i_mmap_lock_write(struct address_space *mapping)
{
495
	down_write(&mapping->i_mmap_rwsem);
496 497
}

498 499 500 501 502
static inline int i_mmap_trylock_write(struct address_space *mapping)
{
	return down_write_trylock(&mapping->i_mmap_rwsem);
}

503 504
static inline void i_mmap_unlock_write(struct address_space *mapping)
{
505
	up_write(&mapping->i_mmap_rwsem);
506 507
}

D
Davidlohr Bueso 已提交
508 509 510 511 512 513 514 515 516 517
static inline void i_mmap_lock_read(struct address_space *mapping)
{
	down_read(&mapping->i_mmap_rwsem);
}

static inline void i_mmap_unlock_read(struct address_space *mapping)
{
	up_read(&mapping->i_mmap_rwsem);
}

518 519 520 521 522 523 524 525 526 527
static inline void i_mmap_assert_locked(struct address_space *mapping)
{
	lockdep_assert_held(&mapping->i_mmap_rwsem);
}

static inline void i_mmap_assert_write_locked(struct address_space *mapping)
{
	lockdep_assert_held_write(&mapping->i_mmap_rwsem);
}

L
Linus Torvalds 已提交
528 529 530 531 532
/*
 * Might pages of this file be mapped into userspace?
 */
static inline int mapping_mapped(struct address_space *mapping)
{
533
	return	!RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
L
Linus Torvalds 已提交
534 535 536 537
}

/*
 * Might pages of this file have been modified in userspace?
538
 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap
L
Linus Torvalds 已提交
539 540
 * marks vma as VM_SHARED if it is shared, and the file was opened for
 * writing i.e. vma may be mprotected writable even if now readonly.
541 542 543
 *
 * If i_mmap_writable is negative, no new writable mappings are allowed. You
 * can only deny writable mappings, if none exists right now.
L
Linus Torvalds 已提交
544 545 546
 */
static inline int mapping_writably_mapped(struct address_space *mapping)
{
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
	return atomic_read(&mapping->i_mmap_writable) > 0;
}

static inline int mapping_map_writable(struct address_space *mapping)
{
	return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
		0 : -EPERM;
}

static inline void mapping_unmap_writable(struct address_space *mapping)
{
	atomic_dec(&mapping->i_mmap_writable);
}

static inline int mapping_deny_writable(struct address_space *mapping)
{
	return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
		0 : -EBUSY;
}

static inline void mapping_allow_writable(struct address_space *mapping)
{
	atomic_inc(&mapping->i_mmap_writable);
L
Linus Torvalds 已提交
570 571 572 573 574 575 576 577 578 579 580 581 582
}

/*
 * Use sequence counter to get consistent i_size on 32-bit processors.
 */
#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
#include <linux/seqlock.h>
#define __NEED_I_SIZE_ORDERED
#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
#else
#define i_size_ordered_init(inode) do { } while (0)
#endif

A
Al Viro 已提交
583 584
struct posix_acl;
#define ACL_NOT_CACHED ((void *)(-1))
585
#define ACL_DONT_CACHE ((void *)(-3))
A
Al Viro 已提交
586

587 588 589 590 591 592 593 594 595 596 597 598
static inline struct posix_acl *
uncached_acl_sentinel(struct task_struct *task)
{
	return (void *)task + 1;
}

static inline bool
is_uncached_acl(struct posix_acl *acl)
{
	return (long)acl & 1;
}

599 600 601
#define IOP_FASTPERM	0x0001
#define IOP_LOOKUP	0x0002
#define IOP_NOFOLLOW	0x0004
602
#define IOP_XATTR	0x0008
603
#define IOP_DEFAULT_READLINK	0x0010
604

605 606
struct fsnotify_mark_connector;

607 608 609 610 611
/*
 * Keep mostly read-only and often accessed (especially for
 * the RCU path lookup and 'stat' data) fields at the beginning
 * of the 'struct inode'
 */
L
Linus Torvalds 已提交
612
struct inode {
613
	umode_t			i_mode;
614
	unsigned short		i_opflags;
615 616
	kuid_t			i_uid;
	kgid_t			i_gid;
617 618 619 620 621 622 623
	unsigned int		i_flags;

#ifdef CONFIG_FS_POSIX_ACL
	struct posix_acl	*i_acl;
	struct posix_acl	*i_default_acl;
#endif

624 625
	const struct inode_operations	*i_op;
	struct super_block	*i_sb;
626
	struct address_space	*i_mapping;
627

628 629 630
#ifdef CONFIG_SECURITY
	void			*i_security;
#endif
631

632 633
	/* Stat data, not accessed from path walking */
	unsigned long		i_ino;
M
Miklos Szeredi 已提交
634 635 636 637 638 639 640 641 642 643 644
	/*
	 * Filesystems may only read i_nlink directly.  They shall use the
	 * following functions for modification:
	 *
	 *    (set|clear|inc|drop)_nlink
	 *    inode_(inc|dec)_link_count
	 */
	union {
		const unsigned int i_nlink;
		unsigned int __i_nlink;
	};
645
	dev_t			i_rdev;
646
	loff_t			i_size;
647 648 649
	struct timespec64	i_atime;
	struct timespec64	i_mtime;
	struct timespec64	i_ctime;
650 651
	spinlock_t		i_lock;	/* i_blocks, i_bytes, maybe i_size */
	unsigned short          i_bytes;
652 653
	u8			i_blkbits;
	u8			i_write_hint;
654 655 656 657 658 659 660 661
	blkcnt_t		i_blocks;

#ifdef __NEED_I_SIZE_ORDERED
	seqcount_t		i_size_seqcount;
#endif

	/* Misc */
	unsigned long		i_state;
662
	struct rw_semaphore	i_rwsem;
663

664
	unsigned long		dirtied_when;	/* jiffies of first dirtying */
665
	unsigned long		dirtied_time_when;
666

L
Linus Torvalds 已提交
667
	struct hlist_node	i_hash;
668
	struct list_head	i_io_list;	/* backing dev IO list */
669 670
#ifdef CONFIG_CGROUP_WRITEBACK
	struct bdi_writeback	*i_wb;		/* the associated cgroup wb */
671 672 673 674 675

	/* foreign inode detection, see wbc_detach_inode() */
	int			i_wb_frn_winner;
	u16			i_wb_frn_avg_time;
	u16			i_wb_frn_history;
676
#endif
N
Nick Piggin 已提交
677
	struct list_head	i_lru;		/* inode LRU list */
L
Linus Torvalds 已提交
678
	struct list_head	i_sb_list;
679
	struct list_head	i_wb_list;	/* backing dev writeback list */
N
Nick Piggin 已提交
680
	union {
A
Al Viro 已提交
681
		struct hlist_head	i_dentry;
N
Nick Piggin 已提交
682 683
		struct rcu_head		i_rcu;
	};
684
	atomic64_t		i_version;
685
	atomic64_t		i_sequence; /* see futex */
686
	atomic_t		i_count;
C
Christoph Hellwig 已提交
687
	atomic_t		i_dio_count;
688
	atomic_t		i_writecount;
689
#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
M
Mimi Zohar 已提交
690 691
	atomic_t		i_readcount; /* struct files open RO */
#endif
A
Al Viro 已提交
692 693 694 695
	union {
		const struct file_operations	*i_fop;	/* former ->i_op->default_file_ops */
		void (*free_inode)(struct inode *);
	};
696
	struct file_lock_context	*i_flctx;
L
Linus Torvalds 已提交
697 698
	struct address_space	i_data;
	struct list_head	i_devices;
699 700
	union {
		struct pipe_inode_info	*i_pipe;
701
		struct cdev		*i_cdev;
A
Al Viro 已提交
702
		char			*i_link;
A
Al Viro 已提交
703
		unsigned		i_dir_seq;
704
	};
L
Linus Torvalds 已提交
705 706 707

	__u32			i_generation;

708 709
#ifdef CONFIG_FSNOTIFY
	__u32			i_fsnotify_mask; /* all events this inode cares about */
710
	struct fsnotify_mark_connector __rcu	*i_fsnotify_marks;
R
Robert Love 已提交
711 712
#endif

713
#ifdef CONFIG_FS_ENCRYPTION
714 715 716
	struct fscrypt_info	*i_crypt_info;
#endif

717 718 719 720
#ifdef CONFIG_FS_VERITY
	struct fsverity_info	*i_verity_info;
#endif

721
	void			*i_private; /* fs or device private pointer */
722
} __randomize_layout;
L
Linus Torvalds 已提交
723

724 725
struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);

F
Fabian Frederick 已提交
726 727 728 729 730
static inline unsigned int i_blocksize(const struct inode *node)
{
	return (1 << node->i_blkbits);
}

A
Al Viro 已提交
731 732 733 734 735
static inline int inode_unhashed(struct inode *inode)
{
	return hlist_unhashed(&inode->i_hash);
}

A
Al Viro 已提交
736 737 738 739 740 741 742 743 744 745 746
/*
 * __mark_inode_dirty expects inodes to be hashed.  Since we don't
 * want special inodes in the fileset inode space, we make them
 * appear hashed, but do not put on any lists.  hlist_del()
 * will work fine and require no locking.
 */
static inline void inode_fake_hash(struct inode *inode)
{
	hlist_add_fake(&inode->i_hash);
}

I
Ingo Molnar 已提交
747 748 749 750 751 752
/*
 * inode->i_mutex nesting subclasses for the lock validator:
 *
 * 0: the object of the current VFS operation
 * 1: parent
 * 2: child/target
753 754
 * 3: xattr
 * 4: second non-directory
755 756 757
 * 5: second parent (when locking independent directories in rename)
 *
 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
758
 * non-directories at once.
I
Ingo Molnar 已提交
759 760
 *
 * The locking order between these classes is
761
 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
I
Ingo Molnar 已提交
762 763 764 765 766 767
 */
enum inode_i_mutex_lock_class
{
	I_MUTEX_NORMAL,
	I_MUTEX_PARENT,
	I_MUTEX_CHILD,
I
Ingo Molnar 已提交
768
	I_MUTEX_XATTR,
769 770
	I_MUTEX_NONDIR2,
	I_MUTEX_PARENT2,
I
Ingo Molnar 已提交
771 772
};

A
Al Viro 已提交
773 774
static inline void inode_lock(struct inode *inode)
{
775
	down_write(&inode->i_rwsem);
A
Al Viro 已提交
776 777 778 779
}

static inline void inode_unlock(struct inode *inode)
{
780 781 782 783 784 785 786 787 788 789 790
	up_write(&inode->i_rwsem);
}

static inline void inode_lock_shared(struct inode *inode)
{
	down_read(&inode->i_rwsem);
}

static inline void inode_unlock_shared(struct inode *inode)
{
	up_read(&inode->i_rwsem);
A
Al Viro 已提交
791 792 793 794
}

static inline int inode_trylock(struct inode *inode)
{
795 796 797 798 799 800
	return down_write_trylock(&inode->i_rwsem);
}

static inline int inode_trylock_shared(struct inode *inode)
{
	return down_read_trylock(&inode->i_rwsem);
A
Al Viro 已提交
801 802 803 804
}

static inline int inode_is_locked(struct inode *inode)
{
805
	return rwsem_is_locked(&inode->i_rwsem);
A
Al Viro 已提交
806 807 808 809
}

static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
{
810
	down_write_nested(&inode->i_rwsem, subclass);
A
Al Viro 已提交
811 812
}

813 814 815 816 817
static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
{
	down_read_nested(&inode->i_rwsem, subclass);
}

818 819 820
void lock_two_nondirectories(struct inode *, struct inode*);
void unlock_two_nondirectories(struct inode *, struct inode*);

L
Linus Torvalds 已提交
821 822 823 824 825 826 827 828 829 830
/*
 * NOTE: in a 32bit arch with a preemptable kernel and
 * an UP compile the i_size_read/write must be atomic
 * with respect to the local cpu (unlike with preempt disabled),
 * but they don't need to be atomic with respect to other cpus like in
 * true SMP (so they need either to either locally disable irq around
 * the read or for example on x86 they can be still implemented as a
 * cmpxchg8b without the need of the lock prefix). For SMP compiles
 * and 64bit archs it makes no difference if preempt is enabled or not.
 */
J
Jan Engelhardt 已提交
831
static inline loff_t i_size_read(const struct inode *inode)
L
Linus Torvalds 已提交
832 833 834 835 836 837 838 839 840 841
{
#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
	loff_t i_size;
	unsigned int seq;

	do {
		seq = read_seqcount_begin(&inode->i_size_seqcount);
		i_size = inode->i_size;
	} while (read_seqcount_retry(&inode->i_size_seqcount, seq));
	return i_size;
842
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
L
Linus Torvalds 已提交
843 844 845 846 847 848 849 850 851 852 853
	loff_t i_size;

	preempt_disable();
	i_size = inode->i_size;
	preempt_enable();
	return i_size;
#else
	return inode->i_size;
#endif
}

854 855 856 857 858
/*
 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
 */
L
Linus Torvalds 已提交
859 860 861
static inline void i_size_write(struct inode *inode, loff_t i_size)
{
#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
862
	preempt_disable();
L
Linus Torvalds 已提交
863 864 865
	write_seqcount_begin(&inode->i_size_seqcount);
	inode->i_size = i_size;
	write_seqcount_end(&inode->i_size_seqcount);
866
	preempt_enable();
867
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
L
Linus Torvalds 已提交
868 869 870 871 872 873 874 875
	preempt_disable();
	inode->i_size = i_size;
	preempt_enable();
#else
	inode->i_size = i_size;
#endif
}

J
Jan Engelhardt 已提交
876
static inline unsigned iminor(const struct inode *inode)
L
Linus Torvalds 已提交
877 878 879 880
{
	return MINOR(inode->i_rdev);
}

J
Jan Engelhardt 已提交
881
static inline unsigned imajor(const struct inode *inode)
L
Linus Torvalds 已提交
882 883 884 885 886 887
{
	return MAJOR(inode->i_rdev);
}

struct fown_struct {
	rwlock_t lock;          /* protects pid, uid, euid fields */
888 889
	struct pid *pid;	/* pid or -pgrp where SIGIO should be sent */
	enum pid_type pid_type;	/* Kind of process group SIGIO should be sent to */
890
	kuid_t uid, euid;	/* uid/euid of process setting the owner */
L
Linus Torvalds 已提交
891 892 893 894 895 896 897
	int signum;		/* posix.1b rt signal to be delivered on IO */
};

/*
 * Track a single file's readahead state
 */
struct file_ra_state {
F
Fengguang Wu 已提交
898 899 900
	pgoff_t start;			/* where readahead started */
	unsigned int size;		/* # of readahead pages */
	unsigned int async_size;	/* do asynchronous readahead when
901
					   there are only # of pages ahead */
902

F
Fengguang Wu 已提交
903
	unsigned int ra_pages;		/* Maximum readahead window */
904
	unsigned int mmap_miss;		/* Cache miss stat for mmap accesses */
905
	loff_t prev_pos;		/* Cache last read() position */
L
Linus Torvalds 已提交
906 907
};

908 909 910 911 912
/*
 * Check if @index falls in the readahead windows.
 */
static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
{
913 914
	return (index >= ra->start &&
		index <  ra->start + ra->size);
915 916
}

L
Linus Torvalds 已提交
917
struct file {
E
Eric Dumazet 已提交
918
	union {
919
		struct llist_node	fu_llist;
E
Eric Dumazet 已提交
920 921
		struct rcu_head 	fu_rcuhead;
	} f_u;
922
	struct path		f_path;
923
	struct inode		*f_inode;	/* cached value */
924
	const struct file_operations	*f_op;
925 926

	/*
927
	 * Protects f_ep, f_flags.
928 929 930
	 * Must not be taken from IRQ context.
	 */
	spinlock_t		f_lock;
931
	enum rw_hint		f_write_hint;
A
Al Viro 已提交
932
	atomic_long_t		f_count;
L
Linus Torvalds 已提交
933
	unsigned int 		f_flags;
934
	fmode_t			f_mode;
935
	struct mutex		f_pos_lock;
L
Linus Torvalds 已提交
936 937
	loff_t			f_pos;
	struct fown_struct	f_owner;
D
David Howells 已提交
938
	const struct cred	*f_cred;
L
Linus Torvalds 已提交
939 940
	struct file_ra_state	f_ra;

941
	u64			f_version;
942
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
943
	void			*f_security;
944
#endif
L
Linus Torvalds 已提交
945 946 947 948 949
	/* needed for tty driver, and maybe others */
	void			*private_data;

#ifdef CONFIG_EPOLL
	/* Used by fs/eventpoll.c to link all the hooks to this file */
950
	struct hlist_head	*f_ep;
L
Linus Torvalds 已提交
951 952
#endif /* #ifdef CONFIG_EPOLL */
	struct address_space	*f_mapping;
953
	errseq_t		f_wb_err;
954
	errseq_t		f_sb_err; /* for syncfs */
955 956
} __randomize_layout
  __attribute__((aligned(4)));	/* lest something weird decides that 2 is OK */
L
Linus Torvalds 已提交
957

958 959 960 961
struct file_handle {
	__u32 handle_bytes;
	int handle_type;
	/* file identifier */
962
	unsigned char f_handle[];
963 964
};

A
Al Viro 已提交
965 966 967 968 969
static inline struct file *get_file(struct file *f)
{
	atomic_long_inc(&f->f_count);
	return f;
}
J
Jens Axboe 已提交
970 971 972
#define get_file_rcu_many(x, cnt)	\
	atomic_long_add_unless(&(x)->f_count, (cnt), 0)
#define get_file_rcu(x) get_file_rcu_many((x), 1)
A
Al Viro 已提交
973
#define file_count(x)	atomic_long_read(&(x)->f_count)
L
Linus Torvalds 已提交
974 975 976 977 978 979

#define	MAX_NON_LFS	((1UL<<31) - 1)

/* Page cache limit. The filesystems should put that into their s_maxbytes 
   limits, otherwise bad things can happen in VM. */ 
#if BITS_PER_LONG==32
980
#define MAX_LFS_FILESIZE	((loff_t)ULONG_MAX << PAGE_SHIFT)
L
Linus Torvalds 已提交
981
#elif BITS_PER_LONG==64
982
#define MAX_LFS_FILESIZE 	((loff_t)LLONG_MAX)
L
Linus Torvalds 已提交
983 984 985 986
#endif

#define FL_POSIX	1
#define FL_FLOCK	2
987
#define FL_DELEG	4	/* NFSv4 delegation */
L
Linus Torvalds 已提交
988
#define FL_ACCESS	8	/* not trying to lock, just looking */
989
#define FL_EXISTS	16	/* when unlocking, test for existence */
L
Linus Torvalds 已提交
990
#define FL_LEASE	32	/* lease held on this file */
991
#define FL_CLOSE	64	/* unlock on close */
L
Linus Torvalds 已提交
992
#define FL_SLEEP	128	/* A blocking lock */
993 994
#define FL_DOWNGRADE_PENDING	256 /* Lease is being downgraded */
#define FL_UNLOCK_PENDING	512 /* Lease is being broken */
995
#define FL_OFDLCK	1024	/* lock is "owned" by struct file */
C
Christoph Hellwig 已提交
996
#define FL_LAYOUT	2048	/* outstanding pNFS layout */
L
Linus Torvalds 已提交
997

998 999
#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)

1000 1001 1002 1003 1004 1005
/*
 * Special return value from posix_lock_file() and vfs_lock_file() for
 * asynchronous locking.
 */
#define FILE_LOCK_DEFERRED 1

1006
/* legacy typedef, should eventually be removed */
1007
typedef void *fl_owner_t;
L
Linus Torvalds 已提交
1008

1009 1010
struct file_lock;

L
Linus Torvalds 已提交
1011 1012 1013 1014 1015 1016
struct file_lock_operations {
	void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
	void (*fl_release_private)(struct file_lock *);
};

struct lock_manager_operations {
1017 1018
	fl_owner_t (*lm_get_owner)(fl_owner_t);
	void (*lm_put_owner)(fl_owner_t);
J
J. Bruce Fields 已提交
1019
	void (*lm_notify)(struct file_lock *);	/* unblock callback */
1020
	int (*lm_grant)(struct file_lock *, int);
J
Jeff Layton 已提交
1021
	bool (*lm_break)(struct file_lock *);
1022
	int (*lm_change)(struct file_lock *, int, struct list_head *);
1023
	void (*lm_setup)(struct file_lock *, void **);
1024
	bool (*lm_breaker_owns_lease)(struct file_lock *);
L
Linus Torvalds 已提交
1025 1026
};

1027 1028
struct lock_manager {
	struct list_head list;
1029 1030 1031 1032 1033
	/*
	 * NFSv4 and up also want opens blocked during the grace period;
	 * NLM doesn't care:
	 */
	bool block_opens;
1034 1035
};

1036 1037
struct net;
void locks_start_grace(struct net *, struct lock_manager *);
1038
void locks_end_grace(struct lock_manager *);
C
Corentin Labbe 已提交
1039 1040
bool locks_in_grace(struct net *);
bool opens_in_grace(struct net *);
1041

L
Linus Torvalds 已提交
1042 1043 1044
/* that will die - we need it for nfs_lock_info */
#include <linux/nfs_fs_i.h>

1045 1046 1047 1048 1049 1050 1051 1052 1053
/*
 * struct file_lock represents a generic "file lock". It's used to represent
 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
 * note that the same struct is used to represent both a request for a lock and
 * the lock itself, but the same object is never used for both.
 *
 * FIXME: should we create a separate "struct lock_request" to help distinguish
 * these two uses?
 *
1054
 * The varous i_flctx lists are ordered by:
1055
 *
1056 1057 1058
 * 1) lock owner
 * 2) lock range start
 * 3) lock range end
1059 1060 1061
 *
 * Obviously, the last two criteria only matter for POSIX locks.
 */
L
Linus Torvalds 已提交
1062
struct file_lock {
1063
	struct file_lock *fl_blocker;	/* The lock, that is blocking us */
1064
	struct list_head fl_list;	/* link into file_lock_context */
1065
	struct hlist_node fl_link;	/* node in global lists */
1066 1067 1068 1069 1070 1071
	struct list_head fl_blocked_requests;	/* list of requests with
						 * ->fl_blocker pointing here
						 */
	struct list_head fl_blocked_member;	/* node in
						 * ->fl_blocker->fl_blocked_requests
						 */
L
Linus Torvalds 已提交
1072
	fl_owner_t fl_owner;
1073
	unsigned int fl_flags;
1074
	unsigned char fl_type;
L
Linus Torvalds 已提交
1075
	unsigned int fl_pid;
1076
	int fl_link_cpu;		/* what cpu's list is this on? */
L
Linus Torvalds 已提交
1077 1078 1079 1080 1081 1082
	wait_queue_head_t fl_wait;
	struct file *fl_file;
	loff_t fl_start;
	loff_t fl_end;

	struct fasync_struct *	fl_fasync; /* for lease break notifications */
1083 1084 1085
	/* for lease breaks: */
	unsigned long fl_break_time;
	unsigned long fl_downgrade_time;
L
Linus Torvalds 已提交
1086

1087
	const struct file_lock_operations *fl_ops;	/* Callbacks for filesystems */
1088
	const struct lock_manager_operations *fl_lmops;	/* Callbacks for lockmanagers */
L
Linus Torvalds 已提交
1089 1090
	union {
		struct nfs_lock_info	nfs_fl;
1091
		struct nfs4_lock_info	nfs4_fl;
D
David Howells 已提交
1092 1093 1094
		struct {
			struct list_head link;	/* link in AFS vnode's pending_locks list */
			int state;		/* state of grant or error if -ve */
1095
			unsigned int	debug_id;
D
David Howells 已提交
1096
		} afs;
L
Linus Torvalds 已提交
1097
	} fl_u;
1098
} __randomize_layout;
L
Linus Torvalds 已提交
1099

1100
struct file_lock_context {
1101
	spinlock_t		flc_lock;
1102
	struct list_head	flc_flock;
1103
	struct list_head	flc_posix;
1104
	struct list_head	flc_lease;
1105 1106
};

L
Linus Torvalds 已提交
1107 1108 1109 1110 1111 1112 1113
/* The following constant reflects the upper bound of the file/locking space */
#ifndef OFFSET_MAX
#define INT_LIMIT(x)	(~((x)1 << (sizeof(x)*8 - 1)))
#define OFFSET_MAX	INT_LIMIT(loff_t)
#define OFFT_OFFSET_MAX	INT_LIMIT(off_t)
#endif

1114 1115
extern void send_sigio(struct fown_struct *fown, int fd, int band);

1116
#define locks_inode(f) file_inode(f)
1117

1118
#ifdef CONFIG_FILE_LOCKING
1119
extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1120
extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1121
			struct flock *);
L
Linus Torvalds 已提交
1122 1123

#if BITS_PER_LONG == 32
1124
extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1125
extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1126
			struct flock64 *);
L
Linus Torvalds 已提交
1127 1128 1129 1130 1131 1132
#endif

extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
extern int fcntl_getlease(struct file *filp);

/* fs/locks.c */
1133
void locks_free_lock_context(struct inode *inode);
1134
void locks_free_lock(struct file_lock *fl);
L
Linus Torvalds 已提交
1135
extern void locks_init_lock(struct file_lock *);
1136
extern struct file_lock * locks_alloc_lock(void);
L
Linus Torvalds 已提交
1137
extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1138
extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
L
Linus Torvalds 已提交
1139
extern void locks_remove_posix(struct file *, fl_owner_t);
1140
extern void locks_remove_file(struct file *);
1141
extern void locks_release_private(struct file_lock *);
1142
extern void posix_test_lock(struct file *, struct file_lock *);
1143
extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1144
extern int locks_delete_block(struct file_lock *);
1145
extern int vfs_test_lock(struct file *, struct file_lock *);
1146
extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
M
Marc Eshel 已提交
1147
extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1148
extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J
J. Bruce Fields 已提交
1149
extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1150
extern void lease_get_mtime(struct inode *, struct timespec64 *time);
1151 1152
extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1153
extern int lease_modify(struct file_lock *, int, struct list_head *);
1154 1155 1156 1157 1158

struct notifier_block;
extern int lease_register_notifier(struct notifier_block *);
extern void lease_unregister_notifier(struct notifier_block *);

1159 1160 1161
struct files_struct;
extern void show_fd_locks(struct seq_file *f,
			 struct file *filp, struct files_struct *files);
1162
#else /* !CONFIG_FILE_LOCKING */
1163 1164
static inline int fcntl_getlk(struct file *file, unsigned int cmd,
			      struct flock __user *user)
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
{
	return -EINVAL;
}

static inline int fcntl_setlk(unsigned int fd, struct file *file,
			      unsigned int cmd, struct flock __user *user)
{
	return -EACCES;
}

1175
#if BITS_PER_LONG == 32
1176 1177
static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
				struct flock64 __user *user)
1178 1179 1180 1181 1182 1183 1184 1185 1186
{
	return -EINVAL;
}

static inline int fcntl_setlk64(unsigned int fd, struct file *file,
				unsigned int cmd, struct flock64 __user *user)
{
	return -EACCES;
}
1187
#endif
1188 1189
static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
{
1190
	return -EINVAL;
1191 1192 1193 1194
}

static inline int fcntl_getlease(struct file *filp)
{
1195
	return F_UNLCK;
1196 1197
}

1198
static inline void
1199
locks_free_lock_context(struct inode *inode)
1200 1201 1202
{
}

1203 1204 1205 1206 1207
static inline void locks_init_lock(struct file_lock *fl)
{
	return;
}

1208
static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
{
	return;
}

static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
{
	return;
}

static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
{
	return;
}

1223
static inline void locks_remove_file(struct file *filp)
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
{
	return;
}

static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
{
	return;
}

static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
				  struct file_lock *conflock)
{
	return -ENOLCK;
}

1239
static inline int locks_delete_block(struct file_lock *waiter)
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
{
	return -ENOENT;
}

static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
{
	return 0;
}

static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
				struct file_lock *fl, struct file_lock *conf)
{
	return -ENOLCK;
}

static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
{
	return 0;
}

1260 1261 1262 1263 1264
static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
{
	return -ENOLCK;
}

J
J. Bruce Fields 已提交
1265
static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1266 1267 1268 1269
{
	return 0;
}

1270 1271
static inline void lease_get_mtime(struct inode *inode,
				   struct timespec64 *time)
1272 1273 1274 1275 1276
{
	return;
}

static inline int generic_setlease(struct file *filp, long arg,
1277
				    struct file_lock **flp, void **priv)
1278 1279 1280 1281 1282
{
	return -EINVAL;
}

static inline int vfs_setlease(struct file *filp, long arg,
1283
			       struct file_lock **lease, void **priv)
1284 1285 1286 1287
{
	return -EINVAL;
}

1288
static inline int lease_modify(struct file_lock *fl, int arg,
1289
			       struct list_head *dispose)
1290 1291 1292
{
	return -EINVAL;
}
1293 1294 1295 1296

struct files_struct;
static inline void show_fd_locks(struct seq_file *f,
			struct file *filp, struct files_struct *files) {}
1297 1298
#endif /* !CONFIG_FILE_LOCKING */

1299 1300 1301 1302 1303
static inline struct inode *file_inode(const struct file *f)
{
	return f->f_inode;
}

M
Miklos Szeredi 已提交
1304 1305
static inline struct dentry *file_dentry(const struct file *file)
{
1306
	return d_real(file->f_path.dentry, file_inode(file));
M
Miklos Szeredi 已提交
1307 1308
}

1309 1310
static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
{
1311
	return locks_lock_inode_wait(locks_inode(filp), fl);
1312 1313
}

L
Linus Torvalds 已提交
1314
struct fasync_struct {
1315
	rwlock_t		fa_lock;
1316 1317 1318 1319 1320
	int			magic;
	int			fa_fd;
	struct fasync_struct	*fa_next; /* singly linked list */
	struct file		*fa_file;
	struct rcu_head		fa_rcu;
L
Linus Torvalds 已提交
1321 1322 1323 1324 1325 1326
};

#define FASYNC_MAGIC 0x4601

/* SMP safe fasync helpers: */
extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1327 1328 1329 1330 1331
extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
extern int fasync_remove_entry(struct file *, struct fasync_struct **);
extern struct fasync_struct *fasync_alloc(void);
extern void fasync_free(struct fasync_struct *);

L
Linus Torvalds 已提交
1332 1333 1334
/* can be called from interrupts */
extern void kill_fasync(struct fasync_struct **, int, int);

1335
extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1336
extern int f_setown(struct file *filp, unsigned long arg, int force);
L
Linus Torvalds 已提交
1337
extern void f_delown(struct file *filp);
1338
extern pid_t f_getown(struct file *filp);
L
Linus Torvalds 已提交
1339 1340
extern int send_sigurg(struct fown_struct *fown);

1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
/*
 * sb->s_flags.  Note that these mirror the equivalent MS_* flags where
 * represented in both.
 */
#define SB_RDONLY	 1	/* Mount read-only */
#define SB_NOSUID	 2	/* Ignore suid and sgid bits */
#define SB_NODEV	 4	/* Disallow access to device special files */
#define SB_NOEXEC	 8	/* Disallow program execution */
#define SB_SYNCHRONOUS	16	/* Writes are synced at once */
#define SB_MANDLOCK	64	/* Allow mandatory locks on an FS */
#define SB_DIRSYNC	128	/* Directory modifications are synchronous */
#define SB_NOATIME	1024	/* Do not update access times. */
#define SB_NODIRATIME	2048	/* Do not update directory access times */
#define SB_SILENT	32768
#define SB_POSIXACL	(1<<16)	/* VFS does not apply the umask */
S
Satya Tangirala 已提交
1356
#define SB_INLINECRYPT	(1<<17)	/* Use blk-crypto for encrypted files */
1357 1358 1359 1360 1361 1362
#define SB_KERNMOUNT	(1<<22) /* this is a kern_mount call */
#define SB_I_VERSION	(1<<23) /* Update inode I_version field */
#define SB_LAZYTIME	(1<<25) /* Update the on-disk [acm]times lazily */

/* These sb flags are internal to the kernel */
#define SB_SUBMOUNT     (1<<26)
1363
#define SB_FORCE    	(1<<27)
1364 1365 1366 1367 1368
#define SB_NOSEC	(1<<28)
#define SB_BORN		(1<<29)
#define SB_ACTIVE	(1<<30)
#define SB_NOUSER	(1<<31)

1369 1370 1371 1372 1373 1374
/* These flags relate to encoding and casefolding */
#define SB_ENC_STRICT_MODE_FL	(1 << 0)

#define sb_has_strict_encoding(sb) \
	(sb->s_encoding_flags & SB_ENC_STRICT_MODE_FL)

L
Linus Torvalds 已提交
1375 1376 1377 1378 1379 1380 1381
/*
 *	Umount options
 */

#define MNT_FORCE	0x00000001	/* Attempt to forcibily umount */
#define MNT_DETACH	0x00000002	/* Just detach from the tree */
#define MNT_EXPIRE	0x00000004	/* Mark for expiry */
1382 1383
#define UMOUNT_NOFOLLOW	0x00000008	/* Don't follow symlink on umount */
#define UMOUNT_UNUSED	0x80000000	/* Flag guaranteed to be unused */
L
Linus Torvalds 已提交
1384

1385 1386
/* sb->s_iflags */
#define SB_I_CGROUPWB	0x00000001	/* cgroup-aware writeback enabled */
1387
#define SB_I_NOEXEC	0x00000002	/* Ignore executables on this fs */
1388
#define SB_I_NODEV	0x00000004	/* Ignore devices on this fs */
1389
#define SB_I_STABLE_WRITES 0x00000008	/* don't modify blks until WB is done */
L
Linus Torvalds 已提交
1390

1391 1392
/* sb->s_iflags to limit user namespace mounts */
#define SB_I_USERNS_VISIBLE		0x00000010 /* fstype already mounted */
1393 1394
#define SB_I_IMA_UNVERIFIABLE_SIGNATURE	0x00000020
#define SB_I_UNTRUSTED_MOUNTER		0x00000040
L
Linus Torvalds 已提交
1395

1396 1397
#define SB_I_SKIP_SYNC	0x00000100	/* Skip superblock at global sync */

1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
/* Possible states of 'frozen' field */
enum {
	SB_UNFROZEN = 0,		/* FS is unfrozen */
	SB_FREEZE_WRITE	= 1,		/* Writes, dir ops, ioctls frozen */
	SB_FREEZE_PAGEFAULT = 2,	/* Page faults stopped as well */
	SB_FREEZE_FS = 3,		/* For internal FS use (e.g. to stop
					 * internal threads if needed) */
	SB_FREEZE_COMPLETE = 4,		/* ->freeze_fs finished successfully */
};

#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)

struct sb_writers {
1411
	int				frozen;		/* Is sb frozen? */
1412
	wait_queue_head_t		wait_unfrozen;	/* wait for thaw */
1413
	struct percpu_rw_semaphore	rw_sem[SB_FREEZE_LEVELS];
1414 1415
};

L
Linus Torvalds 已提交
1416 1417 1418
struct super_block {
	struct list_head	s_list;		/* Keep this first */
	dev_t			s_dev;		/* search index; _not_ kdev_t */
1419 1420
	unsigned char		s_blocksize_bits;
	unsigned long		s_blocksize;
1421
	loff_t			s_maxbytes;	/* Max file size */
L
Linus Torvalds 已提交
1422
	struct file_system_type	*s_type;
1423
	const struct super_operations	*s_op;
1424
	const struct dquot_operations	*dq_op;
1425
	const struct quotactl_ops	*s_qcop;
1426
	const struct export_operations *s_export_op;
L
Linus Torvalds 已提交
1427
	unsigned long		s_flags;
1428
	unsigned long		s_iflags;	/* internal SB_I_* flags */
L
Linus Torvalds 已提交
1429 1430 1431 1432 1433
	unsigned long		s_magic;
	struct dentry		*s_root;
	struct rw_semaphore	s_umount;
	int			s_count;
	atomic_t		s_active;
1434
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
1435
	void                    *s_security;
1436
#endif
1437
	const struct xattr_handler **s_xattr;
1438
#ifdef CONFIG_FS_ENCRYPTION
1439
	const struct fscrypt_operations	*s_cop;
1440
	struct key		*s_master_keys; /* master crypto keys in use */
1441 1442 1443
#endif
#ifdef CONFIG_FS_VERITY
	const struct fsverity_operations *s_vop;
1444 1445 1446 1447
#endif
#ifdef CONFIG_UNICODE
	struct unicode_map *s_encoding;
	__u16 s_encoding_flags;
1448
#endif
1449
	struct hlist_bl_head	s_roots;	/* alternate root dentries for NFS */
1450
	struct list_head	s_mounts;	/* list of mounts; _not_ for fs use */
L
Linus Torvalds 已提交
1451
	struct block_device	*s_bdev;
J
Jens Axboe 已提交
1452
	struct backing_dev_info *s_bdi;
1453
	struct mtd_info		*s_mtd;
A
Al Viro 已提交
1454
	struct hlist_node	s_instances;
1455
	unsigned int		s_quota_types;	/* Bitmask of supported quota types */
L
Linus Torvalds 已提交
1456 1457
	struct quota_info	s_dquot;	/* Diskquota specific options */

1458
	struct sb_writers	s_writers;
L
Linus Torvalds 已提交
1459

1460 1461 1462 1463 1464 1465 1466 1467 1468
	/*
	 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
	 * s_fsnotify_marks together for cache efficiency. They are frequently
	 * accessed and rarely modified.
	 */
	void			*s_fs_info;	/* Filesystem private info */

	/* Granularity of c/m/atime in ns (cannot be worse than a second) */
	u32			s_time_gran;
1469 1470 1471
	/* Time limits for c/m/atime in seconds */
	time64_t		   s_time_min;
	time64_t		   s_time_max;
1472 1473 1474 1475 1476
#ifdef CONFIG_FSNOTIFY
	__u32			s_fsnotify_mask;
	struct fsnotify_mark_connector __rcu	*s_fsnotify_marks;
#endif

1477 1478
	char			s_id[32];	/* Informational name */
	uuid_t			s_uuid;		/* UUID */
L
Linus Torvalds 已提交
1479

1480
	unsigned int		s_max_links;
1481
	fmode_t			s_mode;
L
Linus Torvalds 已提交
1482 1483 1484 1485 1486

	/*
	 * The next field is for VFS *only*. No filesystems have any business
	 * even looking at it. You had been warned.
	 */
1487
	struct mutex s_vfs_rename_mutex;	/* Kludge */
L
Linus Torvalds 已提交
1488

M
Miklos Szeredi 已提交
1489 1490 1491 1492
	/*
	 * Filesystem subtype.  If non-empty the filesystem type field
	 * in /proc/mounts will be "type.subtype"
	 */
1493
	const char *s_subtype;
1494

A
Al Viro 已提交
1495
	const struct dentry_operations *s_d_op; /* default d_op for dentries */
1496 1497 1498 1499 1500

	/*
	 * Saved pool identifier for cleancache (-1 means none)
	 */
	int cleancache_poolid;
1501 1502

	struct shrinker s_shrink;	/* per-sb shrinker handle */
1503

M
Miklos Szeredi 已提交
1504 1505 1506
	/* Number of inodes with nlink == 0 but still referenced */
	atomic_long_t s_remove_count;

1507 1508 1509
	/* Pending fsnotify inode refs */
	atomic_long_t s_fsnotify_inode_refs;

1510 1511
	/* Being remounted read-only */
	int s_readonly_remount;
1512

1513 1514 1515
	/* per-sb errseq_t for reporting writeback errors via syncfs */
	errseq_t s_wb_err;

1516 1517
	/* AIO completions deferred from interrupt context */
	struct workqueue_struct *s_dio_done_wq;
A
Al Viro 已提交
1518
	struct hlist_head s_pins;
1519

1520 1521 1522 1523 1524 1525 1526
	/*
	 * Owning user namespace and default context in which to
	 * interpret filesystem uids, gids, quotas, device nodes,
	 * xattrs and security labels.
	 */
	struct user_namespace *s_user_ns;

1527
	/*
1528 1529 1530
	 * The list_lru structure is essentially just a pointer to a table
	 * of per-node lru lists, each of which has its own spinlock.
	 * There is no need to put them into separate cachelines.
1531
	 */
1532 1533
	struct list_lru		s_dentry_lru;
	struct list_lru		s_inode_lru;
A
Al Viro 已提交
1534
	struct rcu_head		rcu;
1535
	struct work_struct	destroy_work;
1536

1537
	struct mutex		s_sync_lock;	/* sync serialisation lock */
1538 1539 1540 1541 1542

	/*
	 * Indicates how deep in a filesystem stack this SB is
	 */
	int s_stack_depth;
1543 1544 1545 1546

	/* s_inode_list_lock protects s_inodes */
	spinlock_t		s_inode_list_lock ____cacheline_aligned_in_smp;
	struct list_head	s_inodes;	/* all inodes */
1547 1548 1549

	spinlock_t		s_inode_wblist_lock;
	struct list_head	s_inodes_wb;	/* writeback inodes */
1550
} __randomize_layout;
L
Linus Torvalds 已提交
1551

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
/* Helper functions so that in most cases filesystems will
 * not need to deal directly with kuid_t and kgid_t and can
 * instead deal with the raw numeric values that are stored
 * in the filesystem.
 */
static inline uid_t i_uid_read(const struct inode *inode)
{
	return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
}

static inline gid_t i_gid_read(const struct inode *inode)
{
	return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
}

static inline void i_uid_write(struct inode *inode, uid_t uid)
{
	inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
}

static inline void i_gid_write(struct inode *inode, gid_t gid)
{
	inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
}

1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
static inline kuid_t kuid_into_mnt(struct user_namespace *mnt_userns,
				   kuid_t kuid)
{
	return make_kuid(mnt_userns, __kuid_val(kuid));
}

static inline kgid_t kgid_into_mnt(struct user_namespace *mnt_userns,
				   kgid_t kgid)
{
	return make_kgid(mnt_userns, __kgid_val(kgid));
}

static inline kuid_t i_uid_into_mnt(struct user_namespace *mnt_userns,
				    const struct inode *inode)
{
	return kuid_into_mnt(mnt_userns, inode->i_uid);
}

static inline kgid_t i_gid_into_mnt(struct user_namespace *mnt_userns,
				    const struct inode *inode)
{
	return kgid_into_mnt(mnt_userns, inode->i_gid);
}

static inline kuid_t kuid_from_mnt(struct user_namespace *mnt_userns,
				   kuid_t kuid)
{
	return KUIDT_INIT(from_kuid(mnt_userns, kuid));
}

static inline kgid_t kgid_from_mnt(struct user_namespace *mnt_userns,
				   kgid_t kgid)
{
	return KGIDT_INIT(from_kgid(mnt_userns, kgid));
}

static inline kuid_t fsuid_into_mnt(struct user_namespace *mnt_userns)
{
	return kuid_from_mnt(mnt_userns, current_fsuid());
}

static inline kgid_t fsgid_into_mnt(struct user_namespace *mnt_userns)
{
	return kgid_from_mnt(mnt_userns, current_fsgid());
}

1623
extern struct timespec64 current_time(struct inode *inode);
L
Linus Torvalds 已提交
1624 1625 1626 1627 1628

/*
 * Snapshotting support.
 */

1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
/*
 * These are internal functions, please use sb_start_{write,pagefault,intwrite}
 * instead.
 */
static inline void __sb_end_write(struct super_block *sb, int level)
{
	percpu_up_read(sb->s_writers.rw_sem + level-1);
}

static inline void __sb_start_write(struct super_block *sb, int level)
{
	percpu_down_read(sb->s_writers.rw_sem + level - 1);
}

static inline bool __sb_start_write_trylock(struct super_block *sb, int level)
{
	return percpu_down_read_trylock(sb->s_writers.rw_sem + level - 1);
}
1647

1648
#define __sb_writers_acquired(sb, lev)	\
1649
	percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1650
#define __sb_writers_release(sb, lev)	\
1651
	percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1652

1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
/**
 * sb_end_write - drop write access to a superblock
 * @sb: the super we wrote to
 *
 * Decrement number of writers to the filesystem. Wake up possible waiters
 * wanting to freeze the filesystem.
 */
static inline void sb_end_write(struct super_block *sb)
{
	__sb_end_write(sb, SB_FREEZE_WRITE);
}

/**
 * sb_end_pagefault - drop write access to a superblock from a page fault
 * @sb: the super we wrote to
 *
 * Decrement number of processes handling write page fault to the filesystem.
 * Wake up possible waiters wanting to freeze the filesystem.
 */
static inline void sb_end_pagefault(struct super_block *sb)
{
	__sb_end_write(sb, SB_FREEZE_PAGEFAULT);
}

/**
 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
 * @sb: the super we wrote to
 *
 * Decrement fs-internal number of writers to the filesystem.  Wake up possible
 * waiters wanting to freeze the filesystem.
 */
static inline void sb_end_intwrite(struct super_block *sb)
{
	__sb_end_write(sb, SB_FREEZE_FS);
}

/**
 * sb_start_write - get write access to a superblock
 * @sb: the super we write to
 *
 * When a process wants to write data or metadata to a file system (i.e. dirty
 * a page or an inode), it should embed the operation in a sb_start_write() -
 * sb_end_write() pair to get exclusion against file system freezing. This
 * function increments number of writers preventing freezing. If the file
 * system is already frozen, the function waits until the file system is
 * thawed.
 *
 * Since freeze protection behaves as a lock, users have to preserve
 * ordering of freeze protection and other filesystem locks. Generally,
 * freeze protection should be the outermost lock. In particular, we have:
 *
 * sb_start_write
 *   -> i_mutex			(write path, truncate, directory ops, ...)
 *   -> s_umount		(freeze_super, thaw_super)
 */
static inline void sb_start_write(struct super_block *sb)
{
1710
	__sb_start_write(sb, SB_FREEZE_WRITE);
1711 1712
}

1713
static inline bool sb_start_write_trylock(struct super_block *sb)
1714
{
1715
	return __sb_start_write_trylock(sb, SB_FREEZE_WRITE);
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
}

/**
 * sb_start_pagefault - get write access to a superblock from a page fault
 * @sb: the super we write to
 *
 * When a process starts handling write page fault, it should embed the
 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
 * exclusion against file system freezing. This is needed since the page fault
 * is going to dirty a page. This function increments number of running page
 * faults preventing freezing. If the file system is already frozen, the
 * function waits until the file system is thawed.
 *
 * Since page fault freeze protection behaves as a lock, users have to preserve
 * ordering of freeze protection and other filesystem locks. It is advised to
1731
 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
1732 1733
 * handling code implies lock dependency:
 *
1734
 * mmap_lock
1735 1736 1737 1738
 *   -> sb_start_pagefault
 */
static inline void sb_start_pagefault(struct super_block *sb)
{
1739
	__sb_start_write(sb, SB_FREEZE_PAGEFAULT);
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756
}

/*
 * sb_start_intwrite - get write access to a superblock for internal fs purposes
 * @sb: the super we write to
 *
 * This is the third level of protection against filesystem freezing. It is
 * free for use by a filesystem. The only requirement is that it must rank
 * below sb_start_pagefault.
 *
 * For example filesystem can call sb_start_intwrite() when starting a
 * transaction which somewhat eases handling of freezing for internal sources
 * of filesystem changes (internal fs threads, discarding preallocation on file
 * close, etc.).
 */
static inline void sb_start_intwrite(struct super_block *sb)
{
1757
	__sb_start_write(sb, SB_FREEZE_FS);
1758
}
L
Linus Torvalds 已提交
1759

1760
static inline bool sb_start_intwrite_trylock(struct super_block *sb)
1761
{
1762
	return __sb_start_write_trylock(sb, SB_FREEZE_FS);
1763 1764
}

1765 1766
bool inode_owner_or_capable(struct user_namespace *mnt_userns,
			    const struct inode *inode);
1767

L
Linus Torvalds 已提交
1768 1769 1770
/*
 * VFS helper functions..
 */
A
Al Viro 已提交
1771
extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1772
extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
A
Al Viro 已提交
1773
extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1774
extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J
J. Bruce Fields 已提交
1775
extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
L
Linus Torvalds 已提交
1776
extern int vfs_rmdir(struct inode *, struct dentry *);
1777
extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
M
Miklos Szeredi 已提交
1778
extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1779 1780 1781 1782 1783

static inline int vfs_whiteout(struct inode *dir, struct dentry *dentry)
{
	return vfs_mknod(dir, dentry, S_IFCHR | WHITEOUT_MODE, WHITEOUT_DEV);
}
L
Linus Torvalds 已提交
1784

1785 1786 1787
extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
				  int open_flag);

A
Al Viro 已提交
1788 1789 1790 1791
int vfs_mkobj(struct dentry *, umode_t,
		int (*f)(struct dentry *, umode_t, void *),
		void *);

C
Christoph Hellwig 已提交
1792
int vfs_fchown(struct file *file, uid_t user, gid_t group);
C
Christoph Hellwig 已提交
1793
int vfs_fchmod(struct file *file, umode_t mode);
C
Christoph Hellwig 已提交
1794
int vfs_utimes(const struct path *path, struct timespec64 *times);
C
Christoph Hellwig 已提交
1795

1796 1797
extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);

1798 1799 1800 1801 1802 1803 1804
#ifdef CONFIG_COMPAT
extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
					unsigned long arg);
#else
#define compat_ptr_ioctl NULL
#endif

1805 1806 1807
/*
 * VFS file helper functions.
 */
1808 1809
void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
		      const struct inode *dir, umode_t mode);
1810
extern bool may_open_dev(const struct path *path);
M
Mark Fasheh 已提交
1811

L
Linus Torvalds 已提交
1812 1813 1814 1815 1816 1817
/*
 * This is the "filldir" function type, used by readdir() to let
 * the kernel specify what kind of dirent layout it wants to have.
 * This allows the kernel to read directories into kernel space or
 * to have different dirent layouts depending on the binary type.
 */
1818 1819 1820 1821
struct dir_context;
typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
			 unsigned);

1822
struct dir_context {
1823
	filldir_t actor;
1824
	loff_t pos;
1825
};
1826

1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
/*
 * These flags let !MMU mmap() govern direct device mapping vs immediate
 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
 *
 * NOMMU_MAP_COPY:	Copy can be mapped (MAP_PRIVATE)
 * NOMMU_MAP_DIRECT:	Can be mapped directly (MAP_SHARED)
 * NOMMU_MAP_READ:	Can be mapped for reading
 * NOMMU_MAP_WRITE:	Can be mapped for writing
 * NOMMU_MAP_EXEC:	Can be mapped for execution
 */
#define NOMMU_MAP_COPY		0x00000001
#define NOMMU_MAP_DIRECT	0x00000008
#define NOMMU_MAP_READ		VM_MAYREAD
#define NOMMU_MAP_WRITE		VM_MAYWRITE
#define NOMMU_MAP_EXEC		VM_MAYEXEC

#define NOMMU_VMFLAGS \
	(NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)

1846 1847 1848
/*
 * These flags control the behavior of the remap_file_range function pointer.
 * If it is called with len == 0 that means "remap to end of source file".
1849
 * See Documentation/filesystems/vfs.rst for more details about this call.
1850 1851
 *
 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
1852
 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
1853 1854
 */
#define REMAP_FILE_DEDUP		(1 << 0)
1855
#define REMAP_FILE_CAN_SHORTEN		(1 << 1)
1856 1857 1858 1859 1860 1861 1862 1863

/*
 * These flags signal that the caller is ok with altering various aspects of
 * the behavior of the remap operation.  The changes must be made by the
 * implementation; the vfs remap helper functions can take advantage of them.
 * Flags in this category exist to preserve the quirky behavior of the hoisted
 * btrfs clone/dedupe ioctls.
 */
1864
#define REMAP_FILE_ADVISORY		(REMAP_FILE_CAN_SHORTEN)
1865

1866 1867
struct iov_iter;

L
Linus Torvalds 已提交
1868 1869 1870 1871 1872
struct file_operations {
	struct module *owner;
	loff_t (*llseek) (struct file *, loff_t, int);
	ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
	ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1873 1874
	ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
	ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1875
	int (*iopoll)(struct kiocb *kiocb, bool spin);
1876
	int (*iterate) (struct file *, struct dir_context *);
1877
	int (*iterate_shared) (struct file *, struct dir_context *);
A
Al Viro 已提交
1878
	__poll_t (*poll) (struct file *, struct poll_table_struct *);
L
Linus Torvalds 已提交
1879 1880 1881
	long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
	long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
	int (*mmap) (struct file *, struct vm_area_struct *);
1882
	unsigned long mmap_supported_flags;
L
Linus Torvalds 已提交
1883
	int (*open) (struct inode *, struct file *);
1884
	int (*flush) (struct file *, fl_owner_t id);
L
Linus Torvalds 已提交
1885
	int (*release) (struct inode *, struct file *);
1886
	int (*fsync) (struct file *, loff_t, loff_t, int datasync);
L
Linus Torvalds 已提交
1887 1888 1889 1890 1891 1892
	int (*fasync) (int, struct file *, int);
	int (*lock) (struct file *, int, struct file_lock *);
	ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
	unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
	int (*check_flags)(int);
	int (*flock) (struct file *, int, struct file_lock *);
1893 1894
	ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
	ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1895
	int (*setlease)(struct file *, long, struct file_lock **, void **);
1896 1897
	long (*fallocate)(struct file *file, int mode, loff_t offset,
			  loff_t len);
1898
	void (*show_fdinfo)(struct seq_file *m, struct file *f);
1899 1900 1901
#ifndef CONFIG_MMU
	unsigned (*mmap_capabilities)(struct file *);
#endif
1902 1903
	ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
			loff_t, size_t, unsigned int);
1904 1905 1906
	loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
				   struct file *file_out, loff_t pos_out,
				   loff_t len, unsigned int remap_flags);
1907
	int (*fadvise)(struct file *, loff_t, loff_t, int);
1908
} __randomize_layout;
L
Linus Torvalds 已提交
1909 1910

struct inode_operations {
A
Al Viro 已提交
1911
	struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1912
	const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1913
	int (*permission) (struct inode *, int);
1914
	struct posix_acl * (*get_acl)(struct inode *, int);
1915 1916 1917

	int (*readlink) (struct dentry *, char __user *,int);

A
Al Viro 已提交
1918
	int (*create) (struct inode *,struct dentry *, umode_t, bool);
L
Linus Torvalds 已提交
1919 1920 1921
	int (*link) (struct dentry *,struct inode *,struct dentry *);
	int (*unlink) (struct inode *,struct dentry *);
	int (*symlink) (struct inode *,struct dentry *,const char *);
1922
	int (*mkdir) (struct inode *,struct dentry *,umode_t);
L
Linus Torvalds 已提交
1923
	int (*rmdir) (struct inode *,struct dentry *);
A
Al Viro 已提交
1924
	int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
L
Linus Torvalds 已提交
1925
	int (*rename) (struct inode *, struct dentry *,
M
Miklos Szeredi 已提交
1926
			struct inode *, struct dentry *, unsigned int);
L
Linus Torvalds 已提交
1927
	int (*setattr) (struct dentry *, struct iattr *);
1928
	int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
L
Linus Torvalds 已提交
1929
	ssize_t (*listxattr) (struct dentry *, char *, size_t);
M
Mark Fasheh 已提交
1930 1931
	int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
		      u64 len);
1932
	int (*update_time)(struct inode *, struct timespec64 *, int);
A
Al Viro 已提交
1933
	int (*atomic_open)(struct inode *, struct dentry *,
A
Al Viro 已提交
1934
			   struct file *, unsigned open_flag,
1935
			   umode_t create_mode);
1936
	int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1937
	int (*set_acl)(struct inode *, struct posix_acl *, int);
1938
} ____cacheline_aligned;
L
Linus Torvalds 已提交
1939

1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
				     struct iov_iter *iter)
{
	return file->f_op->read_iter(kio, iter);
}

static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
				      struct iov_iter *iter)
{
	return file->f_op->write_iter(kio, iter);
}

1952 1953 1954 1955 1956
static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
{
	return file->f_op->mmap(file, vma);
}

L
Linus Torvalds 已提交
1957 1958
extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1959 1960
extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
				   loff_t, size_t, unsigned int);
1961 1962 1963
extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
				       struct file *file_out, loff_t pos_out,
				       size_t len, unsigned int flags);
1964 1965
extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
					 struct file *file_out, loff_t pos_out,
1966 1967 1968 1969
					 loff_t *count,
					 unsigned int remap_flags);
extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
				  struct file *file_out, loff_t pos_out,
1970
				  loff_t len, unsigned int remap_flags);
1971 1972
extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
				   struct file *file_out, loff_t pos_out,
1973
				   loff_t len, unsigned int remap_flags);
1974 1975
extern int vfs_dedupe_file_range(struct file *file,
				 struct file_dedupe_range *same);
1976 1977
extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
					struct file *dst_file, loff_t dst_pos,
1978
					loff_t len, unsigned int remap_flags);
1979

L
Linus Torvalds 已提交
1980 1981 1982 1983

struct super_operations {
   	struct inode *(*alloc_inode)(struct super_block *sb);
	void (*destroy_inode)(struct inode *);
A
Al Viro 已提交
1984
	void (*free_inode)(struct inode *);
L
Linus Torvalds 已提交
1985

1986
   	void (*dirty_inode) (struct inode *, int flags);
1987
	int (*write_inode) (struct inode *, struct writeback_control *wbc);
1988
	int (*drop_inode) (struct inode *);
A
Al Viro 已提交
1989
	void (*evict_inode) (struct inode *);
L
Linus Torvalds 已提交
1990 1991
	void (*put_super) (struct super_block *);
	int (*sync_fs)(struct super_block *sb, int wait);
1992
	int (*freeze_super) (struct super_block *);
1993
	int (*freeze_fs) (struct super_block *);
1994
	int (*thaw_super) (struct super_block *);
1995
	int (*unfreeze_fs) (struct super_block *);
1996
	int (*statfs) (struct dentry *, struct kstatfs *);
L
Linus Torvalds 已提交
1997
	int (*remount_fs) (struct super_block *, int *, char *);
1998
	void (*umount_begin) (struct super_block *);
L
Linus Torvalds 已提交
1999

2000
	int (*show_options)(struct seq_file *, struct dentry *);
2001
	int (*show_devname)(struct seq_file *, struct dentry *);
2002
	int (*show_path)(struct seq_file *, struct dentry *);
2003
	int (*show_stats)(struct seq_file *, struct dentry *);
2004
#ifdef CONFIG_QUOTA
L
Linus Torvalds 已提交
2005 2006
	ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
	ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
2007
	struct dquot **(*get_dquots)(struct inode *);
2008
#endif
2009
	int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
2010 2011 2012 2013
	long (*nr_cached_objects)(struct super_block *,
				  struct shrink_control *);
	long (*free_cached_objects)(struct super_block *,
				    struct shrink_control *);
L
Linus Torvalds 已提交
2014 2015
};

D
David Howells 已提交
2016 2017 2018
/*
 * Inode flags - they have no relation to superblock flags now
 */
2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031
#define S_SYNC		(1 << 0)  /* Writes are synced at once */
#define S_NOATIME	(1 << 1)  /* Do not update access times */
#define S_APPEND	(1 << 2)  /* Append-only file */
#define S_IMMUTABLE	(1 << 3)  /* Immutable file */
#define S_DEAD		(1 << 4)  /* removed, but still open directory */
#define S_NOQUOTA	(1 << 5)  /* Inode is not counted to quota */
#define S_DIRSYNC	(1 << 6)  /* Directory modifications are synchronous */
#define S_NOCMTIME	(1 << 7)  /* Do not update file c/mtime */
#define S_SWAPFILE	(1 << 8)  /* Do not truncate: swapon got its bmaps */
#define S_PRIVATE	(1 << 9)  /* Inode is fs-internal */
#define S_IMA		(1 << 10) /* Inode has an associated IMA struct */
#define S_AUTOMOUNT	(1 << 11) /* Automount/referral quasi-directory */
#define S_NOSEC		(1 << 12) /* no suid or xattr security attributes */
2032
#ifdef CONFIG_FS_DAX
2033
#define S_DAX		(1 << 13) /* Direct Access, avoiding the page cache */
2034
#else
2035
#define S_DAX		0	  /* Make all the DAX code disappear */
2036
#endif
2037 2038 2039
#define S_ENCRYPTED	(1 << 14) /* Encrypted file (using fs/crypto/) */
#define S_CASEFOLD	(1 << 15) /* Casefolded file */
#define S_VERITY	(1 << 16) /* Verity file (using fs/verity/) */
D
David Howells 已提交
2040 2041 2042 2043 2044 2045 2046

/*
 * Note that nosuid etc flags are inode-specific: setting some file-system
 * flags just means all the inodes inherit those flags by default. It might be
 * possible to override it selectively if you really wanted to with some
 * ioctl() that is not currently implemented.
 *
2047
 * Exception: SB_RDONLY is always applied to the entire file system.
D
David Howells 已提交
2048 2049 2050 2051 2052 2053 2054 2055
 *
 * Unfortunately, it is possible to change a filesystems flags with it mounted
 * with files in use.  This means that all of the inodes will not have their
 * i_flags updated.  Hence, i_flags no longer inherit the superblock mount
 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
 */
#define __IS_FLG(inode, flg)	((inode)->i_sb->s_flags & (flg))

2056
static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
2057
#define IS_RDONLY(inode)	sb_rdonly((inode)->i_sb)
2058
#define IS_SYNC(inode)		(__IS_FLG(inode, SB_SYNCHRONOUS) || \
D
David Howells 已提交
2059
					((inode)->i_flags & S_SYNC))
2060
#define IS_DIRSYNC(inode)	(__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
D
David Howells 已提交
2061
					((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
2062 2063 2064
#define IS_MANDLOCK(inode)	__IS_FLG(inode, SB_MANDLOCK)
#define IS_NOATIME(inode)	__IS_FLG(inode, SB_RDONLY|SB_NOATIME)
#define IS_I_VERSION(inode)	__IS_FLG(inode, SB_I_VERSION)
D
David Howells 已提交
2065 2066 2067 2068

#define IS_NOQUOTA(inode)	((inode)->i_flags & S_NOQUOTA)
#define IS_APPEND(inode)	((inode)->i_flags & S_APPEND)
#define IS_IMMUTABLE(inode)	((inode)->i_flags & S_IMMUTABLE)
2069
#define IS_POSIXACL(inode)	__IS_FLG(inode, SB_POSIXACL)
D
David Howells 已提交
2070 2071 2072 2073 2074 2075 2076 2077

#define IS_DEADDIR(inode)	((inode)->i_flags & S_DEAD)
#define IS_NOCMTIME(inode)	((inode)->i_flags & S_NOCMTIME)
#define IS_SWAPFILE(inode)	((inode)->i_flags & S_SWAPFILE)
#define IS_PRIVATE(inode)	((inode)->i_flags & S_PRIVATE)
#define IS_IMA(inode)		((inode)->i_flags & S_IMA)
#define IS_AUTOMOUNT(inode)	((inode)->i_flags & S_AUTOMOUNT)
#define IS_NOSEC(inode)		((inode)->i_flags & S_NOSEC)
2078
#define IS_DAX(inode)		((inode)->i_flags & S_DAX)
2079
#define IS_ENCRYPTED(inode)	((inode)->i_flags & S_ENCRYPTED)
2080
#define IS_CASEFOLDED(inode)	((inode)->i_flags & S_CASEFOLD)
2081
#define IS_VERITY(inode)	((inode)->i_flags & S_VERITY)
D
David Howells 已提交
2082

M
Miklos Szeredi 已提交
2083 2084 2085
#define IS_WHITEOUT(inode)	(S_ISCHR(inode->i_mode) && \
				 (inode)->i_rdev == WHITEOUT_DEV)

2086 2087
static inline bool HAS_UNMAPPED_ID(struct user_namespace *mnt_userns,
				   struct inode *inode)
2088
{
2089 2090
	return !uid_valid(i_uid_into_mnt(mnt_userns, inode)) ||
	       !gid_valid(i_gid_into_mnt(mnt_userns, inode));
2091 2092
}

2093 2094 2095 2096 2097 2098 2099 2100 2101 2102
static inline enum rw_hint file_write_hint(struct file *file)
{
	if (file->f_write_hint != WRITE_LIFE_NOT_SET)
		return file->f_write_hint;

	return file_inode(file)->i_write_hint;
}

static inline int iocb_flags(struct file *file);

2103 2104 2105 2106 2107 2108 2109 2110 2111
static inline u16 ki_hint_validate(enum rw_hint hint)
{
	typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;

	if (hint <= max_hint)
		return hint;
	return 0;
}

2112 2113 2114 2115 2116
static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
{
	*kiocb = (struct kiocb) {
		.ki_filp = filp,
		.ki_flags = iocb_flags(filp),
2117
		.ki_hint = ki_hint_validate(file_write_hint(filp)),
2118
		.ki_ioprio = get_current_ioprio(),
2119 2120 2121
	};
}

2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133
static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
			       struct file *filp)
{
	*kiocb = (struct kiocb) {
		.ki_filp = filp,
		.ki_flags = kiocb_src->ki_flags,
		.ki_hint = kiocb_src->ki_hint,
		.ki_ioprio = kiocb_src->ki_ioprio,
		.ki_pos = kiocb_src->ki_pos,
	};
}

J
Joern Engel 已提交
2134
/*
2135
 * Inode state bits.  Protected by inode->i_lock
J
Joern Engel 已提交
2136 2137 2138 2139 2140 2141 2142 2143
 *
 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
 *
 * Four bits define the lifetime of an inode.  Initially, inodes are I_NEW,
 * until that flag is cleared.  I_WILL_FREE, I_FREEING and I_CLEAR are set at
 * various stages of removing an inode.
 *
C
Christoph Hellwig 已提交
2144
 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
J
Joern Engel 已提交
2145
 *
J
Joern Engel 已提交
2146 2147
 * I_DIRTY_SYNC		Inode is dirty, but doesn't have to be written on
 *			fdatasync().  i_atime is the usual cause.
2148 2149 2150 2151
 * I_DIRTY_DATASYNC	Data-related inode changes pending. We keep track of
 *			these changes separately from I_DIRTY_SYNC so that we
 *			don't have to write inode on fdatasync() when only
 *			mtime has changed in it.
J
Joern Engel 已提交
2152
 * I_DIRTY_PAGES	Inode has dirty pages.  Inode itself may be clean.
C
Christoph Hellwig 已提交
2153 2154 2155 2156 2157 2158 2159 2160
 * I_NEW		Serves as both a mutex and completion notification.
 *			New inodes set I_NEW.  If two processes both create
 *			the same inode, one of them will release its inode and
 *			wait for I_NEW to be released before returning.
 *			Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
 *			also cause waiting on I_NEW, without I_NEW actually
 *			being set.  find_inode() uses this to prevent returning
 *			nearly-dead inodes.
J
Joern Engel 已提交
2161 2162 2163 2164 2165 2166
 * I_WILL_FREE		Must be set when calling write_inode_now() if i_count
 *			is zero.  I_FREEING must be set when I_WILL_FREE is
 *			cleared.
 * I_FREEING		Set when inode is about to be freed but still has dirty
 *			pages or buffers attached or the inode itself is still
 *			dirty.
2167 2168
 * I_CLEAR		Added by clear_inode().  In this state the inode is
 *			clean and can be destroyed.  Inode keeps I_FREEING.
J
Joern Engel 已提交
2169 2170 2171 2172 2173
 *
 *			Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
 *			prohibited for many purposes.  iget() must wait for
 *			the inode to be completely released, then create it
 *			anew.  Other functions will just ignore such inodes,
C
Christoph Hellwig 已提交
2174
 *			if appropriate.  I_NEW is used for waiting.
J
Joern Engel 已提交
2175
 *
2176 2177 2178 2179
 * I_SYNC		Writeback of inode is running. The bit is set during
 *			data writeback, and cleared with a wakeup on the bit
 *			address once it is done. The bit is also used to pin
 *			the inode in memory for flusher thread.
J
Joern Engel 已提交
2180
 *
C
Christoph Hellwig 已提交
2181 2182 2183 2184
 * I_REFERENCED		Marks the inode as recently references on the LRU list.
 *
 * I_DIO_WAKEUP		Never set.  Only used as a key for wait_on_bit().
 *
2185 2186
 * I_WB_SWITCH		Cgroup bdi_writeback switching in progress.  Used to
 *			synchronize competing switching instances and to tell
M
Matthew Wilcox 已提交
2187
 *			wb stat updates to grab the i_pages lock.  See
2188
 *			inode_switch_wbs_work_fn() for details.
2189
 *
2190 2191 2192
 * I_OVL_INUSE		Used by overlayfs to get exclusive ownership on upper
 *			and work dirs among overlayfs mounts.
 *
A
Al Viro 已提交
2193 2194
 * I_CREATING		New object's inode in the middle of setting up.
 *
2195 2196
 * I_DONTCACHE		Evict inode as soon as it is not used anymore.
 *
2197 2198 2199 2200
 * I_SYNC_QUEUED	Inode is queued in b_io or b_more_io writeback lists.
 *			Used to detect that mark_inode_dirty() should not move
 * 			inode between dirty lists.
 *
J
Joern Engel 已提交
2201 2202
 * Q: What is the difference between I_WILL_FREE and I_FREEING?
 */
2203 2204 2205
#define I_DIRTY_SYNC		(1 << 0)
#define I_DIRTY_DATASYNC	(1 << 1)
#define I_DIRTY_PAGES		(1 << 2)
C
Christoph Hellwig 已提交
2206 2207
#define __I_NEW			3
#define I_NEW			(1 << __I_NEW)
2208 2209 2210
#define I_WILL_FREE		(1 << 4)
#define I_FREEING		(1 << 5)
#define I_CLEAR			(1 << 6)
C
Christoph Hellwig 已提交
2211
#define __I_SYNC		7
J
Joern Engel 已提交
2212
#define I_SYNC			(1 << __I_SYNC)
2213
#define I_REFERENCED		(1 << 8)
C
Christoph Hellwig 已提交
2214
#define __I_DIO_WAKEUP		9
E
Eric Sandeen 已提交
2215
#define I_DIO_WAKEUP		(1 << __I_DIO_WAKEUP)
2216
#define I_LINKABLE		(1 << 10)
2217
#define I_DIRTY_TIME		(1 << 11)
2218
#define I_WB_SWITCH		(1 << 13)
A
Al Viro 已提交
2219 2220
#define I_OVL_INUSE		(1 << 14)
#define I_CREATING		(1 << 15)
2221
#define I_DONTCACHE		(1 << 16)
2222
#define I_SYNC_QUEUED		(1 << 17)
L
Linus Torvalds 已提交
2223

2224 2225
#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2226
#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
L
Linus Torvalds 已提交
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238

extern void __mark_inode_dirty(struct inode *, int);
static inline void mark_inode_dirty(struct inode *inode)
{
	__mark_inode_dirty(inode, I_DIRTY);
}

static inline void mark_inode_dirty_sync(struct inode *inode)
{
	__mark_inode_dirty(inode, I_DIRTY_SYNC);
}

M
Miklos Szeredi 已提交
2239 2240 2241 2242
extern void inc_nlink(struct inode *inode);
extern void drop_nlink(struct inode *inode);
extern void clear_nlink(struct inode *inode);
extern void set_nlink(struct inode *inode, unsigned int nlink);
2243 2244 2245 2246

static inline void inode_inc_link_count(struct inode *inode)
{
	inc_nlink(inode);
2247 2248 2249
	mark_inode_dirty(inode);
}

2250 2251 2252
static inline void inode_dec_link_count(struct inode *inode)
{
	drop_nlink(inode);
2253 2254 2255
	mark_inode_dirty(inode);
}

2256 2257 2258 2259 2260 2261 2262
enum file_time_flags {
	S_ATIME = 1,
	S_MTIME = 2,
	S_CTIME = 4,
	S_VERSION = 8,
};

2263
extern bool atime_needs_update(const struct path *, struct inode *);
A
Al Viro 已提交
2264
extern void touch_atime(const struct path *);
L
Linus Torvalds 已提交
2265 2266 2267
static inline void file_accessed(struct file *file)
{
	if (!(file->f_flags & O_NOATIME))
A
Al Viro 已提交
2268
		touch_atime(&file->f_path);
L
Linus Torvalds 已提交
2269 2270
}

2271 2272
extern int file_modified(struct file *file);

L
Linus Torvalds 已提交
2273
int sync_inode(struct inode *inode, struct writeback_control *wbc);
C
Christoph Hellwig 已提交
2274
int sync_inode_metadata(struct inode *inode, int wait);
L
Linus Torvalds 已提交
2275 2276 2277 2278

struct file_system_type {
	const char *name;
	int fs_flags;
D
David Howells 已提交
2279 2280 2281
#define FS_REQUIRES_DEV		1 
#define FS_BINARY_MOUNTDATA	2
#define FS_HAS_SUBTYPE		4
2282
#define FS_USERNS_MOUNT		8	/* Can be mounted by userns root */
2283
#define FS_DISALLOW_NOTIFY_PERM	16	/* Disable fanotify permission events */
2284
#define FS_ALLOW_IDMAP         32      /* FS has been updated to handle vfs idmappings. */
2285
#define FS_THP_SUPPORT		8192	/* Remove once all fs converted */
D
David Howells 已提交
2286
#define FS_RENAME_DOES_D_MOVE	32768	/* FS will handle d_move() during rename() internally. */
A
Al Viro 已提交
2287
	int (*init_fs_context)(struct fs_context *);
2288
	const struct fs_parameter_spec *parameters;
A
Al Viro 已提交
2289 2290
	struct dentry *(*mount) (struct file_system_type *, int,
		       const char *, void *);
L
Linus Torvalds 已提交
2291 2292 2293
	void (*kill_sb) (struct super_block *);
	struct module *owner;
	struct file_system_type * next;
A
Al Viro 已提交
2294
	struct hlist_head fs_supers;
2295

I
Ingo Molnar 已提交
2296
	struct lock_class_key s_lock_key;
2297
	struct lock_class_key s_umount_key;
2298
	struct lock_class_key s_vfs_rename_key;
2299
	struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2300 2301 2302

	struct lock_class_key i_lock_key;
	struct lock_class_key i_mutex_key;
2303
	struct lock_class_key i_mutex_dir_key;
L
Linus Torvalds 已提交
2304 2305
};

2306 2307
#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)

A
Al Viro 已提交
2308 2309 2310
extern struct dentry *mount_bdev(struct file_system_type *fs_type,
	int flags, const char *dev_name, void *data,
	int (*fill_super)(struct super_block *, void *, int));
A
Al Viro 已提交
2311 2312 2313
extern struct dentry *mount_single(struct file_system_type *fs_type,
	int flags, void *data,
	int (*fill_super)(struct super_block *, void *, int));
A
Al Viro 已提交
2314 2315 2316
extern struct dentry *mount_nodev(struct file_system_type *fs_type,
	int flags, void *data,
	int (*fill_super)(struct super_block *, void *, int));
A
Al Viro 已提交
2317
extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
L
Linus Torvalds 已提交
2318 2319 2320 2321 2322
void generic_shutdown_super(struct super_block *sb);
void kill_block_super(struct super_block *sb);
void kill_anon_super(struct super_block *sb);
void kill_litter_super(struct super_block *sb);
void deactivate_super(struct super_block *sb);
A
Al Viro 已提交
2323
void deactivate_locked_super(struct super_block *sb);
L
Linus Torvalds 已提交
2324
int set_anon_super(struct super_block *s, void *data);
2325
int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2326 2327
int get_anon_bdev(dev_t *);
void free_anon_bdev(dev_t);
2328 2329 2330
struct super_block *sget_fc(struct fs_context *fc,
			    int (*test)(struct super_block *, struct fs_context *),
			    int (*set)(struct super_block *, struct fs_context *));
L
Linus Torvalds 已提交
2331 2332 2333
struct super_block *sget(struct file_system_type *type,
			int (*test)(struct super_block *,void *),
			int (*set)(struct super_block *,void *),
D
David Howells 已提交
2334
			int flags, void *data);
L
Linus Torvalds 已提交
2335 2336 2337 2338 2339 2340

/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
#define fops_get(fops) \
	(((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
#define fops_put(fops) \
	do { if (fops) module_put((fops)->owner); } while(0)
2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
/*
 * This one is to be used *ONLY* from ->open() instances.
 * fops must be non-NULL, pinned down *and* module dependencies
 * should be sufficient to pin the caller down as well.
 */
#define replace_fops(f, fops) \
	do {	\
		struct file *__file = (f); \
		fops_put(__file->f_op); \
		BUG_ON(!(__file->f_op = (fops))); \
	} while(0)
L
Linus Torvalds 已提交
2352 2353 2354

extern int register_filesystem(struct file_system_type *);
extern int unregister_filesystem(struct file_system_type *);
D
David Howells 已提交
2355
extern struct vfsmount *kern_mount(struct file_system_type *);
2356
extern void kern_unmount(struct vfsmount *mnt);
L
Linus Torvalds 已提交
2357 2358
extern int may_umount_tree(struct vfsmount *);
extern int may_umount(struct vfsmount *);
2359 2360
extern long do_mount(const char *, const char __user *,
		     const char *, unsigned long, void *);
2361
extern struct vfsmount *collect_mounts(const struct path *);
2362
extern void drop_collected_mounts(struct vfsmount *);
A
Al Viro 已提交
2363 2364
extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
			  struct vfsmount *);
A
Al Viro 已提交
2365
extern int vfs_statfs(const struct path *, struct kstatfs *);
A
Al Viro 已提交
2366 2367
extern int user_statfs(const char __user *, struct kstatfs *);
extern int fd_statfs(int, struct kstatfs *);
2368 2369
extern int freeze_super(struct super_block *super);
extern int thaw_super(struct super_block *super);
2370
extern bool our_mnt(struct vfsmount *mnt);
2371 2372 2373
extern __printf(2, 3)
int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
extern int super_setup_bdi(struct super_block *sb);
L
Linus Torvalds 已提交
2374

A
Al Viro 已提交
2375 2376
extern int current_umask(void);

2377 2378
extern void ihold(struct inode * inode);
extern void iput(struct inode *);
2379
extern int generic_update_time(struct inode *, struct timespec64 *, int);
2380

M
Miklos Szeredi 已提交
2381
/* /sys/fs */
2382
extern struct kobject *fs_kobj;
M
Miklos Szeredi 已提交
2383

2384
#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2385

2386
#ifdef CONFIG_MANDATORY_FILE_LOCKING
2387
extern int locks_mandatory_locked(struct file *);
2388
extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
L
Linus Torvalds 已提交
2389 2390 2391 2392 2393

/*
 * Candidates for mandatory locking have the setgid bit set
 * but no group execute bit -  an otherwise meaningless combination.
 */
2394 2395 2396 2397 2398 2399 2400

static inline int __mandatory_lock(struct inode *ino)
{
	return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
}

/*
2401
 * ... and these candidates should be on SB_MANDLOCK mounted fs,
2402 2403 2404 2405 2406 2407 2408
 * otherwise these will be advisory locks
 */

static inline int mandatory_lock(struct inode *ino)
{
	return IS_MANDLOCK(ino) && __mandatory_lock(ino);
}
L
Linus Torvalds 已提交
2409

2410
static inline int locks_verify_locked(struct file *file)
L
Linus Torvalds 已提交
2411
{
2412
	if (mandatory_lock(locks_inode(file)))
2413
		return locks_mandatory_locked(file);
L
Linus Torvalds 已提交
2414 2415 2416 2417
	return 0;
}

static inline int locks_verify_truncate(struct inode *inode,
2418
				    struct file *f,
L
Linus Torvalds 已提交
2419 2420
				    loff_t size)
{
2421 2422 2423 2424 2425 2426 2427 2428 2429 2430
	if (!inode->i_flctx || !mandatory_lock(inode))
		return 0;

	if (size < inode->i_size) {
		return locks_mandatory_area(inode, f, size, inode->i_size - 1,
				F_WRLCK);
	} else {
		return locks_mandatory_area(inode, f, inode->i_size, size - 1,
				F_WRLCK);
	}
L
Linus Torvalds 已提交
2431 2432
}

2433 2434 2435 2436 2437 2438 2439
#else /* !CONFIG_MANDATORY_FILE_LOCKING */

static inline int locks_mandatory_locked(struct file *file)
{
	return 0;
}

2440 2441
static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
                                       loff_t start, loff_t end, unsigned char type)
2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470
{
	return 0;
}

static inline int __mandatory_lock(struct inode *inode)
{
	return 0;
}

static inline int mandatory_lock(struct inode *inode)
{
	return 0;
}

static inline int locks_verify_locked(struct file *file)
{
	return 0;
}

static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
					size_t size)
{
	return 0;
}

#endif /* CONFIG_MANDATORY_FILE_LOCKING */


#ifdef CONFIG_FILE_LOCKING
L
Linus Torvalds 已提交
2471 2472
static inline int break_lease(struct inode *inode, unsigned int mode)
{
2473 2474
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2475 2476 2477
	 * taken are done before checking i_flctx->flc_lease. Otherwise, we
	 * could end up racing with tasks trying to set a new lease on this
	 * file.
2478 2479
	 */
	smp_mb();
2480
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2481
		return __break_lease(inode, mode, FL_LEASE);
L
Linus Torvalds 已提交
2482 2483
	return 0;
}
J
J. Bruce Fields 已提交
2484 2485 2486

static inline int break_deleg(struct inode *inode, unsigned int mode)
{
2487 2488
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2489 2490 2491
	 * taken are done before checking i_flctx->flc_lease. Otherwise, we
	 * could end up racing with tasks trying to set a new lease on this
	 * file.
2492 2493
	 */
	smp_mb();
2494
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2495
		return __break_lease(inode, mode, FL_DELEG);
L
Linus Torvalds 已提交
2496 2497
	return 0;
}
J
J. Bruce Fields 已提交
2498

2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520
static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
{
	int ret;

	ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
	if (ret == -EWOULDBLOCK && delegated_inode) {
		*delegated_inode = inode;
		ihold(inode);
	}
	return ret;
}

static inline int break_deleg_wait(struct inode **delegated_inode)
{
	int ret;

	ret = break_deleg(*delegated_inode, O_WRONLY);
	iput(*delegated_inode);
	*delegated_inode = NULL;
	return ret;
}

C
Christoph Hellwig 已提交
2521 2522 2523 2524 2525 2526 2527 2528 2529 2530
static inline int break_layout(struct inode *inode, bool wait)
{
	smp_mb();
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
		return __break_lease(inode,
				wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
				FL_LAYOUT);
	return 0;
}

2531
#else /* !CONFIG_FILE_LOCKING */
2532 2533 2534 2535 2536
static inline int break_lease(struct inode *inode, unsigned int mode)
{
	return 0;
}

J
J. Bruce Fields 已提交
2537 2538 2539 2540
static inline int break_deleg(struct inode *inode, unsigned int mode)
{
	return 0;
}
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552

static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
{
	return 0;
}

static inline int break_deleg_wait(struct inode **delegated_inode)
{
	BUG();
	return 0;
}

C
Christoph Hellwig 已提交
2553 2554 2555 2556 2557
static inline int break_layout(struct inode *inode, bool wait)
{
	return 0;
}

2558
#endif /* CONFIG_FILE_LOCKING */
L
Linus Torvalds 已提交
2559 2560

/* fs/open.c */
2561
struct audit_names;
2562
struct filename {
2563 2564
	const char		*name;	/* pointer to actual string */
	const __user char	*uptr;	/* original userland pointer */
2565
	int			refcnt;
2566
	struct audit_names	*aname;
A
Al Viro 已提交
2567
	const char		iname[];
2568
};
2569
static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
L
Linus Torvalds 已提交
2570

2571 2572 2573 2574
static inline struct user_namespace *file_mnt_user_ns(struct file *file)
{
	return mnt_user_ns(file->f_path.mnt);
}
A
Al Viro 已提交
2575
extern long vfs_truncate(const struct path *, loff_t);
2576 2577
extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
		       struct file *filp);
2578
extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2579
			loff_t len);
J
Jason Uhlenkott 已提交
2580
extern long do_sys_open(int dfd, const char __user *filename, int flags,
2581
			umode_t mode);
2582
extern struct file *file_open_name(struct filename *, int, umode_t);
2583
extern struct file *filp_open(const char *, int, umode_t);
A
Al Viro 已提交
2584
extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2585
				   const char *, int, umode_t);
2586
extern struct file * dentry_open(const struct path *, int, const struct cred *);
A
Al Viro 已提交
2587 2588
extern struct file * open_with_fake_path(const struct path *, int,
					 struct inode*, const struct cred *);
2589 2590 2591 2592
static inline struct file *file_clone_open(struct file *file)
{
	return dentry_open(&file->f_path, file->f_flags, file->f_cred);
}
L
Linus Torvalds 已提交
2593
extern int filp_close(struct file *, fl_owner_t id);
2594

2595
extern struct filename *getname_flags(const char __user *, int, int *);
2596
extern struct filename *getname(const char __user *);
2597
extern struct filename *getname_kernel(const char *);
2598
extern void putname(struct filename *name);
2599

A
Al Viro 已提交
2600
extern int finish_open(struct file *file, struct dentry *dentry,
2601
			int (*open)(struct inode *, struct file *));
A
Al Viro 已提交
2602
extern int finish_no_open(struct file *file, struct dentry *dentry);
L
Linus Torvalds 已提交
2603 2604 2605

/* fs/dcache.c */
extern void __init vfs_caches_init_early(void);
2606
extern void __init vfs_caches_init(void);
L
Linus Torvalds 已提交
2607

2608 2609
extern struct kmem_cache *names_cachep;

2610
#define __getname()		kmem_cache_alloc(names_cachep, GFP_KERNEL)
V
Vegard Nossum 已提交
2611
#define __putname(name)		kmem_cache_free(names_cachep, (void *)(name))
L
Linus Torvalds 已提交
2612

T
Tejun Heo 已提交
2613 2614 2615
extern struct super_block *blockdev_superblock;
static inline bool sb_is_blkdev_sb(struct super_block *sb)
{
2616
	return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
2617
}
2618

2619
void emergency_thaw_all(void);
2620
extern int sync_filesystem(struct super_block *);
2621
extern const struct file_operations def_blk_fops;
2622
extern const struct file_operations def_chr_fops;
L
Linus Torvalds 已提交
2623 2624

/* fs/char_dev.c */
2625
#define CHRDEV_MAJOR_MAX 512
2626 2627
/* Marks the bottom of the first segment of free char majors */
#define CHRDEV_MAJOR_DYN_END 234
2628 2629 2630 2631
/* Marks the top and bottom of the second segment of free char majors */
#define CHRDEV_MAJOR_DYN_EXT_START 511
#define CHRDEV_MAJOR_DYN_EXT_END 384

L
Linus Torvalds 已提交
2632 2633
extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
extern int register_chrdev_region(dev_t, unsigned, const char *);
2634 2635 2636 2637 2638
extern int __register_chrdev(unsigned int major, unsigned int baseminor,
			     unsigned int count, const char *name,
			     const struct file_operations *fops);
extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
				unsigned int count, const char *name);
L
Linus Torvalds 已提交
2639
extern void unregister_chrdev_region(dev_t, unsigned);
2640
extern void chrdev_show(struct seq_file *,off_t);
L
Linus Torvalds 已提交
2641

2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652
static inline int register_chrdev(unsigned int major, const char *name,
				  const struct file_operations *fops)
{
	return __register_chrdev(major, 0, 256, name, fops);
}

static inline void unregister_chrdev(unsigned int major, const char *name)
{
	__unregister_chrdev(major, 0, 256, name);
}

L
Linus Torvalds 已提交
2653 2654 2655 2656
extern void init_special_inode(struct inode *, umode_t, dev_t);

/* Invalid inode operations -- fs/bad_inode.c */
extern void make_bad_inode(struct inode *);
2657
extern bool is_bad_inode(struct inode *);
L
Linus Torvalds 已提交
2658 2659 2660

unsigned long invalidate_mapping_pages(struct address_space *mapping,
					pgoff_t start, pgoff_t end);
2661

2662 2663 2664 2665
void invalidate_mapping_pagevec(struct address_space *mapping,
				pgoff_t start, pgoff_t end,
				unsigned long *nr_pagevec);

L
Linus Torvalds 已提交
2666 2667 2668 2669
static inline void invalidate_remote_inode(struct inode *inode)
{
	if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
	    S_ISLNK(inode->i_mode))
2670
		invalidate_mapping_pages(inode->i_mapping, 0, -1);
L
Linus Torvalds 已提交
2671 2672 2673 2674 2675 2676 2677
}
extern int invalidate_inode_pages2(struct address_space *mapping);
extern int invalidate_inode_pages2_range(struct address_space *mapping,
					 pgoff_t start, pgoff_t end);
extern int write_inode_now(struct inode *, int);
extern int filemap_fdatawrite(struct address_space *);
extern int filemap_flush(struct address_space *);
2678
extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2679 2680
extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
				   loff_t lend);
2681 2682
extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
		loff_t start_byte, loff_t end_byte);
2683 2684 2685 2686 2687 2688

static inline int filemap_fdatawait(struct address_space *mapping)
{
	return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
}

2689 2690
extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
				  loff_t lend);
L
Linus Torvalds 已提交
2691 2692
extern int filemap_write_and_wait_range(struct address_space *mapping,
				        loff_t lstart, loff_t lend);
2693 2694
extern int __filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end, int sync_mode);
2695 2696
extern int filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end);
2697
extern int filemap_check_errors(struct address_space *mapping);
2698
extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2699

2700 2701 2702 2703 2704
static inline int filemap_write_and_wait(struct address_space *mapping)
{
	return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
}

2705 2706
extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
						loff_t lend);
2707 2708 2709 2710
extern int __must_check file_check_and_advance_wb_err(struct file *file);
extern int __must_check file_write_and_wait_range(struct file *file,
						loff_t start, loff_t end);

2711 2712 2713 2714 2715
static inline int file_write_and_wait(struct file *file)
{
	return file_write_and_wait_range(file, 0, LLONG_MAX);
}

2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737
/**
 * filemap_set_wb_err - set a writeback error on an address_space
 * @mapping: mapping in which to set writeback error
 * @err: error to be set in mapping
 *
 * When writeback fails in some way, we must record that error so that
 * userspace can be informed when fsync and the like are called.  We endeavor
 * to report errors on any file that was open at the time of the error.  Some
 * internal callers also need to know when writeback errors have occurred.
 *
 * When a writeback error occurs, most filesystems will want to call
 * filemap_set_wb_err to record the error in the mapping so that it will be
 * automatically reported whenever fsync is called on the file.
 */
static inline void filemap_set_wb_err(struct address_space *mapping, int err)
{
	/* Fastpath for common case of no error */
	if (unlikely(err))
		__filemap_set_wb_err(mapping, err);
}

/**
A
Andreas Gruenbacher 已提交
2738
 * filemap_check_wb_err - has an error occurred since the mark was sampled?
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764
 * @mapping: mapping to check for writeback errors
 * @since: previously-sampled errseq_t
 *
 * Grab the errseq_t value from the mapping, and see if it has changed "since"
 * the given value was sampled.
 *
 * If it has then report the latest error set, otherwise return 0.
 */
static inline int filemap_check_wb_err(struct address_space *mapping,
					errseq_t since)
{
	return errseq_check(&mapping->wb_err, since);
}

/**
 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
 * @mapping: mapping to be sampled
 *
 * Writeback errors are always reported relative to a particular sample point
 * in the past. This function provides those sample points.
 */
static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
{
	return errseq_sample(&mapping->wb_err);
}

2765 2766
/**
 * file_sample_sb_err - sample the current errseq_t to test for later errors
2767
 * @file: file pointer to be sampled
2768 2769 2770 2771 2772 2773 2774 2775 2776
 *
 * Grab the most current superblock-level errseq_t value for the given
 * struct file.
 */
static inline errseq_t file_sample_sb_err(struct file *file)
{
	return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
}

2777 2778 2779
extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
			   int datasync);
extern int vfs_fsync(struct file *file, int datasync);
2780

J
Jens Axboe 已提交
2781 2782 2783
extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
				unsigned int flags);

2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799
/*
 * Sync the bytes written if this was a synchronous write.  Expect ki_pos
 * to already be updated for the write, and will return either the amount
 * of bytes passed in, or an error if syncing the file failed.
 */
static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
{
	if (iocb->ki_flags & IOCB_DSYNC) {
		int ret = vfs_fsync_range(iocb->ki_filp,
				iocb->ki_pos - count, iocb->ki_pos - 1,
				(iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
		if (ret)
			return ret;
	}

	return count;
2800
}
2801

L
Linus Torvalds 已提交
2802 2803
extern void emergency_sync(void);
extern void emergency_remount(void);
2804

2805
#ifdef CONFIG_BLOCK
2806 2807 2808 2809 2810 2811
extern int bmap(struct inode *inode, sector_t *block);
#else
static inline int bmap(struct inode *inode,  sector_t *block)
{
	return -EINVAL;
}
2812
#endif
2813

C
Christian Brauner 已提交
2814 2815
int notify_change(struct user_namespace *, struct dentry *,
		  struct iattr *, struct inode **);
2816 2817
int inode_permission(struct user_namespace *, struct inode *, int);
int generic_permission(struct user_namespace *, struct inode *, int);
2818 2819
static inline int file_permission(struct file *file, int mask)
{
2820 2821
	return inode_permission(file_mnt_user_ns(file),
				file_inode(file), mask);
2822 2823 2824
}
static inline int path_permission(const struct path *path, int mask)
{
2825 2826
	return inode_permission(mnt_user_ns(path->mnt),
				d_inode(path->dentry), mask);
2827
}
2828 2829
int __check_sticky(struct user_namespace *mnt_userns, struct inode *dir,
		   struct inode *inode);
L
Linus Torvalds 已提交
2830

2831 2832 2833 2834 2835
static inline bool execute_ok(struct inode *inode)
{
	return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
}

2836 2837 2838 2839
static inline void file_start_write(struct file *file)
{
	if (!S_ISREG(file_inode(file)->i_mode))
		return;
2840
	sb_start_write(file_inode(file)->i_sb);
2841 2842
}

2843 2844 2845 2846
static inline bool file_start_write_trylock(struct file *file)
{
	if (!S_ISREG(file_inode(file)->i_mode))
		return true;
2847
	return sb_start_write_trylock(file_inode(file)->i_sb);
2848 2849
}

2850 2851 2852 2853 2854 2855
static inline void file_end_write(struct file *file)
{
	if (!S_ISREG(file_inode(file)->i_mode))
		return;
	__sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
}
2856

2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878
/*
 * get_write_access() gets write permission for a file.
 * put_write_access() releases this write permission.
 * This is used for regular files.
 * We cannot support write (and maybe mmap read-write shared) accesses and
 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
 * can have the following values:
 * 0: no writers, no VM_DENYWRITE mappings
 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
 * > 0: (i_writecount) users are writing to the file.
 *
 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
 * except for the cases where we don't hold i_writecount yet. Then we need to
 * use {get,deny}_write_access() - these functions check the sign and refuse
 * to do the change if sign is wrong.
 */
static inline int get_write_access(struct inode *inode)
{
	return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
}
static inline int deny_write_access(struct file *file)
{
A
Al Viro 已提交
2879
	struct inode *inode = file_inode(file);
2880 2881
	return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
}
L
Linus Torvalds 已提交
2882 2883 2884 2885 2886 2887 2888
static inline void put_write_access(struct inode * inode)
{
	atomic_dec(&inode->i_writecount);
}
static inline void allow_write_access(struct file *file)
{
	if (file)
A
Al Viro 已提交
2889
		atomic_inc(&file_inode(file)->i_writecount);
L
Linus Torvalds 已提交
2890
}
2891 2892 2893 2894 2895
static inline bool inode_is_open_for_write(const struct inode *inode)
{
	return atomic_read(&inode->i_writecount) > 0;
}

2896
#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
M
Mimi Zohar 已提交
2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915
static inline void i_readcount_dec(struct inode *inode)
{
	BUG_ON(!atomic_read(&inode->i_readcount));
	atomic_dec(&inode->i_readcount);
}
static inline void i_readcount_inc(struct inode *inode)
{
	atomic_inc(&inode->i_readcount);
}
#else
static inline void i_readcount_dec(struct inode *inode)
{
	return;
}
static inline void i_readcount_inc(struct inode *inode)
{
	return;
}
#endif
U
Ulrich Drepper 已提交
2916
extern int do_pipe_flags(int *, int);
L
Linus Torvalds 已提交
2917

2918
extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2919
ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
2920
extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2921
extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
L
Linus Torvalds 已提交
2922 2923 2924
extern struct file * open_exec(const char *);
 
/* fs/dcache.c -- generic fs support functions */
Y
Yaowei Bai 已提交
2925
extern bool is_subdir(struct dentry *, struct dentry *);
2926
extern bool path_is_under(const struct path *, const struct path *);
L
Linus Torvalds 已提交
2927

M
Miklos Szeredi 已提交
2928 2929
extern char *file_path(struct file *, char *, int);

L
Linus Torvalds 已提交
2930 2931 2932
#include <linux/err.h>

/* needed for stackable file system support */
2933
extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
L
Linus Torvalds 已提交
2934

2935
extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
L
Linus Torvalds 已提交
2936

2937
extern int inode_init_always(struct super_block *, struct inode *);
L
Linus Torvalds 已提交
2938
extern void inode_init_once(struct inode *);
2939
extern void address_space_init_once(struct address_space *mapping);
L
Linus Torvalds 已提交
2940 2941 2942
extern struct inode * igrab(struct inode *);
extern ino_t iunique(struct super_block *, ino_t);
extern int inode_needs_sync(struct inode *inode);
2943
extern int generic_delete_inode(struct inode *inode);
2944 2945
static inline int generic_drop_inode(struct inode *inode)
{
2946
	return !inode->i_nlink || inode_unhashed(inode);
2947
}
I
Ira Weiny 已提交
2948
extern void d_mark_dontcache(struct inode *inode);
L
Linus Torvalds 已提交
2949

2950 2951 2952
extern struct inode *ilookup5_nowait(struct super_block *sb,
		unsigned long hashval, int (*test)(struct inode *, void *),
		void *data);
L
Linus Torvalds 已提交
2953 2954 2955 2956
extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
		int (*test)(struct inode *, void *), void *data);
extern struct inode *ilookup(struct super_block *sb, unsigned long ino);

M
Miklos Szeredi 已提交
2957 2958 2959 2960
extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
		int (*test)(struct inode *, void *),
		int (*set)(struct inode *, void *),
		void *data);
L
Linus Torvalds 已提交
2961 2962
extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
extern struct inode * iget_locked(struct super_block *, unsigned long);
2963 2964 2965 2966 2967
extern struct inode *find_inode_nowait(struct super_block *,
				       unsigned long,
				       int (*match)(struct inode *,
						    unsigned long, void *),
				       void *data);
2968 2969 2970
extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
				    int (*)(struct inode *, void *), void *);
extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
A
Al Viro 已提交
2971 2972
extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
extern int insert_inode_locked(struct inode *);
2973 2974 2975 2976 2977
#ifdef CONFIG_DEBUG_LOCK_ALLOC
extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
#else
static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
#endif
L
Linus Torvalds 已提交
2978
extern void unlock_new_inode(struct inode *);
A
Al Viro 已提交
2979
extern void discard_new_inode(struct inode *);
2980
extern unsigned int get_next_ino(void);
2981
extern void evict_inodes(struct super_block *sb);
L
Linus Torvalds 已提交
2982

C
Chris Down 已提交
2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997
/*
 * Userspace may rely on the the inode number being non-zero. For example, glibc
 * simply ignores files with zero i_ino in unlink() and other places.
 *
 * As an additional complication, if userspace was compiled with
 * _FILE_OFFSET_BITS=32 on a 64-bit kernel we'll only end up reading out the
 * lower 32 bits, so we need to check that those aren't zero explicitly. With
 * _FILE_OFFSET_BITS=64, this may cause some harmless false-negatives, but
 * better safe than sorry.
 */
static inline bool is_zero_ino(ino_t ino)
{
	return (u32)ino == 0;
}

L
Linus Torvalds 已提交
2998
extern void __iget(struct inode * inode);
2999
extern void iget_failed(struct inode *);
3000
extern void clear_inode(struct inode *);
C
Christoph Hellwig 已提交
3001
extern void __destroy_inode(struct inode *);
3002 3003
extern struct inode *new_inode_pseudo(struct super_block *sb);
extern struct inode *new_inode(struct super_block *sb);
3004
extern void free_inode_nonrcu(struct inode *inode);
3005
extern int should_remove_suid(struct dentry *);
3006
extern int file_remove_privs(struct file *);
L
Linus Torvalds 已提交
3007 3008

extern void __insert_inode_hash(struct inode *, unsigned long hashval);
3009 3010
static inline void insert_inode_hash(struct inode *inode)
{
L
Linus Torvalds 已提交
3011 3012
	__insert_inode_hash(inode, inode->i_ino);
}
3013 3014 3015 3016

extern void __remove_inode_hash(struct inode *);
static inline void remove_inode_hash(struct inode *inode)
{
3017
	if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
3018 3019 3020
		__remove_inode_hash(inode);
}

3021
extern void inode_sb_list_add(struct inode *inode);
L
Linus Torvalds 已提交
3022 3023 3024 3025 3026 3027

extern int sb_set_blocksize(struct super_block *, int);
extern int sb_min_blocksize(struct super_block *, int);

extern int generic_file_mmap(struct file *, struct vm_area_struct *);
extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3028
extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
3029 3030
extern int generic_write_check_limits(struct file *file, loff_t pos,
		loff_t *count);
3031
extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
3032 3033
extern ssize_t generic_file_buffered_read(struct kiocb *iocb,
		struct iov_iter *to, ssize_t already_read);
A
Al Viro 已提交
3034
extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
3035 3036
extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
3037
extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3038
extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
A
Andrew Morton 已提交
3039

3040
ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3041
		rwf_t flags);
3042
ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3043
		rwf_t flags);
3044 3045 3046 3047
ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
			   struct iov_iter *iter);
ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
			    struct iov_iter *iter);
3048

3049
/* fs/block_dev.c */
3050
extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
3051
extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
3052 3053
extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
			int datasync);
A
Al Viro 已提交
3054
extern void block_sync_page(struct page *page);
3055

A
Andrew Morton 已提交
3056
/* fs/splice.c */
3057
extern ssize_t generic_file_splice_read(struct file *, loff_t *,
A
Andrew Morton 已提交
3058
		struct pipe_inode_info *, size_t, unsigned int);
A
Al Viro 已提交
3059
extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3060
		struct file *, loff_t *, size_t, unsigned int);
A
Andrew Morton 已提交
3061
extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
3062
		struct file *out, loff_t *, size_t len, unsigned int flags);
3063 3064 3065
extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
		loff_t *opos, size_t len, unsigned int flags);

A
Andrew Morton 已提交
3066

L
Linus Torvalds 已提交
3067 3068
extern void
file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3069 3070
extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
J
Jie Liu 已提交
3071
extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3072
extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
A
Andi Kleen 已提交
3073
extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3074
		int whence, loff_t maxsize, loff_t eof);
A
Al Viro 已提交
3075 3076
extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
		int whence, loff_t size);
3077 3078
extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
L
Linus Torvalds 已提交
3079 3080
extern int generic_file_open(struct inode * inode, struct file * filp);
extern int nonseekable_open(struct inode * inode, struct file * filp);
3081
extern int stream_open(struct inode * inode, struct file * filp);
L
Linus Torvalds 已提交
3082

3083
#ifdef CONFIG_BLOCK
3084
typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3085
			    loff_t file_offset);
L
Linus Torvalds 已提交
3086 3087

enum {
3088 3089 3090 3091 3092
	/* need locking between buffered and direct access */
	DIO_LOCKING	= 0x01,

	/* filesystem does not support filling holes */
	DIO_SKIP_HOLES	= 0x02,
L
Linus Torvalds 已提交
3093 3094
};

3095 3096
ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
			     struct block_device *bdev, struct iov_iter *iter,
3097
			     get_block_t get_block,
3098 3099
			     dio_iodone_t end_io, dio_submit_t submit_io,
			     int flags);
3100

3101 3102
static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
					 struct inode *inode,
3103
					 struct iov_iter *iter,
3104
					 get_block_t get_block)
L
Linus Torvalds 已提交
3105
{
3106
	return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3107
			get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
L
Linus Torvalds 已提交
3108
}
3109
#endif
L
Linus Torvalds 已提交
3110

3111
void inode_dio_wait(struct inode *inode);
3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136

/*
 * inode_dio_begin - signal start of a direct I/O requests
 * @inode: inode the direct I/O happens on
 *
 * This is called once we've finished processing a direct I/O request,
 * and is used to wake up callers waiting for direct I/O to be quiesced.
 */
static inline void inode_dio_begin(struct inode *inode)
{
	atomic_inc(&inode->i_dio_count);
}

/*
 * inode_dio_end - signal finish of a direct I/O requests
 * @inode: inode the direct I/O happens on
 *
 * This is called once we've finished processing a direct I/O request,
 * and is used to wake up callers waiting for direct I/O to be quiesced.
 */
static inline void inode_dio_end(struct inode *inode)
{
	if (atomic_dec_and_test(&inode->i_dio_count))
		wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
}
3137

3138 3139 3140 3141 3142
/*
 * Warn about a page cache invalidation failure diring a direct I/O write.
 */
void dio_warn_stale_pagecache(struct file *filp);

3143 3144 3145
extern void inode_set_flags(struct inode *inode, unsigned int flags,
			    unsigned int mask);

3146
extern const struct file_operations generic_ro_fops;
L
Linus Torvalds 已提交
3147 3148 3149

#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))

A
Al Viro 已提交
3150
extern int readlink_copy(char __user *, int, const char *);
L
Linus Torvalds 已提交
3151
extern int page_readlink(struct dentry *, char __user *, int);
3152 3153 3154
extern const char *page_get_link(struct dentry *, struct inode *,
				 struct delayed_call *);
extern void page_put_link(void *);
3155
extern int __page_symlink(struct inode *inode, const char *symname, int len,
3156
		int nofs);
L
Linus Torvalds 已提交
3157
extern int page_symlink(struct inode *inode, const char *symname, int len);
3158
extern const struct inode_operations page_symlink_inode_operations;
3159
extern void kfree_link(void *);
C
Christian Brauner 已提交
3160
void generic_fillattr(struct user_namespace *, struct inode *, struct kstat *);
3161 3162
extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3163
void __inode_add_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3164
void inode_add_bytes(struct inode *inode, loff_t bytes);
3165
void __inode_sub_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3166
void inode_sub_bytes(struct inode *inode, loff_t bytes);
J
Jan Kara 已提交
3167 3168 3169 3170
static inline loff_t __inode_get_bytes(struct inode *inode)
{
	return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
}
L
Linus Torvalds 已提交
3171 3172
loff_t inode_get_bytes(struct inode *inode);
void inode_set_bytes(struct inode *inode, loff_t bytes);
3173 3174
const char *simple_get_link(struct dentry *, struct inode *,
			    struct delayed_call *);
A
Al Viro 已提交
3175
extern const struct inode_operations simple_symlink_inode_operations;
L
Linus Torvalds 已提交
3176

3177
extern int iterate_dir(struct file *, struct dir_context *);
L
Linus Torvalds 已提交
3178

3179 3180
int vfs_fstatat(int dfd, const char __user *filename, struct kstat *stat,
		int flags);
C
Christoph Hellwig 已提交
3181
int vfs_fstat(int fd, struct kstat *stat);
3182 3183 3184

static inline int vfs_stat(const char __user *filename, struct kstat *stat)
{
3185
	return vfs_fstatat(AT_FDCWD, filename, stat, 0);
3186 3187 3188
}
static inline int vfs_lstat(const char __user *name, struct kstat *stat)
{
3189
	return vfs_fstatat(AT_FDCWD, name, stat, AT_SYMLINK_NOFOLLOW);
3190 3191
}

M
Miklos Szeredi 已提交
3192
extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3193
extern int vfs_readlink(struct dentry *, char __user *, int);
L
Linus Torvalds 已提交
3194

3195
extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3196
extern void put_filesystem(struct file_system_type *fs);
L
Linus Torvalds 已提交
3197 3198
extern struct file_system_type *get_fs_type(const char *name);
extern struct super_block *get_super(struct block_device *);
3199
extern struct super_block *get_active_super(struct block_device *bdev);
L
Linus Torvalds 已提交
3200
extern void drop_super(struct super_block *sb);
3201
extern void drop_super_exclusive(struct super_block *sb);
A
Al Viro 已提交
3202
extern void iterate_supers(void (*)(struct super_block *, void *), void *);
A
Al Viro 已提交
3203 3204
extern void iterate_supers_type(struct file_system_type *,
			        void (*)(struct super_block *, void *), void *);
L
Linus Torvalds 已提交
3205 3206 3207 3208

extern int dcache_dir_open(struct inode *, struct file *);
extern int dcache_dir_close(struct inode *, struct file *);
extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3209
extern int dcache_readdir(struct file *, struct dir_context *);
3210
extern int simple_setattr(struct dentry *, struct iattr *);
3211
extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3212
extern int simple_statfs(struct dentry *, struct kstatfs *);
S
Stephen Boyd 已提交
3213
extern int simple_open(struct inode *inode, struct file *file);
L
Linus Torvalds 已提交
3214 3215 3216
extern int simple_link(struct dentry *, struct inode *, struct dentry *);
extern int simple_unlink(struct inode *, struct dentry *);
extern int simple_rmdir(struct inode *, struct dentry *);
3217 3218
extern int simple_rename(struct inode *, struct dentry *,
			 struct inode *, struct dentry *, unsigned int);
3219 3220
extern void simple_recursive_removal(struct dentry *,
                              void (*callback)(struct dentry *));
3221
extern int noop_fsync(struct file *, loff_t, loff_t, int);
3222 3223 3224 3225
extern int noop_set_page_dirty(struct page *page);
extern void noop_invalidatepage(struct page *page, unsigned int offset,
		unsigned int length);
extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
L
Linus Torvalds 已提交
3226 3227
extern int simple_empty(struct dentry *);
extern int simple_readpage(struct file *file, struct page *page);
3228 3229 3230 3231 3232 3233
extern int simple_write_begin(struct file *file, struct address_space *mapping,
			loff_t pos, unsigned len, unsigned flags,
			struct page **pagep, void **fsdata);
extern int simple_write_end(struct file *file, struct address_space *mapping,
			loff_t pos, unsigned len, unsigned copied,
			struct page *page, void *fsdata);
3234
extern int always_delete_dentry(const struct dentry *);
A
Al Viro 已提交
3235
extern struct inode *alloc_anon_inode(struct super_block *);
3236
extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3237
extern const struct dentry_operations simple_dentry_operations;
L
Linus Torvalds 已提交
3238

A
Al Viro 已提交
3239
extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
L
Linus Torvalds 已提交
3240
extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3241
extern const struct file_operations simple_dir_operations;
3242
extern const struct inode_operations simple_dir_inode_operations;
3243 3244
extern void make_empty_dir_inode(struct inode *inode);
extern bool is_empty_dir_inode(struct inode *inode);
3245
struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
L
Linus Torvalds 已提交
3246
struct dentry *d_alloc_name(struct dentry *, const char *);
3247 3248
extern int simple_fill_super(struct super_block *, unsigned long,
			     const struct tree_descr *);
3249
extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
L
Linus Torvalds 已提交
3250 3251
extern void simple_release_fs(struct vfsmount **mount, int *count);

3252 3253
extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
			loff_t *ppos, const void *from, size_t available);
3254 3255
extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
		const void __user *from, size_t count);
L
Linus Torvalds 已提交
3256

3257
extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3258
extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
A
Al Viro 已提交
3259

3260 3261
extern int generic_check_addressable(unsigned, u64);

3262 3263 3264 3265 3266
#ifdef CONFIG_UNICODE
extern int generic_ci_d_hash(const struct dentry *dentry, struct qstr *str);
extern int generic_ci_d_compare(const struct dentry *dentry, unsigned int len,
				const char *str, const struct qstr *name);
#endif
3267
extern void generic_set_encrypted_ci_d_ops(struct dentry *dentry);
3268

3269
#ifdef CONFIG_MIGRATION
3270
extern int buffer_migrate_page(struct address_space *,
3271 3272
				struct page *, struct page *,
				enum migrate_mode);
3273 3274 3275
extern int buffer_migrate_page_norefs(struct address_space *,
				struct page *, struct page *,
				enum migrate_mode);
3276 3277
#else
#define buffer_migrate_page NULL
3278
#define buffer_migrate_page_norefs NULL
3279 3280
#endif

C
Christian Brauner 已提交
3281
int setattr_prepare(struct user_namespace *, struct dentry *, struct iattr *);
N
npiggin@suse.de 已提交
3282
extern int inode_newsize_ok(const struct inode *, loff_t offset);
C
Christian Brauner 已提交
3283 3284
void setattr_copy(struct user_namespace *, struct inode *inode,
		  const struct iattr *attr);
L
Linus Torvalds 已提交
3285

3286
extern int file_update_time(struct file *file);
L
Linus Torvalds 已提交
3287

3288
static inline bool vma_is_dax(const struct vm_area_struct *vma)
3289 3290 3291 3292
{
	return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
}

3293 3294 3295 3296
static inline bool vma_is_fsdax(struct vm_area_struct *vma)
{
	struct inode *inode;

3297
	if (!IS_ENABLED(CONFIG_FS_DAX) || !vma->vm_file)
3298 3299 3300 3301
		return false;
	if (!vma_is_dax(vma))
		return false;
	inode = file_inode(vma->vm_file);
D
Dan Williams 已提交
3302
	if (S_ISCHR(inode->i_mode))
3303 3304 3305 3306
		return false; /* device-dax */
	return true;
}

3307 3308 3309 3310 3311
static inline int iocb_flags(struct file *file)
{
	int res = 0;
	if (file->f_flags & O_APPEND)
		res |= IOCB_APPEND;
3312
	if (file->f_flags & O_DIRECT)
3313
		res |= IOCB_DIRECT;
3314 3315 3316 3317
	if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
		res |= IOCB_DSYNC;
	if (file->f_flags & __O_SYNC)
		res |= IOCB_SYNC;
3318 3319 3320
	return res;
}

C
Christoph Hellwig 已提交
3321
static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3322
{
3323 3324
	int kiocb_flags = 0;

3325 3326 3327
	/* make sure there's no overlap between RWF and private IOCB flags */
	BUILD_BUG_ON((__force int) RWF_SUPPORTED & IOCB_EVENTFD);

3328 3329
	if (!flags)
		return 0;
3330 3331 3332
	if (unlikely(flags & ~RWF_SUPPORTED))
		return -EOPNOTSUPP;

3333
	if (flags & RWF_NOWAIT) {
3334
		if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3335
			return -EOPNOTSUPP;
3336
		kiocb_flags |= IOCB_NOIO;
3337
	}
3338
	kiocb_flags |= (__force int) (flags & RWF_SUPPORTED);
3339
	if (flags & RWF_SYNC)
3340
		kiocb_flags |= IOCB_DSYNC;
3341 3342

	ki->ki_flags |= kiocb_flags;
3343 3344 3345
	return 0;
}

L
Linus Torvalds 已提交
3346 3347 3348 3349
static inline ino_t parent_ino(struct dentry *dentry)
{
	ino_t res;

N
Nick Piggin 已提交
3350 3351 3352 3353
	/*
	 * Don't strictly need d_lock here? If the parent ino could change
	 * then surely we'd have a deeper race in the caller?
	 */
L
Linus Torvalds 已提交
3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367
	spin_lock(&dentry->d_lock);
	res = dentry->d_parent->d_inode->i_ino;
	spin_unlock(&dentry->d_lock);
	return res;
}

/* Transaction based IO helpers */

/*
 * An argresp is stored in an allocated page and holds the
 * size of the argument or response, along with its content
 */
struct simple_transaction_argresp {
	ssize_t size;
3368
	char data[];
L
Linus Torvalds 已提交
3369 3370 3371 3372 3373 3374 3375 3376 3377 3378
};

#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))

char *simple_transaction_get(struct file *file, const char __user *buf,
				size_t size);
ssize_t simple_transaction_read(struct file *file, char __user *buf,
				size_t size, loff_t *pos);
int simple_transaction_release(struct inode *inode, struct file *file);

3379
void simple_transaction_set(struct file *file, size_t n);
L
Linus Torvalds 已提交
3380

3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402
/*
 * simple attribute files
 *
 * These attributes behave similar to those in sysfs:
 *
 * Writing to an attribute immediately sets a value, an open file can be
 * written to multiple times.
 *
 * Reading from an attribute creates a buffer from the value that might get
 * read with multiple read calls. When the attribute has been read
 * completely, no further read calls are possible until the file is opened
 * again.
 *
 * All attributes contain a text representation of a numeric value
 * that are accessed with the get() and set() functions.
 */
#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)		\
static int __fops ## _open(struct inode *inode, struct file *file)	\
{									\
	__simple_attr_check_format(__fmt, 0ull);			\
	return simple_attr_open(inode, file, __get, __set, __fmt);	\
}									\
3403
static const struct file_operations __fops = {				\
3404 3405
	.owner	 = THIS_MODULE,						\
	.open	 = __fops ## _open,					\
3406
	.release = simple_attr_release,					\
3407 3408
	.read	 = simple_attr_read,					\
	.write	 = simple_attr_write,					\
3409
	.llseek	 = generic_file_llseek,					\
3410
}
3411

3412 3413
static inline __printf(1, 2)
void __simple_attr_check_format(const char *fmt, ...)
3414 3415 3416 3417 3418
{
	/* don't do anything, just let the compiler check the arguments; */
}

int simple_attr_open(struct inode *inode, struct file *file,
3419
		     int (*get)(void *, u64 *), int (*set)(void *, u64),
3420
		     const char *fmt);
3421
int simple_attr_release(struct inode *inode, struct file *file);
3422 3423 3424 3425 3426
ssize_t simple_attr_read(struct file *file, char __user *buf,
			 size_t len, loff_t *ppos);
ssize_t simple_attr_write(struct file *file, const char __user *buf,
			  size_t len, loff_t *ppos);

A
Alexey Dobriyan 已提交
3427
struct ctl_table;
3428
int proc_nr_files(struct ctl_table *table, int write,
3429
		  void *buffer, size_t *lenp, loff_t *ppos);
3430
int proc_nr_dentry(struct ctl_table *table, int write,
3431
		  void *buffer, size_t *lenp, loff_t *ppos);
3432
int proc_nr_inodes(struct ctl_table *table, int write,
3433
		   void *buffer, size_t *lenp, loff_t *ppos);
3434
int __init get_filesystem_list(char *buf);
3435

N
Namhyung Kim 已提交
3436
#define __FMODE_EXEC		((__force int) FMODE_EXEC)
3437 3438
#define __FMODE_NONOTIFY	((__force int) FMODE_NONOTIFY)

A
Al Viro 已提交
3439
#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
E
Eric Paris 已提交
3440
#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
3441
					    (flag & __FMODE_NONOTIFY)))
A
Al Viro 已提交
3442

Y
Yaowei Bai 已提交
3443
static inline bool is_sxid(umode_t mode)
3444 3445 3446 3447
{
	return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
}

3448 3449
static inline int check_sticky(struct user_namespace *mnt_userns,
			       struct inode *dir, struct inode *inode)
M
Miklos Szeredi 已提交
3450 3451 3452 3453
{
	if (!(dir->i_mode & S_ISVTX))
		return 0;

3454
	return __check_sticky(mnt_userns, dir, inode);
M
Miklos Szeredi 已提交
3455 3456
}

3457 3458
static inline void inode_has_no_xattr(struct inode *inode)
{
3459
	if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3460 3461 3462
		inode->i_flags |= S_NOSEC;
}

A
Al Viro 已提交
3463 3464 3465 3466 3467
static inline bool is_root_inode(struct inode *inode)
{
	return inode == inode->i_sb->s_root->d_inode;
}

3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497
static inline bool dir_emit(struct dir_context *ctx,
			    const char *name, int namelen,
			    u64 ino, unsigned type)
{
	return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
}
static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
{
	return ctx->actor(ctx, ".", 1, ctx->pos,
			  file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
}
static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
{
	return ctx->actor(ctx, "..", 2, ctx->pos,
			  parent_ino(file->f_path.dentry), DT_DIR) == 0;
}
static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
{
	if (ctx->pos == 0) {
		if (!dir_emit_dot(file, ctx))
			return false;
		ctx->pos = 1;
	}
	if (ctx->pos == 1) {
		if (!dir_emit_dotdot(file, ctx))
			return false;
		ctx->pos = 2;
	}
	return true;
}
A
Al Viro 已提交
3498 3499
static inline bool dir_relax(struct inode *inode)
{
A
Al Viro 已提交
3500 3501
	inode_unlock(inode);
	inode_lock(inode);
A
Al Viro 已提交
3502 3503
	return !IS_DEADDIR(inode);
}
3504

A
Al Viro 已提交
3505 3506 3507 3508 3509 3510 3511
static inline bool dir_relax_shared(struct inode *inode)
{
	inode_unlock_shared(inode);
	inode_lock_shared(inode);
	return !IS_DEADDIR(inode);
}

3512
extern bool path_noexec(const struct path *path);
3513
extern void inode_nohighmem(struct inode *inode);
3514

3515 3516 3517
/* mm/fadvise.c */
extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
		       int advice);
J
Jan Kara 已提交
3518 3519
extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
			   int advice);
3520

3521 3522 3523
int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
			     unsigned int flags);

3524 3525 3526 3527 3528 3529 3530 3531 3532
int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
			     struct fsxattr *fa);

static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
{
	memset(fa, 0, sizeof(*fa));
	fa->fsx_xflags = xflags;
}

3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543
/*
 * Flush file data before changing attributes.  Caller must hold any locks
 * required to prevent further writes to this file until we're done setting
 * flags.
 */
static inline int inode_drain_writes(struct inode *inode)
{
	inode_dio_wait(inode);
	return filemap_write_and_wait(inode->i_mapping);
}

L
Linus Torvalds 已提交
3544
#endif /* _LINUX_FS_H */