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