aio.c 46.6 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
#include <linux/sched/signal.h>
L
Linus Torvalds 已提交
24 25 26 27
#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

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

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
struct kioctx_table {
71 72 73
	struct rcu_head		rcu;
	unsigned		nr;
	struct kioctx __rcu	*table[];
74 75
};

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

80 81 82 83 84
struct ctx_rq_wait {
	struct completion comp;
	atomic_t count;
};

85
struct kioctx {
K
Kent Overstreet 已提交
86
	struct percpu_ref	users;
K
Kent Overstreet 已提交
87
	atomic_t		dead;
88

K
Kent Overstreet 已提交
89 90
	struct percpu_ref	reqs;

91 92
	unsigned long		user_id;

K
Kent Overstreet 已提交
93 94 95 96 97 98 99
	struct __percpu kioctx_cpu *cpu;

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

K
Kent Overstreet 已提交
109 110
	/* Size of ringbuffer, in units of struct io_event */
	unsigned		nr_events;
111

K
Kent Overstreet 已提交
112 113 114 115 116 117
	unsigned long		mmap_base;
	unsigned long		mmap_size;

	struct page		**ring_pages;
	long			nr_pages;

118
	struct rcu_work		free_rwork;	/* see free_ioctx() */
119

120 121 122
	/*
	 * signals when all in-flight requests are done
	 */
123
	struct ctx_rq_wait	*rq_wait;
124

125
	struct {
126 127 128 129 130
		/*
		 * 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 已提交
131 132
		 *
		 * We batch accesses to it with a percpu version.
133 134
		 */
		atomic_t	reqs_available;
135 136 137 138 139 140 141
	} ____cacheline_aligned_in_smp;

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

K
Kent Overstreet 已提交
142 143
	struct {
		struct mutex	ring_lock;
144 145
		wait_queue_head_t wait;
	} ____cacheline_aligned_in_smp;
K
Kent Overstreet 已提交
146 147 148

	struct {
		unsigned	tail;
149
		unsigned	completed_events;
K
Kent Overstreet 已提交
150
		spinlock_t	completion_lock;
151
	} ____cacheline_aligned_in_smp;
K
Kent Overstreet 已提交
152 153

	struct page		*internal_pages[AIO_RING_PAGES];
154
	struct file		*aio_ring_file;
155 156

	unsigned		id;
157 158
};

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/*
 * We use ki_cancel == KIOCB_CANCELLED to indicate that a kiocb has been either
 * cancelled or completed (this makes a certain amount of sense because
 * successful cancellation - io_cancel() - does deliver the completion to
 * userspace).
 *
 * And since most things don't implement kiocb cancellation and we'd really like
 * kiocb completion to be lockless when possible, we use ki_cancel to
 * synchronize cancellation and completion - we only set it to KIOCB_CANCELLED
 * with xchg() or cmpxchg(), see batch_complete_aio() and kiocb_cancel().
 */
#define KIOCB_CANCELLED		((void *) (~0ULL))

struct aio_kiocb {
	struct kiocb		common;

	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 已提交
191
/*------ sysctl variables----*/
192 193 194
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 已提交
195 196
/*----end sysctl variables---*/

197 198
static struct kmem_cache	*kiocb_cachep;
static struct kmem_cache	*kioctx_cachep;
L
Linus Torvalds 已提交
199

200 201 202 203 204 205 206 207 208 209 210
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);
211 212
	if (IS_ERR(inode))
		return ERR_CAST(inode);
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

	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 已提交
242 243 244 245 246 247
	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;
248 249
}

L
Linus Torvalds 已提交
250 251 252 253 254 255
/* 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)
{
256 257 258 259 260 261 262 263 264
	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.");

265
	kiocb_cachep = KMEM_CACHE(aio_kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
266
	kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
L
Linus Torvalds 已提交
267 268
	return 0;
}
269
__initcall(aio_setup);
L
Linus Torvalds 已提交
270

271 272 273
static void put_aio_ring_file(struct kioctx *ctx)
{
	struct file *aio_ring_file = ctx->aio_ring_file;
274 275
	struct address_space *i_mapping;

276
	if (aio_ring_file) {
A
Al Viro 已提交
277
		truncate_setsize(file_inode(aio_ring_file), 0);
278 279

		/* Prevent further access to the kioctx from migratepages */
A
Al Viro 已提交
280
		i_mapping = aio_ring_file->f_mapping;
281 282
		spin_lock(&i_mapping->private_lock);
		i_mapping->private_data = NULL;
283
		ctx->aio_ring_file = NULL;
284
		spin_unlock(&i_mapping->private_lock);
285 286 287 288 289

		fput(aio_ring_file);
	}
}

L
Linus Torvalds 已提交
290 291
static void aio_free_ring(struct kioctx *ctx)
{
292
	int i;
L
Linus Torvalds 已提交
293

294 295 296 297 298
	/* Disconnect the kiotx from the ring file.  This prevents future
	 * accesses to the kioctx from page migration.
	 */
	put_aio_ring_file(ctx);

299
	for (i = 0; i < ctx->nr_pages; i++) {
300
		struct page *page;
301 302
		pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
				page_count(ctx->ring_pages[i]));
303 304 305 306 307
		page = ctx->ring_pages[i];
		if (!page)
			continue;
		ctx->ring_pages[i] = NULL;
		put_page(page);
308
	}
L
Linus Torvalds 已提交
309

310
	if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
K
Kent Overstreet 已提交
311
		kfree(ctx->ring_pages);
312 313
		ctx->ring_pages = NULL;
	}
314 315
}

316
static int aio_ring_mremap(struct vm_area_struct *vma)
317
{
318
	struct file *file = vma->vm_file;
319 320
	struct mm_struct *mm = vma->vm_mm;
	struct kioctx_table *table;
A
Al Viro 已提交
321
	int i, res = -EINVAL;
322 323 324 325 326 327 328

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

329
		ctx = rcu_dereference(table->table[i]);
330
		if (ctx && ctx->aio_ring_file == file) {
A
Al Viro 已提交
331 332 333 334
			if (!atomic_read(&ctx->dead)) {
				ctx->user_id = ctx->mmap_base = vma->vm_start;
				res = 0;
			}
335 336 337 338 339 340
			break;
		}
	}

	rcu_read_unlock();
	spin_unlock(&mm->ioctx_lock);
A
Al Viro 已提交
341
	return res;
342 343
}

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
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;
}

360 361 362 363
static const struct file_operations aio_ring_fops = {
	.mmap = aio_ring_mmap,
};

364
#if IS_ENABLED(CONFIG_MIGRATION)
365 366 367
static int aio_migratepage(struct address_space *mapping, struct page *new,
			struct page *old, enum migrate_mode mode)
{
368
	struct kioctx *ctx;
369
	unsigned long flags;
370
	pgoff_t idx;
371 372
	int rc;

373 374 375 376 377 378 379 380
	/*
	 * 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;

381 382
	rc = 0;

383
	/* mapping->private_lock here protects against the kioctx teardown.  */
384 385
	spin_lock(&mapping->private_lock);
	ctx = mapping->private_data;
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
	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;
405 406 407 408
	} else
		rc = -EINVAL;

	if (rc != 0)
409
		goto out_unlock;
410

411 412
	/* Writeback must be complete */
	BUG_ON(PageWriteback(old));
413
	get_page(new);
414

415
	rc = migrate_page_move_mapping(mapping, new, old, NULL, mode, 1);
416
	if (rc != MIGRATEPAGE_SUCCESS) {
417
		put_page(new);
418
		goto out_unlock;
419 420
	}

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

431 432
	/* The old page is no longer accessible. */
	put_page(old);
433

434 435 436 437
out_unlock:
	mutex_unlock(&ctx->ring_lock);
out:
	spin_unlock(&mapping->private_lock);
438
	return rc;
L
Linus Torvalds 已提交
439
}
440
#endif
L
Linus Torvalds 已提交
441

442
static const struct address_space_operations aio_ctx_aops = {
443
	.set_page_dirty = __set_page_dirty_no_writeback,
444
#if IS_ENABLED(CONFIG_MIGRATION)
445
	.migratepage	= aio_migratepage,
446
#endif
447 448
};

449
static int aio_setup_ring(struct kioctx *ctx, unsigned int nr_events)
L
Linus Torvalds 已提交
450 451
{
	struct aio_ring *ring;
Z
Zach Brown 已提交
452
	struct mm_struct *mm = current->mm;
453
	unsigned long size, unused;
L
Linus Torvalds 已提交
454
	int nr_pages;
455 456
	int i;
	struct file *file;
L
Linus Torvalds 已提交
457 458 459 460 461 462 463

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

464
	nr_pages = PFN_UP(size);
L
Linus Torvalds 已提交
465 466 467
	if (nr_pages < 0)
		return -EINVAL;

468
	file = aio_private_file(ctx, nr_pages);
469 470
	if (IS_ERR(file)) {
		ctx->aio_ring_file = NULL;
471
		return -ENOMEM;
472 473
	}

474 475 476 477 478 479 480 481 482 483 484 485 486 487
	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;
		}
	}

488 489
	for (i = 0; i < nr_pages; i++) {
		struct page *page;
A
Al Viro 已提交
490
		page = find_or_create_page(file->f_mapping,
491 492 493 494 495 496 497
					   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);
498 499

		ctx->ring_pages[i] = page;
500
	}
501
	ctx->nr_pages = i;
L
Linus Torvalds 已提交
502

503 504
	if (unlikely(i != nr_pages)) {
		aio_free_ring(ctx);
505
		return -ENOMEM;
L
Linus Torvalds 已提交
506 507
	}

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

M
Michal Hocko 已提交
511 512 513 514 515 516
	if (down_write_killable(&mm->mmap_sem)) {
		ctx->mmap_size = 0;
		aio_free_ring(ctx);
		return -EINTR;
	}

517 518
	ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
				       PROT_READ | PROT_WRITE,
519
				       MAP_SHARED, 0, &unused, NULL);
520
	up_write(&mm->mmap_sem);
K
Kent Overstreet 已提交
521 522
	if (IS_ERR((void *)ctx->mmap_base)) {
		ctx->mmap_size = 0;
L
Linus Torvalds 已提交
523
		aio_free_ring(ctx);
524
		return -ENOMEM;
L
Linus Torvalds 已提交
525 526
	}

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

K
Kent Overstreet 已提交
529 530
	ctx->user_id = ctx->mmap_base;
	ctx->nr_events = nr_events; /* trusted copy */
L
Linus Torvalds 已提交
531

K
Kent Overstreet 已提交
532
	ring = kmap_atomic(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
533
	ring->nr = nr_events;	/* user copy */
534
	ring->id = ~0U;
L
Linus Torvalds 已提交
535 536 537 538 539
	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);
540
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
541
	flush_dcache_page(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
542 543 544 545 546 547 548 549

	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)

550
void kiocb_set_cancel_fn(struct kiocb *iocb, kiocb_cancel_fn *cancel)
551
{
552
	struct aio_kiocb *req = container_of(iocb, struct aio_kiocb, common);
553 554 555 556 557 558 559 560 561 562 563 564 565 566
	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);

567
static int kiocb_cancel(struct aio_kiocb *kiocb)
K
Kent Overstreet 已提交
568
{
569
	kiocb_cancel_fn *old, *cancel;
K
Kent Overstreet 已提交
570

571 572 573 574 575
	/*
	 * Don't want to set kiocb->ki_cancel = KIOCB_CANCELLED unless it
	 * actually has a cancel function, hence the cmpxchg()
	 */

576
	cancel = READ_ONCE(kiocb->ki_cancel);
577 578
	do {
		if (!cancel || cancel == KIOCB_CANCELLED)
K
Kent Overstreet 已提交
579
			return -EINVAL;
K
Kent Overstreet 已提交
580

581 582 583
		old = cancel;
		cancel = cmpxchg(&kiocb->ki_cancel, old, KIOCB_CANCELLED);
	} while (cancel != old);
K
Kent Overstreet 已提交
584

585
	return cancel(&kiocb->common);
K
Kent Overstreet 已提交
586 587
}

588 589 590
/*
 * free_ioctx() should be RCU delayed to synchronize against the RCU
 * protected lookup_ioctx() and also needs process context to call
591
 * aio_free_ring().  Use rcu_work.
592
 */
K
Kent Overstreet 已提交
593
static void free_ioctx(struct work_struct *work)
K
Kent Overstreet 已提交
594
{
595 596
	struct kioctx *ctx = container_of(to_rcu_work(work), struct kioctx,
					  free_rwork);
K
Kent Overstreet 已提交
597
	pr_debug("freeing %p\n", ctx);
K
Kent Overstreet 已提交
598

K
Kent Overstreet 已提交
599
	aio_free_ring(ctx);
K
Kent Overstreet 已提交
600
	free_percpu(ctx->cpu);
601 602
	percpu_ref_exit(&ctx->reqs);
	percpu_ref_exit(&ctx->users);
K
Kent Overstreet 已提交
603 604 605
	kmem_cache_free(kioctx_cachep, ctx);
}

K
Kent Overstreet 已提交
606 607 608 609
static void free_ioctx_reqs(struct percpu_ref *ref)
{
	struct kioctx *ctx = container_of(ref, struct kioctx, reqs);

610
	/* At this point we know that there are no any in-flight requests */
611 612
	if (ctx->rq_wait && atomic_dec_and_test(&ctx->rq_wait->count))
		complete(&ctx->rq_wait->comp);
613

614
	/* Synchronize against RCU protected table->table[] dereferences */
615 616
	INIT_RCU_WORK(&ctx->free_rwork, free_ioctx);
	queue_rcu_work(system_wq, &ctx->free_rwork);
K
Kent Overstreet 已提交
617 618
}

K
Kent Overstreet 已提交
619 620 621 622 623
/*
 * 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 已提交
624
static void free_ioctx_users(struct percpu_ref *ref)
K
Kent Overstreet 已提交
625
{
K
Kent Overstreet 已提交
626
	struct kioctx *ctx = container_of(ref, struct kioctx, users);
627
	struct aio_kiocb *req;
K
Kent Overstreet 已提交
628 629 630 631 632

	spin_lock_irq(&ctx->ctx_lock);

	while (!list_empty(&ctx->active_reqs)) {
		req = list_first_entry(&ctx->active_reqs,
633
				       struct aio_kiocb, ki_list);
K
Kent Overstreet 已提交
634 635

		list_del_init(&req->ki_list);
636
		kiocb_cancel(req);
K
Kent Overstreet 已提交
637 638 639 640
	}

	spin_unlock_irq(&ctx->ctx_lock);

K
Kent Overstreet 已提交
641 642
	percpu_ref_kill(&ctx->reqs);
	percpu_ref_put(&ctx->reqs);
K
Kent Overstreet 已提交
643 644
}

645 646 647 648 649 650 651
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);
652
	table = rcu_dereference_raw(mm->ioctx_table);
653 654 655 656

	while (1) {
		if (table)
			for (i = 0; i < table->nr; i++)
657
				if (!rcu_access_pointer(table->table[i])) {
658
					ctx->id = i;
659
					rcu_assign_pointer(table->table[i], ctx);
660 661
					spin_unlock(&mm->ioctx_lock);

662 663 664 665
					/* While kioctx setup is in progress,
					 * we are protected from page migration
					 * changes ring_pages by ->ring_lock.
					 */
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
					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);
683
		old = rcu_dereference_raw(mm->ioctx_table);
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699

		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 已提交
700 701 702 703 704 705 706 707 708 709
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 已提交
710 711 712 713 714
/* 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 已提交
715
	struct mm_struct *mm = current->mm;
L
Linus Torvalds 已提交
716
	struct kioctx *ctx;
717
	int err = -ENOMEM;
L
Linus Torvalds 已提交
718

719 720 721 722 723 724
	/*
	 * 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 已提交
725 726 727 728 729 730 731 732 733 734 735 736
	/*
	 * 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 已提交
737
	/* Prevent overflows */
A
Al Viro 已提交
738
	if (nr_events > (0x10000000U / sizeof(struct io_event))) {
L
Linus Torvalds 已提交
739 740 741 742
		pr_debug("ENOMEM: nr_events too high\n");
		return ERR_PTR(-EINVAL);
	}

743
	if (!nr_events || (unsigned long)max_reqs > aio_max_nr)
L
Linus Torvalds 已提交
744 745
		return ERR_PTR(-EAGAIN);

746
	ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
747 748 749
	if (!ctx)
		return ERR_PTR(-ENOMEM);

750
	ctx->max_reqs = max_reqs;
L
Linus Torvalds 已提交
751 752

	spin_lock_init(&ctx->ctx_lock);
753
	spin_lock_init(&ctx->completion_lock);
K
Kent Overstreet 已提交
754
	mutex_init(&ctx->ring_lock);
755 756 757
	/* 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 已提交
758 759 760 761
	init_waitqueue_head(&ctx->wait);

	INIT_LIST_HEAD(&ctx->active_reqs);

762
	if (percpu_ref_init(&ctx->users, free_ioctx_users, 0, GFP_KERNEL))
763 764
		goto err;

765
	if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs, 0, GFP_KERNEL))
766 767
		goto err;

K
Kent Overstreet 已提交
768 769
	ctx->cpu = alloc_percpu(struct kioctx_cpu);
	if (!ctx->cpu)
K
Kent Overstreet 已提交
770
		goto err;
L
Linus Torvalds 已提交
771

772
	err = aio_setup_ring(ctx, nr_events);
773
	if (err < 0)
K
Kent Overstreet 已提交
774
		goto err;
K
Kent Overstreet 已提交
775

776
	atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
K
Kent Overstreet 已提交
777
	ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
778 779
	if (ctx->req_batch < 1)
		ctx->req_batch = 1;
780

L
Linus Torvalds 已提交
781
	/* limit the number of system wide aios */
782
	spin_lock(&aio_nr_lock);
783 784
	if (aio_nr + ctx->max_reqs > aio_max_nr ||
	    aio_nr + ctx->max_reqs < aio_nr) {
785
		spin_unlock(&aio_nr_lock);
K
Kent Overstreet 已提交
786
		err = -EAGAIN;
G
Gu Zheng 已提交
787
		goto err_ctx;
788 789
	}
	aio_nr += ctx->max_reqs;
790
	spin_unlock(&aio_nr_lock);
L
Linus Torvalds 已提交
791

792 793
	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 已提交
794

795 796
	err = ioctx_add_table(ctx, mm);
	if (err)
K
Kent Overstreet 已提交
797
		goto err_cleanup;
798

799 800 801
	/* Release the ring_lock mutex now that all setup is complete. */
	mutex_unlock(&ctx->ring_lock);

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

K
Kent Overstreet 已提交
806 807
err_cleanup:
	aio_nr_sub(ctx->max_reqs);
G
Gu Zheng 已提交
808
err_ctx:
809 810 811
	atomic_set(&ctx->dead, 1);
	if (ctx->mmap_size)
		vm_munmap(ctx->mmap_base, ctx->mmap_size);
G
Gu Zheng 已提交
812
	aio_free_ring(ctx);
K
Kent Overstreet 已提交
813
err:
814
	mutex_unlock(&ctx->ring_lock);
K
Kent Overstreet 已提交
815
	free_percpu(ctx->cpu);
816 817
	percpu_ref_exit(&ctx->reqs);
	percpu_ref_exit(&ctx->users);
L
Linus Torvalds 已提交
818
	kmem_cache_free(kioctx_cachep, ctx);
K
Kent Overstreet 已提交
819
	pr_debug("error allocating ioctx %d\n", err);
820
	return ERR_PTR(err);
L
Linus Torvalds 已提交
821 822
}

K
Kent Overstreet 已提交
823 824 825 826 827
/* 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.
 */
828
static int kill_ioctx(struct mm_struct *mm, struct kioctx *ctx,
829
		      struct ctx_rq_wait *wait)
K
Kent Overstreet 已提交
830
{
831
	struct kioctx_table *table;
832

A
Al Viro 已提交
833 834 835
	spin_lock(&mm->ioctx_lock);
	if (atomic_xchg(&ctx->dead, 1)) {
		spin_unlock(&mm->ioctx_lock);
836
		return -EINVAL;
A
Al Viro 已提交
837
	}
838

839
	table = rcu_dereference_raw(mm->ioctx_table);
840 841
	WARN_ON(ctx != rcu_access_pointer(table->table[ctx->id]));
	RCU_INIT_POINTER(table->table[ctx->id], NULL);
842
	spin_unlock(&mm->ioctx_lock);
843

844
	/* free_ioctx_reqs() will do the necessary RCU synchronization */
845
	wake_up_all(&ctx->wait);
846

847 848 849 850 851 852 853 854
	/*
	 * 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);
855

856 857
	if (ctx->mmap_size)
		vm_munmap(ctx->mmap_base, ctx->mmap_size);
858

859
	ctx->rq_wait = wait;
860 861
	percpu_ref_kill(&ctx->users);
	return 0;
L
Linus Torvalds 已提交
862 863
}

K
Kent Overstreet 已提交
864 865 866 867 868 869 870
/*
 * 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 已提交
871
 */
872
void exit_aio(struct mm_struct *mm)
L
Linus Torvalds 已提交
873
{
874
	struct kioctx_table *table = rcu_dereference_raw(mm->ioctx_table);
875 876
	struct ctx_rq_wait wait;
	int i, skipped;
877

878 879
	if (!table)
		return;
880

881 882 883 884
	atomic_set(&wait.count, table->nr);
	init_completion(&wait.comp);

	skipped = 0;
885
	for (i = 0; i < table->nr; ++i) {
886 887
		struct kioctx *ctx =
			rcu_dereference_protected(table->table[i], true);
J
Jens Axboe 已提交
888

889 890
		if (!ctx) {
			skipped++;
891
			continue;
892 893
		}

894
		/*
895 896 897 898 899
		 * 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.
900
		 */
K
Kent Overstreet 已提交
901
		ctx->mmap_size = 0;
902 903
		kill_ioctx(mm, ctx, &wait);
	}
K
Kent Overstreet 已提交
904

905
	if (!atomic_sub_and_test(skipped, &wait.count)) {
906
		/* Wait until all IO for the context are done. */
907
		wait_for_completion(&wait.comp);
L
Linus Torvalds 已提交
908
	}
909 910 911

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

K
Kent Overstreet 已提交
914 915 916
static void put_reqs_available(struct kioctx *ctx, unsigned nr)
{
	struct kioctx_cpu *kcpu;
917
	unsigned long flags;
K
Kent Overstreet 已提交
918

919
	local_irq_save(flags);
920
	kcpu = this_cpu_ptr(ctx->cpu);
K
Kent Overstreet 已提交
921
	kcpu->reqs_available += nr;
922

K
Kent Overstreet 已提交
923 924 925 926 927
	while (kcpu->reqs_available >= ctx->req_batch * 2) {
		kcpu->reqs_available -= ctx->req_batch;
		atomic_add(ctx->req_batch, &ctx->reqs_available);
	}

928
	local_irq_restore(flags);
K
Kent Overstreet 已提交
929 930 931 932 933 934
}

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

937
	local_irq_save(flags);
938
	kcpu = this_cpu_ptr(ctx->cpu);
K
Kent Overstreet 已提交
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
	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:
957
	local_irq_restore(flags);
K
Kent Overstreet 已提交
958 959 960
	return ret;
}

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 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
/* 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 已提交
1023
/* aio_get_req
K
Kent Overstreet 已提交
1024 1025
 *	Allocate a slot for an aio request.
 * Returns NULL if no requests are free.
L
Linus Torvalds 已提交
1026
 */
1027
static inline struct aio_kiocb *aio_get_req(struct kioctx *ctx)
L
Linus Torvalds 已提交
1028
{
1029
	struct aio_kiocb *req;
K
Kent Overstreet 已提交
1030

1031 1032 1033 1034 1035
	if (!get_reqs_available(ctx)) {
		user_refill_reqs_available(ctx);
		if (!get_reqs_available(ctx))
			return NULL;
	}
K
Kent Overstreet 已提交
1036

1037
	req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
L
Linus Torvalds 已提交
1038
	if (unlikely(!req))
K
Kent Overstreet 已提交
1039
		goto out_put;
L
Linus Torvalds 已提交
1040

K
Kent Overstreet 已提交
1041 1042
	percpu_ref_get(&ctx->reqs);

L
Linus Torvalds 已提交
1043
	req->ki_ctx = ctx;
J
Jeff Moyer 已提交
1044
	return req;
K
Kent Overstreet 已提交
1045
out_put:
K
Kent Overstreet 已提交
1046
	put_reqs_available(ctx, 1);
K
Kent Overstreet 已提交
1047
	return NULL;
L
Linus Torvalds 已提交
1048 1049
}

1050
static void kiocb_free(struct aio_kiocb *req)
L
Linus Torvalds 已提交
1051
{
1052 1053
	if (req->common.ki_filp)
		fput(req->common.ki_filp);
1054 1055
	if (req->ki_eventfd != NULL)
		eventfd_ctx_put(req->ki_eventfd);
L
Linus Torvalds 已提交
1056 1057 1058
	kmem_cache_free(kiocb_cachep, req);
}

A
Adrian Bunk 已提交
1059
static struct kioctx *lookup_ioctx(unsigned long ctx_id)
L
Linus Torvalds 已提交
1060
{
1061
	struct aio_ring __user *ring  = (void __user *)ctx_id;
J
Jens Axboe 已提交
1062
	struct mm_struct *mm = current->mm;
1063
	struct kioctx *ctx, *ret = NULL;
1064 1065 1066 1067 1068
	struct kioctx_table *table;
	unsigned id;

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

J
Jens Axboe 已提交
1070
	rcu_read_lock();
1071
	table = rcu_dereference(mm->ioctx_table);
J
Jens Axboe 已提交
1072

1073 1074
	if (!table || id >= table->nr)
		goto out;
L
Linus Torvalds 已提交
1075

1076
	ctx = rcu_dereference(table->table[id]);
1077
	if (ctx && ctx->user_id == ctx_id) {
1078 1079 1080 1081
		percpu_ref_get(&ctx->users);
		ret = ctx;
	}
out:
J
Jens Axboe 已提交
1082
	rcu_read_unlock();
1083
	return ret;
L
Linus Torvalds 已提交
1084 1085 1086 1087 1088
}

/* aio_complete
 *	Called when the io request on the given iocb is complete.
 */
1089
static void aio_complete(struct kiocb *kiocb, long res, long res2)
L
Linus Torvalds 已提交
1090
{
1091
	struct aio_kiocb *iocb = container_of(kiocb, struct aio_kiocb, common);
L
Linus Torvalds 已提交
1092 1093
	struct kioctx	*ctx = iocb->ki_ctx;
	struct aio_ring	*ring;
K
Kent Overstreet 已提交
1094
	struct io_event	*ev_page, *event;
1095
	unsigned tail, pos, head;
L
Linus Torvalds 已提交
1096 1097
	unsigned long	flags;

1098 1099 1100 1101 1102 1103 1104
	if (kiocb->ki_flags & IOCB_WRITE) {
		struct file *file = kiocb->ki_filp;

		/*
		 * Tell lockdep we inherited freeze protection from submission
		 * thread.
		 */
S
Shaohua Li 已提交
1105 1106
		if (S_ISREG(file_inode(file)->i_mode))
			__sb_writers_acquired(file_inode(file)->i_sb, SB_FREEZE_WRITE);
1107 1108 1109
		file_end_write(file);
	}

1110 1111 1112 1113 1114 1115 1116
	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);
	}
1117

1118 1119
	/*
	 * Add a completion event to the ring buffer. Must be done holding
1120
	 * ctx->completion_lock to prevent other code from messing with the tail
1121 1122 1123 1124
	 * pointer since we might be called from irq context.
	 */
	spin_lock_irqsave(&ctx->completion_lock, flags);

K
Kent Overstreet 已提交
1125
	tail = ctx->tail;
K
Kent Overstreet 已提交
1126 1127
	pos = tail + AIO_EVENTS_OFFSET;

K
Kent Overstreet 已提交
1128
	if (++tail >= ctx->nr_events)
1129
		tail = 0;
L
Linus Torvalds 已提交
1130

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

1134
	event->obj = (u64)(unsigned long)iocb->ki_user_iocb;
L
Linus Torvalds 已提交
1135 1136 1137 1138
	event->data = iocb->ki_user_data;
	event->res = res;
	event->res2 = res2;

K
Kent Overstreet 已提交
1139
	kunmap_atomic(ev_page);
K
Kent Overstreet 已提交
1140
	flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
K
Kent Overstreet 已提交
1141 1142

	pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
1143
		 ctx, tail, iocb, iocb->ki_user_iocb, iocb->ki_user_data,
K
Kent Overstreet 已提交
1144
		 res, res2);
L
Linus Torvalds 已提交
1145 1146 1147 1148 1149 1150

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

K
Kent Overstreet 已提交
1153
	ring = kmap_atomic(ctx->ring_pages[0]);
1154
	head = ring->head;
K
Kent Overstreet 已提交
1155
	ring->tail = tail;
1156
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
1157
	flush_dcache_page(ctx->ring_pages[0]);
L
Linus Torvalds 已提交
1158

1159 1160 1161
	ctx->completed_events++;
	if (ctx->completed_events > 1)
		refill_reqs_available(ctx, head, tail);
1162 1163
	spin_unlock_irqrestore(&ctx->completion_lock, flags);

K
Kent Overstreet 已提交
1164
	pr_debug("added to ring %p at [%u]\n", iocb, tail);
D
Davide Libenzi 已提交
1165 1166 1167 1168 1169 1170

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

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

1177 1178 1179 1180 1181 1182 1183 1184
	/*
	 * 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 已提交
1185 1186 1187
	if (waitqueue_active(&ctx->wait))
		wake_up(&ctx->wait);

K
Kent Overstreet 已提交
1188
	percpu_ref_put(&ctx->reqs);
L
Linus Torvalds 已提交
1189 1190
}

G
Gu Zheng 已提交
1191
/* aio_read_events_ring
1192 1193
 *	Pull an event off of the ioctx's event ring.  Returns the number of
 *	events fetched
L
Linus Torvalds 已提交
1194
 */
1195 1196
static long aio_read_events_ring(struct kioctx *ctx,
				 struct io_event __user *event, long nr)
L
Linus Torvalds 已提交
1197 1198
{
	struct aio_ring *ring;
1199
	unsigned head, tail, pos;
1200 1201 1202
	long ret = 0;
	int copy_ret;

1203 1204 1205 1206 1207 1208 1209
	/*
	 * 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 已提交
1210
	mutex_lock(&ctx->ring_lock);
L
Linus Torvalds 已提交
1211

1212
	/* Access to ->ring_pages here is protected by ctx->ring_lock. */
K
Kent Overstreet 已提交
1213
	ring = kmap_atomic(ctx->ring_pages[0]);
1214
	head = ring->head;
1215
	tail = ring->tail;
1216 1217
	kunmap_atomic(ring);

1218 1219 1220 1221 1222 1223
	/*
	 * 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();

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

1226
	if (head == tail)
L
Linus Torvalds 已提交
1227 1228
		goto out;

1229 1230 1231
	head %= ctx->nr_events;
	tail %= ctx->nr_events;

1232 1233 1234 1235 1236
	while (ret < nr) {
		long avail;
		struct io_event *ev;
		struct page *page;

1237 1238
		avail = (head <= tail ?  tail : ctx->nr_events) - head;
		if (head == tail)
1239 1240 1241 1242 1243 1244 1245
			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 已提交
1246
		page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
		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 已提交
1261
		head %= ctx->nr_events;
L
Linus Torvalds 已提交
1262 1263
	}

K
Kent Overstreet 已提交
1264
	ring = kmap_atomic(ctx->ring_pages[0]);
1265
	ring->head = head;
1266
	kunmap_atomic(ring);
K
Kent Overstreet 已提交
1267
	flush_dcache_page(ctx->ring_pages[0]);
1268

1269
	pr_debug("%li  h%u t%u\n", ret, head, tail);
1270
out:
K
Kent Overstreet 已提交
1271
	mutex_unlock(&ctx->ring_lock);
1272

L
Linus Torvalds 已提交
1273 1274 1275
	return ret;
}

1276 1277
static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
			    struct io_event __user *event, long *i)
L
Linus Torvalds 已提交
1278
{
1279
	long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
L
Linus Torvalds 已提交
1280

1281 1282
	if (ret > 0)
		*i += ret;
L
Linus Torvalds 已提交
1283

1284 1285
	if (unlikely(atomic_read(&ctx->dead)))
		ret = -EINVAL;
L
Linus Torvalds 已提交
1286

1287 1288
	if (!*i)
		*i = ret;
L
Linus Torvalds 已提交
1289

1290
	return ret < 0 || *i >= min_nr;
L
Linus Torvalds 已提交
1291 1292
}

1293
static long read_events(struct kioctx *ctx, long min_nr, long nr,
L
Linus Torvalds 已提交
1294
			struct io_event __user *event,
1295
			ktime_t until)
L
Linus Torvalds 已提交
1296
{
1297
	long ret = 0;
L
Linus Torvalds 已提交
1298

1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
	/*
	 * 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 已提交
1313
	if (until == 0)
1314 1315 1316 1317 1318
		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);
L
Linus Torvalds 已提交
1319

1320 1321
	if (!ret && signal_pending(current))
		ret = -EINTR;
L
Linus Torvalds 已提交
1322

1323
	return ret;
L
Linus Torvalds 已提交
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
}

/* 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.
 */
1339
SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
L
Linus Torvalds 已提交
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
{
	struct kioctx *ioctx = NULL;
	unsigned long ctx;
	long ret;

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

	ret = -EINVAL;
1350
	if (unlikely(ctx || nr_events == 0)) {
1351
		pr_debug("EINVAL: ctx %lu nr_events %u\n",
1352
		         ctx, nr_events);
L
Linus Torvalds 已提交
1353 1354 1355 1356 1357 1358 1359
		goto out;
	}

	ioctx = ioctx_alloc(nr_events);
	ret = PTR_ERR(ioctx);
	if (!IS_ERR(ioctx)) {
		ret = put_user(ioctx->user_id, ctxp);
1360
		if (ret)
1361
			kill_ioctx(current->mm, ioctx, NULL);
K
Kent Overstreet 已提交
1362
		percpu_ref_put(&ioctx->users);
L
Linus Torvalds 已提交
1363 1364 1365 1366 1367 1368
	}

out:
	return ret;
}

A
Al Viro 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
#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 已提交
1402 1403 1404
/* sys_io_destroy:
 *	Destroy the aio_context specified.  May cancel any outstanding 
 *	AIOs and block on completion.  Will fail with -ENOSYS if not
1405
 *	implemented.  May fail with -EINVAL if the context pointed to
L
Linus Torvalds 已提交
1406 1407
 *	is invalid.
 */
1408
SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
L
Linus Torvalds 已提交
1409 1410 1411
{
	struct kioctx *ioctx = lookup_ioctx(ctx);
	if (likely(NULL != ioctx)) {
1412
		struct ctx_rq_wait wait;
1413
		int ret;
1414

1415 1416 1417
		init_completion(&wait.comp);
		atomic_set(&wait.count, 1);

1418 1419 1420 1421
		/* 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.
		 */
1422
		ret = kill_ioctx(current->mm, ioctx, &wait);
K
Kent Overstreet 已提交
1423
		percpu_ref_put(&ioctx->users);
1424 1425 1426 1427 1428

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

1432
		return ret;
L
Linus Torvalds 已提交
1433
	}
1434
	pr_debug("EINVAL: invalid context id\n");
L
Linus Torvalds 已提交
1435 1436 1437
	return -EINVAL;
}

C
Christoph Hellwig 已提交
1438 1439
static int aio_setup_rw(int rw, struct iocb *iocb, struct iovec **iovec,
		bool vectored, bool compat, struct iov_iter *iter)
B
Badari Pulavarty 已提交
1440
{
C
Christoph Hellwig 已提交
1441 1442 1443 1444 1445 1446 1447 1448
	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;
	}
1449 1450
#ifdef CONFIG_COMPAT
	if (compat)
C
Christoph Hellwig 已提交
1451 1452
		return compat_import_iovec(rw, buf, len, UIO_FASTIOV, iovec,
				iter);
1453
#endif
C
Christoph Hellwig 已提交
1454
	return import_iovec(rw, buf, len, UIO_FASTIOV, iovec, iter);
B
Badari Pulavarty 已提交
1455 1456
}

C
Christoph Hellwig 已提交
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
static inline ssize_t aio_ret(struct kiocb *req, ssize_t ret)
{
	switch (ret) {
	case -EIOCBQUEUED:
		return ret;
	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:
		aio_complete(req, ret, 0);
		return 0;
	}
}

static ssize_t aio_read(struct kiocb *req, struct iocb *iocb, bool vectored,
		bool compat)
L
Linus Torvalds 已提交
1480
{
K
Kent Overstreet 已提交
1481
	struct file *file = req->ki_filp;
1482
	struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1483
	struct iov_iter iter;
C
Christoph Hellwig 已提交
1484
	ssize_t ret;
L
Linus Torvalds 已提交
1485

C
Christoph Hellwig 已提交
1486 1487 1488 1489
	if (unlikely(!(file->f_mode & FMODE_READ)))
		return -EBADF;
	if (unlikely(!file->f_op->read_iter))
		return -EINVAL;
K
Kent Overstreet 已提交
1490

C
Christoph Hellwig 已提交
1491 1492 1493 1494 1495
	ret = aio_setup_rw(READ, iocb, &iovec, vectored, compat, &iter);
	if (ret)
		return ret;
	ret = rw_verify_area(READ, file, &req->ki_pos, iov_iter_count(&iter));
	if (!ret)
1496
		ret = aio_ret(req, call_read_iter(file, req, &iter));
C
Christoph Hellwig 已提交
1497 1498 1499
	kfree(iovec);
	return ret;
}
K
Kent Overstreet 已提交
1500

C
Christoph Hellwig 已提交
1501 1502 1503 1504 1505 1506 1507
static ssize_t aio_write(struct kiocb *req, struct iocb *iocb, bool vectored,
		bool compat)
{
	struct file *file = req->ki_filp;
	struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
	struct iov_iter iter;
	ssize_t ret;
K
Kent Overstreet 已提交
1508

C
Christoph Hellwig 已提交
1509 1510 1511
	if (unlikely(!(file->f_mode & FMODE_WRITE)))
		return -EBADF;
	if (unlikely(!file->f_op->write_iter))
K
Kent Overstreet 已提交
1512
		return -EINVAL;
L
Linus Torvalds 已提交
1513

C
Christoph Hellwig 已提交
1514 1515 1516 1517 1518
	ret = aio_setup_rw(WRITE, iocb, &iovec, vectored, compat, &iter);
	if (ret)
		return ret;
	ret = rw_verify_area(WRITE, file, &req->ki_pos, iov_iter_count(&iter));
	if (!ret) {
1519
		req->ki_flags |= IOCB_WRITE;
C
Christoph Hellwig 已提交
1520
		file_start_write(file);
1521
		ret = aio_ret(req, call_write_iter(file, req, &iter));
1522 1523 1524 1525 1526
		/*
		 * We release freeze protection in aio_complete().  Fool lockdep
		 * by telling it the lock got released so that it doesn't
		 * complain about held lock when we return to userspace.
		 */
S
Shaohua Li 已提交
1527 1528
		if (S_ISREG(file_inode(file)->i_mode))
			__sb_writers_release(file_inode(file)->i_sb, SB_FREEZE_WRITE);
K
Kent Overstreet 已提交
1529
	}
C
Christoph Hellwig 已提交
1530 1531
	kfree(iovec);
	return ret;
L
Linus Torvalds 已提交
1532 1533
}

A
Adrian Bunk 已提交
1534
static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
K
Kent Overstreet 已提交
1535
			 struct iocb *iocb, bool compat)
L
Linus Torvalds 已提交
1536
{
1537
	struct aio_kiocb *req;
C
Christoph Hellwig 已提交
1538
	struct file *file;
L
Linus Torvalds 已提交
1539 1540 1541
	ssize_t ret;

	/* enforce forwards compatibility on users */
1542
	if (unlikely(iocb->aio_reserved2)) {
K
Kent Overstreet 已提交
1543
		pr_debug("EINVAL: reserve field set\n");
L
Linus Torvalds 已提交
1544 1545 1546 1547 1548 1549 1550 1551 1552
		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)
	   )) {
1553
		pr_debug("EINVAL: overflow check\n");
L
Linus Torvalds 已提交
1554 1555 1556
		return -EINVAL;
	}

K
Kent Overstreet 已提交
1557
	req = aio_get_req(ctx);
1558
	if (unlikely(!req))
L
Linus Torvalds 已提交
1559
		return -EAGAIN;
1560

C
Christoph Hellwig 已提交
1561
	req->common.ki_filp = file = fget(iocb->aio_fildes);
1562
	if (unlikely(!req->common.ki_filp)) {
1563 1564
		ret = -EBADF;
		goto out_put_req;
L
Linus Torvalds 已提交
1565
	}
1566 1567
	req->common.ki_pos = iocb->aio_offset;
	req->common.ki_complete = aio_complete;
1568
	req->common.ki_flags = iocb_flags(req->common.ki_filp);
1569
	req->common.ki_hint = file_write_hint(file);
1570

1571 1572 1573 1574 1575 1576 1577
	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.
		 */
1578
		req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
1579
		if (IS_ERR(req->ki_eventfd)) {
1580
			ret = PTR_ERR(req->ki_eventfd);
1581
			req->ki_eventfd = NULL;
1582 1583
			goto out_put_req;
		}
1584 1585

		req->common.ki_flags |= IOCB_EVENTFD;
1586
	}
L
Linus Torvalds 已提交
1587

1588 1589 1590 1591 1592 1593
	ret = kiocb_set_rw_flags(&req->common, iocb->aio_rw_flags);
	if (unlikely(ret)) {
		pr_debug("EINVAL: aio_rw_flags\n");
		goto out_put_req;
	}

K
Kent Overstreet 已提交
1594
	ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
L
Linus Torvalds 已提交
1595
	if (unlikely(ret)) {
K
Kent Overstreet 已提交
1596
		pr_debug("EFAULT: aio_key\n");
L
Linus Torvalds 已提交
1597 1598 1599
		goto out_put_req;
	}

1600
	req->ki_user_iocb = user_iocb;
L
Linus Torvalds 已提交
1601 1602
	req->ki_user_data = iocb->aio_data;

C
Christoph Hellwig 已提交
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
	get_file(file);
	switch (iocb->aio_lio_opcode) {
	case IOCB_CMD_PREAD:
		ret = aio_read(&req->common, iocb, false, compat);
		break;
	case IOCB_CMD_PWRITE:
		ret = aio_write(&req->common, iocb, false, compat);
		break;
	case IOCB_CMD_PREADV:
		ret = aio_read(&req->common, iocb, true, compat);
		break;
	case IOCB_CMD_PWRITEV:
		ret = aio_write(&req->common, iocb, true, compat);
		break;
	default:
		pr_debug("invalid aio operation %d\n", iocb->aio_lio_opcode);
		ret = -EINVAL;
		break;
	}
	fput(file);
Z
Zach Brown 已提交
1623

C
Christoph Hellwig 已提交
1624 1625
	if (ret && ret != -EIOCBQUEUED)
		goto out_put_req;
L
Linus Torvalds 已提交
1626 1627
	return 0;
out_put_req:
K
Kent Overstreet 已提交
1628
	put_reqs_available(ctx, 1);
K
Kent Overstreet 已提交
1629
	percpu_ref_put(&ctx->reqs);
K
Kent Overstreet 已提交
1630
	kiocb_free(req);
L
Linus Torvalds 已提交
1631 1632 1633
	return ret;
}

A
Al Viro 已提交
1634 1635
static long do_io_submit(aio_context_t ctx_id, long nr,
			  struct iocb __user *__user *iocbpp, bool compat)
L
Linus Torvalds 已提交
1636 1637 1638
{
	struct kioctx *ctx;
	long ret = 0;
J
Jeff Moyer 已提交
1639
	int i = 0;
S
Shaohua Li 已提交
1640
	struct blk_plug plug;
L
Linus Torvalds 已提交
1641 1642 1643 1644

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

1645 1646 1647
	if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
		nr = LONG_MAX/sizeof(*iocbpp);

L
Linus Torvalds 已提交
1648 1649 1650 1651 1652
	if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
		return -EFAULT;

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

S
Shaohua Li 已提交
1657 1658
	blk_start_plug(&plug);

L
Linus Torvalds 已提交
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
	/*
	 * 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 已提交
1677
		ret = io_submit_one(ctx, user_iocb, &tmp, compat);
L
Linus Torvalds 已提交
1678 1679 1680
		if (ret)
			break;
	}
S
Shaohua Li 已提交
1681
	blk_finish_plug(&plug);
L
Linus Torvalds 已提交
1682

K
Kent Overstreet 已提交
1683
	percpu_ref_put(&ctx->users);
L
Linus Torvalds 已提交
1684 1685 1686
	return i ? i : ret;
}

1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704
/* 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);
}

A
Al Viro 已提交
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
#ifdef CONFIG_COMPAT
static inline long
copy_iocb(long nr, u32 __user *ptr32, struct iocb __user * __user *ptr64)
{
	compat_uptr_t uptr;
	int i;

	for (i = 0; i < nr; ++i) {
		if (get_user(uptr, ptr32 + i))
			return -EFAULT;
		if (put_user(compat_ptr(uptr), ptr64 + i))
			return -EFAULT;
	}
	return 0;
}

#define MAX_AIO_SUBMITS 	(PAGE_SIZE/sizeof(struct iocb *))

COMPAT_SYSCALL_DEFINE3(io_submit, compat_aio_context_t, ctx_id,
		       int, nr, u32 __user *, iocb)
{
	struct iocb __user * __user *iocb64;
	long ret;

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

	if (nr > MAX_AIO_SUBMITS)
		nr = MAX_AIO_SUBMITS;

	iocb64 = compat_alloc_user_space(nr * sizeof(*iocb64));
	ret = copy_iocb(nr, iocb, iocb64);
	if (!ret)
		ret = do_io_submit(ctx_id, nr, iocb64, 1);
	return ret;
}
#endif

L
Linus Torvalds 已提交
1743 1744 1745
/* lookup_kiocb
 *	Finds a given iocb for cancellation.
 */
1746 1747
static struct aio_kiocb *
lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb, u32 key)
L
Linus Torvalds 已提交
1748
{
1749
	struct aio_kiocb *kiocb;
1750 1751 1752

	assert_spin_locked(&ctx->ctx_lock);

K
Kent Overstreet 已提交
1753 1754 1755
	if (key != KIOCB_KEY)
		return NULL;

L
Linus Torvalds 已提交
1756
	/* TODO: use a hash or array, this sucks. */
1757 1758
	list_for_each_entry(kiocb, &ctx->active_reqs, ki_list) {
		if (kiocb->ki_user_iocb == iocb)
L
Linus Torvalds 已提交
1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
			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.
 */
1774 1775
SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
		struct io_event __user *, result)
L
Linus Torvalds 已提交
1776 1777
{
	struct kioctx *ctx;
1778
	struct aio_kiocb *kiocb;
L
Linus Torvalds 已提交
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
	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 已提交
1791

L
Linus Torvalds 已提交
1792
	kiocb = lookup_kiocb(ctx, iocb, key);
K
Kent Overstreet 已提交
1793
	if (kiocb)
1794
		ret = kiocb_cancel(kiocb);
K
Kent Overstreet 已提交
1795 1796 1797
	else
		ret = -EINVAL;

L
Linus Torvalds 已提交
1798 1799
	spin_unlock_irq(&ctx->ctx_lock);

K
Kent Overstreet 已提交
1800
	if (!ret) {
1801 1802 1803 1804
		/*
		 * 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 已提交
1805
		 */
1806
		ret = -EINPROGRESS;
K
Kent Overstreet 已提交
1807
	}
L
Linus Torvalds 已提交
1808

K
Kent Overstreet 已提交
1809
	percpu_ref_put(&ctx->users);
L
Linus Torvalds 已提交
1810 1811 1812 1813

	return ret;
}

1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
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 已提交
1833 1834
/* io_getevents:
 *	Attempts to read at least min_nr events and up to nr events from
1835 1836 1837 1838 1839 1840 1841 1842
 *	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 已提交
1843
 *	timeout is relative.  Will fail with -ENOSYS if not implemented.
L
Linus Torvalds 已提交
1844
 */
1845 1846 1847 1848 1849
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 已提交
1850
{
1851
	struct timespec64	ts;
L
Linus Torvalds 已提交
1852

1853 1854 1855
	if (timeout) {
		if (unlikely(get_timespec64(&ts, timeout)))
			return -EFAULT;
L
Linus Torvalds 已提交
1856
	}
1857 1858

	return do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &ts : NULL);
L
Linus Torvalds 已提交
1859
}
A
Al Viro 已提交
1860 1861 1862 1863 1864 1865 1866 1867

#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)
{
1868
	struct timespec64 t;
A
Al Viro 已提交
1869 1870

	if (timeout) {
1871
		if (compat_get_timespec64(&t, timeout))
A
Al Viro 已提交
1872 1873 1874
			return -EFAULT;

	}
1875 1876

	return do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &t : NULL);
A
Al Viro 已提交
1877 1878
}
#endif