direct_IO: use iov_iter_rw() instead of rw everywhere
[deliverable/linux.git] / fs / aio.c
CommitLineData
1da177e4
LT
1/*
2 * An async IO implementation for Linux
3 * Written by Benjamin LaHaise <bcrl@kvack.org>
4 *
5 * Implements an efficient asynchronous io interface.
6 *
7 * Copyright 2000, 2001, 2002 Red Hat, Inc. All Rights Reserved.
8 *
9 * See ../COPYING for licensing terms.
10 */
caf4167a
KO
11#define pr_fmt(fmt) "%s: " fmt, __func__
12
1da177e4
LT
13#include <linux/kernel.h>
14#include <linux/init.h>
15#include <linux/errno.h>
16#include <linux/time.h>
17#include <linux/aio_abi.h>
630d9c47 18#include <linux/export.h>
1da177e4 19#include <linux/syscalls.h>
b9d128f1 20#include <linux/backing-dev.h>
027445c3 21#include <linux/uio.h>
1da177e4 22
1da177e4
LT
23#include <linux/sched.h>
24#include <linux/fs.h>
25#include <linux/file.h>
26#include <linux/mm.h>
27#include <linux/mman.h>
3d2d827f 28#include <linux/mmu_context.h>
e1bdd5f2 29#include <linux/percpu.h>
1da177e4
LT
30#include <linux/slab.h>
31#include <linux/timer.h>
32#include <linux/aio.h>
33#include <linux/highmem.h>
34#include <linux/workqueue.h>
35#include <linux/security.h>
9c3060be 36#include <linux/eventfd.h>
cfb1e33e 37#include <linux/blkdev.h>
9d85cba7 38#include <linux/compat.h>
36bc08cc
GZ
39#include <linux/migrate.h>
40#include <linux/ramfs.h>
723be6e3 41#include <linux/percpu-refcount.h>
71ad7490 42#include <linux/mount.h>
1da177e4
LT
43
44#include <asm/kmap_types.h>
45#include <asm/uaccess.h>
1da177e4 46
68d70d03
AV
47#include "internal.h"
48
4e179bca
KO
49#define AIO_RING_MAGIC 0xa10a10a1
50#define AIO_RING_COMPAT_FEATURES 1
51#define AIO_RING_INCOMPAT_FEATURES 0
52struct aio_ring {
53 unsigned id; /* kernel internal index number */
54 unsigned nr; /* number of io_events */
fa8a53c3
BL
55 unsigned head; /* Written to by userland or under ring_lock
56 * mutex by aio_read_events_ring(). */
4e179bca
KO
57 unsigned tail;
58
59 unsigned magic;
60 unsigned compat_features;
61 unsigned incompat_features;
62 unsigned header_length; /* size of aio_ring */
63
64
65 struct io_event io_events[0];
66}; /* 128 bytes + ring size */
67
68#define AIO_RING_PAGES 8
4e179bca 69
db446a08
BL
70struct kioctx_table {
71 struct rcu_head rcu;
72 unsigned nr;
73 struct kioctx *table[];
74};
75
e1bdd5f2
KO
76struct kioctx_cpu {
77 unsigned reqs_available;
78};
79
4e179bca 80struct kioctx {
723be6e3 81 struct percpu_ref users;
36f55889 82 atomic_t dead;
4e179bca 83
e34ecee2
KO
84 struct percpu_ref reqs;
85
4e179bca 86 unsigned long user_id;
4e179bca 87
e1bdd5f2
KO
88 struct __percpu kioctx_cpu *cpu;
89
90 /*
91 * For percpu reqs_available, number of slots we move to/from global
92 * counter at a time:
93 */
94 unsigned req_batch;
3e845ce0
KO
95 /*
96 * This is what userspace passed to io_setup(), it's not used for
97 * anything but counting against the global max_reqs quota.
98 *
58c85dc2 99 * The real limit is nr_events - 1, which will be larger (see
3e845ce0
KO
100 * aio_setup_ring())
101 */
4e179bca
KO
102 unsigned max_reqs;
103
58c85dc2
KO
104 /* Size of ringbuffer, in units of struct io_event */
105 unsigned nr_events;
4e179bca 106
58c85dc2
KO
107 unsigned long mmap_base;
108 unsigned long mmap_size;
109
110 struct page **ring_pages;
111 long nr_pages;
112
723be6e3 113 struct work_struct free_work;
4e23bcae 114
e02ba72a
AP
115 /*
116 * signals when all in-flight requests are done
117 */
118 struct completion *requests_done;
119
4e23bcae 120 struct {
34e83fc6
KO
121 /*
122 * This counts the number of available slots in the ringbuffer,
123 * so we avoid overflowing it: it's decremented (if positive)
124 * when allocating a kiocb and incremented when the resulting
125 * io_event is pulled off the ringbuffer.
e1bdd5f2
KO
126 *
127 * We batch accesses to it with a percpu version.
34e83fc6
KO
128 */
129 atomic_t reqs_available;
4e23bcae
KO
130 } ____cacheline_aligned_in_smp;
131
132 struct {
133 spinlock_t ctx_lock;
134 struct list_head active_reqs; /* used for cancellation */
135 } ____cacheline_aligned_in_smp;
136
58c85dc2
KO
137 struct {
138 struct mutex ring_lock;
4e23bcae
KO
139 wait_queue_head_t wait;
140 } ____cacheline_aligned_in_smp;
58c85dc2
KO
141
142 struct {
143 unsigned tail;
d856f32a 144 unsigned completed_events;
58c85dc2 145 spinlock_t completion_lock;
4e23bcae 146 } ____cacheline_aligned_in_smp;
58c85dc2
KO
147
148 struct page *internal_pages[AIO_RING_PAGES];
36bc08cc 149 struct file *aio_ring_file;
db446a08
BL
150
151 unsigned id;
4e179bca
KO
152};
153
04b2fa9f
CH
154/*
155 * We use ki_cancel == KIOCB_CANCELLED to indicate that a kiocb has been either
156 * cancelled or completed (this makes a certain amount of sense because
157 * successful cancellation - io_cancel() - does deliver the completion to
158 * userspace).
159 *
160 * And since most things don't implement kiocb cancellation and we'd really like
161 * kiocb completion to be lockless when possible, we use ki_cancel to
162 * synchronize cancellation and completion - we only set it to KIOCB_CANCELLED
163 * with xchg() or cmpxchg(), see batch_complete_aio() and kiocb_cancel().
164 */
165#define KIOCB_CANCELLED ((void *) (~0ULL))
166
167struct aio_kiocb {
168 struct kiocb common;
169
170 struct kioctx *ki_ctx;
171 kiocb_cancel_fn *ki_cancel;
172
173 struct iocb __user *ki_user_iocb; /* user's aiocb */
174 __u64 ki_user_data; /* user's data for completion */
175
176 struct list_head ki_list; /* the aio core uses this
177 * for cancellation */
178
179 /*
180 * If the aio_resfd field of the userspace iocb is not zero,
181 * this is the underlying eventfd context to deliver events to.
182 */
183 struct eventfd_ctx *ki_eventfd;
184};
185
1da177e4 186/*------ sysctl variables----*/
d55b5fda
ZB
187static DEFINE_SPINLOCK(aio_nr_lock);
188unsigned long aio_nr; /* current system wide number of aio requests */
189unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
1da177e4
LT
190/*----end sysctl variables---*/
191
e18b890b
CL
192static struct kmem_cache *kiocb_cachep;
193static struct kmem_cache *kioctx_cachep;
1da177e4 194
71ad7490
BL
195static struct vfsmount *aio_mnt;
196
197static const struct file_operations aio_ring_fops;
198static const struct address_space_operations aio_ctx_aops;
199
200static struct file *aio_private_file(struct kioctx *ctx, loff_t nr_pages)
201{
202 struct qstr this = QSTR_INIT("[aio]", 5);
203 struct file *file;
204 struct path path;
205 struct inode *inode = alloc_anon_inode(aio_mnt->mnt_sb);
7f62656b
DC
206 if (IS_ERR(inode))
207 return ERR_CAST(inode);
71ad7490
BL
208
209 inode->i_mapping->a_ops = &aio_ctx_aops;
210 inode->i_mapping->private_data = ctx;
211 inode->i_size = PAGE_SIZE * nr_pages;
212
213 path.dentry = d_alloc_pseudo(aio_mnt->mnt_sb, &this);
214 if (!path.dentry) {
215 iput(inode);
216 return ERR_PTR(-ENOMEM);
217 }
218 path.mnt = mntget(aio_mnt);
219
220 d_instantiate(path.dentry, inode);
221 file = alloc_file(&path, FMODE_READ | FMODE_WRITE, &aio_ring_fops);
222 if (IS_ERR(file)) {
223 path_put(&path);
224 return file;
225 }
226
227 file->f_flags = O_RDWR;
71ad7490
BL
228 return file;
229}
230
231static struct dentry *aio_mount(struct file_system_type *fs_type,
232 int flags, const char *dev_name, void *data)
233{
234 static const struct dentry_operations ops = {
235 .d_dname = simple_dname,
236 };
8dc4379e 237 return mount_pseudo(fs_type, "aio:", NULL, &ops, AIO_RING_MAGIC);
71ad7490
BL
238}
239
1da177e4
LT
240/* aio_setup
241 * Creates the slab caches used by the aio routines, panic on
242 * failure as this is done early during the boot sequence.
243 */
244static int __init aio_setup(void)
245{
71ad7490
BL
246 static struct file_system_type aio_fs = {
247 .name = "aio",
248 .mount = aio_mount,
249 .kill_sb = kill_anon_super,
250 };
251 aio_mnt = kern_mount(&aio_fs);
252 if (IS_ERR(aio_mnt))
253 panic("Failed to create aio fs mount.");
254
04b2fa9f 255 kiocb_cachep = KMEM_CACHE(aio_kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
0a31bd5f 256 kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
1da177e4 257
caf4167a 258 pr_debug("sizeof(struct page) = %zu\n", sizeof(struct page));
1da177e4
LT
259
260 return 0;
261}
385773e0 262__initcall(aio_setup);
1da177e4 263
5e9ae2e5
BL
264static void put_aio_ring_file(struct kioctx *ctx)
265{
266 struct file *aio_ring_file = ctx->aio_ring_file;
267 if (aio_ring_file) {
268 truncate_setsize(aio_ring_file->f_inode, 0);
269
270 /* Prevent further access to the kioctx from migratepages */
271 spin_lock(&aio_ring_file->f_inode->i_mapping->private_lock);
272 aio_ring_file->f_inode->i_mapping->private_data = NULL;
273 ctx->aio_ring_file = NULL;
274 spin_unlock(&aio_ring_file->f_inode->i_mapping->private_lock);
275
276 fput(aio_ring_file);
277 }
278}
279
1da177e4
LT
280static void aio_free_ring(struct kioctx *ctx)
281{
36bc08cc 282 int i;
1da177e4 283
fa8a53c3
BL
284 /* Disconnect the kiotx from the ring file. This prevents future
285 * accesses to the kioctx from page migration.
286 */
287 put_aio_ring_file(ctx);
288
36bc08cc 289 for (i = 0; i < ctx->nr_pages; i++) {
8e321fef 290 struct page *page;
36bc08cc
GZ
291 pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
292 page_count(ctx->ring_pages[i]));
8e321fef
BL
293 page = ctx->ring_pages[i];
294 if (!page)
295 continue;
296 ctx->ring_pages[i] = NULL;
297 put_page(page);
36bc08cc 298 }
1da177e4 299
ddb8c45b 300 if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
58c85dc2 301 kfree(ctx->ring_pages);
ddb8c45b
SL
302 ctx->ring_pages = NULL;
303 }
36bc08cc
GZ
304}
305
306static int aio_ring_mmap(struct file *file, struct vm_area_struct *vma)
307{
e4a0d3e7 308 vma->vm_flags |= VM_DONTEXPAND;
36bc08cc
GZ
309 vma->vm_ops = &generic_file_vm_ops;
310 return 0;
311}
312
e4a0d3e7
PE
313static void aio_ring_remap(struct file *file, struct vm_area_struct *vma)
314{
315 struct mm_struct *mm = vma->vm_mm;
316 struct kioctx_table *table;
317 int i;
318
319 spin_lock(&mm->ioctx_lock);
320 rcu_read_lock();
321 table = rcu_dereference(mm->ioctx_table);
322 for (i = 0; i < table->nr; i++) {
323 struct kioctx *ctx;
324
325 ctx = table->table[i];
326 if (ctx && ctx->aio_ring_file == file) {
327 ctx->user_id = ctx->mmap_base = vma->vm_start;
328 break;
329 }
330 }
331
332 rcu_read_unlock();
333 spin_unlock(&mm->ioctx_lock);
334}
335
36bc08cc
GZ
336static const struct file_operations aio_ring_fops = {
337 .mmap = aio_ring_mmap,
e4a0d3e7 338 .mremap = aio_ring_remap,
36bc08cc
GZ
339};
340
0c45355f 341#if IS_ENABLED(CONFIG_MIGRATION)
36bc08cc
GZ
342static int aio_migratepage(struct address_space *mapping, struct page *new,
343 struct page *old, enum migrate_mode mode)
344{
5e9ae2e5 345 struct kioctx *ctx;
36bc08cc 346 unsigned long flags;
fa8a53c3 347 pgoff_t idx;
36bc08cc
GZ
348 int rc;
349
8e321fef
BL
350 rc = 0;
351
fa8a53c3 352 /* mapping->private_lock here protects against the kioctx teardown. */
8e321fef
BL
353 spin_lock(&mapping->private_lock);
354 ctx = mapping->private_data;
fa8a53c3
BL
355 if (!ctx) {
356 rc = -EINVAL;
357 goto out;
358 }
359
360 /* The ring_lock mutex. The prevents aio_read_events() from writing
361 * to the ring's head, and prevents page migration from mucking in
362 * a partially initialized kiotx.
363 */
364 if (!mutex_trylock(&ctx->ring_lock)) {
365 rc = -EAGAIN;
366 goto out;
367 }
368
369 idx = old->index;
370 if (idx < (pgoff_t)ctx->nr_pages) {
371 /* Make sure the old page hasn't already been changed */
372 if (ctx->ring_pages[idx] != old)
373 rc = -EAGAIN;
8e321fef
BL
374 } else
375 rc = -EINVAL;
8e321fef
BL
376
377 if (rc != 0)
fa8a53c3 378 goto out_unlock;
8e321fef 379
36bc08cc
GZ
380 /* Writeback must be complete */
381 BUG_ON(PageWriteback(old));
8e321fef 382 get_page(new);
36bc08cc 383
8e321fef 384 rc = migrate_page_move_mapping(mapping, new, old, NULL, mode, 1);
36bc08cc 385 if (rc != MIGRATEPAGE_SUCCESS) {
8e321fef 386 put_page(new);
fa8a53c3 387 goto out_unlock;
36bc08cc
GZ
388 }
389
fa8a53c3
BL
390 /* Take completion_lock to prevent other writes to the ring buffer
391 * while the old page is copied to the new. This prevents new
392 * events from being lost.
5e9ae2e5 393 */
fa8a53c3
BL
394 spin_lock_irqsave(&ctx->completion_lock, flags);
395 migrate_page_copy(new, old);
396 BUG_ON(ctx->ring_pages[idx] != old);
397 ctx->ring_pages[idx] = new;
398 spin_unlock_irqrestore(&ctx->completion_lock, flags);
36bc08cc 399
fa8a53c3
BL
400 /* The old page is no longer accessible. */
401 put_page(old);
8e321fef 402
fa8a53c3
BL
403out_unlock:
404 mutex_unlock(&ctx->ring_lock);
405out:
406 spin_unlock(&mapping->private_lock);
36bc08cc 407 return rc;
1da177e4 408}
0c45355f 409#endif
1da177e4 410
36bc08cc 411static const struct address_space_operations aio_ctx_aops = {
835f252c 412 .set_page_dirty = __set_page_dirty_no_writeback,
0c45355f 413#if IS_ENABLED(CONFIG_MIGRATION)
36bc08cc 414 .migratepage = aio_migratepage,
0c45355f 415#endif
36bc08cc
GZ
416};
417
1da177e4
LT
418static int aio_setup_ring(struct kioctx *ctx)
419{
420 struct aio_ring *ring;
1da177e4 421 unsigned nr_events = ctx->max_reqs;
41003a7b 422 struct mm_struct *mm = current->mm;
3dc9acb6 423 unsigned long size, unused;
1da177e4 424 int nr_pages;
36bc08cc
GZ
425 int i;
426 struct file *file;
1da177e4
LT
427
428 /* Compensate for the ring buffer's head/tail overlap entry */
429 nr_events += 2; /* 1 is required, 2 for good luck */
430
431 size = sizeof(struct aio_ring);
432 size += sizeof(struct io_event) * nr_events;
1da177e4 433
36bc08cc 434 nr_pages = PFN_UP(size);
1da177e4
LT
435 if (nr_pages < 0)
436 return -EINVAL;
437
71ad7490 438 file = aio_private_file(ctx, nr_pages);
36bc08cc
GZ
439 if (IS_ERR(file)) {
440 ctx->aio_ring_file = NULL;
fa8a53c3 441 return -ENOMEM;
36bc08cc
GZ
442 }
443
3dc9acb6
LT
444 ctx->aio_ring_file = file;
445 nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring))
446 / sizeof(struct io_event);
447
448 ctx->ring_pages = ctx->internal_pages;
449 if (nr_pages > AIO_RING_PAGES) {
450 ctx->ring_pages = kcalloc(nr_pages, sizeof(struct page *),
451 GFP_KERNEL);
452 if (!ctx->ring_pages) {
453 put_aio_ring_file(ctx);
454 return -ENOMEM;
455 }
456 }
457
36bc08cc
GZ
458 for (i = 0; i < nr_pages; i++) {
459 struct page *page;
460 page = find_or_create_page(file->f_inode->i_mapping,
461 i, GFP_HIGHUSER | __GFP_ZERO);
462 if (!page)
463 break;
464 pr_debug("pid(%d) page[%d]->count=%d\n",
465 current->pid, i, page_count(page));
466 SetPageUptodate(page);
36bc08cc 467 unlock_page(page);
3dc9acb6
LT
468
469 ctx->ring_pages[i] = page;
36bc08cc 470 }
3dc9acb6 471 ctx->nr_pages = i;
1da177e4 472
3dc9acb6
LT
473 if (unlikely(i != nr_pages)) {
474 aio_free_ring(ctx);
fa8a53c3 475 return -ENOMEM;
1da177e4
LT
476 }
477
58c85dc2
KO
478 ctx->mmap_size = nr_pages * PAGE_SIZE;
479 pr_debug("attempting mmap of %lu bytes\n", ctx->mmap_size);
36bc08cc 480
41003a7b 481 down_write(&mm->mmap_sem);
36bc08cc
GZ
482 ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
483 PROT_READ | PROT_WRITE,
3dc9acb6
LT
484 MAP_SHARED, 0, &unused);
485 up_write(&mm->mmap_sem);
58c85dc2 486 if (IS_ERR((void *)ctx->mmap_base)) {
58c85dc2 487 ctx->mmap_size = 0;
1da177e4 488 aio_free_ring(ctx);
fa8a53c3 489 return -ENOMEM;
1da177e4
LT
490 }
491
58c85dc2 492 pr_debug("mmap address: 0x%08lx\n", ctx->mmap_base);
d6c355c7 493
58c85dc2
KO
494 ctx->user_id = ctx->mmap_base;
495 ctx->nr_events = nr_events; /* trusted copy */
1da177e4 496
58c85dc2 497 ring = kmap_atomic(ctx->ring_pages[0]);
1da177e4 498 ring->nr = nr_events; /* user copy */
db446a08 499 ring->id = ~0U;
1da177e4
LT
500 ring->head = ring->tail = 0;
501 ring->magic = AIO_RING_MAGIC;
502 ring->compat_features = AIO_RING_COMPAT_FEATURES;
503 ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
504 ring->header_length = sizeof(struct aio_ring);
e8e3c3d6 505 kunmap_atomic(ring);
58c85dc2 506 flush_dcache_page(ctx->ring_pages[0]);
1da177e4
LT
507
508 return 0;
509}
510
1da177e4
LT
511#define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
512#define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
513#define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
514
04b2fa9f 515void kiocb_set_cancel_fn(struct kiocb *iocb, kiocb_cancel_fn *cancel)
0460fef2 516{
04b2fa9f 517 struct aio_kiocb *req = container_of(iocb, struct aio_kiocb, common);
0460fef2
KO
518 struct kioctx *ctx = req->ki_ctx;
519 unsigned long flags;
520
521 spin_lock_irqsave(&ctx->ctx_lock, flags);
522
523 if (!req->ki_list.next)
524 list_add(&req->ki_list, &ctx->active_reqs);
525
526 req->ki_cancel = cancel;
527
528 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
529}
530EXPORT_SYMBOL(kiocb_set_cancel_fn);
531
04b2fa9f 532static int kiocb_cancel(struct aio_kiocb *kiocb)
906b973c 533{
0460fef2 534 kiocb_cancel_fn *old, *cancel;
906b973c 535
0460fef2
KO
536 /*
537 * Don't want to set kiocb->ki_cancel = KIOCB_CANCELLED unless it
538 * actually has a cancel function, hence the cmpxchg()
539 */
540
541 cancel = ACCESS_ONCE(kiocb->ki_cancel);
542 do {
543 if (!cancel || cancel == KIOCB_CANCELLED)
57282d8f 544 return -EINVAL;
906b973c 545
0460fef2
KO
546 old = cancel;
547 cancel = cmpxchg(&kiocb->ki_cancel, old, KIOCB_CANCELLED);
548 } while (cancel != old);
906b973c 549
04b2fa9f 550 return cancel(&kiocb->common);
906b973c
KO
551}
552
e34ecee2 553static void free_ioctx(struct work_struct *work)
36f55889 554{
e34ecee2 555 struct kioctx *ctx = container_of(work, struct kioctx, free_work);
e1bdd5f2 556
e34ecee2 557 pr_debug("freeing %p\n", ctx);
e1bdd5f2 558
e34ecee2 559 aio_free_ring(ctx);
e1bdd5f2 560 free_percpu(ctx->cpu);
9a1049da
TH
561 percpu_ref_exit(&ctx->reqs);
562 percpu_ref_exit(&ctx->users);
36f55889
KO
563 kmem_cache_free(kioctx_cachep, ctx);
564}
565
e34ecee2
KO
566static void free_ioctx_reqs(struct percpu_ref *ref)
567{
568 struct kioctx *ctx = container_of(ref, struct kioctx, reqs);
569
e02ba72a
AP
570 /* At this point we know that there are no any in-flight requests */
571 if (ctx->requests_done)
572 complete(ctx->requests_done);
573
e34ecee2
KO
574 INIT_WORK(&ctx->free_work, free_ioctx);
575 schedule_work(&ctx->free_work);
576}
577
36f55889
KO
578/*
579 * When this function runs, the kioctx has been removed from the "hash table"
580 * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
581 * now it's safe to cancel any that need to be.
582 */
e34ecee2 583static void free_ioctx_users(struct percpu_ref *ref)
36f55889 584{
e34ecee2 585 struct kioctx *ctx = container_of(ref, struct kioctx, users);
04b2fa9f 586 struct aio_kiocb *req;
36f55889
KO
587
588 spin_lock_irq(&ctx->ctx_lock);
589
590 while (!list_empty(&ctx->active_reqs)) {
591 req = list_first_entry(&ctx->active_reqs,
04b2fa9f 592 struct aio_kiocb, ki_list);
36f55889
KO
593
594 list_del_init(&req->ki_list);
d52a8f9e 595 kiocb_cancel(req);
36f55889
KO
596 }
597
598 spin_unlock_irq(&ctx->ctx_lock);
599
e34ecee2
KO
600 percpu_ref_kill(&ctx->reqs);
601 percpu_ref_put(&ctx->reqs);
36f55889
KO
602}
603
db446a08
BL
604static int ioctx_add_table(struct kioctx *ctx, struct mm_struct *mm)
605{
606 unsigned i, new_nr;
607 struct kioctx_table *table, *old;
608 struct aio_ring *ring;
609
610 spin_lock(&mm->ioctx_lock);
855ef0de 611 table = rcu_dereference_raw(mm->ioctx_table);
db446a08
BL
612
613 while (1) {
614 if (table)
615 for (i = 0; i < table->nr; i++)
616 if (!table->table[i]) {
617 ctx->id = i;
618 table->table[i] = ctx;
619 spin_unlock(&mm->ioctx_lock);
620
fa8a53c3
BL
621 /* While kioctx setup is in progress,
622 * we are protected from page migration
623 * changes ring_pages by ->ring_lock.
624 */
db446a08
BL
625 ring = kmap_atomic(ctx->ring_pages[0]);
626 ring->id = ctx->id;
627 kunmap_atomic(ring);
628 return 0;
629 }
630
631 new_nr = (table ? table->nr : 1) * 4;
db446a08
BL
632 spin_unlock(&mm->ioctx_lock);
633
634 table = kzalloc(sizeof(*table) + sizeof(struct kioctx *) *
635 new_nr, GFP_KERNEL);
636 if (!table)
637 return -ENOMEM;
638
639 table->nr = new_nr;
640
641 spin_lock(&mm->ioctx_lock);
855ef0de 642 old = rcu_dereference_raw(mm->ioctx_table);
db446a08
BL
643
644 if (!old) {
645 rcu_assign_pointer(mm->ioctx_table, table);
646 } else if (table->nr > old->nr) {
647 memcpy(table->table, old->table,
648 old->nr * sizeof(struct kioctx *));
649
650 rcu_assign_pointer(mm->ioctx_table, table);
651 kfree_rcu(old, rcu);
652 } else {
653 kfree(table);
654 table = old;
655 }
656 }
657}
658
e34ecee2
KO
659static void aio_nr_sub(unsigned nr)
660{
661 spin_lock(&aio_nr_lock);
662 if (WARN_ON(aio_nr - nr > aio_nr))
663 aio_nr = 0;
664 else
665 aio_nr -= nr;
666 spin_unlock(&aio_nr_lock);
667}
668
1da177e4
LT
669/* ioctx_alloc
670 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
671 */
672static struct kioctx *ioctx_alloc(unsigned nr_events)
673{
41003a7b 674 struct mm_struct *mm = current->mm;
1da177e4 675 struct kioctx *ctx;
e23754f8 676 int err = -ENOMEM;
1da177e4 677
e1bdd5f2
KO
678 /*
679 * We keep track of the number of available ringbuffer slots, to prevent
680 * overflow (reqs_available), and we also use percpu counters for this.
681 *
682 * So since up to half the slots might be on other cpu's percpu counters
683 * and unavailable, double nr_events so userspace sees what they
684 * expected: additionally, we move req_batch slots to/from percpu
685 * counters at a time, so make sure that isn't 0:
686 */
687 nr_events = max(nr_events, num_possible_cpus() * 4);
688 nr_events *= 2;
689
1da177e4 690 /* Prevent overflows */
08397acd 691 if (nr_events > (0x10000000U / sizeof(struct io_event))) {
1da177e4
LT
692 pr_debug("ENOMEM: nr_events too high\n");
693 return ERR_PTR(-EINVAL);
694 }
695
4cd81c3d 696 if (!nr_events || (unsigned long)nr_events > (aio_max_nr * 2UL))
1da177e4
LT
697 return ERR_PTR(-EAGAIN);
698
c3762229 699 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
1da177e4
LT
700 if (!ctx)
701 return ERR_PTR(-ENOMEM);
702
1da177e4 703 ctx->max_reqs = nr_events;
1da177e4 704
1da177e4 705 spin_lock_init(&ctx->ctx_lock);
0460fef2 706 spin_lock_init(&ctx->completion_lock);
58c85dc2 707 mutex_init(&ctx->ring_lock);
fa8a53c3
BL
708 /* Protect against page migration throughout kiotx setup by keeping
709 * the ring_lock mutex held until setup is complete. */
710 mutex_lock(&ctx->ring_lock);
1da177e4
LT
711 init_waitqueue_head(&ctx->wait);
712
713 INIT_LIST_HEAD(&ctx->active_reqs);
1da177e4 714
2aad2a86 715 if (percpu_ref_init(&ctx->users, free_ioctx_users, 0, GFP_KERNEL))
fa8a53c3
BL
716 goto err;
717
2aad2a86 718 if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs, 0, GFP_KERNEL))
fa8a53c3
BL
719 goto err;
720
e1bdd5f2
KO
721 ctx->cpu = alloc_percpu(struct kioctx_cpu);
722 if (!ctx->cpu)
e34ecee2 723 goto err;
1da177e4 724
fa8a53c3
BL
725 err = aio_setup_ring(ctx);
726 if (err < 0)
e34ecee2 727 goto err;
e1bdd5f2 728
34e83fc6 729 atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
e1bdd5f2 730 ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
6878ea72
BL
731 if (ctx->req_batch < 1)
732 ctx->req_batch = 1;
34e83fc6 733
1da177e4 734 /* limit the number of system wide aios */
9fa1cb39 735 spin_lock(&aio_nr_lock);
4cd81c3d 736 if (aio_nr + nr_events > (aio_max_nr * 2UL) ||
2dd542b7 737 aio_nr + nr_events < aio_nr) {
9fa1cb39 738 spin_unlock(&aio_nr_lock);
e34ecee2 739 err = -EAGAIN;
d1b94327 740 goto err_ctx;
2dd542b7
AV
741 }
742 aio_nr += ctx->max_reqs;
9fa1cb39 743 spin_unlock(&aio_nr_lock);
1da177e4 744
1881686f
BL
745 percpu_ref_get(&ctx->users); /* io_setup() will drop this ref */
746 percpu_ref_get(&ctx->reqs); /* free_ioctx_users() will drop this */
723be6e3 747
da90382c
BL
748 err = ioctx_add_table(ctx, mm);
749 if (err)
e34ecee2 750 goto err_cleanup;
da90382c 751
fa8a53c3
BL
752 /* Release the ring_lock mutex now that all setup is complete. */
753 mutex_unlock(&ctx->ring_lock);
754
caf4167a 755 pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
58c85dc2 756 ctx, ctx->user_id, mm, ctx->nr_events);
1da177e4
LT
757 return ctx;
758
e34ecee2
KO
759err_cleanup:
760 aio_nr_sub(ctx->max_reqs);
d1b94327
GZ
761err_ctx:
762 aio_free_ring(ctx);
e34ecee2 763err:
fa8a53c3 764 mutex_unlock(&ctx->ring_lock);
e1bdd5f2 765 free_percpu(ctx->cpu);
9a1049da
TH
766 percpu_ref_exit(&ctx->reqs);
767 percpu_ref_exit(&ctx->users);
1da177e4 768 kmem_cache_free(kioctx_cachep, ctx);
caf4167a 769 pr_debug("error allocating ioctx %d\n", err);
e23754f8 770 return ERR_PTR(err);
1da177e4
LT
771}
772
36f55889
KO
773/* kill_ioctx
774 * Cancels all outstanding aio requests on an aio context. Used
775 * when the processes owning a context have all exited to encourage
776 * the rapid destruction of the kioctx.
777 */
fb2d4483 778static int kill_ioctx(struct mm_struct *mm, struct kioctx *ctx,
e02ba72a 779 struct completion *requests_done)
36f55889 780{
fa88b6f8 781 struct kioctx_table *table;
db446a08 782
fa88b6f8
BL
783 if (atomic_xchg(&ctx->dead, 1))
784 return -EINVAL;
db446a08 785
db446a08 786
fa88b6f8 787 spin_lock(&mm->ioctx_lock);
855ef0de 788 table = rcu_dereference_raw(mm->ioctx_table);
fa88b6f8
BL
789 WARN_ON(ctx != table->table[ctx->id]);
790 table->table[ctx->id] = NULL;
fa88b6f8 791 spin_unlock(&mm->ioctx_lock);
4fcc712f 792
fa88b6f8
BL
793 /* percpu_ref_kill() will do the necessary call_rcu() */
794 wake_up_all(&ctx->wait);
4fcc712f 795
fa88b6f8
BL
796 /*
797 * It'd be more correct to do this in free_ioctx(), after all
798 * the outstanding kiocbs have finished - but by then io_destroy
799 * has already returned, so io_setup() could potentially return
800 * -EAGAIN with no ioctxs actually in use (as far as userspace
801 * could tell).
802 */
803 aio_nr_sub(ctx->max_reqs);
4fcc712f 804
fa88b6f8
BL
805 if (ctx->mmap_size)
806 vm_munmap(ctx->mmap_base, ctx->mmap_size);
fb2d4483 807
fa88b6f8
BL
808 ctx->requests_done = requests_done;
809 percpu_ref_kill(&ctx->users);
810 return 0;
1da177e4
LT
811}
812
36f55889
KO
813/*
814 * exit_aio: called when the last user of mm goes away. At this point, there is
815 * no way for any new requests to be submited or any of the io_* syscalls to be
816 * called on the context.
817 *
818 * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
819 * them.
1da177e4 820 */
fc9b52cd 821void exit_aio(struct mm_struct *mm)
1da177e4 822{
4b70ac5f
ON
823 struct kioctx_table *table = rcu_dereference_raw(mm->ioctx_table);
824 int i;
db446a08 825
4b70ac5f
ON
826 if (!table)
827 return;
db446a08 828
4b70ac5f
ON
829 for (i = 0; i < table->nr; ++i) {
830 struct kioctx *ctx = table->table[i];
6098b45b
GZ
831 struct completion requests_done =
832 COMPLETION_INITIALIZER_ONSTACK(requests_done);
abf137dd 833
4b70ac5f
ON
834 if (!ctx)
835 continue;
936af157 836 /*
4b70ac5f
ON
837 * We don't need to bother with munmap() here - exit_mmap(mm)
838 * is coming and it'll unmap everything. And we simply can't,
839 * this is not necessarily our ->mm.
840 * Since kill_ioctx() uses non-zero ->mmap_size as indicator
841 * that it needs to unmap the area, just set it to 0.
936af157 842 */
58c85dc2 843 ctx->mmap_size = 0;
6098b45b 844 kill_ioctx(mm, ctx, &requests_done);
36f55889 845
6098b45b
GZ
846 /* Wait until all IO for the context are done. */
847 wait_for_completion(&requests_done);
1da177e4 848 }
4b70ac5f
ON
849
850 RCU_INIT_POINTER(mm->ioctx_table, NULL);
851 kfree(table);
1da177e4
LT
852}
853
e1bdd5f2
KO
854static void put_reqs_available(struct kioctx *ctx, unsigned nr)
855{
856 struct kioctx_cpu *kcpu;
263782c1 857 unsigned long flags;
e1bdd5f2 858
263782c1 859 local_irq_save(flags);
be6fb451 860 kcpu = this_cpu_ptr(ctx->cpu);
e1bdd5f2 861 kcpu->reqs_available += nr;
263782c1 862
e1bdd5f2
KO
863 while (kcpu->reqs_available >= ctx->req_batch * 2) {
864 kcpu->reqs_available -= ctx->req_batch;
865 atomic_add(ctx->req_batch, &ctx->reqs_available);
866 }
867
263782c1 868 local_irq_restore(flags);
e1bdd5f2
KO
869}
870
871static bool get_reqs_available(struct kioctx *ctx)
872{
873 struct kioctx_cpu *kcpu;
874 bool ret = false;
263782c1 875 unsigned long flags;
e1bdd5f2 876
263782c1 877 local_irq_save(flags);
be6fb451 878 kcpu = this_cpu_ptr(ctx->cpu);
e1bdd5f2
KO
879 if (!kcpu->reqs_available) {
880 int old, avail = atomic_read(&ctx->reqs_available);
881
882 do {
883 if (avail < ctx->req_batch)
884 goto out;
885
886 old = avail;
887 avail = atomic_cmpxchg(&ctx->reqs_available,
888 avail, avail - ctx->req_batch);
889 } while (avail != old);
890
891 kcpu->reqs_available += ctx->req_batch;
892 }
893
894 ret = true;
895 kcpu->reqs_available--;
896out:
263782c1 897 local_irq_restore(flags);
e1bdd5f2
KO
898 return ret;
899}
900
d856f32a
BL
901/* refill_reqs_available
902 * Updates the reqs_available reference counts used for tracking the
903 * number of free slots in the completion ring. This can be called
904 * from aio_complete() (to optimistically update reqs_available) or
905 * from aio_get_req() (the we're out of events case). It must be
906 * called holding ctx->completion_lock.
907 */
908static void refill_reqs_available(struct kioctx *ctx, unsigned head,
909 unsigned tail)
910{
911 unsigned events_in_ring, completed;
912
913 /* Clamp head since userland can write to it. */
914 head %= ctx->nr_events;
915 if (head <= tail)
916 events_in_ring = tail - head;
917 else
918 events_in_ring = ctx->nr_events - (head - tail);
919
920 completed = ctx->completed_events;
921 if (events_in_ring < completed)
922 completed -= events_in_ring;
923 else
924 completed = 0;
925
926 if (!completed)
927 return;
928
929 ctx->completed_events -= completed;
930 put_reqs_available(ctx, completed);
931}
932
933/* user_refill_reqs_available
934 * Called to refill reqs_available when aio_get_req() encounters an
935 * out of space in the completion ring.
936 */
937static void user_refill_reqs_available(struct kioctx *ctx)
938{
939 spin_lock_irq(&ctx->completion_lock);
940 if (ctx->completed_events) {
941 struct aio_ring *ring;
942 unsigned head;
943
944 /* Access of ring->head may race with aio_read_events_ring()
945 * here, but that's okay since whether we read the old version
946 * or the new version, and either will be valid. The important
947 * part is that head cannot pass tail since we prevent
948 * aio_complete() from updating tail by holding
949 * ctx->completion_lock. Even if head is invalid, the check
950 * against ctx->completed_events below will make sure we do the
951 * safe/right thing.
952 */
953 ring = kmap_atomic(ctx->ring_pages[0]);
954 head = ring->head;
955 kunmap_atomic(ring);
956
957 refill_reqs_available(ctx, head, ctx->tail);
958 }
959
960 spin_unlock_irq(&ctx->completion_lock);
961}
962
1da177e4 963/* aio_get_req
57282d8f
KO
964 * Allocate a slot for an aio request.
965 * Returns NULL if no requests are free.
1da177e4 966 */
04b2fa9f 967static inline struct aio_kiocb *aio_get_req(struct kioctx *ctx)
1da177e4 968{
04b2fa9f 969 struct aio_kiocb *req;
a1c8eae7 970
d856f32a
BL
971 if (!get_reqs_available(ctx)) {
972 user_refill_reqs_available(ctx);
973 if (!get_reqs_available(ctx))
974 return NULL;
975 }
a1c8eae7 976
0460fef2 977 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
1da177e4 978 if (unlikely(!req))
a1c8eae7 979 goto out_put;
1da177e4 980
e34ecee2
KO
981 percpu_ref_get(&ctx->reqs);
982
1da177e4 983 req->ki_ctx = ctx;
080d676d 984 return req;
a1c8eae7 985out_put:
e1bdd5f2 986 put_reqs_available(ctx, 1);
a1c8eae7 987 return NULL;
1da177e4
LT
988}
989
04b2fa9f 990static void kiocb_free(struct aio_kiocb *req)
1da177e4 991{
04b2fa9f
CH
992 if (req->common.ki_filp)
993 fput(req->common.ki_filp);
13389010
DL
994 if (req->ki_eventfd != NULL)
995 eventfd_ctx_put(req->ki_eventfd);
1da177e4 996 kmem_cache_free(kiocb_cachep, req);
1da177e4
LT
997}
998
d5470b59 999static struct kioctx *lookup_ioctx(unsigned long ctx_id)
1da177e4 1000{
db446a08 1001 struct aio_ring __user *ring = (void __user *)ctx_id;
abf137dd 1002 struct mm_struct *mm = current->mm;
65c24491 1003 struct kioctx *ctx, *ret = NULL;
db446a08
BL
1004 struct kioctx_table *table;
1005 unsigned id;
1006
1007 if (get_user(id, &ring->id))
1008 return NULL;
1da177e4 1009
abf137dd 1010 rcu_read_lock();
db446a08 1011 table = rcu_dereference(mm->ioctx_table);
abf137dd 1012
db446a08
BL
1013 if (!table || id >= table->nr)
1014 goto out;
1da177e4 1015
db446a08 1016 ctx = table->table[id];
f30d704f 1017 if (ctx && ctx->user_id == ctx_id) {
db446a08
BL
1018 percpu_ref_get(&ctx->users);
1019 ret = ctx;
1020 }
1021out:
abf137dd 1022 rcu_read_unlock();
65c24491 1023 return ret;
1da177e4
LT
1024}
1025
1da177e4
LT
1026/* aio_complete
1027 * Called when the io request on the given iocb is complete.
1da177e4 1028 */
04b2fa9f 1029static void aio_complete(struct kiocb *kiocb, long res, long res2)
1da177e4 1030{
04b2fa9f 1031 struct aio_kiocb *iocb = container_of(kiocb, struct aio_kiocb, common);
1da177e4 1032 struct kioctx *ctx = iocb->ki_ctx;
1da177e4 1033 struct aio_ring *ring;
21b40200 1034 struct io_event *ev_page, *event;
d856f32a 1035 unsigned tail, pos, head;
1da177e4 1036 unsigned long flags;
1da177e4 1037
20dcae32
ZB
1038 /*
1039 * Special case handling for sync iocbs:
1040 * - events go directly into the iocb for fast handling
1041 * - the sync task with the iocb in its stack holds the single iocb
1042 * ref, no other paths have a way to get another ref
1043 * - the sync task helpfully left a reference to itself in the iocb
1da177e4 1044 */
04b2fa9f 1045 BUG_ON(is_sync_kiocb(kiocb));
1da177e4 1046
0460fef2
KO
1047 if (iocb->ki_list.next) {
1048 unsigned long flags;
1049
1050 spin_lock_irqsave(&ctx->ctx_lock, flags);
1051 list_del(&iocb->ki_list);
1052 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
1053 }
11599eba 1054
0460fef2
KO
1055 /*
1056 * Add a completion event to the ring buffer. Must be done holding
4b30f07e 1057 * ctx->completion_lock to prevent other code from messing with the tail
0460fef2
KO
1058 * pointer since we might be called from irq context.
1059 */
1060 spin_lock_irqsave(&ctx->completion_lock, flags);
1061
58c85dc2 1062 tail = ctx->tail;
21b40200
KO
1063 pos = tail + AIO_EVENTS_OFFSET;
1064
58c85dc2 1065 if (++tail >= ctx->nr_events)
4bf69b2a 1066 tail = 0;
1da177e4 1067
58c85dc2 1068 ev_page = kmap_atomic(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
21b40200
KO
1069 event = ev_page + pos % AIO_EVENTS_PER_PAGE;
1070
04b2fa9f 1071 event->obj = (u64)(unsigned long)iocb->ki_user_iocb;
1da177e4
LT
1072 event->data = iocb->ki_user_data;
1073 event->res = res;
1074 event->res2 = res2;
1075
21b40200 1076 kunmap_atomic(ev_page);
58c85dc2 1077 flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
21b40200
KO
1078
1079 pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
04b2fa9f 1080 ctx, tail, iocb, iocb->ki_user_iocb, iocb->ki_user_data,
caf4167a 1081 res, res2);
1da177e4
LT
1082
1083 /* after flagging the request as done, we
1084 * must never even look at it again
1085 */
1086 smp_wmb(); /* make event visible before updating tail */
1087
58c85dc2 1088 ctx->tail = tail;
1da177e4 1089
58c85dc2 1090 ring = kmap_atomic(ctx->ring_pages[0]);
d856f32a 1091 head = ring->head;
21b40200 1092 ring->tail = tail;
e8e3c3d6 1093 kunmap_atomic(ring);
58c85dc2 1094 flush_dcache_page(ctx->ring_pages[0]);
1da177e4 1095
d856f32a
BL
1096 ctx->completed_events++;
1097 if (ctx->completed_events > 1)
1098 refill_reqs_available(ctx, head, tail);
0460fef2
KO
1099 spin_unlock_irqrestore(&ctx->completion_lock, flags);
1100
21b40200 1101 pr_debug("added to ring %p at [%u]\n", iocb, tail);
8d1c98b0
DL
1102
1103 /*
1104 * Check if the user asked us to deliver the result through an
1105 * eventfd. The eventfd_signal() function is safe to be called
1106 * from IRQ context.
1107 */
87c3a86e 1108 if (iocb->ki_eventfd != NULL)
8d1c98b0
DL
1109 eventfd_signal(iocb->ki_eventfd, 1);
1110
1da177e4 1111 /* everything turned out well, dispose of the aiocb. */
57282d8f 1112 kiocb_free(iocb);
1da177e4 1113
6cb2a210
QB
1114 /*
1115 * We have to order our ring_info tail store above and test
1116 * of the wait list below outside the wait lock. This is
1117 * like in wake_up_bit() where clearing a bit has to be
1118 * ordered with the unlocked test.
1119 */
1120 smp_mb();
1121
1da177e4
LT
1122 if (waitqueue_active(&ctx->wait))
1123 wake_up(&ctx->wait);
1124
e34ecee2 1125 percpu_ref_put(&ctx->reqs);
1da177e4
LT
1126}
1127
2be4e7de 1128/* aio_read_events_ring
a31ad380
KO
1129 * Pull an event off of the ioctx's event ring. Returns the number of
1130 * events fetched
1da177e4 1131 */
a31ad380
KO
1132static long aio_read_events_ring(struct kioctx *ctx,
1133 struct io_event __user *event, long nr)
1da177e4 1134{
1da177e4 1135 struct aio_ring *ring;
5ffac122 1136 unsigned head, tail, pos;
a31ad380
KO
1137 long ret = 0;
1138 int copy_ret;
1139
9c9ce763
DC
1140 /*
1141 * The mutex can block and wake us up and that will cause
1142 * wait_event_interruptible_hrtimeout() to schedule without sleeping
1143 * and repeat. This should be rare enough that it doesn't cause
1144 * peformance issues. See the comment in read_events() for more detail.
1145 */
1146 sched_annotate_sleep();
58c85dc2 1147 mutex_lock(&ctx->ring_lock);
1da177e4 1148
fa8a53c3 1149 /* Access to ->ring_pages here is protected by ctx->ring_lock. */
58c85dc2 1150 ring = kmap_atomic(ctx->ring_pages[0]);
a31ad380 1151 head = ring->head;
5ffac122 1152 tail = ring->tail;
a31ad380
KO
1153 kunmap_atomic(ring);
1154
2ff396be
JM
1155 /*
1156 * Ensure that once we've read the current tail pointer, that
1157 * we also see the events that were stored up to the tail.
1158 */
1159 smp_rmb();
1160
5ffac122 1161 pr_debug("h%u t%u m%u\n", head, tail, ctx->nr_events);
1da177e4 1162
5ffac122 1163 if (head == tail)
1da177e4
LT
1164 goto out;
1165
edfbbf38
BL
1166 head %= ctx->nr_events;
1167 tail %= ctx->nr_events;
1168
a31ad380
KO
1169 while (ret < nr) {
1170 long avail;
1171 struct io_event *ev;
1172 struct page *page;
1173
5ffac122
KO
1174 avail = (head <= tail ? tail : ctx->nr_events) - head;
1175 if (head == tail)
a31ad380
KO
1176 break;
1177
1178 avail = min(avail, nr - ret);
1179 avail = min_t(long, avail, AIO_EVENTS_PER_PAGE -
1180 ((head + AIO_EVENTS_OFFSET) % AIO_EVENTS_PER_PAGE));
1181
1182 pos = head + AIO_EVENTS_OFFSET;
58c85dc2 1183 page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
a31ad380
KO
1184 pos %= AIO_EVENTS_PER_PAGE;
1185
1186 ev = kmap(page);
1187 copy_ret = copy_to_user(event + ret, ev + pos,
1188 sizeof(*ev) * avail);
1189 kunmap(page);
1190
1191 if (unlikely(copy_ret)) {
1192 ret = -EFAULT;
1193 goto out;
1194 }
1195
1196 ret += avail;
1197 head += avail;
58c85dc2 1198 head %= ctx->nr_events;
1da177e4 1199 }
1da177e4 1200
58c85dc2 1201 ring = kmap_atomic(ctx->ring_pages[0]);
a31ad380 1202 ring->head = head;
91d80a84 1203 kunmap_atomic(ring);
58c85dc2 1204 flush_dcache_page(ctx->ring_pages[0]);
a31ad380 1205
5ffac122 1206 pr_debug("%li h%u t%u\n", ret, head, tail);
a31ad380 1207out:
58c85dc2 1208 mutex_unlock(&ctx->ring_lock);
a31ad380 1209
1da177e4
LT
1210 return ret;
1211}
1212
a31ad380
KO
1213static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
1214 struct io_event __user *event, long *i)
1da177e4 1215{
a31ad380 1216 long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
1da177e4 1217
a31ad380
KO
1218 if (ret > 0)
1219 *i += ret;
1da177e4 1220
a31ad380
KO
1221 if (unlikely(atomic_read(&ctx->dead)))
1222 ret = -EINVAL;
1da177e4 1223
a31ad380
KO
1224 if (!*i)
1225 *i = ret;
1da177e4 1226
a31ad380 1227 return ret < 0 || *i >= min_nr;
1da177e4
LT
1228}
1229
a31ad380 1230static long read_events(struct kioctx *ctx, long min_nr, long nr,
1da177e4
LT
1231 struct io_event __user *event,
1232 struct timespec __user *timeout)
1233{
a31ad380
KO
1234 ktime_t until = { .tv64 = KTIME_MAX };
1235 long ret = 0;
1da177e4 1236
1da177e4
LT
1237 if (timeout) {
1238 struct timespec ts;
a31ad380 1239
1da177e4 1240 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
a31ad380 1241 return -EFAULT;
1da177e4 1242
a31ad380 1243 until = timespec_to_ktime(ts);
1da177e4
LT
1244 }
1245
a31ad380
KO
1246 /*
1247 * Note that aio_read_events() is being called as the conditional - i.e.
1248 * we're calling it after prepare_to_wait() has set task state to
1249 * TASK_INTERRUPTIBLE.
1250 *
1251 * But aio_read_events() can block, and if it blocks it's going to flip
1252 * the task state back to TASK_RUNNING.
1253 *
1254 * This should be ok, provided it doesn't flip the state back to
1255 * TASK_RUNNING and return 0 too much - that causes us to spin. That
1256 * will only happen if the mutex_lock() call blocks, and we then find
1257 * the ringbuffer empty. So in practice we should be ok, but it's
1258 * something to be aware of when touching this code.
1259 */
5f785de5
FZ
1260 if (until.tv64 == 0)
1261 aio_read_events(ctx, min_nr, nr, event, &ret);
1262 else
1263 wait_event_interruptible_hrtimeout(ctx->wait,
1264 aio_read_events(ctx, min_nr, nr, event, &ret),
1265 until);
1da177e4 1266
a31ad380
KO
1267 if (!ret && signal_pending(current))
1268 ret = -EINTR;
1da177e4 1269
a31ad380 1270 return ret;
1da177e4
LT
1271}
1272
1da177e4
LT
1273/* sys_io_setup:
1274 * Create an aio_context capable of receiving at least nr_events.
1275 * ctxp must not point to an aio_context that already exists, and
1276 * must be initialized to 0 prior to the call. On successful
1277 * creation of the aio_context, *ctxp is filled in with the resulting
1278 * handle. May fail with -EINVAL if *ctxp is not initialized,
1279 * if the specified nr_events exceeds internal limits. May fail
1280 * with -EAGAIN if the specified nr_events exceeds the user's limit
1281 * of available events. May fail with -ENOMEM if insufficient kernel
1282 * resources are available. May fail with -EFAULT if an invalid
1283 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1284 * implemented.
1285 */
002c8976 1286SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
1da177e4
LT
1287{
1288 struct kioctx *ioctx = NULL;
1289 unsigned long ctx;
1290 long ret;
1291
1292 ret = get_user(ctx, ctxp);
1293 if (unlikely(ret))
1294 goto out;
1295
1296 ret = -EINVAL;
d55b5fda 1297 if (unlikely(ctx || nr_events == 0)) {
acd88d4e 1298 pr_debug("EINVAL: ctx %lu nr_events %u\n",
d55b5fda 1299 ctx, nr_events);
1da177e4
LT
1300 goto out;
1301 }
1302
1303 ioctx = ioctx_alloc(nr_events);
1304 ret = PTR_ERR(ioctx);
1305 if (!IS_ERR(ioctx)) {
1306 ret = put_user(ioctx->user_id, ctxp);
a2e1859a 1307 if (ret)
e02ba72a 1308 kill_ioctx(current->mm, ioctx, NULL);
723be6e3 1309 percpu_ref_put(&ioctx->users);
1da177e4
LT
1310 }
1311
1312out:
1313 return ret;
1314}
1315
1316/* sys_io_destroy:
1317 * Destroy the aio_context specified. May cancel any outstanding
1318 * AIOs and block on completion. Will fail with -ENOSYS if not
642b5123 1319 * implemented. May fail with -EINVAL if the context pointed to
1da177e4
LT
1320 * is invalid.
1321 */
002c8976 1322SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
1da177e4
LT
1323{
1324 struct kioctx *ioctx = lookup_ioctx(ctx);
1325 if (likely(NULL != ioctx)) {
e02ba72a
AP
1326 struct completion requests_done =
1327 COMPLETION_INITIALIZER_ONSTACK(requests_done);
fb2d4483 1328 int ret;
e02ba72a
AP
1329
1330 /* Pass requests_done to kill_ioctx() where it can be set
1331 * in a thread-safe way. If we try to set it here then we have
1332 * a race condition if two io_destroy() called simultaneously.
1333 */
fb2d4483 1334 ret = kill_ioctx(current->mm, ioctx, &requests_done);
723be6e3 1335 percpu_ref_put(&ioctx->users);
e02ba72a
AP
1336
1337 /* Wait until all IO for the context are done. Otherwise kernel
1338 * keep using user-space buffers even if user thinks the context
1339 * is destroyed.
1340 */
fb2d4483
BL
1341 if (!ret)
1342 wait_for_completion(&requests_done);
e02ba72a 1343
fb2d4483 1344 return ret;
1da177e4 1345 }
acd88d4e 1346 pr_debug("EINVAL: invalid context id\n");
1da177e4
LT
1347 return -EINVAL;
1348}
1349
293bc982 1350typedef ssize_t (rw_iter_op)(struct kiocb *, struct iov_iter *);
41ef4eb8 1351
a96114fa
AV
1352static int aio_setup_vectored_rw(int rw, char __user *buf, size_t len,
1353 struct iovec **iovec,
1354 bool compat,
1355 struct iov_iter *iter)
eed4e51f 1356{
9d85cba7
JM
1357#ifdef CONFIG_COMPAT
1358 if (compat)
32a56afa 1359 return compat_import_iovec(rw,
8bc92afc 1360 (struct compat_iovec __user *)buf,
32a56afa 1361 len, UIO_FASTIOV, iovec, iter);
9d85cba7 1362#endif
32a56afa
AV
1363 return import_iovec(rw, (struct iovec __user *)buf,
1364 len, UIO_FASTIOV, iovec, iter);
eed4e51f
BP
1365}
1366
1da177e4 1367/*
2be4e7de
GZ
1368 * aio_run_iocb:
1369 * Performs the initial checks and io submission.
1da177e4 1370 */
8bc92afc 1371static ssize_t aio_run_iocb(struct kiocb *req, unsigned opcode,
66ee59af 1372 char __user *buf, size_t len, bool compat)
1da177e4 1373{
41ef4eb8
KO
1374 struct file *file = req->ki_filp;
1375 ssize_t ret;
1376 int rw;
1377 fmode_t mode;
293bc982 1378 rw_iter_op *iter_op;
00fefb9c 1379 struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
293bc982 1380 struct iov_iter iter;
1da177e4 1381
8bc92afc 1382 switch (opcode) {
1da177e4 1383 case IOCB_CMD_PREAD:
eed4e51f 1384 case IOCB_CMD_PREADV:
41ef4eb8
KO
1385 mode = FMODE_READ;
1386 rw = READ;
293bc982 1387 iter_op = file->f_op->read_iter;
41ef4eb8
KO
1388 goto rw_common;
1389
1390 case IOCB_CMD_PWRITE:
eed4e51f 1391 case IOCB_CMD_PWRITEV:
41ef4eb8
KO
1392 mode = FMODE_WRITE;
1393 rw = WRITE;
293bc982 1394 iter_op = file->f_op->write_iter;
41ef4eb8
KO
1395 goto rw_common;
1396rw_common:
1397 if (unlikely(!(file->f_mode & mode)))
1398 return -EBADF;
1399
84363182 1400 if (!iter_op)
41ef4eb8
KO
1401 return -EINVAL;
1402
66ee59af 1403 if (opcode == IOCB_CMD_PREADV || opcode == IOCB_CMD_PWRITEV)
a96114fa
AV
1404 ret = aio_setup_vectored_rw(rw, buf, len,
1405 &iovec, compat, &iter);
32a56afa 1406 else {
d4fb392f 1407 ret = import_single_range(rw, buf, len, iovec, &iter);
32a56afa
AV
1408 iovec = NULL;
1409 }
754320d6 1410 if (!ret)
a96114fa
AV
1411 ret = rw_verify_area(rw, file, &req->ki_pos,
1412 iov_iter_count(&iter));
8bc92afc 1413 if (ret < 0) {
32a56afa 1414 kfree(iovec);
41ef4eb8 1415 return ret;
8bc92afc 1416 }
41ef4eb8 1417
66ee59af 1418 len = ret;
41ef4eb8 1419
73a7075e
KO
1420 if (rw == WRITE)
1421 file_start_write(file);
1422
84363182 1423 ret = iter_op(req, &iter);
73a7075e
KO
1424
1425 if (rw == WRITE)
1426 file_end_write(file);
32a56afa 1427 kfree(iovec);
1da177e4 1428 break;
41ef4eb8 1429
1da177e4 1430 case IOCB_CMD_FDSYNC:
41ef4eb8
KO
1431 if (!file->f_op->aio_fsync)
1432 return -EINVAL;
1433
1434 ret = file->f_op->aio_fsync(req, 1);
1da177e4 1435 break;
41ef4eb8 1436
1da177e4 1437 case IOCB_CMD_FSYNC:
41ef4eb8
KO
1438 if (!file->f_op->aio_fsync)
1439 return -EINVAL;
1440
1441 ret = file->f_op->aio_fsync(req, 0);
1da177e4 1442 break;
41ef4eb8 1443
1da177e4 1444 default:
caf4167a 1445 pr_debug("EINVAL: no operation provided\n");
41ef4eb8 1446 return -EINVAL;
1da177e4
LT
1447 }
1448
41ef4eb8
KO
1449 if (ret != -EIOCBQUEUED) {
1450 /*
1451 * There's no easy way to restart the syscall since other AIO's
1452 * may be already running. Just fail this IO with EINTR.
1453 */
1454 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
1455 ret == -ERESTARTNOHAND ||
1456 ret == -ERESTART_RESTARTBLOCK))
1457 ret = -EINTR;
1458 aio_complete(req, ret, 0);
1459 }
1da177e4
LT
1460
1461 return 0;
1462}
1463
d5470b59 1464static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
a1c8eae7 1465 struct iocb *iocb, bool compat)
1da177e4 1466{
04b2fa9f 1467 struct aio_kiocb *req;
1da177e4
LT
1468 ssize_t ret;
1469
1470 /* enforce forwards compatibility on users */
9c3060be 1471 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
caf4167a 1472 pr_debug("EINVAL: reserve field set\n");
1da177e4
LT
1473 return -EINVAL;
1474 }
1475
1476 /* prevent overflows */
1477 if (unlikely(
1478 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1479 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1480 ((ssize_t)iocb->aio_nbytes < 0)
1481 )) {
acd88d4e 1482 pr_debug("EINVAL: overflow check\n");
1da177e4
LT
1483 return -EINVAL;
1484 }
1485
41ef4eb8 1486 req = aio_get_req(ctx);
1d98ebfc 1487 if (unlikely(!req))
1da177e4 1488 return -EAGAIN;
1d98ebfc 1489
04b2fa9f
CH
1490 req->common.ki_filp = fget(iocb->aio_fildes);
1491 if (unlikely(!req->common.ki_filp)) {
1d98ebfc
KO
1492 ret = -EBADF;
1493 goto out_put_req;
1da177e4 1494 }
04b2fa9f
CH
1495 req->common.ki_pos = iocb->aio_offset;
1496 req->common.ki_complete = aio_complete;
1497 req->common.ki_flags = 0;
1d98ebfc 1498
9c3060be
DL
1499 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1500 /*
1501 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1502 * instance of the file* now. The file descriptor must be
1503 * an eventfd() fd, and will be signaled for each completed
1504 * event using the eventfd_signal() function.
1505 */
13389010 1506 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
801678c5 1507 if (IS_ERR(req->ki_eventfd)) {
9c3060be 1508 ret = PTR_ERR(req->ki_eventfd);
87c3a86e 1509 req->ki_eventfd = NULL;
9c3060be
DL
1510 goto out_put_req;
1511 }
04b2fa9f
CH
1512
1513 req->common.ki_flags |= IOCB_EVENTFD;
9c3060be 1514 }
1da177e4 1515
8a660890 1516 ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
1da177e4 1517 if (unlikely(ret)) {
caf4167a 1518 pr_debug("EFAULT: aio_key\n");
1da177e4
LT
1519 goto out_put_req;
1520 }
1521
04b2fa9f 1522 req->ki_user_iocb = user_iocb;
1da177e4 1523 req->ki_user_data = iocb->aio_data;
1da177e4 1524
04b2fa9f 1525 ret = aio_run_iocb(&req->common, iocb->aio_lio_opcode,
8bc92afc 1526 (char __user *)(unsigned long)iocb->aio_buf,
66ee59af 1527 iocb->aio_nbytes,
8bc92afc 1528 compat);
41003a7b 1529 if (ret)
7137c6bd 1530 goto out_put_req;
41003a7b 1531
1da177e4 1532 return 0;
1da177e4 1533out_put_req:
e1bdd5f2 1534 put_reqs_available(ctx, 1);
e34ecee2 1535 percpu_ref_put(&ctx->reqs);
57282d8f 1536 kiocb_free(req);
1da177e4
LT
1537 return ret;
1538}
1539
9d85cba7
JM
1540long do_io_submit(aio_context_t ctx_id, long nr,
1541 struct iocb __user *__user *iocbpp, bool compat)
1da177e4
LT
1542{
1543 struct kioctx *ctx;
1544 long ret = 0;
080d676d 1545 int i = 0;
9f5b9425 1546 struct blk_plug plug;
1da177e4
LT
1547
1548 if (unlikely(nr < 0))
1549 return -EINVAL;
1550
75e1c70f
JM
1551 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1552 nr = LONG_MAX/sizeof(*iocbpp);
1553
1da177e4
LT
1554 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1555 return -EFAULT;
1556
1557 ctx = lookup_ioctx(ctx_id);
1558 if (unlikely(!ctx)) {
caf4167a 1559 pr_debug("EINVAL: invalid context id\n");
1da177e4
LT
1560 return -EINVAL;
1561 }
1562
9f5b9425
SL
1563 blk_start_plug(&plug);
1564
1da177e4
LT
1565 /*
1566 * AKPM: should this return a partial result if some of the IOs were
1567 * successfully submitted?
1568 */
1569 for (i=0; i<nr; i++) {
1570 struct iocb __user *user_iocb;
1571 struct iocb tmp;
1572
1573 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1574 ret = -EFAULT;
1575 break;
1576 }
1577
1578 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1579 ret = -EFAULT;
1580 break;
1581 }
1582
a1c8eae7 1583 ret = io_submit_one(ctx, user_iocb, &tmp, compat);
1da177e4
LT
1584 if (ret)
1585 break;
1586 }
9f5b9425 1587 blk_finish_plug(&plug);
1da177e4 1588
723be6e3 1589 percpu_ref_put(&ctx->users);
1da177e4
LT
1590 return i ? i : ret;
1591}
1592
9d85cba7
JM
1593/* sys_io_submit:
1594 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1595 * the number of iocbs queued. May return -EINVAL if the aio_context
1596 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1597 * *iocbpp[0] is not properly initialized, if the operation specified
1598 * is invalid for the file descriptor in the iocb. May fail with
1599 * -EFAULT if any of the data structures point to invalid data. May
1600 * fail with -EBADF if the file descriptor specified in the first
1601 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1602 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1603 * fail with -ENOSYS if not implemented.
1604 */
1605SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1606 struct iocb __user * __user *, iocbpp)
1607{
1608 return do_io_submit(ctx_id, nr, iocbpp, 0);
1609}
1610
1da177e4
LT
1611/* lookup_kiocb
1612 * Finds a given iocb for cancellation.
1da177e4 1613 */
04b2fa9f
CH
1614static struct aio_kiocb *
1615lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb, u32 key)
1da177e4 1616{
04b2fa9f 1617 struct aio_kiocb *kiocb;
d00689af
ZB
1618
1619 assert_spin_locked(&ctx->ctx_lock);
1620
8a660890
KO
1621 if (key != KIOCB_KEY)
1622 return NULL;
1623
1da177e4 1624 /* TODO: use a hash or array, this sucks. */
04b2fa9f
CH
1625 list_for_each_entry(kiocb, &ctx->active_reqs, ki_list) {
1626 if (kiocb->ki_user_iocb == iocb)
1da177e4
LT
1627 return kiocb;
1628 }
1629 return NULL;
1630}
1631
1632/* sys_io_cancel:
1633 * Attempts to cancel an iocb previously passed to io_submit. If
1634 * the operation is successfully cancelled, the resulting event is
1635 * copied into the memory pointed to by result without being placed
1636 * into the completion queue and 0 is returned. May fail with
1637 * -EFAULT if any of the data structures pointed to are invalid.
1638 * May fail with -EINVAL if aio_context specified by ctx_id is
1639 * invalid. May fail with -EAGAIN if the iocb specified was not
1640 * cancelled. Will fail with -ENOSYS if not implemented.
1641 */
002c8976
HC
1642SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1643 struct io_event __user *, result)
1da177e4 1644{
1da177e4 1645 struct kioctx *ctx;
04b2fa9f 1646 struct aio_kiocb *kiocb;
1da177e4
LT
1647 u32 key;
1648 int ret;
1649
1650 ret = get_user(key, &iocb->aio_key);
1651 if (unlikely(ret))
1652 return -EFAULT;
1653
1654 ctx = lookup_ioctx(ctx_id);
1655 if (unlikely(!ctx))
1656 return -EINVAL;
1657
1658 spin_lock_irq(&ctx->ctx_lock);
906b973c 1659
1da177e4 1660 kiocb = lookup_kiocb(ctx, iocb, key);
906b973c 1661 if (kiocb)
d52a8f9e 1662 ret = kiocb_cancel(kiocb);
906b973c
KO
1663 else
1664 ret = -EINVAL;
1665
1da177e4
LT
1666 spin_unlock_irq(&ctx->ctx_lock);
1667
906b973c 1668 if (!ret) {
bec68faa
KO
1669 /*
1670 * The result argument is no longer used - the io_event is
1671 * always delivered via the ring buffer. -EINPROGRESS indicates
1672 * cancellation is progress:
906b973c 1673 */
bec68faa 1674 ret = -EINPROGRESS;
906b973c 1675 }
1da177e4 1676
723be6e3 1677 percpu_ref_put(&ctx->users);
1da177e4
LT
1678
1679 return ret;
1680}
1681
1682/* io_getevents:
1683 * Attempts to read at least min_nr events and up to nr events from
642b5123
ST
1684 * the completion queue for the aio_context specified by ctx_id. If
1685 * it succeeds, the number of read events is returned. May fail with
1686 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1687 * out of range, if timeout is out of range. May fail with -EFAULT
1688 * if any of the memory specified is invalid. May return 0 or
1689 * < min_nr if the timeout specified by timeout has elapsed
1690 * before sufficient events are available, where timeout == NULL
1691 * specifies an infinite timeout. Note that the timeout pointed to by
6900807c 1692 * timeout is relative. Will fail with -ENOSYS if not implemented.
1da177e4 1693 */
002c8976
HC
1694SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1695 long, min_nr,
1696 long, nr,
1697 struct io_event __user *, events,
1698 struct timespec __user *, timeout)
1da177e4
LT
1699{
1700 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1701 long ret = -EINVAL;
1702
1703 if (likely(ioctx)) {
2e410255 1704 if (likely(min_nr <= nr && min_nr >= 0))
1da177e4 1705 ret = read_events(ioctx, min_nr, nr, events, timeout);
723be6e3 1706 percpu_ref_put(&ioctx->users);
1da177e4 1707 }
1da177e4
LT
1708 return ret;
1709}
This page took 0.897158 seconds and 5 git commands to generate.