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