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