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

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

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

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

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

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

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

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

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

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

148
/* File is huge (eg. /dev/mem): treat loff_t as unsigned */
D
David Howells 已提交
149 150 151 152 153
#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)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/* non-RWF related bits - start at 16 */
#define IOCB_EVENTFD		(1 << 16)
#define IOCB_DIRECT		(1 << 17)
#define IOCB_WRITE		(1 << 18)
319
/* iocb->ki_waitq is valid */
320 321
#define IOCB_WAITQ		(1 << 19)
#define IOCB_NOIO		(1 << 20)
J
Jens Axboe 已提交
322 323
/* can use bio alloc cache */
#define IOCB_ALLOC_CACHE	(1 << 21)
324 325 326

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

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

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

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

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

L
Linus Torvalds 已提交
368 369 370 371 372 373 374
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 *);

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

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

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

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

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

421 422 423 424 425 426 427 428 429 430 431 432
/*
 * 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);

433 434 435 436
/**
 * struct address_space - Contents of a cacheable, mappable object.
 * @host: Owner, either the inode or the block_device.
 * @i_pages: Cached pages.
437 438 439 440
 * @invalidate_lock: Guards coherency between page cache contents and
 *   file offset->disk block mappings in the filesystem during invalidates.
 *   It is also used to block modification of page cache contents through
 *   memory mappings.
441 442
 * @gfp_mask: Memory allocation flags to use for allocating pages.
 * @i_mmap_writable: Number of VM_SHARED mappings.
443
 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
444 445 446 447 448 449 450 451 452 453 454
 * @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.
 * @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 已提交
455
struct address_space {
456 457
	struct inode		*host;
	struct xarray		i_pages;
458
	struct rw_semaphore	invalidate_lock;
459 460
	gfp_t			gfp_mask;
	atomic_t		i_mmap_writable;
461 462 463 464
#ifdef CONFIG_READ_ONLY_THP_FOR_FS
	/* number of thp, only for non-shmem files */
	atomic_t		nr_thps;
#endif
465 466 467 468 469 470
	struct rb_root_cached	i_mmap;
	struct rw_semaphore	i_mmap_rwsem;
	unsigned long		nrpages;
	pgoff_t			writeback_index;
	const struct address_space_operations *a_ops;
	unsigned long		flags;
471
	errseq_t		wb_err;
472 473 474
	spinlock_t		private_lock;
	struct list_head	private_list;
	void			*private_data;
475
} __attribute__((aligned(sizeof(long)))) __randomize_layout;
L
Linus Torvalds 已提交
476 477
	/*
	 * On most architectures that alignment is already the case; but
L
Lucas De Marchi 已提交
478
	 * must be enforced here for CRIS, to let the least significant bit
L
Linus Torvalds 已提交
479 480 481
	 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
	 */

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

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

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

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

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

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

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

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

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

/*
 * 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 已提交
585 586
struct posix_acl;
#define ACL_NOT_CACHED ((void *)(-1))
M
Miklos Szeredi 已提交
587 588 589 590 591
/*
 * ACL_DONT_CACHE is for stacked filesystems, that rely on underlying fs to
 * cache the ACL.  This also means that ->get_acl() can be called in RCU mode
 * with the LOOKUP_RCU flag.
 */
592
#define ACL_DONT_CACHE ((void *)(-3))
A
Al Viro 已提交
593

594 595 596 597 598 599 600 601 602 603 604 605
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;
}

606 607 608
#define IOP_FASTPERM	0x0001
#define IOP_LOOKUP	0x0002
#define IOP_NOFOLLOW	0x0004
609
#define IOP_XATTR	0x0008
610
#define IOP_DEFAULT_READLINK	0x0010
611

612 613
struct fsnotify_mark_connector;

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

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

631 632
	const struct inode_operations	*i_op;
	struct super_block	*i_sb;
633
	struct address_space	*i_mapping;
634

635 636 637
#ifdef CONFIG_SECURITY
	void			*i_security;
#endif
638

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

#ifdef __NEED_I_SIZE_ORDERED
	seqcount_t		i_size_seqcount;
#endif

	/* Misc */
	unsigned long		i_state;
669
	struct rw_semaphore	i_rwsem;
670

671
	unsigned long		dirtied_when;	/* jiffies of first dirtying */
672
	unsigned long		dirtied_time_when;
673

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

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

	__u32			i_generation;

715 716
#ifdef CONFIG_FSNOTIFY
	__u32			i_fsnotify_mask; /* all events this inode cares about */
717
	struct fsnotify_mark_connector __rcu	*i_fsnotify_marks;
R
Robert Love 已提交
718 719
#endif

720
#ifdef CONFIG_FS_ENCRYPTION
721 722 723
	struct fscrypt_info	*i_crypt_info;
#endif

724 725 726 727
#ifdef CONFIG_FS_VERITY
	struct fsverity_info	*i_verity_info;
#endif

728
	void			*i_private; /* fs or device private pointer */
729
} __randomize_layout;
L
Linus Torvalds 已提交
730

731 732
struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);

F
Fabian Frederick 已提交
733 734 735 736 737
static inline unsigned int i_blocksize(const struct inode *node)
{
	return (1 << node->i_blkbits);
}

A
Al Viro 已提交
738 739 740 741 742
static inline int inode_unhashed(struct inode *inode)
{
	return hlist_unhashed(&inode->i_hash);
}

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

A
Al Viro 已提交
780 781
static inline void inode_lock(struct inode *inode)
{
782
	down_write(&inode->i_rwsem);
A
Al Viro 已提交
783 784 785 786
}

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

static inline int inode_trylock(struct inode *inode)
{
802 803 804 805 806 807
	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 已提交
808 809 810 811
}

static inline int inode_is_locked(struct inode *inode)
{
812
	return rwsem_is_locked(&inode->i_rwsem);
A
Al Viro 已提交
813 814 815 816
}

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

820 821 822 823 824
static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
{
	down_read_nested(&inode->i_rwsem, subclass);
}

825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
static inline void filemap_invalidate_lock(struct address_space *mapping)
{
	down_write(&mapping->invalidate_lock);
}

static inline void filemap_invalidate_unlock(struct address_space *mapping)
{
	up_write(&mapping->invalidate_lock);
}

static inline void filemap_invalidate_lock_shared(struct address_space *mapping)
{
	down_read(&mapping->invalidate_lock);
}

static inline int filemap_invalidate_trylock_shared(
					struct address_space *mapping)
{
	return down_read_trylock(&mapping->invalidate_lock);
}

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

852 853 854
void lock_two_nondirectories(struct inode *, struct inode*);
void unlock_two_nondirectories(struct inode *, struct inode*);

855 856 857 858 859 860
void filemap_invalidate_lock_two(struct address_space *mapping1,
				 struct address_space *mapping2);
void filemap_invalidate_unlock_two(struct address_space *mapping1,
				   struct address_space *mapping2);


L
Linus Torvalds 已提交
861 862 863 864 865 866 867 868 869 870
/*
 * 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 已提交
871
static inline loff_t i_size_read(const struct inode *inode)
L
Linus Torvalds 已提交
872 873 874 875 876 877 878 879 880 881
{
#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;
882
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
L
Linus Torvalds 已提交
883 884 885 886 887 888 889 890 891 892 893
	loff_t i_size;

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

894 895 896 897 898
/*
 * 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 已提交
899 900 901
static inline void i_size_write(struct inode *inode, loff_t i_size)
{
#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
902
	preempt_disable();
L
Linus Torvalds 已提交
903 904 905
	write_seqcount_begin(&inode->i_size_seqcount);
	inode->i_size = i_size;
	write_seqcount_end(&inode->i_size_seqcount);
906
	preempt_enable();
907
#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
L
Linus Torvalds 已提交
908 909 910 911 912 913 914 915
	preempt_disable();
	inode->i_size = i_size;
	preempt_enable();
#else
	inode->i_size = i_size;
#endif
}

J
Jan Engelhardt 已提交
916
static inline unsigned iminor(const struct inode *inode)
L
Linus Torvalds 已提交
917 918 919 920
{
	return MINOR(inode->i_rdev);
}

J
Jan Engelhardt 已提交
921
static inline unsigned imajor(const struct inode *inode)
L
Linus Torvalds 已提交
922 923 924 925 926 927
{
	return MAJOR(inode->i_rdev);
}

struct fown_struct {
	rwlock_t lock;          /* protects pid, uid, euid fields */
928 929
	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 */
930
	kuid_t uid, euid;	/* uid/euid of process setting the owner */
L
Linus Torvalds 已提交
931 932 933
	int signum;		/* posix.1b rt signal to be delivered on IO */
};

934 935 936 937 938 939 940 941
/**
 * struct file_ra_state - Track a file's readahead state.
 * @start: Where the most recent readahead started.
 * @size: Number of pages read in the most recent readahead.
 * @async_size: Start next readahead when this many pages are left.
 * @ra_pages: Maximum size of a readahead request.
 * @mmap_miss: How many mmap accesses missed in the page cache.
 * @prev_pos: The last byte in the most recent read request.
L
Linus Torvalds 已提交
942 943
 */
struct file_ra_state {
944 945 946 947 948 949
	pgoff_t start;
	unsigned int size;
	unsigned int async_size;
	unsigned int ra_pages;
	unsigned int mmap_miss;
	loff_t prev_pos;
L
Linus Torvalds 已提交
950 951
};

952 953 954 955 956
/*
 * Check if @index falls in the readahead windows.
 */
static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
{
957 958
	return (index >= ra->start &&
		index <  ra->start + ra->size);
959 960
}

L
Linus Torvalds 已提交
961
struct file {
E
Eric Dumazet 已提交
962
	union {
963
		struct llist_node	fu_llist;
E
Eric Dumazet 已提交
964 965
		struct rcu_head 	fu_rcuhead;
	} f_u;
966
	struct path		f_path;
967
	struct inode		*f_inode;	/* cached value */
968
	const struct file_operations	*f_op;
969 970

	/*
971
	 * Protects f_ep, f_flags.
972 973 974
	 * Must not be taken from IRQ context.
	 */
	spinlock_t		f_lock;
975
	enum rw_hint		f_write_hint;
A
Al Viro 已提交
976
	atomic_long_t		f_count;
L
Linus Torvalds 已提交
977
	unsigned int 		f_flags;
978
	fmode_t			f_mode;
979
	struct mutex		f_pos_lock;
L
Linus Torvalds 已提交
980 981
	loff_t			f_pos;
	struct fown_struct	f_owner;
D
David Howells 已提交
982
	const struct cred	*f_cred;
L
Linus Torvalds 已提交
983 984
	struct file_ra_state	f_ra;

985
	u64			f_version;
986
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
987
	void			*f_security;
988
#endif
L
Linus Torvalds 已提交
989 990 991 992 993
	/* 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 */
994
	struct hlist_head	*f_ep;
L
Linus Torvalds 已提交
995 996
#endif /* #ifdef CONFIG_EPOLL */
	struct address_space	*f_mapping;
997
	errseq_t		f_wb_err;
998
	errseq_t		f_sb_err; /* for syncfs */
999 1000
} __randomize_layout
  __attribute__((aligned(4)));	/* lest something weird decides that 2 is OK */
L
Linus Torvalds 已提交
1001

1002 1003 1004 1005
struct file_handle {
	__u32 handle_bytes;
	int handle_type;
	/* file identifier */
1006
	unsigned char f_handle[];
1007 1008
};

A
Al Viro 已提交
1009 1010 1011 1012 1013
static inline struct file *get_file(struct file *f)
{
	atomic_long_inc(&f->f_count);
	return f;
}
J
Jens Axboe 已提交
1014 1015 1016
#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 已提交
1017
#define file_count(x)	atomic_long_read(&(x)->f_count)
L
Linus Torvalds 已提交
1018 1019 1020 1021 1022 1023

#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
1024
#define MAX_LFS_FILESIZE	((loff_t)ULONG_MAX << PAGE_SHIFT)
L
Linus Torvalds 已提交
1025
#elif BITS_PER_LONG==64
1026
#define MAX_LFS_FILESIZE 	((loff_t)LLONG_MAX)
L
Linus Torvalds 已提交
1027 1028 1029 1030
#endif

#define FL_POSIX	1
#define FL_FLOCK	2
1031
#define FL_DELEG	4	/* NFSv4 delegation */
L
Linus Torvalds 已提交
1032
#define FL_ACCESS	8	/* not trying to lock, just looking */
1033
#define FL_EXISTS	16	/* when unlocking, test for existence */
L
Linus Torvalds 已提交
1034
#define FL_LEASE	32	/* lease held on this file */
1035
#define FL_CLOSE	64	/* unlock on close */
L
Linus Torvalds 已提交
1036
#define FL_SLEEP	128	/* A blocking lock */
1037 1038
#define FL_DOWNGRADE_PENDING	256 /* Lease is being downgraded */
#define FL_UNLOCK_PENDING	512 /* Lease is being broken */
1039
#define FL_OFDLCK	1024	/* lock is "owned" by struct file */
C
Christoph Hellwig 已提交
1040
#define FL_LAYOUT	2048	/* outstanding pNFS layout */
1041
#define FL_RECLAIM	4096	/* reclaiming from a reboot server */
L
Linus Torvalds 已提交
1042

1043 1044
#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)

1045 1046 1047 1048 1049 1050
/*
 * Special return value from posix_lock_file() and vfs_lock_file() for
 * asynchronous locking.
 */
#define FILE_LOCK_DEFERRED 1

1051
/* legacy typedef, should eventually be removed */
1052
typedef void *fl_owner_t;
L
Linus Torvalds 已提交
1053

1054 1055
struct file_lock;

L
Linus Torvalds 已提交
1056 1057 1058 1059 1060 1061
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 {
1062 1063
	fl_owner_t (*lm_get_owner)(fl_owner_t);
	void (*lm_put_owner)(fl_owner_t);
J
J. Bruce Fields 已提交
1064
	void (*lm_notify)(struct file_lock *);	/* unblock callback */
1065
	int (*lm_grant)(struct file_lock *, int);
J
Jeff Layton 已提交
1066
	bool (*lm_break)(struct file_lock *);
1067
	int (*lm_change)(struct file_lock *, int, struct list_head *);
1068
	void (*lm_setup)(struct file_lock *, void **);
1069
	bool (*lm_breaker_owns_lease)(struct file_lock *);
L
Linus Torvalds 已提交
1070 1071
};

1072 1073
struct lock_manager {
	struct list_head list;
1074 1075 1076 1077 1078
	/*
	 * NFSv4 and up also want opens blocked during the grace period;
	 * NLM doesn't care:
	 */
	bool block_opens;
1079 1080
};

1081 1082
struct net;
void locks_start_grace(struct net *, struct lock_manager *);
1083
void locks_end_grace(struct lock_manager *);
C
Corentin Labbe 已提交
1084 1085
bool locks_in_grace(struct net *);
bool opens_in_grace(struct net *);
1086

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

1090 1091 1092 1093 1094 1095 1096 1097 1098
/*
 * 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?
 *
1099
 * The varous i_flctx lists are ordered by:
1100
 *
1101 1102 1103
 * 1) lock owner
 * 2) lock range start
 * 3) lock range end
1104 1105 1106
 *
 * Obviously, the last two criteria only matter for POSIX locks.
 */
L
Linus Torvalds 已提交
1107
struct file_lock {
1108
	struct file_lock *fl_blocker;	/* The lock, that is blocking us */
1109
	struct list_head fl_list;	/* link into file_lock_context */
1110
	struct hlist_node fl_link;	/* node in global lists */
1111 1112 1113 1114 1115 1116
	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 已提交
1117
	fl_owner_t fl_owner;
1118
	unsigned int fl_flags;
1119
	unsigned char fl_type;
L
Linus Torvalds 已提交
1120
	unsigned int fl_pid;
1121
	int fl_link_cpu;		/* what cpu's list is this on? */
L
Linus Torvalds 已提交
1122 1123 1124 1125 1126 1127
	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 */
1128 1129 1130
	/* for lease breaks: */
	unsigned long fl_break_time;
	unsigned long fl_downgrade_time;
L
Linus Torvalds 已提交
1131

1132
	const struct file_lock_operations *fl_ops;	/* Callbacks for filesystems */
1133
	const struct lock_manager_operations *fl_lmops;	/* Callbacks for lockmanagers */
L
Linus Torvalds 已提交
1134 1135
	union {
		struct nfs_lock_info	nfs_fl;
1136
		struct nfs4_lock_info	nfs4_fl;
D
David Howells 已提交
1137 1138 1139
		struct {
			struct list_head link;	/* link in AFS vnode's pending_locks list */
			int state;		/* state of grant or error if -ve */
1140
			unsigned int	debug_id;
D
David Howells 已提交
1141
		} afs;
L
Linus Torvalds 已提交
1142
	} fl_u;
1143
} __randomize_layout;
L
Linus Torvalds 已提交
1144

1145
struct file_lock_context {
1146
	spinlock_t		flc_lock;
1147
	struct list_head	flc_flock;
1148
	struct list_head	flc_posix;
1149
	struct list_head	flc_lease;
1150 1151
};

L
Linus Torvalds 已提交
1152 1153 1154 1155 1156 1157 1158
/* 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

1159 1160
extern void send_sigio(struct fown_struct *fown, int fd, int band);

1161
#define locks_inode(f) file_inode(f)
1162

1163
#ifdef CONFIG_FILE_LOCKING
1164
extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
1165
extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1166
			struct flock *);
L
Linus Torvalds 已提交
1167 1168

#if BITS_PER_LONG == 32
1169
extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
1170
extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1171
			struct flock64 *);
L
Linus Torvalds 已提交
1172 1173 1174 1175 1176 1177
#endif

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

/* fs/locks.c */
1178
void locks_free_lock_context(struct inode *inode);
1179
void locks_free_lock(struct file_lock *fl);
L
Linus Torvalds 已提交
1180
extern void locks_init_lock(struct file_lock *);
1181
extern struct file_lock * locks_alloc_lock(void);
L
Linus Torvalds 已提交
1182
extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1183
extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
L
Linus Torvalds 已提交
1184
extern void locks_remove_posix(struct file *, fl_owner_t);
1185
extern void locks_remove_file(struct file *);
1186
extern void locks_release_private(struct file_lock *);
1187
extern void posix_test_lock(struct file *, struct file_lock *);
1188
extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1189
extern int locks_delete_block(struct file_lock *);
1190
extern int vfs_test_lock(struct file *, struct file_lock *);
1191
extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
M
Marc Eshel 已提交
1192
extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1193
extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J
J. Bruce Fields 已提交
1194
extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1195
extern void lease_get_mtime(struct inode *, struct timespec64 *time);
1196 1197
extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1198
extern int lease_modify(struct file_lock *, int, struct list_head *);
1199 1200 1201 1202 1203

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

1204 1205 1206
struct files_struct;
extern void show_fd_locks(struct seq_file *f,
			 struct file *filp, struct files_struct *files);
1207
#else /* !CONFIG_FILE_LOCKING */
1208 1209
static inline int fcntl_getlk(struct file *file, unsigned int cmd,
			      struct flock __user *user)
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
{
	return -EINVAL;
}

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

1220
#if BITS_PER_LONG == 32
1221 1222
static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
				struct flock64 __user *user)
1223 1224 1225 1226 1227 1228 1229 1230 1231
{
	return -EINVAL;
}

static inline int fcntl_setlk64(unsigned int fd, struct file *file,
				unsigned int cmd, struct flock64 __user *user)
{
	return -EACCES;
}
1232
#endif
1233 1234
static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
{
1235
	return -EINVAL;
1236 1237 1238 1239
}

static inline int fcntl_getlease(struct file *filp)
{
1240
	return F_UNLCK;
1241 1242
}

1243
static inline void
1244
locks_free_lock_context(struct inode *inode)
1245 1246 1247
{
}

1248 1249 1250 1251 1252
static inline void locks_init_lock(struct file_lock *fl)
{
	return;
}

1253
static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
{
	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;
}

1268
static inline void locks_remove_file(struct file *filp)
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
{
	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;
}

1284
static inline int locks_delete_block(struct file_lock *waiter)
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
{
	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;
}

1305 1306 1307 1308 1309
static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
{
	return -ENOLCK;
}

J
J. Bruce Fields 已提交
1310
static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1311 1312 1313 1314
{
	return 0;
}

1315 1316
static inline void lease_get_mtime(struct inode *inode,
				   struct timespec64 *time)
1317 1318 1319 1320 1321
{
	return;
}

static inline int generic_setlease(struct file *filp, long arg,
1322
				    struct file_lock **flp, void **priv)
1323 1324 1325 1326 1327
{
	return -EINVAL;
}

static inline int vfs_setlease(struct file *filp, long arg,
1328
			       struct file_lock **lease, void **priv)
1329 1330 1331 1332
{
	return -EINVAL;
}

1333
static inline int lease_modify(struct file_lock *fl, int arg,
1334
			       struct list_head *dispose)
1335 1336 1337
{
	return -EINVAL;
}
1338 1339 1340 1341

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

1344 1345 1346 1347 1348
static inline struct inode *file_inode(const struct file *f)
{
	return f->f_inode;
}

M
Miklos Szeredi 已提交
1349 1350
static inline struct dentry *file_dentry(const struct file *file)
{
1351
	return d_real(file->f_path.dentry, file_inode(file));
M
Miklos Szeredi 已提交
1352 1353
}

1354 1355
static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
{
1356
	return locks_lock_inode_wait(locks_inode(filp), fl);
1357 1358
}

L
Linus Torvalds 已提交
1359
struct fasync_struct {
1360
	rwlock_t		fa_lock;
1361 1362 1363 1364 1365
	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 已提交
1366 1367 1368 1369 1370 1371
};

#define FASYNC_MAGIC 0x4601

/* SMP safe fasync helpers: */
extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1372 1373 1374 1375 1376
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 已提交
1377 1378 1379
/* can be called from interrupts */
extern void kill_fasync(struct fasync_struct **, int, int);

1380
extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1381
extern int f_setown(struct file *filp, unsigned long arg, int force);
L
Linus Torvalds 已提交
1382
extern void f_delown(struct file *filp);
1383
extern pid_t f_getown(struct file *filp);
L
Linus Torvalds 已提交
1384 1385
extern int send_sigurg(struct fown_struct *fown);

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
/*
 * sb->s_flags.  Note that these mirror the equivalent MS_* flags where
 * represented in both.
 */
#define SB_RDONLY	 1	/* Mount read-only */
#define SB_NOSUID	 2	/* Ignore suid and sgid bits */
#define SB_NODEV	 4	/* Disallow access to device special files */
#define SB_NOEXEC	 8	/* Disallow program execution */
#define SB_SYNCHRONOUS	16	/* Writes are synced at once */
#define SB_MANDLOCK	64	/* Allow mandatory locks on an FS */
#define SB_DIRSYNC	128	/* Directory modifications are synchronous */
#define SB_NOATIME	1024	/* Do not update access times. */
#define SB_NODIRATIME	2048	/* Do not update directory access times */
#define SB_SILENT	32768
#define SB_POSIXACL	(1<<16)	/* VFS does not apply the umask */
S
Satya Tangirala 已提交
1401
#define SB_INLINECRYPT	(1<<17)	/* Use blk-crypto for encrypted files */
1402 1403 1404 1405 1406 1407
#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)
1408
#define SB_FORCE    	(1<<27)
1409 1410 1411 1412 1413
#define SB_NOSEC	(1<<28)
#define SB_BORN		(1<<29)
#define SB_ACTIVE	(1<<30)
#define SB_NOUSER	(1<<31)

1414 1415 1416 1417 1418 1419
/* These flags relate to encoding and casefolding */
#define SB_ENC_STRICT_MODE_FL	(1 << 0)

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

L
Linus Torvalds 已提交
1420 1421 1422 1423 1424 1425 1426
/*
 *	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 */
1427 1428
#define UMOUNT_NOFOLLOW	0x00000008	/* Don't follow symlink on umount */
#define UMOUNT_UNUSED	0x80000000	/* Flag guaranteed to be unused */
L
Linus Torvalds 已提交
1429

1430 1431
/* sb->s_iflags */
#define SB_I_CGROUPWB	0x00000001	/* cgroup-aware writeback enabled */
1432
#define SB_I_NOEXEC	0x00000002	/* Ignore executables on this fs */
1433
#define SB_I_NODEV	0x00000004	/* Ignore devices on this fs */
1434
#define SB_I_STABLE_WRITES 0x00000008	/* don't modify blks until WB is done */
L
Linus Torvalds 已提交
1435

1436 1437
/* sb->s_iflags to limit user namespace mounts */
#define SB_I_USERNS_VISIBLE		0x00000010 /* fstype already mounted */
1438 1439
#define SB_I_IMA_UNVERIFIABLE_SIGNATURE	0x00000020
#define SB_I_UNTRUSTED_MOUNTER		0x00000040
L
Linus Torvalds 已提交
1440

1441 1442
#define SB_I_SKIP_SYNC	0x00000100	/* Skip superblock at global sync */

1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
/* 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 {
1456
	int				frozen;		/* Is sb frozen? */
1457
	wait_queue_head_t		wait_unfrozen;	/* wait for thaw */
1458
	struct percpu_rw_semaphore	rw_sem[SB_FREEZE_LEVELS];
1459 1460
};

L
Linus Torvalds 已提交
1461 1462 1463
struct super_block {
	struct list_head	s_list;		/* Keep this first */
	dev_t			s_dev;		/* search index; _not_ kdev_t */
1464 1465
	unsigned char		s_blocksize_bits;
	unsigned long		s_blocksize;
1466
	loff_t			s_maxbytes;	/* Max file size */
L
Linus Torvalds 已提交
1467
	struct file_system_type	*s_type;
1468
	const struct super_operations	*s_op;
1469
	const struct dquot_operations	*dq_op;
1470
	const struct quotactl_ops	*s_qcop;
1471
	const struct export_operations *s_export_op;
L
Linus Torvalds 已提交
1472
	unsigned long		s_flags;
1473
	unsigned long		s_iflags;	/* internal SB_I_* flags */
L
Linus Torvalds 已提交
1474 1475 1476 1477 1478
	unsigned long		s_magic;
	struct dentry		*s_root;
	struct rw_semaphore	s_umount;
	int			s_count;
	atomic_t		s_active;
1479
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
1480
	void                    *s_security;
1481
#endif
1482
	const struct xattr_handler **s_xattr;
1483
#ifdef CONFIG_FS_ENCRYPTION
1484
	const struct fscrypt_operations	*s_cop;
1485
	struct key		*s_master_keys; /* master crypto keys in use */
1486 1487 1488
#endif
#ifdef CONFIG_FS_VERITY
	const struct fsverity_operations *s_vop;
1489 1490 1491 1492
#endif
#ifdef CONFIG_UNICODE
	struct unicode_map *s_encoding;
	__u16 s_encoding_flags;
1493
#endif
1494
	struct hlist_bl_head	s_roots;	/* alternate root dentries for NFS */
1495
	struct list_head	s_mounts;	/* list of mounts; _not_ for fs use */
L
Linus Torvalds 已提交
1496
	struct block_device	*s_bdev;
J
Jens Axboe 已提交
1497
	struct backing_dev_info *s_bdi;
1498
	struct mtd_info		*s_mtd;
A
Al Viro 已提交
1499
	struct hlist_node	s_instances;
1500
	unsigned int		s_quota_types;	/* Bitmask of supported quota types */
L
Linus Torvalds 已提交
1501 1502
	struct quota_info	s_dquot;	/* Diskquota specific options */

1503
	struct sb_writers	s_writers;
L
Linus Torvalds 已提交
1504

1505 1506 1507 1508 1509 1510 1511 1512 1513
	/*
	 * 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;
1514 1515 1516
	/* Time limits for c/m/atime in seconds */
	time64_t		   s_time_min;
	time64_t		   s_time_max;
1517 1518 1519 1520 1521
#ifdef CONFIG_FSNOTIFY
	__u32			s_fsnotify_mask;
	struct fsnotify_mark_connector __rcu	*s_fsnotify_marks;
#endif

1522 1523
	char			s_id[32];	/* Informational name */
	uuid_t			s_uuid;		/* UUID */
L
Linus Torvalds 已提交
1524

1525
	unsigned int		s_max_links;
1526
	fmode_t			s_mode;
L
Linus Torvalds 已提交
1527 1528 1529 1530 1531

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

M
Miklos Szeredi 已提交
1534 1535 1536 1537
	/*
	 * Filesystem subtype.  If non-empty the filesystem type field
	 * in /proc/mounts will be "type.subtype"
	 */
1538
	const char *s_subtype;
1539

A
Al Viro 已提交
1540
	const struct dentry_operations *s_d_op; /* default d_op for dentries */
1541 1542 1543 1544 1545

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

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

M
Miklos Szeredi 已提交
1549 1550 1551
	/* Number of inodes with nlink == 0 but still referenced */
	atomic_long_t s_remove_count;

1552 1553 1554 1555 1556
	/*
	 * Number of inode/mount/sb objects that are being watched, note that
	 * inodes objects are currently double-accounted.
	 */
	atomic_long_t s_fsnotify_connectors;
1557

1558 1559
	/* Being remounted read-only */
	int s_readonly_remount;
1560

1561 1562 1563
	/* per-sb errseq_t for reporting writeback errors via syncfs */
	errseq_t s_wb_err;

1564 1565
	/* AIO completions deferred from interrupt context */
	struct workqueue_struct *s_dio_done_wq;
A
Al Viro 已提交
1566
	struct hlist_head s_pins;
1567

1568 1569 1570 1571 1572 1573 1574
	/*
	 * 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;

1575
	/*
1576 1577 1578
	 * 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.
1579
	 */
1580 1581
	struct list_lru		s_dentry_lru;
	struct list_lru		s_inode_lru;
A
Al Viro 已提交
1582
	struct rcu_head		rcu;
1583
	struct work_struct	destroy_work;
1584

1585
	struct mutex		s_sync_lock;	/* sync serialisation lock */
1586 1587 1588 1589 1590

	/*
	 * Indicates how deep in a filesystem stack this SB is
	 */
	int s_stack_depth;
1591 1592 1593 1594

	/* s_inode_list_lock protects s_inodes */
	spinlock_t		s_inode_list_lock ____cacheline_aligned_in_smp;
	struct list_head	s_inodes;	/* all inodes */
1595 1596 1597

	spinlock_t		s_inode_wblist_lock;
	struct list_head	s_inodes_wb;	/* writeback inodes */
1598
} __randomize_layout;
L
Linus Torvalds 已提交
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
/* 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);
}

C
Christian Brauner 已提交
1625 1626 1627 1628 1629 1630 1631 1632
/**
 * kuid_into_mnt - map a kuid down into a mnt_userns
 * @mnt_userns: user namespace of the relevant mount
 * @kuid: kuid to be mapped
 *
 * Return: @kuid mapped according to @mnt_userns.
 * If @kuid has no mapping INVALID_UID is returned.
 */
1633 1634 1635 1636 1637 1638
static inline kuid_t kuid_into_mnt(struct user_namespace *mnt_userns,
				   kuid_t kuid)
{
	return make_kuid(mnt_userns, __kuid_val(kuid));
}

C
Christian Brauner 已提交
1639 1640 1641 1642 1643 1644 1645 1646
/**
 * kgid_into_mnt - map a kgid down into a mnt_userns
 * @mnt_userns: user namespace of the relevant mount
 * @kgid: kgid to be mapped
 *
 * Return: @kgid mapped according to @mnt_userns.
 * If @kgid has no mapping INVALID_GID is returned.
 */
1647 1648 1649 1650 1651 1652
static inline kgid_t kgid_into_mnt(struct user_namespace *mnt_userns,
				   kgid_t kgid)
{
	return make_kgid(mnt_userns, __kgid_val(kgid));
}

C
Christian Brauner 已提交
1653 1654 1655 1656 1657 1658 1659 1660
/**
 * i_uid_into_mnt - map an inode's i_uid down into a mnt_userns
 * @mnt_userns: user namespace of the mount the inode was found from
 * @inode: inode to map
 *
 * Return: the inode's i_uid mapped down according to @mnt_userns.
 * If the inode's i_uid has no mapping INVALID_UID is returned.
 */
1661 1662 1663 1664 1665 1666
static inline kuid_t i_uid_into_mnt(struct user_namespace *mnt_userns,
				    const struct inode *inode)
{
	return kuid_into_mnt(mnt_userns, inode->i_uid);
}

C
Christian Brauner 已提交
1667 1668 1669 1670 1671 1672 1673 1674
/**
 * i_gid_into_mnt - map an inode's i_gid down into a mnt_userns
 * @mnt_userns: user namespace of the mount the inode was found from
 * @inode: inode to map
 *
 * Return: the inode's i_gid mapped down according to @mnt_userns.
 * If the inode's i_gid has no mapping INVALID_GID is returned.
 */
1675 1676 1677 1678 1679 1680
static inline kgid_t i_gid_into_mnt(struct user_namespace *mnt_userns,
				    const struct inode *inode)
{
	return kgid_into_mnt(mnt_userns, inode->i_gid);
}

C
Christian Brauner 已提交
1681 1682 1683 1684 1685 1686 1687 1688
/**
 * kuid_from_mnt - map a kuid up into a mnt_userns
 * @mnt_userns: user namespace of the relevant mount
 * @kuid: kuid to be mapped
 *
 * Return: @kuid mapped up according to @mnt_userns.
 * If @kuid has no mapping INVALID_UID is returned.
 */
1689 1690 1691 1692 1693 1694
static inline kuid_t kuid_from_mnt(struct user_namespace *mnt_userns,
				   kuid_t kuid)
{
	return KUIDT_INIT(from_kuid(mnt_userns, kuid));
}

C
Christian Brauner 已提交
1695 1696 1697 1698 1699 1700 1701 1702
/**
 * kgid_from_mnt - map a kgid up into a mnt_userns
 * @mnt_userns: user namespace of the relevant mount
 * @kgid: kgid to be mapped
 *
 * Return: @kgid mapped up according to @mnt_userns.
 * If @kgid has no mapping INVALID_GID is returned.
 */
1703 1704 1705 1706 1707 1708
static inline kgid_t kgid_from_mnt(struct user_namespace *mnt_userns,
				   kgid_t kgid)
{
	return KGIDT_INIT(from_kgid(mnt_userns, kgid));
}

1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
/**
 * mapped_fsuid - return caller's fsuid mapped up into a mnt_userns
 * @mnt_userns: user namespace of the relevant mount
 *
 * Use this helper to initialize a new vfs or filesystem object based on
 * the caller's fsuid. A common example is initializing the i_uid field of
 * a newly allocated inode triggered by a creation event such as mkdir or
 * O_CREAT. Other examples include the allocation of quotas for a specific
 * user.
 *
 * Return: the caller's current fsuid mapped up according to @mnt_userns.
 */
static inline kuid_t mapped_fsuid(struct user_namespace *mnt_userns)
1722 1723 1724 1725
{
	return kuid_from_mnt(mnt_userns, current_fsuid());
}

1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
/**
 * mapped_fsgid - return caller's fsgid mapped up into a mnt_userns
 * @mnt_userns: user namespace of the relevant mount
 *
 * Use this helper to initialize a new vfs or filesystem object based on
 * the caller's fsgid. A common example is initializing the i_gid field of
 * a newly allocated inode triggered by a creation event such as mkdir or
 * O_CREAT. Other examples include the allocation of quotas for a specific
 * user.
 *
 * Return: the caller's current fsgid mapped up according to @mnt_userns.
 */
static inline kgid_t mapped_fsgid(struct user_namespace *mnt_userns)
1739 1740 1741 1742
{
	return kgid_from_mnt(mnt_userns, current_fsgid());
}

1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
/**
 * inode_fsuid_set - initialize inode's i_uid field with callers fsuid
 * @inode: inode to initialize
 * @mnt_userns: user namespace of the mount the inode was found from
 *
 * Initialize the i_uid field of @inode. If the inode was found/created via
 * an idmapped mount map the caller's fsuid according to @mnt_users.
 */
static inline void inode_fsuid_set(struct inode *inode,
				   struct user_namespace *mnt_userns)
{
	inode->i_uid = mapped_fsuid(mnt_userns);
}

/**
 * inode_fsgid_set - initialize inode's i_gid field with callers fsgid
 * @inode: inode to initialize
 * @mnt_userns: user namespace of the mount the inode was found from
 *
 * Initialize the i_gid field of @inode. If the inode was found/created via
 * an idmapped mount map the caller's fsgid according to @mnt_users.
 */
static inline void inode_fsgid_set(struct inode *inode,
				   struct user_namespace *mnt_userns)
{
	inode->i_gid = mapped_fsgid(mnt_userns);
}

1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
/**
 * fsuidgid_has_mapping() - check whether caller's fsuid/fsgid is mapped
 * @sb: the superblock we want a mapping in
 * @mnt_userns: user namespace of the relevant mount
 *
 * Check whether the caller's fsuid and fsgid have a valid mapping in the
 * s_user_ns of the superblock @sb. If the caller is on an idmapped mount map
 * the caller's fsuid and fsgid according to the @mnt_userns first.
 *
 * Return: true if fsuid and fsgid is mapped, false if not.
 */
static inline bool fsuidgid_has_mapping(struct super_block *sb,
					struct user_namespace *mnt_userns)
{
	struct user_namespace *s_user_ns = sb->s_user_ns;

	return kuid_has_mapping(s_user_ns, mapped_fsuid(mnt_userns)) &&
	       kgid_has_mapping(s_user_ns, mapped_fsgid(mnt_userns));
}

1791
extern struct timespec64 current_time(struct inode *inode);
L
Linus Torvalds 已提交
1792 1793 1794 1795 1796

/*
 * Snapshotting support.
 */

1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
/*
 * These are internal functions, please use sb_start_{write,pagefault,intwrite}
 * instead.
 */
static inline void __sb_end_write(struct super_block *sb, int level)
{
	percpu_up_read(sb->s_writers.rw_sem + level-1);
}

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

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

1816
#define __sb_writers_acquired(sb, lev)	\
1817
	percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1818
#define __sb_writers_release(sb, lev)	\
1819
	percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1820

1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
/**
 * 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)
{
1878
	__sb_start_write(sb, SB_FREEZE_WRITE);
1879 1880
}

1881
static inline bool sb_start_write_trylock(struct super_block *sb)
1882
{
1883
	return __sb_start_write_trylock(sb, SB_FREEZE_WRITE);
1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
}

/**
 * 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
1899
 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
1900 1901
 * handling code implies lock dependency:
 *
1902
 * mmap_lock
1903 1904 1905 1906
 *   -> sb_start_pagefault
 */
static inline void sb_start_pagefault(struct super_block *sb)
{
1907
	__sb_start_write(sb, SB_FREEZE_PAGEFAULT);
1908 1909
}

1910
/**
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
 * 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)
{
1925
	__sb_start_write(sb, SB_FREEZE_FS);
1926
}
L
Linus Torvalds 已提交
1927

1928
static inline bool sb_start_intwrite_trylock(struct super_block *sb)
1929
{
1930
	return __sb_start_write_trylock(sb, SB_FREEZE_FS);
1931 1932
}

1933 1934
bool inode_owner_or_capable(struct user_namespace *mnt_userns,
			    const struct inode *inode);
1935

L
Linus Torvalds 已提交
1936 1937 1938
/*
 * VFS helper functions..
 */
1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
int vfs_create(struct user_namespace *, struct inode *,
	       struct dentry *, umode_t, bool);
int vfs_mkdir(struct user_namespace *, struct inode *,
	      struct dentry *, umode_t);
int vfs_mknod(struct user_namespace *, struct inode *, struct dentry *,
              umode_t, dev_t);
int vfs_symlink(struct user_namespace *, struct inode *,
		struct dentry *, const char *);
int vfs_link(struct dentry *, struct user_namespace *, struct inode *,
	     struct dentry *, struct inode **);
int vfs_rmdir(struct user_namespace *, struct inode *, struct dentry *);
int vfs_unlink(struct user_namespace *, struct inode *, struct dentry *,
	       struct inode **);
1952

1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
/**
 * struct renamedata - contains all information required for renaming
 * @old_mnt_userns:    old user namespace of the mount the inode was found from
 * @old_dir:           parent of source
 * @old_dentry:                source
 * @new_mnt_userns:    new user namespace of the mount the inode was found from
 * @new_dir:           parent of destination
 * @new_dentry:                destination
 * @delegated_inode:   returns an inode needing a delegation break
 * @flags:             rename flags
 */
1964
struct renamedata {
1965
	struct user_namespace *old_mnt_userns;
1966 1967
	struct inode *old_dir;
	struct dentry *old_dentry;
1968
	struct user_namespace *new_mnt_userns;
1969 1970 1971 1972 1973
	struct inode *new_dir;
	struct dentry *new_dentry;
	struct inode **delegated_inode;
	unsigned int flags;
} __randomize_layout;
1974

1975
int vfs_rename(struct renamedata *);
1976

1977 1978
static inline int vfs_whiteout(struct user_namespace *mnt_userns,
			       struct inode *dir, struct dentry *dentry)
1979
{
1980 1981
	return vfs_mknod(mnt_userns, dir, dentry, S_IFCHR | WHITEOUT_MODE,
			 WHITEOUT_DEV);
1982
}
L
Linus Torvalds 已提交
1983

1984 1985
struct dentry *vfs_tmpfile(struct user_namespace *mnt_userns,
			   struct dentry *dentry, umode_t mode, int open_flag);
1986

A
Al Viro 已提交
1987 1988 1989 1990
int vfs_mkobj(struct dentry *, umode_t,
		int (*f)(struct dentry *, umode_t, void *),
		void *);

C
Christoph Hellwig 已提交
1991
int vfs_fchown(struct file *file, uid_t user, gid_t group);
C
Christoph Hellwig 已提交
1992
int vfs_fchmod(struct file *file, umode_t mode);
C
Christoph Hellwig 已提交
1993
int vfs_utimes(const struct path *path, struct timespec64 *times);
C
Christoph Hellwig 已提交
1994

1995 1996
extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);

1997 1998 1999 2000 2001 2002 2003
#ifdef CONFIG_COMPAT
extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
					unsigned long arg);
#else
#define compat_ptr_ioctl NULL
#endif

2004 2005 2006
/*
 * VFS file helper functions.
 */
2007 2008
void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
		      const struct inode *dir, umode_t mode);
2009
extern bool may_open_dev(const struct path *path);
M
Mark Fasheh 已提交
2010

L
Linus Torvalds 已提交
2011 2012 2013 2014 2015 2016
/*
 * 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.
 */
2017 2018 2019 2020
struct dir_context;
typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
			 unsigned);

2021
struct dir_context {
2022
	filldir_t actor;
2023
	loff_t pos;
2024
};
2025

2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
/*
 * 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)

2045 2046 2047
/*
 * 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".
2048
 * See Documentation/filesystems/vfs.rst for more details about this call.
2049 2050
 *
 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
2051
 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
2052 2053
 */
#define REMAP_FILE_DEDUP		(1 << 0)
2054
#define REMAP_FILE_CAN_SHORTEN		(1 << 1)
2055 2056 2057 2058 2059 2060 2061 2062

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

2065 2066
struct iov_iter;

L
Linus Torvalds 已提交
2067 2068 2069 2070 2071
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 *);
2072 2073
	ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
	ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
2074
	int (*iopoll)(struct kiocb *kiocb, unsigned int flags);
2075
	int (*iterate) (struct file *, struct dir_context *);
2076
	int (*iterate_shared) (struct file *, struct dir_context *);
A
Al Viro 已提交
2077
	__poll_t (*poll) (struct file *, struct poll_table_struct *);
L
Linus Torvalds 已提交
2078 2079 2080
	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 *);
2081
	unsigned long mmap_supported_flags;
L
Linus Torvalds 已提交
2082
	int (*open) (struct inode *, struct file *);
2083
	int (*flush) (struct file *, fl_owner_t id);
L
Linus Torvalds 已提交
2084
	int (*release) (struct inode *, struct file *);
2085
	int (*fsync) (struct file *, loff_t, loff_t, int datasync);
L
Linus Torvalds 已提交
2086 2087 2088 2089 2090 2091
	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 *);
2092 2093
	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);
2094
	int (*setlease)(struct file *, long, struct file_lock **, void **);
2095 2096
	long (*fallocate)(struct file *file, int mode, loff_t offset,
			  loff_t len);
2097
	void (*show_fdinfo)(struct seq_file *m, struct file *f);
2098 2099 2100
#ifndef CONFIG_MMU
	unsigned (*mmap_capabilities)(struct file *);
#endif
2101 2102
	ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
			loff_t, size_t, unsigned int);
2103 2104 2105
	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);
2106
	int (*fadvise)(struct file *, loff_t, loff_t, int);
2107
} __randomize_layout;
L
Linus Torvalds 已提交
2108 2109

struct inode_operations {
A
Al Viro 已提交
2110
	struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
2111
	const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
2112
	int (*permission) (struct user_namespace *, struct inode *, int);
2113
	struct posix_acl * (*get_acl)(struct inode *, int, bool);
2114 2115 2116

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

2117 2118
	int (*create) (struct user_namespace *, struct inode *,struct dentry *,
		       umode_t, bool);
L
Linus Torvalds 已提交
2119 2120
	int (*link) (struct dentry *,struct inode *,struct dentry *);
	int (*unlink) (struct inode *,struct dentry *);
2121 2122 2123 2124
	int (*symlink) (struct user_namespace *, struct inode *,struct dentry *,
			const char *);
	int (*mkdir) (struct user_namespace *, struct inode *,struct dentry *,
		      umode_t);
L
Linus Torvalds 已提交
2125
	int (*rmdir) (struct inode *,struct dentry *);
2126 2127 2128
	int (*mknod) (struct user_namespace *, struct inode *,struct dentry *,
		      umode_t,dev_t);
	int (*rename) (struct user_namespace *, struct inode *, struct dentry *,
M
Miklos Szeredi 已提交
2129
			struct inode *, struct dentry *, unsigned int);
2130 2131 2132 2133
	int (*setattr) (struct user_namespace *, struct dentry *,
			struct iattr *);
	int (*getattr) (struct user_namespace *, const struct path *,
			struct kstat *, u32, unsigned int);
L
Linus Torvalds 已提交
2134
	ssize_t (*listxattr) (struct dentry *, char *, size_t);
M
Mark Fasheh 已提交
2135 2136
	int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
		      u64 len);
2137
	int (*update_time)(struct inode *, struct timespec64 *, int);
A
Al Viro 已提交
2138
	int (*atomic_open)(struct inode *, struct dentry *,
A
Al Viro 已提交
2139
			   struct file *, unsigned open_flag,
2140
			   umode_t create_mode);
2141 2142 2143 2144
	int (*tmpfile) (struct user_namespace *, struct inode *,
			struct dentry *, umode_t);
	int (*set_acl)(struct user_namespace *, struct inode *,
		       struct posix_acl *, int);
M
Miklos Szeredi 已提交
2145 2146 2147
	int (*fileattr_set)(struct user_namespace *mnt_userns,
			    struct dentry *dentry, struct fileattr *fa);
	int (*fileattr_get)(struct dentry *dentry, struct fileattr *fa);
2148
} ____cacheline_aligned;
L
Linus Torvalds 已提交
2149

2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
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);
}

2162 2163 2164 2165 2166
static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
{
	return file->f_op->mmap(file, vma);
}

L
Linus Torvalds 已提交
2167 2168
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 *);
2169 2170
extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
				   loff_t, size_t, unsigned int);
2171 2172 2173
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);
2174 2175
extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
					 struct file *file_out, loff_t pos_out,
2176 2177 2178 2179
					 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,
2180
				  loff_t len, unsigned int remap_flags);
2181 2182
extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
				   struct file *file_out, loff_t pos_out,
2183
				   loff_t len, unsigned int remap_flags);
2184 2185
extern int vfs_dedupe_file_range(struct file *file,
				 struct file_dedupe_range *same);
2186 2187
extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
					struct file *dst_file, loff_t dst_pos,
2188
					loff_t len, unsigned int remap_flags);
2189

L
Linus Torvalds 已提交
2190 2191 2192 2193

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

2196
   	void (*dirty_inode) (struct inode *, int flags);
2197
	int (*write_inode) (struct inode *, struct writeback_control *wbc);
2198
	int (*drop_inode) (struct inode *);
A
Al Viro 已提交
2199
	void (*evict_inode) (struct inode *);
L
Linus Torvalds 已提交
2200 2201
	void (*put_super) (struct super_block *);
	int (*sync_fs)(struct super_block *sb, int wait);
2202
	int (*freeze_super) (struct super_block *);
2203
	int (*freeze_fs) (struct super_block *);
2204
	int (*thaw_super) (struct super_block *);
2205
	int (*unfreeze_fs) (struct super_block *);
2206
	int (*statfs) (struct dentry *, struct kstatfs *);
L
Linus Torvalds 已提交
2207
	int (*remount_fs) (struct super_block *, int *, char *);
2208
	void (*umount_begin) (struct super_block *);
L
Linus Torvalds 已提交
2209

2210
	int (*show_options)(struct seq_file *, struct dentry *);
2211
	int (*show_devname)(struct seq_file *, struct dentry *);
2212
	int (*show_path)(struct seq_file *, struct dentry *);
2213
	int (*show_stats)(struct seq_file *, struct dentry *);
2214
#ifdef CONFIG_QUOTA
L
Linus Torvalds 已提交
2215 2216
	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);
2217
	struct dquot **(*get_dquots)(struct inode *);
2218
#endif
2219 2220 2221 2222
	long (*nr_cached_objects)(struct super_block *,
				  struct shrink_control *);
	long (*free_cached_objects)(struct super_block *,
				    struct shrink_control *);
L
Linus Torvalds 已提交
2223 2224
};

D
David Howells 已提交
2225 2226 2227
/*
 * Inode flags - they have no relation to superblock flags now
 */
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240
#define S_SYNC		(1 << 0)  /* Writes are synced at once */
#define S_NOATIME	(1 << 1)  /* Do not update access times */
#define S_APPEND	(1 << 2)  /* Append-only file */
#define S_IMMUTABLE	(1 << 3)  /* Immutable file */
#define S_DEAD		(1 << 4)  /* removed, but still open directory */
#define S_NOQUOTA	(1 << 5)  /* Inode is not counted to quota */
#define S_DIRSYNC	(1 << 6)  /* Directory modifications are synchronous */
#define S_NOCMTIME	(1 << 7)  /* Do not update file c/mtime */
#define S_SWAPFILE	(1 << 8)  /* Do not truncate: swapon got its bmaps */
#define S_PRIVATE	(1 << 9)  /* Inode is fs-internal */
#define S_IMA		(1 << 10) /* Inode has an associated IMA struct */
#define S_AUTOMOUNT	(1 << 11) /* Automount/referral quasi-directory */
#define S_NOSEC		(1 << 12) /* no suid or xattr security attributes */
2241
#ifdef CONFIG_FS_DAX
2242
#define S_DAX		(1 << 13) /* Direct Access, avoiding the page cache */
2243
#else
2244
#define S_DAX		0	  /* Make all the DAX code disappear */
2245
#endif
2246 2247 2248
#define S_ENCRYPTED	(1 << 14) /* Encrypted file (using fs/crypto/) */
#define S_CASEFOLD	(1 << 15) /* Casefolded file */
#define S_VERITY	(1 << 16) /* Verity file (using fs/verity/) */
D
David Howells 已提交
2249 2250 2251 2252 2253 2254 2255

/*
 * 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.
 *
2256
 * Exception: SB_RDONLY is always applied to the entire file system.
D
David Howells 已提交
2257 2258 2259 2260 2261 2262 2263 2264
 *
 * 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))

2265
static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
2266
#define IS_RDONLY(inode)	sb_rdonly((inode)->i_sb)
2267
#define IS_SYNC(inode)		(__IS_FLG(inode, SB_SYNCHRONOUS) || \
D
David Howells 已提交
2268
					((inode)->i_flags & S_SYNC))
2269
#define IS_DIRSYNC(inode)	(__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
D
David Howells 已提交
2270
					((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
2271 2272 2273
#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 已提交
2274 2275 2276 2277

#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)
2278
#define IS_POSIXACL(inode)	__IS_FLG(inode, SB_POSIXACL)
D
David Howells 已提交
2279 2280 2281 2282 2283 2284 2285 2286

#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)
2287
#define IS_DAX(inode)		((inode)->i_flags & S_DAX)
2288
#define IS_ENCRYPTED(inode)	((inode)->i_flags & S_ENCRYPTED)
2289
#define IS_CASEFOLDED(inode)	((inode)->i_flags & S_CASEFOLD)
2290
#define IS_VERITY(inode)	((inode)->i_flags & S_VERITY)
D
David Howells 已提交
2291

M
Miklos Szeredi 已提交
2292 2293 2294
#define IS_WHITEOUT(inode)	(S_ISCHR(inode->i_mode) && \
				 (inode)->i_rdev == WHITEOUT_DEV)

2295 2296
static inline bool HAS_UNMAPPED_ID(struct user_namespace *mnt_userns,
				   struct inode *inode)
2297
{
2298 2299
	return !uid_valid(i_uid_into_mnt(mnt_userns, inode)) ||
	       !gid_valid(i_gid_into_mnt(mnt_userns, inode));
2300 2301
}

2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
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);

2312 2313 2314 2315 2316 2317 2318 2319 2320
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;
}

2321 2322 2323 2324 2325
static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
{
	*kiocb = (struct kiocb) {
		.ki_filp = filp,
		.ki_flags = iocb_flags(filp),
2326
		.ki_hint = ki_hint_validate(file_write_hint(filp)),
2327
		.ki_ioprio = get_current_ioprio(),
2328 2329 2330
	};
}

2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
			       struct file *filp)
{
	*kiocb = (struct kiocb) {
		.ki_filp = filp,
		.ki_flags = kiocb_src->ki_flags,
		.ki_hint = kiocb_src->ki_hint,
		.ki_ioprio = kiocb_src->ki_ioprio,
		.ki_pos = kiocb_src->ki_pos,
	};
}

J
Joern Engel 已提交
2343
/*
2344
 * Inode state bits.  Protected by inode->i_lock
J
Joern Engel 已提交
2345
 *
2346 2347
 * Four bits determine the dirty state of the inode: I_DIRTY_SYNC,
 * I_DIRTY_DATASYNC, I_DIRTY_PAGES, and I_DIRTY_TIME.
J
Joern Engel 已提交
2348 2349 2350 2351 2352
 *
 * 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 已提交
2353
 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
J
Joern Engel 已提交
2354
 *
J
Joern Engel 已提交
2355
 * I_DIRTY_SYNC		Inode is dirty, but doesn't have to be written on
2356 2357 2358
 *			fdatasync() (unless I_DIRTY_DATASYNC is also set).
 *			Timestamp updates are the usual cause.
 * I_DIRTY_DATASYNC	Data-related inode changes pending.  We keep track of
2359 2360
 *			these changes separately from I_DIRTY_SYNC so that we
 *			don't have to write inode on fdatasync() when only
2361
 *			e.g. the timestamps have changed.
J
Joern Engel 已提交
2362
 * I_DIRTY_PAGES	Inode has dirty pages.  Inode itself may be clean.
2363 2364 2365 2366 2367 2368 2369
 * I_DIRTY_TIME		The inode itself only has dirty timestamps, and the
 *			lazytime mount option is enabled.  We keep track of this
 *			separately from I_DIRTY_SYNC in order to implement
 *			lazytime.  This gets cleared if I_DIRTY_INODE
 *			(I_DIRTY_SYNC and/or I_DIRTY_DATASYNC) gets set.  I.e.
 *			either I_DIRTY_TIME *or* I_DIRTY_INODE can be set in
 *			i_state, but not both.  I_DIRTY_PAGES may still be set.
C
Christoph Hellwig 已提交
2370 2371 2372 2373 2374 2375 2376 2377
 * 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 已提交
2378 2379 2380 2381 2382 2383
 * 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.
2384 2385
 * I_CLEAR		Added by clear_inode().  In this state the inode is
 *			clean and can be destroyed.  Inode keeps I_FREEING.
J
Joern Engel 已提交
2386 2387 2388 2389 2390
 *
 *			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 已提交
2391
 *			if appropriate.  I_NEW is used for waiting.
J
Joern Engel 已提交
2392
 *
2393 2394 2395 2396
 * 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 已提交
2397
 *
C
Christoph Hellwig 已提交
2398 2399 2400 2401
 * 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().
 *
2402 2403
 * I_WB_SWITCH		Cgroup bdi_writeback switching in progress.  Used to
 *			synchronize competing switching instances and to tell
M
Matthew Wilcox 已提交
2404
 *			wb stat updates to grab the i_pages lock.  See
2405
 *			inode_switch_wbs_work_fn() for details.
2406
 *
2407 2408 2409
 * I_OVL_INUSE		Used by overlayfs to get exclusive ownership on upper
 *			and work dirs among overlayfs mounts.
 *
A
Al Viro 已提交
2410 2411
 * I_CREATING		New object's inode in the middle of setting up.
 *
2412 2413
 * I_DONTCACHE		Evict inode as soon as it is not used anymore.
 *
2414 2415 2416 2417
 * I_SYNC_QUEUED	Inode is queued in b_io or b_more_io writeback lists.
 *			Used to detect that mark_inode_dirty() should not move
 * 			inode between dirty lists.
 *
J
Joern Engel 已提交
2418 2419
 * Q: What is the difference between I_WILL_FREE and I_FREEING?
 */
2420 2421 2422
#define I_DIRTY_SYNC		(1 << 0)
#define I_DIRTY_DATASYNC	(1 << 1)
#define I_DIRTY_PAGES		(1 << 2)
C
Christoph Hellwig 已提交
2423 2424
#define __I_NEW			3
#define I_NEW			(1 << __I_NEW)
2425 2426 2427
#define I_WILL_FREE		(1 << 4)
#define I_FREEING		(1 << 5)
#define I_CLEAR			(1 << 6)
C
Christoph Hellwig 已提交
2428
#define __I_SYNC		7
J
Joern Engel 已提交
2429
#define I_SYNC			(1 << __I_SYNC)
2430
#define I_REFERENCED		(1 << 8)
C
Christoph Hellwig 已提交
2431
#define __I_DIO_WAKEUP		9
E
Eric Sandeen 已提交
2432
#define I_DIO_WAKEUP		(1 << __I_DIO_WAKEUP)
2433
#define I_LINKABLE		(1 << 10)
2434
#define I_DIRTY_TIME		(1 << 11)
2435
#define I_WB_SWITCH		(1 << 13)
A
Al Viro 已提交
2436 2437
#define I_OVL_INUSE		(1 << 14)
#define I_CREATING		(1 << 15)
2438
#define I_DONTCACHE		(1 << 16)
2439
#define I_SYNC_QUEUED		(1 << 17)
L
Linus Torvalds 已提交
2440

2441 2442
#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2443
#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
L
Linus Torvalds 已提交
2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455

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

2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470
/*
 * Returns true if the given inode itself only has dirty timestamps (its pages
 * may still be dirty) and isn't currently being allocated or freed.
 * Filesystems should call this if when writing an inode when lazytime is
 * enabled, they want to opportunistically write the timestamps of other inodes
 * located very nearby on-disk, e.g. in the same inode block.  This returns true
 * if the given inode is in need of such an opportunistic update.  Requires
 * i_lock, or at least later re-checking under i_lock.
 */
static inline bool inode_is_dirtytime_only(struct inode *inode)
{
	return (inode->i_state & (I_DIRTY_TIME | I_NEW |
				  I_FREEING | I_WILL_FREE)) == I_DIRTY_TIME;
}

M
Miklos Szeredi 已提交
2471 2472 2473 2474
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);
2475 2476 2477 2478

static inline void inode_inc_link_count(struct inode *inode)
{
	inc_nlink(inode);
2479 2480 2481
	mark_inode_dirty(inode);
}

2482 2483 2484
static inline void inode_dec_link_count(struct inode *inode)
{
	drop_nlink(inode);
2485 2486 2487
	mark_inode_dirty(inode);
}

2488 2489 2490 2491 2492 2493 2494
enum file_time_flags {
	S_ATIME = 1,
	S_MTIME = 2,
	S_CTIME = 4,
	S_VERSION = 8,
};

2495
extern bool atime_needs_update(const struct path *, struct inode *);
A
Al Viro 已提交
2496
extern void touch_atime(const struct path *);
L
Linus Torvalds 已提交
2497 2498 2499
static inline void file_accessed(struct file *file)
{
	if (!(file->f_flags & O_NOATIME))
A
Al Viro 已提交
2500
		touch_atime(&file->f_path);
L
Linus Torvalds 已提交
2501 2502
}

2503 2504
extern int file_modified(struct file *file);

C
Christoph Hellwig 已提交
2505
int sync_inode_metadata(struct inode *inode, int wait);
L
Linus Torvalds 已提交
2506 2507 2508 2509

struct file_system_type {
	const char *name;
	int fs_flags;
D
David Howells 已提交
2510 2511 2512
#define FS_REQUIRES_DEV		1 
#define FS_BINARY_MOUNTDATA	2
#define FS_HAS_SUBTYPE		4
2513
#define FS_USERNS_MOUNT		8	/* Can be mounted by userns root */
2514
#define FS_DISALLOW_NOTIFY_PERM	16	/* Disable fanotify permission events */
2515
#define FS_ALLOW_IDMAP         32      /* FS has been updated to handle vfs idmappings. */
2516
#define FS_THP_SUPPORT		8192	/* Remove once all fs converted */
D
David Howells 已提交
2517
#define FS_RENAME_DOES_D_MOVE	32768	/* FS will handle d_move() during rename() internally. */
A
Al Viro 已提交
2518
	int (*init_fs_context)(struct fs_context *);
2519
	const struct fs_parameter_spec *parameters;
A
Al Viro 已提交
2520 2521
	struct dentry *(*mount) (struct file_system_type *, int,
		       const char *, void *);
L
Linus Torvalds 已提交
2522 2523 2524
	void (*kill_sb) (struct super_block *);
	struct module *owner;
	struct file_system_type * next;
A
Al Viro 已提交
2525
	struct hlist_head fs_supers;
2526

I
Ingo Molnar 已提交
2527
	struct lock_class_key s_lock_key;
2528
	struct lock_class_key s_umount_key;
2529
	struct lock_class_key s_vfs_rename_key;
2530
	struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2531 2532 2533

	struct lock_class_key i_lock_key;
	struct lock_class_key i_mutex_key;
2534
	struct lock_class_key invalidate_lock_key;
2535
	struct lock_class_key i_mutex_dir_key;
L
Linus Torvalds 已提交
2536 2537
};

2538 2539
#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)

A
Al Viro 已提交
2540 2541 2542
extern struct dentry *mount_bdev(struct file_system_type *fs_type,
	int flags, const char *dev_name, void *data,
	int (*fill_super)(struct super_block *, void *, int));
A
Al Viro 已提交
2543 2544 2545
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 已提交
2546 2547 2548
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 已提交
2549
extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
L
Linus Torvalds 已提交
2550 2551 2552 2553 2554
void generic_shutdown_super(struct super_block *sb);
void kill_block_super(struct super_block *sb);
void kill_anon_super(struct super_block *sb);
void kill_litter_super(struct super_block *sb);
void deactivate_super(struct super_block *sb);
A
Al Viro 已提交
2555
void deactivate_locked_super(struct super_block *sb);
L
Linus Torvalds 已提交
2556
int set_anon_super(struct super_block *s, void *data);
2557
int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2558 2559
int get_anon_bdev(dev_t *);
void free_anon_bdev(dev_t);
2560 2561 2562
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 已提交
2563 2564 2565
struct super_block *sget(struct file_system_type *type,
			int (*test)(struct super_block *,void *),
			int (*set)(struct super_block *,void *),
D
David Howells 已提交
2566
			int flags, void *data);
L
Linus Torvalds 已提交
2567 2568 2569 2570 2571 2572

/* 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)
2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583
/*
 * 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 已提交
2584 2585 2586

extern int register_filesystem(struct file_system_type *);
extern int unregister_filesystem(struct file_system_type *);
D
David Howells 已提交
2587
extern struct vfsmount *kern_mount(struct file_system_type *);
2588
extern void kern_unmount(struct vfsmount *mnt);
L
Linus Torvalds 已提交
2589 2590
extern int may_umount_tree(struct vfsmount *);
extern int may_umount(struct vfsmount *);
2591 2592
extern long do_mount(const char *, const char __user *,
		     const char *, unsigned long, void *);
2593
extern struct vfsmount *collect_mounts(const struct path *);
2594
extern void drop_collected_mounts(struct vfsmount *);
A
Al Viro 已提交
2595 2596
extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
			  struct vfsmount *);
A
Al Viro 已提交
2597
extern int vfs_statfs(const struct path *, struct kstatfs *);
A
Al Viro 已提交
2598 2599
extern int user_statfs(const char __user *, struct kstatfs *);
extern int fd_statfs(int, struct kstatfs *);
2600 2601
extern int freeze_super(struct super_block *super);
extern int thaw_super(struct super_block *super);
2602
extern bool our_mnt(struct vfsmount *mnt);
2603 2604 2605
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 已提交
2606

A
Al Viro 已提交
2607 2608
extern int current_umask(void);

2609 2610
extern void ihold(struct inode * inode);
extern void iput(struct inode *);
2611
extern int generic_update_time(struct inode *, struct timespec64 *, int);
2612

M
Miklos Szeredi 已提交
2613
/* /sys/fs */
2614
extern struct kobject *fs_kobj;
M
Miklos Szeredi 已提交
2615

2616
#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2617

2618
#ifdef CONFIG_FILE_LOCKING
L
Linus Torvalds 已提交
2619 2620
static inline int break_lease(struct inode *inode, unsigned int mode)
{
2621 2622
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2623 2624 2625
	 * 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.
2626 2627
	 */
	smp_mb();
2628
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2629
		return __break_lease(inode, mode, FL_LEASE);
L
Linus Torvalds 已提交
2630 2631
	return 0;
}
J
J. Bruce Fields 已提交
2632 2633 2634

static inline int break_deleg(struct inode *inode, unsigned int mode)
{
2635 2636
	/*
	 * Since this check is lockless, we must ensure that any refcounts
2637 2638 2639
	 * 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.
2640 2641
	 */
	smp_mb();
2642
	if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J
J. Bruce Fields 已提交
2643
		return __break_lease(inode, mode, FL_DELEG);
L
Linus Torvalds 已提交
2644 2645
	return 0;
}
J
J. Bruce Fields 已提交
2646

2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668
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 已提交
2669 2670 2671 2672 2673 2674 2675 2676 2677 2678
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;
}

2679
#else /* !CONFIG_FILE_LOCKING */
2680 2681 2682 2683 2684
static inline int break_lease(struct inode *inode, unsigned int mode)
{
	return 0;
}

J
J. Bruce Fields 已提交
2685 2686 2687 2688
static inline int break_deleg(struct inode *inode, unsigned int mode)
{
	return 0;
}
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700

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 已提交
2701 2702 2703 2704 2705
static inline int break_layout(struct inode *inode, bool wait)
{
	return 0;
}

2706
#endif /* CONFIG_FILE_LOCKING */
L
Linus Torvalds 已提交
2707 2708

/* fs/open.c */
2709
struct audit_names;
2710
struct filename {
2711 2712
	const char		*name;	/* pointer to actual string */
	const __user char	*uptr;	/* original userland pointer */
2713
	int			refcnt;
2714
	struct audit_names	*aname;
A
Al Viro 已提交
2715
	const char		iname[];
2716
};
2717
static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
L
Linus Torvalds 已提交
2718

2719 2720 2721 2722
static inline struct user_namespace *file_mnt_user_ns(struct file *file)
{
	return mnt_user_ns(file->f_path.mnt);
}
A
Al Viro 已提交
2723
extern long vfs_truncate(const struct path *, loff_t);
2724 2725
int do_truncate(struct user_namespace *, struct dentry *, loff_t start,
		unsigned int time_attrs, struct file *filp);
2726
extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2727
			loff_t len);
J
Jason Uhlenkott 已提交
2728
extern long do_sys_open(int dfd, const char __user *filename, int flags,
2729
			umode_t mode);
2730
extern struct file *file_open_name(struct filename *, int, umode_t);
2731
extern struct file *filp_open(const char *, int, umode_t);
A
Al Viro 已提交
2732
extern struct file *file_open_root(const struct path *,
2733
				   const char *, int, umode_t);
A
Al Viro 已提交
2734 2735 2736 2737 2738 2739
static inline struct file *file_open_root_mnt(struct vfsmount *mnt,
				   const char *name, int flags, umode_t mode)
{
	return file_open_root(&(struct path){.mnt = mnt, .dentry = mnt->mnt_root},
			      name, flags, mode);
}
2740
extern struct file * dentry_open(const struct path *, int, const struct cred *);
A
Al Viro 已提交
2741 2742
extern struct file * open_with_fake_path(const struct path *, int,
					 struct inode*, const struct cred *);
2743 2744 2745 2746
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 已提交
2747
extern int filp_close(struct file *, fl_owner_t id);
2748

2749
extern struct filename *getname_flags(const char __user *, int, int *);
D
Dmitry Kadashev 已提交
2750
extern struct filename *getname_uflags(const char __user *, int);
2751
extern struct filename *getname(const char __user *);
2752
extern struct filename *getname_kernel(const char *);
2753
extern void putname(struct filename *name);
2754

A
Al Viro 已提交
2755
extern int finish_open(struct file *file, struct dentry *dentry,
2756
			int (*open)(struct inode *, struct file *));
A
Al Viro 已提交
2757
extern int finish_no_open(struct file *file, struct dentry *dentry);
L
Linus Torvalds 已提交
2758 2759 2760

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

2763 2764
extern struct kmem_cache *names_cachep;

2765
#define __getname()		kmem_cache_alloc(names_cachep, GFP_KERNEL)
V
Vegard Nossum 已提交
2766
#define __putname(name)		kmem_cache_free(names_cachep, (void *)(name))
L
Linus Torvalds 已提交
2767

T
Tejun Heo 已提交
2768 2769 2770
extern struct super_block *blockdev_superblock;
static inline bool sb_is_blkdev_sb(struct super_block *sb)
{
2771
	return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
2772
}
2773

2774
void emergency_thaw_all(void);
2775
extern int sync_filesystem(struct super_block *);
2776
extern const struct file_operations def_blk_fops;
2777
extern const struct file_operations def_chr_fops;
L
Linus Torvalds 已提交
2778 2779

/* fs/char_dev.c */
2780
#define CHRDEV_MAJOR_MAX 512
2781 2782
/* Marks the bottom of the first segment of free char majors */
#define CHRDEV_MAJOR_DYN_END 234
2783 2784 2785 2786
/* 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 已提交
2787 2788
extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
extern int register_chrdev_region(dev_t, unsigned, const char *);
2789 2790 2791 2792 2793
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 已提交
2794
extern void unregister_chrdev_region(dev_t, unsigned);
2795
extern void chrdev_show(struct seq_file *,off_t);
L
Linus Torvalds 已提交
2796

2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807
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 已提交
2808 2809 2810 2811
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 *);
2812
extern bool is_bad_inode(struct inode *);
L
Linus Torvalds 已提交
2813 2814 2815

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

2817 2818 2819 2820
void invalidate_mapping_pagevec(struct address_space *mapping,
				pgoff_t start, pgoff_t end,
				unsigned long *nr_pagevec);

L
Linus Torvalds 已提交
2821 2822 2823 2824
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))
2825
		invalidate_mapping_pages(inode->i_mapping, 0, -1);
L
Linus Torvalds 已提交
2826 2827 2828 2829 2830 2831 2832
}
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 *);
2833
extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
2834 2835
extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
				   loff_t lend);
2836 2837
extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
		loff_t start_byte, loff_t end_byte);
2838 2839 2840 2841 2842 2843

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

2844 2845
extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
				  loff_t lend);
2846 2847
extern bool filemap_range_needs_writeback(struct address_space *,
					  loff_t lstart, loff_t lend);
L
Linus Torvalds 已提交
2848 2849
extern int filemap_write_and_wait_range(struct address_space *mapping,
				        loff_t lstart, loff_t lend);
2850 2851
extern int __filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end, int sync_mode);
2852 2853
extern int filemap_fdatawrite_range(struct address_space *mapping,
				loff_t start, loff_t end);
2854
extern int filemap_check_errors(struct address_space *mapping);
2855
extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2856 2857
int filemap_fdatawrite_wbc(struct address_space *mapping,
			   struct writeback_control *wbc);
2858

2859 2860 2861 2862 2863
static inline int filemap_write_and_wait(struct address_space *mapping)
{
	return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
}

2864 2865
extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
						loff_t lend);
2866 2867 2868 2869
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);

2870 2871 2872 2873 2874
static inline int file_write_and_wait(struct file *file)
{
	return file_write_and_wait_range(file, 0, LLONG_MAX);
}

2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896
/**
 * filemap_set_wb_err - set a writeback error on an address_space
 * @mapping: mapping in which to set writeback error
 * @err: error to be set in mapping
 *
 * When writeback fails in some way, we must record that error so that
 * userspace can be informed when fsync and the like are called.  We endeavor
 * to report errors on any file that was open at the time of the error.  Some
 * internal callers also need to know when writeback errors have occurred.
 *
 * When a writeback error occurs, most filesystems will want to call
 * filemap_set_wb_err to record the error in the mapping so that it will be
 * automatically reported whenever fsync is called on the file.
 */
static inline void filemap_set_wb_err(struct address_space *mapping, int err)
{
	/* Fastpath for common case of no error */
	if (unlikely(err))
		__filemap_set_wb_err(mapping, err);
}

/**
A
Andreas Gruenbacher 已提交
2897
 * filemap_check_wb_err - has an error occurred since the mark was sampled?
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923
 * @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);
}

2924 2925
/**
 * file_sample_sb_err - sample the current errseq_t to test for later errors
2926
 * @file: file pointer to be sampled
2927 2928 2929 2930 2931 2932 2933 2934 2935
 *
 * Grab the most current superblock-level errseq_t value for the given
 * struct file.
 */
static inline errseq_t file_sample_sb_err(struct file *file)
{
	return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
}

2936 2937 2938
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);
2939

J
Jens Axboe 已提交
2940 2941 2942
extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
				unsigned int flags);

2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958
/*
 * 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;
2959
}
2960

L
Linus Torvalds 已提交
2961 2962
extern void emergency_sync(void);
extern void emergency_remount(void);
2963

2964
#ifdef CONFIG_BLOCK
2965 2966 2967 2968 2969 2970
extern int bmap(struct inode *inode, sector_t *block);
#else
static inline int bmap(struct inode *inode,  sector_t *block)
{
	return -EINVAL;
}
2971
#endif
2972

C
Christian Brauner 已提交
2973 2974
int notify_change(struct user_namespace *, struct dentry *,
		  struct iattr *, struct inode **);
2975 2976
int inode_permission(struct user_namespace *, struct inode *, int);
int generic_permission(struct user_namespace *, struct inode *, int);
2977 2978
static inline int file_permission(struct file *file, int mask)
{
2979 2980
	return inode_permission(file_mnt_user_ns(file),
				file_inode(file), mask);
2981 2982 2983
}
static inline int path_permission(const struct path *path, int mask)
{
2984 2985
	return inode_permission(mnt_user_ns(path->mnt),
				d_inode(path->dentry), mask);
2986
}
2987 2988
int __check_sticky(struct user_namespace *mnt_userns, struct inode *dir,
		   struct inode *inode);
L
Linus Torvalds 已提交
2989

2990 2991 2992 2993 2994
static inline bool execute_ok(struct inode *inode)
{
	return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
}

A
Al Viro 已提交
2995 2996 2997 2998 2999
static inline bool inode_wrong_type(const struct inode *inode, umode_t mode)
{
	return (inode->i_mode ^ mode) & S_IFMT;
}

3000 3001 3002 3003
static inline void file_start_write(struct file *file)
{
	if (!S_ISREG(file_inode(file)->i_mode))
		return;
3004
	sb_start_write(file_inode(file)->i_sb);
3005 3006
}

3007 3008 3009 3010
static inline bool file_start_write_trylock(struct file *file)
{
	if (!S_ISREG(file_inode(file)->i_mode))
		return true;
3011
	return sb_start_write_trylock(file_inode(file)->i_sb);
3012 3013
}

3014 3015 3016 3017 3018 3019
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);
}
3020

3021
/*
3022 3023 3024 3025 3026
 * This is used for regular files where some users -- especially the
 * currently executed binary in a process, previously handled via
 * VM_DENYWRITE -- cannot handle concurrent write (and maybe mmap
 * read-write shared) accesses.
 *
3027 3028
 * get_write_access() gets write permission for a file.
 * put_write_access() releases this write permission.
3029 3030 3031 3032 3033 3034 3035
 * deny_write_access() denies write access to a file.
 * allow_write_access() re-enables write access to a file.
 *
 * The i_writecount field of an inode can have the following values:
 * 0: no write access, no denied write access
 * < 0: (-i_writecount) users that denied write access to the file.
 * > 0: (i_writecount) users that have write access to the file.
3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047
 *
 * 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 已提交
3048
	struct inode *inode = file_inode(file);
3049 3050
	return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
}
L
Linus Torvalds 已提交
3051 3052 3053 3054 3055 3056 3057
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 已提交
3058
		atomic_inc(&file_inode(file)->i_writecount);
L
Linus Torvalds 已提交
3059
}
3060 3061 3062 3063 3064
static inline bool inode_is_open_for_write(const struct inode *inode)
{
	return atomic_read(&inode->i_writecount) > 0;
}

3065
#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
M
Mimi Zohar 已提交
3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084
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 已提交
3085
extern int do_pipe_flags(int *, int);
L
Linus Torvalds 已提交
3086

3087
extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
3088
ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
3089
extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
3090
extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
L
Linus Torvalds 已提交
3091 3092 3093
extern struct file * open_exec(const char *);
 
/* fs/dcache.c -- generic fs support functions */
Y
Yaowei Bai 已提交
3094
extern bool is_subdir(struct dentry *, struct dentry *);
3095
extern bool path_is_under(const struct path *, const struct path *);
L
Linus Torvalds 已提交
3096

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

L
Linus Torvalds 已提交
3099 3100 3101
#include <linux/err.h>

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

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

3106
extern int inode_init_always(struct super_block *, struct inode *);
L
Linus Torvalds 已提交
3107
extern void inode_init_once(struct inode *);
3108
extern void address_space_init_once(struct address_space *mapping);
L
Linus Torvalds 已提交
3109 3110 3111
extern struct inode * igrab(struct inode *);
extern ino_t iunique(struct super_block *, ino_t);
extern int inode_needs_sync(struct inode *inode);
3112
extern int generic_delete_inode(struct inode *inode);
3113 3114
static inline int generic_drop_inode(struct inode *inode)
{
3115
	return !inode->i_nlink || inode_unhashed(inode);
3116
}
I
Ira Weiny 已提交
3117
extern void d_mark_dontcache(struct inode *inode);
L
Linus Torvalds 已提交
3118

3119 3120 3121
extern struct inode *ilookup5_nowait(struct super_block *sb,
		unsigned long hashval, int (*test)(struct inode *, void *),
		void *data);
L
Linus Torvalds 已提交
3122 3123 3124 3125
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 已提交
3126 3127 3128 3129
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 已提交
3130 3131
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);
3132 3133 3134 3135 3136
extern struct inode *find_inode_nowait(struct super_block *,
				       unsigned long,
				       int (*match)(struct inode *,
						    unsigned long, void *),
				       void *data);
3137 3138 3139
extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
				    int (*)(struct inode *, void *), void *);
extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
A
Al Viro 已提交
3140 3141
extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
extern int insert_inode_locked(struct inode *);
3142 3143 3144 3145 3146
#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 已提交
3147
extern void unlock_new_inode(struct inode *);
A
Al Viro 已提交
3148
extern void discard_new_inode(struct inode *);
3149
extern unsigned int get_next_ino(void);
3150
extern void evict_inodes(struct super_block *sb);
L
Linus Torvalds 已提交
3151

C
Chris Down 已提交
3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166
/*
 * Userspace may rely on the the inode number being non-zero. For example, glibc
 * simply ignores files with zero i_ino in unlink() and other places.
 *
 * As an additional complication, if userspace was compiled with
 * _FILE_OFFSET_BITS=32 on a 64-bit kernel we'll only end up reading out the
 * lower 32 bits, so we need to check that those aren't zero explicitly. With
 * _FILE_OFFSET_BITS=64, this may cause some harmless false-negatives, but
 * better safe than sorry.
 */
static inline bool is_zero_ino(ino_t ino)
{
	return (u32)ino == 0;
}

L
Linus Torvalds 已提交
3167
extern void __iget(struct inode * inode);
3168
extern void iget_failed(struct inode *);
3169
extern void clear_inode(struct inode *);
C
Christoph Hellwig 已提交
3170
extern void __destroy_inode(struct inode *);
3171 3172
extern struct inode *new_inode_pseudo(struct super_block *sb);
extern struct inode *new_inode(struct super_block *sb);
3173
extern void free_inode_nonrcu(struct inode *inode);
3174
extern int should_remove_suid(struct dentry *);
3175
extern int file_remove_privs(struct file *);
L
Linus Torvalds 已提交
3176 3177

extern void __insert_inode_hash(struct inode *, unsigned long hashval);
3178 3179
static inline void insert_inode_hash(struct inode *inode)
{
L
Linus Torvalds 已提交
3180 3181
	__insert_inode_hash(inode, inode->i_ino);
}
3182 3183 3184 3185

extern void __remove_inode_hash(struct inode *);
static inline void remove_inode_hash(struct inode *inode)
{
3186
	if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
3187 3188 3189
		__remove_inode_hash(inode);
}

3190
extern void inode_sb_list_add(struct inode *inode);
L
Linus Torvalds 已提交
3191 3192 3193 3194 3195 3196

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 *);
3197
extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
3198 3199
extern int generic_write_check_limits(struct file *file, loff_t pos,
		loff_t *count);
3200
extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
3201 3202
ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *to,
		ssize_t already_read);
A
Al Viro 已提交
3203
extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
3204 3205
extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
3206
extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3207
extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
A
Andrew Morton 已提交
3208

3209
ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3210
		rwf_t flags);
3211
ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
C
Christoph Hellwig 已提交
3212
		rwf_t flags);
3213 3214 3215 3216
ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
			   struct iov_iter *iter);
ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
			    struct iov_iter *iter);
3217

A
Andrew Morton 已提交
3218
/* fs/splice.c */
3219
extern ssize_t generic_file_splice_read(struct file *, loff_t *,
A
Andrew Morton 已提交
3220
		struct pipe_inode_info *, size_t, unsigned int);
A
Al Viro 已提交
3221
extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3222
		struct file *, loff_t *, size_t, unsigned int);
A
Andrew Morton 已提交
3223
extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
3224
		struct file *out, loff_t *, size_t len, unsigned int flags);
3225 3226 3227
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 已提交
3228

L
Linus Torvalds 已提交
3229 3230
extern void
file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3231 3232
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 已提交
3233
extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3234
extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
A
Andi Kleen 已提交
3235
extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3236
		int whence, loff_t maxsize, loff_t eof);
A
Al Viro 已提交
3237 3238
extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
		int whence, loff_t size);
3239 3240
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 已提交
3241 3242
extern int generic_file_open(struct inode * inode, struct file * filp);
extern int nonseekable_open(struct inode * inode, struct file * filp);
3243
extern int stream_open(struct inode * inode, struct file * filp);
L
Linus Torvalds 已提交
3244

3245
#ifdef CONFIG_BLOCK
3246
typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3247
			    loff_t file_offset);
L
Linus Torvalds 已提交
3248 3249

enum {
3250 3251 3252 3253 3254
	/* need locking between buffered and direct access */
	DIO_LOCKING	= 0x01,

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

3257 3258
ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
			     struct block_device *bdev, struct iov_iter *iter,
3259
			     get_block_t get_block,
3260 3261
			     dio_iodone_t end_io, dio_submit_t submit_io,
			     int flags);
3262

3263 3264
static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
					 struct inode *inode,
3265
					 struct iov_iter *iter,
3266
					 get_block_t get_block)
L
Linus Torvalds 已提交
3267
{
3268
	return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3269
			get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
L
Linus Torvalds 已提交
3270
}
3271
#endif
L
Linus Torvalds 已提交
3272

3273
void inode_dio_wait(struct inode *inode);
3274

3275
/**
3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286
 * 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);
}

3287
/**
3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298
 * 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);
}
3299

3300 3301 3302 3303 3304
/*
 * Warn about a page cache invalidation failure diring a direct I/O write.
 */
void dio_warn_stale_pagecache(struct file *filp);

3305 3306 3307
extern void inode_set_flags(struct inode *inode, unsigned int flags,
			    unsigned int mask);

3308
extern const struct file_operations generic_ro_fops;
L
Linus Torvalds 已提交
3309 3310 3311

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

A
Al Viro 已提交
3312
extern int readlink_copy(char __user *, int, const char *);
L
Linus Torvalds 已提交
3313
extern int page_readlink(struct dentry *, char __user *, int);
3314 3315 3316
extern const char *page_get_link(struct dentry *, struct inode *,
				 struct delayed_call *);
extern void page_put_link(void *);
3317
extern int __page_symlink(struct inode *inode, const char *symname, int len,
3318
		int nofs);
L
Linus Torvalds 已提交
3319
extern int page_symlink(struct inode *inode, const char *symname, int len);
3320
extern const struct inode_operations page_symlink_inode_operations;
3321
extern void kfree_link(void *);
C
Christian Brauner 已提交
3322
void generic_fillattr(struct user_namespace *, struct inode *, struct kstat *);
3323
void generic_fill_statx_attr(struct inode *inode, struct kstat *stat);
3324 3325
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);
3326
void __inode_add_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3327
void inode_add_bytes(struct inode *inode, loff_t bytes);
3328
void __inode_sub_bytes(struct inode *inode, loff_t bytes);
L
Linus Torvalds 已提交
3329
void inode_sub_bytes(struct inode *inode, loff_t bytes);
J
Jan Kara 已提交
3330 3331 3332 3333
static inline loff_t __inode_get_bytes(struct inode *inode)
{
	return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
}
L
Linus Torvalds 已提交
3334 3335
loff_t inode_get_bytes(struct inode *inode);
void inode_set_bytes(struct inode *inode, loff_t bytes);
3336 3337
const char *simple_get_link(struct dentry *, struct inode *,
			    struct delayed_call *);
A
Al Viro 已提交
3338
extern const struct inode_operations simple_symlink_inode_operations;
L
Linus Torvalds 已提交
3339

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

3342 3343
int vfs_fstatat(int dfd, const char __user *filename, struct kstat *stat,
		int flags);
C
Christoph Hellwig 已提交
3344
int vfs_fstat(int fd, struct kstat *stat);
3345 3346 3347

static inline int vfs_stat(const char __user *filename, struct kstat *stat)
{
3348
	return vfs_fstatat(AT_FDCWD, filename, stat, 0);
3349 3350 3351
}
static inline int vfs_lstat(const char __user *name, struct kstat *stat)
{
3352
	return vfs_fstatat(AT_FDCWD, name, stat, AT_SYMLINK_NOFOLLOW);
3353 3354
}

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

3358
extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3359
extern void put_filesystem(struct file_system_type *fs);
L
Linus Torvalds 已提交
3360 3361
extern struct file_system_type *get_fs_type(const char *name);
extern struct super_block *get_super(struct block_device *);
3362
extern struct super_block *get_active_super(struct block_device *bdev);
L
Linus Torvalds 已提交
3363
extern void drop_super(struct super_block *sb);
3364
extern void drop_super_exclusive(struct super_block *sb);
A
Al Viro 已提交
3365
extern void iterate_supers(void (*)(struct super_block *, void *), void *);
A
Al Viro 已提交
3366 3367
extern void iterate_supers_type(struct file_system_type *,
			        void (*)(struct super_block *, void *), void *);
L
Linus Torvalds 已提交
3368 3369 3370 3371

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);
3372
extern int dcache_readdir(struct file *, struct dir_context *);
3373 3374 3375 3376
extern int simple_setattr(struct user_namespace *, struct dentry *,
			  struct iattr *);
extern int simple_getattr(struct user_namespace *, const struct path *,
			  struct kstat *, u32, unsigned int);
3377
extern int simple_statfs(struct dentry *, struct kstatfs *);
S
Stephen Boyd 已提交
3378
extern int simple_open(struct inode *inode, struct file *file);
L
Linus Torvalds 已提交
3379 3380 3381
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 *);
3382 3383 3384
extern int simple_rename(struct user_namespace *, struct inode *,
			 struct dentry *, struct inode *, struct dentry *,
			 unsigned int);
3385 3386
extern void simple_recursive_removal(struct dentry *,
                              void (*callback)(struct dentry *));
3387
extern int noop_fsync(struct file *, loff_t, loff_t, int);
3388 3389 3390
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 已提交
3391
extern int simple_empty(struct dentry *);
3392 3393 3394
extern int simple_write_begin(struct file *file, struct address_space *mapping,
			loff_t pos, unsigned len, unsigned flags,
			struct page **pagep, void **fsdata);
C
Christoph Hellwig 已提交
3395
extern const struct address_space_operations ram_aops;
3396
extern int always_delete_dentry(const struct dentry *);
A
Al Viro 已提交
3397
extern struct inode *alloc_anon_inode(struct super_block *);
3398
extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
3399
extern const struct dentry_operations simple_dentry_operations;
L
Linus Torvalds 已提交
3400

A
Al Viro 已提交
3401
extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
L
Linus Torvalds 已提交
3402
extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3403
extern const struct file_operations simple_dir_operations;
3404
extern const struct inode_operations simple_dir_inode_operations;
3405 3406
extern void make_empty_dir_inode(struct inode *inode);
extern bool is_empty_dir_inode(struct inode *inode);
3407
struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
L
Linus Torvalds 已提交
3408
struct dentry *d_alloc_name(struct dentry *, const char *);
3409 3410
extern int simple_fill_super(struct super_block *, unsigned long,
			     const struct tree_descr *);
3411
extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
L
Linus Torvalds 已提交
3412 3413
extern void simple_release_fs(struct vfsmount **mount, int *count);

3414 3415
extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
			loff_t *ppos, const void *from, size_t available);
3416 3417
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 已提交
3418

3419
extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3420
extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
A
Al Viro 已提交
3421

3422 3423
extern int generic_check_addressable(unsigned, u64);

3424
extern void generic_set_encrypted_ci_d_ops(struct dentry *dentry);
3425

3426
#ifdef CONFIG_MIGRATION
3427
extern int buffer_migrate_page(struct address_space *,
3428 3429
				struct page *, struct page *,
				enum migrate_mode);
3430 3431 3432
extern int buffer_migrate_page_norefs(struct address_space *,
				struct page *, struct page *,
				enum migrate_mode);
3433 3434
#else
#define buffer_migrate_page NULL
3435
#define buffer_migrate_page_norefs NULL
3436 3437
#endif

3438 3439
int may_setattr(struct user_namespace *mnt_userns, struct inode *inode,
		unsigned int ia_valid);
C
Christian Brauner 已提交
3440
int setattr_prepare(struct user_namespace *, struct dentry *, struct iattr *);
N
npiggin@suse.de 已提交
3441
extern int inode_newsize_ok(const struct inode *, loff_t offset);
C
Christian Brauner 已提交
3442 3443
void setattr_copy(struct user_namespace *, struct inode *inode,
		  const struct iattr *attr);
L
Linus Torvalds 已提交
3444

3445
extern int file_update_time(struct file *file);
L
Linus Torvalds 已提交
3446

3447
static inline bool vma_is_dax(const struct vm_area_struct *vma)
3448 3449 3450 3451
{
	return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
}

3452 3453 3454 3455
static inline bool vma_is_fsdax(struct vm_area_struct *vma)
{
	struct inode *inode;

3456
	if (!IS_ENABLED(CONFIG_FS_DAX) || !vma->vm_file)
3457 3458 3459 3460
		return false;
	if (!vma_is_dax(vma))
		return false;
	inode = file_inode(vma->vm_file);
D
Dan Williams 已提交
3461
	if (S_ISCHR(inode->i_mode))
3462 3463 3464 3465
		return false; /* device-dax */
	return true;
}

3466 3467 3468 3469 3470
static inline int iocb_flags(struct file *file)
{
	int res = 0;
	if (file->f_flags & O_APPEND)
		res |= IOCB_APPEND;
3471
	if (file->f_flags & O_DIRECT)
3472
		res |= IOCB_DIRECT;
3473 3474 3475 3476
	if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
		res |= IOCB_DSYNC;
	if (file->f_flags & __O_SYNC)
		res |= IOCB_SYNC;
3477 3478 3479
	return res;
}

C
Christoph Hellwig 已提交
3480
static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
3481
{
3482 3483
	int kiocb_flags = 0;

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

3487 3488
	if (!flags)
		return 0;
3489 3490 3491
	if (unlikely(flags & ~RWF_SUPPORTED))
		return -EOPNOTSUPP;

3492
	if (flags & RWF_NOWAIT) {
3493
		if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3494
			return -EOPNOTSUPP;
3495
		kiocb_flags |= IOCB_NOIO;
3496
	}
3497
	kiocb_flags |= (__force int) (flags & RWF_SUPPORTED);
3498
	if (flags & RWF_SYNC)
3499
		kiocb_flags |= IOCB_DSYNC;
3500 3501

	ki->ki_flags |= kiocb_flags;
3502 3503 3504
	return 0;
}

L
Linus Torvalds 已提交
3505 3506 3507 3508
static inline ino_t parent_ino(struct dentry *dentry)
{
	ino_t res;

N
Nick Piggin 已提交
3509 3510 3511 3512
	/*
	 * 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 已提交
3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526
	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;
3527
	char data[];
L
Linus Torvalds 已提交
3528 3529 3530 3531 3532 3533 3534 3535 3536 3537
};

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

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

3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561
/*
 * 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);	\
}									\
3562
static const struct file_operations __fops = {				\
3563 3564
	.owner	 = THIS_MODULE,						\
	.open	 = __fops ## _open,					\
3565
	.release = simple_attr_release,					\
3566 3567
	.read	 = simple_attr_read,					\
	.write	 = simple_attr_write,					\
3568
	.llseek	 = generic_file_llseek,					\
3569
}
3570

3571 3572
static inline __printf(1, 2)
void __simple_attr_check_format(const char *fmt, ...)
3573 3574 3575 3576 3577
{
	/* don't do anything, just let the compiler check the arguments; */
}

int simple_attr_open(struct inode *inode, struct file *file,
3578
		     int (*get)(void *, u64 *), int (*set)(void *, u64),
3579
		     const char *fmt);
3580
int simple_attr_release(struct inode *inode, struct file *file);
3581 3582 3583 3584 3585
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 已提交
3586
struct ctl_table;
3587
int proc_nr_files(struct ctl_table *table, int write,
3588
		  void *buffer, size_t *lenp, loff_t *ppos);
3589
int proc_nr_dentry(struct ctl_table *table, int write,
3590
		  void *buffer, size_t *lenp, loff_t *ppos);
3591
int proc_nr_inodes(struct ctl_table *table, int write,
3592
		   void *buffer, size_t *lenp, loff_t *ppos);
3593
int __init list_bdev_fs_names(char *buf, size_t size);
3594

N
Namhyung Kim 已提交
3595
#define __FMODE_EXEC		((__force int) FMODE_EXEC)
3596 3597
#define __FMODE_NONOTIFY	((__force int) FMODE_NONOTIFY)

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

Y
Yaowei Bai 已提交
3602
static inline bool is_sxid(umode_t mode)
3603 3604 3605 3606
{
	return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
}

3607 3608
static inline int check_sticky(struct user_namespace *mnt_userns,
			       struct inode *dir, struct inode *inode)
M
Miklos Szeredi 已提交
3609 3610 3611 3612
{
	if (!(dir->i_mode & S_ISVTX))
		return 0;

3613
	return __check_sticky(mnt_userns, dir, inode);
M
Miklos Szeredi 已提交
3614 3615
}

3616 3617
static inline void inode_has_no_xattr(struct inode *inode)
{
3618
	if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3619 3620 3621
		inode->i_flags |= S_NOSEC;
}

A
Al Viro 已提交
3622 3623 3624 3625 3626
static inline bool is_root_inode(struct inode *inode)
{
	return inode == inode->i_sb->s_root->d_inode;
}

3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656
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 已提交
3657 3658
static inline bool dir_relax(struct inode *inode)
{
A
Al Viro 已提交
3659 3660
	inode_unlock(inode);
	inode_lock(inode);
A
Al Viro 已提交
3661 3662
	return !IS_DEADDIR(inode);
}
3663

A
Al Viro 已提交
3664 3665 3666 3667 3668 3669 3670
static inline bool dir_relax_shared(struct inode *inode)
{
	inode_unlock_shared(inode);
	inode_lock_shared(inode);
	return !IS_DEADDIR(inode);
}

3671
extern bool path_noexec(const struct path *path);
3672
extern void inode_nohighmem(struct inode *inode);
3673

3674 3675 3676
/* mm/fadvise.c */
extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
		       int advice);
J
Jan Kara 已提交
3677 3678
extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
			   int advice);
3679

3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690
/*
 * 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 已提交
3691
#endif /* _LINUX_FS_H */