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

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

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

47
struct backing_dev_info;
48
struct bdi_writeback;
49
struct bio;
50
struct export_operations;
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_description;
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

D
David Howells 已提交
178 179 180 181 182 183 184 185
/*
 * 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 已提交
186 187 188 189
/*
 * Attribute flags.  These should be or-ed together to figure out what
 * has been changed!
 */
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
#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)
206
#define ATTR_TOUCH	(1 << 17)
L
Linus Torvalds 已提交
207

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

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

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

247 248 249 250 251 252
/*
 * Maximum number of layers of fs stack.  Needs to be limited to
 * prevent kernel stack overflow
 */
#define FILESYSTEM_MAX_STACK_DEPTH 2

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

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

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

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

309
#define IOCB_EVENTFD		(1 << 0)
310 311
#define IOCB_APPEND		(1 << 1)
#define IOCB_DIRECT		(1 << 2)
312
#define IOCB_HIPRI		(1 << 3)
313 314
#define IOCB_DSYNC		(1 << 4)
#define IOCB_SYNC		(1 << 5)
315
#define IOCB_WRITE		(1 << 6)
316
#define IOCB_NOWAIT		(1 << 7)
317 318 319

struct kiocb {
	struct file		*ki_filp;
320 321 322 323

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

324 325 326 327
	loff_t			ki_pos;
	void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
	void			*private;
	int			ki_flags;
328
	u16			ki_hint;
A
Adam Manzanares 已提交
329
	u16			ki_ioprio; /* See linux/ioprio.h */
330
	unsigned int		ki_cookie; /* for ->iopoll */
331 332 333

	randomized_struct_fields_end
};
334 335 336 337 338 339

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

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
/*
 * "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 已提交
361

L
Linus Torvalds 已提交
362 363 364 365 366 367 368
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 *);

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

372 373 374 375
	/*
	 * Reads in the requested pages. Unlike ->readpage(), this is
	 * PURELY used for read-ahead!.
	 */
L
Linus Torvalds 已提交
376 377 378
	int (*readpages)(struct file *filp, struct address_space *mapping,
			struct list_head *pages, unsigned nr_pages);

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

	/* swapfile support */
407 408 409
	int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
				sector_t *span);
	void (*swap_deactivate)(struct file *file);
L
Linus Torvalds 已提交
410 411
};

J
Jens Axboe 已提交
412 413
extern const struct address_space_operations empty_aops;

414 415 416 417 418 419 420 421 422 423 424 425
/*
 * 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);

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
/**
 * 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.
 * @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 已提交
444
struct address_space {
445 446 447 448 449 450 451
	struct inode		*host;
	struct xarray		i_pages;
	gfp_t			gfp_mask;
	atomic_t		i_mmap_writable;
	struct rb_root_cached	i_mmap;
	struct rw_semaphore	i_mmap_rwsem;
	unsigned long		nrpages;
452
	unsigned long		nrexceptional;
453 454 455
	pgoff_t			writeback_index;
	const struct address_space_operations *a_ops;
	unsigned long		flags;
456
	errseq_t		wb_err;
457 458 459
	spinlock_t		private_lock;
	struct list_head	private_list;
	void			*private_data;
460
} __attribute__((aligned(sizeof(long)))) __randomize_layout;
L
Linus Torvalds 已提交
461 462
	/*
	 * On most architectures that alignment is already the case; but
L
Lucas De Marchi 已提交
463
	 * must be enforced here for CRIS, to let the least significant bit
L
Linus Torvalds 已提交
464 465
	 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
	 */
466
struct request_queue;
L
Linus Torvalds 已提交
467 468 469

struct block_device {
	dev_t			bd_dev;  /* not a kdev_t - it's a search key */
470
	int			bd_openers;
L
Linus Torvalds 已提交
471
	struct inode *		bd_inode;	/* will die */
472
	struct super_block *	bd_super;
473
	struct mutex		bd_mutex;	/* open/close mutex */
474
	void *			bd_claiming;
L
Linus Torvalds 已提交
475 476
	void *			bd_holder;
	int			bd_holders;
477
	bool			bd_write_holder;
478
#ifdef CONFIG_SYSFS
479
	struct list_head	bd_holder_disks;
480
#endif
L
Linus Torvalds 已提交
481 482
	struct block_device *	bd_contains;
	unsigned		bd_block_size;
483
	u8			bd_partno;
L
Linus Torvalds 已提交
484 485 486 487 488
	struct hd_struct *	bd_part;
	/* number of times partitions within this device have been opened. */
	unsigned		bd_part_count;
	int			bd_invalidated;
	struct gendisk *	bd_disk;
489
	struct request_queue *  bd_queue;
490
	struct backing_dev_info *bd_bdi;
L
Linus Torvalds 已提交
491 492 493 494 495 496 497 498
	struct list_head	bd_list;
	/*
	 * Private data.  You must have bd_claim'ed the block_device
	 * to use this.  NOTE:  bd_claim allows an owner to claim
	 * the same device multiple times, the owner must take special
	 * care to not mess up bd_private for that case.
	 */
	unsigned long		bd_private;
499 500 501 502 503

	/* The counter of freeze processes */
	int			bd_fsfreeze_count;
	/* Mutex for freeze */
	struct mutex		bd_fsfreeze_mutex;
504
} __randomize_layout;
L
Linus Torvalds 已提交
505

506 507 508 509 510
/* 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 已提交
511
/*
512
 * Returns true if any of the pages in the mapping are marked with the tag.
L
Linus Torvalds 已提交
513
 */
514 515 516 517
static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
{
	return xa_marked(&mapping->i_pages, tag);
}
L
Linus Torvalds 已提交
518

519 520
static inline void i_mmap_lock_write(struct address_space *mapping)
{
521
	down_write(&mapping->i_mmap_rwsem);
522 523 524 525
}

static inline void i_mmap_unlock_write(struct address_space *mapping)
{
526
	up_write(&mapping->i_mmap_rwsem);
527 528
}

D
Davidlohr Bueso 已提交
529 530 531 532 533 534 535 536 537 538
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 已提交
539 540 541 542 543
/*
 * Might pages of this file be mapped into userspace?
 */
static inline int mapping_mapped(struct address_space *mapping)
{
544
	return	!RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
L
Linus Torvalds 已提交
545 546 547 548 549 550 551
}

/*
 * Might pages of this file have been modified in userspace?
 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
 * 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.
552 553 554
 *
 * 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 已提交
555 556 557
 */
static inline int mapping_writably_mapped(struct address_space *mapping)
{
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
	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 已提交
581 582 583 584 585 586 587 588 589 590 591 592 593
}

/*
 * 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 已提交
594 595
struct posix_acl;
#define ACL_NOT_CACHED ((void *)(-1))
596
#define ACL_DONT_CACHE ((void *)(-3))
A
Al Viro 已提交
597

598 599 600 601 602 603 604 605 606 607 608 609
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;
}

610 611 612
#define IOP_FASTPERM	0x0001
#define IOP_LOOKUP	0x0002
#define IOP_NOFOLLOW	0x0004
613
#define IOP_XATTR	0x0008
614
#define IOP_DEFAULT_READLINK	0x0010
615

616 617
struct fsnotify_mark_connector;

618 619 620 621 622
/*
 * 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 已提交
623
struct inode {
624
	umode_t			i_mode;
625
	unsigned short		i_opflags;
626 627
	kuid_t			i_uid;
	kgid_t			i_gid;
628 629 630 631 632 633 634
	unsigned int		i_flags;

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

635 636
	const struct inode_operations	*i_op;
	struct super_block	*i_sb;
637
	struct address_space	*i_mapping;
638

639 640 641
#ifdef CONFIG_SECURITY
	void			*i_security;
#endif
642

643 644
	/* Stat data, not accessed from path walking */
	unsigned long		i_ino;
M
Miklos Szeredi 已提交
645 646 647 648 649 650 651 652 653 654 655
	/*
	 * 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;
	};
656
	dev_t			i_rdev;
657
	loff_t			i_size;
658 659 660
	struct timespec64	i_atime;
	struct timespec64	i_mtime;
	struct timespec64	i_ctime;
661 662
	spinlock_t		i_lock;	/* i_blocks, i_bytes, maybe i_size */
	unsigned short          i_bytes;
663 664
	u8			i_blkbits;
	u8			i_write_hint;
665 666 667 668 669 670 671 672
	blkcnt_t		i_blocks;

#ifdef __NEED_I_SIZE_ORDERED
	seqcount_t		i_size_seqcount;
#endif

	/* Misc */
	unsigned long		i_state;
673
	struct rw_semaphore	i_rwsem;
674

675
	unsigned long		dirtied_when;	/* jiffies of first dirtying */
676
	unsigned long		dirtied_time_when;
677

L
Linus Torvalds 已提交
678
	struct hlist_node	i_hash;
679
	struct list_head	i_io_list;	/* backing dev IO list */
680 681
#ifdef CONFIG_CGROUP_WRITEBACK
	struct bdi_writeback	*i_wb;		/* the associated cgroup wb */
682 683 684 685 686

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

	__u32			i_generation;

719 720
#ifdef CONFIG_FSNOTIFY
	__u32			i_fsnotify_mask; /* all events this inode cares about */
721
	struct fsnotify_mark_connector __rcu	*i_fsnotify_marks;
R
Robert Love 已提交
722 723
#endif

724
#ifdef CONFIG_FS_ENCRYPTION
725 726 727
	struct fscrypt_info	*i_crypt_info;
#endif

728 729 730 731
#ifdef CONFIG_FS_VERITY
	struct fsverity_info	*i_verity_info;
#endif

732
	void			*i_private; /* fs or device private pointer */
733
} __randomize_layout;
L
Linus Torvalds 已提交
734

735 736
struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);

F
Fabian Frederick 已提交
737 738 739 740 741
static inline unsigned int i_blocksize(const struct inode *node)
{
	return (1 << node->i_blkbits);
}

A
Al Viro 已提交
742 743 744 745 746
static inline int inode_unhashed(struct inode *inode)
{
	return hlist_unhashed(&inode->i_hash);
}

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

A
Al Viro 已提交
784 785
static inline void inode_lock(struct inode *inode)
{
786
	down_write(&inode->i_rwsem);
A
Al Viro 已提交
787 788 789 790
}

static inline void inode_unlock(struct inode *inode)
{
791 792 793 794 795 796 797 798 799 800 801
	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 已提交
802 803 804 805
}

static inline int inode_trylock(struct inode *inode)
{
806 807 808 809 810 811
	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 已提交
812 813 814 815
}

static inline int inode_is_locked(struct inode *inode)
{
816
	return rwsem_is_locked(&inode->i_rwsem);
A
Al Viro 已提交
817 818 819 820
}

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

824 825 826 827 828
static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
{
	down_read_nested(&inode->i_rwsem, subclass);
}

829 830 831
void lock_two_nondirectories(struct inode *, struct inode*);
void unlock_two_nondirectories(struct inode *, struct inode*);

L
Linus Torvalds 已提交
832 833 834 835 836 837 838 839 840 841
/*
 * 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 已提交
842
static inline loff_t i_size_read(const struct inode *inode)
L
Linus Torvalds 已提交
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
{
#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;
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
	loff_t i_size;

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

865 866 867 868 869
/*
 * 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 已提交
870 871 872
static inline void i_size_write(struct inode *inode, loff_t i_size)
{
#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
873
	preempt_disable();
L
Linus Torvalds 已提交
874 875 876
	write_seqcount_begin(&inode->i_size_seqcount);
	inode->i_size = i_size;
	write_seqcount_end(&inode->i_size_seqcount);
877
	preempt_enable();
L
Linus Torvalds 已提交
878 879 880 881 882 883 884 885 886
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
	preempt_disable();
	inode->i_size = i_size;
	preempt_enable();
#else
	inode->i_size = i_size;
#endif
}

J
Jan Engelhardt 已提交
887
static inline unsigned iminor(const struct inode *inode)
L
Linus Torvalds 已提交
888 889 890 891
{
	return MINOR(inode->i_rdev);
}

J
Jan Engelhardt 已提交
892
static inline unsigned imajor(const struct inode *inode)
L
Linus Torvalds 已提交
893 894 895 896 897 898 899 900
{
	return MAJOR(inode->i_rdev);
}

extern struct block_device *I_BDEV(struct inode *inode);

struct fown_struct {
	rwlock_t lock;          /* protects pid, uid, euid fields */
901 902
	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 */
903
	kuid_t uid, euid;	/* uid/euid of process setting the owner */
L
Linus Torvalds 已提交
904 905 906 907 908 909 910
	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 已提交
911 912 913
	pgoff_t start;			/* where readahead started */
	unsigned int size;		/* # of readahead pages */
	unsigned int async_size;	/* do asynchronous readahead when
914
					   there are only # of pages ahead */
915

F
Fengguang Wu 已提交
916
	unsigned int ra_pages;		/* Maximum readahead window */
917
	unsigned int mmap_miss;		/* Cache miss stat for mmap accesses */
918
	loff_t prev_pos;		/* Cache last read() position */
L
Linus Torvalds 已提交
919 920
};

921 922 923 924 925
/*
 * Check if @index falls in the readahead windows.
 */
static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
{
926 927
	return (index >= ra->start &&
		index <  ra->start + ra->size);
928 929
}

L
Linus Torvalds 已提交
930
struct file {
E
Eric Dumazet 已提交
931
	union {
932
		struct llist_node	fu_llist;
E
Eric Dumazet 已提交
933 934
		struct rcu_head 	fu_rcuhead;
	} f_u;
935
	struct path		f_path;
936
	struct inode		*f_inode;	/* cached value */
937
	const struct file_operations	*f_op;
938 939

	/*
940
	 * Protects f_ep_links, f_flags.
941 942 943
	 * Must not be taken from IRQ context.
	 */
	spinlock_t		f_lock;
944
	enum rw_hint		f_write_hint;
A
Al Viro 已提交
945
	atomic_long_t		f_count;
L
Linus Torvalds 已提交
946
	unsigned int 		f_flags;
947
	fmode_t			f_mode;
948
	struct mutex		f_pos_lock;
L
Linus Torvalds 已提交
949 950
	loff_t			f_pos;
	struct fown_struct	f_owner;
D
David Howells 已提交
951
	const struct cred	*f_cred;
L
Linus Torvalds 已提交
952 953
	struct file_ra_state	f_ra;

954
	u64			f_version;
955
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
956
	void			*f_security;
957
#endif
L
Linus Torvalds 已提交
958 959 960 961 962 963
	/* 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 已提交
964
	struct list_head	f_tfile_llink;
L
Linus Torvalds 已提交
965 966
#endif /* #ifdef CONFIG_EPOLL */
	struct address_space	*f_mapping;
967
	errseq_t		f_wb_err;
968 969
} __randomize_layout
  __attribute__((aligned(4)));	/* lest something weird decides that 2 is OK */
L
Linus Torvalds 已提交
970

971 972 973 974 975 976 977
struct file_handle {
	__u32 handle_bytes;
	int handle_type;
	/* file identifier */
	unsigned char f_handle[0];
};

A
Al Viro 已提交
978 979 980 981 982
static inline struct file *get_file(struct file *f)
{
	atomic_long_inc(&f->f_count);
	return f;
}
J
Jens Axboe 已提交
983 984 985
#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 已提交
986
#define file_count(x)	atomic_long_read(&(x)->f_count)
L
Linus Torvalds 已提交
987 988 989 990 991 992

#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
993
#define MAX_LFS_FILESIZE	((loff_t)ULONG_MAX << PAGE_SHIFT)
L
Linus Torvalds 已提交
994
#elif BITS_PER_LONG==64
995
#define MAX_LFS_FILESIZE 	((loff_t)LLONG_MAX)
L
Linus Torvalds 已提交
996 997 998 999
#endif

#define FL_POSIX	1
#define FL_FLOCK	2
1000
#define FL_DELEG	4	/* NFSv4 delegation */
L
Linus Torvalds 已提交
1001
#define FL_ACCESS	8	/* not trying to lock, just looking */
1002
#define FL_EXISTS	16	/* when unlocking, test for existence */
L
Linus Torvalds 已提交
1003
#define FL_LEASE	32	/* lease held on this file */
1004
#define FL_CLOSE	64	/* unlock on close */
L
Linus Torvalds 已提交
1005
#define FL_SLEEP	128	/* A blocking lock */
1006 1007
#define FL_DOWNGRADE_PENDING	256 /* Lease is being downgraded */
#define FL_UNLOCK_PENDING	512 /* Lease is being broken */
1008
#define FL_OFDLCK	1024	/* lock is "owned" by struct file */
C
Christoph Hellwig 已提交
1009
#define FL_LAYOUT	2048	/* outstanding pNFS layout */
L
Linus Torvalds 已提交
1010

1011 1012
#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)

1013 1014 1015 1016 1017 1018
/*
 * Special return value from posix_lock_file() and vfs_lock_file() for
 * asynchronous locking.
 */
#define FILE_LOCK_DEFERRED 1

1019
/* legacy typedef, should eventually be removed */
1020
typedef void *fl_owner_t;
L
Linus Torvalds 已提交
1021

1022 1023
struct file_lock;

L
Linus Torvalds 已提交
1024 1025 1026 1027 1028 1029
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 {
1030 1031
	fl_owner_t (*lm_get_owner)(fl_owner_t);
	void (*lm_put_owner)(fl_owner_t);
J
J. Bruce Fields 已提交
1032
	void (*lm_notify)(struct file_lock *);	/* unblock callback */
1033
	int (*lm_grant)(struct file_lock *, int);
J
Jeff Layton 已提交
1034
	bool (*lm_break)(struct file_lock *);
1035
	int (*lm_change)(struct file_lock *, int, struct list_head *);
1036
	void (*lm_setup)(struct file_lock *, void **);
L
Linus Torvalds 已提交
1037 1038
};

1039 1040
struct lock_manager {
	struct list_head list;
1041 1042 1043 1044 1045
	/*
	 * NFSv4 and up also want opens blocked during the grace period;
	 * NLM doesn't care:
	 */
	bool block_opens;
1046 1047
};

1048 1049
struct net;
void locks_start_grace(struct net *, struct lock_manager *);
1050
void locks_end_grace(struct lock_manager *);
C
Corentin Labbe 已提交
1051 1052
bool locks_in_grace(struct net *);
bool opens_in_grace(struct net *);
1053

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

1057 1058 1059 1060 1061 1062 1063 1064 1065
/*
 * 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?
 *
1066
 * The varous i_flctx lists are ordered by:
1067
 *
1068 1069 1070
 * 1) lock owner
 * 2) lock range start
 * 3) lock range end
1071 1072 1073
 *
 * Obviously, the last two criteria only matter for POSIX locks.
 */
L
Linus Torvalds 已提交
1074
struct file_lock {
1075
	struct file_lock *fl_blocker;	/* The lock, that is blocking us */
1076
	struct list_head fl_list;	/* link into file_lock_context */
1077
	struct hlist_node fl_link;	/* node in global lists */
1078 1079 1080 1081 1082 1083
	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 已提交
1084
	fl_owner_t fl_owner;
1085
	unsigned int fl_flags;
1086
	unsigned char fl_type;
L
Linus Torvalds 已提交
1087
	unsigned int fl_pid;
1088
	int fl_link_cpu;		/* what cpu's list is this on? */
L
Linus Torvalds 已提交
1089 1090 1091 1092 1093 1094
	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 */
1095 1096 1097
	/* for lease breaks: */
	unsigned long fl_break_time;
	unsigned long fl_downgrade_time;
L
Linus Torvalds 已提交
1098

1099
	const struct file_lock_operations *fl_ops;	/* Callbacks for filesystems */
1100
	const struct lock_manager_operations *fl_lmops;	/* Callbacks for lockmanagers */
L
Linus Torvalds 已提交
1101 1102
	union {
		struct nfs_lock_info	nfs_fl;
1103
		struct nfs4_lock_info	nfs4_fl;
D
David Howells 已提交
1104 1105 1106
		struct {
			struct list_head link;	/* link in AFS vnode's pending_locks list */
			int state;		/* state of grant or error if -ve */
1107
			unsigned int	debug_id;
D
David Howells 已提交
1108
		} afs;
L
Linus Torvalds 已提交
1109
	} fl_u;
1110
} __randomize_layout;
L
Linus Torvalds 已提交
1111

1112
struct file_lock_context {
1113
	spinlock_t		flc_lock;
1114
	struct list_head	flc_flock;
1115
	struct list_head	flc_posix;
1116
	struct list_head	flc_lease;
1117 1118
};

L
Linus Torvalds 已提交
1119 1120 1121 1122 1123 1124 1125
/* 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

1126 1127
extern void send_sigio(struct fown_struct *fown, int fd, int band);

1128
#define locks_inode(f) file_inode(f)
1129

1130
#ifdef CONFIG_FILE_LOCKING
1131
extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1132
extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1133
			struct flock *);
L
Linus Torvalds 已提交
1134 1135

#if BITS_PER_LONG == 32
1136
extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1137
extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1138
			struct flock64 *);
L
Linus Torvalds 已提交
1139 1140 1141 1142 1143 1144
#endif

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

/* fs/locks.c */
1145
void locks_free_lock_context(struct inode *inode);
1146
void locks_free_lock(struct file_lock *fl);
L
Linus Torvalds 已提交
1147
extern void locks_init_lock(struct file_lock *);
1148
extern struct file_lock * locks_alloc_lock(void);
L
Linus Torvalds 已提交
1149
extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1150
extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
L
Linus Torvalds 已提交
1151
extern void locks_remove_posix(struct file *, fl_owner_t);
1152
extern void locks_remove_file(struct file *);
1153
extern void locks_release_private(struct file_lock *);
1154
extern void posix_test_lock(struct file *, struct file_lock *);
1155
extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1156
extern int locks_delete_block(struct file_lock *);
1157
extern int vfs_test_lock(struct file *, struct file_lock *);
1158
extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
M
Marc Eshel 已提交
1159
extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1160
extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J
J. Bruce Fields 已提交
1161
extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1162
extern void lease_get_mtime(struct inode *, struct timespec64 *time);
1163 1164
extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1165
extern int lease_modify(struct file_lock *, int, struct list_head *);
1166 1167 1168
struct files_struct;
extern void show_fd_locks(struct seq_file *f,
			 struct file *filp, struct files_struct *files);
1169
#else /* !CONFIG_FILE_LOCKING */
1170 1171
static inline int fcntl_getlk(struct file *file, unsigned int cmd,
			      struct flock __user *user)
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
{
	return -EINVAL;
}

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

1182
#if BITS_PER_LONG == 32
1183 1184
static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
				struct flock64 __user *user)
1185 1186 1187 1188 1189 1190 1191 1192 1193
{
	return -EINVAL;
}

static inline int fcntl_setlk64(unsigned int fd, struct file *file,
				unsigned int cmd, struct flock64 __user *user)
{
	return -EACCES;
}
1194
#endif
1195 1196
static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
{
1197
	return -EINVAL;
1198 1199 1200 1201
}

static inline int fcntl_getlease(struct file *filp)
{
1202
	return F_UNLCK;
1203 1204
}

1205
static inline void
1206
locks_free_lock_context(struct inode *inode)
1207 1208 1209
{
}

1210 1211 1212 1213 1214
static inline void locks_init_lock(struct file_lock *fl)
{
	return;
}

1215
static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
{
	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;
}

1230
static inline void locks_remove_file(struct file *filp)
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
{
	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;
}

1246
static inline int locks_delete_block(struct file_lock *waiter)
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
{
	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;
}

1267 1268 1269 1270 1271
static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
{
	return -ENOLCK;
}

J
J. Bruce Fields 已提交
1272
static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1273 1274 1275 1276
{
	return 0;
}

1277 1278
static inline void lease_get_mtime(struct inode *inode,
				   struct timespec64 *time)
1279 1280 1281 1282 1283
{
	return;
}

static inline int generic_setlease(struct file *filp, long arg,
1284
				    struct file_lock **flp, void **priv)
1285 1286 1287 1288 1289
{
	return -EINVAL;
}

static inline int vfs_setlease(struct file *filp, long arg,
1290
			       struct file_lock **lease, void **priv)
1291 1292 1293 1294
{
	return -EINVAL;
}

1295
static inline int lease_modify(struct file_lock *fl, int arg,
1296
			       struct list_head *dispose)
1297 1298 1299
{
	return -EINVAL;
}
1300 1301 1302 1303

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

1306 1307 1308 1309 1310
static inline struct inode *file_inode(const struct file *f)
{
	return f->f_inode;
}

M
Miklos Szeredi 已提交
1311 1312
static inline struct dentry *file_dentry(const struct file *file)
{
1313
	return d_real(file->f_path.dentry, file_inode(file));
M
Miklos Szeredi 已提交
1314 1315
}

1316 1317
static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
{
1318
	return locks_lock_inode_wait(locks_inode(filp), fl);
1319 1320
}

L
Linus Torvalds 已提交
1321
struct fasync_struct {
1322
	rwlock_t		fa_lock;
1323 1324 1325 1326 1327
	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 已提交
1328 1329 1330 1331 1332 1333
};

#define FASYNC_MAGIC 0x4601

/* SMP safe fasync helpers: */
extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1334 1335 1336 1337 1338
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 已提交
1339 1340 1341
/* can be called from interrupts */
extern void kill_fasync(struct fasync_struct **, int, int);

1342
extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1343
extern int f_setown(struct file *filp, unsigned long arg, int force);
L
Linus Torvalds 已提交
1344
extern void f_delown(struct file *filp);
1345
extern pid_t f_getown(struct file *filp);
L
Linus Torvalds 已提交
1346 1347
extern int send_sigurg(struct fown_struct *fown);

1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
/*
 * 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 */
#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)
1369
#define SB_FORCE    	(1<<27)
1370 1371 1372 1373 1374
#define SB_NOSEC	(1<<28)
#define SB_BORN		(1<<29)
#define SB_ACTIVE	(1<<30)
#define SB_NOUSER	(1<<31)

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

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

1385 1386
/* sb->s_iflags */
#define SB_I_CGROUPWB	0x00000001	/* cgroup-aware writeback enabled */
1387
#define SB_I_NOEXEC	0x00000002	/* Ignore executables on this fs */
1388
#define SB_I_NODEV	0x00000004	/* Ignore devices on this fs */
1389
#define SB_I_MULTIROOT	0x00000008	/* Multiple roots to the dentry tree */
L
Linus Torvalds 已提交
1390

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

1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
/* 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 {
1409 1410 1411
	int				frozen;		/* Is sb frozen? */
	wait_queue_head_t		wait_unfrozen;	/* for get_super_thawed() */
	struct percpu_rw_semaphore	rw_sem[SB_FREEZE_LEVELS];
1412 1413
};

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

1452
	struct sb_writers	s_writers;
L
Linus Torvalds 已提交
1453

1454 1455 1456 1457 1458 1459 1460 1461 1462
	/*
	 * 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;
1463 1464 1465
	/* Time limits for c/m/atime in seconds */
	time64_t		   s_time_min;
	time64_t		   s_time_max;
1466 1467 1468 1469 1470
#ifdef CONFIG_FSNOTIFY
	__u32			s_fsnotify_mask;
	struct fsnotify_mark_connector __rcu	*s_fsnotify_marks;
#endif

1471 1472
	char			s_id[32];	/* Informational name */
	uuid_t			s_uuid;		/* UUID */
L
Linus Torvalds 已提交
1473

1474
	unsigned int		s_max_links;
1475
	fmode_t			s_mode;
L
Linus Torvalds 已提交
1476 1477 1478 1479 1480

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

M
Miklos Szeredi 已提交
1483 1484 1485 1486
	/*
	 * Filesystem subtype.  If non-empty the filesystem type field
	 * in /proc/mounts will be "type.subtype"
	 */
1487
	const char *s_subtype;
1488

A
Al Viro 已提交
1489
	const struct dentry_operations *s_d_op; /* default d_op for dentries */
1490 1491 1492 1493 1494

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

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

M
Miklos Szeredi 已提交
1498 1499 1500
	/* Number of inodes with nlink == 0 but still referenced */
	atomic_long_t s_remove_count;

1501 1502 1503
	/* Pending fsnotify inode refs */
	atomic_long_t s_fsnotify_inode_refs;

1504 1505
	/* Being remounted read-only */
	int s_readonly_remount;
1506 1507 1508

	/* AIO completions deferred from interrupt context */
	struct workqueue_struct *s_dio_done_wq;
A
Al Viro 已提交
1509
	struct hlist_head s_pins;
1510

1511 1512 1513 1514 1515 1516 1517
	/*
	 * 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;

1518
	/*
1519 1520 1521
	 * 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.
1522
	 */
1523 1524
	struct list_lru		s_dentry_lru;
	struct list_lru		s_inode_lru;
A
Al Viro 已提交
1525
	struct rcu_head		rcu;
1526
	struct work_struct	destroy_work;
1527

1528
	struct mutex		s_sync_lock;	/* sync serialisation lock */
1529 1530 1531 1532 1533

	/*
	 * Indicates how deep in a filesystem stack this SB is
	 */
	int s_stack_depth;
1534 1535 1536 1537

	/* s_inode_list_lock protects s_inodes */
	spinlock_t		s_inode_list_lock ____cacheline_aligned_in_smp;
	struct list_head	s_inodes;	/* all inodes */
1538 1539 1540

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

1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
/* 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);
}

D
Deepa Dinamani 已提交
1568
extern struct timespec64 timespec64_trunc(struct timespec64 t, unsigned gran);
1569
extern struct timespec64 current_time(struct inode *inode);
L
Linus Torvalds 已提交
1570 1571 1572 1573 1574

/*
 * Snapshotting support.
 */

1575 1576 1577
void __sb_end_write(struct super_block *sb, int level);
int __sb_start_write(struct super_block *sb, int level, bool wait);

1578
#define __sb_writers_acquired(sb, lev)	\
1579
	percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1580
#define __sb_writers_release(sb, lev)	\
1581
	percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
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 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
/**
 * 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
 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
 * handling code implies lock dependency:
 *
 * mmap_sem
 *   -> 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 已提交
1689

1690 1691 1692 1693 1694
static inline int sb_start_intwrite_trylock(struct super_block *sb)
{
	return __sb_start_write(sb, SB_FREEZE_FS, false);
}

L
Linus Torvalds 已提交
1695

1696
extern bool inode_owner_or_capable(const struct inode *inode);
1697

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

1711 1712 1713
extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
				  int open_flag);

A
Al Viro 已提交
1714 1715 1716 1717
int vfs_mkobj(struct dentry *, umode_t,
		int (*f)(struct dentry *, umode_t, void *),
		void *);

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

1720 1721 1722
/*
 * VFS file helper functions.
 */
1723
extern void inode_init_owner(struct inode *inode, const struct inode *dir,
A
Al Viro 已提交
1724
			umode_t mode);
1725
extern bool may_open_dev(const struct path *path);
M
Mark Fasheh 已提交
1726 1727 1728 1729 1730 1731 1732
/*
 * VFS FS_IOC_FIEMAP helper definitions.
 */
struct fiemap_extent_info {
	unsigned int fi_flags;		/* Flags as passed from user */
	unsigned int fi_extents_mapped;	/* Number of mapped extents */
	unsigned int fi_extents_max;	/* Size of fiemap_extent array */
1733 1734
	struct fiemap_extent __user *fi_extents_start; /* Start of
							fiemap_extent array */
M
Mark Fasheh 已提交
1735 1736 1737 1738 1739
};
int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
			    u64 phys, u64 len, u32 flags);
int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);

L
Linus Torvalds 已提交
1740 1741 1742 1743 1744 1745
/*
 * 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.
 */
1746 1747 1748 1749
struct dir_context;
typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
			 unsigned);

1750
struct dir_context {
1751
	filldir_t actor;
1752
	loff_t pos;
1753
};
1754

1755
struct block_device_operations;
L
Linus Torvalds 已提交
1756 1757 1758 1759 1760 1761 1762

/* These macros are for out of kernel modules to test that
 * the kernel supports the unlocked_ioctl and compat_ioctl
 * fields in struct file_operations. */
#define HAVE_COMPAT_IOCTL 1
#define HAVE_UNLOCKED_IOCTL 1

1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
/*
 * 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)

1782 1783 1784
/*
 * 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".
1785
 * See Documentation/filesystems/vfs.rst for more details about this call.
1786 1787
 *
 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
1788
 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
1789 1790
 */
#define REMAP_FILE_DEDUP		(1 << 0)
1791
#define REMAP_FILE_CAN_SHORTEN		(1 << 1)
1792 1793 1794 1795 1796 1797 1798 1799

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

1802 1803
struct iov_iter;

L
Linus Torvalds 已提交
1804 1805 1806 1807 1808
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 *);
1809 1810
	ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
	ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1811
	int (*iopoll)(struct kiocb *kiocb, bool spin);
1812
	int (*iterate) (struct file *, struct dir_context *);
1813
	int (*iterate_shared) (struct file *, struct dir_context *);
A
Al Viro 已提交
1814
	__poll_t (*poll) (struct file *, struct poll_table_struct *);
L
Linus Torvalds 已提交
1815 1816 1817
	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 *);
1818
	unsigned long mmap_supported_flags;
L
Linus Torvalds 已提交
1819
	int (*open) (struct inode *, struct file *);
1820
	int (*flush) (struct file *, fl_owner_t id);
L
Linus Torvalds 已提交
1821
	int (*release) (struct inode *, struct file *);
1822
	int (*fsync) (struct file *, loff_t, loff_t, int datasync);
L
Linus Torvalds 已提交
1823 1824 1825 1826 1827 1828
	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 *);
1829 1830
	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);
1831
	int (*setlease)(struct file *, long, struct file_lock **, void **);
1832 1833
	long (*fallocate)(struct file *file, int mode, loff_t offset,
			  loff_t len);
1834
	void (*show_fdinfo)(struct seq_file *m, struct file *f);
1835 1836 1837
#ifndef CONFIG_MMU
	unsigned (*mmap_capabilities)(struct file *);
#endif
1838 1839
	ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
			loff_t, size_t, unsigned int);
1840 1841 1842
	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);
1843
	int (*fadvise)(struct file *, loff_t, loff_t, int);
1844
} __randomize_layout;
L
Linus Torvalds 已提交
1845 1846

struct inode_operations {
A
Al Viro 已提交
1847
	struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1848
	const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1849
	int (*permission) (struct inode *, int);
1850
	struct posix_acl * (*get_acl)(struct inode *, int);
1851 1852 1853

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

A
Al Viro 已提交
1854
	int (*create) (struct inode *,struct dentry *, umode_t, bool);
L
Linus Torvalds 已提交
1855 1856 1857
	int (*link) (struct dentry *,struct inode *,struct dentry *);
	int (*unlink) (struct inode *,struct dentry *);
	int (*symlink) (struct inode *,struct dentry *,const char *);
1858
	int (*mkdir) (struct inode *,struct dentry *,umode_t);
L
Linus Torvalds 已提交
1859
	int (*rmdir) (struct inode *,struct dentry *);
A
Al Viro 已提交
1860
	int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
L
Linus Torvalds 已提交
1861
	int (*rename) (struct inode *, struct dentry *,
M
Miklos Szeredi 已提交
1862
			struct inode *, struct dentry *, unsigned int);
L
Linus Torvalds 已提交
1863
	int (*setattr) (struct dentry *, struct iattr *);
1864
	int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
L
Linus Torvalds 已提交
1865
	ssize_t (*listxattr) (struct dentry *, char *, size_t);
M
Mark Fasheh 已提交
1866 1867
	int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
		      u64 len);
1868
	int (*update_time)(struct inode *, struct timespec64 *, int);
A
Al Viro 已提交
1869
	int (*atomic_open)(struct inode *, struct dentry *,
A
Al Viro 已提交
1870
			   struct file *, unsigned open_flag,
1871
			   umode_t create_mode);
1872
	int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1873
	int (*set_acl)(struct inode *, struct posix_acl *, int);
1874
} ____cacheline_aligned;
L
Linus Torvalds 已提交
1875

1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
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);
}

1888 1889 1890 1891 1892
static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
{
	return file->f_op->mmap(file, vma);
}

B
Badari Pulavarty 已提交
1893
ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
C
Christopher Yeoh 已提交
1894 1895
			      unsigned long nr_segs, unsigned long fast_segs,
			      struct iovec *fast_pointer,
1896
			      struct iovec **ret_pointer);
B
Badari Pulavarty 已提交
1897

D
Dmitry Kasatkin 已提交
1898
extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
L
Linus Torvalds 已提交
1899 1900 1901
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 已提交
1902
		unsigned long, loff_t *, rwf_t);
1903 1904
extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
				   loff_t, size_t, unsigned int);
1905 1906 1907
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);
1908 1909
extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
					 struct file *file_out, loff_t pos_out,
1910 1911 1912 1913
					 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,
1914
				  loff_t len, unsigned int remap_flags);
1915 1916
extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
				   struct file *file_out, loff_t pos_out,
1917
				   loff_t len, unsigned int remap_flags);
1918 1919
extern int vfs_dedupe_file_range(struct file *file,
				 struct file_dedupe_range *same);
1920 1921
extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
					struct file *dst_file, loff_t dst_pos,
1922
					loff_t len, unsigned int remap_flags);
1923

L
Linus Torvalds 已提交
1924 1925 1926 1927

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

1930
   	void (*dirty_inode) (struct inode *, int flags);
1931
	int (*write_inode) (struct inode *, struct writeback_control *wbc);
1932
	int (*drop_inode) (struct inode *);
A
Al Viro 已提交
1933
	void (*evict_inode) (struct inode *);
L
Linus Torvalds 已提交
1934 1935
	void (*put_super) (struct super_block *);
	int (*sync_fs)(struct super_block *sb, int wait);
1936
	int (*freeze_super) (struct super_block *);
1937
	int (*freeze_fs) (struct super_block *);
1938
	int (*thaw_super) (struct super_block *);
1939
	int (*unfreeze_fs) (struct super_block *);
1940
	int (*statfs) (struct dentry *, struct kstatfs *);
L
Linus Torvalds 已提交
1941
	int (*remount_fs) (struct super_block *, int *, char *);
1942
	void (*umount_begin) (struct super_block *);
L
Linus Torvalds 已提交
1943

1944
	int (*show_options)(struct seq_file *, struct dentry *);
1945
	int (*show_devname)(struct seq_file *, struct dentry *);
1946
	int (*show_path)(struct seq_file *, struct dentry *);
1947
	int (*show_stats)(struct seq_file *, struct dentry *);
1948
#ifdef CONFIG_QUOTA
L
Linus Torvalds 已提交
1949 1950
	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);
1951
	struct dquot **(*get_dquots)(struct inode *);
1952
#endif
1953
	int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1954 1955 1956 1957
	long (*nr_cached_objects)(struct super_block *,
				  struct shrink_control *);
	long (*free_cached_objects)(struct super_block *,
				    struct shrink_control *);
L
Linus Torvalds 已提交
1958 1959
};

D
David Howells 已提交
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
/*
 * Inode flags - they have no relation to superblock flags now
 */
#define S_SYNC		1	/* Writes are synced at once */
#define S_NOATIME	2	/* Do not update access times */
#define S_APPEND	4	/* Append-only file */
#define S_IMMUTABLE	8	/* Immutable file */
#define S_DEAD		16	/* removed, but still open directory */
#define S_NOQUOTA	32	/* Inode is not counted to quota */
#define S_DIRSYNC	64	/* Directory modifications are synchronous */
#define S_NOCMTIME	128	/* Do not update file c/mtime */
#define S_SWAPFILE	256	/* Do not truncate: swapon got its bmaps */
#define S_PRIVATE	512	/* Inode is fs-internal */
#define S_IMA		1024	/* Inode has an associated IMA struct */
#define S_AUTOMOUNT	2048	/* Automount/referral quasi-directory */
#define S_NOSEC		4096	/* no suid or xattr security attributes */
1976
#ifdef CONFIG_FS_DAX
1977 1978 1979 1980
#define S_DAX		8192	/* Direct Access, avoiding the page cache */
#else
#define S_DAX		0	/* Make all the DAX code disappear */
#endif
1981
#define S_ENCRYPTED	16384	/* Encrypted file (using fs/crypto/) */
1982
#define S_CASEFOLD	32768	/* Casefolded file */
1983
#define S_VERITY	65536	/* Verity file (using fs/verity/) */
D
David Howells 已提交
1984 1985 1986 1987 1988 1989 1990

/*
 * 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.
 *
1991
 * Exception: SB_RDONLY is always applied to the entire file system.
D
David Howells 已提交
1992 1993 1994 1995 1996 1997 1998 1999
 *
 * 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))

2000
static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
2001
#define IS_RDONLY(inode)	sb_rdonly((inode)->i_sb)
2002
#define IS_SYNC(inode)		(__IS_FLG(inode, SB_SYNCHRONOUS) || \
D
David Howells 已提交
2003
					((inode)->i_flags & S_SYNC))
2004
#define IS_DIRSYNC(inode)	(__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
D
David Howells 已提交
2005
					((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
2006 2007 2008
#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 已提交
2009 2010 2011 2012

#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)
2013
#define IS_POSIXACL(inode)	__IS_FLG(inode, SB_POSIXACL)
D
David Howells 已提交
2014 2015 2016 2017 2018 2019 2020 2021

#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)
2022
#define IS_DAX(inode)		((inode)->i_flags & S_DAX)
2023
#define IS_ENCRYPTED(inode)	((inode)->i_flags & S_ENCRYPTED)
2024
#define IS_CASEFOLDED(inode)	((inode)->i_flags & S_CASEFOLD)
2025
#define IS_VERITY(inode)	((inode)->i_flags & S_VERITY)
D
David Howells 已提交
2026

M
Miklos Szeredi 已提交
2027 2028 2029
#define IS_WHITEOUT(inode)	(S_ISCHR(inode->i_mode) && \
				 (inode)->i_rdev == WHITEOUT_DEV)

2030 2031 2032 2033 2034
static inline bool HAS_UNMAPPED_ID(struct inode *inode)
{
	return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
}

2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
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);

2045 2046 2047 2048 2049 2050 2051 2052 2053
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;
}

2054 2055 2056 2057 2058
static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
{
	*kiocb = (struct kiocb) {
		.ki_filp = filp,
		.ki_flags = iocb_flags(filp),
2059
		.ki_hint = ki_hint_validate(file_write_hint(filp)),
2060
		.ki_ioprio = get_current_ioprio(),
2061 2062 2063
	};
}

J
Joern Engel 已提交
2064
/*
2065
 * Inode state bits.  Protected by inode->i_lock
J
Joern Engel 已提交
2066 2067 2068 2069 2070 2071 2072 2073
 *
 * 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 已提交
2074
 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
J
Joern Engel 已提交
2075
 *
J
Joern Engel 已提交
2076 2077
 * I_DIRTY_SYNC		Inode is dirty, but doesn't have to be written on
 *			fdatasync().  i_atime is the usual cause.
2078 2079 2080 2081
 * 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 已提交
2082
 * I_DIRTY_PAGES	Inode has dirty pages.  Inode itself may be clean.
C
Christoph Hellwig 已提交
2083 2084 2085 2086 2087 2088 2089 2090
 * 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 已提交
2091 2092 2093 2094 2095 2096
 * 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.
2097 2098
 * I_CLEAR		Added by clear_inode().  In this state the inode is
 *			clean and can be destroyed.  Inode keeps I_FREEING.
J
Joern Engel 已提交
2099 2100 2101 2102 2103
 *
 *			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 已提交
2104
 *			if appropriate.  I_NEW is used for waiting.
J
Joern Engel 已提交
2105
 *
2106 2107 2108 2109
 * 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 已提交
2110
 *
C
Christoph Hellwig 已提交
2111 2112 2113 2114
 * 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().
 *
2115 2116
 * I_WB_SWITCH		Cgroup bdi_writeback switching in progress.  Used to
 *			synchronize competing switching instances and to tell
M
Matthew Wilcox 已提交
2117
 *			wb stat updates to grab the i_pages lock.  See
2118
 *			inode_switch_wbs_work_fn() for details.
2119
 *
2120 2121 2122
 * I_OVL_INUSE		Used by overlayfs to get exclusive ownership on upper
 *			and work dirs among overlayfs mounts.
 *
A
Al Viro 已提交
2123 2124
 * I_CREATING		New object's inode in the middle of setting up.
 *
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)
L
Linus Torvalds 已提交
2147

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

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

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

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

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

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

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

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

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

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

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

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

2230
#ifdef CONFIG_BLOCK
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));
2234 2235 2236 2237 2238 2239 2240 2241
#else
static inline 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))
{
	return ERR_PTR(-ENODEV);
}
#endif
A
Al Viro 已提交
2242 2243 2244
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 已提交
2245 2246 2247
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 已提交
2248
extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
L
Linus Torvalds 已提交
2249
void generic_shutdown_super(struct super_block *sb);
2250
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
2251
void kill_block_super(struct super_block *sb);
2252 2253 2254 2255 2256 2257
#else
static inline void kill_block_super(struct super_block *sb)
{
	BUG();
}
#endif
L
Linus Torvalds 已提交
2258 2259 2260
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 已提交
2261
void deactivate_locked_super(struct super_block *sb);
L
Linus Torvalds 已提交
2262
int set_anon_super(struct super_block *s, void *data);
2263
int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2264 2265
int get_anon_bdev(dev_t *);
void free_anon_bdev(dev_t);
2266 2267 2268
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 已提交
2269 2270 2271
struct super_block *sget(struct file_system_type *type,
			int (*test)(struct super_block *,void *),
			int (*set)(struct super_block *,void *),
D
David Howells 已提交
2272
			int flags, void *data);
L
Linus Torvalds 已提交
2273 2274 2275 2276 2277 2278

/* 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)
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
/*
 * 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 已提交
2290 2291 2292

extern int register_filesystem(struct file_system_type *);
extern int unregister_filesystem(struct file_system_type *);
D
David Howells 已提交
2293
extern struct vfsmount *kern_mount(struct file_system_type *);
2294
extern void kern_unmount(struct vfsmount *mnt);
L
Linus Torvalds 已提交
2295 2296
extern int may_umount_tree(struct vfsmount *);
extern int may_umount(struct vfsmount *);
2297 2298
extern long do_mount(const char *, const char __user *,
		     const char *, unsigned long, void *);
2299
extern struct vfsmount *collect_mounts(const struct path *);
2300
extern void drop_collected_mounts(struct vfsmount *);
A
Al Viro 已提交
2301 2302
extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
			  struct vfsmount *);
A
Al Viro 已提交
2303
extern int vfs_statfs(const struct path *, struct kstatfs *);
A
Al Viro 已提交
2304 2305
extern int user_statfs(const char __user *, struct kstatfs *);
extern int fd_statfs(int, struct kstatfs *);
2306 2307
extern int freeze_super(struct super_block *super);
extern int thaw_super(struct super_block *super);
2308
extern bool our_mnt(struct vfsmount *mnt);
2309 2310 2311
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 已提交
2312

A
Al Viro 已提交
2313 2314
extern int current_umask(void);

2315 2316
extern void ihold(struct inode * inode);
extern void iput(struct inode *);
2317
extern int generic_update_time(struct inode *, struct timespec64 *, int);
2318

M
Miklos Szeredi 已提交
2319
/* /sys/fs */
2320
extern struct kobject *fs_kobj;
M
Miklos Szeredi 已提交
2321

2322
#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2323

2324
#ifdef CONFIG_MANDATORY_FILE_LOCKING
2325
extern int locks_mandatory_locked(struct file *);
2326
extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
L
Linus Torvalds 已提交
2327 2328 2329 2330 2331

/*
 * Candidates for mandatory locking have the setgid bit set
 * but no group execute bit -  an otherwise meaningless combination.
 */
2332 2333 2334 2335 2336 2337 2338

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

/*
2339
 * ... and these candidates should be on SB_MANDLOCK mounted fs,
2340 2341 2342 2343 2344 2345 2346
 * otherwise these will be advisory locks
 */

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

2348
static inline int locks_verify_locked(struct file *file)
L
Linus Torvalds 已提交
2349
{
2350
	if (mandatory_lock(locks_inode(file)))
2351
		return locks_mandatory_locked(file);
L
Linus Torvalds 已提交
2352 2353 2354 2355
	return 0;
}

static inline int locks_verify_truncate(struct inode *inode,
2356
				    struct file *f,
L
Linus Torvalds 已提交
2357 2358
				    loff_t size)
{
2359 2360 2361 2362 2363 2364 2365 2366 2367 2368
	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 已提交
2369 2370
}

2371 2372 2373 2374 2375 2376 2377
#else /* !CONFIG_MANDATORY_FILE_LOCKING */

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

2378 2379
static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
                                       loff_t start, loff_t end, unsigned char type)
2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408
{
	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 已提交
2409 2410
static inline int break_lease(struct inode *inode, unsigned int mode)
{
2411 2412
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2413 2414 2415
	 * 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.
2416 2417
	 */
	smp_mb();
2418
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2419
		return __break_lease(inode, mode, FL_LEASE);
L
Linus Torvalds 已提交
2420 2421
	return 0;
}
J
J. Bruce Fields 已提交
2422 2423 2424

static inline int break_deleg(struct inode *inode, unsigned int mode)
{
2425 2426
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2427 2428 2429
	 * 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.
2430 2431
	 */
	smp_mb();
2432
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2433
		return __break_lease(inode, mode, FL_DELEG);
L
Linus Torvalds 已提交
2434 2435
	return 0;
}
J
J. Bruce Fields 已提交
2436

2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
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 已提交
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
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;
}

2469
#else /* !CONFIG_FILE_LOCKING */
2470 2471 2472 2473 2474
static inline int break_lease(struct inode *inode, unsigned int mode)
{
	return 0;
}

J
J. Bruce Fields 已提交
2475 2476 2477 2478
static inline int break_deleg(struct inode *inode, unsigned int mode)
{
	return 0;
}
2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490

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 已提交
2491 2492 2493 2494 2495
static inline int break_layout(struct inode *inode, bool wait)
{
	return 0;
}

2496
#endif /* CONFIG_FILE_LOCKING */
L
Linus Torvalds 已提交
2497 2498

/* fs/open.c */
2499
struct audit_names;
2500
struct filename {
2501 2502
	const char		*name;	/* pointer to actual string */
	const __user char	*uptr;	/* original userland pointer */
2503
	int			refcnt;
2504
	struct audit_names	*aname;
A
Al Viro 已提交
2505
	const char		iname[];
2506
};
2507
static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
L
Linus Torvalds 已提交
2508

A
Al Viro 已提交
2509
extern long vfs_truncate(const struct path *, loff_t);
2510 2511
extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
		       struct file *filp);
2512
extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2513
			loff_t len);
J
Jason Uhlenkott 已提交
2514
extern long do_sys_open(int dfd, const char __user *filename, int flags,
2515
			umode_t mode);
2516
extern struct file *file_open_name(struct filename *, int, umode_t);
2517
extern struct file *filp_open(const char *, int, umode_t);
A
Al Viro 已提交
2518
extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2519
				   const char *, int, umode_t);
2520
extern struct file * dentry_open(const struct path *, int, const struct cred *);
A
Al Viro 已提交
2521 2522
extern struct file * open_with_fake_path(const struct path *, int,
					 struct inode*, const struct cred *);
2523 2524 2525 2526
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 已提交
2527
extern int filp_close(struct file *, fl_owner_t id);
2528

2529
extern struct filename *getname_flags(const char __user *, int, int *);
2530
extern struct filename *getname(const char __user *);
2531
extern struct filename *getname_kernel(const char *);
2532
extern void putname(struct filename *name);
2533

A
Al Viro 已提交
2534
extern int finish_open(struct file *file, struct dentry *dentry,
2535
			int (*open)(struct inode *, struct file *));
A
Al Viro 已提交
2536
extern int finish_no_open(struct file *file, struct dentry *dentry);
L
Linus Torvalds 已提交
2537

2538 2539 2540 2541
/* fs/ioctl.c */

extern int ioctl_preallocate(struct file *filp, void __user *argp);

L
Linus Torvalds 已提交
2542 2543
/* fs/dcache.c */
extern void __init vfs_caches_init_early(void);
2544
extern void __init vfs_caches_init(void);
L
Linus Torvalds 已提交
2545

2546 2547
extern struct kmem_cache *names_cachep;

2548
#define __getname()		kmem_cache_alloc(names_cachep, GFP_KERNEL)
V
Vegard Nossum 已提交
2549
#define __putname(name)		kmem_cache_free(names_cachep, (void *)(name))
L
Linus Torvalds 已提交
2550

2551
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
2552
extern int register_blkdev(unsigned int, const char *);
A
Akinobu Mita 已提交
2553
extern void unregister_blkdev(unsigned int, const char *);
2554
extern void bdev_unhash_inode(dev_t dev);
L
Linus Torvalds 已提交
2555
extern struct block_device *bdget(dev_t);
2556
extern struct block_device *bdgrab(struct block_device *bdev);
L
Linus Torvalds 已提交
2557 2558 2559
extern void bd_set_size(struct block_device *, loff_t size);
extern void bd_forget(struct inode *inode);
extern void bdput(struct block_device *);
N
Nick Piggin 已提交
2560
extern void invalidate_bdev(struct block_device *);
2561
extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
N
Nick Piggin 已提交
2562
extern int sync_blockdev(struct block_device *bdev);
A
Al Viro 已提交
2563
extern void kill_bdev(struct block_device *);
N
Nick Piggin 已提交
2564
extern struct super_block *freeze_bdev(struct block_device *);
2565
extern void emergency_thaw_all(void);
2566
extern void emergency_thaw_bdev(struct super_block *sb);
N
Nick Piggin 已提交
2567 2568
extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
extern int fsync_bdev(struct block_device *);
T
Tejun Heo 已提交
2569 2570 2571 2572 2573 2574 2575

extern struct super_block *blockdev_superblock;

static inline bool sb_is_blkdev_sb(struct super_block *sb)
{
	return sb == blockdev_superblock;
}
2576 2577
#else
static inline void bd_forget(struct inode *inode) {}
2578
static inline int sync_blockdev(struct block_device *bdev) { return 0; }
A
Al Viro 已提交
2579
static inline void kill_bdev(struct block_device *bdev) {}
2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
static inline void invalidate_bdev(struct block_device *bdev) {}

static inline struct super_block *freeze_bdev(struct block_device *sb)
{
	return NULL;
}

static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
{
	return 0;
}
2591

2592 2593 2594 2595 2596
static inline int emergency_thaw_bdev(struct super_block *sb)
{
	return 0;
}

2597 2598 2599
static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
{
}
2600

2601
static inline bool sb_is_blkdev_sb(struct super_block *sb)
2602
{
2603
	return false;
2604
}
2605
#endif
2606
extern int sync_filesystem(struct super_block *);
2607
extern const struct file_operations def_blk_fops;
2608
extern const struct file_operations def_chr_fops;
2609
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
2610
extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2611
extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
L
Linus Torvalds 已提交
2612
extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2613
extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2614 2615 2616 2617
extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
					       void *holder);
extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
					      void *holder);
2618 2619 2620 2621 2622 2623
extern struct block_device *bd_start_claiming(struct block_device *bdev,
					      void *holder);
extern void bd_finish_claiming(struct block_device *bdev,
			       struct block_device *whole, void *holder);
extern void bd_abort_claiming(struct block_device *bdev,
			      struct block_device *whole, void *holder);
A
Al Viro 已提交
2624
extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2625 2626 2627
extern int __blkdev_reread_part(struct block_device *bdev);
extern int blkdev_reread_part(struct block_device *bdev);

2628
#ifdef CONFIG_SYSFS
2629
extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2630 2631
extern void bd_unlink_disk_holder(struct block_device *bdev,
				  struct gendisk *disk);
2632
#else
2633 2634 2635 2636 2637
static inline int bd_link_disk_holder(struct block_device *bdev,
				      struct gendisk *disk)
{
	return 0;
}
2638 2639 2640 2641
static inline void bd_unlink_disk_holder(struct block_device *bdev,
					 struct gendisk *disk)
{
}
2642
#endif
2643
#endif
L
Linus Torvalds 已提交
2644 2645

/* fs/char_dev.c */
2646
#define CHRDEV_MAJOR_MAX 512
2647 2648
/* Marks the bottom of the first segment of free char majors */
#define CHRDEV_MAJOR_DYN_END 234
2649 2650 2651 2652
/* 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 已提交
2653 2654
extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
extern int register_chrdev_region(dev_t, unsigned, const char *);
2655 2656 2657 2658 2659
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 已提交
2660
extern void unregister_chrdev_region(dev_t, unsigned);
2661
extern void chrdev_show(struct seq_file *,off_t);
L
Linus Torvalds 已提交
2662

2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673
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 已提交
2674 2675
/* fs/block_dev.c */
#define BDEVNAME_SIZE	32	/* Largest string for a blockdev identifier */
2676
#define BDEVT_SIZE	10	/* Largest string for MAJ:MIN for blkdev */
2677 2678

#ifdef CONFIG_BLOCK
2679
#define BLKDEV_MAJOR_MAX	512
L
Linus Torvalds 已提交
2680 2681 2682
extern const char *__bdevname(dev_t, char *buffer);
extern const char *bdevname(struct block_device *bdev, char *buffer);
extern struct block_device *lookup_bdev(const char *);
2683
extern void blkdev_show(struct seq_file *,off_t);
2684

2685
#else
2686
#define BLKDEV_MAJOR_MAX	0
2687
#endif
L
Linus Torvalds 已提交
2688 2689 2690 2691 2692

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 *);
2693
extern bool is_bad_inode(struct inode *);
L
Linus Torvalds 已提交
2694

2695
#ifdef CONFIG_BLOCK
2696
extern void check_disk_size_change(struct gendisk *disk,
2697
		struct block_device *bdev, bool verbose);
2698
extern int revalidate_disk(struct gendisk *);
L
Linus Torvalds 已提交
2699
extern int check_disk_change(struct block_device *);
2700
extern int __invalidate_device(struct block_device *, bool);
L
Linus Torvalds 已提交
2701
extern int invalidate_partition(struct gendisk *, int);
2702
#endif
L
Linus Torvalds 已提交
2703 2704
unsigned long invalidate_mapping_pages(struct address_space *mapping,
					pgoff_t start, pgoff_t end);
2705

L
Linus Torvalds 已提交
2706 2707 2708 2709
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))
2710
		invalidate_mapping_pages(inode->i_mapping, 0, -1);
L
Linus Torvalds 已提交
2711 2712 2713 2714 2715 2716 2717
}
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 *);
2718
extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2719 2720
extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
				   loff_t lend);
2721 2722
extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
		loff_t start_byte, loff_t end_byte);
2723 2724 2725 2726 2727 2728

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

2729 2730
extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
				  loff_t lend);
L
Linus Torvalds 已提交
2731 2732 2733
extern int filemap_write_and_wait(struct address_space *mapping);
extern int filemap_write_and_wait_range(struct address_space *mapping,
				        loff_t lstart, loff_t lend);
2734 2735
extern int __filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end, int sync_mode);
2736 2737
extern int filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end);
2738
extern int filemap_check_errors(struct address_space *mapping);
2739
extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2740 2741 2742

extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
						loff_t lend);
2743 2744 2745 2746
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);

2747 2748 2749 2750 2751
static inline int file_write_and_wait(struct file *file)
{
	return file_write_and_wait_range(file, 0, LLONG_MAX);
}

2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800
/**
 * 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);
}

/**
 * filemap_check_wb_error - has an error occurred since the mark was sampled?
 * @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);
}

2801 2802 2803
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);
2804

J
Jens Axboe 已提交
2805 2806 2807
extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
				unsigned int flags);

2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823
/*
 * 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;
2824
}
2825

L
Linus Torvalds 已提交
2826 2827
extern void emergency_sync(void);
extern void emergency_remount(void);
2828
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
2829
extern sector_t bmap(struct inode *, sector_t);
2830
#endif
2831
extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2832
extern int inode_permission(struct inode *, int);
2833
extern int generic_permission(struct inode *, int);
M
Miklos Szeredi 已提交
2834
extern int __check_sticky(struct inode *dir, struct inode *inode);
L
Linus Torvalds 已提交
2835

2836 2837 2838 2839 2840
static inline bool execute_ok(struct inode *inode)
{
	return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
}

2841 2842 2843 2844 2845 2846 2847
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);
}

2848 2849 2850 2851 2852 2853 2854
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);
}

2855 2856 2857 2858 2859 2860
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);
}
2861

2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883
/*
 * 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 已提交
2884
	struct inode *inode = file_inode(file);
2885 2886
	return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
}
L
Linus Torvalds 已提交
2887 2888 2889 2890 2891 2892 2893
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 已提交
2894
		atomic_inc(&file_inode(file)->i_writecount);
L
Linus Torvalds 已提交
2895
}
2896 2897 2898 2899 2900
static inline bool inode_is_open_for_write(const struct inode *inode)
{
	return atomic_read(&inode->i_writecount) > 0;
}

2901
#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
M
Mimi Zohar 已提交
2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920
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 已提交
2921
extern int do_pipe_flags(int *, int);
L
Linus Torvalds 已提交
2922

2923 2924 2925
#define __kernel_read_file_id(id) \
	id(UNKNOWN, unknown)		\
	id(FIRMWARE, firmware)		\
2926
	id(FIRMWARE_PREALLOC_BUFFER, firmware)	\
2927 2928 2929 2930
	id(MODULE, kernel-module)		\
	id(KEXEC_IMAGE, kexec-image)		\
	id(KEXEC_INITRAMFS, kexec-initramfs)	\
	id(POLICY, security-policy)		\
2931
	id(X509_CERTIFICATE, x509-certificate)	\
2932 2933 2934 2935 2936
	id(MAX_ID, )

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

2937
enum kernel_read_file_id {
2938 2939 2940 2941 2942
	__kernel_read_file_id(__fid_enumify)
};

static const char * const kernel_read_file_str[] = {
	__kernel_read_file_id(__fid_stringify)
2943 2944
};

K
Kees Cook 已提交
2945
static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
2946
{
2947
	if ((unsigned)id >= READING_MAX_ID)
2948 2949 2950 2951 2952
		return kernel_read_file_str[READING_UNKNOWN];

	return kernel_read_file_str[id];
}

2953 2954
extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
			    enum kernel_read_file_id);
2955
extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
2956
				      enum kernel_read_file_id);
2957 2958
extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
				    enum kernel_read_file_id);
2959
extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
2960
extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
2961
extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
L
Linus Torvalds 已提交
2962 2963 2964
extern struct file * open_exec(const char *);
 
/* fs/dcache.c -- generic fs support functions */
Y
Yaowei Bai 已提交
2965
extern bool is_subdir(struct dentry *, struct dentry *);
2966
extern bool path_is_under(const struct path *, const struct path *);
L
Linus Torvalds 已提交
2967

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

L
Linus Torvalds 已提交
2970 2971 2972
#include <linux/err.h>

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

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

2977
extern int inode_init_always(struct super_block *, struct inode *);
L
Linus Torvalds 已提交
2978
extern void inode_init_once(struct inode *);
2979
extern void address_space_init_once(struct address_space *mapping);
L
Linus Torvalds 已提交
2980 2981 2982
extern struct inode * igrab(struct inode *);
extern ino_t iunique(struct super_block *, ino_t);
extern int inode_needs_sync(struct inode *inode);
2983
extern int generic_delete_inode(struct inode *inode);
2984 2985 2986 2987
static inline int generic_drop_inode(struct inode *inode)
{
	return !inode->i_nlink || inode_unhashed(inode);
}
L
Linus Torvalds 已提交
2988

2989 2990 2991
extern struct inode *ilookup5_nowait(struct super_block *sb,
		unsigned long hashval, int (*test)(struct inode *, void *),
		void *data);
L
Linus Torvalds 已提交
2992 2993 2994 2995
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 已提交
2996 2997 2998 2999
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 已提交
3000 3001
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);
3002 3003 3004 3005 3006
extern struct inode *find_inode_nowait(struct super_block *,
				       unsigned long,
				       int (*match)(struct inode *,
						    unsigned long, void *),
				       void *data);
A
Al Viro 已提交
3007 3008
extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
extern int insert_inode_locked(struct inode *);
3009 3010 3011 3012 3013
#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 已提交
3014
extern void unlock_new_inode(struct inode *);
A
Al Viro 已提交
3015
extern void discard_new_inode(struct inode *);
3016
extern unsigned int get_next_ino(void);
3017
extern void evict_inodes(struct super_block *sb);
L
Linus Torvalds 已提交
3018 3019

extern void __iget(struct inode * inode);
3020
extern void iget_failed(struct inode *);
3021
extern void clear_inode(struct inode *);
C
Christoph Hellwig 已提交
3022
extern void __destroy_inode(struct inode *);
3023 3024
extern struct inode *new_inode_pseudo(struct super_block *sb);
extern struct inode *new_inode(struct super_block *sb);
3025
extern void free_inode_nonrcu(struct inode *inode);
3026
extern int should_remove_suid(struct dentry *);
3027
extern int file_remove_privs(struct file *);
L
Linus Torvalds 已提交
3028 3029

extern void __insert_inode_hash(struct inode *, unsigned long hashval);
3030 3031
static inline void insert_inode_hash(struct inode *inode)
{
L
Linus Torvalds 已提交
3032 3033
	__insert_inode_hash(inode, inode->i_ino);
}
3034 3035 3036 3037

extern void __remove_inode_hash(struct inode *);
static inline void remove_inode_hash(struct inode *inode)
{
3038
	if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
3039 3040 3041
		__remove_inode_hash(inode);
}

3042
extern void inode_sb_list_add(struct inode *inode);
L
Linus Torvalds 已提交
3043

3044
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
3045
extern int bdev_read_only(struct block_device *);
3046
#endif
L
Linus Torvalds 已提交
3047 3048 3049 3050 3051 3052
extern int set_blocksize(struct block_device *, int);
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 *);
3053
extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
3054 3055
extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
				struct file *file_out, loff_t pos_out,
3056
				loff_t *count, unsigned int remap_flags);
3057
extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
3058 3059 3060
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);
A
Al Viro 已提交
3061
extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
3062 3063
extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
3064
extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3065
extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
A
Andrew Morton 已提交
3066

3067
ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3068
		rwf_t flags);
3069
ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3070
		rwf_t flags);
3071

3072
/* fs/block_dev.c */
3073
extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
3074
extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
3075 3076
extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
			int datasync);
A
Al Viro 已提交
3077
extern void block_sync_page(struct page *page);
3078

A
Andrew Morton 已提交
3079
/* fs/splice.c */
3080
extern ssize_t generic_file_splice_read(struct file *, loff_t *,
A
Andrew Morton 已提交
3081
		struct pipe_inode_info *, size_t, unsigned int);
A
Al Viro 已提交
3082
extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3083
		struct file *, loff_t *, size_t, unsigned int);
A
Andrew Morton 已提交
3084
extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
3085
		struct file *out, loff_t *, size_t len, unsigned int flags);
3086 3087 3088
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 已提交
3089

L
Linus Torvalds 已提交
3090 3091
extern void
file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3092 3093
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 已提交
3094
extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3095
extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
A
Andi Kleen 已提交
3096
extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3097
		int whence, loff_t maxsize, loff_t eof);
A
Al Viro 已提交
3098 3099
extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
		int whence, loff_t size);
3100 3101
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 已提交
3102 3103
extern int generic_file_open(struct inode * inode, struct file * filp);
extern int nonseekable_open(struct inode * inode, struct file * filp);
3104
extern int stream_open(struct inode * inode, struct file * filp);
L
Linus Torvalds 已提交
3105

3106
#ifdef CONFIG_BLOCK
3107
typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3108
			    loff_t file_offset);
L
Linus Torvalds 已提交
3109 3110

enum {
3111 3112 3113 3114 3115
	/* need locking between buffered and direct access */
	DIO_LOCKING	= 0x01,

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

3118
void dio_end_io(struct bio *bio);
3119
void dio_warn_stale_pagecache(struct file *filp);
3120

3121 3122
ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
			     struct block_device *bdev, struct iov_iter *iter,
3123
			     get_block_t get_block,
3124 3125
			     dio_iodone_t end_io, dio_submit_t submit_io,
			     int flags);
3126

3127 3128
static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
					 struct inode *inode,
3129
					 struct iov_iter *iter,
3130
					 get_block_t get_block)
L
Linus Torvalds 已提交
3131
{
3132
	return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3133
			get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
L
Linus Torvalds 已提交
3134
}
3135
#endif
L
Linus Torvalds 已提交
3136

3137
void inode_dio_wait(struct inode *inode);
3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162

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

3164 3165 3166
extern void inode_set_flags(struct inode *inode, unsigned int flags,
			    unsigned int mask);

3167
extern const struct file_operations generic_ro_fops;
L
Linus Torvalds 已提交
3168 3169 3170

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

A
Al Viro 已提交
3171
extern int readlink_copy(char __user *, int, const char *);
L
Linus Torvalds 已提交
3172
extern int page_readlink(struct dentry *, char __user *, int);
3173 3174 3175
extern const char *page_get_link(struct dentry *, struct inode *,
				 struct delayed_call *);
extern void page_put_link(void *);
3176
extern int __page_symlink(struct inode *inode, const char *symname, int len,
3177
		int nofs);
L
Linus Torvalds 已提交
3178
extern int page_symlink(struct inode *inode, const char *symname, int len);
3179
extern const struct inode_operations page_symlink_inode_operations;
3180
extern void kfree_link(void *);
L
Linus Torvalds 已提交
3181
extern void generic_fillattr(struct inode *, struct kstat *);
3182 3183
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);
3184
void __inode_add_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3185
void inode_add_bytes(struct inode *inode, loff_t bytes);
3186
void __inode_sub_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3187
void inode_sub_bytes(struct inode *inode, loff_t bytes);
J
Jan Kara 已提交
3188 3189 3190 3191
static inline loff_t __inode_get_bytes(struct inode *inode)
{
	return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
}
L
Linus Torvalds 已提交
3192 3193
loff_t inode_get_bytes(struct inode *inode);
void inode_set_bytes(struct inode *inode, loff_t bytes);
3194 3195
const char *simple_get_link(struct dentry *, struct inode *,
			    struct delayed_call *);
A
Al Viro 已提交
3196
extern const struct inode_operations simple_symlink_inode_operations;
L
Linus Torvalds 已提交
3197

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

3200 3201 3202 3203 3204
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)
{
3205 3206
	return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
			 stat, STATX_BASIC_STATS);
3207 3208 3209
}
static inline int vfs_lstat(const char __user *name, struct kstat *stat)
{
3210
	return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
3211 3212 3213 3214 3215
			 stat, STATX_BASIC_STATS);
}
static inline int vfs_fstatat(int dfd, const char __user *filename,
			      struct kstat *stat, int flags)
{
3216 3217
	return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
			 stat, STATX_BASIC_STATS);
3218 3219 3220 3221 3222 3223 3224
}
static inline int vfs_fstat(int fd, struct kstat *stat)
{
	return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
}


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

3228
extern int __generic_block_fiemap(struct inode *inode,
J
Josef Bacik 已提交
3229 3230 3231
				  struct fiemap_extent_info *fieinfo,
				  loff_t start, loff_t len,
				  get_block_t *get_block);
3232 3233 3234
extern int generic_block_fiemap(struct inode *inode,
				struct fiemap_extent_info *fieinfo, u64 start,
				u64 len, get_block_t *get_block);
L
Linus Torvalds 已提交
3235

3236
extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3237
extern void put_filesystem(struct file_system_type *fs);
L
Linus Torvalds 已提交
3238 3239
extern struct file_system_type *get_fs_type(const char *name);
extern struct super_block *get_super(struct block_device *);
3240
extern struct super_block *get_super_thawed(struct block_device *);
3241
extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
3242
extern struct super_block *get_active_super(struct block_device *bdev);
L
Linus Torvalds 已提交
3243
extern void drop_super(struct super_block *sb);
3244
extern void drop_super_exclusive(struct super_block *sb);
A
Al Viro 已提交
3245
extern void iterate_supers(void (*)(struct super_block *, void *), void *);
A
Al Viro 已提交
3246 3247
extern void iterate_supers_type(struct file_system_type *,
			        void (*)(struct super_block *, void *), void *);
L
Linus Torvalds 已提交
3248 3249 3250 3251

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);
3252
extern int dcache_readdir(struct file *, struct dir_context *);
3253
extern int simple_setattr(struct dentry *, struct iattr *);
3254
extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
3255
extern int simple_statfs(struct dentry *, struct kstatfs *);
S
Stephen Boyd 已提交
3256
extern int simple_open(struct inode *inode, struct file *file);
L
Linus Torvalds 已提交
3257 3258 3259
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 *);
3260 3261
extern int simple_rename(struct inode *, struct dentry *,
			 struct inode *, struct dentry *, unsigned int);
3262
extern int noop_fsync(struct file *, loff_t, loff_t, int);
3263 3264 3265 3266
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 已提交
3267 3268
extern int simple_empty(struct dentry *);
extern int simple_readpage(struct file *file, struct page *page);
3269 3270 3271 3272 3273 3274
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);
3275
extern int always_delete_dentry(const struct dentry *);
A
Al Viro 已提交
3276
extern struct inode *alloc_anon_inode(struct super_block *);
3277
extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3278
extern const struct dentry_operations simple_dentry_operations;
L
Linus Torvalds 已提交
3279

A
Al Viro 已提交
3280
extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
L
Linus Torvalds 已提交
3281
extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3282
extern const struct file_operations simple_dir_operations;
3283
extern const struct inode_operations simple_dir_inode_operations;
3284 3285
extern void make_empty_dir_inode(struct inode *inode);
extern bool is_empty_dir_inode(struct inode *inode);
3286
struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
L
Linus Torvalds 已提交
3287
struct dentry *d_alloc_name(struct dentry *, const char *);
3288 3289
extern int simple_fill_super(struct super_block *, unsigned long,
			     const struct tree_descr *);
3290
extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
L
Linus Torvalds 已提交
3291 3292
extern void simple_release_fs(struct vfsmount **mount, int *count);

3293 3294
extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
			loff_t *ppos, const void *from, size_t available);
3295 3296
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 已提交
3297

3298
extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3299
extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
A
Al Viro 已提交
3300

3301 3302
extern int generic_check_addressable(unsigned, u64);

3303
#ifdef CONFIG_MIGRATION
3304
extern int buffer_migrate_page(struct address_space *,
3305 3306
				struct page *, struct page *,
				enum migrate_mode);
3307 3308 3309
extern int buffer_migrate_page_norefs(struct address_space *,
				struct page *, struct page *,
				enum migrate_mode);
3310 3311
#else
#define buffer_migrate_page NULL
3312
#define buffer_migrate_page_norefs NULL
3313 3314
#endif

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

3319
extern int file_update_time(struct file *file);
L
Linus Torvalds 已提交
3320

3321 3322
static inline bool io_is_direct(struct file *filp)
{
3323
	return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
3324 3325
}

3326 3327 3328 3329 3330
static inline bool vma_is_dax(struct vm_area_struct *vma)
{
	return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
}

3331 3332 3333 3334 3335 3336 3337 3338 3339
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 已提交
3340
	if (S_ISCHR(inode->i_mode))
3341 3342 3343 3344
		return false; /* device-dax */
	return true;
}

3345 3346 3347 3348 3349 3350 3351
static inline int iocb_flags(struct file *file)
{
	int res = 0;
	if (file->f_flags & O_APPEND)
		res |= IOCB_APPEND;
	if (io_is_direct(file))
		res |= IOCB_DIRECT;
3352 3353 3354 3355
	if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
		res |= IOCB_DSYNC;
	if (file->f_flags & __O_SYNC)
		res |= IOCB_SYNC;
3356 3357 3358
	return res;
}

C
Christoph Hellwig 已提交
3359
static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3360 3361 3362 3363
{
	if (unlikely(flags & ~RWF_SUPPORTED))
		return -EOPNOTSUPP;

3364
	if (flags & RWF_NOWAIT) {
3365
		if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3366 3367 3368
			return -EOPNOTSUPP;
		ki->ki_flags |= IOCB_NOWAIT;
	}
3369 3370 3371 3372 3373 3374
	if (flags & RWF_HIPRI)
		ki->ki_flags |= IOCB_HIPRI;
	if (flags & RWF_DSYNC)
		ki->ki_flags |= IOCB_DSYNC;
	if (flags & RWF_SYNC)
		ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
J
Jürg Billeter 已提交
3375 3376
	if (flags & RWF_APPEND)
		ki->ki_flags |= IOCB_APPEND;
3377 3378 3379
	return 0;
}

L
Linus Torvalds 已提交
3380 3381 3382 3383
static inline ino_t parent_ino(struct dentry *dentry)
{
	ino_t res;

N
Nick Piggin 已提交
3384 3385 3386 3387
	/*
	 * 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 已提交
3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412
	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);

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

3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436
/*
 * 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);	\
}									\
3437
static const struct file_operations __fops = {				\
3438 3439
	.owner	 = THIS_MODULE,						\
	.open	 = __fops ## _open,					\
3440
	.release = simple_attr_release,					\
3441 3442
	.read	 = simple_attr_read,					\
	.write	 = simple_attr_write,					\
3443
	.llseek	 = generic_file_llseek,					\
3444
}
3445

3446 3447
static inline __printf(1, 2)
void __simple_attr_check_format(const char *fmt, ...)
3448 3449 3450 3451 3452
{
	/* don't do anything, just let the compiler check the arguments; */
}

int simple_attr_open(struct inode *inode, struct file *file,
3453
		     int (*get)(void *, u64 *), int (*set)(void *, u64),
3454
		     const char *fmt);
3455
int simple_attr_release(struct inode *inode, struct file *file);
3456 3457 3458 3459 3460
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 已提交
3461
struct ctl_table;
3462
int proc_nr_files(struct ctl_table *table, int write,
3463
		  void __user *buffer, size_t *lenp, loff_t *ppos);
3464 3465
int proc_nr_dentry(struct ctl_table *table, int write,
		  void __user *buffer, size_t *lenp, loff_t *ppos);
3466 3467
int proc_nr_inodes(struct ctl_table *table, int write,
		   void __user *buffer, size_t *lenp, loff_t *ppos);
3468
int __init get_filesystem_list(char *buf);
3469

N
Namhyung Kim 已提交
3470
#define __FMODE_EXEC		((__force int) FMODE_EXEC)
3471 3472
#define __FMODE_NONOTIFY	((__force int) FMODE_NONOTIFY)

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

Y
Yaowei Bai 已提交
3477
static inline bool is_sxid(umode_t mode)
3478 3479 3480 3481
{
	return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
}

M
Miklos Szeredi 已提交
3482 3483 3484 3485 3486 3487 3488 3489
static inline int check_sticky(struct inode *dir, struct inode *inode)
{
	if (!(dir->i_mode & S_ISVTX))
		return 0;

	return __check_sticky(dir, inode);
}

3490 3491
static inline void inode_has_no_xattr(struct inode *inode)
{
3492
	if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3493 3494 3495
		inode->i_flags |= S_NOSEC;
}

A
Al Viro 已提交
3496 3497 3498 3499 3500
static inline bool is_root_inode(struct inode *inode)
{
	return inode == inode->i_sb->s_root->d_inode;
}

3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530
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 已提交
3531 3532
static inline bool dir_relax(struct inode *inode)
{
A
Al Viro 已提交
3533 3534
	inode_unlock(inode);
	inode_lock(inode);
A
Al Viro 已提交
3535 3536
	return !IS_DEADDIR(inode);
}
3537

A
Al Viro 已提交
3538 3539 3540 3541 3542 3543 3544
static inline bool dir_relax_shared(struct inode *inode)
{
	inode_unlock_shared(inode);
	inode_lock_shared(inode);
	return !IS_DEADDIR(inode);
}

3545
extern bool path_noexec(const struct path *path);
3546
extern void inode_nohighmem(struct inode *inode);
3547

3548 3549 3550
/* mm/fadvise.c */
extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
		       int advice);
J
Jan Kara 已提交
3551 3552
extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
			   int advice);
3553

J
Jens Axboe 已提交
3554 3555 3556 3557 3558 3559 3560 3561 3562
#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

3563 3564 3565
int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
			     unsigned int flags);

3566 3567 3568 3569 3570 3571 3572 3573 3574
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;
}

3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585
/*
 * 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 已提交
3586
#endif /* _LINUX_FS_H */