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