[PATCH] aio: lock around kiocbTryKick()
[safe/jmp/linux-2.6] / 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 #include <linux/kernel.h>
12 #include <linux/init.h>
13 #include <linux/errno.h>
14 #include <linux/time.h>
15 #include <linux/aio_abi.h>
16 #include <linux/module.h>
17 #include <linux/syscalls.h>
18
19 #define DEBUG 0
20
21 #include <linux/sched.h>
22 #include <linux/fs.h>
23 #include <linux/file.h>
24 #include <linux/mm.h>
25 #include <linux/mman.h>
26 #include <linux/slab.h>
27 #include <linux/timer.h>
28 #include <linux/aio.h>
29 #include <linux/highmem.h>
30 #include <linux/workqueue.h>
31 #include <linux/security.h>
32 #include <linux/rcuref.h>
33
34 #include <asm/kmap_types.h>
35 #include <asm/uaccess.h>
36 #include <asm/mmu_context.h>
37
38 #if DEBUG > 1
39 #define dprintk         printk
40 #else
41 #define dprintk(x...)   do { ; } while (0)
42 #endif
43
44 /*------ sysctl variables----*/
45 atomic_t aio_nr = ATOMIC_INIT(0);       /* current system wide number of aio requests */
46 unsigned aio_max_nr = 0x10000;  /* system wide maximum number of aio requests */
47 /*----end sysctl variables---*/
48
49 static kmem_cache_t     *kiocb_cachep;
50 static kmem_cache_t     *kioctx_cachep;
51
52 static struct workqueue_struct *aio_wq;
53
54 /* Used for rare fput completion. */
55 static void aio_fput_routine(void *);
56 static DECLARE_WORK(fput_work, aio_fput_routine, NULL);
57
58 static DEFINE_SPINLOCK(fput_lock);
59 static LIST_HEAD(fput_head);
60
61 static void aio_kick_handler(void *);
62 static void aio_queue_work(struct kioctx *);
63
64 /* aio_setup
65  *      Creates the slab caches used by the aio routines, panic on
66  *      failure as this is done early during the boot sequence.
67  */
68 static int __init aio_setup(void)
69 {
70         kiocb_cachep = kmem_cache_create("kiocb", sizeof(struct kiocb),
71                                 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL, NULL);
72         kioctx_cachep = kmem_cache_create("kioctx", sizeof(struct kioctx),
73                                 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL, NULL);
74
75         aio_wq = create_workqueue("aio");
76
77         pr_debug("aio_setup: sizeof(struct page) = %d\n", (int)sizeof(struct page));
78
79         return 0;
80 }
81
82 static void aio_free_ring(struct kioctx *ctx)
83 {
84         struct aio_ring_info *info = &ctx->ring_info;
85         long i;
86
87         for (i=0; i<info->nr_pages; i++)
88                 put_page(info->ring_pages[i]);
89
90         if (info->mmap_size) {
91                 down_write(&ctx->mm->mmap_sem);
92                 do_munmap(ctx->mm, info->mmap_base, info->mmap_size);
93                 up_write(&ctx->mm->mmap_sem);
94         }
95
96         if (info->ring_pages && info->ring_pages != info->internal_pages)
97                 kfree(info->ring_pages);
98         info->ring_pages = NULL;
99         info->nr = 0;
100 }
101
102 static int aio_setup_ring(struct kioctx *ctx)
103 {
104         struct aio_ring *ring;
105         struct aio_ring_info *info = &ctx->ring_info;
106         unsigned nr_events = ctx->max_reqs;
107         unsigned long size;
108         int nr_pages;
109
110         /* Compensate for the ring buffer's head/tail overlap entry */
111         nr_events += 2; /* 1 is required, 2 for good luck */
112
113         size = sizeof(struct aio_ring);
114         size += sizeof(struct io_event) * nr_events;
115         nr_pages = (size + PAGE_SIZE-1) >> PAGE_SHIFT;
116
117         if (nr_pages < 0)
118                 return -EINVAL;
119
120         nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring)) / sizeof(struct io_event);
121
122         info->nr = 0;
123         info->ring_pages = info->internal_pages;
124         if (nr_pages > AIO_RING_PAGES) {
125                 info->ring_pages = kmalloc(sizeof(struct page *) * nr_pages, GFP_KERNEL);
126                 if (!info->ring_pages)
127                         return -ENOMEM;
128                 memset(info->ring_pages, 0, sizeof(struct page *) * nr_pages);
129         }
130
131         info->mmap_size = nr_pages * PAGE_SIZE;
132         dprintk("attempting mmap of %lu bytes\n", info->mmap_size);
133         down_write(&ctx->mm->mmap_sem);
134         info->mmap_base = do_mmap(NULL, 0, info->mmap_size, 
135                                   PROT_READ|PROT_WRITE, MAP_ANON|MAP_PRIVATE,
136                                   0);
137         if (IS_ERR((void *)info->mmap_base)) {
138                 up_write(&ctx->mm->mmap_sem);
139                 printk("mmap err: %ld\n", -info->mmap_base);
140                 info->mmap_size = 0;
141                 aio_free_ring(ctx);
142                 return -EAGAIN;
143         }
144
145         dprintk("mmap address: 0x%08lx\n", info->mmap_base);
146         info->nr_pages = get_user_pages(current, ctx->mm,
147                                         info->mmap_base, nr_pages, 
148                                         1, 0, info->ring_pages, NULL);
149         up_write(&ctx->mm->mmap_sem);
150
151         if (unlikely(info->nr_pages != nr_pages)) {
152                 aio_free_ring(ctx);
153                 return -EAGAIN;
154         }
155
156         ctx->user_id = info->mmap_base;
157
158         info->nr = nr_events;           /* trusted copy */
159
160         ring = kmap_atomic(info->ring_pages[0], KM_USER0);
161         ring->nr = nr_events;   /* user copy */
162         ring->id = ctx->user_id;
163         ring->head = ring->tail = 0;
164         ring->magic = AIO_RING_MAGIC;
165         ring->compat_features = AIO_RING_COMPAT_FEATURES;
166         ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
167         ring->header_length = sizeof(struct aio_ring);
168         kunmap_atomic(ring, KM_USER0);
169
170         return 0;
171 }
172
173
174 /* aio_ring_event: returns a pointer to the event at the given index from
175  * kmap_atomic(, km).  Release the pointer with put_aio_ring_event();
176  */
177 #define AIO_EVENTS_PER_PAGE     (PAGE_SIZE / sizeof(struct io_event))
178 #define AIO_EVENTS_FIRST_PAGE   ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
179 #define AIO_EVENTS_OFFSET       (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
180
181 #define aio_ring_event(info, nr, km) ({                                 \
182         unsigned pos = (nr) + AIO_EVENTS_OFFSET;                        \
183         struct io_event *__event;                                       \
184         __event = kmap_atomic(                                          \
185                         (info)->ring_pages[pos / AIO_EVENTS_PER_PAGE], km); \
186         __event += pos % AIO_EVENTS_PER_PAGE;                           \
187         __event;                                                        \
188 })
189
190 #define put_aio_ring_event(event, km) do {      \
191         struct io_event *__event = (event);     \
192         (void)__event;                          \
193         kunmap_atomic((void *)((unsigned long)__event & PAGE_MASK), km); \
194 } while(0)
195
196 /* ioctx_alloc
197  *      Allocates and initializes an ioctx.  Returns an ERR_PTR if it failed.
198  */
199 static struct kioctx *ioctx_alloc(unsigned nr_events)
200 {
201         struct mm_struct *mm;
202         struct kioctx *ctx;
203
204         /* Prevent overflows */
205         if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
206             (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
207                 pr_debug("ENOMEM: nr_events too high\n");
208                 return ERR_PTR(-EINVAL);
209         }
210
211         if (nr_events > aio_max_nr)
212                 return ERR_PTR(-EAGAIN);
213
214         ctx = kmem_cache_alloc(kioctx_cachep, GFP_KERNEL);
215         if (!ctx)
216                 return ERR_PTR(-ENOMEM);
217
218         memset(ctx, 0, sizeof(*ctx));
219         ctx->max_reqs = nr_events;
220         mm = ctx->mm = current->mm;
221         atomic_inc(&mm->mm_count);
222
223         atomic_set(&ctx->users, 1);
224         spin_lock_init(&ctx->ctx_lock);
225         spin_lock_init(&ctx->ring_info.ring_lock);
226         init_waitqueue_head(&ctx->wait);
227
228         INIT_LIST_HEAD(&ctx->active_reqs);
229         INIT_LIST_HEAD(&ctx->run_list);
230         INIT_WORK(&ctx->wq, aio_kick_handler, ctx);
231
232         if (aio_setup_ring(ctx) < 0)
233                 goto out_freectx;
234
235         /* limit the number of system wide aios */
236         atomic_add(ctx->max_reqs, &aio_nr);     /* undone by __put_ioctx */
237         if (unlikely(atomic_read(&aio_nr) > aio_max_nr))
238                 goto out_cleanup;
239
240         /* now link into global list.  kludge.  FIXME */
241         write_lock(&mm->ioctx_list_lock);
242         ctx->next = mm->ioctx_list;
243         mm->ioctx_list = ctx;
244         write_unlock(&mm->ioctx_list_lock);
245
246         dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
247                 ctx, ctx->user_id, current->mm, ctx->ring_info.nr);
248         return ctx;
249
250 out_cleanup:
251         atomic_sub(ctx->max_reqs, &aio_nr);
252         ctx->max_reqs = 0;      /* prevent __put_ioctx from sub'ing aio_nr */
253         __put_ioctx(ctx);
254         return ERR_PTR(-EAGAIN);
255
256 out_freectx:
257         mmdrop(mm);
258         kmem_cache_free(kioctx_cachep, ctx);
259         ctx = ERR_PTR(-ENOMEM);
260
261         dprintk("aio: error allocating ioctx %p\n", ctx);
262         return ctx;
263 }
264
265 /* aio_cancel_all
266  *      Cancels all outstanding aio requests on an aio context.  Used 
267  *      when the processes owning a context have all exited to encourage 
268  *      the rapid destruction of the kioctx.
269  */
270 static void aio_cancel_all(struct kioctx *ctx)
271 {
272         int (*cancel)(struct kiocb *, struct io_event *);
273         struct io_event res;
274         spin_lock_irq(&ctx->ctx_lock);
275         ctx->dead = 1;
276         while (!list_empty(&ctx->active_reqs)) {
277                 struct list_head *pos = ctx->active_reqs.next;
278                 struct kiocb *iocb = list_kiocb(pos);
279                 list_del_init(&iocb->ki_list);
280                 cancel = iocb->ki_cancel;
281                 kiocbSetCancelled(iocb);
282                 if (cancel) {
283                         iocb->ki_users++;
284                         spin_unlock_irq(&ctx->ctx_lock);
285                         cancel(iocb, &res);
286                         spin_lock_irq(&ctx->ctx_lock);
287                 }
288         }
289         spin_unlock_irq(&ctx->ctx_lock);
290 }
291
292 static void wait_for_all_aios(struct kioctx *ctx)
293 {
294         struct task_struct *tsk = current;
295         DECLARE_WAITQUEUE(wait, tsk);
296
297         if (!ctx->reqs_active)
298                 return;
299
300         add_wait_queue(&ctx->wait, &wait);
301         set_task_state(tsk, TASK_UNINTERRUPTIBLE);
302         while (ctx->reqs_active) {
303                 schedule();
304                 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
305         }
306         __set_task_state(tsk, TASK_RUNNING);
307         remove_wait_queue(&ctx->wait, &wait);
308 }
309
310 /* wait_on_sync_kiocb:
311  *      Waits on the given sync kiocb to complete.
312  */
313 ssize_t fastcall wait_on_sync_kiocb(struct kiocb *iocb)
314 {
315         while (iocb->ki_users) {
316                 set_current_state(TASK_UNINTERRUPTIBLE);
317                 if (!iocb->ki_users)
318                         break;
319                 schedule();
320         }
321         __set_current_state(TASK_RUNNING);
322         return iocb->ki_user_data;
323 }
324
325 /* exit_aio: called when the last user of mm goes away.  At this point, 
326  * there is no way for any new requests to be submited or any of the 
327  * io_* syscalls to be called on the context.  However, there may be 
328  * outstanding requests which hold references to the context; as they 
329  * go away, they will call put_ioctx and release any pinned memory
330  * associated with the request (held via struct page * references).
331  */
332 void fastcall exit_aio(struct mm_struct *mm)
333 {
334         struct kioctx *ctx = mm->ioctx_list;
335         mm->ioctx_list = NULL;
336         while (ctx) {
337                 struct kioctx *next = ctx->next;
338                 ctx->next = NULL;
339                 aio_cancel_all(ctx);
340
341                 wait_for_all_aios(ctx);
342                 /*
343                  * this is an overkill, but ensures we don't leave
344                  * the ctx on the aio_wq
345                  */
346                 flush_workqueue(aio_wq);
347
348                 if (1 != atomic_read(&ctx->users))
349                         printk(KERN_DEBUG
350                                 "exit_aio:ioctx still alive: %d %d %d\n",
351                                 atomic_read(&ctx->users), ctx->dead,
352                                 ctx->reqs_active);
353                 put_ioctx(ctx);
354                 ctx = next;
355         }
356 }
357
358 /* __put_ioctx
359  *      Called when the last user of an aio context has gone away,
360  *      and the struct needs to be freed.
361  */
362 void fastcall __put_ioctx(struct kioctx *ctx)
363 {
364         unsigned nr_events = ctx->max_reqs;
365
366         if (unlikely(ctx->reqs_active))
367                 BUG();
368
369         cancel_delayed_work(&ctx->wq);
370         flush_workqueue(aio_wq);
371         aio_free_ring(ctx);
372         mmdrop(ctx->mm);
373         ctx->mm = NULL;
374         pr_debug("__put_ioctx: freeing %p\n", ctx);
375         kmem_cache_free(kioctx_cachep, ctx);
376
377         atomic_sub(nr_events, &aio_nr);
378 }
379
380 /* aio_get_req
381  *      Allocate a slot for an aio request.  Increments the users count
382  * of the kioctx so that the kioctx stays around until all requests are
383  * complete.  Returns NULL if no requests are free.
384  *
385  * Returns with kiocb->users set to 2.  The io submit code path holds
386  * an extra reference while submitting the i/o.
387  * This prevents races between the aio code path referencing the
388  * req (after submitting it) and aio_complete() freeing the req.
389  */
390 static struct kiocb *FASTCALL(__aio_get_req(struct kioctx *ctx));
391 static struct kiocb fastcall *__aio_get_req(struct kioctx *ctx)
392 {
393         struct kiocb *req = NULL;
394         struct aio_ring *ring;
395         int okay = 0;
396
397         req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
398         if (unlikely(!req))
399                 return NULL;
400
401         req->ki_flags = 1 << KIF_LOCKED;
402         req->ki_users = 2;
403         req->ki_key = 0;
404         req->ki_ctx = ctx;
405         req->ki_cancel = NULL;
406         req->ki_retry = NULL;
407         req->ki_dtor = NULL;
408         req->private = NULL;
409         INIT_LIST_HEAD(&req->ki_run_list);
410
411         /* Check if the completion queue has enough free space to
412          * accept an event from this io.
413          */
414         spin_lock_irq(&ctx->ctx_lock);
415         ring = kmap_atomic(ctx->ring_info.ring_pages[0], KM_USER0);
416         if (ctx->reqs_active < aio_ring_avail(&ctx->ring_info, ring)) {
417                 list_add(&req->ki_list, &ctx->active_reqs);
418                 get_ioctx(ctx);
419                 ctx->reqs_active++;
420                 okay = 1;
421         }
422         kunmap_atomic(ring, KM_USER0);
423         spin_unlock_irq(&ctx->ctx_lock);
424
425         if (!okay) {
426                 kmem_cache_free(kiocb_cachep, req);
427                 req = NULL;
428         }
429
430         return req;
431 }
432
433 static inline struct kiocb *aio_get_req(struct kioctx *ctx)
434 {
435         struct kiocb *req;
436         /* Handle a potential starvation case -- should be exceedingly rare as 
437          * requests will be stuck on fput_head only if the aio_fput_routine is 
438          * delayed and the requests were the last user of the struct file.
439          */
440         req = __aio_get_req(ctx);
441         if (unlikely(NULL == req)) {
442                 aio_fput_routine(NULL);
443                 req = __aio_get_req(ctx);
444         }
445         return req;
446 }
447
448 static inline void really_put_req(struct kioctx *ctx, struct kiocb *req)
449 {
450         if (req->ki_dtor)
451                 req->ki_dtor(req);
452         kmem_cache_free(kiocb_cachep, req);
453         ctx->reqs_active--;
454
455         if (unlikely(!ctx->reqs_active && ctx->dead))
456                 wake_up(&ctx->wait);
457 }
458
459 static void aio_fput_routine(void *data)
460 {
461         spin_lock_irq(&fput_lock);
462         while (likely(!list_empty(&fput_head))) {
463                 struct kiocb *req = list_kiocb(fput_head.next);
464                 struct kioctx *ctx = req->ki_ctx;
465
466                 list_del(&req->ki_list);
467                 spin_unlock_irq(&fput_lock);
468
469                 /* Complete the fput */
470                 __fput(req->ki_filp);
471
472                 /* Link the iocb into the context's free list */
473                 spin_lock_irq(&ctx->ctx_lock);
474                 really_put_req(ctx, req);
475                 spin_unlock_irq(&ctx->ctx_lock);
476
477                 put_ioctx(ctx);
478                 spin_lock_irq(&fput_lock);
479         }
480         spin_unlock_irq(&fput_lock);
481 }
482
483 /* __aio_put_req
484  *      Returns true if this put was the last user of the request.
485  */
486 static int __aio_put_req(struct kioctx *ctx, struct kiocb *req)
487 {
488         dprintk(KERN_DEBUG "aio_put(%p): f_count=%d\n",
489                 req, atomic_read(&req->ki_filp->f_count));
490
491         req->ki_users --;
492         if (unlikely(req->ki_users < 0))
493                 BUG();
494         if (likely(req->ki_users))
495                 return 0;
496         list_del(&req->ki_list);                /* remove from active_reqs */
497         req->ki_cancel = NULL;
498         req->ki_retry = NULL;
499
500         /* Must be done under the lock to serialise against cancellation.
501          * Call this aio_fput as it duplicates fput via the fput_work.
502          */
503         if (unlikely(rcuref_dec_and_test(&req->ki_filp->f_count))) {
504                 get_ioctx(ctx);
505                 spin_lock(&fput_lock);
506                 list_add(&req->ki_list, &fput_head);
507                 spin_unlock(&fput_lock);
508                 queue_work(aio_wq, &fput_work);
509         } else
510                 really_put_req(ctx, req);
511         return 1;
512 }
513
514 /* aio_put_req
515  *      Returns true if this put was the last user of the kiocb,
516  *      false if the request is still in use.
517  */
518 int fastcall aio_put_req(struct kiocb *req)
519 {
520         struct kioctx *ctx = req->ki_ctx;
521         int ret;
522         spin_lock_irq(&ctx->ctx_lock);
523         ret = __aio_put_req(ctx, req);
524         spin_unlock_irq(&ctx->ctx_lock);
525         if (ret)
526                 put_ioctx(ctx);
527         return ret;
528 }
529
530 /*      Lookup an ioctx id.  ioctx_list is lockless for reads.
531  *      FIXME: this is O(n) and is only suitable for development.
532  */
533 struct kioctx *lookup_ioctx(unsigned long ctx_id)
534 {
535         struct kioctx *ioctx;
536         struct mm_struct *mm;
537
538         mm = current->mm;
539         read_lock(&mm->ioctx_list_lock);
540         for (ioctx = mm->ioctx_list; ioctx; ioctx = ioctx->next)
541                 if (likely(ioctx->user_id == ctx_id && !ioctx->dead)) {
542                         get_ioctx(ioctx);
543                         break;
544                 }
545         read_unlock(&mm->ioctx_list_lock);
546
547         return ioctx;
548 }
549
550 static int lock_kiocb_action(void *param)
551 {
552         schedule();
553         return 0;
554 }
555
556 static inline void lock_kiocb(struct kiocb *iocb)
557 {
558         wait_on_bit_lock(&iocb->ki_flags, KIF_LOCKED, lock_kiocb_action,
559                          TASK_UNINTERRUPTIBLE);
560 }
561
562 static inline void unlock_kiocb(struct kiocb *iocb)
563 {
564         kiocbClearLocked(iocb);
565         smp_mb__after_clear_bit();
566         wake_up_bit(&iocb->ki_flags, KIF_LOCKED);
567 }
568
569 /*
570  * use_mm
571  *      Makes the calling kernel thread take on the specified
572  *      mm context.
573  *      Called by the retry thread execute retries within the
574  *      iocb issuer's mm context, so that copy_from/to_user
575  *      operations work seamlessly for aio.
576  *      (Note: this routine is intended to be called only
577  *      from a kernel thread context)
578  */
579 static void use_mm(struct mm_struct *mm)
580 {
581         struct mm_struct *active_mm;
582         struct task_struct *tsk = current;
583
584         task_lock(tsk);
585         tsk->flags |= PF_BORROWED_MM;
586         active_mm = tsk->active_mm;
587         atomic_inc(&mm->mm_count);
588         tsk->mm = mm;
589         tsk->active_mm = mm;
590         /*
591          * Note that on UML this *requires* PF_BORROWED_MM to be set, otherwise
592          * it won't work. Update it accordingly if you change it here
593          */
594         activate_mm(active_mm, mm);
595         task_unlock(tsk);
596
597         mmdrop(active_mm);
598 }
599
600 /*
601  * unuse_mm
602  *      Reverses the effect of use_mm, i.e. releases the
603  *      specified mm context which was earlier taken on
604  *      by the calling kernel thread
605  *      (Note: this routine is intended to be called only
606  *      from a kernel thread context)
607  *
608  * Comments: Called with ctx->ctx_lock held. This nests
609  * task_lock instead ctx_lock.
610  */
611 static void unuse_mm(struct mm_struct *mm)
612 {
613         struct task_struct *tsk = current;
614
615         task_lock(tsk);
616         tsk->flags &= ~PF_BORROWED_MM;
617         tsk->mm = NULL;
618         /* active_mm is still 'mm' */
619         enter_lazy_tlb(mm, tsk);
620         task_unlock(tsk);
621 }
622
623 /*
624  * Queue up a kiocb to be retried. Assumes that the kiocb
625  * has already been marked as kicked, and places it on
626  * the retry run list for the corresponding ioctx, if it
627  * isn't already queued. Returns 1 if it actually queued
628  * the kiocb (to tell the caller to activate the work
629  * queue to process it), or 0, if it found that it was
630  * already queued.
631  *
632  * Should be called with the spin lock iocb->ki_ctx->ctx_lock
633  * held
634  */
635 static inline int __queue_kicked_iocb(struct kiocb *iocb)
636 {
637         struct kioctx *ctx = iocb->ki_ctx;
638
639         if (list_empty(&iocb->ki_run_list)) {
640                 list_add_tail(&iocb->ki_run_list,
641                         &ctx->run_list);
642                 return 1;
643         }
644         return 0;
645 }
646
647 /* aio_run_iocb
648  *      This is the core aio execution routine. It is
649  *      invoked both for initial i/o submission and
650  *      subsequent retries via the aio_kick_handler.
651  *      Expects to be invoked with iocb->ki_ctx->lock
652  *      already held. The lock is released and reaquired
653  *      as needed during processing.
654  *
655  * Calls the iocb retry method (already setup for the
656  * iocb on initial submission) for operation specific
657  * handling, but takes care of most of common retry
658  * execution details for a given iocb. The retry method
659  * needs to be non-blocking as far as possible, to avoid
660  * holding up other iocbs waiting to be serviced by the
661  * retry kernel thread.
662  *
663  * The trickier parts in this code have to do with
664  * ensuring that only one retry instance is in progress
665  * for a given iocb at any time. Providing that guarantee
666  * simplifies the coding of individual aio operations as
667  * it avoids various potential races.
668  */
669 static ssize_t aio_run_iocb(struct kiocb *iocb)
670 {
671         struct kioctx   *ctx = iocb->ki_ctx;
672         ssize_t (*retry)(struct kiocb *);
673         ssize_t ret;
674
675         if (iocb->ki_retried++ > 1024*1024) {
676                 printk("Maximal retry count.  Bytes done %Zd\n",
677                         iocb->ki_nbytes - iocb->ki_left);
678                 return -EAGAIN;
679         }
680
681         if (!(iocb->ki_retried & 0xff)) {
682                 pr_debug("%ld retry: %d of %d\n", iocb->ki_retried,
683                         iocb->ki_nbytes - iocb->ki_left, iocb->ki_nbytes);
684         }
685
686         if (!(retry = iocb->ki_retry)) {
687                 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
688                 return 0;
689         }
690
691         /*
692          * We don't want the next retry iteration for this
693          * operation to start until this one has returned and
694          * updated the iocb state. However, wait_queue functions
695          * can trigger a kick_iocb from interrupt context in the
696          * meantime, indicating that data is available for the next
697          * iteration. We want to remember that and enable the
698          * next retry iteration _after_ we are through with
699          * this one.
700          *
701          * So, in order to be able to register a "kick", but
702          * prevent it from being queued now, we clear the kick
703          * flag, but make the kick code *think* that the iocb is
704          * still on the run list until we are actually done.
705          * When we are done with this iteration, we check if
706          * the iocb was kicked in the meantime and if so, queue
707          * it up afresh.
708          */
709
710         kiocbClearKicked(iocb);
711
712         /*
713          * This is so that aio_complete knows it doesn't need to
714          * pull the iocb off the run list (We can't just call
715          * INIT_LIST_HEAD because we don't want a kick_iocb to
716          * queue this on the run list yet)
717          */
718         iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
719         spin_unlock_irq(&ctx->ctx_lock);
720
721         /* Quit retrying if the i/o has been cancelled */
722         if (kiocbIsCancelled(iocb)) {
723                 ret = -EINTR;
724                 aio_complete(iocb, ret, 0);
725                 /* must not access the iocb after this */
726                 goto out;
727         }
728
729         /*
730          * Now we are all set to call the retry method in async
731          * context. By setting this thread's io_wait context
732          * to point to the wait queue entry inside the currently
733          * running iocb for the duration of the retry, we ensure
734          * that async notification wakeups are queued by the
735          * operation instead of blocking waits, and when notified,
736          * cause the iocb to be kicked for continuation (through
737          * the aio_wake_function callback).
738          */
739         BUG_ON(current->io_wait != NULL);
740         current->io_wait = &iocb->ki_wait;
741         ret = retry(iocb);
742         current->io_wait = NULL;
743
744         if (-EIOCBRETRY != ret) {
745                 if (-EIOCBQUEUED != ret) {
746                         BUG_ON(!list_empty(&iocb->ki_wait.task_list));
747                         aio_complete(iocb, ret, 0);
748                         /* must not access the iocb after this */
749                 }
750         } else {
751                 /*
752                  * Issue an additional retry to avoid waiting forever if
753                  * no waits were queued (e.g. in case of a short read).
754                  */
755                 if (list_empty(&iocb->ki_wait.task_list))
756                         kiocbSetKicked(iocb);
757         }
758 out:
759         spin_lock_irq(&ctx->ctx_lock);
760
761         if (-EIOCBRETRY == ret) {
762                 /*
763                  * OK, now that we are done with this iteration
764                  * and know that there is more left to go,
765                  * this is where we let go so that a subsequent
766                  * "kick" can start the next iteration
767                  */
768
769                 /* will make __queue_kicked_iocb succeed from here on */
770                 INIT_LIST_HEAD(&iocb->ki_run_list);
771                 /* we must queue the next iteration ourselves, if it
772                  * has already been kicked */
773                 if (kiocbIsKicked(iocb)) {
774                         __queue_kicked_iocb(iocb);
775
776                         /*
777                          * __queue_kicked_iocb will always return 1 here, because
778                          * iocb->ki_run_list is empty at this point so it should
779                          * be safe to unconditionally queue the context into the
780                          * work queue.
781                          */
782                         aio_queue_work(ctx);
783                 }
784         }
785         return ret;
786 }
787
788 /*
789  * __aio_run_iocbs:
790  *      Process all pending retries queued on the ioctx
791  *      run list.
792  * Assumes it is operating within the aio issuer's mm
793  * context. Expects to be called with ctx->ctx_lock held
794  */
795 static int __aio_run_iocbs(struct kioctx *ctx)
796 {
797         struct kiocb *iocb;
798         LIST_HEAD(run_list);
799
800         list_splice_init(&ctx->run_list, &run_list);
801         while (!list_empty(&run_list)) {
802                 iocb = list_entry(run_list.next, struct kiocb,
803                         ki_run_list);
804                 list_del(&iocb->ki_run_list);
805                 /*
806                  * Hold an extra reference while retrying i/o.
807                  */
808                 iocb->ki_users++;       /* grab extra reference */
809                 lock_kiocb(iocb);
810                 aio_run_iocb(iocb);
811                 unlock_kiocb(iocb);
812                 if (__aio_put_req(ctx, iocb))  /* drop extra ref */
813                         put_ioctx(ctx);
814         }
815         if (!list_empty(&ctx->run_list))
816                 return 1;
817         return 0;
818 }
819
820 static void aio_queue_work(struct kioctx * ctx)
821 {
822         unsigned long timeout;
823         /*
824          * if someone is waiting, get the work started right
825          * away, otherwise, use a longer delay
826          */
827         smp_mb();
828         if (waitqueue_active(&ctx->wait))
829                 timeout = 1;
830         else
831                 timeout = HZ/10;
832         queue_delayed_work(aio_wq, &ctx->wq, timeout);
833 }
834
835
836 /*
837  * aio_run_iocbs:
838  *      Process all pending retries queued on the ioctx
839  *      run list.
840  * Assumes it is operating within the aio issuer's mm
841  * context.
842  */
843 static inline void aio_run_iocbs(struct kioctx *ctx)
844 {
845         int requeue;
846
847         spin_lock_irq(&ctx->ctx_lock);
848
849         requeue = __aio_run_iocbs(ctx);
850         spin_unlock_irq(&ctx->ctx_lock);
851         if (requeue)
852                 aio_queue_work(ctx);
853 }
854
855 /*
856  * just like aio_run_iocbs, but keeps running them until
857  * the list stays empty
858  */
859 static inline void aio_run_all_iocbs(struct kioctx *ctx)
860 {
861         spin_lock_irq(&ctx->ctx_lock);
862         while (__aio_run_iocbs(ctx))
863                 ;
864         spin_unlock_irq(&ctx->ctx_lock);
865 }
866
867 /*
868  * aio_kick_handler:
869  *      Work queue handler triggered to process pending
870  *      retries on an ioctx. Takes on the aio issuer's
871  *      mm context before running the iocbs, so that
872  *      copy_xxx_user operates on the issuer's address
873  *      space.
874  * Run on aiod's context.
875  */
876 static void aio_kick_handler(void *data)
877 {
878         struct kioctx *ctx = data;
879         mm_segment_t oldfs = get_fs();
880         int requeue;
881
882         set_fs(USER_DS);
883         use_mm(ctx->mm);
884         spin_lock_irq(&ctx->ctx_lock);
885         requeue =__aio_run_iocbs(ctx);
886         unuse_mm(ctx->mm);
887         spin_unlock_irq(&ctx->ctx_lock);
888         set_fs(oldfs);
889         /*
890          * we're in a worker thread already, don't use queue_delayed_work,
891          */
892         if (requeue)
893                 queue_work(aio_wq, &ctx->wq);
894 }
895
896
897 /*
898  * Called by kick_iocb to queue the kiocb for retry
899  * and if required activate the aio work queue to process
900  * it
901  */
902 static void try_queue_kicked_iocb(struct kiocb *iocb)
903 {
904         struct kioctx   *ctx = iocb->ki_ctx;
905         unsigned long flags;
906         int run = 0;
907
908         /* We're supposed to be the only path putting the iocb back on the run
909          * list.  If we find that the iocb is *back* on a wait queue already
910          * than retry has happened before we could queue the iocb.  This also
911          * means that the retry could have completed and freed our iocb, no
912          * good. */
913         BUG_ON((!list_empty(&iocb->ki_wait.task_list)));
914
915         spin_lock_irqsave(&ctx->ctx_lock, flags);
916         /* set this inside the lock so that we can't race with aio_run_iocb()
917          * testing it and putting the iocb on the run list under the lock */
918         if (!kiocbTryKick(iocb))
919                 run = __queue_kicked_iocb(iocb);
920         spin_unlock_irqrestore(&ctx->ctx_lock, flags);
921         if (run)
922                 aio_queue_work(ctx);
923 }
924
925 /*
926  * kick_iocb:
927  *      Called typically from a wait queue callback context
928  *      (aio_wake_function) to trigger a retry of the iocb.
929  *      The retry is usually executed by aio workqueue
930  *      threads (See aio_kick_handler).
931  */
932 void fastcall kick_iocb(struct kiocb *iocb)
933 {
934         /* sync iocbs are easy: they can only ever be executing from a 
935          * single context. */
936         if (is_sync_kiocb(iocb)) {
937                 kiocbSetKicked(iocb);
938                 wake_up_process(iocb->ki_obj.tsk);
939                 return;
940         }
941
942         try_queue_kicked_iocb(iocb);
943 }
944 EXPORT_SYMBOL(kick_iocb);
945
946 /* aio_complete
947  *      Called when the io request on the given iocb is complete.
948  *      Returns true if this is the last user of the request.  The 
949  *      only other user of the request can be the cancellation code.
950  */
951 int fastcall aio_complete(struct kiocb *iocb, long res, long res2)
952 {
953         struct kioctx   *ctx = iocb->ki_ctx;
954         struct aio_ring_info    *info;
955         struct aio_ring *ring;
956         struct io_event *event;
957         unsigned long   flags;
958         unsigned long   tail;
959         int             ret;
960
961         /* Special case handling for sync iocbs: events go directly
962          * into the iocb for fast handling.  Note that this will not 
963          * work if we allow sync kiocbs to be cancelled. in which
964          * case the usage count checks will have to move under ctx_lock
965          * for all cases.
966          */
967         if (is_sync_kiocb(iocb)) {
968                 int ret;
969
970                 iocb->ki_user_data = res;
971                 if (iocb->ki_users == 1) {
972                         iocb->ki_users = 0;
973                         ret = 1;
974                 } else {
975                         spin_lock_irq(&ctx->ctx_lock);
976                         iocb->ki_users--;
977                         ret = (0 == iocb->ki_users);
978                         spin_unlock_irq(&ctx->ctx_lock);
979                 }
980                 /* sync iocbs put the task here for us */
981                 wake_up_process(iocb->ki_obj.tsk);
982                 return ret;
983         }
984
985         info = &ctx->ring_info;
986
987         /* add a completion event to the ring buffer.
988          * must be done holding ctx->ctx_lock to prevent
989          * other code from messing with the tail
990          * pointer since we might be called from irq
991          * context.
992          */
993         spin_lock_irqsave(&ctx->ctx_lock, flags);
994
995         if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
996                 list_del_init(&iocb->ki_run_list);
997
998         /*
999          * cancelled requests don't get events, userland was given one
1000          * when the event got cancelled.
1001          */
1002         if (kiocbIsCancelled(iocb))
1003                 goto put_rq;
1004
1005         ring = kmap_atomic(info->ring_pages[0], KM_IRQ1);
1006
1007         tail = info->tail;
1008         event = aio_ring_event(info, tail, KM_IRQ0);
1009         if (++tail >= info->nr)
1010                 tail = 0;
1011
1012         event->obj = (u64)(unsigned long)iocb->ki_obj.user;
1013         event->data = iocb->ki_user_data;
1014         event->res = res;
1015         event->res2 = res2;
1016
1017         dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
1018                 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
1019                 res, res2);
1020
1021         /* after flagging the request as done, we
1022          * must never even look at it again
1023          */
1024         smp_wmb();      /* make event visible before updating tail */
1025
1026         info->tail = tail;
1027         ring->tail = tail;
1028
1029         put_aio_ring_event(event, KM_IRQ0);
1030         kunmap_atomic(ring, KM_IRQ1);
1031
1032         pr_debug("added to ring %p at [%lu]\n", iocb, tail);
1033
1034         pr_debug("%ld retries: %d of %d\n", iocb->ki_retried,
1035                 iocb->ki_nbytes - iocb->ki_left, iocb->ki_nbytes);
1036 put_rq:
1037         /* everything turned out well, dispose of the aiocb. */
1038         ret = __aio_put_req(ctx, iocb);
1039
1040         spin_unlock_irqrestore(&ctx->ctx_lock, flags);
1041
1042         if (waitqueue_active(&ctx->wait))
1043                 wake_up(&ctx->wait);
1044
1045         if (ret)
1046                 put_ioctx(ctx);
1047
1048         return ret;
1049 }
1050
1051 /* aio_read_evt
1052  *      Pull an event off of the ioctx's event ring.  Returns the number of 
1053  *      events fetched (0 or 1 ;-)
1054  *      FIXME: make this use cmpxchg.
1055  *      TODO: make the ringbuffer user mmap()able (requires FIXME).
1056  */
1057 static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
1058 {
1059         struct aio_ring_info *info = &ioctx->ring_info;
1060         struct aio_ring *ring;
1061         unsigned long head;
1062         int ret = 0;
1063
1064         ring = kmap_atomic(info->ring_pages[0], KM_USER0);
1065         dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1066                  (unsigned long)ring->head, (unsigned long)ring->tail,
1067                  (unsigned long)ring->nr);
1068
1069         if (ring->head == ring->tail)
1070                 goto out;
1071
1072         spin_lock(&info->ring_lock);
1073
1074         head = ring->head % info->nr;
1075         if (head != ring->tail) {
1076                 struct io_event *evp = aio_ring_event(info, head, KM_USER1);
1077                 *ent = *evp;
1078                 head = (head + 1) % info->nr;
1079                 smp_mb(); /* finish reading the event before updatng the head */
1080                 ring->head = head;
1081                 ret = 1;
1082                 put_aio_ring_event(evp, KM_USER1);
1083         }
1084         spin_unlock(&info->ring_lock);
1085
1086 out:
1087         kunmap_atomic(ring, KM_USER0);
1088         dprintk("leaving aio_read_evt: %d  h%lu t%lu\n", ret,
1089                  (unsigned long)ring->head, (unsigned long)ring->tail);
1090         return ret;
1091 }
1092
1093 struct aio_timeout {
1094         struct timer_list       timer;
1095         int                     timed_out;
1096         struct task_struct      *p;
1097 };
1098
1099 static void timeout_func(unsigned long data)
1100 {
1101         struct aio_timeout *to = (struct aio_timeout *)data;
1102
1103         to->timed_out = 1;
1104         wake_up_process(to->p);
1105 }
1106
1107 static inline void init_timeout(struct aio_timeout *to)
1108 {
1109         init_timer(&to->timer);
1110         to->timer.data = (unsigned long)to;
1111         to->timer.function = timeout_func;
1112         to->timed_out = 0;
1113         to->p = current;
1114 }
1115
1116 static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
1117                                const struct timespec *ts)
1118 {
1119         to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
1120         if (time_after(to->timer.expires, jiffies))
1121                 add_timer(&to->timer);
1122         else
1123                 to->timed_out = 1;
1124 }
1125
1126 static inline void clear_timeout(struct aio_timeout *to)
1127 {
1128         del_singleshot_timer_sync(&to->timer);
1129 }
1130
1131 static int read_events(struct kioctx *ctx,
1132                         long min_nr, long nr,
1133                         struct io_event __user *event,
1134                         struct timespec __user *timeout)
1135 {
1136         long                    start_jiffies = jiffies;
1137         struct task_struct      *tsk = current;
1138         DECLARE_WAITQUEUE(wait, tsk);
1139         int                     ret;
1140         int                     i = 0;
1141         struct io_event         ent;
1142         struct aio_timeout      to;
1143         int                     retry = 0;
1144
1145         /* needed to zero any padding within an entry (there shouldn't be 
1146          * any, but C is fun!
1147          */
1148         memset(&ent, 0, sizeof(ent));
1149 retry:
1150         ret = 0;
1151         while (likely(i < nr)) {
1152                 ret = aio_read_evt(ctx, &ent);
1153                 if (unlikely(ret <= 0))
1154                         break;
1155
1156                 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1157                         ent.data, ent.obj, ent.res, ent.res2);
1158
1159                 /* Could we split the check in two? */
1160                 ret = -EFAULT;
1161                 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1162                         dprintk("aio: lost an event due to EFAULT.\n");
1163                         break;
1164                 }
1165                 ret = 0;
1166
1167                 /* Good, event copied to userland, update counts. */
1168                 event ++;
1169                 i ++;
1170         }
1171
1172         if (min_nr <= i)
1173                 return i;
1174         if (ret)
1175                 return ret;
1176
1177         /* End fast path */
1178
1179         /* racey check, but it gets redone */
1180         if (!retry && unlikely(!list_empty(&ctx->run_list))) {
1181                 retry = 1;
1182                 aio_run_all_iocbs(ctx);
1183                 goto retry;
1184         }
1185
1186         init_timeout(&to);
1187         if (timeout) {
1188                 struct timespec ts;
1189                 ret = -EFAULT;
1190                 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1191                         goto out;
1192
1193                 set_timeout(start_jiffies, &to, &ts);
1194         }
1195
1196         while (likely(i < nr)) {
1197                 add_wait_queue_exclusive(&ctx->wait, &wait);
1198                 do {
1199                         set_task_state(tsk, TASK_INTERRUPTIBLE);
1200                         ret = aio_read_evt(ctx, &ent);
1201                         if (ret)
1202                                 break;
1203                         if (min_nr <= i)
1204                                 break;
1205                         ret = 0;
1206                         if (to.timed_out)       /* Only check after read evt */
1207                                 break;
1208                         schedule();
1209                         if (signal_pending(tsk)) {
1210                                 ret = -EINTR;
1211                                 break;
1212                         }
1213                         /*ret = aio_read_evt(ctx, &ent);*/
1214                 } while (1) ;
1215
1216                 set_task_state(tsk, TASK_RUNNING);
1217                 remove_wait_queue(&ctx->wait, &wait);
1218
1219                 if (unlikely(ret <= 0))
1220                         break;
1221
1222                 ret = -EFAULT;
1223                 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1224                         dprintk("aio: lost an event due to EFAULT.\n");
1225                         break;
1226                 }
1227
1228                 /* Good, event copied to userland, update counts. */
1229                 event ++;
1230                 i ++;
1231         }
1232
1233         if (timeout)
1234                 clear_timeout(&to);
1235 out:
1236         return i ? i : ret;
1237 }
1238
1239 /* Take an ioctx and remove it from the list of ioctx's.  Protects 
1240  * against races with itself via ->dead.
1241  */
1242 static void io_destroy(struct kioctx *ioctx)
1243 {
1244         struct mm_struct *mm = current->mm;
1245         struct kioctx **tmp;
1246         int was_dead;
1247
1248         /* delete the entry from the list is someone else hasn't already */
1249         write_lock(&mm->ioctx_list_lock);
1250         was_dead = ioctx->dead;
1251         ioctx->dead = 1;
1252         for (tmp = &mm->ioctx_list; *tmp && *tmp != ioctx;
1253              tmp = &(*tmp)->next)
1254                 ;
1255         if (*tmp)
1256                 *tmp = ioctx->next;
1257         write_unlock(&mm->ioctx_list_lock);
1258
1259         dprintk("aio_release(%p)\n", ioctx);
1260         if (likely(!was_dead))
1261                 put_ioctx(ioctx);       /* twice for the list */
1262
1263         aio_cancel_all(ioctx);
1264         wait_for_all_aios(ioctx);
1265         put_ioctx(ioctx);       /* once for the lookup */
1266 }
1267
1268 /* sys_io_setup:
1269  *      Create an aio_context capable of receiving at least nr_events.
1270  *      ctxp must not point to an aio_context that already exists, and
1271  *      must be initialized to 0 prior to the call.  On successful
1272  *      creation of the aio_context, *ctxp is filled in with the resulting 
1273  *      handle.  May fail with -EINVAL if *ctxp is not initialized,
1274  *      if the specified nr_events exceeds internal limits.  May fail 
1275  *      with -EAGAIN if the specified nr_events exceeds the user's limit 
1276  *      of available events.  May fail with -ENOMEM if insufficient kernel
1277  *      resources are available.  May fail with -EFAULT if an invalid
1278  *      pointer is passed for ctxp.  Will fail with -ENOSYS if not
1279  *      implemented.
1280  */
1281 asmlinkage long sys_io_setup(unsigned nr_events, aio_context_t __user *ctxp)
1282 {
1283         struct kioctx *ioctx = NULL;
1284         unsigned long ctx;
1285         long ret;
1286
1287         ret = get_user(ctx, ctxp);
1288         if (unlikely(ret))
1289                 goto out;
1290
1291         ret = -EINVAL;
1292         if (unlikely(ctx || (int)nr_events <= 0)) {
1293                 pr_debug("EINVAL: io_setup: ctx or nr_events > max\n");
1294                 goto out;
1295         }
1296
1297         ioctx = ioctx_alloc(nr_events);
1298         ret = PTR_ERR(ioctx);
1299         if (!IS_ERR(ioctx)) {
1300                 ret = put_user(ioctx->user_id, ctxp);
1301                 if (!ret)
1302                         return 0;
1303
1304                 get_ioctx(ioctx); /* io_destroy() expects us to hold a ref */
1305                 io_destroy(ioctx);
1306         }
1307
1308 out:
1309         return ret;
1310 }
1311
1312 /* sys_io_destroy:
1313  *      Destroy the aio_context specified.  May cancel any outstanding 
1314  *      AIOs and block on completion.  Will fail with -ENOSYS if not
1315  *      implemented.  May fail with -EFAULT if the context pointed to
1316  *      is invalid.
1317  */
1318 asmlinkage long sys_io_destroy(aio_context_t ctx)
1319 {
1320         struct kioctx *ioctx = lookup_ioctx(ctx);
1321         if (likely(NULL != ioctx)) {
1322                 io_destroy(ioctx);
1323                 return 0;
1324         }
1325         pr_debug("EINVAL: io_destroy: invalid context id\n");
1326         return -EINVAL;
1327 }
1328
1329 /*
1330  * Default retry method for aio_read (also used for first time submit)
1331  * Responsible for updating iocb state as retries progress
1332  */
1333 static ssize_t aio_pread(struct kiocb *iocb)
1334 {
1335         struct file *file = iocb->ki_filp;
1336         struct address_space *mapping = file->f_mapping;
1337         struct inode *inode = mapping->host;
1338         ssize_t ret = 0;
1339
1340         ret = file->f_op->aio_read(iocb, iocb->ki_buf,
1341                 iocb->ki_left, iocb->ki_pos);
1342
1343         /*
1344          * Can't just depend on iocb->ki_left to determine
1345          * whether we are done. This may have been a short read.
1346          */
1347         if (ret > 0) {
1348                 iocb->ki_buf += ret;
1349                 iocb->ki_left -= ret;
1350                 /*
1351                  * For pipes and sockets we return once we have
1352                  * some data; for regular files we retry till we
1353                  * complete the entire read or find that we can't
1354                  * read any more data (e.g short reads).
1355                  */
1356                 if (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))
1357                         ret = -EIOCBRETRY;
1358         }
1359
1360         /* This means we must have transferred all that we could */
1361         /* No need to retry anymore */
1362         if ((ret == 0) || (iocb->ki_left == 0))
1363                 ret = iocb->ki_nbytes - iocb->ki_left;
1364
1365         return ret;
1366 }
1367
1368 /*
1369  * Default retry method for aio_write (also used for first time submit)
1370  * Responsible for updating iocb state as retries progress
1371  */
1372 static ssize_t aio_pwrite(struct kiocb *iocb)
1373 {
1374         struct file *file = iocb->ki_filp;
1375         ssize_t ret = 0;
1376
1377         ret = file->f_op->aio_write(iocb, iocb->ki_buf,
1378                 iocb->ki_left, iocb->ki_pos);
1379
1380         if (ret > 0) {
1381                 iocb->ki_buf += ret;
1382                 iocb->ki_left -= ret;
1383
1384                 ret = -EIOCBRETRY;
1385         }
1386
1387         /* This means we must have transferred all that we could */
1388         /* No need to retry anymore */
1389         if ((ret == 0) || (iocb->ki_left == 0))
1390                 ret = iocb->ki_nbytes - iocb->ki_left;
1391
1392         return ret;
1393 }
1394
1395 static ssize_t aio_fdsync(struct kiocb *iocb)
1396 {
1397         struct file *file = iocb->ki_filp;
1398         ssize_t ret = -EINVAL;
1399
1400         if (file->f_op->aio_fsync)
1401                 ret = file->f_op->aio_fsync(iocb, 1);
1402         return ret;
1403 }
1404
1405 static ssize_t aio_fsync(struct kiocb *iocb)
1406 {
1407         struct file *file = iocb->ki_filp;
1408         ssize_t ret = -EINVAL;
1409
1410         if (file->f_op->aio_fsync)
1411                 ret = file->f_op->aio_fsync(iocb, 0);
1412         return ret;
1413 }
1414
1415 /*
1416  * aio_setup_iocb:
1417  *      Performs the initial checks and aio retry method
1418  *      setup for the kiocb at the time of io submission.
1419  */
1420 static ssize_t aio_setup_iocb(struct kiocb *kiocb)
1421 {
1422         struct file *file = kiocb->ki_filp;
1423         ssize_t ret = 0;
1424
1425         switch (kiocb->ki_opcode) {
1426         case IOCB_CMD_PREAD:
1427                 ret = -EBADF;
1428                 if (unlikely(!(file->f_mode & FMODE_READ)))
1429                         break;
1430                 ret = -EFAULT;
1431                 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1432                         kiocb->ki_left)))
1433                         break;
1434                 ret = -EINVAL;
1435                 if (file->f_op->aio_read)
1436                         kiocb->ki_retry = aio_pread;
1437                 break;
1438         case IOCB_CMD_PWRITE:
1439                 ret = -EBADF;
1440                 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1441                         break;
1442                 ret = -EFAULT;
1443                 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1444                         kiocb->ki_left)))
1445                         break;
1446                 ret = -EINVAL;
1447                 if (file->f_op->aio_write)
1448                         kiocb->ki_retry = aio_pwrite;
1449                 break;
1450         case IOCB_CMD_FDSYNC:
1451                 ret = -EINVAL;
1452                 if (file->f_op->aio_fsync)
1453                         kiocb->ki_retry = aio_fdsync;
1454                 break;
1455         case IOCB_CMD_FSYNC:
1456                 ret = -EINVAL;
1457                 if (file->f_op->aio_fsync)
1458                         kiocb->ki_retry = aio_fsync;
1459                 break;
1460         default:
1461                 dprintk("EINVAL: io_submit: no operation provided\n");
1462                 ret = -EINVAL;
1463         }
1464
1465         if (!kiocb->ki_retry)
1466                 return ret;
1467
1468         return 0;
1469 }
1470
1471 /*
1472  * aio_wake_function:
1473  *      wait queue callback function for aio notification,
1474  *      Simply triggers a retry of the operation via kick_iocb.
1475  *
1476  *      This callback is specified in the wait queue entry in
1477  *      a kiocb (current->io_wait points to this wait queue
1478  *      entry when an aio operation executes; it is used
1479  *      instead of a synchronous wait when an i/o blocking
1480  *      condition is encountered during aio).
1481  *
1482  * Note:
1483  * This routine is executed with the wait queue lock held.
1484  * Since kick_iocb acquires iocb->ctx->ctx_lock, it nests
1485  * the ioctx lock inside the wait queue lock. This is safe
1486  * because this callback isn't used for wait queues which
1487  * are nested inside ioctx lock (i.e. ctx->wait)
1488  */
1489 static int aio_wake_function(wait_queue_t *wait, unsigned mode,
1490                              int sync, void *key)
1491 {
1492         struct kiocb *iocb = container_of(wait, struct kiocb, ki_wait);
1493
1494         list_del_init(&wait->task_list);
1495         kick_iocb(iocb);
1496         return 1;
1497 }
1498
1499 int fastcall io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
1500                          struct iocb *iocb)
1501 {
1502         struct kiocb *req;
1503         struct file *file;
1504         ssize_t ret;
1505
1506         /* enforce forwards compatibility on users */
1507         if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2 ||
1508                      iocb->aio_reserved3)) {
1509                 pr_debug("EINVAL: io_submit: reserve field set\n");
1510                 return -EINVAL;
1511         }
1512
1513         /* prevent overflows */
1514         if (unlikely(
1515             (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1516             (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1517             ((ssize_t)iocb->aio_nbytes < 0)
1518            )) {
1519                 pr_debug("EINVAL: io_submit: overflow check\n");
1520                 return -EINVAL;
1521         }
1522
1523         file = fget(iocb->aio_fildes);
1524         if (unlikely(!file))
1525                 return -EBADF;
1526
1527         req = aio_get_req(ctx);         /* returns with 2 references to req */
1528         if (unlikely(!req)) {
1529                 fput(file);
1530                 return -EAGAIN;
1531         }
1532
1533         req->ki_filp = file;
1534         ret = put_user(req->ki_key, &user_iocb->aio_key);
1535         if (unlikely(ret)) {
1536                 dprintk("EFAULT: aio_key\n");
1537                 goto out_put_req;
1538         }
1539
1540         req->ki_obj.user = user_iocb;
1541         req->ki_user_data = iocb->aio_data;
1542         req->ki_pos = iocb->aio_offset;
1543
1544         req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1545         req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1546         req->ki_opcode = iocb->aio_lio_opcode;
1547         init_waitqueue_func_entry(&req->ki_wait, aio_wake_function);
1548         INIT_LIST_HEAD(&req->ki_wait.task_list);
1549         req->ki_retried = 0;
1550
1551         ret = aio_setup_iocb(req);
1552
1553         if (ret)
1554                 goto out_put_req;
1555
1556         spin_lock_irq(&ctx->ctx_lock);
1557         aio_run_iocb(req);
1558         unlock_kiocb(req);
1559         if (!list_empty(&ctx->run_list)) {
1560                 /* drain the run list */
1561                 while (__aio_run_iocbs(ctx))
1562                         ;
1563         }
1564         spin_unlock_irq(&ctx->ctx_lock);
1565         aio_put_req(req);       /* drop extra ref to req */
1566         return 0;
1567
1568 out_put_req:
1569         aio_put_req(req);       /* drop extra ref to req */
1570         aio_put_req(req);       /* drop i/o ref to req */
1571         return ret;
1572 }
1573
1574 /* sys_io_submit:
1575  *      Queue the nr iocbs pointed to by iocbpp for processing.  Returns
1576  *      the number of iocbs queued.  May return -EINVAL if the aio_context
1577  *      specified by ctx_id is invalid, if nr is < 0, if the iocb at
1578  *      *iocbpp[0] is not properly initialized, if the operation specified
1579  *      is invalid for the file descriptor in the iocb.  May fail with
1580  *      -EFAULT if any of the data structures point to invalid data.  May
1581  *      fail with -EBADF if the file descriptor specified in the first
1582  *      iocb is invalid.  May fail with -EAGAIN if insufficient resources
1583  *      are available to queue any iocbs.  Will return 0 if nr is 0.  Will
1584  *      fail with -ENOSYS if not implemented.
1585  */
1586 asmlinkage long sys_io_submit(aio_context_t ctx_id, long nr,
1587                               struct iocb __user * __user *iocbpp)
1588 {
1589         struct kioctx *ctx;
1590         long ret = 0;
1591         int i;
1592
1593         if (unlikely(nr < 0))
1594                 return -EINVAL;
1595
1596         if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1597                 return -EFAULT;
1598
1599         ctx = lookup_ioctx(ctx_id);
1600         if (unlikely(!ctx)) {
1601                 pr_debug("EINVAL: io_submit: invalid context id\n");
1602                 return -EINVAL;
1603         }
1604
1605         /*
1606          * AKPM: should this return a partial result if some of the IOs were
1607          * successfully submitted?
1608          */
1609         for (i=0; i<nr; i++) {
1610                 struct iocb __user *user_iocb;
1611                 struct iocb tmp;
1612
1613                 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1614                         ret = -EFAULT;
1615                         break;
1616                 }
1617
1618                 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1619                         ret = -EFAULT;
1620                         break;
1621                 }
1622
1623                 ret = io_submit_one(ctx, user_iocb, &tmp);
1624                 if (ret)
1625                         break;
1626         }
1627
1628         put_ioctx(ctx);
1629         return i ? i : ret;
1630 }
1631
1632 /* lookup_kiocb
1633  *      Finds a given iocb for cancellation.
1634  *      MUST be called with ctx->ctx_lock held.
1635  */
1636 static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1637                                   u32 key)
1638 {
1639         struct list_head *pos;
1640         /* TODO: use a hash or array, this sucks. */
1641         list_for_each(pos, &ctx->active_reqs) {
1642                 struct kiocb *kiocb = list_kiocb(pos);
1643                 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1644                         return kiocb;
1645         }
1646         return NULL;
1647 }
1648
1649 /* sys_io_cancel:
1650  *      Attempts to cancel an iocb previously passed to io_submit.  If
1651  *      the operation is successfully cancelled, the resulting event is
1652  *      copied into the memory pointed to by result without being placed
1653  *      into the completion queue and 0 is returned.  May fail with
1654  *      -EFAULT if any of the data structures pointed to are invalid.
1655  *      May fail with -EINVAL if aio_context specified by ctx_id is
1656  *      invalid.  May fail with -EAGAIN if the iocb specified was not
1657  *      cancelled.  Will fail with -ENOSYS if not implemented.
1658  */
1659 asmlinkage long sys_io_cancel(aio_context_t ctx_id, struct iocb __user *iocb,
1660                               struct io_event __user *result)
1661 {
1662         int (*cancel)(struct kiocb *iocb, struct io_event *res);
1663         struct kioctx *ctx;
1664         struct kiocb *kiocb;
1665         u32 key;
1666         int ret;
1667
1668         ret = get_user(key, &iocb->aio_key);
1669         if (unlikely(ret))
1670                 return -EFAULT;
1671
1672         ctx = lookup_ioctx(ctx_id);
1673         if (unlikely(!ctx))
1674                 return -EINVAL;
1675
1676         spin_lock_irq(&ctx->ctx_lock);
1677         ret = -EAGAIN;
1678         kiocb = lookup_kiocb(ctx, iocb, key);
1679         if (kiocb && kiocb->ki_cancel) {
1680                 cancel = kiocb->ki_cancel;
1681                 kiocb->ki_users ++;
1682                 kiocbSetCancelled(kiocb);
1683         } else
1684                 cancel = NULL;
1685         spin_unlock_irq(&ctx->ctx_lock);
1686
1687         if (NULL != cancel) {
1688                 struct io_event tmp;
1689                 pr_debug("calling cancel\n");
1690                 lock_kiocb(kiocb);
1691                 memset(&tmp, 0, sizeof(tmp));
1692                 tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
1693                 tmp.data = kiocb->ki_user_data;
1694                 ret = cancel(kiocb, &tmp);
1695                 if (!ret) {
1696                         /* Cancellation succeeded -- copy the result
1697                          * into the user's buffer.
1698                          */
1699                         if (copy_to_user(result, &tmp, sizeof(tmp)))
1700                                 ret = -EFAULT;
1701                 }
1702                 unlock_kiocb(kiocb);
1703         } else
1704                 ret = -EINVAL;
1705
1706         put_ioctx(ctx);
1707
1708         return ret;
1709 }
1710
1711 /* io_getevents:
1712  *      Attempts to read at least min_nr events and up to nr events from
1713  *      the completion queue for the aio_context specified by ctx_id.  May
1714  *      fail with -EINVAL if ctx_id is invalid, if min_nr is out of range,
1715  *      if nr is out of range, if when is out of range.  May fail with
1716  *      -EFAULT if any of the memory specified to is invalid.  May return
1717  *      0 or < min_nr if no events are available and the timeout specified
1718  *      by when has elapsed, where when == NULL specifies an infinite
1719  *      timeout.  Note that the timeout pointed to by when is relative and
1720  *      will be updated if not NULL and the operation blocks.  Will fail
1721  *      with -ENOSYS if not implemented.
1722  */
1723 asmlinkage long sys_io_getevents(aio_context_t ctx_id,
1724                                  long min_nr,
1725                                  long nr,
1726                                  struct io_event __user *events,
1727                                  struct timespec __user *timeout)
1728 {
1729         struct kioctx *ioctx = lookup_ioctx(ctx_id);
1730         long ret = -EINVAL;
1731
1732         if (likely(ioctx)) {
1733                 if (likely(min_nr <= nr && min_nr >= 0 && nr >= 0))
1734                         ret = read_events(ioctx, min_nr, nr, events, timeout);
1735                 put_ioctx(ioctx);
1736         }
1737
1738         return ret;
1739 }
1740
1741 __initcall(aio_setup);
1742
1743 EXPORT_SYMBOL(aio_complete);
1744 EXPORT_SYMBOL(aio_put_req);
1745 EXPORT_SYMBOL(wait_on_sync_kiocb);