aio.c 38.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 *	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.
 *
 *	See ../COPYING for licensing terms.
 */
K
Kent Overstreet 已提交
11 12
#define pr_fmt(fmt) "%s: " fmt, __func__

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

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

#include <asm/kmap_types.h>
#include <asm/uaccess.h>

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

49 50 51 52 53 54
#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 */
55 56
	unsigned	head;	/* Written to by userland or under ring_lock
				 * mutex by aio_read_events_ring(). */
57 58 59 60 61 62 63 64 65 66 67 68 69
	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

70 71 72 73 74 75
struct kioctx_table {
	struct rcu_head	rcu;
	unsigned	nr;
	struct kioctx	*table[];
};

K
Kent Overstreet 已提交
76 77 78 79
struct kioctx_cpu {
	unsigned		reqs_available;
};

80
struct kioctx {
K
Kent Overstreet 已提交
81
	struct percpu_ref	users;
K
Kent Overstreet 已提交
82
	atomic_t		dead;
83

K
Kent Overstreet 已提交
84 85
	struct percpu_ref	reqs;

86 87
	unsigned long		user_id;

K
Kent Overstreet 已提交
88 89 90 91 92 93 94
	struct __percpu kioctx_cpu *cpu;

	/*
	 * For percpu reqs_available, number of slots we move to/from global
	 * counter at a time:
	 */
	unsigned		req_batch;
95 96 97 98
	/*
	 * 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 已提交
99
	 * The real limit is nr_events - 1, which will be larger (see
100 101
	 * aio_setup_ring())
	 */
102 103
	unsigned		max_reqs;

K
Kent Overstreet 已提交
104 105
	/* Size of ringbuffer, in units of struct io_event */
	unsigned		nr_events;
106

K
Kent Overstreet 已提交
107 108 109 110 111 112
	unsigned long		mmap_base;
	unsigned long		mmap_size;

	struct page		**ring_pages;
	long			nr_pages;

K
Kent Overstreet 已提交
113
	struct work_struct	free_work;
114 115

	struct {
116 117 118 119 120
		/*
		 * 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 已提交
121 122
		 *
		 * We batch accesses to it with a percpu version.
123 124
		 */
		atomic_t	reqs_available;
125 126 127 128 129 130 131
	} ____cacheline_aligned_in_smp;

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

K
Kent Overstreet 已提交
132 133
	struct {
		struct mutex	ring_lock;
134 135
		wait_queue_head_t wait;
	} ____cacheline_aligned_in_smp;
K
Kent Overstreet 已提交
136 137 138 139

	struct {
		unsigned	tail;
		spinlock_t	completion_lock;
140
	} ____cacheline_aligned_in_smp;
K
Kent Overstreet 已提交
141 142

	struct page		*internal_pages[AIO_RING_PAGES];
143
	struct file		*aio_ring_file;
144 145

	unsigned		id;
146 147
};

L
Linus Torvalds 已提交
148
/*------ sysctl variables----*/
149 150 151
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 已提交
152 153
/*----end sysctl variables---*/

154 155
static struct kmem_cache	*kiocb_cachep;
static struct kmem_cache	*kioctx_cachep;
L
Linus Torvalds 已提交
156

157 158 159 160 161 162 163 164 165 166 167
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);
168 169
	if (IS_ERR(inode))
		return ERR_CAST(inode);
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

	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;
	file->private_data = ctx;
	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,
	};
	return mount_pseudo(fs_type, "aio:", NULL, &ops, 0xa10a10a1);
}

L
Linus Torvalds 已提交
203 204 205 206 207 208
/* 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)
{
209 210 211 212 213 214 215 216 217
	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.");

218 219
	kiocb_cachep = KMEM_CACHE(kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
	kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
L
Linus Torvalds 已提交
220

K
Kent Overstreet 已提交
221
	pr_debug("sizeof(struct page) = %zu\n", sizeof(struct page));
L
Linus Torvalds 已提交
222 223 224

	return 0;
}
225
__initcall(aio_setup);
L
Linus Torvalds 已提交
226

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
static void put_aio_ring_file(struct kioctx *ctx)
{
	struct file *aio_ring_file = ctx->aio_ring_file;
	if (aio_ring_file) {
		truncate_setsize(aio_ring_file->f_inode, 0);

		/* Prevent further access to the kioctx from migratepages */
		spin_lock(&aio_ring_file->f_inode->i_mapping->private_lock);
		aio_ring_file->f_inode->i_mapping->private_data = NULL;
		ctx->aio_ring_file = NULL;
		spin_unlock(&aio_ring_file->f_inode->i_mapping->private_lock);

		fput(aio_ring_file);
	}
}

L
Linus Torvalds 已提交
243 244
static void aio_free_ring(struct kioctx *ctx)
{
245
	int i;
L
Linus Torvalds 已提交
246

247 248 249 250 251
	/* Disconnect the kiotx from the ring file.  This prevents future
	 * accesses to the kioctx from page migration.
	 */
	put_aio_ring_file(ctx);

252
	for (i = 0; i < ctx->nr_pages; i++) {
253
		struct page *page;
254 255
		pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
				page_count(ctx->ring_pages[i]));
256 257 258 259 260
		page = ctx->ring_pages[i];
		if (!page)
			continue;
		ctx->ring_pages[i] = NULL;
		put_page(page);
261
	}
L
Linus Torvalds 已提交
262

263
	if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
K
Kent Overstreet 已提交
264
		kfree(ctx->ring_pages);
265 266
		ctx->ring_pages = NULL;
	}
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
}

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

static const struct file_operations aio_ring_fops = {
	.mmap = aio_ring_mmap,
};

static int aio_set_page_dirty(struct page *page)
{
	return 0;
}

284
#if IS_ENABLED(CONFIG_MIGRATION)
285 286 287
static int aio_migratepage(struct address_space *mapping, struct page *new,
			struct page *old, enum migrate_mode mode)
{
288
	struct kioctx *ctx;
289
	unsigned long flags;
290
	pgoff_t idx;
291 292
	int rc;

293 294
	rc = 0;

295
	/* mapping->private_lock here protects against the kioctx teardown.  */
296 297
	spin_lock(&mapping->private_lock);
	ctx = mapping->private_data;
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
	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;
317 318 319 320
	} else
		rc = -EINVAL;

	if (rc != 0)
321
		goto out_unlock;
322

323 324
	/* Writeback must be complete */
	BUG_ON(PageWriteback(old));
325
	get_page(new);
326

327
	rc = migrate_page_move_mapping(mapping, new, old, NULL, mode, 1);
328
	if (rc != MIGRATEPAGE_SUCCESS) {
329
		put_page(new);
330
		goto out_unlock;
331 332
	}

333 334 335
	/* 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.
336
	 */
337 338 339 340 341
	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);
342

343 344
	/* The old page is no longer accessible. */
	put_page(old);
345

346 347 348 349
out_unlock:
	mutex_unlock(&ctx->ring_lock);
out:
	spin_unlock(&mapping->private_lock);
350
	return rc;
L
Linus Torvalds 已提交
351
}
352
#endif
L
Linus Torvalds 已提交
353

354 355
static const struct address_space_operations aio_ctx_aops = {
	.set_page_dirty = aio_set_page_dirty,
356
#if IS_ENABLED(CONFIG_MIGRATION)
357
	.migratepage	= aio_migratepage,
358
#endif
359 360
};

L
Linus Torvalds 已提交
361 362 363 364
static int aio_setup_ring(struct kioctx *ctx)
{
	struct aio_ring *ring;
	unsigned nr_events = ctx->max_reqs;
Z
Zach Brown 已提交
365
	struct mm_struct *mm = current->mm;
366
	unsigned long size, unused;
L
Linus Torvalds 已提交
367
	int nr_pages;
368 369
	int i;
	struct file *file;
L
Linus Torvalds 已提交
370 371 372 373 374 375 376

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

377
	nr_pages = PFN_UP(size);
L
Linus Torvalds 已提交
378 379 380
	if (nr_pages < 0)
		return -EINVAL;

381
	file = aio_private_file(ctx, nr_pages);
382 383
	if (IS_ERR(file)) {
		ctx->aio_ring_file = NULL;
384
		return -ENOMEM;
385 386
	}

387 388 389 390 391 392 393 394 395 396 397 398 399 400
	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;
		}
	}

401 402 403 404 405 406 407 408 409 410 411
	for (i = 0; i < nr_pages; i++) {
		struct page *page;
		page = find_or_create_page(file->f_inode->i_mapping,
					   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);
		SetPageDirty(page);
		unlock_page(page);
412 413

		ctx->ring_pages[i] = page;
414
	}
415
	ctx->nr_pages = i;
L
Linus Torvalds 已提交
416

417 418
	if (unlikely(i != nr_pages)) {
		aio_free_ring(ctx);
419
		return -ENOMEM;
L
Linus Torvalds 已提交
420 421
	}

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

Z
Zach Brown 已提交
425
	down_write(&mm->mmap_sem);
426 427
	ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
				       PROT_READ | PROT_WRITE,
428 429
				       MAP_SHARED, 0, &unused);
	up_write(&mm->mmap_sem);
K
Kent Overstreet 已提交
430 431
	if (IS_ERR((void *)ctx->mmap_base)) {
		ctx->mmap_size = 0;
L
Linus Torvalds 已提交
432
		aio_free_ring(ctx);
433
		return -ENOMEM;
L
Linus Torvalds 已提交
434 435
	}

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

K
Kent Overstreet 已提交
438 439
	ctx->user_id = ctx->mmap_base;
	ctx->nr_events = nr_events; /* trusted copy */
L
Linus Torvalds 已提交
440

K
Kent Overstreet 已提交
441
	ring = kmap_atomic(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
442
	ring->nr = nr_events;	/* user copy */
443
	ring->id = ~0U;
L
Linus Torvalds 已提交
444 445 446 447 448
	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);
449
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
450
	flush_dcache_page(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
451 452 453 454 455 456 457 458

	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)

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
void kiocb_set_cancel_fn(struct kiocb *req, kiocb_cancel_fn *cancel)
{
	struct kioctx *ctx = req->ki_ctx;
	unsigned long flags;

	spin_lock_irqsave(&ctx->ctx_lock, flags);

	if (!req->ki_list.next)
		list_add(&req->ki_list, &ctx->active_reqs);

	req->ki_cancel = cancel;

	spin_unlock_irqrestore(&ctx->ctx_lock, flags);
}
EXPORT_SYMBOL(kiocb_set_cancel_fn);

475
static int kiocb_cancel(struct kioctx *ctx, struct kiocb *kiocb)
K
Kent Overstreet 已提交
476
{
477
	kiocb_cancel_fn *old, *cancel;
K
Kent Overstreet 已提交
478

479 480 481 482 483 484 485 486
	/*
	 * Don't want to set kiocb->ki_cancel = KIOCB_CANCELLED unless it
	 * actually has a cancel function, hence the cmpxchg()
	 */

	cancel = ACCESS_ONCE(kiocb->ki_cancel);
	do {
		if (!cancel || cancel == KIOCB_CANCELLED)
K
Kent Overstreet 已提交
487
			return -EINVAL;
K
Kent Overstreet 已提交
488

489 490 491
		old = cancel;
		cancel = cmpxchg(&kiocb->ki_cancel, old, KIOCB_CANCELLED);
	} while (cancel != old);
K
Kent Overstreet 已提交
492

K
Kent Overstreet 已提交
493
	return cancel(kiocb);
K
Kent Overstreet 已提交
494 495
}

K
Kent Overstreet 已提交
496
static void free_ioctx(struct work_struct *work)
K
Kent Overstreet 已提交
497
{
K
Kent Overstreet 已提交
498
	struct kioctx *ctx = container_of(work, struct kioctx, free_work);
K
Kent Overstreet 已提交
499

K
Kent Overstreet 已提交
500
	pr_debug("freeing %p\n", ctx);
K
Kent Overstreet 已提交
501

K
Kent Overstreet 已提交
502
	aio_free_ring(ctx);
K
Kent Overstreet 已提交
503
	free_percpu(ctx->cpu);
K
Kent Overstreet 已提交
504 505 506
	kmem_cache_free(kioctx_cachep, ctx);
}

K
Kent Overstreet 已提交
507 508 509 510 511 512 513 514
static void free_ioctx_reqs(struct percpu_ref *ref)
{
	struct kioctx *ctx = container_of(ref, struct kioctx, reqs);

	INIT_WORK(&ctx->free_work, free_ioctx);
	schedule_work(&ctx->free_work);
}

K
Kent Overstreet 已提交
515 516 517 518 519
/*
 * 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 已提交
520
static void free_ioctx_users(struct percpu_ref *ref)
K
Kent Overstreet 已提交
521
{
K
Kent Overstreet 已提交
522
	struct kioctx *ctx = container_of(ref, struct kioctx, users);
K
Kent Overstreet 已提交
523 524 525 526 527 528 529 530 531
	struct kiocb *req;

	spin_lock_irq(&ctx->ctx_lock);

	while (!list_empty(&ctx->active_reqs)) {
		req = list_first_entry(&ctx->active_reqs,
				       struct kiocb, ki_list);

		list_del_init(&req->ki_list);
532
		kiocb_cancel(ctx, req);
K
Kent Overstreet 已提交
533 534 535 536
	}

	spin_unlock_irq(&ctx->ctx_lock);

K
Kent Overstreet 已提交
537 538
	percpu_ref_kill(&ctx->reqs);
	percpu_ref_put(&ctx->reqs);
K
Kent Overstreet 已提交
539 540
}

541 542 543 544 545 546 547
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);
548
	rcu_read_lock();
549
	table = rcu_dereference(mm->ioctx_table);
550 551 552 553 554 555 556

	while (1) {
		if (table)
			for (i = 0; i < table->nr; i++)
				if (!table->table[i]) {
					ctx->id = i;
					table->table[i] = ctx;
557
					rcu_read_unlock();
558 559
					spin_unlock(&mm->ioctx_lock);

560 561 562 563
					/* While kioctx setup is in progress,
					 * we are protected from page migration
					 * changes ring_pages by ->ring_lock.
					 */
564 565 566 567 568 569 570 571
					ring = kmap_atomic(ctx->ring_pages[0]);
					ring->id = ctx->id;
					kunmap_atomic(ring);
					return 0;
				}

		new_nr = (table ? table->nr : 1) * 4;

572
		rcu_read_unlock();
573 574 575 576 577 578 579 580 581 582
		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);
583
		rcu_read_lock();
584
		old = rcu_dereference(mm->ioctx_table);
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600

		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 已提交
601 602 603 604 605 606 607 608 609 610
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 已提交
611 612 613 614 615
/* 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 已提交
616
	struct mm_struct *mm = current->mm;
L
Linus Torvalds 已提交
617
	struct kioctx *ctx;
618
	int err = -ENOMEM;
L
Linus Torvalds 已提交
619

K
Kent Overstreet 已提交
620 621 622 623 624 625 626 627 628 629 630 631
	/*
	 * 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 已提交
632 633 634 635 636 637 638
	/* Prevent overflows */
	if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
	    (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
		pr_debug("ENOMEM: nr_events too high\n");
		return ERR_PTR(-EINVAL);
	}

639
	if (!nr_events || (unsigned long)nr_events > (aio_max_nr * 2UL))
L
Linus Torvalds 已提交
640 641
		return ERR_PTR(-EAGAIN);

642
	ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
643 644 645 646 647 648
	if (!ctx)
		return ERR_PTR(-ENOMEM);

	ctx->max_reqs = nr_events;

	spin_lock_init(&ctx->ctx_lock);
649
	spin_lock_init(&ctx->completion_lock);
K
Kent Overstreet 已提交
650
	mutex_init(&ctx->ring_lock);
651 652 653
	/* 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 已提交
654 655 656 657
	init_waitqueue_head(&ctx->wait);

	INIT_LIST_HEAD(&ctx->active_reqs);

658 659 660 661 662 663
	if (percpu_ref_init(&ctx->users, free_ioctx_users))
		goto err;

	if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs))
		goto err;

K
Kent Overstreet 已提交
664 665
	ctx->cpu = alloc_percpu(struct kioctx_cpu);
	if (!ctx->cpu)
K
Kent Overstreet 已提交
666
		goto err;
L
Linus Torvalds 已提交
667

668 669
	err = aio_setup_ring(ctx);
	if (err < 0)
K
Kent Overstreet 已提交
670
		goto err;
K
Kent Overstreet 已提交
671

672
	atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
K
Kent Overstreet 已提交
673
	ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
674 675
	if (ctx->req_batch < 1)
		ctx->req_batch = 1;
676

L
Linus Torvalds 已提交
677
	/* limit the number of system wide aios */
678
	spin_lock(&aio_nr_lock);
679
	if (aio_nr + nr_events > (aio_max_nr * 2UL) ||
680
	    aio_nr + nr_events < aio_nr) {
681
		spin_unlock(&aio_nr_lock);
K
Kent Overstreet 已提交
682
		err = -EAGAIN;
G
Gu Zheng 已提交
683
		goto err_ctx;
684 685
	}
	aio_nr += ctx->max_reqs;
686
	spin_unlock(&aio_nr_lock);
L
Linus Torvalds 已提交
687

688 689
	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 已提交
690

691 692
	err = ioctx_add_table(ctx, mm);
	if (err)
K
Kent Overstreet 已提交
693
		goto err_cleanup;
694

695 696 697
	/* Release the ring_lock mutex now that all setup is complete. */
	mutex_unlock(&ctx->ring_lock);

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

K
Kent Overstreet 已提交
702 703
err_cleanup:
	aio_nr_sub(ctx->max_reqs);
G
Gu Zheng 已提交
704 705
err_ctx:
	aio_free_ring(ctx);
K
Kent Overstreet 已提交
706
err:
707
	mutex_unlock(&ctx->ring_lock);
K
Kent Overstreet 已提交
708
	free_percpu(ctx->cpu);
K
Kent Overstreet 已提交
709
	free_percpu(ctx->reqs.pcpu_count);
K
Kent Overstreet 已提交
710
	free_percpu(ctx->users.pcpu_count);
L
Linus Torvalds 已提交
711
	kmem_cache_free(kioctx_cachep, ctx);
K
Kent Overstreet 已提交
712
	pr_debug("error allocating ioctx %d\n", err);
713
	return ERR_PTR(err);
L
Linus Torvalds 已提交
714 715
}

K
Kent Overstreet 已提交
716 717 718 719 720
/* 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.
 */
721
static void kill_ioctx(struct mm_struct *mm, struct kioctx *ctx)
K
Kent Overstreet 已提交
722 723
{
	if (!atomic_xchg(&ctx->dead, 1)) {
724 725 726
		struct kioctx_table *table;

		spin_lock(&mm->ioctx_lock);
727
		rcu_read_lock();
728
		table = rcu_dereference(mm->ioctx_table);
729 730 731

		WARN_ON(ctx != table->table[ctx->id]);
		table->table[ctx->id] = NULL;
732
		rcu_read_unlock();
733 734
		spin_unlock(&mm->ioctx_lock);

K
Kent Overstreet 已提交
735 736
		/* percpu_ref_kill() will do the necessary call_rcu() */
		wake_up_all(&ctx->wait);
737

K
Kent Overstreet 已提交
738
		/*
739 740 741 742 743
		 * 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).
K
Kent Overstreet 已提交
744
		 */
K
Kent Overstreet 已提交
745
		aio_nr_sub(ctx->max_reqs);
746 747 748 749

		if (ctx->mmap_size)
			vm_munmap(ctx->mmap_base, ctx->mmap_size);

K
Kent Overstreet 已提交
750
		percpu_ref_kill(&ctx->users);
K
Kent Overstreet 已提交
751
	}
L
Linus Torvalds 已提交
752 753 754 755 756
}

/* wait_on_sync_kiocb:
 *	Waits on the given sync kiocb to complete.
 */
K
Kent Overstreet 已提交
757
ssize_t wait_on_sync_kiocb(struct kiocb *req)
L
Linus Torvalds 已提交
758
{
K
Kent Overstreet 已提交
759
	while (!req->ki_ctx) {
L
Linus Torvalds 已提交
760
		set_current_state(TASK_UNINTERRUPTIBLE);
K
Kent Overstreet 已提交
761
		if (req->ki_ctx)
L
Linus Torvalds 已提交
762
			break;
J
Jeff Moyer 已提交
763
		io_schedule();
L
Linus Torvalds 已提交
764 765
	}
	__set_current_state(TASK_RUNNING);
K
Kent Overstreet 已提交
766
	return req->ki_user_data;
L
Linus Torvalds 已提交
767
}
768
EXPORT_SYMBOL(wait_on_sync_kiocb);
L
Linus Torvalds 已提交
769

K
Kent Overstreet 已提交
770 771 772 773 774 775 776
/*
 * 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 已提交
777
 */
778
void exit_aio(struct mm_struct *mm)
L
Linus Torvalds 已提交
779
{
780
	struct kioctx_table *table;
J
Jens Axboe 已提交
781
	struct kioctx *ctx;
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
	unsigned i = 0;

	while (1) {
		rcu_read_lock();
		table = rcu_dereference(mm->ioctx_table);

		do {
			if (!table || i >= table->nr) {
				rcu_read_unlock();
				rcu_assign_pointer(mm->ioctx_table, NULL);
				if (table)
					kfree(table);
				return;
			}

			ctx = table->table[i++];
		} while (!ctx);

		rcu_read_unlock();
J
Jens Axboe 已提交
801

802 803 804 805 806 807 808 809
		/*
		 * We don't need to bother with munmap() here -
		 * exit_mmap(mm) is coming and it'll unmap everything.
		 * Since aio_free_ring() uses non-zero ->mmap_size
		 * as indicator that it needs to unmap the area,
		 * just set it to 0; aio_free_ring() is the only
		 * place that uses ->mmap_size, so it's safe.
		 */
K
Kent Overstreet 已提交
810
		ctx->mmap_size = 0;
K
Kent Overstreet 已提交
811

812
		kill_ioctx(mm, ctx);
L
Linus Torvalds 已提交
813 814 815
	}
}

K
Kent Overstreet 已提交
816 817 818 819 820 821 822 823 824 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 852 853 854 855 856 857 858 859 860 861
static void put_reqs_available(struct kioctx *ctx, unsigned nr)
{
	struct kioctx_cpu *kcpu;

	preempt_disable();
	kcpu = this_cpu_ptr(ctx->cpu);

	kcpu->reqs_available += nr;
	while (kcpu->reqs_available >= ctx->req_batch * 2) {
		kcpu->reqs_available -= ctx->req_batch;
		atomic_add(ctx->req_batch, &ctx->reqs_available);
	}

	preempt_enable();
}

static bool get_reqs_available(struct kioctx *ctx)
{
	struct kioctx_cpu *kcpu;
	bool ret = false;

	preempt_disable();
	kcpu = this_cpu_ptr(ctx->cpu);

	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:
	preempt_enable();
	return ret;
}

L
Linus Torvalds 已提交
862
/* aio_get_req
K
Kent Overstreet 已提交
863 864
 *	Allocate a slot for an aio request.
 * Returns NULL if no requests are free.
L
Linus Torvalds 已提交
865
 */
K
Kent Overstreet 已提交
866
static inline struct kiocb *aio_get_req(struct kioctx *ctx)
L
Linus Torvalds 已提交
867
{
K
Kent Overstreet 已提交
868 869
	struct kiocb *req;

K
Kent Overstreet 已提交
870
	if (!get_reqs_available(ctx))
K
Kent Overstreet 已提交
871 872
		return NULL;

873
	req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
L
Linus Torvalds 已提交
874
	if (unlikely(!req))
K
Kent Overstreet 已提交
875
		goto out_put;
L
Linus Torvalds 已提交
876

K
Kent Overstreet 已提交
877 878
	percpu_ref_get(&ctx->reqs);

L
Linus Torvalds 已提交
879
	req->ki_ctx = ctx;
J
Jeff Moyer 已提交
880
	return req;
K
Kent Overstreet 已提交
881
out_put:
K
Kent Overstreet 已提交
882
	put_reqs_available(ctx, 1);
K
Kent Overstreet 已提交
883
	return NULL;
L
Linus Torvalds 已提交
884 885
}

886
static void kiocb_free(struct kiocb *req)
L
Linus Torvalds 已提交
887
{
888 889
	if (req->ki_filp)
		fput(req->ki_filp);
890 891
	if (req->ki_eventfd != NULL)
		eventfd_ctx_put(req->ki_eventfd);
L
Linus Torvalds 已提交
892 893 894
	kmem_cache_free(kiocb_cachep, req);
}

A
Adrian Bunk 已提交
895
static struct kioctx *lookup_ioctx(unsigned long ctx_id)
L
Linus Torvalds 已提交
896
{
897
	struct aio_ring __user *ring  = (void __user *)ctx_id;
J
Jens Axboe 已提交
898
	struct mm_struct *mm = current->mm;
899
	struct kioctx *ctx, *ret = NULL;
900 901 902 903 904
	struct kioctx_table *table;
	unsigned id;

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

J
Jens Axboe 已提交
906
	rcu_read_lock();
907
	table = rcu_dereference(mm->ioctx_table);
J
Jens Axboe 已提交
908

909 910
	if (!table || id >= table->nr)
		goto out;
L
Linus Torvalds 已提交
911

912
	ctx = table->table[id];
913
	if (ctx && ctx->user_id == ctx_id) {
914 915 916 917
		percpu_ref_get(&ctx->users);
		ret = ctx;
	}
out:
J
Jens Axboe 已提交
918
	rcu_read_unlock();
919
	return ret;
L
Linus Torvalds 已提交
920 921 922 923 924
}

/* aio_complete
 *	Called when the io request on the given iocb is complete.
 */
925
void aio_complete(struct kiocb *iocb, long res, long res2)
L
Linus Torvalds 已提交
926 927 928
{
	struct kioctx	*ctx = iocb->ki_ctx;
	struct aio_ring	*ring;
K
Kent Overstreet 已提交
929
	struct io_event	*ev_page, *event;
L
Linus Torvalds 已提交
930
	unsigned long	flags;
K
Kent Overstreet 已提交
931
	unsigned tail, pos;
L
Linus Torvalds 已提交
932

933 934 935 936 937 938
	/*
	 * Special case handling for sync iocbs:
	 *  - events go directly into the iocb for fast handling
	 *  - the sync task with the iocb in its stack holds the single iocb
	 *    ref, no other paths have a way to get another ref
	 *  - the sync task helpfully left a reference to itself in the iocb
L
Linus Torvalds 已提交
939 940 941
	 */
	if (is_sync_kiocb(iocb)) {
		iocb->ki_user_data = res;
K
Kent Overstreet 已提交
942 943
		smp_wmb();
		iocb->ki_ctx = ERR_PTR(-EXDEV);
L
Linus Torvalds 已提交
944
		wake_up_process(iocb->ki_obj.tsk);
945
		return;
L
Linus Torvalds 已提交
946 947
	}

948 949 950 951 952 953 954
	if (iocb->ki_list.next) {
		unsigned long flags;

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

956 957
	/*
	 * Add a completion event to the ring buffer. Must be done holding
958
	 * ctx->completion_lock to prevent other code from messing with the tail
959 960 961 962
	 * pointer since we might be called from irq context.
	 */
	spin_lock_irqsave(&ctx->completion_lock, flags);

K
Kent Overstreet 已提交
963
	tail = ctx->tail;
K
Kent Overstreet 已提交
964 965
	pos = tail + AIO_EVENTS_OFFSET;

K
Kent Overstreet 已提交
966
	if (++tail >= ctx->nr_events)
967
		tail = 0;
L
Linus Torvalds 已提交
968

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

L
Linus Torvalds 已提交
972 973 974 975 976
	event->obj = (u64)(unsigned long)iocb->ki_obj.user;
	event->data = iocb->ki_user_data;
	event->res = res;
	event->res2 = res2;

K
Kent Overstreet 已提交
977
	kunmap_atomic(ev_page);
K
Kent Overstreet 已提交
978
	flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
K
Kent Overstreet 已提交
979 980

	pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
K
Kent Overstreet 已提交
981 982
		 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
		 res, res2);
L
Linus Torvalds 已提交
983 984 985 986 987 988

	/* 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 已提交
989
	ctx->tail = tail;
L
Linus Torvalds 已提交
990

K
Kent Overstreet 已提交
991
	ring = kmap_atomic(ctx->ring_pages[0]);
K
Kent Overstreet 已提交
992
	ring->tail = tail;
993
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
994
	flush_dcache_page(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
995

996 997
	spin_unlock_irqrestore(&ctx->completion_lock, flags);

K
Kent Overstreet 已提交
998
	pr_debug("added to ring %p at [%u]\n", iocb, tail);
D
Davide Libenzi 已提交
999 1000 1001 1002 1003 1004

	/*
	 * 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.
	 */
1005
	if (iocb->ki_eventfd != NULL)
D
Davide Libenzi 已提交
1006 1007
		eventfd_signal(iocb->ki_eventfd, 1);

L
Linus Torvalds 已提交
1008
	/* everything turned out well, dispose of the aiocb. */
K
Kent Overstreet 已提交
1009
	kiocb_free(iocb);
L
Linus Torvalds 已提交
1010

1011 1012 1013 1014 1015 1016 1017 1018
	/*
	 * 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 已提交
1019 1020 1021
	if (waitqueue_active(&ctx->wait))
		wake_up(&ctx->wait);

K
Kent Overstreet 已提交
1022
	percpu_ref_put(&ctx->reqs);
L
Linus Torvalds 已提交
1023
}
1024
EXPORT_SYMBOL(aio_complete);
L
Linus Torvalds 已提交
1025

1026 1027 1028
/* aio_read_events
 *	Pull an event off of the ioctx's event ring.  Returns the number of
 *	events fetched
L
Linus Torvalds 已提交
1029
 */
1030 1031
static long aio_read_events_ring(struct kioctx *ctx,
				 struct io_event __user *event, long nr)
L
Linus Torvalds 已提交
1032 1033
{
	struct aio_ring *ring;
1034
	unsigned head, tail, pos;
1035 1036 1037
	long ret = 0;
	int copy_ret;

K
Kent Overstreet 已提交
1038
	mutex_lock(&ctx->ring_lock);
L
Linus Torvalds 已提交
1039

1040
	/* Access to ->ring_pages here is protected by ctx->ring_lock. */
K
Kent Overstreet 已提交
1041
	ring = kmap_atomic(ctx->ring_pages[0]);
1042
	head = ring->head;
1043
	tail = ring->tail;
1044 1045
	kunmap_atomic(ring);

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

1048
	if (head == tail)
L
Linus Torvalds 已提交
1049 1050
		goto out;

1051 1052 1053 1054 1055
	while (ret < nr) {
		long avail;
		struct io_event *ev;
		struct page *page;

1056 1057
		avail = (head <= tail ?  tail : ctx->nr_events) - head;
		if (head == tail)
1058 1059 1060 1061 1062 1063 1064
			break;

		avail = min(avail, nr - ret);
		avail = min_t(long, avail, AIO_EVENTS_PER_PAGE -
			    ((head + AIO_EVENTS_OFFSET) % AIO_EVENTS_PER_PAGE));

		pos = head + AIO_EVENTS_OFFSET;
K
Kent Overstreet 已提交
1065
		page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
		pos %= AIO_EVENTS_PER_PAGE;

		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 已提交
1080
		head %= ctx->nr_events;
L
Linus Torvalds 已提交
1081 1082
	}

K
Kent Overstreet 已提交
1083
	ring = kmap_atomic(ctx->ring_pages[0]);
1084
	ring->head = head;
1085
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
1086
	flush_dcache_page(ctx->ring_pages[0]);
1087

1088
	pr_debug("%li  h%u t%u\n", ret, head, tail);
1089

K
Kent Overstreet 已提交
1090
	put_reqs_available(ctx, ret);
1091
out:
K
Kent Overstreet 已提交
1092
	mutex_unlock(&ctx->ring_lock);
1093

L
Linus Torvalds 已提交
1094 1095 1096
	return ret;
}

1097 1098
static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
			    struct io_event __user *event, long *i)
L
Linus Torvalds 已提交
1099
{
1100
	long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
L
Linus Torvalds 已提交
1101

1102 1103
	if (ret > 0)
		*i += ret;
L
Linus Torvalds 已提交
1104

1105 1106
	if (unlikely(atomic_read(&ctx->dead)))
		ret = -EINVAL;
L
Linus Torvalds 已提交
1107

1108 1109
	if (!*i)
		*i = ret;
L
Linus Torvalds 已提交
1110

1111
	return ret < 0 || *i >= min_nr;
L
Linus Torvalds 已提交
1112 1113
}

1114
static long read_events(struct kioctx *ctx, long min_nr, long nr,
L
Linus Torvalds 已提交
1115 1116 1117
			struct io_event __user *event,
			struct timespec __user *timeout)
{
1118 1119
	ktime_t until = { .tv64 = KTIME_MAX };
	long ret = 0;
L
Linus Torvalds 已提交
1120 1121 1122

	if (timeout) {
		struct timespec	ts;
1123

L
Linus Torvalds 已提交
1124
		if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1125
			return -EFAULT;
L
Linus Torvalds 已提交
1126

1127
		until = timespec_to_ktime(ts);
L
Linus Torvalds 已提交
1128 1129
	}

1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
	/*
	 * 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.
	 */
	wait_event_interruptible_hrtimeout(ctx->wait,
			aio_read_events(ctx, min_nr, nr, event, &ret), until);
L
Linus Torvalds 已提交
1146

1147 1148
	if (!ret && signal_pending(current))
		ret = -EINTR;
L
Linus Torvalds 已提交
1149

1150
	return ret;
L
Linus Torvalds 已提交
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
}

/* 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.
 */
1166
SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
L
Linus Torvalds 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
{
	struct kioctx *ioctx = NULL;
	unsigned long ctx;
	long ret;

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

	ret = -EINVAL;
1177 1178 1179
	if (unlikely(ctx || nr_events == 0)) {
		pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
		         ctx, nr_events);
L
Linus Torvalds 已提交
1180 1181 1182 1183 1184 1185 1186
		goto out;
	}

	ioctx = ioctx_alloc(nr_events);
	ret = PTR_ERR(ioctx);
	if (!IS_ERR(ioctx)) {
		ret = put_user(ioctx->user_id, ctxp);
1187
		if (ret)
1188
			kill_ioctx(current->mm, ioctx);
K
Kent Overstreet 已提交
1189
		percpu_ref_put(&ioctx->users);
L
Linus Torvalds 已提交
1190 1191 1192 1193 1194 1195 1196 1197 1198
	}

out:
	return ret;
}

/* sys_io_destroy:
 *	Destroy the aio_context specified.  May cancel any outstanding 
 *	AIOs and block on completion.  Will fail with -ENOSYS if not
1199
 *	implemented.  May fail with -EINVAL if the context pointed to
L
Linus Torvalds 已提交
1200 1201
 *	is invalid.
 */
1202
SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
L
Linus Torvalds 已提交
1203 1204 1205
{
	struct kioctx *ioctx = lookup_ioctx(ctx);
	if (likely(NULL != ioctx)) {
1206
		kill_ioctx(current->mm, ioctx);
K
Kent Overstreet 已提交
1207
		percpu_ref_put(&ioctx->users);
L
Linus Torvalds 已提交
1208 1209 1210 1211 1212 1213
		return 0;
	}
	pr_debug("EINVAL: io_destroy: invalid context id\n");
	return -EINVAL;
}

K
Kent Overstreet 已提交
1214 1215 1216
typedef ssize_t (aio_rw_op)(struct kiocb *, const struct iovec *,
			    unsigned long, loff_t);

1217 1218 1219 1220 1221
static ssize_t aio_setup_vectored_rw(struct kiocb *kiocb,
				     int rw, char __user *buf,
				     unsigned long *nr_segs,
				     struct iovec **iovec,
				     bool compat)
B
Badari Pulavarty 已提交
1222 1223 1224
{
	ssize_t ret;

1225
	*nr_segs = kiocb->ki_nbytes;
K
Kent Overstreet 已提交
1226

1227 1228
#ifdef CONFIG_COMPAT
	if (compat)
K
Kent Overstreet 已提交
1229
		ret = compat_rw_copy_check_uvector(rw,
1230 1231
				(struct compat_iovec __user *)buf,
				*nr_segs, 1, *iovec, iovec);
1232 1233
	else
#endif
K
Kent Overstreet 已提交
1234
		ret = rw_copy_check_uvector(rw,
1235 1236
				(struct iovec __user *)buf,
				*nr_segs, 1, *iovec, iovec);
B
Badari Pulavarty 已提交
1237
	if (ret < 0)
K
Kent Overstreet 已提交
1238
		return ret;
1239

K
Kent Overstreet 已提交
1240
	/* ki_nbytes now reflect bytes instead of segs */
B
Badari Pulavarty 已提交
1241
	kiocb->ki_nbytes = ret;
K
Kent Overstreet 已提交
1242
	return 0;
B
Badari Pulavarty 已提交
1243 1244
}

1245 1246 1247 1248
static ssize_t aio_setup_single_vector(struct kiocb *kiocb,
				       int rw, char __user *buf,
				       unsigned long *nr_segs,
				       struct iovec *iovec)
B
Badari Pulavarty 已提交
1249
{
1250
	if (unlikely(!access_ok(!rw, buf, kiocb->ki_nbytes)))
K
Kent Overstreet 已提交
1251
		return -EFAULT;
1252

1253 1254 1255
	iovec->iov_base = buf;
	iovec->iov_len = kiocb->ki_nbytes;
	*nr_segs = 1;
B
Badari Pulavarty 已提交
1256 1257 1258
	return 0;
}

L
Linus Torvalds 已提交
1259 1260 1261 1262 1263
/*
 * aio_setup_iocb:
 *	Performs the initial checks and aio retry method
 *	setup for the kiocb at the time of io submission.
 */
1264 1265
static ssize_t aio_run_iocb(struct kiocb *req, unsigned opcode,
			    char __user *buf, bool compat)
L
Linus Torvalds 已提交
1266
{
K
Kent Overstreet 已提交
1267 1268
	struct file *file = req->ki_filp;
	ssize_t ret;
1269
	unsigned long nr_segs;
K
Kent Overstreet 已提交
1270 1271 1272
	int rw;
	fmode_t mode;
	aio_rw_op *rw_op;
1273
	struct iovec inline_vec, *iovec = &inline_vec;
L
Linus Torvalds 已提交
1274

1275
	switch (opcode) {
L
Linus Torvalds 已提交
1276
	case IOCB_CMD_PREAD:
B
Badari Pulavarty 已提交
1277
	case IOCB_CMD_PREADV:
K
Kent Overstreet 已提交
1278 1279 1280 1281 1282 1283
		mode	= FMODE_READ;
		rw	= READ;
		rw_op	= file->f_op->aio_read;
		goto rw_common;

	case IOCB_CMD_PWRITE:
B
Badari Pulavarty 已提交
1284
	case IOCB_CMD_PWRITEV:
K
Kent Overstreet 已提交
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
		mode	= FMODE_WRITE;
		rw	= WRITE;
		rw_op	= file->f_op->aio_write;
		goto rw_common;
rw_common:
		if (unlikely(!(file->f_mode & mode)))
			return -EBADF;

		if (!rw_op)
			return -EINVAL;

1296 1297 1298 1299 1300 1301
		ret = (opcode == IOCB_CMD_PREADV ||
		       opcode == IOCB_CMD_PWRITEV)
			? aio_setup_vectored_rw(req, rw, buf, &nr_segs,
						&iovec, compat)
			: aio_setup_single_vector(req, rw, buf, &nr_segs,
						  iovec);
B
Badari Pulavarty 已提交
1302
		if (ret)
K
Kent Overstreet 已提交
1303 1304 1305
			return ret;

		ret = rw_verify_area(rw, file, &req->ki_pos, req->ki_nbytes);
1306 1307 1308
		if (ret < 0) {
			if (iovec != &inline_vec)
				kfree(iovec);
K
Kent Overstreet 已提交
1309
			return ret;
1310
		}
K
Kent Overstreet 已提交
1311 1312 1313

		req->ki_nbytes = ret;

K
Kent Overstreet 已提交
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
		/* XXX: move/kill - rw_verify_area()? */
		/* This matches the pread()/pwrite() logic */
		if (req->ki_pos < 0) {
			ret = -EINVAL;
			break;
		}

		if (rw == WRITE)
			file_start_write(file);

1324
		ret = rw_op(req, iovec, nr_segs, req->ki_pos);
K
Kent Overstreet 已提交
1325 1326 1327

		if (rw == WRITE)
			file_end_write(file);
L
Linus Torvalds 已提交
1328
		break;
K
Kent Overstreet 已提交
1329

L
Linus Torvalds 已提交
1330
	case IOCB_CMD_FDSYNC:
K
Kent Overstreet 已提交
1331 1332 1333 1334
		if (!file->f_op->aio_fsync)
			return -EINVAL;

		ret = file->f_op->aio_fsync(req, 1);
L
Linus Torvalds 已提交
1335
		break;
K
Kent Overstreet 已提交
1336

L
Linus Torvalds 已提交
1337
	case IOCB_CMD_FSYNC:
K
Kent Overstreet 已提交
1338 1339 1340 1341
		if (!file->f_op->aio_fsync)
			return -EINVAL;

		ret = file->f_op->aio_fsync(req, 0);
L
Linus Torvalds 已提交
1342
		break;
K
Kent Overstreet 已提交
1343

L
Linus Torvalds 已提交
1344
	default:
K
Kent Overstreet 已提交
1345
		pr_debug("EINVAL: no operation provided\n");
K
Kent Overstreet 已提交
1346
		return -EINVAL;
L
Linus Torvalds 已提交
1347 1348
	}

1349 1350 1351
	if (iovec != &inline_vec)
		kfree(iovec);

K
Kent Overstreet 已提交
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
	if (ret != -EIOCBQUEUED) {
		/*
		 * There's no easy way to restart the syscall since other AIO's
		 * may be already running. Just fail this IO with EINTR.
		 */
		if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
			     ret == -ERESTARTNOHAND ||
			     ret == -ERESTART_RESTARTBLOCK))
			ret = -EINTR;
		aio_complete(req, ret, 0);
	}
L
Linus Torvalds 已提交
1363 1364 1365 1366

	return 0;
}

A
Adrian Bunk 已提交
1367
static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
K
Kent Overstreet 已提交
1368
			 struct iocb *iocb, bool compat)
L
Linus Torvalds 已提交
1369 1370 1371 1372 1373
{
	struct kiocb *req;
	ssize_t ret;

	/* enforce forwards compatibility on users */
1374
	if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
K
Kent Overstreet 已提交
1375
		pr_debug("EINVAL: reserve field set\n");
L
Linus Torvalds 已提交
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
		return -EINVAL;
	}

	/* prevent overflows */
	if (unlikely(
	    (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
	    (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
	    ((ssize_t)iocb->aio_nbytes < 0)
	   )) {
		pr_debug("EINVAL: io_submit: overflow check\n");
		return -EINVAL;
	}

K
Kent Overstreet 已提交
1389
	req = aio_get_req(ctx);
1390
	if (unlikely(!req))
L
Linus Torvalds 已提交
1391
		return -EAGAIN;
1392 1393 1394 1395 1396

	req->ki_filp = fget(iocb->aio_fildes);
	if (unlikely(!req->ki_filp)) {
		ret = -EBADF;
		goto out_put_req;
L
Linus Torvalds 已提交
1397
	}
1398

1399 1400 1401 1402 1403 1404 1405
	if (iocb->aio_flags & IOCB_FLAG_RESFD) {
		/*
		 * 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.
		 */
1406
		req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
1407
		if (IS_ERR(req->ki_eventfd)) {
1408
			ret = PTR_ERR(req->ki_eventfd);
1409
			req->ki_eventfd = NULL;
1410 1411 1412
			goto out_put_req;
		}
	}
L
Linus Torvalds 已提交
1413

K
Kent Overstreet 已提交
1414
	ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
L
Linus Torvalds 已提交
1415
	if (unlikely(ret)) {
K
Kent Overstreet 已提交
1416
		pr_debug("EFAULT: aio_key\n");
L
Linus Torvalds 已提交
1417 1418 1419 1420 1421 1422
		goto out_put_req;
	}

	req->ki_obj.user = user_iocb;
	req->ki_user_data = iocb->aio_data;
	req->ki_pos = iocb->aio_offset;
K
Kent Overstreet 已提交
1423
	req->ki_nbytes = iocb->aio_nbytes;
L
Linus Torvalds 已提交
1424

1425 1426 1427
	ret = aio_run_iocb(req, iocb->aio_lio_opcode,
			   (char __user *)(unsigned long)iocb->aio_buf,
			   compat);
Z
Zach Brown 已提交
1428
	if (ret)
1429
		goto out_put_req;
Z
Zach Brown 已提交
1430

L
Linus Torvalds 已提交
1431 1432
	return 0;
out_put_req:
K
Kent Overstreet 已提交
1433
	put_reqs_available(ctx, 1);
K
Kent Overstreet 已提交
1434
	percpu_ref_put(&ctx->reqs);
K
Kent Overstreet 已提交
1435
	kiocb_free(req);
L
Linus Torvalds 已提交
1436 1437 1438
	return ret;
}

1439 1440
long do_io_submit(aio_context_t ctx_id, long nr,
		  struct iocb __user *__user *iocbpp, bool compat)
L
Linus Torvalds 已提交
1441 1442 1443
{
	struct kioctx *ctx;
	long ret = 0;
J
Jeff Moyer 已提交
1444
	int i = 0;
S
Shaohua Li 已提交
1445
	struct blk_plug plug;
L
Linus Torvalds 已提交
1446 1447 1448 1449

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

1450 1451 1452
	if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
		nr = LONG_MAX/sizeof(*iocbpp);

L
Linus Torvalds 已提交
1453 1454 1455 1456 1457
	if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
		return -EFAULT;

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

S
Shaohua Li 已提交
1462 1463
	blk_start_plug(&plug);

L
Linus Torvalds 已提交
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
	/*
	 * AKPM: should this return a partial result if some of the IOs were
	 * successfully submitted?
	 */
	for (i=0; i<nr; i++) {
		struct iocb __user *user_iocb;
		struct iocb tmp;

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

		if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
			ret = -EFAULT;
			break;
		}

K
Kent Overstreet 已提交
1482
		ret = io_submit_one(ctx, user_iocb, &tmp, compat);
L
Linus Torvalds 已提交
1483 1484 1485
		if (ret)
			break;
	}
S
Shaohua Li 已提交
1486
	blk_finish_plug(&plug);
L
Linus Torvalds 已提交
1487

K
Kent Overstreet 已提交
1488
	percpu_ref_put(&ctx->users);
L
Linus Torvalds 已提交
1489 1490 1491
	return i ? i : ret;
}

1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
/* 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)
{
	return do_io_submit(ctx_id, nr, iocbpp, 0);
}

L
Linus Torvalds 已提交
1510 1511 1512
/* lookup_kiocb
 *	Finds a given iocb for cancellation.
 */
1513 1514
static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
				  u32 key)
L
Linus Torvalds 已提交
1515 1516
{
	struct list_head *pos;
1517 1518 1519

	assert_spin_locked(&ctx->ctx_lock);

K
Kent Overstreet 已提交
1520 1521 1522
	if (key != KIOCB_KEY)
		return NULL;

L
Linus Torvalds 已提交
1523 1524 1525
	/* TODO: use a hash or array, this sucks. */
	list_for_each(pos, &ctx->active_reqs) {
		struct kiocb *kiocb = list_kiocb(pos);
K
Kent Overstreet 已提交
1526
		if (kiocb->ki_obj.user == iocb)
L
Linus Torvalds 已提交
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
			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.
 */
1542 1543
SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
		struct io_event __user *, result)
L
Linus Torvalds 已提交
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
{
	struct kioctx *ctx;
	struct kiocb *kiocb;
	u32 key;
	int ret;

	ret = get_user(key, &iocb->aio_key);
	if (unlikely(ret))
		return -EFAULT;

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

	spin_lock_irq(&ctx->ctx_lock);
K
Kent Overstreet 已提交
1559

L
Linus Torvalds 已提交
1560
	kiocb = lookup_kiocb(ctx, iocb, key);
K
Kent Overstreet 已提交
1561
	if (kiocb)
1562
		ret = kiocb_cancel(ctx, kiocb);
K
Kent Overstreet 已提交
1563 1564 1565
	else
		ret = -EINVAL;

L
Linus Torvalds 已提交
1566 1567
	spin_unlock_irq(&ctx->ctx_lock);

K
Kent Overstreet 已提交
1568
	if (!ret) {
1569 1570 1571 1572
		/*
		 * 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 已提交
1573
		 */
1574
		ret = -EINPROGRESS;
K
Kent Overstreet 已提交
1575
	}
L
Linus Torvalds 已提交
1576

K
Kent Overstreet 已提交
1577
	percpu_ref_put(&ctx->users);
L
Linus Torvalds 已提交
1578 1579 1580 1581 1582 1583

	return ret;
}

/* io_getevents:
 *	Attempts to read at least min_nr events and up to nr events from
1584 1585 1586 1587 1588 1589 1590 1591
 *	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 已提交
1592
 *	timeout is relative.  Will fail with -ENOSYS if not implemented.
L
Linus Torvalds 已提交
1593
 */
1594 1595 1596 1597 1598
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 已提交
1599 1600 1601 1602 1603
{
	struct kioctx *ioctx = lookup_ioctx(ctx_id);
	long ret = -EINVAL;

	if (likely(ioctx)) {
N
Namhyung Kim 已提交
1604
		if (likely(min_nr <= nr && min_nr >= 0))
L
Linus Torvalds 已提交
1605
			ret = read_events(ioctx, min_nr, nr, events, timeout);
K
Kent Overstreet 已提交
1606
		percpu_ref_put(&ioctx->users);
L
Linus Torvalds 已提交
1607 1608 1609
	}
	return ret;
}