fs.h 113.4 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>
L
Linus Torvalds 已提交
42 43

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

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

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

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

C
Christoph Hellwig 已提交
87 88
typedef __kernel_rwf_t rwf_t;

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

D
David Howells 已提交
95 96 97 98 99 100 101 102 103 104 105 106
#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
107
 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
D
David Howells 已提交
108 109 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
 */

/* 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)

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

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

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

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

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

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

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

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

D
David Howells 已提交
181 182 183 184 185 186 187 188
/*
 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
 * that indicates that they should check the contents of the iovec are
 * valid, but not check the memory that the iovec elements
 * points too.
 */
#define CHECK_IOVEC_ONLY -1

L
Linus Torvalds 已提交
189 190 191 192
/*
 * Attribute flags.  These should be or-ed together to figure out what
 * has been changed!
 */
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
#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)
209
#define ATTR_TOUCH	(1 << 17)
L
Linus Torvalds 已提交
210

M
Miklos Szeredi 已提交
211 212 213 214 215 216 217
/*
 * 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 已提交
218 219 220 221 222 223 224 225 226 227 228 229
/*
 * 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;
230 231
	kuid_t		ia_uid;
	kgid_t		ia_gid;
L
Linus Torvalds 已提交
232
	loff_t		ia_size;
233 234 235
	struct timespec64 ia_atime;
	struct timespec64 ia_mtime;
	struct timespec64 ia_ctime;
236 237

	/*
L
Lucas De Marchi 已提交
238
	 * Not an attribute, but an auxiliary info for filesystems wanting to
239 240 241 242
	 * 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 已提交
243 244 245 246 247 248 249
};

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

250 251 252 253 254 255
/*
 * Maximum number of layers of fs stack.  Needs to be limited to
 * prevent kernel stack overflow
 */
#define FILESYSTEM_MAX_STACK_DEPTH 2

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
/** 
 * 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 已提交
274
 *  			by readpage().
275 276 277 278 279 280 281 282 283 284 285 286
 *
 * 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,
};

287 288
#define AOP_FLAG_CONT_EXPAND		0x0001 /* called from cont_expand */
#define AOP_FLAG_NOFS			0x0002 /* used by filesystem to direct
289 290
						* helper code (eg buffer layer)
						* to clear GFP_FS from alloc */
291

L
Linus Torvalds 已提交
292 293 294 295 296 297
/*
 * oh the beauties of C type declarations.
 */
struct page;
struct address_space;
struct writeback_control;
298
struct readahead_control;
L
Linus Torvalds 已提交
299

300 301
/*
 * Write life time hint values.
302
 * Stored in struct inode as u8.
303 304 305 306 307 308 309 310 311 312
 */
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,
};

313
#define IOCB_EVENTFD		(1 << 0)
314 315
#define IOCB_APPEND		(1 << 1)
#define IOCB_DIRECT		(1 << 2)
316
#define IOCB_HIPRI		(1 << 3)
317 318
#define IOCB_DSYNC		(1 << 4)
#define IOCB_SYNC		(1 << 5)
319
#define IOCB_WRITE		(1 << 6)
320
#define IOCB_NOWAIT		(1 << 7)
321 322
/* iocb->ki_waitq is valid */
#define IOCB_WAITQ		(1 << 8)
323
#define IOCB_NOIO		(1 << 9)
324 325 326

struct kiocb {
	struct file		*ki_filp;
327 328 329 330

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

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

	randomized_struct_fields_end
};
344 345 346 347 348 349

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

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
/*
 * "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 已提交
371

L
Linus Torvalds 已提交
372 373 374 375 376 377 378
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 *);

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

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

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

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

J
Jens Axboe 已提交
423 424
extern const struct address_space_operations empty_aops;

425 426 427 428 429 430 431 432 433 434 435 436
/*
 * 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);

437 438 439 440 441 442
/**
 * 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.
443
 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
444 445 446 447 448 449 450 451 452 453 454 455
 * @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 已提交
456
struct address_space {
457 458 459 460
	struct inode		*host;
	struct xarray		i_pages;
	gfp_t			gfp_mask;
	atomic_t		i_mmap_writable;
461 462 463 464
#ifdef CONFIG_READ_ONLY_THP_FOR_FS
	/* number of thp, only for non-shmem files */
	atomic_t		nr_thps;
#endif
465 466 467
	struct rb_root_cached	i_mmap;
	struct rw_semaphore	i_mmap_rwsem;
	unsigned long		nrpages;
468
	unsigned long		nrexceptional;
469 470 471
	pgoff_t			writeback_index;
	const struct address_space_operations *a_ops;
	unsigned long		flags;
472
	errseq_t		wb_err;
473 474 475
	spinlock_t		private_lock;
	struct list_head	private_list;
	void			*private_data;
476
} __attribute__((aligned(sizeof(long)))) __randomize_layout;
L
Linus Torvalds 已提交
477 478
	/*
	 * On most architectures that alignment is already the case; but
L
Lucas De Marchi 已提交
479
	 * must be enforced here for CRIS, to let the least significant bit
L
Linus Torvalds 已提交
480 481 482
	 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
	 */

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

496 497
static inline void i_mmap_lock_write(struct address_space *mapping)
{
498
	down_write(&mapping->i_mmap_rwsem);
499 500
}

501 502 503 504 505
static inline int i_mmap_trylock_write(struct address_space *mapping)
{
	return down_write_trylock(&mapping->i_mmap_rwsem);
}

506 507
static inline void i_mmap_unlock_write(struct address_space *mapping)
{
508
	up_write(&mapping->i_mmap_rwsem);
509 510
}

D
Davidlohr Bueso 已提交
511 512 513 514 515 516 517 518 519 520
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);
}

L
Linus Torvalds 已提交
521 522 523 524 525
/*
 * Might pages of this file be mapped into userspace?
 */
static inline int mapping_mapped(struct address_space *mapping)
{
526
	return	!RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
L
Linus Torvalds 已提交
527 528 529 530
}

/*
 * Might pages of this file have been modified in userspace?
531
 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap
L
Linus Torvalds 已提交
532 533
 * 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.
534 535 536
 *
 * 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 已提交
537 538 539
 */
static inline int mapping_writably_mapped(struct address_space *mapping)
{
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
	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 已提交
563 564 565 566 567 568 569 570 571 572 573 574 575
}

/*
 * 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 已提交
576 577
struct posix_acl;
#define ACL_NOT_CACHED ((void *)(-1))
578
#define ACL_DONT_CACHE ((void *)(-3))
A
Al Viro 已提交
579

580 581 582 583 584 585 586 587 588 589 590 591
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;
}

592 593 594
#define IOP_FASTPERM	0x0001
#define IOP_LOOKUP	0x0002
#define IOP_NOFOLLOW	0x0004
595
#define IOP_XATTR	0x0008
596
#define IOP_DEFAULT_READLINK	0x0010
597

598 599
struct fsnotify_mark_connector;

600 601 602 603 604
/*
 * 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 已提交
605
struct inode {
606
	umode_t			i_mode;
607
	unsigned short		i_opflags;
608 609
	kuid_t			i_uid;
	kgid_t			i_gid;
610 611 612 613 614 615 616
	unsigned int		i_flags;

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

617 618
	const struct inode_operations	*i_op;
	struct super_block	*i_sb;
619
	struct address_space	*i_mapping;
620

621 622 623
#ifdef CONFIG_SECURITY
	void			*i_security;
#endif
624

625 626
	/* Stat data, not accessed from path walking */
	unsigned long		i_ino;
M
Miklos Szeredi 已提交
627 628 629 630 631 632 633 634 635 636 637
	/*
	 * 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;
	};
638
	dev_t			i_rdev;
639
	loff_t			i_size;
640 641 642
	struct timespec64	i_atime;
	struct timespec64	i_mtime;
	struct timespec64	i_ctime;
643 644
	spinlock_t		i_lock;	/* i_blocks, i_bytes, maybe i_size */
	unsigned short          i_bytes;
645 646
	u8			i_blkbits;
	u8			i_write_hint;
647 648 649 650 651 652 653 654
	blkcnt_t		i_blocks;

#ifdef __NEED_I_SIZE_ORDERED
	seqcount_t		i_size_seqcount;
#endif

	/* Misc */
	unsigned long		i_state;
655
	struct rw_semaphore	i_rwsem;
656

657
	unsigned long		dirtied_when;	/* jiffies of first dirtying */
658
	unsigned long		dirtied_time_when;
659

L
Linus Torvalds 已提交
660
	struct hlist_node	i_hash;
661
	struct list_head	i_io_list;	/* backing dev IO list */
662 663
#ifdef CONFIG_CGROUP_WRITEBACK
	struct bdi_writeback	*i_wb;		/* the associated cgroup wb */
664 665 666 667 668

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

	__u32			i_generation;

702 703
#ifdef CONFIG_FSNOTIFY
	__u32			i_fsnotify_mask; /* all events this inode cares about */
704
	struct fsnotify_mark_connector __rcu	*i_fsnotify_marks;
R
Robert Love 已提交
705 706
#endif

707
#ifdef CONFIG_FS_ENCRYPTION
708 709 710
	struct fscrypt_info	*i_crypt_info;
#endif

711 712 713 714
#ifdef CONFIG_FS_VERITY
	struct fsverity_info	*i_verity_info;
#endif

715
	void			*i_private; /* fs or device private pointer */
716
} __randomize_layout;
L
Linus Torvalds 已提交
717

718 719
struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);

F
Fabian Frederick 已提交
720 721 722 723 724
static inline unsigned int i_blocksize(const struct inode *node)
{
	return (1 << node->i_blkbits);
}

A
Al Viro 已提交
725 726 727 728 729
static inline int inode_unhashed(struct inode *inode)
{
	return hlist_unhashed(&inode->i_hash);
}

A
Al Viro 已提交
730 731 732 733 734 735 736 737 738 739 740
/*
 * __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 已提交
741 742 743 744 745 746
/*
 * inode->i_mutex nesting subclasses for the lock validator:
 *
 * 0: the object of the current VFS operation
 * 1: parent
 * 2: child/target
747 748
 * 3: xattr
 * 4: second non-directory
749 750 751
 * 5: second parent (when locking independent directories in rename)
 *
 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
752
 * non-directories at once.
I
Ingo Molnar 已提交
753 754
 *
 * The locking order between these classes is
755
 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
I
Ingo Molnar 已提交
756 757 758 759 760 761
 */
enum inode_i_mutex_lock_class
{
	I_MUTEX_NORMAL,
	I_MUTEX_PARENT,
	I_MUTEX_CHILD,
I
Ingo Molnar 已提交
762
	I_MUTEX_XATTR,
763 764
	I_MUTEX_NONDIR2,
	I_MUTEX_PARENT2,
I
Ingo Molnar 已提交
765 766
};

A
Al Viro 已提交
767 768
static inline void inode_lock(struct inode *inode)
{
769
	down_write(&inode->i_rwsem);
A
Al Viro 已提交
770 771 772 773
}

static inline void inode_unlock(struct inode *inode)
{
774 775 776 777 778 779 780 781 782 783 784
	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 已提交
785 786 787 788
}

static inline int inode_trylock(struct inode *inode)
{
789 790 791 792 793 794
	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 已提交
795 796 797 798
}

static inline int inode_is_locked(struct inode *inode)
{
799
	return rwsem_is_locked(&inode->i_rwsem);
A
Al Viro 已提交
800 801 802 803
}

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

807 808 809 810 811
static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
{
	down_read_nested(&inode->i_rwsem, subclass);
}

812 813 814
void lock_two_nondirectories(struct inode *, struct inode*);
void unlock_two_nondirectories(struct inode *, struct inode*);

L
Linus Torvalds 已提交
815 816 817 818 819 820 821 822 823 824
/*
 * 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 已提交
825
static inline loff_t i_size_read(const struct inode *inode)
L
Linus Torvalds 已提交
826 827 828 829 830 831 832 833 834 835
{
#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;
836
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
L
Linus Torvalds 已提交
837 838 839 840 841 842 843 844 845 846 847
	loff_t i_size;

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

848 849 850 851 852
/*
 * 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 已提交
853 854 855
static inline void i_size_write(struct inode *inode, loff_t i_size)
{
#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
856
	preempt_disable();
L
Linus Torvalds 已提交
857 858 859
	write_seqcount_begin(&inode->i_size_seqcount);
	inode->i_size = i_size;
	write_seqcount_end(&inode->i_size_seqcount);
860
	preempt_enable();
861
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
L
Linus Torvalds 已提交
862 863 864 865 866 867 868 869
	preempt_disable();
	inode->i_size = i_size;
	preempt_enable();
#else
	inode->i_size = i_size;
#endif
}

J
Jan Engelhardt 已提交
870
static inline unsigned iminor(const struct inode *inode)
L
Linus Torvalds 已提交
871 872 873 874
{
	return MINOR(inode->i_rdev);
}

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

struct fown_struct {
	rwlock_t lock;          /* protects pid, uid, euid fields */
882 883
	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 */
884
	kuid_t uid, euid;	/* uid/euid of process setting the owner */
L
Linus Torvalds 已提交
885 886 887 888 889 890 891
	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 已提交
892 893 894
	pgoff_t start;			/* where readahead started */
	unsigned int size;		/* # of readahead pages */
	unsigned int async_size;	/* do asynchronous readahead when
895
					   there are only # of pages ahead */
896

F
Fengguang Wu 已提交
897
	unsigned int ra_pages;		/* Maximum readahead window */
898
	unsigned int mmap_miss;		/* Cache miss stat for mmap accesses */
899
	loff_t prev_pos;		/* Cache last read() position */
L
Linus Torvalds 已提交
900 901
};

902 903 904 905 906
/*
 * Check if @index falls in the readahead windows.
 */
static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
{
907 908
	return (index >= ra->start &&
		index <  ra->start + ra->size);
909 910
}

L
Linus Torvalds 已提交
911
struct file {
E
Eric Dumazet 已提交
912
	union {
913
		struct llist_node	fu_llist;
E
Eric Dumazet 已提交
914 915
		struct rcu_head 	fu_rcuhead;
	} f_u;
916
	struct path		f_path;
917
	struct inode		*f_inode;	/* cached value */
918
	const struct file_operations	*f_op;
919 920

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

935
	u64			f_version;
936
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
937
	void			*f_security;
938
#endif
L
Linus Torvalds 已提交
939 940 941 942 943 944
	/* 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 */
	struct list_head	f_ep_links;
J
Jason Baron 已提交
945
	struct list_head	f_tfile_llink;
L
Linus Torvalds 已提交
946 947
#endif /* #ifdef CONFIG_EPOLL */
	struct address_space	*f_mapping;
948
	errseq_t		f_wb_err;
949
	errseq_t		f_sb_err; /* for syncfs */
950 951
} __randomize_layout
  __attribute__((aligned(4)));	/* lest something weird decides that 2 is OK */
L
Linus Torvalds 已提交
952

953 954 955 956
struct file_handle {
	__u32 handle_bytes;
	int handle_type;
	/* file identifier */
957
	unsigned char f_handle[];
958 959
};

A
Al Viro 已提交
960 961 962 963 964
static inline struct file *get_file(struct file *f)
{
	atomic_long_inc(&f->f_count);
	return f;
}
J
Jens Axboe 已提交
965 966 967
#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 已提交
968
#define file_count(x)	atomic_long_read(&(x)->f_count)
L
Linus Torvalds 已提交
969 970 971 972 973 974

#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
975
#define MAX_LFS_FILESIZE	((loff_t)ULONG_MAX << PAGE_SHIFT)
L
Linus Torvalds 已提交
976
#elif BITS_PER_LONG==64
977
#define MAX_LFS_FILESIZE 	((loff_t)LLONG_MAX)
L
Linus Torvalds 已提交
978 979 980 981
#endif

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

993 994
#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)

995 996 997 998 999 1000
/*
 * Special return value from posix_lock_file() and vfs_lock_file() for
 * asynchronous locking.
 */
#define FILE_LOCK_DEFERRED 1

1001
/* legacy typedef, should eventually be removed */
1002
typedef void *fl_owner_t;
L
Linus Torvalds 已提交
1003

1004 1005
struct file_lock;

L
Linus Torvalds 已提交
1006 1007 1008 1009 1010 1011
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 {
1012 1013
	fl_owner_t (*lm_get_owner)(fl_owner_t);
	void (*lm_put_owner)(fl_owner_t);
J
J. Bruce Fields 已提交
1014
	void (*lm_notify)(struct file_lock *);	/* unblock callback */
1015
	int (*lm_grant)(struct file_lock *, int);
J
Jeff Layton 已提交
1016
	bool (*lm_break)(struct file_lock *);
1017
	int (*lm_change)(struct file_lock *, int, struct list_head *);
1018
	void (*lm_setup)(struct file_lock *, void **);
1019
	bool (*lm_breaker_owns_lease)(struct file_lock *);
L
Linus Torvalds 已提交
1020 1021
};

1022 1023
struct lock_manager {
	struct list_head list;
1024 1025 1026 1027 1028
	/*
	 * NFSv4 and up also want opens blocked during the grace period;
	 * NLM doesn't care:
	 */
	bool block_opens;
1029 1030
};

1031 1032
struct net;
void locks_start_grace(struct net *, struct lock_manager *);
1033
void locks_end_grace(struct lock_manager *);
C
Corentin Labbe 已提交
1034 1035
bool locks_in_grace(struct net *);
bool opens_in_grace(struct net *);
1036

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

1040 1041 1042 1043 1044 1045 1046 1047 1048
/*
 * 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?
 *
1049
 * The varous i_flctx lists are ordered by:
1050
 *
1051 1052 1053
 * 1) lock owner
 * 2) lock range start
 * 3) lock range end
1054 1055 1056
 *
 * Obviously, the last two criteria only matter for POSIX locks.
 */
L
Linus Torvalds 已提交
1057
struct file_lock {
1058
	struct file_lock *fl_blocker;	/* The lock, that is blocking us */
1059
	struct list_head fl_list;	/* link into file_lock_context */
1060
	struct hlist_node fl_link;	/* node in global lists */
1061 1062 1063 1064 1065 1066
	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 已提交
1067
	fl_owner_t fl_owner;
1068
	unsigned int fl_flags;
1069
	unsigned char fl_type;
L
Linus Torvalds 已提交
1070
	unsigned int fl_pid;
1071
	int fl_link_cpu;		/* what cpu's list is this on? */
L
Linus Torvalds 已提交
1072 1073 1074 1075 1076 1077
	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 */
1078 1079 1080
	/* for lease breaks: */
	unsigned long fl_break_time;
	unsigned long fl_downgrade_time;
L
Linus Torvalds 已提交
1081

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

1095
struct file_lock_context {
1096
	spinlock_t		flc_lock;
1097
	struct list_head	flc_flock;
1098
	struct list_head	flc_posix;
1099
	struct list_head	flc_lease;
1100 1101
};

L
Linus Torvalds 已提交
1102 1103 1104 1105 1106 1107 1108
/* 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

1109 1110
extern void send_sigio(struct fown_struct *fown, int fd, int band);

1111
#define locks_inode(f) file_inode(f)
1112

1113
#ifdef CONFIG_FILE_LOCKING
1114
extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1115
extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1116
			struct flock *);
L
Linus Torvalds 已提交
1117 1118

#if BITS_PER_LONG == 32
1119
extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1120
extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1121
			struct flock64 *);
L
Linus Torvalds 已提交
1122 1123 1124 1125 1126 1127
#endif

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

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

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

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

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

1170
#if BITS_PER_LONG == 32
1171 1172
static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
				struct flock64 __user *user)
1173 1174 1175 1176 1177 1178 1179 1180 1181
{
	return -EINVAL;
}

static inline int fcntl_setlk64(unsigned int fd, struct file *file,
				unsigned int cmd, struct flock64 __user *user)
{
	return -EACCES;
}
1182
#endif
1183 1184
static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
{
1185
	return -EINVAL;
1186 1187 1188 1189
}

static inline int fcntl_getlease(struct file *filp)
{
1190
	return F_UNLCK;
1191 1192
}

1193
static inline void
1194
locks_free_lock_context(struct inode *inode)
1195 1196 1197
{
}

1198 1199 1200 1201 1202
static inline void locks_init_lock(struct file_lock *fl)
{
	return;
}

1203
static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
{
	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;
}

1218
static inline void locks_remove_file(struct file *filp)
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
{
	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;
}

1234
static inline int locks_delete_block(struct file_lock *waiter)
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
{
	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;
}

1255 1256 1257 1258 1259
static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
{
	return -ENOLCK;
}

J
J. Bruce Fields 已提交
1260
static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1261 1262 1263 1264
{
	return 0;
}

1265 1266
static inline void lease_get_mtime(struct inode *inode,
				   struct timespec64 *time)
1267 1268 1269 1270 1271
{
	return;
}

static inline int generic_setlease(struct file *filp, long arg,
1272
				    struct file_lock **flp, void **priv)
1273 1274 1275 1276 1277
{
	return -EINVAL;
}

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

1283
static inline int lease_modify(struct file_lock *fl, int arg,
1284
			       struct list_head *dispose)
1285 1286 1287
{
	return -EINVAL;
}
1288 1289 1290 1291

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

1294 1295 1296 1297 1298
static inline struct inode *file_inode(const struct file *f)
{
	return f->f_inode;
}

M
Miklos Szeredi 已提交
1299 1300
static inline struct dentry *file_dentry(const struct file *file)
{
1301
	return d_real(file->f_path.dentry, file_inode(file));
M
Miklos Szeredi 已提交
1302 1303
}

1304 1305
static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
{
1306
	return locks_lock_inode_wait(locks_inode(filp), fl);
1307 1308
}

L
Linus Torvalds 已提交
1309
struct fasync_struct {
1310
	rwlock_t		fa_lock;
1311 1312 1313 1314 1315
	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 已提交
1316 1317 1318 1319 1320 1321
};

#define FASYNC_MAGIC 0x4601

/* SMP safe fasync helpers: */
extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1322 1323 1324 1325 1326
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 已提交
1327 1328 1329
/* can be called from interrupts */
extern void kill_fasync(struct fasync_struct **, int, int);

1330
extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1331
extern int f_setown(struct file *filp, unsigned long arg, int force);
L
Linus Torvalds 已提交
1332
extern void f_delown(struct file *filp);
1333
extern pid_t f_getown(struct file *filp);
L
Linus Torvalds 已提交
1334 1335
extern int send_sigurg(struct fown_struct *fown);

1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
/*
 * 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 已提交
1351
#define SB_INLINECRYPT	(1<<17)	/* Use blk-crypto for encrypted files */
1352 1353 1354 1355 1356 1357
#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)
1358
#define SB_FORCE    	(1<<27)
1359 1360 1361 1362 1363
#define SB_NOSEC	(1<<28)
#define SB_BORN		(1<<29)
#define SB_ACTIVE	(1<<30)
#define SB_NOUSER	(1<<31)

L
Linus Torvalds 已提交
1364 1365 1366 1367 1368 1369 1370
/*
 *	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 */
1371 1372
#define UMOUNT_NOFOLLOW	0x00000008	/* Don't follow symlink on umount */
#define UMOUNT_UNUSED	0x80000000	/* Flag guaranteed to be unused */
L
Linus Torvalds 已提交
1373

1374 1375
/* sb->s_iflags */
#define SB_I_CGROUPWB	0x00000001	/* cgroup-aware writeback enabled */
1376
#define SB_I_NOEXEC	0x00000002	/* Ignore executables on this fs */
1377
#define SB_I_NODEV	0x00000004	/* Ignore devices on this fs */
1378
#define SB_I_MULTIROOT	0x00000008	/* Multiple roots to the dentry tree */
L
Linus Torvalds 已提交
1379

1380 1381
/* sb->s_iflags to limit user namespace mounts */
#define SB_I_USERNS_VISIBLE		0x00000010 /* fstype already mounted */
1382 1383
#define SB_I_IMA_UNVERIFIABLE_SIGNATURE	0x00000020
#define SB_I_UNTRUSTED_MOUNTER		0x00000040
L
Linus Torvalds 已提交
1384

1385 1386
#define SB_I_SKIP_SYNC	0x00000100	/* Skip superblock at global sync */

1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
/* 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 {
1400 1401 1402
	int				frozen;		/* Is sb frozen? */
	wait_queue_head_t		wait_unfrozen;	/* for get_super_thawed() */
	struct percpu_rw_semaphore	rw_sem[SB_FREEZE_LEVELS];
1403 1404
};

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

1443
	struct sb_writers	s_writers;
L
Linus Torvalds 已提交
1444

1445 1446 1447 1448 1449 1450 1451 1452 1453
	/*
	 * 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;
1454 1455 1456
	/* Time limits for c/m/atime in seconds */
	time64_t		   s_time_min;
	time64_t		   s_time_max;
1457 1458 1459 1460 1461
#ifdef CONFIG_FSNOTIFY
	__u32			s_fsnotify_mask;
	struct fsnotify_mark_connector __rcu	*s_fsnotify_marks;
#endif

1462 1463
	char			s_id[32];	/* Informational name */
	uuid_t			s_uuid;		/* UUID */
L
Linus Torvalds 已提交
1464

1465
	unsigned int		s_max_links;
1466
	fmode_t			s_mode;
L
Linus Torvalds 已提交
1467 1468 1469 1470 1471

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

M
Miklos Szeredi 已提交
1474 1475 1476 1477
	/*
	 * Filesystem subtype.  If non-empty the filesystem type field
	 * in /proc/mounts will be "type.subtype"
	 */
1478
	const char *s_subtype;
1479

A
Al Viro 已提交
1480
	const struct dentry_operations *s_d_op; /* default d_op for dentries */
1481 1482 1483 1484 1485

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

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

M
Miklos Szeredi 已提交
1489 1490 1491
	/* Number of inodes with nlink == 0 but still referenced */
	atomic_long_t s_remove_count;

1492 1493 1494
	/* Pending fsnotify inode refs */
	atomic_long_t s_fsnotify_inode_refs;

1495 1496
	/* Being remounted read-only */
	int s_readonly_remount;
1497

1498 1499 1500
	/* per-sb errseq_t for reporting writeback errors via syncfs */
	errseq_t s_wb_err;

1501 1502
	/* AIO completions deferred from interrupt context */
	struct workqueue_struct *s_dio_done_wq;
A
Al Viro 已提交
1503
	struct hlist_head s_pins;
1504

1505 1506 1507 1508 1509 1510 1511
	/*
	 * 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;

1512
	/*
1513 1514 1515
	 * 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.
1516
	 */
1517 1518
	struct list_lru		s_dentry_lru;
	struct list_lru		s_inode_lru;
A
Al Viro 已提交
1519
	struct rcu_head		rcu;
1520
	struct work_struct	destroy_work;
1521

1522
	struct mutex		s_sync_lock;	/* sync serialisation lock */
1523 1524 1525 1526 1527

	/*
	 * Indicates how deep in a filesystem stack this SB is
	 */
	int s_stack_depth;
1528 1529 1530 1531

	/* s_inode_list_lock protects s_inodes */
	spinlock_t		s_inode_list_lock ____cacheline_aligned_in_smp;
	struct list_head	s_inodes;	/* all inodes */
1532 1533 1534

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

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
/* 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);
}

1562
extern struct timespec64 current_time(struct inode *inode);
L
Linus Torvalds 已提交
1563 1564 1565 1566 1567

/*
 * Snapshotting support.
 */

1568 1569 1570
void __sb_end_write(struct super_block *sb, int level);
int __sb_start_write(struct super_block *sb, int level, bool wait);

1571
#define __sb_writers_acquired(sb, lev)	\
1572
	percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1573
#define __sb_writers_release(sb, lev)	\
1574
	percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1575

1576 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 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653
/**
 * 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)
{
	__sb_start_write(sb, SB_FREEZE_WRITE, true);
}

static inline int sb_start_write_trylock(struct super_block *sb)
{
	return __sb_start_write(sb, SB_FREEZE_WRITE, false);
}

/**
 * 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
1654
 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
1655 1656
 * handling code implies lock dependency:
 *
1657
 * mmap_lock
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
 *   -> sb_start_pagefault
 */
static inline void sb_start_pagefault(struct super_block *sb)
{
	__sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
}

/*
 * 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)
{
	__sb_start_write(sb, SB_FREEZE_FS, true);
}
L
Linus Torvalds 已提交
1682

1683 1684 1685 1686 1687
static inline int sb_start_intwrite_trylock(struct super_block *sb)
{
	return __sb_start_write(sb, SB_FREEZE_FS, false);
}

L
Linus Torvalds 已提交
1688

1689
extern bool inode_owner_or_capable(const struct inode *inode);
1690

L
Linus Torvalds 已提交
1691 1692 1693
/*
 * VFS helper functions..
 */
A
Al Viro 已提交
1694
extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1695
extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
A
Al Viro 已提交
1696
extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1697
extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J
J. Bruce Fields 已提交
1698
extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
L
Linus Torvalds 已提交
1699
extern int vfs_rmdir(struct inode *, struct dentry *);
1700
extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
M
Miklos Szeredi 已提交
1701
extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1702 1703 1704 1705 1706

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 已提交
1707

1708 1709 1710
extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
				  int open_flag);

A
Al Viro 已提交
1711 1712 1713 1714
int vfs_mkobj(struct dentry *, umode_t,
		int (*f)(struct dentry *, umode_t, void *),
		void *);

C
Christoph Hellwig 已提交
1715
int vfs_fchown(struct file *file, uid_t user, gid_t group);
C
Christoph Hellwig 已提交
1716
int vfs_fchmod(struct file *file, umode_t mode);
C
Christoph Hellwig 已提交
1717
int vfs_utimes(const struct path *path, struct timespec64 *times);
C
Christoph Hellwig 已提交
1718

1719 1720
extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);

1721 1722 1723 1724 1725 1726 1727
#ifdef CONFIG_COMPAT
extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
					unsigned long arg);
#else
#define compat_ptr_ioctl NULL
#endif

1728 1729 1730
/*
 * VFS file helper functions.
 */
1731
extern void inode_init_owner(struct inode *inode, const struct inode *dir,
A
Al Viro 已提交
1732
			umode_t mode);
1733
extern bool may_open_dev(const struct path *path);
M
Mark Fasheh 已提交
1734

L
Linus Torvalds 已提交
1735 1736 1737 1738 1739 1740
/*
 * 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.
 */
1741 1742 1743 1744
struct dir_context;
typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
			 unsigned);

1745
struct dir_context {
1746
	filldir_t actor;
1747
	loff_t pos;
1748
};
1749

1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
/*
 * 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)

1769 1770 1771
/*
 * 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".
1772
 * See Documentation/filesystems/vfs.rst for more details about this call.
1773 1774
 *
 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
1775
 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
1776 1777
 */
#define REMAP_FILE_DEDUP		(1 << 0)
1778
#define REMAP_FILE_CAN_SHORTEN		(1 << 1)
1779 1780 1781 1782 1783 1784 1785 1786

/*
 * 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.
 */
1787
#define REMAP_FILE_ADVISORY		(REMAP_FILE_CAN_SHORTEN)
1788

1789 1790
struct iov_iter;

L
Linus Torvalds 已提交
1791 1792 1793 1794 1795
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 *);
1796 1797
	ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
	ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1798
	int (*iopoll)(struct kiocb *kiocb, bool spin);
1799
	int (*iterate) (struct file *, struct dir_context *);
1800
	int (*iterate_shared) (struct file *, struct dir_context *);
A
Al Viro 已提交
1801
	__poll_t (*poll) (struct file *, struct poll_table_struct *);
L
Linus Torvalds 已提交
1802 1803 1804
	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 *);
1805
	unsigned long mmap_supported_flags;
L
Linus Torvalds 已提交
1806
	int (*open) (struct inode *, struct file *);
1807
	int (*flush) (struct file *, fl_owner_t id);
L
Linus Torvalds 已提交
1808
	int (*release) (struct inode *, struct file *);
1809
	int (*fsync) (struct file *, loff_t, loff_t, int datasync);
L
Linus Torvalds 已提交
1810 1811 1812 1813 1814 1815
	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 *);
1816 1817
	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);
1818
	int (*setlease)(struct file *, long, struct file_lock **, void **);
1819 1820
	long (*fallocate)(struct file *file, int mode, loff_t offset,
			  loff_t len);
1821
	void (*show_fdinfo)(struct seq_file *m, struct file *f);
1822 1823 1824
#ifndef CONFIG_MMU
	unsigned (*mmap_capabilities)(struct file *);
#endif
1825 1826
	ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
			loff_t, size_t, unsigned int);
1827 1828 1829
	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);
1830
	int (*fadvise)(struct file *, loff_t, loff_t, int);
1831
} __randomize_layout;
L
Linus Torvalds 已提交
1832 1833

struct inode_operations {
A
Al Viro 已提交
1834
	struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1835
	const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1836
	int (*permission) (struct inode *, int);
1837
	struct posix_acl * (*get_acl)(struct inode *, int);
1838 1839 1840

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

A
Al Viro 已提交
1841
	int (*create) (struct inode *,struct dentry *, umode_t, bool);
L
Linus Torvalds 已提交
1842 1843 1844
	int (*link) (struct dentry *,struct inode *,struct dentry *);
	int (*unlink) (struct inode *,struct dentry *);
	int (*symlink) (struct inode *,struct dentry *,const char *);
1845
	int (*mkdir) (struct inode *,struct dentry *,umode_t);
L
Linus Torvalds 已提交
1846
	int (*rmdir) (struct inode *,struct dentry *);
A
Al Viro 已提交
1847
	int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
L
Linus Torvalds 已提交
1848
	int (*rename) (struct inode *, struct dentry *,
M
Miklos Szeredi 已提交
1849
			struct inode *, struct dentry *, unsigned int);
L
Linus Torvalds 已提交
1850
	int (*setattr) (struct dentry *, struct iattr *);
1851
	int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
L
Linus Torvalds 已提交
1852
	ssize_t (*listxattr) (struct dentry *, char *, size_t);
M
Mark Fasheh 已提交
1853 1854
	int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
		      u64 len);
1855
	int (*update_time)(struct inode *, struct timespec64 *, int);
A
Al Viro 已提交
1856
	int (*atomic_open)(struct inode *, struct dentry *,
A
Al Viro 已提交
1857
			   struct file *, unsigned open_flag,
1858
			   umode_t create_mode);
1859
	int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1860
	int (*set_acl)(struct inode *, struct posix_acl *, int);
1861
} ____cacheline_aligned;
L
Linus Torvalds 已提交
1862

1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874
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);
}

1875 1876 1877 1878 1879
static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
{
	return file->f_op->mmap(file, vma);
}

B
Badari Pulavarty 已提交
1880
ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
C
Christopher Yeoh 已提交
1881 1882
			      unsigned long nr_segs, unsigned long fast_segs,
			      struct iovec *fast_pointer,
1883
			      struct iovec **ret_pointer);
B
Badari Pulavarty 已提交
1884

L
Linus Torvalds 已提交
1885 1886 1887
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 *);
extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
C
Christoph Hellwig 已提交
1888
		unsigned long, loff_t *, rwf_t);
1889 1890
extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
				   loff_t, size_t, unsigned int);
1891 1892 1893
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);
1894 1895
extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
					 struct file *file_out, loff_t pos_out,
1896 1897 1898 1899
					 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,
1900
				  loff_t len, unsigned int remap_flags);
1901 1902
extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
				   struct file *file_out, loff_t pos_out,
1903
				   loff_t len, unsigned int remap_flags);
1904 1905
extern int vfs_dedupe_file_range(struct file *file,
				 struct file_dedupe_range *same);
1906 1907
extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
					struct file *dst_file, loff_t dst_pos,
1908
					loff_t len, unsigned int remap_flags);
1909

L
Linus Torvalds 已提交
1910 1911 1912 1913

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

1916
   	void (*dirty_inode) (struct inode *, int flags);
1917
	int (*write_inode) (struct inode *, struct writeback_control *wbc);
1918
	int (*drop_inode) (struct inode *);
A
Al Viro 已提交
1919
	void (*evict_inode) (struct inode *);
L
Linus Torvalds 已提交
1920 1921
	void (*put_super) (struct super_block *);
	int (*sync_fs)(struct super_block *sb, int wait);
1922
	int (*freeze_super) (struct super_block *);
1923
	int (*freeze_fs) (struct super_block *);
1924
	int (*thaw_super) (struct super_block *);
1925
	int (*unfreeze_fs) (struct super_block *);
1926
	int (*statfs) (struct dentry *, struct kstatfs *);
L
Linus Torvalds 已提交
1927
	int (*remount_fs) (struct super_block *, int *, char *);
1928
	void (*umount_begin) (struct super_block *);
L
Linus Torvalds 已提交
1929

1930
	int (*show_options)(struct seq_file *, struct dentry *);
1931
	int (*show_devname)(struct seq_file *, struct dentry *);
1932
	int (*show_path)(struct seq_file *, struct dentry *);
1933
	int (*show_stats)(struct seq_file *, struct dentry *);
1934
#ifdef CONFIG_QUOTA
L
Linus Torvalds 已提交
1935 1936
	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);
1937
	struct dquot **(*get_dquots)(struct inode *);
1938
#endif
1939
	int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1940 1941 1942 1943
	long (*nr_cached_objects)(struct super_block *,
				  struct shrink_control *);
	long (*free_cached_objects)(struct super_block *,
				    struct shrink_control *);
L
Linus Torvalds 已提交
1944 1945
};

D
David Howells 已提交
1946 1947 1948
/*
 * Inode flags - they have no relation to superblock flags now
 */
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
#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 */
1962
#ifdef CONFIG_FS_DAX
1963
#define S_DAX		(1 << 13) /* Direct Access, avoiding the page cache */
1964
#else
1965
#define S_DAX		0	  /* Make all the DAX code disappear */
1966
#endif
1967 1968 1969
#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 已提交
1970 1971 1972 1973 1974 1975 1976

/*
 * 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.
 *
1977
 * Exception: SB_RDONLY is always applied to the entire file system.
D
David Howells 已提交
1978 1979 1980 1981 1982 1983 1984 1985
 *
 * 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))

1986
static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
1987
#define IS_RDONLY(inode)	sb_rdonly((inode)->i_sb)
1988
#define IS_SYNC(inode)		(__IS_FLG(inode, SB_SYNCHRONOUS) || \
D
David Howells 已提交
1989
					((inode)->i_flags & S_SYNC))
1990
#define IS_DIRSYNC(inode)	(__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
D
David Howells 已提交
1991
					((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1992 1993 1994
#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 已提交
1995 1996 1997 1998

#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)
1999
#define IS_POSIXACL(inode)	__IS_FLG(inode, SB_POSIXACL)
D
David Howells 已提交
2000 2001 2002 2003 2004 2005 2006 2007

#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)
2008
#define IS_DAX(inode)		((inode)->i_flags & S_DAX)
2009
#define IS_ENCRYPTED(inode)	((inode)->i_flags & S_ENCRYPTED)
2010
#define IS_CASEFOLDED(inode)	((inode)->i_flags & S_CASEFOLD)
2011
#define IS_VERITY(inode)	((inode)->i_flags & S_VERITY)
D
David Howells 已提交
2012

M
Miklos Szeredi 已提交
2013 2014 2015
#define IS_WHITEOUT(inode)	(S_ISCHR(inode->i_mode) && \
				 (inode)->i_rdev == WHITEOUT_DEV)

2016 2017 2018 2019 2020
static inline bool HAS_UNMAPPED_ID(struct inode *inode)
{
	return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
}

2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
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);

2031 2032 2033 2034 2035 2036 2037 2038 2039
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;
}

2040 2041 2042 2043 2044
static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
{
	*kiocb = (struct kiocb) {
		.ki_filp = filp,
		.ki_flags = iocb_flags(filp),
2045
		.ki_hint = ki_hint_validate(file_write_hint(filp)),
2046
		.ki_ioprio = get_current_ioprio(),
2047 2048 2049
	};
}

2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
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 已提交
2062
/*
2063
 * Inode state bits.  Protected by inode->i_lock
J
Joern Engel 已提交
2064 2065 2066 2067 2068 2069 2070 2071
 *
 * 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 已提交
2072
 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
J
Joern Engel 已提交
2073
 *
J
Joern Engel 已提交
2074 2075
 * I_DIRTY_SYNC		Inode is dirty, but doesn't have to be written on
 *			fdatasync().  i_atime is the usual cause.
2076 2077 2078 2079
 * 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 已提交
2080
 * I_DIRTY_PAGES	Inode has dirty pages.  Inode itself may be clean.
C
Christoph Hellwig 已提交
2081 2082 2083 2084 2085 2086 2087 2088
 * 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 已提交
2089 2090 2091 2092 2093 2094
 * 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.
2095 2096
 * I_CLEAR		Added by clear_inode().  In this state the inode is
 *			clean and can be destroyed.  Inode keeps I_FREEING.
J
Joern Engel 已提交
2097 2098 2099 2100 2101
 *
 *			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 已提交
2102
 *			if appropriate.  I_NEW is used for waiting.
J
Joern Engel 已提交
2103
 *
2104 2105 2106 2107
 * 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 已提交
2108
 *
C
Christoph Hellwig 已提交
2109 2110 2111 2112
 * 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().
 *
2113 2114
 * I_WB_SWITCH		Cgroup bdi_writeback switching in progress.  Used to
 *			synchronize competing switching instances and to tell
M
Matthew Wilcox 已提交
2115
 *			wb stat updates to grab the i_pages lock.  See
2116
 *			inode_switch_wbs_work_fn() for details.
2117
 *
2118 2119 2120
 * I_OVL_INUSE		Used by overlayfs to get exclusive ownership on upper
 *			and work dirs among overlayfs mounts.
 *
A
Al Viro 已提交
2121 2122
 * I_CREATING		New object's inode in the middle of setting up.
 *
2123 2124
 * I_DONTCACHE		Evict inode as soon as it is not used anymore.
 *
J
Joern Engel 已提交
2125 2126
 * Q: What is the difference between I_WILL_FREE and I_FREEING?
 */
2127 2128 2129
#define I_DIRTY_SYNC		(1 << 0)
#define I_DIRTY_DATASYNC	(1 << 1)
#define I_DIRTY_PAGES		(1 << 2)
C
Christoph Hellwig 已提交
2130 2131
#define __I_NEW			3
#define I_NEW			(1 << __I_NEW)
2132 2133 2134
#define I_WILL_FREE		(1 << 4)
#define I_FREEING		(1 << 5)
#define I_CLEAR			(1 << 6)
C
Christoph Hellwig 已提交
2135
#define __I_SYNC		7
J
Joern Engel 已提交
2136
#define I_SYNC			(1 << __I_SYNC)
2137
#define I_REFERENCED		(1 << 8)
C
Christoph Hellwig 已提交
2138
#define __I_DIO_WAKEUP		9
E
Eric Sandeen 已提交
2139
#define I_DIO_WAKEUP		(1 << __I_DIO_WAKEUP)
2140
#define I_LINKABLE		(1 << 10)
2141 2142 2143
#define I_DIRTY_TIME		(1 << 11)
#define __I_DIRTY_TIME_EXPIRED	12
#define I_DIRTY_TIME_EXPIRED	(1 << __I_DIRTY_TIME_EXPIRED)
2144
#define I_WB_SWITCH		(1 << 13)
A
Al Viro 已提交
2145 2146
#define I_OVL_INUSE		(1 << 14)
#define I_CREATING		(1 << 15)
2147
#define I_DONTCACHE		(1 << 16)
L
Linus Torvalds 已提交
2148

2149 2150
#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2151
#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
L
Linus Torvalds 已提交
2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163

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 已提交
2164 2165 2166 2167
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);
2168 2169 2170 2171

static inline void inode_inc_link_count(struct inode *inode)
{
	inc_nlink(inode);
2172 2173 2174
	mark_inode_dirty(inode);
}

2175 2176 2177
static inline void inode_dec_link_count(struct inode *inode)
{
	drop_nlink(inode);
2178 2179 2180
	mark_inode_dirty(inode);
}

2181 2182 2183 2184 2185 2186 2187
enum file_time_flags {
	S_ATIME = 1,
	S_MTIME = 2,
	S_CTIME = 4,
	S_VERSION = 8,
};

2188
extern bool atime_needs_update(const struct path *, struct inode *);
A
Al Viro 已提交
2189
extern void touch_atime(const struct path *);
L
Linus Torvalds 已提交
2190 2191 2192
static inline void file_accessed(struct file *file)
{
	if (!(file->f_flags & O_NOATIME))
A
Al Viro 已提交
2193
		touch_atime(&file->f_path);
L
Linus Torvalds 已提交
2194 2195
}

2196 2197
extern int file_modified(struct file *file);

L
Linus Torvalds 已提交
2198
int sync_inode(struct inode *inode, struct writeback_control *wbc);
C
Christoph Hellwig 已提交
2199
int sync_inode_metadata(struct inode *inode, int wait);
L
Linus Torvalds 已提交
2200 2201 2202 2203

struct file_system_type {
	const char *name;
	int fs_flags;
D
David Howells 已提交
2204 2205 2206
#define FS_REQUIRES_DEV		1 
#define FS_BINARY_MOUNTDATA	2
#define FS_HAS_SUBTYPE		4
2207
#define FS_USERNS_MOUNT		8	/* Can be mounted by userns root */
2208
#define FS_DISALLOW_NOTIFY_PERM	16	/* Disable fanotify permission events */
D
David Howells 已提交
2209
#define FS_RENAME_DOES_D_MOVE	32768	/* FS will handle d_move() during rename() internally. */
A
Al Viro 已提交
2210
	int (*init_fs_context)(struct fs_context *);
2211
	const struct fs_parameter_spec *parameters;
A
Al Viro 已提交
2212 2213
	struct dentry *(*mount) (struct file_system_type *, int,
		       const char *, void *);
L
Linus Torvalds 已提交
2214 2215 2216
	void (*kill_sb) (struct super_block *);
	struct module *owner;
	struct file_system_type * next;
A
Al Viro 已提交
2217
	struct hlist_head fs_supers;
2218

I
Ingo Molnar 已提交
2219
	struct lock_class_key s_lock_key;
2220
	struct lock_class_key s_umount_key;
2221
	struct lock_class_key s_vfs_rename_key;
2222
	struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2223 2224 2225

	struct lock_class_key i_lock_key;
	struct lock_class_key i_mutex_key;
2226
	struct lock_class_key i_mutex_dir_key;
L
Linus Torvalds 已提交
2227 2228
};

2229 2230
#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)

A
Al Viro 已提交
2231 2232 2233
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 已提交
2234 2235 2236
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 已提交
2237 2238 2239
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 已提交
2240
extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
L
Linus Torvalds 已提交
2241 2242 2243 2244 2245
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 已提交
2246
void deactivate_locked_super(struct super_block *sb);
L
Linus Torvalds 已提交
2247
int set_anon_super(struct super_block *s, void *data);
2248
int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2249 2250
int get_anon_bdev(dev_t *);
void free_anon_bdev(dev_t);
2251 2252 2253
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 已提交
2254 2255 2256
struct super_block *sget(struct file_system_type *type,
			int (*test)(struct super_block *,void *),
			int (*set)(struct super_block *,void *),
D
David Howells 已提交
2257
			int flags, void *data);
L
Linus Torvalds 已提交
2258 2259 2260 2261 2262 2263

/* 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)
2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274
/*
 * 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 已提交
2275 2276 2277

extern int register_filesystem(struct file_system_type *);
extern int unregister_filesystem(struct file_system_type *);
D
David Howells 已提交
2278
extern struct vfsmount *kern_mount(struct file_system_type *);
2279
extern void kern_unmount(struct vfsmount *mnt);
L
Linus Torvalds 已提交
2280 2281
extern int may_umount_tree(struct vfsmount *);
extern int may_umount(struct vfsmount *);
2282 2283
extern long do_mount(const char *, const char __user *,
		     const char *, unsigned long, void *);
2284
extern struct vfsmount *collect_mounts(const struct path *);
2285
extern void drop_collected_mounts(struct vfsmount *);
A
Al Viro 已提交
2286 2287
extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
			  struct vfsmount *);
A
Al Viro 已提交
2288
extern int vfs_statfs(const struct path *, struct kstatfs *);
A
Al Viro 已提交
2289 2290
extern int user_statfs(const char __user *, struct kstatfs *);
extern int fd_statfs(int, struct kstatfs *);
2291 2292
extern int freeze_super(struct super_block *super);
extern int thaw_super(struct super_block *super);
2293
extern bool our_mnt(struct vfsmount *mnt);
2294 2295 2296
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 已提交
2297

A
Al Viro 已提交
2298 2299
extern int current_umask(void);

2300 2301
extern void ihold(struct inode * inode);
extern void iput(struct inode *);
2302
extern int generic_update_time(struct inode *, struct timespec64 *, int);
2303

M
Miklos Szeredi 已提交
2304
/* /sys/fs */
2305
extern struct kobject *fs_kobj;
M
Miklos Szeredi 已提交
2306

2307
#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2308

2309
#ifdef CONFIG_MANDATORY_FILE_LOCKING
2310
extern int locks_mandatory_locked(struct file *);
2311
extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
L
Linus Torvalds 已提交
2312 2313 2314 2315 2316

/*
 * Candidates for mandatory locking have the setgid bit set
 * but no group execute bit -  an otherwise meaningless combination.
 */
2317 2318 2319 2320 2321 2322 2323

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

/*
2324
 * ... and these candidates should be on SB_MANDLOCK mounted fs,
2325 2326 2327 2328 2329 2330 2331
 * otherwise these will be advisory locks
 */

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

2333
static inline int locks_verify_locked(struct file *file)
L
Linus Torvalds 已提交
2334
{
2335
	if (mandatory_lock(locks_inode(file)))
2336
		return locks_mandatory_locked(file);
L
Linus Torvalds 已提交
2337 2338 2339 2340
	return 0;
}

static inline int locks_verify_truncate(struct inode *inode,
2341
				    struct file *f,
L
Linus Torvalds 已提交
2342 2343
				    loff_t size)
{
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353
	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 已提交
2354 2355
}

2356 2357 2358 2359 2360 2361 2362
#else /* !CONFIG_MANDATORY_FILE_LOCKING */

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

2363 2364
static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
                                       loff_t start, loff_t end, unsigned char type)
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393
{
	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 已提交
2394 2395
static inline int break_lease(struct inode *inode, unsigned int mode)
{
2396 2397
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2398 2399 2400
	 * 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.
2401 2402
	 */
	smp_mb();
2403
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2404
		return __break_lease(inode, mode, FL_LEASE);
L
Linus Torvalds 已提交
2405 2406
	return 0;
}
J
J. Bruce Fields 已提交
2407 2408 2409

static inline int break_deleg(struct inode *inode, unsigned int mode)
{
2410 2411
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2412 2413 2414
	 * 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.
2415 2416
	 */
	smp_mb();
2417
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2418
		return __break_lease(inode, mode, FL_DELEG);
L
Linus Torvalds 已提交
2419 2420
	return 0;
}
J
J. Bruce Fields 已提交
2421

2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
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 已提交
2444 2445 2446 2447 2448 2449 2450 2451 2452 2453
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;
}

2454
#else /* !CONFIG_FILE_LOCKING */
2455 2456 2457 2458 2459
static inline int break_lease(struct inode *inode, unsigned int mode)
{
	return 0;
}

J
J. Bruce Fields 已提交
2460 2461 2462 2463
static inline int break_deleg(struct inode *inode, unsigned int mode)
{
	return 0;
}
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475

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 已提交
2476 2477 2478 2479 2480
static inline int break_layout(struct inode *inode, bool wait)
{
	return 0;
}

2481
#endif /* CONFIG_FILE_LOCKING */
L
Linus Torvalds 已提交
2482 2483

/* fs/open.c */
2484
struct audit_names;
2485
struct filename {
2486 2487
	const char		*name;	/* pointer to actual string */
	const __user char	*uptr;	/* original userland pointer */
2488
	int			refcnt;
2489
	struct audit_names	*aname;
A
Al Viro 已提交
2490
	const char		iname[];
2491
};
2492
static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
L
Linus Torvalds 已提交
2493

A
Al Viro 已提交
2494
extern long vfs_truncate(const struct path *, loff_t);
2495 2496
extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
		       struct file *filp);
2497
extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2498
			loff_t len);
J
Jason Uhlenkott 已提交
2499
extern long do_sys_open(int dfd, const char __user *filename, int flags,
2500
			umode_t mode);
2501
extern struct file *file_open_name(struct filename *, int, umode_t);
2502
extern struct file *filp_open(const char *, int, umode_t);
A
Al Viro 已提交
2503
extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2504
				   const char *, int, umode_t);
2505
extern struct file * dentry_open(const struct path *, int, const struct cred *);
A
Al Viro 已提交
2506 2507
extern struct file * open_with_fake_path(const struct path *, int,
					 struct inode*, const struct cred *);
2508 2509 2510 2511
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 已提交
2512
extern int filp_close(struct file *, fl_owner_t id);
2513

2514
extern struct filename *getname_flags(const char __user *, int, int *);
2515
extern struct filename *getname(const char __user *);
2516
extern struct filename *getname_kernel(const char *);
2517
extern void putname(struct filename *name);
2518

A
Al Viro 已提交
2519
extern int finish_open(struct file *file, struct dentry *dentry,
2520
			int (*open)(struct inode *, struct file *));
A
Al Viro 已提交
2521
extern int finish_no_open(struct file *file, struct dentry *dentry);
L
Linus Torvalds 已提交
2522 2523 2524

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

2527 2528
extern struct kmem_cache *names_cachep;

2529
#define __getname()		kmem_cache_alloc(names_cachep, GFP_KERNEL)
V
Vegard Nossum 已提交
2530
#define __putname(name)		kmem_cache_free(names_cachep, (void *)(name))
L
Linus Torvalds 已提交
2531

T
Tejun Heo 已提交
2532 2533 2534
extern struct super_block *blockdev_superblock;
static inline bool sb_is_blkdev_sb(struct super_block *sb)
{
2535
	return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
2536
}
2537

2538
void emergency_thaw_all(void);
2539
extern int sync_filesystem(struct super_block *);
2540
extern const struct file_operations def_blk_fops;
2541
extern const struct file_operations def_chr_fops;
L
Linus Torvalds 已提交
2542 2543

/* fs/char_dev.c */
2544
#define CHRDEV_MAJOR_MAX 512
2545 2546
/* Marks the bottom of the first segment of free char majors */
#define CHRDEV_MAJOR_DYN_END 234
2547 2548 2549 2550
/* 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 已提交
2551 2552
extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
extern int register_chrdev_region(dev_t, unsigned, const char *);
2553 2554 2555 2556 2557
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 已提交
2558
extern void unregister_chrdev_region(dev_t, unsigned);
2559
extern void chrdev_show(struct seq_file *,off_t);
L
Linus Torvalds 已提交
2560

2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571
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 已提交
2572 2573 2574 2575
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 *);
2576
extern bool is_bad_inode(struct inode *);
L
Linus Torvalds 已提交
2577 2578 2579

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

L
Linus Torvalds 已提交
2581 2582 2583 2584
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))
2585
		invalidate_mapping_pages(inode->i_mapping, 0, -1);
L
Linus Torvalds 已提交
2586 2587 2588 2589 2590 2591 2592
}
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 *);
2593
extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2594 2595
extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
				   loff_t lend);
2596 2597
extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
		loff_t start_byte, loff_t end_byte);
2598 2599 2600 2601 2602 2603

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

2604 2605
extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
				  loff_t lend);
L
Linus Torvalds 已提交
2606 2607
extern int filemap_write_and_wait_range(struct address_space *mapping,
				        loff_t lstart, loff_t lend);
2608 2609
extern int __filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end, int sync_mode);
2610 2611
extern int filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end);
2612
extern int filemap_check_errors(struct address_space *mapping);
2613
extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2614

2615 2616 2617 2618 2619
static inline int filemap_write_and_wait(struct address_space *mapping)
{
	return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
}

2620 2621
extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
						loff_t lend);
2622 2623 2624 2625
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);

2626 2627 2628 2629 2630
static inline int file_write_and_wait(struct file *file)
{
	return file_write_and_wait_range(file, 0, LLONG_MAX);
}

2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652
/**
 * 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 已提交
2653
 * filemap_check_wb_err - has an error occurred since the mark was sampled?
2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679
 * @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);
}

2680 2681
/**
 * file_sample_sb_err - sample the current errseq_t to test for later errors
2682
 * @file: file pointer to be sampled
2683 2684 2685 2686 2687 2688 2689 2690 2691
 *
 * 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);
}

2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718
static inline int filemap_nr_thps(struct address_space *mapping)
{
#ifdef CONFIG_READ_ONLY_THP_FOR_FS
	return atomic_read(&mapping->nr_thps);
#else
	return 0;
#endif
}

static inline void filemap_nr_thps_inc(struct address_space *mapping)
{
#ifdef CONFIG_READ_ONLY_THP_FOR_FS
	atomic_inc(&mapping->nr_thps);
#else
	WARN_ON_ONCE(1);
#endif
}

static inline void filemap_nr_thps_dec(struct address_space *mapping)
{
#ifdef CONFIG_READ_ONLY_THP_FOR_FS
	atomic_dec(&mapping->nr_thps);
#else
	WARN_ON_ONCE(1);
#endif
}

2719 2720 2721
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);
2722

J
Jens Axboe 已提交
2723 2724 2725
extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
				unsigned int flags);

2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741
/*
 * 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;
2742
}
2743

L
Linus Torvalds 已提交
2744 2745
extern void emergency_sync(void);
extern void emergency_remount(void);
2746

2747
#ifdef CONFIG_BLOCK
2748 2749 2750 2751 2752 2753
extern int bmap(struct inode *inode, sector_t *block);
#else
static inline int bmap(struct inode *inode,  sector_t *block)
{
	return -EINVAL;
}
2754
#endif
2755

2756
extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2757
extern int inode_permission(struct inode *, int);
2758
extern int generic_permission(struct inode *, int);
M
Miklos Szeredi 已提交
2759
extern int __check_sticky(struct inode *dir, struct inode *inode);
L
Linus Torvalds 已提交
2760

2761 2762 2763 2764 2765
static inline bool execute_ok(struct inode *inode)
{
	return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
}

2766 2767 2768 2769 2770 2771 2772
static inline void file_start_write(struct file *file)
{
	if (!S_ISREG(file_inode(file)->i_mode))
		return;
	__sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
}

2773 2774 2775 2776 2777 2778 2779
static inline bool file_start_write_trylock(struct file *file)
{
	if (!S_ISREG(file_inode(file)->i_mode))
		return true;
	return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
}

2780 2781 2782 2783 2784 2785
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);
}
2786

2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808
/*
 * 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 已提交
2809
	struct inode *inode = file_inode(file);
2810 2811
	return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
}
L
Linus Torvalds 已提交
2812 2813 2814 2815 2816 2817 2818
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 已提交
2819
		atomic_inc(&file_inode(file)->i_writecount);
L
Linus Torvalds 已提交
2820
}
2821 2822 2823 2824 2825
static inline bool inode_is_open_for_write(const struct inode *inode)
{
	return atomic_read(&inode->i_writecount) > 0;
}

2826
#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
M
Mimi Zohar 已提交
2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
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 已提交
2846
extern int do_pipe_flags(int *, int);
L
Linus Torvalds 已提交
2847

2848 2849 2850
#define __kernel_read_file_id(id) \
	id(UNKNOWN, unknown)		\
	id(FIRMWARE, firmware)		\
2851
	id(FIRMWARE_PREALLOC_BUFFER, firmware)	\
2852
	id(FIRMWARE_EFI_EMBEDDED, firmware)	\
2853 2854 2855 2856
	id(MODULE, kernel-module)		\
	id(KEXEC_IMAGE, kexec-image)		\
	id(KEXEC_INITRAMFS, kexec-initramfs)	\
	id(POLICY, security-policy)		\
2857
	id(X509_CERTIFICATE, x509-certificate)	\
2858 2859 2860 2861 2862
	id(MAX_ID, )

#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
#define __fid_stringify(dummy, str) #str,

2863
enum kernel_read_file_id {
2864 2865 2866 2867 2868
	__kernel_read_file_id(__fid_enumify)
};

static const char * const kernel_read_file_str[] = {
	__kernel_read_file_id(__fid_stringify)
2869 2870
};

K
Kees Cook 已提交
2871
static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2872
{
2873
	if ((unsigned)id >= READING_MAX_ID)
2874 2875 2876 2877 2878
		return kernel_read_file_str[READING_UNKNOWN];

	return kernel_read_file_str[id];
}

2879 2880
extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
			    enum kernel_read_file_id);
2881
extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2882
				      enum kernel_read_file_id);
2883 2884
extern int kernel_read_file_from_path_initns(const char *, void **, loff_t *, loff_t,
					     enum kernel_read_file_id);
2885 2886
extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
				    enum kernel_read_file_id);
2887
extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2888
ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
2889
extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2890
extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
L
Linus Torvalds 已提交
2891 2892 2893
extern struct file * open_exec(const char *);
 
/* fs/dcache.c -- generic fs support functions */
Y
Yaowei Bai 已提交
2894
extern bool is_subdir(struct dentry *, struct dentry *);
2895
extern bool path_is_under(const struct path *, const struct path *);
L
Linus Torvalds 已提交
2896

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

L
Linus Torvalds 已提交
2899 2900 2901
#include <linux/err.h>

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

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

2906
extern int inode_init_always(struct super_block *, struct inode *);
L
Linus Torvalds 已提交
2907
extern void inode_init_once(struct inode *);
2908
extern void address_space_init_once(struct address_space *mapping);
L
Linus Torvalds 已提交
2909 2910 2911
extern struct inode * igrab(struct inode *);
extern ino_t iunique(struct super_block *, ino_t);
extern int inode_needs_sync(struct inode *inode);
2912
extern int generic_delete_inode(struct inode *inode);
2913 2914
static inline int generic_drop_inode(struct inode *inode)
{
2915 2916
	return !inode->i_nlink || inode_unhashed(inode) ||
		(inode->i_state & I_DONTCACHE);
2917
}
I
Ira Weiny 已提交
2918
extern void d_mark_dontcache(struct inode *inode);
L
Linus Torvalds 已提交
2919

2920 2921 2922
extern struct inode *ilookup5_nowait(struct super_block *sb,
		unsigned long hashval, int (*test)(struct inode *, void *),
		void *data);
L
Linus Torvalds 已提交
2923 2924 2925 2926
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 已提交
2927 2928 2929 2930
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 已提交
2931 2932
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);
2933 2934 2935 2936 2937
extern struct inode *find_inode_nowait(struct super_block *,
				       unsigned long,
				       int (*match)(struct inode *,
						    unsigned long, void *),
				       void *data);
2938 2939 2940
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 已提交
2941 2942
extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
extern int insert_inode_locked(struct inode *);
2943 2944 2945 2946 2947
#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 已提交
2948
extern void unlock_new_inode(struct inode *);
A
Al Viro 已提交
2949
extern void discard_new_inode(struct inode *);
2950
extern unsigned int get_next_ino(void);
2951
extern void evict_inodes(struct super_block *sb);
L
Linus Torvalds 已提交
2952

C
Chris Down 已提交
2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967
/*
 * 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 已提交
2968
extern void __iget(struct inode * inode);
2969
extern void iget_failed(struct inode *);
2970
extern void clear_inode(struct inode *);
C
Christoph Hellwig 已提交
2971
extern void __destroy_inode(struct inode *);
2972 2973
extern struct inode *new_inode_pseudo(struct super_block *sb);
extern struct inode *new_inode(struct super_block *sb);
2974
extern void free_inode_nonrcu(struct inode *inode);
2975
extern int should_remove_suid(struct dentry *);
2976
extern int file_remove_privs(struct file *);
L
Linus Torvalds 已提交
2977 2978

extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2979 2980
static inline void insert_inode_hash(struct inode *inode)
{
L
Linus Torvalds 已提交
2981 2982
	__insert_inode_hash(inode, inode->i_ino);
}
2983 2984 2985 2986

extern void __remove_inode_hash(struct inode *);
static inline void remove_inode_hash(struct inode *inode)
{
2987
	if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
2988 2989 2990
		__remove_inode_hash(inode);
}

2991
extern void inode_sb_list_add(struct inode *inode);
L
Linus Torvalds 已提交
2992 2993 2994 2995 2996 2997

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 *);
2998
extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
2999 3000
extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
				struct file *file_out, loff_t pos_out,
3001
				loff_t *count, unsigned int remap_flags);
3002
extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
3003 3004 3005
extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
				    struct file *file_out, loff_t pos_out,
				    size_t *count, unsigned int flags);
3006 3007
extern ssize_t generic_file_buffered_read(struct kiocb *iocb,
		struct iov_iter *to, ssize_t already_read);
A
Al Viro 已提交
3008
extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
3009 3010
extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
3011
extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3012
extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
A
Andrew Morton 已提交
3013

3014
ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3015
		rwf_t flags);
3016
ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3017
		rwf_t flags);
3018 3019 3020 3021
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);
3022

3023
/* fs/block_dev.c */
3024
extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
3025
extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
3026 3027
extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
			int datasync);
A
Al Viro 已提交
3028
extern void block_sync_page(struct page *page);
3029

A
Andrew Morton 已提交
3030
/* fs/splice.c */
3031
extern ssize_t generic_file_splice_read(struct file *, loff_t *,
A
Andrew Morton 已提交
3032
		struct pipe_inode_info *, size_t, unsigned int);
A
Al Viro 已提交
3033
extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3034
		struct file *, loff_t *, size_t, unsigned int);
A
Andrew Morton 已提交
3035
extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
3036
		struct file *out, loff_t *, size_t len, unsigned int flags);
3037 3038 3039
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 已提交
3040

L
Linus Torvalds 已提交
3041 3042
extern void
file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3043 3044
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 已提交
3045
extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3046
extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
A
Andi Kleen 已提交
3047
extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3048
		int whence, loff_t maxsize, loff_t eof);
A
Al Viro 已提交
3049 3050
extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
		int whence, loff_t size);
3051 3052
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 已提交
3053 3054
extern int generic_file_open(struct inode * inode, struct file * filp);
extern int nonseekable_open(struct inode * inode, struct file * filp);
3055
extern int stream_open(struct inode * inode, struct file * filp);
L
Linus Torvalds 已提交
3056

3057
#ifdef CONFIG_BLOCK
3058
typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3059
			    loff_t file_offset);
L
Linus Torvalds 已提交
3060 3061

enum {
3062 3063 3064 3065 3066
	/* need locking between buffered and direct access */
	DIO_LOCKING	= 0x01,

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

D
David Sterba 已提交
3069 3070
void dio_end_io(struct bio *bio);

3071 3072
ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
			     struct block_device *bdev, struct iov_iter *iter,
3073
			     get_block_t get_block,
3074 3075
			     dio_iodone_t end_io, dio_submit_t submit_io,
			     int flags);
3076

3077 3078
static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
					 struct inode *inode,
3079
					 struct iov_iter *iter,
3080
					 get_block_t get_block)
L
Linus Torvalds 已提交
3081
{
3082
	return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3083
			get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
L
Linus Torvalds 已提交
3084
}
3085
#endif
L
Linus Torvalds 已提交
3086

3087
void inode_dio_wait(struct inode *inode);
3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112

/*
 * 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);
}
3113

3114 3115 3116 3117 3118
/*
 * Warn about a page cache invalidation failure diring a direct I/O write.
 */
void dio_warn_stale_pagecache(struct file *filp);

3119 3120 3121
extern void inode_set_flags(struct inode *inode, unsigned int flags,
			    unsigned int mask);

3122
extern const struct file_operations generic_ro_fops;
L
Linus Torvalds 已提交
3123 3124 3125

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

A
Al Viro 已提交
3126
extern int readlink_copy(char __user *, int, const char *);
L
Linus Torvalds 已提交
3127
extern int page_readlink(struct dentry *, char __user *, int);
3128 3129 3130
extern const char *page_get_link(struct dentry *, struct inode *,
				 struct delayed_call *);
extern void page_put_link(void *);
3131
extern int __page_symlink(struct inode *inode, const char *symname, int len,
3132
		int nofs);
L
Linus Torvalds 已提交
3133
extern int page_symlink(struct inode *inode, const char *symname, int len);
3134
extern const struct inode_operations page_symlink_inode_operations;
3135
extern void kfree_link(void *);
L
Linus Torvalds 已提交
3136
extern void generic_fillattr(struct inode *, struct kstat *);
3137 3138
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);
3139
void __inode_add_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3140
void inode_add_bytes(struct inode *inode, loff_t bytes);
3141
void __inode_sub_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3142
void inode_sub_bytes(struct inode *inode, loff_t bytes);
J
Jan Kara 已提交
3143 3144 3145 3146
static inline loff_t __inode_get_bytes(struct inode *inode)
{
	return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
}
L
Linus Torvalds 已提交
3147 3148
loff_t inode_get_bytes(struct inode *inode);
void inode_set_bytes(struct inode *inode, loff_t bytes);
3149 3150
const char *simple_get_link(struct dentry *, struct inode *,
			    struct delayed_call *);
A
Al Viro 已提交
3151
extern const struct inode_operations simple_symlink_inode_operations;
L
Linus Torvalds 已提交
3152

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

3155 3156 3157 3158 3159
extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);

static inline int vfs_stat(const char __user *filename, struct kstat *stat)
{
3160 3161
	return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
			 stat, STATX_BASIC_STATS);
3162 3163 3164
}
static inline int vfs_lstat(const char __user *name, struct kstat *stat)
{
3165
	return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3166 3167 3168 3169 3170
			 stat, STATX_BASIC_STATS);
}
static inline int vfs_fstatat(int dfd, const char __user *filename,
			      struct kstat *stat, int flags)
{
3171 3172
	return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
			 stat, STATX_BASIC_STATS);
3173 3174 3175 3176 3177 3178 3179
}
static inline int vfs_fstat(int fd, struct kstat *stat)
{
	return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
}


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

3183
extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3184
extern void put_filesystem(struct file_system_type *fs);
L
Linus Torvalds 已提交
3185 3186
extern struct file_system_type *get_fs_type(const char *name);
extern struct super_block *get_super(struct block_device *);
3187
extern struct super_block *get_super_thawed(struct block_device *);
3188
extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3189
extern struct super_block *get_active_super(struct block_device *bdev);
L
Linus Torvalds 已提交
3190
extern void drop_super(struct super_block *sb);
3191
extern void drop_super_exclusive(struct super_block *sb);
A
Al Viro 已提交
3192
extern void iterate_supers(void (*)(struct super_block *, void *), void *);
A
Al Viro 已提交
3193 3194
extern void iterate_supers_type(struct file_system_type *,
			        void (*)(struct super_block *, void *), void *);
L
Linus Torvalds 已提交
3195 3196 3197 3198

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);
3199
extern int dcache_readdir(struct file *, struct dir_context *);
3200
extern int simple_setattr(struct dentry *, struct iattr *);
3201
extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3202
extern int simple_statfs(struct dentry *, struct kstatfs *);
S
Stephen Boyd 已提交
3203
extern int simple_open(struct inode *inode, struct file *file);
L
Linus Torvalds 已提交
3204 3205 3206
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 *);
3207 3208
extern int simple_rename(struct inode *, struct dentry *,
			 struct inode *, struct dentry *, unsigned int);
3209 3210
extern void simple_recursive_removal(struct dentry *,
                              void (*callback)(struct dentry *));
3211
extern int noop_fsync(struct file *, loff_t, loff_t, int);
3212 3213 3214 3215
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 已提交
3216 3217
extern int simple_empty(struct dentry *);
extern int simple_readpage(struct file *file, struct page *page);
3218 3219 3220 3221 3222 3223
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);
3224
extern int always_delete_dentry(const struct dentry *);
A
Al Viro 已提交
3225
extern struct inode *alloc_anon_inode(struct super_block *);
3226
extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3227
extern const struct dentry_operations simple_dentry_operations;
L
Linus Torvalds 已提交
3228

A
Al Viro 已提交
3229
extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
L
Linus Torvalds 已提交
3230
extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3231
extern const struct file_operations simple_dir_operations;
3232
extern const struct inode_operations simple_dir_inode_operations;
3233 3234
extern void make_empty_dir_inode(struct inode *inode);
extern bool is_empty_dir_inode(struct inode *inode);
3235
struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
L
Linus Torvalds 已提交
3236
struct dentry *d_alloc_name(struct dentry *, const char *);
3237 3238
extern int simple_fill_super(struct super_block *, unsigned long,
			     const struct tree_descr *);
3239
extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
L
Linus Torvalds 已提交
3240 3241
extern void simple_release_fs(struct vfsmount **mount, int *count);

3242 3243
extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
			loff_t *ppos, const void *from, size_t available);
3244 3245
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 已提交
3246

3247
extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3248
extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
A
Al Viro 已提交
3249

3250 3251
extern int generic_check_addressable(unsigned, u64);

3252
#ifdef CONFIG_MIGRATION
3253
extern int buffer_migrate_page(struct address_space *,
3254 3255
				struct page *, struct page *,
				enum migrate_mode);
3256 3257 3258
extern int buffer_migrate_page_norefs(struct address_space *,
				struct page *, struct page *,
				enum migrate_mode);
3259 3260
#else
#define buffer_migrate_page NULL
3261
#define buffer_migrate_page_norefs NULL
3262 3263
#endif

3264
extern int setattr_prepare(struct dentry *, struct iattr *);
N
npiggin@suse.de 已提交
3265
extern int inode_newsize_ok(const struct inode *, loff_t offset);
C
Christoph Hellwig 已提交
3266
extern void setattr_copy(struct inode *inode, const struct iattr *attr);
L
Linus Torvalds 已提交
3267

3268
extern int file_update_time(struct file *file);
L
Linus Torvalds 已提交
3269

3270
static inline bool vma_is_dax(const struct vm_area_struct *vma)
3271 3272 3273 3274
{
	return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
}

3275 3276 3277 3278 3279 3280 3281 3282 3283
static inline bool vma_is_fsdax(struct vm_area_struct *vma)
{
	struct inode *inode;

	if (!vma->vm_file)
		return false;
	if (!vma_is_dax(vma))
		return false;
	inode = file_inode(vma->vm_file);
D
Dan Williams 已提交
3284
	if (S_ISCHR(inode->i_mode))
3285 3286 3287 3288
		return false; /* device-dax */
	return true;
}

3289 3290 3291 3292 3293
static inline int iocb_flags(struct file *file)
{
	int res = 0;
	if (file->f_flags & O_APPEND)
		res |= IOCB_APPEND;
3294
	if (file->f_flags & O_DIRECT)
3295
		res |= IOCB_DIRECT;
3296 3297 3298 3299
	if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
		res |= IOCB_DSYNC;
	if (file->f_flags & __O_SYNC)
		res |= IOCB_SYNC;
3300 3301 3302
	return res;
}

C
Christoph Hellwig 已提交
3303
static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3304
{
3305 3306 3307 3308
	int kiocb_flags = 0;

	if (!flags)
		return 0;
3309 3310 3311
	if (unlikely(flags & ~RWF_SUPPORTED))
		return -EOPNOTSUPP;

3312
	if (flags & RWF_NOWAIT) {
3313
		if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3314
			return -EOPNOTSUPP;
3315
		kiocb_flags |= IOCB_NOWAIT;
3316
	}
3317
	if (flags & RWF_HIPRI)
3318
		kiocb_flags |= IOCB_HIPRI;
3319
	if (flags & RWF_DSYNC)
3320
		kiocb_flags |= IOCB_DSYNC;
3321
	if (flags & RWF_SYNC)
3322
		kiocb_flags |= (IOCB_DSYNC | IOCB_SYNC);
J
Jürg Billeter 已提交
3323
	if (flags & RWF_APPEND)
3324 3325 3326
		kiocb_flags |= IOCB_APPEND;

	ki->ki_flags |= kiocb_flags;
3327 3328 3329
	return 0;
}

L
Linus Torvalds 已提交
3330 3331 3332 3333
static inline ino_t parent_ino(struct dentry *dentry)
{
	ino_t res;

N
Nick Piggin 已提交
3334 3335 3336 3337
	/*
	 * 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 已提交
3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362
	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;
	char data[0];
};

#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);

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

3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386
/*
 * 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);	\
}									\
3387
static const struct file_operations __fops = {				\
3388 3389
	.owner	 = THIS_MODULE,						\
	.open	 = __fops ## _open,					\
3390
	.release = simple_attr_release,					\
3391 3392
	.read	 = simple_attr_read,					\
	.write	 = simple_attr_write,					\
3393
	.llseek	 = generic_file_llseek,					\
3394
}
3395

3396 3397
static inline __printf(1, 2)
void __simple_attr_check_format(const char *fmt, ...)
3398 3399 3400 3401 3402
{
	/* don't do anything, just let the compiler check the arguments; */
}

int simple_attr_open(struct inode *inode, struct file *file,
3403
		     int (*get)(void *, u64 *), int (*set)(void *, u64),
3404
		     const char *fmt);
3405
int simple_attr_release(struct inode *inode, struct file *file);
3406 3407 3408 3409 3410
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 已提交
3411
struct ctl_table;
3412
int proc_nr_files(struct ctl_table *table, int write,
3413
		  void *buffer, size_t *lenp, loff_t *ppos);
3414
int proc_nr_dentry(struct ctl_table *table, int write,
3415
		  void *buffer, size_t *lenp, loff_t *ppos);
3416
int proc_nr_inodes(struct ctl_table *table, int write,
3417
		   void *buffer, size_t *lenp, loff_t *ppos);
3418
int __init get_filesystem_list(char *buf);
3419

N
Namhyung Kim 已提交
3420
#define __FMODE_EXEC		((__force int) FMODE_EXEC)
3421 3422
#define __FMODE_NONOTIFY	((__force int) FMODE_NONOTIFY)

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

Y
Yaowei Bai 已提交
3427
static inline bool is_sxid(umode_t mode)
3428 3429 3430 3431
{
	return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
}

M
Miklos Szeredi 已提交
3432 3433 3434 3435 3436 3437 3438 3439
static inline int check_sticky(struct inode *dir, struct inode *inode)
{
	if (!(dir->i_mode & S_ISVTX))
		return 0;

	return __check_sticky(dir, inode);
}

3440 3441
static inline void inode_has_no_xattr(struct inode *inode)
{
3442
	if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3443 3444 3445
		inode->i_flags |= S_NOSEC;
}

A
Al Viro 已提交
3446 3447 3448 3449 3450
static inline bool is_root_inode(struct inode *inode)
{
	return inode == inode->i_sb->s_root->d_inode;
}

3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480
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 已提交
3481 3482
static inline bool dir_relax(struct inode *inode)
{
A
Al Viro 已提交
3483 3484
	inode_unlock(inode);
	inode_lock(inode);
A
Al Viro 已提交
3485 3486
	return !IS_DEADDIR(inode);
}
3487

A
Al Viro 已提交
3488 3489 3490 3491 3492 3493 3494
static inline bool dir_relax_shared(struct inode *inode)
{
	inode_unlock_shared(inode);
	inode_lock_shared(inode);
	return !IS_DEADDIR(inode);
}

3495
extern bool path_noexec(const struct path *path);
3496
extern void inode_nohighmem(struct inode *inode);
3497

3498 3499 3500
/* mm/fadvise.c */
extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
		       int advice);
J
Jan Kara 已提交
3501 3502
extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
			   int advice);
3503

J
Jens Axboe 已提交
3504 3505 3506 3507 3508 3509 3510 3511 3512
#if defined(CONFIG_IO_URING)
extern struct sock *io_uring_get_socket(struct file *file);
#else
static inline struct sock *io_uring_get_socket(struct file *file)
{
	return NULL;
}
#endif

3513 3514 3515
int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
			     unsigned int flags);

3516 3517 3518 3519 3520 3521 3522 3523 3524
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;
}

3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535
/*
 * 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 已提交
3536
#endif /* _LINUX_FS_H */