aio.c 53.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/*
 *	An async IO implementation for Linux
 *	Written by Benjamin LaHaise <bcrl@kvack.org>
 *
 *	Implements an efficient asynchronous io interface.
 *
 *	Copyright 2000, 2001, 2002 Red Hat, Inc.  All Rights Reserved.
C
Christoph Hellwig 已提交
8
 *	Copyright 2018 Christoph Hellwig.
L
Linus Torvalds 已提交
9 10 11
 *
 *	See ../COPYING for licensing terms.
 */
K
Kent Overstreet 已提交
12 13
#define pr_fmt(fmt) "%s: " fmt, __func__

L
Linus Torvalds 已提交
14 15 16 17 18
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/errno.h>
#include <linux/time.h>
#include <linux/aio_abi.h>
19
#include <linux/export.h>
L
Linus Torvalds 已提交
20
#include <linux/syscalls.h>
21
#include <linux/backing-dev.h>
22
#include <linux/uio.h>
L
Linus Torvalds 已提交
23

24
#include <linux/sched/signal.h>
L
Linus Torvalds 已提交
25 26 27 28
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/mm.h>
#include <linux/mman.h>
29
#include <linux/mmu_context.h>
K
Kent Overstreet 已提交
30
#include <linux/percpu.h>
L
Linus Torvalds 已提交
31 32 33 34 35 36
#include <linux/slab.h>
#include <linux/timer.h>
#include <linux/aio.h>
#include <linux/highmem.h>
#include <linux/workqueue.h>
#include <linux/security.h>
37
#include <linux/eventfd.h>
J
Jeff Moyer 已提交
38
#include <linux/blkdev.h>
39
#include <linux/compat.h>
40 41
#include <linux/migrate.h>
#include <linux/ramfs.h>
K
Kent Overstreet 已提交
42
#include <linux/percpu-refcount.h>
43
#include <linux/mount.h>
L
Linus Torvalds 已提交
44 45

#include <asm/kmap_types.h>
46
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
47

A
Al Viro 已提交
48 49
#include "internal.h"

50 51
#define KIOCB_KEY		0

52 53 54 55 56 57
#define AIO_RING_MAGIC			0xa10a10a1
#define AIO_RING_COMPAT_FEATURES	1
#define AIO_RING_INCOMPAT_FEATURES	0
struct aio_ring {
	unsigned	id;	/* kernel internal index number */
	unsigned	nr;	/* number of io_events */
58 59
	unsigned	head;	/* Written to by userland or under ring_lock
				 * mutex by aio_read_events_ring(). */
60 61 62 63 64 65 66 67 68 69 70 71 72
	unsigned	tail;

	unsigned	magic;
	unsigned	compat_features;
	unsigned	incompat_features;
	unsigned	header_length;	/* size of aio_ring */


	struct io_event		io_events[0];
}; /* 128 bytes + ring size */

#define AIO_RING_PAGES	8

73
struct kioctx_table {
74 75 76
	struct rcu_head		rcu;
	unsigned		nr;
	struct kioctx __rcu	*table[];
77 78
};

K
Kent Overstreet 已提交
79 80 81 82
struct kioctx_cpu {
	unsigned		reqs_available;
};

83 84 85 86 87
struct ctx_rq_wait {
	struct completion comp;
	atomic_t count;
};

88
struct kioctx {
K
Kent Overstreet 已提交
89
	struct percpu_ref	users;
K
Kent Overstreet 已提交
90
	atomic_t		dead;
91

K
Kent Overstreet 已提交
92 93
	struct percpu_ref	reqs;

94 95
	unsigned long		user_id;

K
Kent Overstreet 已提交
96 97 98 99 100 101 102
	struct __percpu kioctx_cpu *cpu;

	/*
	 * For percpu reqs_available, number of slots we move to/from global
	 * counter at a time:
	 */
	unsigned		req_batch;
103 104 105 106
	/*
	 * This is what userspace passed to io_setup(), it's not used for
	 * anything but counting against the global max_reqs quota.
	 *
K
Kent Overstreet 已提交
107
	 * The real limit is nr_events - 1, which will be larger (see
108 109
	 * aio_setup_ring())
	 */
110 111
	unsigned		max_reqs;

K
Kent Overstreet 已提交
112 113
	/* Size of ringbuffer, in units of struct io_event */
	unsigned		nr_events;
114

K
Kent Overstreet 已提交
115 116 117 118 119 120
	unsigned long		mmap_base;
	unsigned long		mmap_size;

	struct page		**ring_pages;
	long			nr_pages;

121
	struct rcu_work		free_rwork;	/* see free_ioctx() */
122

123 124 125
	/*
	 * signals when all in-flight requests are done
	 */
126
	struct ctx_rq_wait	*rq_wait;
127

128
	struct {
129 130 131 132 133
		/*
		 * This counts the number of available slots in the ringbuffer,
		 * so we avoid overflowing it: it's decremented (if positive)
		 * when allocating a kiocb and incremented when the resulting
		 * io_event is pulled off the ringbuffer.
K
Kent Overstreet 已提交
134 135
		 *
		 * We batch accesses to it with a percpu version.
136 137
		 */
		atomic_t	reqs_available;
138 139 140 141 142 143 144
	} ____cacheline_aligned_in_smp;

	struct {
		spinlock_t	ctx_lock;
		struct list_head active_reqs;	/* used for cancellation */
	} ____cacheline_aligned_in_smp;

K
Kent Overstreet 已提交
145 146
	struct {
		struct mutex	ring_lock;
147 148
		wait_queue_head_t wait;
	} ____cacheline_aligned_in_smp;
K
Kent Overstreet 已提交
149 150 151

	struct {
		unsigned	tail;
152
		unsigned	completed_events;
K
Kent Overstreet 已提交
153
		spinlock_t	completion_lock;
154
	} ____cacheline_aligned_in_smp;
K
Kent Overstreet 已提交
155 156

	struct page		*internal_pages[AIO_RING_PAGES];
157
	struct file		*aio_ring_file;
158 159

	unsigned		id;
160 161
};

162 163 164 165 166 167
struct fsync_iocb {
	struct work_struct	work;
	struct file		*file;
	bool			datasync;
};

C
Christoph Hellwig 已提交
168 169 170 171 172 173 174 175 176 177 178
struct poll_iocb {
	struct file		*file;
	__poll_t		events;
	struct wait_queue_head	*head;

	union {
		struct wait_queue_entry	wait;
		struct work_struct	work;
	};
};

179
struct aio_kiocb {
180 181
	union {
		struct kiocb		rw;
182
		struct fsync_iocb	fsync;
C
Christoph Hellwig 已提交
183
		struct poll_iocb	poll;
184
	};
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

	struct kioctx		*ki_ctx;
	kiocb_cancel_fn		*ki_cancel;

	struct iocb __user	*ki_user_iocb;	/* user's aiocb */
	__u64			ki_user_data;	/* user's data for completion */

	struct list_head	ki_list;	/* the aio core uses this
						 * for cancellation */

	/*
	 * If the aio_resfd field of the userspace iocb is not zero,
	 * this is the underlying eventfd context to deliver events to.
	 */
	struct eventfd_ctx	*ki_eventfd;
};

L
Linus Torvalds 已提交
202
/*------ sysctl variables----*/
203 204 205
static DEFINE_SPINLOCK(aio_nr_lock);
unsigned long aio_nr;		/* current system wide number of aio requests */
unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
L
Linus Torvalds 已提交
206 207
/*----end sysctl variables---*/

208 209
static struct kmem_cache	*kiocb_cachep;
static struct kmem_cache	*kioctx_cachep;
L
Linus Torvalds 已提交
210

211 212 213 214 215 216 217 218 219 220 221
static struct vfsmount *aio_mnt;

static const struct file_operations aio_ring_fops;
static const struct address_space_operations aio_ctx_aops;

static struct file *aio_private_file(struct kioctx *ctx, loff_t nr_pages)
{
	struct qstr this = QSTR_INIT("[aio]", 5);
	struct file *file;
	struct path path;
	struct inode *inode = alloc_anon_inode(aio_mnt->mnt_sb);
222 223
	if (IS_ERR(inode))
		return ERR_CAST(inode);
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

	inode->i_mapping->a_ops = &aio_ctx_aops;
	inode->i_mapping->private_data = ctx;
	inode->i_size = PAGE_SIZE * nr_pages;

	path.dentry = d_alloc_pseudo(aio_mnt->mnt_sb, &this);
	if (!path.dentry) {
		iput(inode);
		return ERR_PTR(-ENOMEM);
	}
	path.mnt = mntget(aio_mnt);

	d_instantiate(path.dentry, inode);
	file = alloc_file(&path, FMODE_READ | FMODE_WRITE, &aio_ring_fops);
	if (IS_ERR(file)) {
		path_put(&path);
		return file;
	}

	file->f_flags = O_RDWR;
	return file;
}

static struct dentry *aio_mount(struct file_system_type *fs_type,
				int flags, const char *dev_name, void *data)
{
	static const struct dentry_operations ops = {
		.d_dname	= simple_dname,
	};
J
Jann Horn 已提交
253 254 255 256 257 258
	struct dentry *root = mount_pseudo(fs_type, "aio:", NULL, &ops,
					   AIO_RING_MAGIC);

	if (!IS_ERR(root))
		root->d_sb->s_iflags |= SB_I_NOEXEC;
	return root;
259 260
}

L
Linus Torvalds 已提交
261 262 263 264 265 266
/* aio_setup
 *	Creates the slab caches used by the aio routines, panic on
 *	failure as this is done early during the boot sequence.
 */
static int __init aio_setup(void)
{
267 268 269 270 271 272 273 274 275
	static struct file_system_type aio_fs = {
		.name		= "aio",
		.mount		= aio_mount,
		.kill_sb	= kill_anon_super,
	};
	aio_mnt = kern_mount(&aio_fs);
	if (IS_ERR(aio_mnt))
		panic("Failed to create aio fs mount.");

276
	kiocb_cachep = KMEM_CACHE(aio_kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
277
	kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
L
Linus Torvalds 已提交
278 279
	return 0;
}
280
__initcall(aio_setup);
L
Linus Torvalds 已提交
281

282 283 284
static void put_aio_ring_file(struct kioctx *ctx)
{
	struct file *aio_ring_file = ctx->aio_ring_file;
285 286
	struct address_space *i_mapping;

287
	if (aio_ring_file) {
A
Al Viro 已提交
288
		truncate_setsize(file_inode(aio_ring_file), 0);
289 290

		/* Prevent further access to the kioctx from migratepages */
A
Al Viro 已提交
291
		i_mapping = aio_ring_file->f_mapping;
292 293
		spin_lock(&i_mapping->private_lock);
		i_mapping->private_data = NULL;
294
		ctx->aio_ring_file = NULL;
295
		spin_unlock(&i_mapping->private_lock);
296 297 298 299 300

		fput(aio_ring_file);
	}
}

L
Linus Torvalds 已提交
301 302
static void aio_free_ring(struct kioctx *ctx)
{
303
	int i;
L
Linus Torvalds 已提交
304

305 306 307 308 309
	/* Disconnect the kiotx from the ring file.  This prevents future
	 * accesses to the kioctx from page migration.
	 */
	put_aio_ring_file(ctx);

310
	for (i = 0; i < ctx->nr_pages; i++) {
311
		struct page *page;
312 313
		pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
				page_count(ctx->ring_pages[i]));
314 315 316 317 318
		page = ctx->ring_pages[i];
		if (!page)
			continue;
		ctx->ring_pages[i] = NULL;
		put_page(page);
319
	}
L
Linus Torvalds 已提交
320

321
	if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
K
Kent Overstreet 已提交
322
		kfree(ctx->ring_pages);
323 324
		ctx->ring_pages = NULL;
	}
325 326
}

327
static int aio_ring_mremap(struct vm_area_struct *vma)
328
{
329
	struct file *file = vma->vm_file;
330 331
	struct mm_struct *mm = vma->vm_mm;
	struct kioctx_table *table;
A
Al Viro 已提交
332
	int i, res = -EINVAL;
333 334 335 336 337 338 339

	spin_lock(&mm->ioctx_lock);
	rcu_read_lock();
	table = rcu_dereference(mm->ioctx_table);
	for (i = 0; i < table->nr; i++) {
		struct kioctx *ctx;

340
		ctx = rcu_dereference(table->table[i]);
341
		if (ctx && ctx->aio_ring_file == file) {
A
Al Viro 已提交
342 343 344 345
			if (!atomic_read(&ctx->dead)) {
				ctx->user_id = ctx->mmap_base = vma->vm_start;
				res = 0;
			}
346 347 348 349 350 351
			break;
		}
	}

	rcu_read_unlock();
	spin_unlock(&mm->ioctx_lock);
A
Al Viro 已提交
352
	return res;
353 354
}

355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
static const struct vm_operations_struct aio_ring_vm_ops = {
	.mremap		= aio_ring_mremap,
#if IS_ENABLED(CONFIG_MMU)
	.fault		= filemap_fault,
	.map_pages	= filemap_map_pages,
	.page_mkwrite	= filemap_page_mkwrite,
#endif
};

static int aio_ring_mmap(struct file *file, struct vm_area_struct *vma)
{
	vma->vm_flags |= VM_DONTEXPAND;
	vma->vm_ops = &aio_ring_vm_ops;
	return 0;
}

371 372 373 374
static const struct file_operations aio_ring_fops = {
	.mmap = aio_ring_mmap,
};

375
#if IS_ENABLED(CONFIG_MIGRATION)
376 377 378
static int aio_migratepage(struct address_space *mapping, struct page *new,
			struct page *old, enum migrate_mode mode)
{
379
	struct kioctx *ctx;
380
	unsigned long flags;
381
	pgoff_t idx;
382 383
	int rc;

384 385 386 387 388 389 390 391
	/*
	 * We cannot support the _NO_COPY case here, because copy needs to
	 * happen under the ctx->completion_lock. That does not work with the
	 * migration workflow of MIGRATE_SYNC_NO_COPY.
	 */
	if (mode == MIGRATE_SYNC_NO_COPY)
		return -EINVAL;

392 393
	rc = 0;

394
	/* mapping->private_lock here protects against the kioctx teardown.  */
395 396
	spin_lock(&mapping->private_lock);
	ctx = mapping->private_data;
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
	if (!ctx) {
		rc = -EINVAL;
		goto out;
	}

	/* The ring_lock mutex.  The prevents aio_read_events() from writing
	 * to the ring's head, and prevents page migration from mucking in
	 * a partially initialized kiotx.
	 */
	if (!mutex_trylock(&ctx->ring_lock)) {
		rc = -EAGAIN;
		goto out;
	}

	idx = old->index;
	if (idx < (pgoff_t)ctx->nr_pages) {
		/* Make sure the old page hasn't already been changed */
		if (ctx->ring_pages[idx] != old)
			rc = -EAGAIN;
416 417 418 419
	} else
		rc = -EINVAL;

	if (rc != 0)
420
		goto out_unlock;
421

422 423
	/* Writeback must be complete */
	BUG_ON(PageWriteback(old));
424
	get_page(new);
425

426
	rc = migrate_page_move_mapping(mapping, new, old, NULL, mode, 1);
427
	if (rc != MIGRATEPAGE_SUCCESS) {
428
		put_page(new);
429
		goto out_unlock;
430 431
	}

432 433 434
	/* Take completion_lock to prevent other writes to the ring buffer
	 * while the old page is copied to the new.  This prevents new
	 * events from being lost.
435
	 */
436 437 438 439 440
	spin_lock_irqsave(&ctx->completion_lock, flags);
	migrate_page_copy(new, old);
	BUG_ON(ctx->ring_pages[idx] != old);
	ctx->ring_pages[idx] = new;
	spin_unlock_irqrestore(&ctx->completion_lock, flags);
441

442 443
	/* The old page is no longer accessible. */
	put_page(old);
444

445 446 447 448
out_unlock:
	mutex_unlock(&ctx->ring_lock);
out:
	spin_unlock(&mapping->private_lock);
449
	return rc;
L
Linus Torvalds 已提交
450
}
451
#endif
L
Linus Torvalds 已提交
452

453
static const struct address_space_operations aio_ctx_aops = {
454
	.set_page_dirty = __set_page_dirty_no_writeback,
455
#if IS_ENABLED(CONFIG_MIGRATION)
456
	.migratepage	= aio_migratepage,
457
#endif
458 459
};

460
static int aio_setup_ring(struct kioctx *ctx, unsigned int nr_events)
L
Linus Torvalds 已提交
461 462
{
	struct aio_ring *ring;
Z
Zach Brown 已提交
463
	struct mm_struct *mm = current->mm;
464
	unsigned long size, unused;
L
Linus Torvalds 已提交
465
	int nr_pages;
466 467
	int i;
	struct file *file;
L
Linus Torvalds 已提交
468 469 470 471 472 473 474

	/* Compensate for the ring buffer's head/tail overlap entry */
	nr_events += 2;	/* 1 is required, 2 for good luck */

	size = sizeof(struct aio_ring);
	size += sizeof(struct io_event) * nr_events;

475
	nr_pages = PFN_UP(size);
L
Linus Torvalds 已提交
476 477 478
	if (nr_pages < 0)
		return -EINVAL;

479
	file = aio_private_file(ctx, nr_pages);
480 481
	if (IS_ERR(file)) {
		ctx->aio_ring_file = NULL;
482
		return -ENOMEM;
483 484
	}

485 486 487 488 489 490 491 492 493 494 495 496 497 498
	ctx->aio_ring_file = file;
	nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring))
			/ sizeof(struct io_event);

	ctx->ring_pages = ctx->internal_pages;
	if (nr_pages > AIO_RING_PAGES) {
		ctx->ring_pages = kcalloc(nr_pages, sizeof(struct page *),
					  GFP_KERNEL);
		if (!ctx->ring_pages) {
			put_aio_ring_file(ctx);
			return -ENOMEM;
		}
	}

499 500
	for (i = 0; i < nr_pages; i++) {
		struct page *page;
A
Al Viro 已提交
501
		page = find_or_create_page(file->f_mapping,
502 503 504 505 506 507 508
					   i, GFP_HIGHUSER | __GFP_ZERO);
		if (!page)
			break;
		pr_debug("pid(%d) page[%d]->count=%d\n",
			 current->pid, i, page_count(page));
		SetPageUptodate(page);
		unlock_page(page);
509 510

		ctx->ring_pages[i] = page;
511
	}
512
	ctx->nr_pages = i;
L
Linus Torvalds 已提交
513

514 515
	if (unlikely(i != nr_pages)) {
		aio_free_ring(ctx);
516
		return -ENOMEM;
L
Linus Torvalds 已提交
517 518
	}

K
Kent Overstreet 已提交
519 520
	ctx->mmap_size = nr_pages * PAGE_SIZE;
	pr_debug("attempting mmap of %lu bytes\n", ctx->mmap_size);
521

M
Michal Hocko 已提交
522 523 524 525 526 527
	if (down_write_killable(&mm->mmap_sem)) {
		ctx->mmap_size = 0;
		aio_free_ring(ctx);
		return -EINTR;
	}

528 529
	ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
				       PROT_READ | PROT_WRITE,
530
				       MAP_SHARED, 0, &unused, NULL);
531
	up_write(&mm->mmap_sem);
K
Kent Overstreet 已提交
532 533
	if (IS_ERR((void *)ctx->mmap_base)) {
		ctx->mmap_size = 0;
L
Linus Torvalds 已提交
534
		aio_free_ring(ctx);
535
		return -ENOMEM;
L
Linus Torvalds 已提交
536 537
	}

K
Kent Overstreet 已提交
538
	pr_debug("mmap address: 0x%08lx\n", ctx->mmap_base);
539

K
Kent Overstreet 已提交
540 541
	ctx->user_id = ctx->mmap_base;
	ctx->nr_events = nr_events; /* trusted copy */
L
Linus Torvalds 已提交
542

K
Kent Overstreet 已提交
543
	ring = kmap_atomic(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
544
	ring->nr = nr_events;	/* user copy */
545
	ring->id = ~0U;
L
Linus Torvalds 已提交
546 547 548 549 550
	ring->head = ring->tail = 0;
	ring->magic = AIO_RING_MAGIC;
	ring->compat_features = AIO_RING_COMPAT_FEATURES;
	ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
	ring->header_length = sizeof(struct aio_ring);
551
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
552
	flush_dcache_page(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
553 554 555 556 557 558 559 560

	return 0;
}

#define AIO_EVENTS_PER_PAGE	(PAGE_SIZE / sizeof(struct io_event))
#define AIO_EVENTS_FIRST_PAGE	((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
#define AIO_EVENTS_OFFSET	(AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)

561
void kiocb_set_cancel_fn(struct kiocb *iocb, kiocb_cancel_fn *cancel)
562
{
563
	struct aio_kiocb *req = container_of(iocb, struct aio_kiocb, rw);
564 565 566
	struct kioctx *ctx = req->ki_ctx;
	unsigned long flags;

567 568
	if (WARN_ON_ONCE(!list_empty(&req->ki_list)))
		return;
569

570 571
	spin_lock_irqsave(&ctx->ctx_lock, flags);
	list_add_tail(&req->ki_list, &ctx->active_reqs);
572 573 574 575 576
	req->ki_cancel = cancel;
	spin_unlock_irqrestore(&ctx->ctx_lock, flags);
}
EXPORT_SYMBOL(kiocb_set_cancel_fn);

577 578 579
/*
 * free_ioctx() should be RCU delayed to synchronize against the RCU
 * protected lookup_ioctx() and also needs process context to call
580
 * aio_free_ring().  Use rcu_work.
581
 */
K
Kent Overstreet 已提交
582
static void free_ioctx(struct work_struct *work)
K
Kent Overstreet 已提交
583
{
584 585
	struct kioctx *ctx = container_of(to_rcu_work(work), struct kioctx,
					  free_rwork);
K
Kent Overstreet 已提交
586
	pr_debug("freeing %p\n", ctx);
K
Kent Overstreet 已提交
587

K
Kent Overstreet 已提交
588
	aio_free_ring(ctx);
K
Kent Overstreet 已提交
589
	free_percpu(ctx->cpu);
590 591
	percpu_ref_exit(&ctx->reqs);
	percpu_ref_exit(&ctx->users);
K
Kent Overstreet 已提交
592 593 594
	kmem_cache_free(kioctx_cachep, ctx);
}

K
Kent Overstreet 已提交
595 596 597 598
static void free_ioctx_reqs(struct percpu_ref *ref)
{
	struct kioctx *ctx = container_of(ref, struct kioctx, reqs);

599
	/* At this point we know that there are no any in-flight requests */
600 601
	if (ctx->rq_wait && atomic_dec_and_test(&ctx->rq_wait->count))
		complete(&ctx->rq_wait->comp);
602

603
	/* Synchronize against RCU protected table->table[] dereferences */
604 605
	INIT_RCU_WORK(&ctx->free_rwork, free_ioctx);
	queue_rcu_work(system_wq, &ctx->free_rwork);
K
Kent Overstreet 已提交
606 607
}

K
Kent Overstreet 已提交
608 609 610 611 612
/*
 * When this function runs, the kioctx has been removed from the "hash table"
 * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
 * now it's safe to cancel any that need to be.
 */
K
Kent Overstreet 已提交
613
static void free_ioctx_users(struct percpu_ref *ref)
K
Kent Overstreet 已提交
614
{
K
Kent Overstreet 已提交
615
	struct kioctx *ctx = container_of(ref, struct kioctx, users);
616
	struct aio_kiocb *req;
K
Kent Overstreet 已提交
617 618 619 620 621

	spin_lock_irq(&ctx->ctx_lock);

	while (!list_empty(&ctx->active_reqs)) {
		req = list_first_entry(&ctx->active_reqs,
622
				       struct aio_kiocb, ki_list);
C
Christoph Hellwig 已提交
623
		req->ki_cancel(&req->rw);
A
Al Viro 已提交
624
		list_del_init(&req->ki_list);
K
Kent Overstreet 已提交
625 626 627 628
	}

	spin_unlock_irq(&ctx->ctx_lock);

K
Kent Overstreet 已提交
629 630
	percpu_ref_kill(&ctx->reqs);
	percpu_ref_put(&ctx->reqs);
K
Kent Overstreet 已提交
631 632
}

633 634 635 636 637 638 639
static int ioctx_add_table(struct kioctx *ctx, struct mm_struct *mm)
{
	unsigned i, new_nr;
	struct kioctx_table *table, *old;
	struct aio_ring *ring;

	spin_lock(&mm->ioctx_lock);
640
	table = rcu_dereference_raw(mm->ioctx_table);
641 642 643 644

	while (1) {
		if (table)
			for (i = 0; i < table->nr; i++)
645
				if (!rcu_access_pointer(table->table[i])) {
646
					ctx->id = i;
647
					rcu_assign_pointer(table->table[i], ctx);
648 649
					spin_unlock(&mm->ioctx_lock);

650 651 652 653
					/* While kioctx setup is in progress,
					 * we are protected from page migration
					 * changes ring_pages by ->ring_lock.
					 */
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
					ring = kmap_atomic(ctx->ring_pages[0]);
					ring->id = ctx->id;
					kunmap_atomic(ring);
					return 0;
				}

		new_nr = (table ? table->nr : 1) * 4;
		spin_unlock(&mm->ioctx_lock);

		table = kzalloc(sizeof(*table) + sizeof(struct kioctx *) *
				new_nr, GFP_KERNEL);
		if (!table)
			return -ENOMEM;

		table->nr = new_nr;

		spin_lock(&mm->ioctx_lock);
671
		old = rcu_dereference_raw(mm->ioctx_table);
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687

		if (!old) {
			rcu_assign_pointer(mm->ioctx_table, table);
		} else if (table->nr > old->nr) {
			memcpy(table->table, old->table,
			       old->nr * sizeof(struct kioctx *));

			rcu_assign_pointer(mm->ioctx_table, table);
			kfree_rcu(old, rcu);
		} else {
			kfree(table);
			table = old;
		}
	}
}

K
Kent Overstreet 已提交
688 689 690 691 692 693 694 695 696 697
static void aio_nr_sub(unsigned nr)
{
	spin_lock(&aio_nr_lock);
	if (WARN_ON(aio_nr - nr > aio_nr))
		aio_nr = 0;
	else
		aio_nr -= nr;
	spin_unlock(&aio_nr_lock);
}

L
Linus Torvalds 已提交
698 699 700 701 702
/* ioctx_alloc
 *	Allocates and initializes an ioctx.  Returns an ERR_PTR if it failed.
 */
static struct kioctx *ioctx_alloc(unsigned nr_events)
{
Z
Zach Brown 已提交
703
	struct mm_struct *mm = current->mm;
L
Linus Torvalds 已提交
704
	struct kioctx *ctx;
705
	int err = -ENOMEM;
L
Linus Torvalds 已提交
706

707 708 709 710 711 712
	/*
	 * Store the original nr_events -- what userspace passed to io_setup(),
	 * for counting against the global limit -- before it changes.
	 */
	unsigned int max_reqs = nr_events;

K
Kent Overstreet 已提交
713 714 715 716 717 718 719 720 721 722 723 724
	/*
	 * We keep track of the number of available ringbuffer slots, to prevent
	 * overflow (reqs_available), and we also use percpu counters for this.
	 *
	 * So since up to half the slots might be on other cpu's percpu counters
	 * and unavailable, double nr_events so userspace sees what they
	 * expected: additionally, we move req_batch slots to/from percpu
	 * counters at a time, so make sure that isn't 0:
	 */
	nr_events = max(nr_events, num_possible_cpus() * 4);
	nr_events *= 2;

L
Linus Torvalds 已提交
725
	/* Prevent overflows */
A
Al Viro 已提交
726
	if (nr_events > (0x10000000U / sizeof(struct io_event))) {
L
Linus Torvalds 已提交
727 728 729 730
		pr_debug("ENOMEM: nr_events too high\n");
		return ERR_PTR(-EINVAL);
	}

731
	if (!nr_events || (unsigned long)max_reqs > aio_max_nr)
L
Linus Torvalds 已提交
732 733
		return ERR_PTR(-EAGAIN);

734
	ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
735 736 737
	if (!ctx)
		return ERR_PTR(-ENOMEM);

738
	ctx->max_reqs = max_reqs;
L
Linus Torvalds 已提交
739 740

	spin_lock_init(&ctx->ctx_lock);
741
	spin_lock_init(&ctx->completion_lock);
K
Kent Overstreet 已提交
742
	mutex_init(&ctx->ring_lock);
743 744 745
	/* Protect against page migration throughout kiotx setup by keeping
	 * the ring_lock mutex held until setup is complete. */
	mutex_lock(&ctx->ring_lock);
L
Linus Torvalds 已提交
746 747 748 749
	init_waitqueue_head(&ctx->wait);

	INIT_LIST_HEAD(&ctx->active_reqs);

750
	if (percpu_ref_init(&ctx->users, free_ioctx_users, 0, GFP_KERNEL))
751 752
		goto err;

753
	if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs, 0, GFP_KERNEL))
754 755
		goto err;

K
Kent Overstreet 已提交
756 757
	ctx->cpu = alloc_percpu(struct kioctx_cpu);
	if (!ctx->cpu)
K
Kent Overstreet 已提交
758
		goto err;
L
Linus Torvalds 已提交
759

760
	err = aio_setup_ring(ctx, nr_events);
761
	if (err < 0)
K
Kent Overstreet 已提交
762
		goto err;
K
Kent Overstreet 已提交
763

764
	atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
K
Kent Overstreet 已提交
765
	ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
766 767
	if (ctx->req_batch < 1)
		ctx->req_batch = 1;
768

L
Linus Torvalds 已提交
769
	/* limit the number of system wide aios */
770
	spin_lock(&aio_nr_lock);
771 772
	if (aio_nr + ctx->max_reqs > aio_max_nr ||
	    aio_nr + ctx->max_reqs < aio_nr) {
773
		spin_unlock(&aio_nr_lock);
K
Kent Overstreet 已提交
774
		err = -EAGAIN;
G
Gu Zheng 已提交
775
		goto err_ctx;
776 777
	}
	aio_nr += ctx->max_reqs;
778
	spin_unlock(&aio_nr_lock);
L
Linus Torvalds 已提交
779

780 781
	percpu_ref_get(&ctx->users);	/* io_setup() will drop this ref */
	percpu_ref_get(&ctx->reqs);	/* free_ioctx_users() will drop this */
K
Kent Overstreet 已提交
782

783 784
	err = ioctx_add_table(ctx, mm);
	if (err)
K
Kent Overstreet 已提交
785
		goto err_cleanup;
786

787 788 789
	/* Release the ring_lock mutex now that all setup is complete. */
	mutex_unlock(&ctx->ring_lock);

K
Kent Overstreet 已提交
790
	pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
K
Kent Overstreet 已提交
791
		 ctx, ctx->user_id, mm, ctx->nr_events);
L
Linus Torvalds 已提交
792 793
	return ctx;

K
Kent Overstreet 已提交
794 795
err_cleanup:
	aio_nr_sub(ctx->max_reqs);
G
Gu Zheng 已提交
796
err_ctx:
797 798 799
	atomic_set(&ctx->dead, 1);
	if (ctx->mmap_size)
		vm_munmap(ctx->mmap_base, ctx->mmap_size);
G
Gu Zheng 已提交
800
	aio_free_ring(ctx);
K
Kent Overstreet 已提交
801
err:
802
	mutex_unlock(&ctx->ring_lock);
K
Kent Overstreet 已提交
803
	free_percpu(ctx->cpu);
804 805
	percpu_ref_exit(&ctx->reqs);
	percpu_ref_exit(&ctx->users);
L
Linus Torvalds 已提交
806
	kmem_cache_free(kioctx_cachep, ctx);
K
Kent Overstreet 已提交
807
	pr_debug("error allocating ioctx %d\n", err);
808
	return ERR_PTR(err);
L
Linus Torvalds 已提交
809 810
}

K
Kent Overstreet 已提交
811 812 813 814 815
/* kill_ioctx
 *	Cancels all outstanding aio requests on an aio context.  Used
 *	when the processes owning a context have all exited to encourage
 *	the rapid destruction of the kioctx.
 */
816
static int kill_ioctx(struct mm_struct *mm, struct kioctx *ctx,
817
		      struct ctx_rq_wait *wait)
K
Kent Overstreet 已提交
818
{
819
	struct kioctx_table *table;
820

A
Al Viro 已提交
821 822 823
	spin_lock(&mm->ioctx_lock);
	if (atomic_xchg(&ctx->dead, 1)) {
		spin_unlock(&mm->ioctx_lock);
824
		return -EINVAL;
A
Al Viro 已提交
825
	}
826

827
	table = rcu_dereference_raw(mm->ioctx_table);
828 829
	WARN_ON(ctx != rcu_access_pointer(table->table[ctx->id]));
	RCU_INIT_POINTER(table->table[ctx->id], NULL);
830
	spin_unlock(&mm->ioctx_lock);
831

832
	/* free_ioctx_reqs() will do the necessary RCU synchronization */
833
	wake_up_all(&ctx->wait);
834

835 836 837 838 839 840 841 842
	/*
	 * It'd be more correct to do this in free_ioctx(), after all
	 * the outstanding kiocbs have finished - but by then io_destroy
	 * has already returned, so io_setup() could potentially return
	 * -EAGAIN with no ioctxs actually in use (as far as userspace
	 *  could tell).
	 */
	aio_nr_sub(ctx->max_reqs);
843

844 845
	if (ctx->mmap_size)
		vm_munmap(ctx->mmap_base, ctx->mmap_size);
846

847
	ctx->rq_wait = wait;
848 849
	percpu_ref_kill(&ctx->users);
	return 0;
L
Linus Torvalds 已提交
850 851
}

K
Kent Overstreet 已提交
852 853 854 855 856 857 858
/*
 * exit_aio: called when the last user of mm goes away.  At this point, there is
 * no way for any new requests to be submited or any of the io_* syscalls to be
 * called on the context.
 *
 * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
 * them.
L
Linus Torvalds 已提交
859
 */
860
void exit_aio(struct mm_struct *mm)
L
Linus Torvalds 已提交
861
{
862
	struct kioctx_table *table = rcu_dereference_raw(mm->ioctx_table);
863 864
	struct ctx_rq_wait wait;
	int i, skipped;
865

866 867
	if (!table)
		return;
868

869 870 871 872
	atomic_set(&wait.count, table->nr);
	init_completion(&wait.comp);

	skipped = 0;
873
	for (i = 0; i < table->nr; ++i) {
874 875
		struct kioctx *ctx =
			rcu_dereference_protected(table->table[i], true);
J
Jens Axboe 已提交
876

877 878
		if (!ctx) {
			skipped++;
879
			continue;
880 881
		}

882
		/*
883 884 885 886 887
		 * We don't need to bother with munmap() here - exit_mmap(mm)
		 * is coming and it'll unmap everything. And we simply can't,
		 * this is not necessarily our ->mm.
		 * Since kill_ioctx() uses non-zero ->mmap_size as indicator
		 * that it needs to unmap the area, just set it to 0.
888
		 */
K
Kent Overstreet 已提交
889
		ctx->mmap_size = 0;
890 891
		kill_ioctx(mm, ctx, &wait);
	}
K
Kent Overstreet 已提交
892

893
	if (!atomic_sub_and_test(skipped, &wait.count)) {
894
		/* Wait until all IO for the context are done. */
895
		wait_for_completion(&wait.comp);
L
Linus Torvalds 已提交
896
	}
897 898 899

	RCU_INIT_POINTER(mm->ioctx_table, NULL);
	kfree(table);
L
Linus Torvalds 已提交
900 901
}

K
Kent Overstreet 已提交
902 903 904
static void put_reqs_available(struct kioctx *ctx, unsigned nr)
{
	struct kioctx_cpu *kcpu;
905
	unsigned long flags;
K
Kent Overstreet 已提交
906

907
	local_irq_save(flags);
908
	kcpu = this_cpu_ptr(ctx->cpu);
K
Kent Overstreet 已提交
909
	kcpu->reqs_available += nr;
910

K
Kent Overstreet 已提交
911 912 913 914 915
	while (kcpu->reqs_available >= ctx->req_batch * 2) {
		kcpu->reqs_available -= ctx->req_batch;
		atomic_add(ctx->req_batch, &ctx->reqs_available);
	}

916
	local_irq_restore(flags);
K
Kent Overstreet 已提交
917 918 919 920 921 922
}

static bool get_reqs_available(struct kioctx *ctx)
{
	struct kioctx_cpu *kcpu;
	bool ret = false;
923
	unsigned long flags;
K
Kent Overstreet 已提交
924

925
	local_irq_save(flags);
926
	kcpu = this_cpu_ptr(ctx->cpu);
K
Kent Overstreet 已提交
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
	if (!kcpu->reqs_available) {
		int old, avail = atomic_read(&ctx->reqs_available);

		do {
			if (avail < ctx->req_batch)
				goto out;

			old = avail;
			avail = atomic_cmpxchg(&ctx->reqs_available,
					       avail, avail - ctx->req_batch);
		} while (avail != old);

		kcpu->reqs_available += ctx->req_batch;
	}

	ret = true;
	kcpu->reqs_available--;
out:
945
	local_irq_restore(flags);
K
Kent Overstreet 已提交
946 947 948
	return ret;
}

949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
/* refill_reqs_available
 *	Updates the reqs_available reference counts used for tracking the
 *	number of free slots in the completion ring.  This can be called
 *	from aio_complete() (to optimistically update reqs_available) or
 *	from aio_get_req() (the we're out of events case).  It must be
 *	called holding ctx->completion_lock.
 */
static void refill_reqs_available(struct kioctx *ctx, unsigned head,
                                  unsigned tail)
{
	unsigned events_in_ring, completed;

	/* Clamp head since userland can write to it. */
	head %= ctx->nr_events;
	if (head <= tail)
		events_in_ring = tail - head;
	else
		events_in_ring = ctx->nr_events - (head - tail);

	completed = ctx->completed_events;
	if (events_in_ring < completed)
		completed -= events_in_ring;
	else
		completed = 0;

	if (!completed)
		return;

	ctx->completed_events -= completed;
	put_reqs_available(ctx, completed);
}

/* user_refill_reqs_available
 *	Called to refill reqs_available when aio_get_req() encounters an
 *	out of space in the completion ring.
 */
static void user_refill_reqs_available(struct kioctx *ctx)
{
	spin_lock_irq(&ctx->completion_lock);
	if (ctx->completed_events) {
		struct aio_ring *ring;
		unsigned head;

		/* Access of ring->head may race with aio_read_events_ring()
		 * here, but that's okay since whether we read the old version
		 * or the new version, and either will be valid.  The important
		 * part is that head cannot pass tail since we prevent
		 * aio_complete() from updating tail by holding
		 * ctx->completion_lock.  Even if head is invalid, the check
		 * against ctx->completed_events below will make sure we do the
		 * safe/right thing.
		 */
		ring = kmap_atomic(ctx->ring_pages[0]);
		head = ring->head;
		kunmap_atomic(ring);

		refill_reqs_available(ctx, head, ctx->tail);
	}

	spin_unlock_irq(&ctx->completion_lock);
}

L
Linus Torvalds 已提交
1011
/* aio_get_req
K
Kent Overstreet 已提交
1012 1013
 *	Allocate a slot for an aio request.
 * Returns NULL if no requests are free.
L
Linus Torvalds 已提交
1014
 */
1015
static inline struct aio_kiocb *aio_get_req(struct kioctx *ctx)
L
Linus Torvalds 已提交
1016
{
1017
	struct aio_kiocb *req;
K
Kent Overstreet 已提交
1018

1019 1020 1021 1022 1023
	if (!get_reqs_available(ctx)) {
		user_refill_reqs_available(ctx);
		if (!get_reqs_available(ctx))
			return NULL;
	}
K
Kent Overstreet 已提交
1024

1025
	req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
L
Linus Torvalds 已提交
1026
	if (unlikely(!req))
K
Kent Overstreet 已提交
1027
		goto out_put;
L
Linus Torvalds 已提交
1028

K
Kent Overstreet 已提交
1029
	percpu_ref_get(&ctx->reqs);
1030
	INIT_LIST_HEAD(&req->ki_list);
L
Linus Torvalds 已提交
1031
	req->ki_ctx = ctx;
J
Jeff Moyer 已提交
1032
	return req;
K
Kent Overstreet 已提交
1033
out_put:
K
Kent Overstreet 已提交
1034
	put_reqs_available(ctx, 1);
K
Kent Overstreet 已提交
1035
	return NULL;
L
Linus Torvalds 已提交
1036 1037
}

A
Adrian Bunk 已提交
1038
static struct kioctx *lookup_ioctx(unsigned long ctx_id)
L
Linus Torvalds 已提交
1039
{
1040
	struct aio_ring __user *ring  = (void __user *)ctx_id;
J
Jens Axboe 已提交
1041
	struct mm_struct *mm = current->mm;
1042
	struct kioctx *ctx, *ret = NULL;
1043 1044 1045 1046 1047
	struct kioctx_table *table;
	unsigned id;

	if (get_user(id, &ring->id))
		return NULL;
L
Linus Torvalds 已提交
1048

J
Jens Axboe 已提交
1049
	rcu_read_lock();
1050
	table = rcu_dereference(mm->ioctx_table);
J
Jens Axboe 已提交
1051

1052 1053
	if (!table || id >= table->nr)
		goto out;
L
Linus Torvalds 已提交
1054

1055
	ctx = rcu_dereference(table->table[id]);
1056
	if (ctx && ctx->user_id == ctx_id) {
1057 1058
		if (percpu_ref_tryget_live(&ctx->users))
			ret = ctx;
1059 1060
	}
out:
J
Jens Axboe 已提交
1061
	rcu_read_unlock();
1062
	return ret;
L
Linus Torvalds 已提交
1063 1064 1065 1066 1067
}

/* aio_complete
 *	Called when the io request on the given iocb is complete.
 */
1068
static void aio_complete(struct aio_kiocb *iocb, long res, long res2)
L
Linus Torvalds 已提交
1069 1070 1071
{
	struct kioctx	*ctx = iocb->ki_ctx;
	struct aio_ring	*ring;
K
Kent Overstreet 已提交
1072
	struct io_event	*ev_page, *event;
1073
	unsigned tail, pos, head;
L
Linus Torvalds 已提交
1074 1075
	unsigned long	flags;

1076 1077
	/*
	 * Add a completion event to the ring buffer. Must be done holding
1078
	 * ctx->completion_lock to prevent other code from messing with the tail
1079 1080 1081 1082
	 * pointer since we might be called from irq context.
	 */
	spin_lock_irqsave(&ctx->completion_lock, flags);

K
Kent Overstreet 已提交
1083
	tail = ctx->tail;
K
Kent Overstreet 已提交
1084 1085
	pos = tail + AIO_EVENTS_OFFSET;

K
Kent Overstreet 已提交
1086
	if (++tail >= ctx->nr_events)
1087
		tail = 0;
L
Linus Torvalds 已提交
1088

K
Kent Overstreet 已提交
1089
	ev_page = kmap_atomic(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
K
Kent Overstreet 已提交
1090 1091
	event = ev_page + pos % AIO_EVENTS_PER_PAGE;

1092
	event->obj = (u64)(unsigned long)iocb->ki_user_iocb;
L
Linus Torvalds 已提交
1093 1094 1095 1096
	event->data = iocb->ki_user_data;
	event->res = res;
	event->res2 = res2;

K
Kent Overstreet 已提交
1097
	kunmap_atomic(ev_page);
K
Kent Overstreet 已提交
1098
	flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
K
Kent Overstreet 已提交
1099 1100

	pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
1101
		 ctx, tail, iocb, iocb->ki_user_iocb, iocb->ki_user_data,
K
Kent Overstreet 已提交
1102
		 res, res2);
L
Linus Torvalds 已提交
1103 1104 1105 1106 1107 1108

	/* after flagging the request as done, we
	 * must never even look at it again
	 */
	smp_wmb();	/* make event visible before updating tail */

K
Kent Overstreet 已提交
1109
	ctx->tail = tail;
L
Linus Torvalds 已提交
1110

K
Kent Overstreet 已提交
1111
	ring = kmap_atomic(ctx->ring_pages[0]);
1112
	head = ring->head;
K
Kent Overstreet 已提交
1113
	ring->tail = tail;
1114
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
1115
	flush_dcache_page(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
1116

1117 1118 1119
	ctx->completed_events++;
	if (ctx->completed_events > 1)
		refill_reqs_available(ctx, head, tail);
1120 1121
	spin_unlock_irqrestore(&ctx->completion_lock, flags);

K
Kent Overstreet 已提交
1122
	pr_debug("added to ring %p at [%u]\n", iocb, tail);
D
Davide Libenzi 已提交
1123 1124 1125 1126 1127 1128

	/*
	 * Check if the user asked us to deliver the result through an
	 * eventfd. The eventfd_signal() function is safe to be called
	 * from IRQ context.
	 */
1129
	if (iocb->ki_eventfd) {
D
Davide Libenzi 已提交
1130
		eventfd_signal(iocb->ki_eventfd, 1);
1131 1132
		eventfd_ctx_put(iocb->ki_eventfd);
	}
D
Davide Libenzi 已提交
1133

1134
	kmem_cache_free(kiocb_cachep, iocb);
L
Linus Torvalds 已提交
1135

1136 1137 1138 1139 1140 1141 1142 1143
	/*
	 * We have to order our ring_info tail store above and test
	 * of the wait list below outside the wait lock.  This is
	 * like in wake_up_bit() where clearing a bit has to be
	 * ordered with the unlocked test.
	 */
	smp_mb();

L
Linus Torvalds 已提交
1144 1145 1146
	if (waitqueue_active(&ctx->wait))
		wake_up(&ctx->wait);

K
Kent Overstreet 已提交
1147
	percpu_ref_put(&ctx->reqs);
L
Linus Torvalds 已提交
1148 1149
}

G
Gu Zheng 已提交
1150
/* aio_read_events_ring
1151 1152
 *	Pull an event off of the ioctx's event ring.  Returns the number of
 *	events fetched
L
Linus Torvalds 已提交
1153
 */
1154 1155
static long aio_read_events_ring(struct kioctx *ctx,
				 struct io_event __user *event, long nr)
L
Linus Torvalds 已提交
1156 1157
{
	struct aio_ring *ring;
1158
	unsigned head, tail, pos;
1159 1160 1161
	long ret = 0;
	int copy_ret;

1162 1163 1164 1165 1166 1167 1168
	/*
	 * The mutex can block and wake us up and that will cause
	 * wait_event_interruptible_hrtimeout() to schedule without sleeping
	 * and repeat. This should be rare enough that it doesn't cause
	 * peformance issues. See the comment in read_events() for more detail.
	 */
	sched_annotate_sleep();
K
Kent Overstreet 已提交
1169
	mutex_lock(&ctx->ring_lock);
L
Linus Torvalds 已提交
1170

1171
	/* Access to ->ring_pages here is protected by ctx->ring_lock. */
K
Kent Overstreet 已提交
1172
	ring = kmap_atomic(ctx->ring_pages[0]);
1173
	head = ring->head;
1174
	tail = ring->tail;
1175 1176
	kunmap_atomic(ring);

1177 1178 1179 1180 1181 1182
	/*
	 * Ensure that once we've read the current tail pointer, that
	 * we also see the events that were stored up to the tail.
	 */
	smp_rmb();

1183
	pr_debug("h%u t%u m%u\n", head, tail, ctx->nr_events);
L
Linus Torvalds 已提交
1184

1185
	if (head == tail)
L
Linus Torvalds 已提交
1186 1187
		goto out;

1188 1189 1190
	head %= ctx->nr_events;
	tail %= ctx->nr_events;

1191 1192 1193 1194 1195
	while (ret < nr) {
		long avail;
		struct io_event *ev;
		struct page *page;

1196 1197
		avail = (head <= tail ?  tail : ctx->nr_events) - head;
		if (head == tail)
1198 1199 1200
			break;

		pos = head + AIO_EVENTS_OFFSET;
K
Kent Overstreet 已提交
1201
		page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
1202 1203
		pos %= AIO_EVENTS_PER_PAGE;

1204 1205 1206
		avail = min(avail, nr - ret);
		avail = min_t(long, avail, AIO_EVENTS_PER_PAGE - pos);

1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
		ev = kmap(page);
		copy_ret = copy_to_user(event + ret, ev + pos,
					sizeof(*ev) * avail);
		kunmap(page);

		if (unlikely(copy_ret)) {
			ret = -EFAULT;
			goto out;
		}

		ret += avail;
		head += avail;
K
Kent Overstreet 已提交
1219
		head %= ctx->nr_events;
L
Linus Torvalds 已提交
1220 1221
	}

K
Kent Overstreet 已提交
1222
	ring = kmap_atomic(ctx->ring_pages[0]);
1223
	ring->head = head;
1224
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
1225
	flush_dcache_page(ctx->ring_pages[0]);
1226

1227
	pr_debug("%li  h%u t%u\n", ret, head, tail);
1228
out:
K
Kent Overstreet 已提交
1229
	mutex_unlock(&ctx->ring_lock);
1230

L
Linus Torvalds 已提交
1231 1232 1233
	return ret;
}

1234 1235
static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
			    struct io_event __user *event, long *i)
L
Linus Torvalds 已提交
1236
{
1237
	long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
L
Linus Torvalds 已提交
1238

1239 1240
	if (ret > 0)
		*i += ret;
L
Linus Torvalds 已提交
1241

1242 1243
	if (unlikely(atomic_read(&ctx->dead)))
		ret = -EINVAL;
L
Linus Torvalds 已提交
1244

1245 1246
	if (!*i)
		*i = ret;
L
Linus Torvalds 已提交
1247

1248
	return ret < 0 || *i >= min_nr;
L
Linus Torvalds 已提交
1249 1250
}

1251
static long read_events(struct kioctx *ctx, long min_nr, long nr,
L
Linus Torvalds 已提交
1252
			struct io_event __user *event,
1253
			ktime_t until)
L
Linus Torvalds 已提交
1254
{
1255
	long ret = 0;
L
Linus Torvalds 已提交
1256

1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
	/*
	 * Note that aio_read_events() is being called as the conditional - i.e.
	 * we're calling it after prepare_to_wait() has set task state to
	 * TASK_INTERRUPTIBLE.
	 *
	 * But aio_read_events() can block, and if it blocks it's going to flip
	 * the task state back to TASK_RUNNING.
	 *
	 * This should be ok, provided it doesn't flip the state back to
	 * TASK_RUNNING and return 0 too much - that causes us to spin. That
	 * will only happen if the mutex_lock() call blocks, and we then find
	 * the ringbuffer empty. So in practice we should be ok, but it's
	 * something to be aware of when touching this code.
	 */
T
Thomas Gleixner 已提交
1271
	if (until == 0)
1272 1273 1274 1275 1276
		aio_read_events(ctx, min_nr, nr, event, &ret);
	else
		wait_event_interruptible_hrtimeout(ctx->wait,
				aio_read_events(ctx, min_nr, nr, event, &ret),
				until);
1277
	return ret;
L
Linus Torvalds 已提交
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
}

/* sys_io_setup:
 *	Create an aio_context capable of receiving at least nr_events.
 *	ctxp must not point to an aio_context that already exists, and
 *	must be initialized to 0 prior to the call.  On successful
 *	creation of the aio_context, *ctxp is filled in with the resulting 
 *	handle.  May fail with -EINVAL if *ctxp is not initialized,
 *	if the specified nr_events exceeds internal limits.  May fail 
 *	with -EAGAIN if the specified nr_events exceeds the user's limit 
 *	of available events.  May fail with -ENOMEM if insufficient kernel
 *	resources are available.  May fail with -EFAULT if an invalid
 *	pointer is passed for ctxp.  Will fail with -ENOSYS if not
 *	implemented.
 */
1293
SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
L
Linus Torvalds 已提交
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
{
	struct kioctx *ioctx = NULL;
	unsigned long ctx;
	long ret;

	ret = get_user(ctx, ctxp);
	if (unlikely(ret))
		goto out;

	ret = -EINVAL;
1304
	if (unlikely(ctx || nr_events == 0)) {
1305
		pr_debug("EINVAL: ctx %lu nr_events %u\n",
1306
		         ctx, nr_events);
L
Linus Torvalds 已提交
1307 1308 1309 1310 1311 1312 1313
		goto out;
	}

	ioctx = ioctx_alloc(nr_events);
	ret = PTR_ERR(ioctx);
	if (!IS_ERR(ioctx)) {
		ret = put_user(ioctx->user_id, ctxp);
1314
		if (ret)
1315
			kill_ioctx(current->mm, ioctx, NULL);
K
Kent Overstreet 已提交
1316
		percpu_ref_put(&ioctx->users);
L
Linus Torvalds 已提交
1317 1318 1319 1320 1321 1322
	}

out:
	return ret;
}

A
Al Viro 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
#ifdef CONFIG_COMPAT
COMPAT_SYSCALL_DEFINE2(io_setup, unsigned, nr_events, u32 __user *, ctx32p)
{
	struct kioctx *ioctx = NULL;
	unsigned long ctx;
	long ret;

	ret = get_user(ctx, ctx32p);
	if (unlikely(ret))
		goto out;

	ret = -EINVAL;
	if (unlikely(ctx || nr_events == 0)) {
		pr_debug("EINVAL: ctx %lu nr_events %u\n",
		         ctx, nr_events);
		goto out;
	}

	ioctx = ioctx_alloc(nr_events);
	ret = PTR_ERR(ioctx);
	if (!IS_ERR(ioctx)) {
		/* truncating is ok because it's a user address */
		ret = put_user((u32)ioctx->user_id, ctx32p);
		if (ret)
			kill_ioctx(current->mm, ioctx, NULL);
		percpu_ref_put(&ioctx->users);
	}

out:
	return ret;
}
#endif

L
Linus Torvalds 已提交
1356 1357 1358
/* sys_io_destroy:
 *	Destroy the aio_context specified.  May cancel any outstanding 
 *	AIOs and block on completion.  Will fail with -ENOSYS if not
1359
 *	implemented.  May fail with -EINVAL if the context pointed to
L
Linus Torvalds 已提交
1360 1361
 *	is invalid.
 */
1362
SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
L
Linus Torvalds 已提交
1363 1364 1365
{
	struct kioctx *ioctx = lookup_ioctx(ctx);
	if (likely(NULL != ioctx)) {
1366
		struct ctx_rq_wait wait;
1367
		int ret;
1368

1369 1370 1371
		init_completion(&wait.comp);
		atomic_set(&wait.count, 1);

1372 1373 1374 1375
		/* Pass requests_done to kill_ioctx() where it can be set
		 * in a thread-safe way. If we try to set it here then we have
		 * a race condition if two io_destroy() called simultaneously.
		 */
1376
		ret = kill_ioctx(current->mm, ioctx, &wait);
K
Kent Overstreet 已提交
1377
		percpu_ref_put(&ioctx->users);
1378 1379 1380 1381 1382

		/* Wait until all IO for the context are done. Otherwise kernel
		 * keep using user-space buffers even if user thinks the context
		 * is destroyed.
		 */
1383
		if (!ret)
1384
			wait_for_completion(&wait.comp);
1385

1386
		return ret;
L
Linus Torvalds 已提交
1387
	}
1388
	pr_debug("EINVAL: invalid context id\n");
L
Linus Torvalds 已提交
1389 1390 1391
	return -EINVAL;
}

1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
static void aio_remove_iocb(struct aio_kiocb *iocb)
{
	struct kioctx *ctx = iocb->ki_ctx;
	unsigned long flags;

	spin_lock_irqsave(&ctx->ctx_lock, flags);
	list_del(&iocb->ki_list);
	spin_unlock_irqrestore(&ctx->ctx_lock, flags);
}

1402 1403 1404 1405
static void aio_complete_rw(struct kiocb *kiocb, long res, long res2)
{
	struct aio_kiocb *iocb = container_of(kiocb, struct aio_kiocb, rw);

1406 1407 1408
	if (!list_empty_careful(&iocb->ki_list))
		aio_remove_iocb(iocb);

1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
	if (kiocb->ki_flags & IOCB_WRITE) {
		struct inode *inode = file_inode(kiocb->ki_filp);

		/*
		 * Tell lockdep we inherited freeze protection from submission
		 * thread.
		 */
		if (S_ISREG(inode->i_mode))
			__sb_writers_acquired(inode->i_sb, SB_FREEZE_WRITE);
		file_end_write(kiocb->ki_filp);
	}

	fput(kiocb->ki_filp);
	aio_complete(iocb, res, res2);
}

static int aio_prep_rw(struct kiocb *req, struct iocb *iocb)
{
	int ret;

	req->ki_filp = fget(iocb->aio_fildes);
	if (unlikely(!req->ki_filp))
		return -EBADF;
	req->ki_complete = aio_complete_rw;
	req->ki_pos = iocb->aio_offset;
	req->ki_flags = iocb_flags(req->ki_filp);
	if (iocb->aio_flags & IOCB_FLAG_RESFD)
		req->ki_flags |= IOCB_EVENTFD;
1437
	req->ki_hint = ki_hint_validate(file_write_hint(req->ki_filp));
A
Adam Manzanares 已提交
1438 1439 1440 1441 1442 1443 1444 1445
	if (iocb->aio_flags & IOCB_FLAG_IOPRIO) {
		/*
		 * If the IOCB_FLAG_IOPRIO flag of aio_flags is set, then
		 * aio_reqprio is interpreted as an I/O scheduling
		 * class and priority.
		 */
		ret = ioprio_check_cap(iocb->aio_reqprio);
		if (ret) {
1446 1447
			pr_debug("aio ioprio check cap error: %d\n", ret);
			return ret;
A
Adam Manzanares 已提交
1448 1449 1450 1451 1452 1453
		}

		req->ki_ioprio = iocb->aio_reqprio;
	} else
		req->ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0);

1454 1455 1456 1457 1458 1459
	ret = kiocb_set_rw_flags(req, iocb->aio_rw_flags);
	if (unlikely(ret))
		fput(req->ki_filp);
	return ret;
}

C
Christoph Hellwig 已提交
1460 1461
static int aio_setup_rw(int rw, struct iocb *iocb, struct iovec **iovec,
		bool vectored, bool compat, struct iov_iter *iter)
B
Badari Pulavarty 已提交
1462
{
C
Christoph Hellwig 已提交
1463 1464 1465 1466 1467 1468 1469 1470
	void __user *buf = (void __user *)(uintptr_t)iocb->aio_buf;
	size_t len = iocb->aio_nbytes;

	if (!vectored) {
		ssize_t ret = import_single_range(rw, buf, len, *iovec, iter);
		*iovec = NULL;
		return ret;
	}
1471 1472
#ifdef CONFIG_COMPAT
	if (compat)
C
Christoph Hellwig 已提交
1473 1474
		return compat_import_iovec(rw, buf, len, UIO_FASTIOV, iovec,
				iter);
1475
#endif
C
Christoph Hellwig 已提交
1476
	return import_iovec(rw, buf, len, UIO_FASTIOV, iovec, iter);
B
Badari Pulavarty 已提交
1477 1478
}

1479
static inline void aio_rw_done(struct kiocb *req, ssize_t ret)
C
Christoph Hellwig 已提交
1480 1481 1482
{
	switch (ret) {
	case -EIOCBQUEUED:
1483
		break;
C
Christoph Hellwig 已提交
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494
	case -ERESTARTSYS:
	case -ERESTARTNOINTR:
	case -ERESTARTNOHAND:
	case -ERESTART_RESTARTBLOCK:
		/*
		 * There's no easy way to restart the syscall since other AIO's
		 * may be already running. Just fail this IO with EINTR.
		 */
		ret = -EINTR;
		/*FALLTHRU*/
	default:
1495
		aio_complete_rw(req, ret, 0);
C
Christoph Hellwig 已提交
1496 1497 1498 1499 1500
	}
}

static ssize_t aio_read(struct kiocb *req, struct iocb *iocb, bool vectored,
		bool compat)
L
Linus Torvalds 已提交
1501
{
1502
	struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1503
	struct iov_iter iter;
1504
	struct file *file;
C
Christoph Hellwig 已提交
1505
	ssize_t ret;
L
Linus Torvalds 已提交
1506

1507 1508 1509 1510 1511 1512
	ret = aio_prep_rw(req, iocb);
	if (ret)
		return ret;
	file = req->ki_filp;

	ret = -EBADF;
C
Christoph Hellwig 已提交
1513
	if (unlikely(!(file->f_mode & FMODE_READ)))
1514 1515
		goto out_fput;
	ret = -EINVAL;
C
Christoph Hellwig 已提交
1516
	if (unlikely(!file->f_op->read_iter))
1517
		goto out_fput;
K
Kent Overstreet 已提交
1518

C
Christoph Hellwig 已提交
1519 1520
	ret = aio_setup_rw(READ, iocb, &iovec, vectored, compat, &iter);
	if (ret)
1521
		goto out_fput;
C
Christoph Hellwig 已提交
1522 1523
	ret = rw_verify_area(READ, file, &req->ki_pos, iov_iter_count(&iter));
	if (!ret)
1524
		aio_rw_done(req, call_read_iter(file, req, &iter));
C
Christoph Hellwig 已提交
1525
	kfree(iovec);
1526
out_fput:
1527
	if (unlikely(ret))
1528
		fput(file);
C
Christoph Hellwig 已提交
1529 1530
	return ret;
}
K
Kent Overstreet 已提交
1531

C
Christoph Hellwig 已提交
1532 1533 1534 1535 1536
static ssize_t aio_write(struct kiocb *req, struct iocb *iocb, bool vectored,
		bool compat)
{
	struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
	struct iov_iter iter;
1537
	struct file *file;
C
Christoph Hellwig 已提交
1538
	ssize_t ret;
K
Kent Overstreet 已提交
1539

1540 1541 1542 1543 1544 1545
	ret = aio_prep_rw(req, iocb);
	if (ret)
		return ret;
	file = req->ki_filp;

	ret = -EBADF;
C
Christoph Hellwig 已提交
1546
	if (unlikely(!(file->f_mode & FMODE_WRITE)))
1547 1548
		goto out_fput;
	ret = -EINVAL;
C
Christoph Hellwig 已提交
1549
	if (unlikely(!file->f_op->write_iter))
1550
		goto out_fput;
L
Linus Torvalds 已提交
1551

C
Christoph Hellwig 已提交
1552 1553
	ret = aio_setup_rw(WRITE, iocb, &iovec, vectored, compat, &iter);
	if (ret)
1554
		goto out_fput;
C
Christoph Hellwig 已提交
1555 1556
	ret = rw_verify_area(WRITE, file, &req->ki_pos, iov_iter_count(&iter));
	if (!ret) {
1557
		/*
1558
		 * Open-code file_start_write here to grab freeze protection,
1559 1560 1561 1562
		 * which will be released by another thread in
		 * aio_complete_rw().  Fool lockdep by telling it the lock got
		 * released so that it doesn't complain about the held lock when
		 * we return to userspace.
1563
		 */
1564 1565
		if (S_ISREG(file_inode(file)->i_mode)) {
			__sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
S
Shaohua Li 已提交
1566
			__sb_writers_release(file_inode(file)->i_sb, SB_FREEZE_WRITE);
1567 1568
		}
		req->ki_flags |= IOCB_WRITE;
1569
		aio_rw_done(req, call_write_iter(file, req, &iter));
K
Kent Overstreet 已提交
1570
	}
C
Christoph Hellwig 已提交
1571
	kfree(iovec);
1572
out_fput:
1573
	if (unlikely(ret))
1574
		fput(file);
C
Christoph Hellwig 已提交
1575
	return ret;
L
Linus Torvalds 已提交
1576 1577
}

1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
static void aio_fsync_work(struct work_struct *work)
{
	struct fsync_iocb *req = container_of(work, struct fsync_iocb, work);
	int ret;

	ret = vfs_fsync(req->file, req->datasync);
	fput(req->file);
	aio_complete(container_of(req, struct aio_kiocb, fsync), ret, 0);
}

static int aio_fsync(struct fsync_iocb *req, struct iocb *iocb, bool datasync)
{
	if (unlikely(iocb->aio_buf || iocb->aio_offset || iocb->aio_nbytes ||
			iocb->aio_rw_flags))
		return -EINVAL;
	req->file = fget(iocb->aio_fildes);
	if (unlikely(!req->file))
		return -EBADF;
	if (unlikely(!req->file->f_op->fsync)) {
		fput(req->file);
		return -EINVAL;
	}

	req->datasync = datasync;
	INIT_WORK(&req->work, aio_fsync_work);
	schedule_work(&req->work);
1604
	return 0;
1605 1606
}

C
Christoph Hellwig 已提交
1607 1608 1609 1610 1611 1612 1613 1614 1615
/* need to use list_del_init so we can check if item was present */
static inline bool __aio_poll_remove(struct poll_iocb *req)
{
	if (list_empty(&req->wait.entry))
		return false;
	list_del_init(&req->wait.entry);
	return true;
}

1616
static inline void __aio_poll_complete(struct aio_kiocb *iocb, __poll_t mask)
C
Christoph Hellwig 已提交
1617
{
1618
	fput(iocb->poll.file);
C
Christoph Hellwig 已提交
1619 1620 1621 1622 1623
	aio_complete(iocb, mangle_poll(mask), 0);
}

static void aio_poll_work(struct work_struct *work)
{
1624
	struct aio_kiocb *iocb = container_of(work, struct aio_kiocb, poll.work);
C
Christoph Hellwig 已提交
1625

1626 1627 1628
	if (!list_empty_careful(&iocb->ki_list))
		aio_remove_iocb(iocb);
	__aio_poll_complete(iocb, iocb->poll.events);
C
Christoph Hellwig 已提交
1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653
}

static int aio_poll_cancel(struct kiocb *iocb)
{
	struct aio_kiocb *aiocb = container_of(iocb, struct aio_kiocb, rw);
	struct poll_iocb *req = &aiocb->poll;
	struct wait_queue_head *head = req->head;
	bool found = false;

	spin_lock(&head->lock);
	found = __aio_poll_remove(req);
	spin_unlock(&head->lock);

	if (found) {
		req->events = 0;
		INIT_WORK(&req->work, aio_poll_work);
		schedule_work(&req->work);
	}
	return 0;
}

static int aio_poll_wake(struct wait_queue_entry *wait, unsigned mode, int sync,
		void *key)
{
	struct poll_iocb *req = container_of(wait, struct poll_iocb, wait);
1654
	struct aio_kiocb *iocb = container_of(req, struct aio_kiocb, poll);
C
Christoph Hellwig 已提交
1655 1656 1657 1658 1659 1660 1661 1662 1663
	struct file *file = req->file;
	__poll_t mask = key_to_poll(key);

	assert_spin_locked(&req->head->lock);

	/* for instances that support it check for an event match first: */
	if (mask && !(mask & req->events))
		return 0;

1664
	mask = file->f_op->poll_mask(file, req->events) & req->events;
C
Christoph Hellwig 已提交
1665 1666 1667 1668 1669
	if (!mask)
		return 0;

	__aio_poll_remove(req);

1670 1671 1672 1673 1674 1675 1676 1677 1678
	/*
	 * Try completing without a context switch if we can acquire ctx_lock
	 * without spinning.  Otherwise we need to defer to a workqueue to
	 * avoid a deadlock due to the lock order.
	 */
	if (spin_trylock(&iocb->ki_ctx->ctx_lock)) {
		list_del_init(&iocb->ki_list);
		spin_unlock(&iocb->ki_ctx->ctx_lock);

1679
		__aio_poll_complete(iocb, mask);
1680 1681 1682 1683 1684 1685
	} else {
		req->events = mask;
		INIT_WORK(&req->work, aio_poll_work);
		schedule_work(&req->work);
	}

C
Christoph Hellwig 已提交
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
	return 1;
}

static ssize_t aio_poll(struct aio_kiocb *aiocb, struct iocb *iocb)
{
	struct kioctx *ctx = aiocb->ki_ctx;
	struct poll_iocb *req = &aiocb->poll;
	__poll_t mask;

	/* reject any unknown events outside the normal event mask. */
	if ((u16)iocb->aio_buf != iocb->aio_buf)
		return -EINVAL;
	/* reject fields that are not defined for poll */
	if (iocb->aio_offset || iocb->aio_nbytes || iocb->aio_rw_flags)
		return -EINVAL;

	req->events = demangle_poll(iocb->aio_buf) | EPOLLERR | EPOLLHUP;
	req->file = fget(iocb->aio_fildes);
	if (unlikely(!req->file))
		return -EBADF;
	if (!file_has_poll_mask(req->file))
		goto out_fail;

	req->head = req->file->f_op->get_poll_head(req->file, req->events);
	if (!req->head)
		goto out_fail;
	if (IS_ERR(req->head)) {
		mask = EPOLLERR;
		goto done;
	}

	init_waitqueue_func_entry(&req->wait, aio_poll_wake);
	aiocb->ki_cancel = aio_poll_cancel;

	spin_lock_irq(&ctx->ctx_lock);
	spin_lock(&req->head->lock);
1722
	mask = req->file->f_op->poll_mask(req->file, req->events) & req->events;
C
Christoph Hellwig 已提交
1723 1724 1725 1726 1727 1728 1729 1730
	if (!mask) {
		__add_wait_queue(req->head, &req->wait);
		list_add_tail(&aiocb->ki_list, &ctx->active_reqs);
	}
	spin_unlock(&req->head->lock);
	spin_unlock_irq(&ctx->ctx_lock);
done:
	if (mask)
1731
		__aio_poll_complete(aiocb, mask);
1732
	return 0;
C
Christoph Hellwig 已提交
1733 1734 1735 1736 1737
out_fail:
	fput(req->file);
	return -EINVAL; /* same as no support for IOCB_CMD_POLL */
}

A
Adrian Bunk 已提交
1738
static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
1739
			 bool compat)
L
Linus Torvalds 已提交
1740
{
1741
	struct aio_kiocb *req;
1742
	struct iocb iocb;
L
Linus Torvalds 已提交
1743 1744
	ssize_t ret;

1745 1746 1747
	if (unlikely(copy_from_user(&iocb, user_iocb, sizeof(iocb))))
		return -EFAULT;

L
Linus Torvalds 已提交
1748
	/* enforce forwards compatibility on users */
1749
	if (unlikely(iocb.aio_reserved2)) {
K
Kent Overstreet 已提交
1750
		pr_debug("EINVAL: reserve field set\n");
L
Linus Torvalds 已提交
1751 1752 1753 1754 1755
		return -EINVAL;
	}

	/* prevent overflows */
	if (unlikely(
1756 1757 1758
	    (iocb.aio_buf != (unsigned long)iocb.aio_buf) ||
	    (iocb.aio_nbytes != (size_t)iocb.aio_nbytes) ||
	    ((ssize_t)iocb.aio_nbytes < 0)
L
Linus Torvalds 已提交
1759
	   )) {
1760
		pr_debug("EINVAL: overflow check\n");
L
Linus Torvalds 已提交
1761 1762 1763
		return -EINVAL;
	}

K
Kent Overstreet 已提交
1764
	req = aio_get_req(ctx);
1765
	if (unlikely(!req))
L
Linus Torvalds 已提交
1766
		return -EAGAIN;
1767

1768
	if (iocb.aio_flags & IOCB_FLAG_RESFD) {
1769 1770 1771 1772 1773 1774
		/*
		 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
		 * instance of the file* now. The file descriptor must be
		 * an eventfd() fd, and will be signaled for each completed
		 * event using the eventfd_signal() function.
		 */
1775
		req->ki_eventfd = eventfd_ctx_fdget((int) iocb.aio_resfd);
1776
		if (IS_ERR(req->ki_eventfd)) {
1777
			ret = PTR_ERR(req->ki_eventfd);
1778
			req->ki_eventfd = NULL;
1779 1780
			goto out_put_req;
		}
1781 1782
	}

K
Kent Overstreet 已提交
1783
	ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
L
Linus Torvalds 已提交
1784
	if (unlikely(ret)) {
K
Kent Overstreet 已提交
1785
		pr_debug("EFAULT: aio_key\n");
L
Linus Torvalds 已提交
1786 1787 1788
		goto out_put_req;
	}

1789
	req->ki_user_iocb = user_iocb;
1790
	req->ki_user_data = iocb.aio_data;
L
Linus Torvalds 已提交
1791

1792
	switch (iocb.aio_lio_opcode) {
C
Christoph Hellwig 已提交
1793
	case IOCB_CMD_PREAD:
1794
		ret = aio_read(&req->rw, &iocb, false, compat);
C
Christoph Hellwig 已提交
1795 1796
		break;
	case IOCB_CMD_PWRITE:
1797
		ret = aio_write(&req->rw, &iocb, false, compat);
C
Christoph Hellwig 已提交
1798 1799
		break;
	case IOCB_CMD_PREADV:
1800
		ret = aio_read(&req->rw, &iocb, true, compat);
C
Christoph Hellwig 已提交
1801 1802
		break;
	case IOCB_CMD_PWRITEV:
1803
		ret = aio_write(&req->rw, &iocb, true, compat);
C
Christoph Hellwig 已提交
1804
		break;
1805
	case IOCB_CMD_FSYNC:
1806
		ret = aio_fsync(&req->fsync, &iocb, false);
1807 1808
		break;
	case IOCB_CMD_FDSYNC:
1809
		ret = aio_fsync(&req->fsync, &iocb, true);
1810
		break;
C
Christoph Hellwig 已提交
1811
	case IOCB_CMD_POLL:
1812
		ret = aio_poll(req, &iocb);
1813
		break;
C
Christoph Hellwig 已提交
1814
	default:
1815
		pr_debug("invalid aio operation %d\n", iocb.aio_lio_opcode);
C
Christoph Hellwig 已提交
1816 1817 1818
		ret = -EINVAL;
		break;
	}
Z
Zach Brown 已提交
1819

1820
	/*
1821 1822 1823
	 * If ret is 0, we'd either done aio_complete() ourselves or have
	 * arranged for that to be done asynchronously.  Anything non-zero
	 * means that we need to destroy req ourselves.
1824
	 */
1825
	if (ret)
C
Christoph Hellwig 已提交
1826
		goto out_put_req;
L
Linus Torvalds 已提交
1827 1828
	return 0;
out_put_req:
K
Kent Overstreet 已提交
1829
	put_reqs_available(ctx, 1);
K
Kent Overstreet 已提交
1830
	percpu_ref_put(&ctx->reqs);
1831 1832 1833
	if (req->ki_eventfd)
		eventfd_ctx_put(req->ki_eventfd);
	kmem_cache_free(kiocb_cachep, req);
L
Linus Torvalds 已提交
1834 1835 1836
	return ret;
}

A
Al Viro 已提交
1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
/* sys_io_submit:
 *	Queue the nr iocbs pointed to by iocbpp for processing.  Returns
 *	the number of iocbs queued.  May return -EINVAL if the aio_context
 *	specified by ctx_id is invalid, if nr is < 0, if the iocb at
 *	*iocbpp[0] is not properly initialized, if the operation specified
 *	is invalid for the file descriptor in the iocb.  May fail with
 *	-EFAULT if any of the data structures point to invalid data.  May
 *	fail with -EBADF if the file descriptor specified in the first
 *	iocb is invalid.  May fail with -EAGAIN if insufficient resources
 *	are available to queue any iocbs.  Will return 0 if nr is 0.  Will
 *	fail with -ENOSYS if not implemented.
 */
SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
		struct iocb __user * __user *, iocbpp)
L
Linus Torvalds 已提交
1851 1852 1853
{
	struct kioctx *ctx;
	long ret = 0;
J
Jeff Moyer 已提交
1854
	int i = 0;
S
Shaohua Li 已提交
1855
	struct blk_plug plug;
L
Linus Torvalds 已提交
1856 1857 1858 1859 1860 1861

	if (unlikely(nr < 0))
		return -EINVAL;

	ctx = lookup_ioctx(ctx_id);
	if (unlikely(!ctx)) {
K
Kent Overstreet 已提交
1862
		pr_debug("EINVAL: invalid context id\n");
L
Linus Torvalds 已提交
1863 1864 1865
		return -EINVAL;
	}

1866 1867 1868
	if (nr > ctx->nr_events)
		nr = ctx->nr_events;

S
Shaohua Li 已提交
1869
	blk_start_plug(&plug);
A
Al Viro 已提交
1870
	for (i = 0; i < nr; i++) {
L
Linus Torvalds 已提交
1871 1872
		struct iocb __user *user_iocb;

A
Al Viro 已提交
1873
		if (unlikely(get_user(user_iocb, iocbpp + i))) {
L
Linus Torvalds 已提交
1874 1875 1876 1877
			ret = -EFAULT;
			break;
		}

A
Al Viro 已提交
1878
		ret = io_submit_one(ctx, user_iocb, false);
L
Linus Torvalds 已提交
1879 1880 1881
		if (ret)
			break;
	}
S
Shaohua Li 已提交
1882
	blk_finish_plug(&plug);
L
Linus Torvalds 已提交
1883

K
Kent Overstreet 已提交
1884
	percpu_ref_put(&ctx->users);
L
Linus Torvalds 已提交
1885 1886 1887
	return i ? i : ret;
}

A
Al Viro 已提交
1888 1889
#ifdef CONFIG_COMPAT
COMPAT_SYSCALL_DEFINE3(io_submit, compat_aio_context_t, ctx_id,
A
Al Viro 已提交
1890
		       int, nr, compat_uptr_t __user *, iocbpp)
A
Al Viro 已提交
1891
{
A
Al Viro 已提交
1892 1893 1894 1895
	struct kioctx *ctx;
	long ret = 0;
	int i = 0;
	struct blk_plug plug;
A
Al Viro 已提交
1896 1897 1898 1899

	if (unlikely(nr < 0))
		return -EINVAL;

A
Al Viro 已提交
1900 1901 1902 1903 1904 1905
	ctx = lookup_ioctx(ctx_id);
	if (unlikely(!ctx)) {
		pr_debug("EINVAL: invalid context id\n");
		return -EINVAL;
	}

1906 1907 1908
	if (nr > ctx->nr_events)
		nr = ctx->nr_events;

A
Al Viro 已提交
1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925
	blk_start_plug(&plug);
	for (i = 0; i < nr; i++) {
		compat_uptr_t user_iocb;

		if (unlikely(get_user(user_iocb, iocbpp + i))) {
			ret = -EFAULT;
			break;
		}

		ret = io_submit_one(ctx, compat_ptr(user_iocb), true);
		if (ret)
			break;
	}
	blk_finish_plug(&plug);

	percpu_ref_put(&ctx->users);
	return i ? i : ret;
A
Al Viro 已提交
1926 1927 1928
}
#endif

L
Linus Torvalds 已提交
1929 1930 1931
/* lookup_kiocb
 *	Finds a given iocb for cancellation.
 */
1932
static struct aio_kiocb *
1933
lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb)
L
Linus Torvalds 已提交
1934
{
1935
	struct aio_kiocb *kiocb;
1936 1937 1938

	assert_spin_locked(&ctx->ctx_lock);

L
Linus Torvalds 已提交
1939
	/* TODO: use a hash or array, this sucks. */
1940 1941
	list_for_each_entry(kiocb, &ctx->active_reqs, ki_list) {
		if (kiocb->ki_user_iocb == iocb)
L
Linus Torvalds 已提交
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956
			return kiocb;
	}
	return NULL;
}

/* sys_io_cancel:
 *	Attempts to cancel an iocb previously passed to io_submit.  If
 *	the operation is successfully cancelled, the resulting event is
 *	copied into the memory pointed to by result without being placed
 *	into the completion queue and 0 is returned.  May fail with
 *	-EFAULT if any of the data structures pointed to are invalid.
 *	May fail with -EINVAL if aio_context specified by ctx_id is
 *	invalid.  May fail with -EAGAIN if the iocb specified was not
 *	cancelled.  Will fail with -ENOSYS if not implemented.
 */
1957 1958
SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
		struct io_event __user *, result)
L
Linus Torvalds 已提交
1959 1960
{
	struct kioctx *ctx;
1961
	struct aio_kiocb *kiocb;
C
Christoph Hellwig 已提交
1962
	int ret = -EINVAL;
L
Linus Torvalds 已提交
1963 1964
	u32 key;

1965
	if (unlikely(get_user(key, &iocb->aio_key)))
L
Linus Torvalds 已提交
1966
		return -EFAULT;
1967 1968
	if (unlikely(key != KIOCB_KEY))
		return -EINVAL;
L
Linus Torvalds 已提交
1969 1970 1971 1972 1973 1974

	ctx = lookup_ioctx(ctx_id);
	if (unlikely(!ctx))
		return -EINVAL;

	spin_lock_irq(&ctx->ctx_lock);
1975
	kiocb = lookup_kiocb(ctx, iocb);
C
Christoph Hellwig 已提交
1976 1977 1978 1979
	if (kiocb) {
		ret = kiocb->ki_cancel(&kiocb->rw);
		list_del_init(&kiocb->ki_list);
	}
L
Linus Torvalds 已提交
1980 1981
	spin_unlock_irq(&ctx->ctx_lock);

K
Kent Overstreet 已提交
1982
	if (!ret) {
1983 1984 1985 1986
		/*
		 * The result argument is no longer used - the io_event is
		 * always delivered via the ring buffer. -EINPROGRESS indicates
		 * cancellation is progress:
K
Kent Overstreet 已提交
1987
		 */
1988
		ret = -EINPROGRESS;
K
Kent Overstreet 已提交
1989
	}
L
Linus Torvalds 已提交
1990

K
Kent Overstreet 已提交
1991
	percpu_ref_put(&ctx->users);
L
Linus Torvalds 已提交
1992 1993 1994 1995

	return ret;
}

1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014
static long do_io_getevents(aio_context_t ctx_id,
		long min_nr,
		long nr,
		struct io_event __user *events,
		struct timespec64 *ts)
{
	ktime_t until = ts ? timespec64_to_ktime(*ts) : KTIME_MAX;
	struct kioctx *ioctx = lookup_ioctx(ctx_id);
	long ret = -EINVAL;

	if (likely(ioctx)) {
		if (likely(min_nr <= nr && min_nr >= 0))
			ret = read_events(ioctx, min_nr, nr, events, until);
		percpu_ref_put(&ioctx->users);
	}

	return ret;
}

L
Linus Torvalds 已提交
2015 2016
/* io_getevents:
 *	Attempts to read at least min_nr events and up to nr events from
2017 2018 2019 2020 2021 2022 2023 2024
 *	the completion queue for the aio_context specified by ctx_id. If
 *	it succeeds, the number of read events is returned. May fail with
 *	-EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
 *	out of range, if timeout is out of range.  May fail with -EFAULT
 *	if any of the memory specified is invalid.  May return 0 or
 *	< min_nr if the timeout specified by timeout has elapsed
 *	before sufficient events are available, where timeout == NULL
 *	specifies an infinite timeout. Note that the timeout pointed to by
J
Jeff Moyer 已提交
2025
 *	timeout is relative.  Will fail with -ENOSYS if not implemented.
L
Linus Torvalds 已提交
2026
 */
2027 2028 2029 2030 2031
SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
		long, min_nr,
		long, nr,
		struct io_event __user *, events,
		struct timespec __user *, timeout)
L
Linus Torvalds 已提交
2032
{
2033
	struct timespec64	ts;
C
Christoph Hellwig 已提交
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
	int			ret;

	if (timeout && unlikely(get_timespec64(&ts, timeout)))
		return -EFAULT;

	ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &ts : NULL);
	if (!ret && signal_pending(current))
		ret = -EINTR;
	return ret;
}
L
Linus Torvalds 已提交
2044

2045 2046 2047 2048 2049
struct __aio_sigset {
	const sigset_t __user	*sigmask;
	size_t		sigsetsize;
};

C
Christoph Hellwig 已提交
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072
SYSCALL_DEFINE6(io_pgetevents,
		aio_context_t, ctx_id,
		long, min_nr,
		long, nr,
		struct io_event __user *, events,
		struct timespec __user *, timeout,
		const struct __aio_sigset __user *, usig)
{
	struct __aio_sigset	ksig = { NULL, };
	sigset_t		ksigmask, sigsaved;
	struct timespec64	ts;
	int ret;

	if (timeout && unlikely(get_timespec64(&ts, timeout)))
		return -EFAULT;

	if (usig && copy_from_user(&ksig, usig, sizeof(ksig)))
		return -EFAULT;

	if (ksig.sigmask) {
		if (ksig.sigsetsize != sizeof(sigset_t))
			return -EINVAL;
		if (copy_from_user(&ksigmask, ksig.sigmask, sizeof(ksigmask)))
2073
			return -EFAULT;
C
Christoph Hellwig 已提交
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
		sigdelsetmask(&ksigmask, sigmask(SIGKILL) | sigmask(SIGSTOP));
		sigprocmask(SIG_SETMASK, &ksigmask, &sigsaved);
	}

	ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &ts : NULL);
	if (signal_pending(current)) {
		if (ksig.sigmask) {
			current->saved_sigmask = sigsaved;
			set_restore_sigmask();
		}

		if (!ret)
			ret = -ERESTARTNOHAND;
	} else {
		if (ksig.sigmask)
			sigprocmask(SIG_SETMASK, &sigsaved, NULL);
L
Linus Torvalds 已提交
2090
	}
2091

C
Christoph Hellwig 已提交
2092
	return ret;
L
Linus Torvalds 已提交
2093
}
A
Al Viro 已提交
2094 2095 2096 2097 2098 2099 2100 2101

#ifdef CONFIG_COMPAT
COMPAT_SYSCALL_DEFINE5(io_getevents, compat_aio_context_t, ctx_id,
		       compat_long_t, min_nr,
		       compat_long_t, nr,
		       struct io_event __user *, events,
		       struct compat_timespec __user *, timeout)
{
2102
	struct timespec64 t;
C
Christoph Hellwig 已提交
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113
	int ret;

	if (timeout && compat_get_timespec64(&t, timeout))
		return -EFAULT;

	ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &t : NULL);
	if (!ret && signal_pending(current))
		ret = -EINTR;
	return ret;
}

A
Al Viro 已提交
2114

C
Christoph Hellwig 已提交
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142
struct __compat_aio_sigset {
	compat_sigset_t __user	*sigmask;
	compat_size_t		sigsetsize;
};

COMPAT_SYSCALL_DEFINE6(io_pgetevents,
		compat_aio_context_t, ctx_id,
		compat_long_t, min_nr,
		compat_long_t, nr,
		struct io_event __user *, events,
		struct compat_timespec __user *, timeout,
		const struct __compat_aio_sigset __user *, usig)
{
	struct __compat_aio_sigset ksig = { NULL, };
	sigset_t ksigmask, sigsaved;
	struct timespec64 t;
	int ret;

	if (timeout && compat_get_timespec64(&t, timeout))
		return -EFAULT;

	if (usig && copy_from_user(&ksig, usig, sizeof(ksig)))
		return -EFAULT;

	if (ksig.sigmask) {
		if (ksig.sigsetsize != sizeof(compat_sigset_t))
			return -EINVAL;
		if (get_compat_sigset(&ksigmask, ksig.sigmask))
A
Al Viro 已提交
2143
			return -EFAULT;
C
Christoph Hellwig 已提交
2144 2145 2146
		sigdelsetmask(&ksigmask, sigmask(SIGKILL) | sigmask(SIGSTOP));
		sigprocmask(SIG_SETMASK, &ksigmask, &sigsaved);
	}
A
Al Viro 已提交
2147

C
Christoph Hellwig 已提交
2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
	ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &t : NULL);
	if (signal_pending(current)) {
		if (ksig.sigmask) {
			current->saved_sigmask = sigsaved;
			set_restore_sigmask();
		}
		if (!ret)
			ret = -ERESTARTNOHAND;
	} else {
		if (ksig.sigmask)
			sigprocmask(SIG_SETMASK, &sigsaved, NULL);
A
Al Viro 已提交
2159
	}
2160

C
Christoph Hellwig 已提交
2161
	return ret;
A
Al Viro 已提交
2162 2163
}
#endif