]> git.karo-electronics.de Git - karo-tx-linux.git/blob - fs/aio.c
aio: use cancellation list lazily
[karo-tx-linux.git] / fs / aio.c
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  */
11 #define pr_fmt(fmt) "%s: " fmt, __func__
12
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>
18 #include <linux/export.h>
19 #include <linux/syscalls.h>
20 #include <linux/backing-dev.h>
21 #include <linux/uio.h>
22
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>
28 #include <linux/mmu_context.h>
29 #include <linux/slab.h>
30 #include <linux/timer.h>
31 #include <linux/aio.h>
32 #include <linux/highmem.h>
33 #include <linux/workqueue.h>
34 #include <linux/security.h>
35 #include <linux/eventfd.h>
36 #include <linux/blkdev.h>
37 #include <linux/compat.h>
38
39 #include <asm/kmap_types.h>
40 #include <asm/uaccess.h>
41
42 #define AIO_RING_MAGIC                  0xa10a10a1
43 #define AIO_RING_COMPAT_FEATURES        1
44 #define AIO_RING_INCOMPAT_FEATURES      0
45 struct aio_ring {
46         unsigned        id;     /* kernel internal index number */
47         unsigned        nr;     /* number of io_events */
48         unsigned        head;
49         unsigned        tail;
50
51         unsigned        magic;
52         unsigned        compat_features;
53         unsigned        incompat_features;
54         unsigned        header_length;  /* size of aio_ring */
55
56
57         struct io_event         io_events[0];
58 }; /* 128 bytes + ring size */
59
60 #define AIO_RING_PAGES  8
61 struct aio_ring_info {
62         unsigned long           mmap_base;
63         unsigned long           mmap_size;
64
65         struct page             **ring_pages;
66         struct mutex            ring_lock;
67         long                    nr_pages;
68
69         unsigned                nr, tail;
70
71         struct page             *internal_pages[AIO_RING_PAGES];
72 };
73
74 static inline unsigned aio_ring_avail(struct aio_ring_info *info,
75                                         struct aio_ring *ring)
76 {
77         return (ring->head + info->nr - 1 - ring->tail) % info->nr;
78 }
79
80 struct kioctx {
81         atomic_t                users;
82         atomic_t                dead;
83
84         /* This needs improving */
85         unsigned long           user_id;
86         struct hlist_node       list;
87
88         wait_queue_head_t       wait;
89
90         spinlock_t              ctx_lock;
91
92         atomic_t                reqs_active;
93         struct list_head        active_reqs;    /* used for cancellation */
94
95         /* sys_io_setup currently limits this to an unsigned int */
96         unsigned                max_reqs;
97
98         struct aio_ring_info    ring_info;
99
100         spinlock_t              completion_lock;
101
102         struct rcu_head         rcu_head;
103         struct work_struct      rcu_work;
104 };
105
106 /*------ sysctl variables----*/
107 static DEFINE_SPINLOCK(aio_nr_lock);
108 unsigned long aio_nr;           /* current system wide number of aio requests */
109 unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
110 /*----end sysctl variables---*/
111
112 static struct kmem_cache        *kiocb_cachep;
113 static struct kmem_cache        *kioctx_cachep;
114
115 /* aio_setup
116  *      Creates the slab caches used by the aio routines, panic on
117  *      failure as this is done early during the boot sequence.
118  */
119 static int __init aio_setup(void)
120 {
121         kiocb_cachep = KMEM_CACHE(kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
122         kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
123
124         pr_debug("sizeof(struct page) = %zu\n", sizeof(struct page));
125
126         return 0;
127 }
128 __initcall(aio_setup);
129
130 static void aio_free_ring(struct kioctx *ctx)
131 {
132         struct aio_ring_info *info = &ctx->ring_info;
133         long i;
134
135         for (i=0; i<info->nr_pages; i++)
136                 put_page(info->ring_pages[i]);
137
138         if (info->mmap_size) {
139                 vm_munmap(info->mmap_base, info->mmap_size);
140         }
141
142         if (info->ring_pages && info->ring_pages != info->internal_pages)
143                 kfree(info->ring_pages);
144         info->ring_pages = NULL;
145         info->nr = 0;
146 }
147
148 static int aio_setup_ring(struct kioctx *ctx)
149 {
150         struct aio_ring *ring;
151         struct aio_ring_info *info = &ctx->ring_info;
152         unsigned nr_events = ctx->max_reqs;
153         struct mm_struct *mm = current->mm;
154         unsigned long size, populate;
155         int nr_pages;
156
157         /* Compensate for the ring buffer's head/tail overlap entry */
158         nr_events += 2; /* 1 is required, 2 for good luck */
159
160         size = sizeof(struct aio_ring);
161         size += sizeof(struct io_event) * nr_events;
162         nr_pages = (size + PAGE_SIZE-1) >> PAGE_SHIFT;
163
164         if (nr_pages < 0)
165                 return -EINVAL;
166
167         nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring)) / sizeof(struct io_event);
168
169         info->nr = 0;
170         info->ring_pages = info->internal_pages;
171         if (nr_pages > AIO_RING_PAGES) {
172                 info->ring_pages = kcalloc(nr_pages, sizeof(struct page *), GFP_KERNEL);
173                 if (!info->ring_pages)
174                         return -ENOMEM;
175         }
176
177         info->mmap_size = nr_pages * PAGE_SIZE;
178         pr_debug("attempting mmap of %lu bytes\n", info->mmap_size);
179         down_write(&mm->mmap_sem);
180         info->mmap_base = do_mmap_pgoff(NULL, 0, info->mmap_size, 
181                                         PROT_READ|PROT_WRITE,
182                                         MAP_ANONYMOUS|MAP_PRIVATE, 0,
183                                         &populate);
184         if (IS_ERR((void *)info->mmap_base)) {
185                 up_write(&mm->mmap_sem);
186                 info->mmap_size = 0;
187                 aio_free_ring(ctx);
188                 return -EAGAIN;
189         }
190
191         pr_debug("mmap address: 0x%08lx\n", info->mmap_base);
192         info->nr_pages = get_user_pages(current, mm, info->mmap_base, nr_pages,
193                                         1, 0, info->ring_pages, NULL);
194         up_write(&mm->mmap_sem);
195
196         if (unlikely(info->nr_pages != nr_pages)) {
197                 aio_free_ring(ctx);
198                 return -EAGAIN;
199         }
200         if (populate)
201                 mm_populate(info->mmap_base, populate);
202
203         ctx->user_id = info->mmap_base;
204
205         info->nr = nr_events;           /* trusted copy */
206
207         ring = kmap_atomic(info->ring_pages[0]);
208         ring->nr = nr_events;   /* user copy */
209         ring->id = ctx->user_id;
210         ring->head = ring->tail = 0;
211         ring->magic = AIO_RING_MAGIC;
212         ring->compat_features = AIO_RING_COMPAT_FEATURES;
213         ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
214         ring->header_length = sizeof(struct aio_ring);
215         kunmap_atomic(ring);
216         flush_dcache_page(info->ring_pages[0]);
217
218         return 0;
219 }
220
221 #define AIO_EVENTS_PER_PAGE     (PAGE_SIZE / sizeof(struct io_event))
222 #define AIO_EVENTS_FIRST_PAGE   ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
223 #define AIO_EVENTS_OFFSET       (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
224
225 void kiocb_set_cancel_fn(struct kiocb *req, kiocb_cancel_fn *cancel)
226 {
227         if (!req->ki_list.next) {
228                 struct kioctx *ctx = req->ki_ctx;
229                 unsigned long flags;
230
231                 spin_lock_irqsave(&ctx->ctx_lock, flags);
232                 list_add(&req->ki_list, &ctx->active_reqs);
233                 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
234         }
235
236         req->ki_cancel = cancel;
237 }
238 EXPORT_SYMBOL(kiocb_set_cancel_fn);
239
240 static int kiocb_cancel(struct kioctx *ctx, struct kiocb *kiocb,
241                         struct io_event *res)
242 {
243         kiocb_cancel_fn *cancel;
244         int ret = -EINVAL;
245
246         cancel = xchg(&kiocb->ki_cancel, KIOCB_CANCELLED);
247         if (!cancel || cancel == KIOCB_CANCELLED)
248                 return ret;
249
250         atomic_inc(&kiocb->ki_users);
251         spin_unlock_irq(&ctx->ctx_lock);
252
253         memset(res, 0, sizeof(*res));
254         res->obj = (u64)(unsigned long)kiocb->ki_obj.user;
255         res->data = kiocb->ki_user_data;
256         ret = cancel(kiocb, res);
257
258         spin_lock_irq(&ctx->ctx_lock);
259
260         return ret;
261 }
262
263 static void free_ioctx_rcu(struct rcu_head *head)
264 {
265         struct kioctx *ctx = container_of(head, struct kioctx, rcu_head);
266         kmem_cache_free(kioctx_cachep, ctx);
267 }
268
269 /*
270  * When this function runs, the kioctx has been removed from the "hash table"
271  * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
272  * now it's safe to cancel any that need to be.
273  */
274 static void free_ioctx(struct kioctx *ctx)
275 {
276         struct io_event res;
277         struct kiocb *req;
278
279         spin_lock_irq(&ctx->ctx_lock);
280
281         while (!list_empty(&ctx->active_reqs)) {
282                 req = list_first_entry(&ctx->active_reqs,
283                                        struct kiocb, ki_list);
284
285                 list_del_init(&req->ki_list);
286                 kiocb_cancel(ctx, req, &res);
287         }
288
289         spin_unlock_irq(&ctx->ctx_lock);
290
291         wait_event(ctx->wait, !atomic_read(&ctx->reqs_active));
292
293         aio_free_ring(ctx);
294
295         spin_lock(&aio_nr_lock);
296         BUG_ON(aio_nr - ctx->max_reqs > aio_nr);
297         aio_nr -= ctx->max_reqs;
298         spin_unlock(&aio_nr_lock);
299
300         pr_debug("freeing %p\n", ctx);
301
302         /*
303          * Here the call_rcu() is between the wait_event() for reqs_active to
304          * hit 0, and freeing the ioctx.
305          *
306          * aio_complete() decrements reqs_active, but it has to touch the ioctx
307          * after to issue a wakeup so we use rcu.
308          */
309         call_rcu(&ctx->rcu_head, free_ioctx_rcu);
310 }
311
312 static void put_ioctx(struct kioctx *ctx)
313 {
314         if (unlikely(atomic_dec_and_test(&ctx->users)))
315                 free_ioctx(ctx);
316 }
317
318 /* ioctx_alloc
319  *      Allocates and initializes an ioctx.  Returns an ERR_PTR if it failed.
320  */
321 static struct kioctx *ioctx_alloc(unsigned nr_events)
322 {
323         struct mm_struct *mm = current->mm;
324         struct kioctx *ctx;
325         int err = -ENOMEM;
326
327         /* Prevent overflows */
328         if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
329             (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
330                 pr_debug("ENOMEM: nr_events too high\n");
331                 return ERR_PTR(-EINVAL);
332         }
333
334         if (!nr_events || (unsigned long)nr_events > aio_max_nr)
335                 return ERR_PTR(-EAGAIN);
336
337         ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
338         if (!ctx)
339                 return ERR_PTR(-ENOMEM);
340
341         ctx->max_reqs = nr_events;
342
343         atomic_set(&ctx->users, 2);
344         atomic_set(&ctx->dead, 0);
345         spin_lock_init(&ctx->ctx_lock);
346         spin_lock_init(&ctx->completion_lock);
347         mutex_init(&ctx->ring_info.ring_lock);
348         init_waitqueue_head(&ctx->wait);
349
350         INIT_LIST_HEAD(&ctx->active_reqs);
351
352         if (aio_setup_ring(ctx) < 0)
353                 goto out_freectx;
354
355         /* limit the number of system wide aios */
356         spin_lock(&aio_nr_lock);
357         if (aio_nr + nr_events > aio_max_nr ||
358             aio_nr + nr_events < aio_nr) {
359                 spin_unlock(&aio_nr_lock);
360                 goto out_cleanup;
361         }
362         aio_nr += ctx->max_reqs;
363         spin_unlock(&aio_nr_lock);
364
365         /* now link into global list. */
366         spin_lock(&mm->ioctx_lock);
367         hlist_add_head_rcu(&ctx->list, &mm->ioctx_list);
368         spin_unlock(&mm->ioctx_lock);
369
370         pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
371                 ctx, ctx->user_id, mm, ctx->ring_info.nr);
372         return ctx;
373
374 out_cleanup:
375         err = -EAGAIN;
376         aio_free_ring(ctx);
377 out_freectx:
378         kmem_cache_free(kioctx_cachep, ctx);
379         pr_debug("error allocating ioctx %d\n", err);
380         return ERR_PTR(err);
381 }
382
383 static void kill_ioctx_work(struct work_struct *work)
384 {
385         struct kioctx *ctx = container_of(work, struct kioctx, rcu_work);
386
387         wake_up_all(&ctx->wait);
388         put_ioctx(ctx);
389 }
390
391 static void kill_ioctx_rcu(struct rcu_head *head)
392 {
393         struct kioctx *ctx = container_of(head, struct kioctx, rcu_head);
394
395         INIT_WORK(&ctx->rcu_work, kill_ioctx_work);
396         schedule_work(&ctx->rcu_work);
397 }
398
399 /* kill_ioctx
400  *      Cancels all outstanding aio requests on an aio context.  Used
401  *      when the processes owning a context have all exited to encourage
402  *      the rapid destruction of the kioctx.
403  */
404 static void kill_ioctx(struct kioctx *ctx)
405 {
406         if (!atomic_xchg(&ctx->dead, 1)) {
407                 hlist_del_rcu(&ctx->list);
408                 /* Between hlist_del_rcu() and dropping the initial ref */
409                 synchronize_rcu();
410
411                 /*
412                  * We can't punt to workqueue here because put_ioctx() ->
413                  * free_ioctx() will unmap the ringbuffer, and that has to be
414                  * done in the original process's context. kill_ioctx_rcu/work()
415                  * exist for exit_aio(), as in that path free_ioctx() won't do
416                  * the unmap.
417                  */
418                 kill_ioctx_work(&ctx->rcu_work);
419         }
420 }
421
422 /* wait_on_sync_kiocb:
423  *      Waits on the given sync kiocb to complete.
424  */
425 ssize_t wait_on_sync_kiocb(struct kiocb *iocb)
426 {
427         while (atomic_read(&iocb->ki_users)) {
428                 set_current_state(TASK_UNINTERRUPTIBLE);
429                 if (!atomic_read(&iocb->ki_users))
430                         break;
431                 io_schedule();
432         }
433         __set_current_state(TASK_RUNNING);
434         return iocb->ki_user_data;
435 }
436 EXPORT_SYMBOL(wait_on_sync_kiocb);
437
438 /*
439  * exit_aio: called when the last user of mm goes away.  At this point, there is
440  * no way for any new requests to be submited or any of the io_* syscalls to be
441  * called on the context.
442  *
443  * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
444  * them.
445  */
446 void exit_aio(struct mm_struct *mm)
447 {
448         struct kioctx *ctx;
449         struct hlist_node *n;
450
451         hlist_for_each_entry_safe(ctx, n, &mm->ioctx_list, list) {
452                 if (1 != atomic_read(&ctx->users))
453                         printk(KERN_DEBUG
454                                 "exit_aio:ioctx still alive: %d %d %d\n",
455                                 atomic_read(&ctx->users),
456                                 atomic_read(&ctx->dead),
457                                 atomic_read(&ctx->reqs_active));
458                 /*
459                  * We don't need to bother with munmap() here -
460                  * exit_mmap(mm) is coming and it'll unmap everything.
461                  * Since aio_free_ring() uses non-zero ->mmap_size
462                  * as indicator that it needs to unmap the area,
463                  * just set it to 0; aio_free_ring() is the only
464                  * place that uses ->mmap_size, so it's safe.
465                  */
466                 ctx->ring_info.mmap_size = 0;
467
468                 if (!atomic_xchg(&ctx->dead, 1)) {
469                         hlist_del_rcu(&ctx->list);
470                         call_rcu(&ctx->rcu_head, kill_ioctx_rcu);
471                 }
472         }
473 }
474
475 /* aio_get_req
476  *      Allocate a slot for an aio request.  Increments the ki_users count
477  * of the kioctx so that the kioctx stays around until all requests are
478  * complete.  Returns NULL if no requests are free.
479  *
480  * Returns with kiocb->ki_users set to 2.  The io submit code path holds
481  * an extra reference while submitting the i/o.
482  * This prevents races between the aio code path referencing the
483  * req (after submitting it) and aio_complete() freeing the req.
484  */
485 static struct kiocb *__aio_get_req(struct kioctx *ctx)
486 {
487         struct kiocb *req = NULL;
488
489         req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
490         if (unlikely(!req))
491                 return NULL;
492
493         atomic_set(&req->ki_users, 2);
494         req->ki_ctx = ctx;
495
496         return req;
497 }
498
499 /*
500  * struct kiocb's are allocated in batches to reduce the number of
501  * times the ctx lock is acquired and released.
502  */
503 #define KIOCB_BATCH_SIZE        32L
504 struct kiocb_batch {
505         struct list_head head;
506         long count; /* number of requests left to allocate */
507 };
508
509 static void kiocb_batch_init(struct kiocb_batch *batch, long total)
510 {
511         INIT_LIST_HEAD(&batch->head);
512         batch->count = total;
513 }
514
515 static void kiocb_batch_free(struct kioctx *ctx, struct kiocb_batch *batch)
516 {
517         struct kiocb *req, *n;
518
519         if (list_empty(&batch->head))
520                 return;
521
522         spin_lock_irq(&ctx->ctx_lock);
523         list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
524                 list_del(&req->ki_batch);
525                 kmem_cache_free(kiocb_cachep, req);
526                 atomic_dec(&ctx->reqs_active);
527         }
528         spin_unlock_irq(&ctx->ctx_lock);
529 }
530
531 /*
532  * Allocate a batch of kiocbs.  This avoids taking and dropping the
533  * context lock a lot during setup.
534  */
535 static int kiocb_batch_refill(struct kioctx *ctx, struct kiocb_batch *batch)
536 {
537         unsigned short allocated, to_alloc;
538         long avail;
539         struct kiocb *req, *n;
540         struct aio_ring *ring;
541
542         to_alloc = min(batch->count, KIOCB_BATCH_SIZE);
543         for (allocated = 0; allocated < to_alloc; allocated++) {
544                 req = __aio_get_req(ctx);
545                 if (!req)
546                         /* allocation failed, go with what we've got */
547                         break;
548                 list_add(&req->ki_batch, &batch->head);
549         }
550
551         if (allocated == 0)
552                 goto out;
553
554         spin_lock_irq(&ctx->ctx_lock);
555         ring = kmap_atomic(ctx->ring_info.ring_pages[0]);
556
557         avail = aio_ring_avail(&ctx->ring_info, ring) - atomic_read(&ctx->reqs_active);
558         BUG_ON(avail < 0);
559         if (avail < allocated) {
560                 /* Trim back the number of requests. */
561                 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
562                         list_del(&req->ki_batch);
563                         kmem_cache_free(kiocb_cachep, req);
564                         if (--allocated <= avail)
565                                 break;
566                 }
567         }
568
569         batch->count -= allocated;
570         atomic_add(allocated, &ctx->reqs_active);
571
572         kunmap_atomic(ring);
573         spin_unlock_irq(&ctx->ctx_lock);
574
575 out:
576         return allocated;
577 }
578
579 static inline struct kiocb *aio_get_req(struct kioctx *ctx,
580                                         struct kiocb_batch *batch)
581 {
582         struct kiocb *req;
583
584         if (list_empty(&batch->head))
585                 if (kiocb_batch_refill(ctx, batch) == 0)
586                         return NULL;
587         req = list_first_entry(&batch->head, struct kiocb, ki_batch);
588         list_del(&req->ki_batch);
589         return req;
590 }
591
592 static void kiocb_free(struct kiocb *req)
593 {
594         if (req->ki_filp)
595                 fput(req->ki_filp);
596         if (req->ki_eventfd != NULL)
597                 eventfd_ctx_put(req->ki_eventfd);
598         if (req->ki_dtor)
599                 req->ki_dtor(req);
600         if (req->ki_iovec != &req->ki_inline_vec)
601                 kfree(req->ki_iovec);
602         kmem_cache_free(kiocb_cachep, req);
603 }
604
605 void aio_put_req(struct kiocb *req)
606 {
607         if (atomic_dec_and_test(&req->ki_users))
608                 kiocb_free(req);
609 }
610 EXPORT_SYMBOL(aio_put_req);
611
612 static struct kioctx *lookup_ioctx(unsigned long ctx_id)
613 {
614         struct mm_struct *mm = current->mm;
615         struct kioctx *ctx, *ret = NULL;
616
617         rcu_read_lock();
618
619         hlist_for_each_entry_rcu(ctx, &mm->ioctx_list, list) {
620                 if (ctx->user_id == ctx_id){
621                         atomic_inc(&ctx->users);
622                         ret = ctx;
623                         break;
624                 }
625         }
626
627         rcu_read_unlock();
628         return ret;
629 }
630
631 /* aio_complete
632  *      Called when the io request on the given iocb is complete.
633  */
634 void aio_complete(struct kiocb *iocb, long res, long res2)
635 {
636         struct kioctx   *ctx = iocb->ki_ctx;
637         struct aio_ring_info    *info;
638         struct aio_ring *ring;
639         struct io_event *ev_page, *event;
640         unsigned long   flags;
641         unsigned tail, pos;
642
643         /*
644          * Special case handling for sync iocbs:
645          *  - events go directly into the iocb for fast handling
646          *  - the sync task with the iocb in its stack holds the single iocb
647          *    ref, no other paths have a way to get another ref
648          *  - the sync task helpfully left a reference to itself in the iocb
649          */
650         if (is_sync_kiocb(iocb)) {
651                 BUG_ON(atomic_read(&iocb->ki_users) != 1);
652                 iocb->ki_user_data = res;
653                 atomic_set(&iocb->ki_users, 0);
654                 wake_up_process(iocb->ki_obj.tsk);
655                 return;
656         }
657
658         info = &ctx->ring_info;
659
660         /*
661          * Take rcu_read_lock() in case the kioctx is being destroyed, as we
662          * need to issue a wakeup after decrementing reqs_active.
663          */
664         rcu_read_lock();
665
666         if (iocb->ki_list.next) {
667                 unsigned long flags;
668
669                 spin_lock_irqsave(&ctx->ctx_lock, flags);
670                 list_del(&iocb->ki_list);
671                 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
672         }
673
674         /*
675          * cancelled requests don't get events, userland was given one
676          * when the event got cancelled.
677          */
678         if (unlikely(xchg(&iocb->ki_cancel,
679                           KIOCB_CANCELLED) == KIOCB_CANCELLED))
680                 goto put_rq;
681
682         /*
683          * Add a completion event to the ring buffer. Must be done holding
684          * ctx->ctx_lock to prevent other code from messing with the tail
685          * pointer since we might be called from irq context.
686          */
687         spin_lock_irqsave(&ctx->completion_lock, flags);
688
689         tail = info->tail;
690         pos = tail + AIO_EVENTS_OFFSET;
691
692         if (++tail >= info->nr)
693                 tail = 0;
694
695         ev_page = kmap_atomic(info->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
696         event = ev_page + pos % AIO_EVENTS_PER_PAGE;
697
698         event->obj = (u64)(unsigned long)iocb->ki_obj.user;
699         event->data = iocb->ki_user_data;
700         event->res = res;
701         event->res2 = res2;
702
703         kunmap_atomic(ev_page);
704         flush_dcache_page(info->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
705
706         pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
707                  ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
708                  res, res2);
709
710         /* after flagging the request as done, we
711          * must never even look at it again
712          */
713         smp_wmb();      /* make event visible before updating tail */
714
715         info->tail = tail;
716
717         ring = kmap_atomic(info->ring_pages[0]);
718         ring->tail = tail;
719         kunmap_atomic(ring);
720         flush_dcache_page(info->ring_pages[0]);
721
722         spin_unlock_irqrestore(&ctx->completion_lock, flags);
723
724         pr_debug("added to ring %p at [%u]\n", iocb, tail);
725
726         /*
727          * Check if the user asked us to deliver the result through an
728          * eventfd. The eventfd_signal() function is safe to be called
729          * from IRQ context.
730          */
731         if (iocb->ki_eventfd != NULL)
732                 eventfd_signal(iocb->ki_eventfd, 1);
733
734 put_rq:
735         /* everything turned out well, dispose of the aiocb. */
736         aio_put_req(iocb);
737         atomic_dec(&ctx->reqs_active);
738
739         /*
740          * We have to order our ring_info tail store above and test
741          * of the wait list below outside the wait lock.  This is
742          * like in wake_up_bit() where clearing a bit has to be
743          * ordered with the unlocked test.
744          */
745         smp_mb();
746
747         if (waitqueue_active(&ctx->wait))
748                 wake_up(&ctx->wait);
749
750         rcu_read_unlock();
751 }
752 EXPORT_SYMBOL(aio_complete);
753
754 /* aio_read_events
755  *      Pull an event off of the ioctx's event ring.  Returns the number of
756  *      events fetched
757  */
758 static int aio_read_events_ring(struct kioctx *ctx,
759                                 struct io_event __user *event, long nr)
760 {
761         struct aio_ring_info *info = &ctx->ring_info;
762         struct aio_ring *ring;
763         unsigned head, pos;
764         int ret = 0, copy_ret;
765
766         if (!mutex_trylock(&info->ring_lock)) {
767                 __set_current_state(TASK_RUNNING);
768                 mutex_lock(&info->ring_lock);
769         }
770
771         ring = kmap_atomic(info->ring_pages[0]);
772         head = ring->head;
773         kunmap_atomic(ring);
774
775         pr_debug("h%u t%u m%u\n", head, info->tail, info->nr);
776
777         if (head == info->tail)
778                 goto out;
779
780         __set_current_state(TASK_RUNNING);
781
782         while (ret < nr) {
783                 unsigned i = (head < info->tail ? info->tail : info->nr) - head;
784                 struct io_event *ev;
785                 struct page *page;
786
787                 if (head == info->tail)
788                         break;
789
790                 i = min_t(int, i, nr - ret);
791                 i = min_t(int, i, AIO_EVENTS_PER_PAGE -
792                           ((head + AIO_EVENTS_OFFSET) % AIO_EVENTS_PER_PAGE));
793
794                 pos = head + AIO_EVENTS_OFFSET;
795                 page = info->ring_pages[pos / AIO_EVENTS_PER_PAGE];
796                 pos %= AIO_EVENTS_PER_PAGE;
797
798                 ev = kmap(page);
799                 copy_ret = copy_to_user(event + ret, ev + pos, sizeof(*ev) * i);
800                 kunmap(page);
801
802                 if (unlikely(copy_ret)) {
803                         ret = -EFAULT;
804                         goto out;
805                 }
806
807                 ret += i;
808                 head += i;
809                 head %= info->nr;
810         }
811
812         ring = kmap_atomic(info->ring_pages[0]);
813         ring->head = head;
814         kunmap_atomic(ring);
815         flush_dcache_page(info->ring_pages[0]);
816
817         pr_debug("%d  h%u t%u\n", ret, head, info->tail);
818 out:
819         mutex_unlock(&info->ring_lock);
820
821         return ret;
822 }
823
824 static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
825                             struct io_event __user *event, long *i)
826 {
827         long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
828
829         if (ret > 0)
830                 *i += ret;
831
832         if (unlikely(atomic_read(&ctx->dead)))
833                 ret = -EINVAL;
834
835         if (!*i)
836                 *i = ret;
837
838         return ret < 0 || *i >= min_nr;
839 }
840
841 static long read_events(struct kioctx *ctx, long min_nr, long nr,
842                         struct io_event __user *event,
843                         struct timespec __user *timeout)
844 {
845         ktime_t until = { .tv64 = KTIME_MAX };
846         long ret = 0;
847
848         if (timeout) {
849                 struct timespec ts;
850
851                 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
852                         return -EFAULT;
853
854                 until = timespec_to_ktime(ts);
855         }
856
857         wait_event_interruptible_hrtimeout(ctx->wait,
858                         aio_read_events(ctx, min_nr, nr, event, &ret), until);
859
860         if (!ret && signal_pending(current))
861                 ret = -EINTR;
862
863         return ret;
864 }
865
866 /* sys_io_setup:
867  *      Create an aio_context capable of receiving at least nr_events.
868  *      ctxp must not point to an aio_context that already exists, and
869  *      must be initialized to 0 prior to the call.  On successful
870  *      creation of the aio_context, *ctxp is filled in with the resulting 
871  *      handle.  May fail with -EINVAL if *ctxp is not initialized,
872  *      if the specified nr_events exceeds internal limits.  May fail 
873  *      with -EAGAIN if the specified nr_events exceeds the user's limit 
874  *      of available events.  May fail with -ENOMEM if insufficient kernel
875  *      resources are available.  May fail with -EFAULT if an invalid
876  *      pointer is passed for ctxp.  Will fail with -ENOSYS if not
877  *      implemented.
878  */
879 SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
880 {
881         struct kioctx *ioctx = NULL;
882         unsigned long ctx;
883         long ret;
884
885         ret = get_user(ctx, ctxp);
886         if (unlikely(ret))
887                 goto out;
888
889         ret = -EINVAL;
890         if (unlikely(ctx || nr_events == 0)) {
891                 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
892                          ctx, nr_events);
893                 goto out;
894         }
895
896         ioctx = ioctx_alloc(nr_events);
897         ret = PTR_ERR(ioctx);
898         if (!IS_ERR(ioctx)) {
899                 ret = put_user(ioctx->user_id, ctxp);
900                 if (ret)
901                         kill_ioctx(ioctx);
902                 put_ioctx(ioctx);
903         }
904
905 out:
906         return ret;
907 }
908
909 /* sys_io_destroy:
910  *      Destroy the aio_context specified.  May cancel any outstanding 
911  *      AIOs and block on completion.  Will fail with -ENOSYS if not
912  *      implemented.  May fail with -EINVAL if the context pointed to
913  *      is invalid.
914  */
915 SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
916 {
917         struct kioctx *ioctx = lookup_ioctx(ctx);
918         if (likely(NULL != ioctx)) {
919                 kill_ioctx(ioctx);
920                 put_ioctx(ioctx);
921                 return 0;
922         }
923         pr_debug("EINVAL: io_destroy: invalid context id\n");
924         return -EINVAL;
925 }
926
927 static void aio_advance_iovec(struct kiocb *iocb, ssize_t ret)
928 {
929         struct iovec *iov = &iocb->ki_iovec[iocb->ki_cur_seg];
930
931         BUG_ON(ret <= 0);
932
933         while (iocb->ki_cur_seg < iocb->ki_nr_segs && ret > 0) {
934                 ssize_t this = min((ssize_t)iov->iov_len, ret);
935                 iov->iov_base += this;
936                 iov->iov_len -= this;
937                 iocb->ki_left -= this;
938                 ret -= this;
939                 if (iov->iov_len == 0) {
940                         iocb->ki_cur_seg++;
941                         iov++;
942                 }
943         }
944
945         /* the caller should not have done more io than what fit in
946          * the remaining iovecs */
947         BUG_ON(ret > 0 && iocb->ki_left == 0);
948 }
949
950 static ssize_t aio_rw_vect_retry(struct kiocb *iocb)
951 {
952         struct file *file = iocb->ki_filp;
953         struct address_space *mapping = file->f_mapping;
954         struct inode *inode = mapping->host;
955         ssize_t (*rw_op)(struct kiocb *, const struct iovec *,
956                          unsigned long, loff_t);
957         ssize_t ret = 0;
958         unsigned short opcode;
959
960         if ((iocb->ki_opcode == IOCB_CMD_PREADV) ||
961                 (iocb->ki_opcode == IOCB_CMD_PREAD)) {
962                 rw_op = file->f_op->aio_read;
963                 opcode = IOCB_CMD_PREADV;
964         } else {
965                 rw_op = file->f_op->aio_write;
966                 opcode = IOCB_CMD_PWRITEV;
967         }
968
969         /* This matches the pread()/pwrite() logic */
970         if (iocb->ki_pos < 0)
971                 return -EINVAL;
972
973         do {
974                 ret = rw_op(iocb, &iocb->ki_iovec[iocb->ki_cur_seg],
975                             iocb->ki_nr_segs - iocb->ki_cur_seg,
976                             iocb->ki_pos);
977                 if (ret > 0)
978                         aio_advance_iovec(iocb, ret);
979
980         /* retry all partial writes.  retry partial reads as long as its a
981          * regular file. */
982         } while (ret > 0 && iocb->ki_left > 0 &&
983                  (opcode == IOCB_CMD_PWRITEV ||
984                   (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))));
985
986         /* This means we must have transferred all that we could */
987         /* No need to retry anymore */
988         if ((ret == 0) || (iocb->ki_left == 0))
989                 ret = iocb->ki_nbytes - iocb->ki_left;
990
991         /* If we managed to write some out we return that, rather than
992          * the eventual error. */
993         if (opcode == IOCB_CMD_PWRITEV
994             && ret < 0 && ret != -EIOCBQUEUED
995             && iocb->ki_nbytes - iocb->ki_left)
996                 ret = iocb->ki_nbytes - iocb->ki_left;
997
998         return ret;
999 }
1000
1001 static ssize_t aio_fdsync(struct kiocb *iocb)
1002 {
1003         struct file *file = iocb->ki_filp;
1004         ssize_t ret = -EINVAL;
1005
1006         if (file->f_op->aio_fsync)
1007                 ret = file->f_op->aio_fsync(iocb, 1);
1008         return ret;
1009 }
1010
1011 static ssize_t aio_fsync(struct kiocb *iocb)
1012 {
1013         struct file *file = iocb->ki_filp;
1014         ssize_t ret = -EINVAL;
1015
1016         if (file->f_op->aio_fsync)
1017                 ret = file->f_op->aio_fsync(iocb, 0);
1018         return ret;
1019 }
1020
1021 static ssize_t aio_setup_vectored_rw(int type, struct kiocb *kiocb, bool compat)
1022 {
1023         ssize_t ret;
1024
1025 #ifdef CONFIG_COMPAT
1026         if (compat)
1027                 ret = compat_rw_copy_check_uvector(type,
1028                                 (struct compat_iovec __user *)kiocb->ki_buf,
1029                                 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
1030                                 &kiocb->ki_iovec);
1031         else
1032 #endif
1033                 ret = rw_copy_check_uvector(type,
1034                                 (struct iovec __user *)kiocb->ki_buf,
1035                                 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
1036                                 &kiocb->ki_iovec);
1037         if (ret < 0)
1038                 goto out;
1039
1040         ret = rw_verify_area(type, kiocb->ki_filp, &kiocb->ki_pos, ret);
1041         if (ret < 0)
1042                 goto out;
1043
1044         kiocb->ki_nr_segs = kiocb->ki_nbytes;
1045         kiocb->ki_cur_seg = 0;
1046         /* ki_nbytes/left now reflect bytes instead of segs */
1047         kiocb->ki_nbytes = ret;
1048         kiocb->ki_left = ret;
1049
1050         ret = 0;
1051 out:
1052         return ret;
1053 }
1054
1055 static ssize_t aio_setup_single_vector(int type, struct file * file, struct kiocb *kiocb)
1056 {
1057         int bytes;
1058
1059         bytes = rw_verify_area(type, file, &kiocb->ki_pos, kiocb->ki_left);
1060         if (bytes < 0)
1061                 return bytes;
1062
1063         kiocb->ki_iovec = &kiocb->ki_inline_vec;
1064         kiocb->ki_iovec->iov_base = kiocb->ki_buf;
1065         kiocb->ki_iovec->iov_len = bytes;
1066         kiocb->ki_nr_segs = 1;
1067         kiocb->ki_cur_seg = 0;
1068         return 0;
1069 }
1070
1071 /*
1072  * aio_setup_iocb:
1073  *      Performs the initial checks and aio retry method
1074  *      setup for the kiocb at the time of io submission.
1075  */
1076 static ssize_t aio_setup_iocb(struct kiocb *kiocb, bool compat)
1077 {
1078         struct file *file = kiocb->ki_filp;
1079         ssize_t ret = 0;
1080
1081         switch (kiocb->ki_opcode) {
1082         case IOCB_CMD_PREAD:
1083                 ret = -EBADF;
1084                 if (unlikely(!(file->f_mode & FMODE_READ)))
1085                         break;
1086                 ret = -EFAULT;
1087                 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1088                         kiocb->ki_left)))
1089                         break;
1090                 ret = aio_setup_single_vector(READ, file, kiocb);
1091                 if (ret)
1092                         break;
1093                 ret = -EINVAL;
1094                 if (file->f_op->aio_read)
1095                         kiocb->ki_retry = aio_rw_vect_retry;
1096                 break;
1097         case IOCB_CMD_PWRITE:
1098                 ret = -EBADF;
1099                 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1100                         break;
1101                 ret = -EFAULT;
1102                 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1103                         kiocb->ki_left)))
1104                         break;
1105                 ret = aio_setup_single_vector(WRITE, file, kiocb);
1106                 if (ret)
1107                         break;
1108                 ret = -EINVAL;
1109                 if (file->f_op->aio_write)
1110                         kiocb->ki_retry = aio_rw_vect_retry;
1111                 break;
1112         case IOCB_CMD_PREADV:
1113                 ret = -EBADF;
1114                 if (unlikely(!(file->f_mode & FMODE_READ)))
1115                         break;
1116                 ret = aio_setup_vectored_rw(READ, kiocb, compat);
1117                 if (ret)
1118                         break;
1119                 ret = -EINVAL;
1120                 if (file->f_op->aio_read)
1121                         kiocb->ki_retry = aio_rw_vect_retry;
1122                 break;
1123         case IOCB_CMD_PWRITEV:
1124                 ret = -EBADF;
1125                 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1126                         break;
1127                 ret = aio_setup_vectored_rw(WRITE, kiocb, compat);
1128                 if (ret)
1129                         break;
1130                 ret = -EINVAL;
1131                 if (file->f_op->aio_write)
1132                         kiocb->ki_retry = aio_rw_vect_retry;
1133                 break;
1134         case IOCB_CMD_FDSYNC:
1135                 ret = -EINVAL;
1136                 if (file->f_op->aio_fsync)
1137                         kiocb->ki_retry = aio_fdsync;
1138                 break;
1139         case IOCB_CMD_FSYNC:
1140                 ret = -EINVAL;
1141                 if (file->f_op->aio_fsync)
1142                         kiocb->ki_retry = aio_fsync;
1143                 break;
1144         default:
1145                 pr_debug("EINVAL: no operation provided\n");
1146                 ret = -EINVAL;
1147         }
1148
1149         if (!kiocb->ki_retry)
1150                 return ret;
1151
1152         return 0;
1153 }
1154
1155 static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
1156                          struct iocb *iocb, struct kiocb_batch *batch,
1157                          bool compat)
1158 {
1159         struct kiocb *req;
1160         ssize_t ret;
1161
1162         /* enforce forwards compatibility on users */
1163         if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
1164                 pr_debug("EINVAL: reserve field set\n");
1165                 return -EINVAL;
1166         }
1167
1168         /* prevent overflows */
1169         if (unlikely(
1170             (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1171             (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1172             ((ssize_t)iocb->aio_nbytes < 0)
1173            )) {
1174                 pr_debug("EINVAL: io_submit: overflow check\n");
1175                 return -EINVAL;
1176         }
1177
1178         req = aio_get_req(ctx, batch);  /* returns with 2 references to req */
1179         if (unlikely(!req))
1180                 return -EAGAIN;
1181
1182         req->ki_filp = fget(iocb->aio_fildes);
1183         if (unlikely(!req->ki_filp)) {
1184                 ret = -EBADF;
1185                 goto out_put_req;
1186         }
1187
1188         if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1189                 /*
1190                  * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1191                  * instance of the file* now. The file descriptor must be
1192                  * an eventfd() fd, and will be signaled for each completed
1193                  * event using the eventfd_signal() function.
1194                  */
1195                 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
1196                 if (IS_ERR(req->ki_eventfd)) {
1197                         ret = PTR_ERR(req->ki_eventfd);
1198                         req->ki_eventfd = NULL;
1199                         goto out_put_req;
1200                 }
1201         }
1202
1203         ret = put_user(req->ki_key, &user_iocb->aio_key);
1204         if (unlikely(ret)) {
1205                 pr_debug("EFAULT: aio_key\n");
1206                 goto out_put_req;
1207         }
1208
1209         req->ki_obj.user = user_iocb;
1210         req->ki_user_data = iocb->aio_data;
1211         req->ki_pos = iocb->aio_offset;
1212
1213         req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1214         req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1215         req->ki_opcode = iocb->aio_lio_opcode;
1216
1217         ret = aio_setup_iocb(req, compat);
1218         if (ret)
1219                 goto out_put_req;
1220
1221         ret = req->ki_retry(req);
1222         if (ret != -EIOCBQUEUED) {
1223                 /*
1224                  * There's no easy way to restart the syscall since other AIO's
1225                  * may be already running. Just fail this IO with EINTR.
1226                  */
1227                 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
1228                              ret == -ERESTARTNOHAND || ret == -ERESTART_RESTARTBLOCK))
1229                         ret = -EINTR;
1230                 aio_complete(req, ret, 0);
1231         }
1232
1233         aio_put_req(req);       /* drop extra ref to req */
1234         return 0;
1235
1236 out_put_req:
1237         atomic_dec(&ctx->reqs_active);
1238         aio_put_req(req);       /* drop extra ref to req */
1239         aio_put_req(req);       /* drop i/o ref to req */
1240         return ret;
1241 }
1242
1243 long do_io_submit(aio_context_t ctx_id, long nr,
1244                   struct iocb __user *__user *iocbpp, bool compat)
1245 {
1246         struct kioctx *ctx;
1247         long ret = 0;
1248         int i = 0;
1249         struct blk_plug plug;
1250         struct kiocb_batch batch;
1251
1252         if (unlikely(nr < 0))
1253                 return -EINVAL;
1254
1255         if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1256                 nr = LONG_MAX/sizeof(*iocbpp);
1257
1258         if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1259                 return -EFAULT;
1260
1261         ctx = lookup_ioctx(ctx_id);
1262         if (unlikely(!ctx)) {
1263                 pr_debug("EINVAL: invalid context id\n");
1264                 return -EINVAL;
1265         }
1266
1267         kiocb_batch_init(&batch, nr);
1268
1269         blk_start_plug(&plug);
1270
1271         /*
1272          * AKPM: should this return a partial result if some of the IOs were
1273          * successfully submitted?
1274          */
1275         for (i=0; i<nr; i++) {
1276                 struct iocb __user *user_iocb;
1277                 struct iocb tmp;
1278
1279                 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1280                         ret = -EFAULT;
1281                         break;
1282                 }
1283
1284                 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1285                         ret = -EFAULT;
1286                         break;
1287                 }
1288
1289                 ret = io_submit_one(ctx, user_iocb, &tmp, &batch, compat);
1290                 if (ret)
1291                         break;
1292         }
1293         blk_finish_plug(&plug);
1294
1295         kiocb_batch_free(ctx, &batch);
1296         put_ioctx(ctx);
1297         return i ? i : ret;
1298 }
1299
1300 /* sys_io_submit:
1301  *      Queue the nr iocbs pointed to by iocbpp for processing.  Returns
1302  *      the number of iocbs queued.  May return -EINVAL if the aio_context
1303  *      specified by ctx_id is invalid, if nr is < 0, if the iocb at
1304  *      *iocbpp[0] is not properly initialized, if the operation specified
1305  *      is invalid for the file descriptor in the iocb.  May fail with
1306  *      -EFAULT if any of the data structures point to invalid data.  May
1307  *      fail with -EBADF if the file descriptor specified in the first
1308  *      iocb is invalid.  May fail with -EAGAIN if insufficient resources
1309  *      are available to queue any iocbs.  Will return 0 if nr is 0.  Will
1310  *      fail with -ENOSYS if not implemented.
1311  */
1312 SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1313                 struct iocb __user * __user *, iocbpp)
1314 {
1315         return do_io_submit(ctx_id, nr, iocbpp, 0);
1316 }
1317
1318 /* lookup_kiocb
1319  *      Finds a given iocb for cancellation.
1320  */
1321 static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1322                                   u32 key)
1323 {
1324         struct list_head *pos;
1325
1326         assert_spin_locked(&ctx->ctx_lock);
1327
1328         /* TODO: use a hash or array, this sucks. */
1329         list_for_each(pos, &ctx->active_reqs) {
1330                 struct kiocb *kiocb = list_kiocb(pos);
1331                 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1332                         return kiocb;
1333         }
1334         return NULL;
1335 }
1336
1337 /* sys_io_cancel:
1338  *      Attempts to cancel an iocb previously passed to io_submit.  If
1339  *      the operation is successfully cancelled, the resulting event is
1340  *      copied into the memory pointed to by result without being placed
1341  *      into the completion queue and 0 is returned.  May fail with
1342  *      -EFAULT if any of the data structures pointed to are invalid.
1343  *      May fail with -EINVAL if aio_context specified by ctx_id is
1344  *      invalid.  May fail with -EAGAIN if the iocb specified was not
1345  *      cancelled.  Will fail with -ENOSYS if not implemented.
1346  */
1347 SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1348                 struct io_event __user *, result)
1349 {
1350         struct io_event res;
1351         struct kioctx *ctx;
1352         struct kiocb *kiocb;
1353         u32 key;
1354         int ret;
1355
1356         ret = get_user(key, &iocb->aio_key);
1357         if (unlikely(ret))
1358                 return -EFAULT;
1359
1360         ctx = lookup_ioctx(ctx_id);
1361         if (unlikely(!ctx))
1362                 return -EINVAL;
1363
1364         spin_lock_irq(&ctx->ctx_lock);
1365
1366         kiocb = lookup_kiocb(ctx, iocb, key);
1367         if (kiocb)
1368                 ret = kiocb_cancel(ctx, kiocb, &res);
1369         else
1370                 ret = -EINVAL;
1371
1372         spin_unlock_irq(&ctx->ctx_lock);
1373
1374         if (!ret) {
1375                 /* Cancellation succeeded -- copy the result
1376                  * into the user's buffer.
1377                  */
1378                 if (copy_to_user(result, &res, sizeof(res)))
1379                         ret = -EFAULT;
1380         }
1381
1382         put_ioctx(ctx);
1383
1384         return ret;
1385 }
1386
1387 /* io_getevents:
1388  *      Attempts to read at least min_nr events and up to nr events from
1389  *      the completion queue for the aio_context specified by ctx_id. If
1390  *      it succeeds, the number of read events is returned. May fail with
1391  *      -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1392  *      out of range, if timeout is out of range.  May fail with -EFAULT
1393  *      if any of the memory specified is invalid.  May return 0 or
1394  *      < min_nr if the timeout specified by timeout has elapsed
1395  *      before sufficient events are available, where timeout == NULL
1396  *      specifies an infinite timeout. Note that the timeout pointed to by
1397  *      timeout is relative and will be updated if not NULL and the
1398  *      operation blocks. Will fail with -ENOSYS if not implemented.
1399  */
1400 SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1401                 long, min_nr,
1402                 long, nr,
1403                 struct io_event __user *, events,
1404                 struct timespec __user *, timeout)
1405 {
1406         struct kioctx *ioctx = lookup_ioctx(ctx_id);
1407         long ret = -EINVAL;
1408
1409         if (likely(ioctx)) {
1410                 if (likely(min_nr <= nr && min_nr >= 0))
1411                         ret = read_events(ioctx, min_nr, nr, events, timeout);
1412                 put_ioctx(ioctx);
1413         }
1414         return ret;
1415 }