Merge master.kernel.org:/home/rmk/linux-2.6-serial
[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         wake_up_bit(&iocb->ki_flags, KIF_LOCKED);
566 }
567
568 /*
569  * use_mm
570  *      Makes the calling kernel thread take on the specified
571  *      mm context.
572  *      Called by the retry thread execute retries within the
573  *      iocb issuer's mm context, so that copy_from/to_user
574  *      operations work seamlessly for aio.
575  *      (Note: this routine is intended to be called only
576  *      from a kernel thread context)
577  */
578 static void use_mm(struct mm_struct *mm)
579 {
580         struct mm_struct *active_mm;
581         struct task_struct *tsk = current;
582
583         task_lock(tsk);
584         tsk->flags |= PF_BORROWED_MM;
585         active_mm = tsk->active_mm;
586         atomic_inc(&mm->mm_count);
587         tsk->mm = mm;
588         tsk->active_mm = mm;
589         /*
590          * Note that on UML this *requires* PF_BORROWED_MM to be set, otherwise
591          * it won't work. Update it accordingly if you change it here
592          */
593         activate_mm(active_mm, mm);
594         task_unlock(tsk);
595
596         mmdrop(active_mm);
597 }
598
599 /*
600  * unuse_mm
601  *      Reverses the effect of use_mm, i.e. releases the
602  *      specified mm context which was earlier taken on
603  *      by the calling kernel thread
604  *      (Note: this routine is intended to be called only
605  *      from a kernel thread context)
606  *
607  * Comments: Called with ctx->ctx_lock held. This nests
608  * task_lock instead ctx_lock.
609  */
610 static void unuse_mm(struct mm_struct *mm)
611 {
612         struct task_struct *tsk = current;
613
614         task_lock(tsk);
615         tsk->flags &= ~PF_BORROWED_MM;
616         tsk->mm = NULL;
617         /* active_mm is still 'mm' */
618         enter_lazy_tlb(mm, tsk);
619         task_unlock(tsk);
620 }
621
622 /*
623  * Queue up a kiocb to be retried. Assumes that the kiocb
624  * has already been marked as kicked, and places it on
625  * the retry run list for the corresponding ioctx, if it
626  * isn't already queued. Returns 1 if it actually queued
627  * the kiocb (to tell the caller to activate the work
628  * queue to process it), or 0, if it found that it was
629  * already queued.
630  *
631  * Should be called with the spin lock iocb->ki_ctx->ctx_lock
632  * held
633  */
634 static inline int __queue_kicked_iocb(struct kiocb *iocb)
635 {
636         struct kioctx *ctx = iocb->ki_ctx;
637
638         if (list_empty(&iocb->ki_run_list)) {
639                 list_add_tail(&iocb->ki_run_list,
640                         &ctx->run_list);
641                 return 1;
642         }
643         return 0;
644 }
645
646 /* aio_run_iocb
647  *      This is the core aio execution routine. It is
648  *      invoked both for initial i/o submission and
649  *      subsequent retries via the aio_kick_handler.
650  *      Expects to be invoked with iocb->ki_ctx->lock
651  *      already held. The lock is released and reaquired
652  *      as needed during processing.
653  *
654  * Calls the iocb retry method (already setup for the
655  * iocb on initial submission) for operation specific
656  * handling, but takes care of most of common retry
657  * execution details for a given iocb. The retry method
658  * needs to be non-blocking as far as possible, to avoid
659  * holding up other iocbs waiting to be serviced by the
660  * retry kernel thread.
661  *
662  * The trickier parts in this code have to do with
663  * ensuring that only one retry instance is in progress
664  * for a given iocb at any time. Providing that guarantee
665  * simplifies the coding of individual aio operations as
666  * it avoids various potential races.
667  */
668 static ssize_t aio_run_iocb(struct kiocb *iocb)
669 {
670         struct kioctx   *ctx = iocb->ki_ctx;
671         ssize_t (*retry)(struct kiocb *);
672         ssize_t ret;
673
674         if (iocb->ki_retried++ > 1024*1024) {
675                 printk("Maximal retry count.  Bytes done %Zd\n",
676                         iocb->ki_nbytes - iocb->ki_left);
677                 return -EAGAIN;
678         }
679
680         if (!(iocb->ki_retried & 0xff)) {
681                 pr_debug("%ld retry: %d of %d\n", iocb->ki_retried,
682                         iocb->ki_nbytes - iocb->ki_left, iocb->ki_nbytes);
683         }
684
685         if (!(retry = iocb->ki_retry)) {
686                 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
687                 return 0;
688         }
689
690         /*
691          * We don't want the next retry iteration for this
692          * operation to start until this one has returned and
693          * updated the iocb state. However, wait_queue functions
694          * can trigger a kick_iocb from interrupt context in the
695          * meantime, indicating that data is available for the next
696          * iteration. We want to remember that and enable the
697          * next retry iteration _after_ we are through with
698          * this one.
699          *
700          * So, in order to be able to register a "kick", but
701          * prevent it from being queued now, we clear the kick
702          * flag, but make the kick code *think* that the iocb is
703          * still on the run list until we are actually done.
704          * When we are done with this iteration, we check if
705          * the iocb was kicked in the meantime and if so, queue
706          * it up afresh.
707          */
708
709         kiocbClearKicked(iocb);
710
711         /*
712          * This is so that aio_complete knows it doesn't need to
713          * pull the iocb off the run list (We can't just call
714          * INIT_LIST_HEAD because we don't want a kick_iocb to
715          * queue this on the run list yet)
716          */
717         iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
718         spin_unlock_irq(&ctx->ctx_lock);
719
720         /* Quit retrying if the i/o has been cancelled */
721         if (kiocbIsCancelled(iocb)) {
722                 ret = -EINTR;
723                 aio_complete(iocb, ret, 0);
724                 /* must not access the iocb after this */
725                 goto out;
726         }
727
728         /*
729          * Now we are all set to call the retry method in async
730          * context. By setting this thread's io_wait context
731          * to point to the wait queue entry inside the currently
732          * running iocb for the duration of the retry, we ensure
733          * that async notification wakeups are queued by the
734          * operation instead of blocking waits, and when notified,
735          * cause the iocb to be kicked for continuation (through
736          * the aio_wake_function callback).
737          */
738         BUG_ON(current->io_wait != NULL);
739         current->io_wait = &iocb->ki_wait;
740         ret = retry(iocb);
741         current->io_wait = NULL;
742
743         if (-EIOCBRETRY != ret) {
744                 if (-EIOCBQUEUED != ret) {
745                         BUG_ON(!list_empty(&iocb->ki_wait.task_list));
746                         aio_complete(iocb, ret, 0);
747                         /* must not access the iocb after this */
748                 }
749         } else {
750                 /*
751                  * Issue an additional retry to avoid waiting forever if
752                  * no waits were queued (e.g. in case of a short read).
753                  */
754                 if (list_empty(&iocb->ki_wait.task_list))
755                         kiocbSetKicked(iocb);
756         }
757 out:
758         spin_lock_irq(&ctx->ctx_lock);
759
760         if (-EIOCBRETRY == ret) {
761                 /*
762                  * OK, now that we are done with this iteration
763                  * and know that there is more left to go,
764                  * this is where we let go so that a subsequent
765                  * "kick" can start the next iteration
766                  */
767
768                 /* will make __queue_kicked_iocb succeed from here on */
769                 INIT_LIST_HEAD(&iocb->ki_run_list);
770                 /* we must queue the next iteration ourselves, if it
771                  * has already been kicked */
772                 if (kiocbIsKicked(iocb)) {
773                         __queue_kicked_iocb(iocb);
774
775                         /*
776                          * __queue_kicked_iocb will always return 1 here, because
777                          * iocb->ki_run_list is empty at this point so it should
778                          * be safe to unconditionally queue the context into the
779                          * work queue.
780                          */
781                         aio_queue_work(ctx);
782                 }
783         }
784         return ret;
785 }
786
787 /*
788  * __aio_run_iocbs:
789  *      Process all pending retries queued on the ioctx
790  *      run list.
791  * Assumes it is operating within the aio issuer's mm
792  * context. Expects to be called with ctx->ctx_lock held
793  */
794 static int __aio_run_iocbs(struct kioctx *ctx)
795 {
796         struct kiocb *iocb;
797         LIST_HEAD(run_list);
798
799         list_splice_init(&ctx->run_list, &run_list);
800         while (!list_empty(&run_list)) {
801                 iocb = list_entry(run_list.next, struct kiocb,
802                         ki_run_list);
803                 list_del(&iocb->ki_run_list);
804                 /*
805                  * Hold an extra reference while retrying i/o.
806                  */
807                 iocb->ki_users++;       /* grab extra reference */
808                 lock_kiocb(iocb);
809                 aio_run_iocb(iocb);
810                 unlock_kiocb(iocb);
811                 if (__aio_put_req(ctx, iocb))  /* drop extra ref */
812                         put_ioctx(ctx);
813         }
814         if (!list_empty(&ctx->run_list))
815                 return 1;
816         return 0;
817 }
818
819 static void aio_queue_work(struct kioctx * ctx)
820 {
821         unsigned long timeout;
822         /*
823          * if someone is waiting, get the work started right
824          * away, otherwise, use a longer delay
825          */
826         smp_mb();
827         if (waitqueue_active(&ctx->wait))
828                 timeout = 1;
829         else
830                 timeout = HZ/10;
831         queue_delayed_work(aio_wq, &ctx->wq, timeout);
832 }
833
834
835 /*
836  * aio_run_iocbs:
837  *      Process all pending retries queued on the ioctx
838  *      run list.
839  * Assumes it is operating within the aio issuer's mm
840  * context.
841  */
842 static inline void aio_run_iocbs(struct kioctx *ctx)
843 {
844         int requeue;
845
846         spin_lock_irq(&ctx->ctx_lock);
847
848         requeue = __aio_run_iocbs(ctx);
849         spin_unlock_irq(&ctx->ctx_lock);
850         if (requeue)
851                 aio_queue_work(ctx);
852 }
853
854 /*
855  * just like aio_run_iocbs, but keeps running them until
856  * the list stays empty
857  */
858 static inline void aio_run_all_iocbs(struct kioctx *ctx)
859 {
860         spin_lock_irq(&ctx->ctx_lock);
861         while (__aio_run_iocbs(ctx))
862                 ;
863         spin_unlock_irq(&ctx->ctx_lock);
864 }
865
866 /*
867  * aio_kick_handler:
868  *      Work queue handler triggered to process pending
869  *      retries on an ioctx. Takes on the aio issuer's
870  *      mm context before running the iocbs, so that
871  *      copy_xxx_user operates on the issuer's address
872  *      space.
873  * Run on aiod's context.
874  */
875 static void aio_kick_handler(void *data)
876 {
877         struct kioctx *ctx = data;
878         mm_segment_t oldfs = get_fs();
879         int requeue;
880
881         set_fs(USER_DS);
882         use_mm(ctx->mm);
883         spin_lock_irq(&ctx->ctx_lock);
884         requeue =__aio_run_iocbs(ctx);
885         unuse_mm(ctx->mm);
886         spin_unlock_irq(&ctx->ctx_lock);
887         set_fs(oldfs);
888         /*
889          * we're in a worker thread already, don't use queue_delayed_work,
890          */
891         if (requeue)
892                 queue_work(aio_wq, &ctx->wq);
893 }
894
895
896 /*
897  * Called by kick_iocb to queue the kiocb for retry
898  * and if required activate the aio work queue to process
899  * it
900  */
901 static void queue_kicked_iocb(struct kiocb *iocb)
902 {
903         struct kioctx   *ctx = iocb->ki_ctx;
904         unsigned long flags;
905         int run = 0;
906
907         WARN_ON((!list_empty(&iocb->ki_wait.task_list)));
908
909         spin_lock_irqsave(&ctx->ctx_lock, flags);
910         run = __queue_kicked_iocb(iocb);
911         spin_unlock_irqrestore(&ctx->ctx_lock, flags);
912         if (run)
913                 aio_queue_work(ctx);
914 }
915
916 /*
917  * kick_iocb:
918  *      Called typically from a wait queue callback context
919  *      (aio_wake_function) to trigger a retry of the iocb.
920  *      The retry is usually executed by aio workqueue
921  *      threads (See aio_kick_handler).
922  */
923 void fastcall kick_iocb(struct kiocb *iocb)
924 {
925         /* sync iocbs are easy: they can only ever be executing from a 
926          * single context. */
927         if (is_sync_kiocb(iocb)) {
928                 kiocbSetKicked(iocb);
929                 wake_up_process(iocb->ki_obj.tsk);
930                 return;
931         }
932
933         /* If its already kicked we shouldn't queue it again */
934         if (!kiocbTryKick(iocb)) {
935                 queue_kicked_iocb(iocb);
936         }
937 }
938 EXPORT_SYMBOL(kick_iocb);
939
940 /* aio_complete
941  *      Called when the io request on the given iocb is complete.
942  *      Returns true if this is the last user of the request.  The 
943  *      only other user of the request can be the cancellation code.
944  */
945 int fastcall aio_complete(struct kiocb *iocb, long res, long res2)
946 {
947         struct kioctx   *ctx = iocb->ki_ctx;
948         struct aio_ring_info    *info;
949         struct aio_ring *ring;
950         struct io_event *event;
951         unsigned long   flags;
952         unsigned long   tail;
953         int             ret;
954
955         /* Special case handling for sync iocbs: events go directly
956          * into the iocb for fast handling.  Note that this will not 
957          * work if we allow sync kiocbs to be cancelled. in which
958          * case the usage count checks will have to move under ctx_lock
959          * for all cases.
960          */
961         if (is_sync_kiocb(iocb)) {
962                 int ret;
963
964                 iocb->ki_user_data = res;
965                 if (iocb->ki_users == 1) {
966                         iocb->ki_users = 0;
967                         ret = 1;
968                 } else {
969                         spin_lock_irq(&ctx->ctx_lock);
970                         iocb->ki_users--;
971                         ret = (0 == iocb->ki_users);
972                         spin_unlock_irq(&ctx->ctx_lock);
973                 }
974                 /* sync iocbs put the task here for us */
975                 wake_up_process(iocb->ki_obj.tsk);
976                 return ret;
977         }
978
979         info = &ctx->ring_info;
980
981         /* add a completion event to the ring buffer.
982          * must be done holding ctx->ctx_lock to prevent
983          * other code from messing with the tail
984          * pointer since we might be called from irq
985          * context.
986          */
987         spin_lock_irqsave(&ctx->ctx_lock, flags);
988
989         if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
990                 list_del_init(&iocb->ki_run_list);
991
992         /*
993          * cancelled requests don't get events, userland was given one
994          * when the event got cancelled.
995          */
996         if (kiocbIsCancelled(iocb))
997                 goto put_rq;
998
999         ring = kmap_atomic(info->ring_pages[0], KM_IRQ1);
1000
1001         tail = info->tail;
1002         event = aio_ring_event(info, tail, KM_IRQ0);
1003         if (++tail >= info->nr)
1004                 tail = 0;
1005
1006         event->obj = (u64)(unsigned long)iocb->ki_obj.user;
1007         event->data = iocb->ki_user_data;
1008         event->res = res;
1009         event->res2 = res2;
1010
1011         dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
1012                 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
1013                 res, res2);
1014
1015         /* after flagging the request as done, we
1016          * must never even look at it again
1017          */
1018         smp_wmb();      /* make event visible before updating tail */
1019
1020         info->tail = tail;
1021         ring->tail = tail;
1022
1023         put_aio_ring_event(event, KM_IRQ0);
1024         kunmap_atomic(ring, KM_IRQ1);
1025
1026         pr_debug("added to ring %p at [%lu]\n", iocb, tail);
1027
1028         pr_debug("%ld retries: %d of %d\n", iocb->ki_retried,
1029                 iocb->ki_nbytes - iocb->ki_left, iocb->ki_nbytes);
1030 put_rq:
1031         /* everything turned out well, dispose of the aiocb. */
1032         ret = __aio_put_req(ctx, iocb);
1033
1034         spin_unlock_irqrestore(&ctx->ctx_lock, flags);
1035
1036         if (waitqueue_active(&ctx->wait))
1037                 wake_up(&ctx->wait);
1038
1039         if (ret)
1040                 put_ioctx(ctx);
1041
1042         return ret;
1043 }
1044
1045 /* aio_read_evt
1046  *      Pull an event off of the ioctx's event ring.  Returns the number of 
1047  *      events fetched (0 or 1 ;-)
1048  *      FIXME: make this use cmpxchg.
1049  *      TODO: make the ringbuffer user mmap()able (requires FIXME).
1050  */
1051 static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
1052 {
1053         struct aio_ring_info *info = &ioctx->ring_info;
1054         struct aio_ring *ring;
1055         unsigned long head;
1056         int ret = 0;
1057
1058         ring = kmap_atomic(info->ring_pages[0], KM_USER0);
1059         dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1060                  (unsigned long)ring->head, (unsigned long)ring->tail,
1061                  (unsigned long)ring->nr);
1062
1063         if (ring->head == ring->tail)
1064                 goto out;
1065
1066         spin_lock(&info->ring_lock);
1067
1068         head = ring->head % info->nr;
1069         if (head != ring->tail) {
1070                 struct io_event *evp = aio_ring_event(info, head, KM_USER1);
1071                 *ent = *evp;
1072                 head = (head + 1) % info->nr;
1073                 smp_mb(); /* finish reading the event before updatng the head */
1074                 ring->head = head;
1075                 ret = 1;
1076                 put_aio_ring_event(evp, KM_USER1);
1077         }
1078         spin_unlock(&info->ring_lock);
1079
1080 out:
1081         kunmap_atomic(ring, KM_USER0);
1082         dprintk("leaving aio_read_evt: %d  h%lu t%lu\n", ret,
1083                  (unsigned long)ring->head, (unsigned long)ring->tail);
1084         return ret;
1085 }
1086
1087 struct aio_timeout {
1088         struct timer_list       timer;
1089         int                     timed_out;
1090         struct task_struct      *p;
1091 };
1092
1093 static void timeout_func(unsigned long data)
1094 {
1095         struct aio_timeout *to = (struct aio_timeout *)data;
1096
1097         to->timed_out = 1;
1098         wake_up_process(to->p);
1099 }
1100
1101 static inline void init_timeout(struct aio_timeout *to)
1102 {
1103         init_timer(&to->timer);
1104         to->timer.data = (unsigned long)to;
1105         to->timer.function = timeout_func;
1106         to->timed_out = 0;
1107         to->p = current;
1108 }
1109
1110 static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
1111                                const struct timespec *ts)
1112 {
1113         to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
1114         if (time_after(to->timer.expires, jiffies))
1115                 add_timer(&to->timer);
1116         else
1117                 to->timed_out = 1;
1118 }
1119
1120 static inline void clear_timeout(struct aio_timeout *to)
1121 {
1122         del_singleshot_timer_sync(&to->timer);
1123 }
1124
1125 static int read_events(struct kioctx *ctx,
1126                         long min_nr, long nr,
1127                         struct io_event __user *event,
1128                         struct timespec __user *timeout)
1129 {
1130         long                    start_jiffies = jiffies;
1131         struct task_struct      *tsk = current;
1132         DECLARE_WAITQUEUE(wait, tsk);
1133         int                     ret;
1134         int                     i = 0;
1135         struct io_event         ent;
1136         struct aio_timeout      to;
1137         int                     retry = 0;
1138
1139         /* needed to zero any padding within an entry (there shouldn't be 
1140          * any, but C is fun!
1141          */
1142         memset(&ent, 0, sizeof(ent));
1143 retry:
1144         ret = 0;
1145         while (likely(i < nr)) {
1146                 ret = aio_read_evt(ctx, &ent);
1147                 if (unlikely(ret <= 0))
1148                         break;
1149
1150                 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1151                         ent.data, ent.obj, ent.res, ent.res2);
1152
1153                 /* Could we split the check in two? */
1154                 ret = -EFAULT;
1155                 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1156                         dprintk("aio: lost an event due to EFAULT.\n");
1157                         break;
1158                 }
1159                 ret = 0;
1160
1161                 /* Good, event copied to userland, update counts. */
1162                 event ++;
1163                 i ++;
1164         }
1165
1166         if (min_nr <= i)
1167                 return i;
1168         if (ret)
1169                 return ret;
1170
1171         /* End fast path */
1172
1173         /* racey check, but it gets redone */
1174         if (!retry && unlikely(!list_empty(&ctx->run_list))) {
1175                 retry = 1;
1176                 aio_run_all_iocbs(ctx);
1177                 goto retry;
1178         }
1179
1180         init_timeout(&to);
1181         if (timeout) {
1182                 struct timespec ts;
1183                 ret = -EFAULT;
1184                 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1185                         goto out;
1186
1187                 set_timeout(start_jiffies, &to, &ts);
1188         }
1189
1190         while (likely(i < nr)) {
1191                 add_wait_queue_exclusive(&ctx->wait, &wait);
1192                 do {
1193                         set_task_state(tsk, TASK_INTERRUPTIBLE);
1194                         ret = aio_read_evt(ctx, &ent);
1195                         if (ret)
1196                                 break;
1197                         if (min_nr <= i)
1198                                 break;
1199                         ret = 0;
1200                         if (to.timed_out)       /* Only check after read evt */
1201                                 break;
1202                         schedule();
1203                         if (signal_pending(tsk)) {
1204                                 ret = -EINTR;
1205                                 break;
1206                         }
1207                         /*ret = aio_read_evt(ctx, &ent);*/
1208                 } while (1) ;
1209
1210                 set_task_state(tsk, TASK_RUNNING);
1211                 remove_wait_queue(&ctx->wait, &wait);
1212
1213                 if (unlikely(ret <= 0))
1214                         break;
1215
1216                 ret = -EFAULT;
1217                 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1218                         dprintk("aio: lost an event due to EFAULT.\n");
1219                         break;
1220                 }
1221
1222                 /* Good, event copied to userland, update counts. */
1223                 event ++;
1224                 i ++;
1225         }
1226
1227         if (timeout)
1228                 clear_timeout(&to);
1229 out:
1230         return i ? i : ret;
1231 }
1232
1233 /* Take an ioctx and remove it from the list of ioctx's.  Protects 
1234  * against races with itself via ->dead.
1235  */
1236 static void io_destroy(struct kioctx *ioctx)
1237 {
1238         struct mm_struct *mm = current->mm;
1239         struct kioctx **tmp;
1240         int was_dead;
1241
1242         /* delete the entry from the list is someone else hasn't already */
1243         write_lock(&mm->ioctx_list_lock);
1244         was_dead = ioctx->dead;
1245         ioctx->dead = 1;
1246         for (tmp = &mm->ioctx_list; *tmp && *tmp != ioctx;
1247              tmp = &(*tmp)->next)
1248                 ;
1249         if (*tmp)
1250                 *tmp = ioctx->next;
1251         write_unlock(&mm->ioctx_list_lock);
1252
1253         dprintk("aio_release(%p)\n", ioctx);
1254         if (likely(!was_dead))
1255                 put_ioctx(ioctx);       /* twice for the list */
1256
1257         aio_cancel_all(ioctx);
1258         wait_for_all_aios(ioctx);
1259         put_ioctx(ioctx);       /* once for the lookup */
1260 }
1261
1262 /* sys_io_setup:
1263  *      Create an aio_context capable of receiving at least nr_events.
1264  *      ctxp must not point to an aio_context that already exists, and
1265  *      must be initialized to 0 prior to the call.  On successful
1266  *      creation of the aio_context, *ctxp is filled in with the resulting 
1267  *      handle.  May fail with -EINVAL if *ctxp is not initialized,
1268  *      if the specified nr_events exceeds internal limits.  May fail 
1269  *      with -EAGAIN if the specified nr_events exceeds the user's limit 
1270  *      of available events.  May fail with -ENOMEM if insufficient kernel
1271  *      resources are available.  May fail with -EFAULT if an invalid
1272  *      pointer is passed for ctxp.  Will fail with -ENOSYS if not
1273  *      implemented.
1274  */
1275 asmlinkage long sys_io_setup(unsigned nr_events, aio_context_t __user *ctxp)
1276 {
1277         struct kioctx *ioctx = NULL;
1278         unsigned long ctx;
1279         long ret;
1280
1281         ret = get_user(ctx, ctxp);
1282         if (unlikely(ret))
1283                 goto out;
1284
1285         ret = -EINVAL;
1286         if (unlikely(ctx || (int)nr_events <= 0)) {
1287                 pr_debug("EINVAL: io_setup: ctx or nr_events > max\n");
1288                 goto out;
1289         }
1290
1291         ioctx = ioctx_alloc(nr_events);
1292         ret = PTR_ERR(ioctx);
1293         if (!IS_ERR(ioctx)) {
1294                 ret = put_user(ioctx->user_id, ctxp);
1295                 if (!ret)
1296                         return 0;
1297
1298                 get_ioctx(ioctx); /* io_destroy() expects us to hold a ref */
1299                 io_destroy(ioctx);
1300         }
1301
1302 out:
1303         return ret;
1304 }
1305
1306 /* sys_io_destroy:
1307  *      Destroy the aio_context specified.  May cancel any outstanding 
1308  *      AIOs and block on completion.  Will fail with -ENOSYS if not
1309  *      implemented.  May fail with -EFAULT if the context pointed to
1310  *      is invalid.
1311  */
1312 asmlinkage long sys_io_destroy(aio_context_t ctx)
1313 {
1314         struct kioctx *ioctx = lookup_ioctx(ctx);
1315         if (likely(NULL != ioctx)) {
1316                 io_destroy(ioctx);
1317                 return 0;
1318         }
1319         pr_debug("EINVAL: io_destroy: invalid context id\n");
1320         return -EINVAL;
1321 }
1322
1323 /*
1324  * Default retry method for aio_read (also used for first time submit)
1325  * Responsible for updating iocb state as retries progress
1326  */
1327 static ssize_t aio_pread(struct kiocb *iocb)
1328 {
1329         struct file *file = iocb->ki_filp;
1330         struct address_space *mapping = file->f_mapping;
1331         struct inode *inode = mapping->host;
1332         ssize_t ret = 0;
1333
1334         ret = file->f_op->aio_read(iocb, iocb->ki_buf,
1335                 iocb->ki_left, iocb->ki_pos);
1336
1337         /*
1338          * Can't just depend on iocb->ki_left to determine
1339          * whether we are done. This may have been a short read.
1340          */
1341         if (ret > 0) {
1342                 iocb->ki_buf += ret;
1343                 iocb->ki_left -= ret;
1344                 /*
1345                  * For pipes and sockets we return once we have
1346                  * some data; for regular files we retry till we
1347                  * complete the entire read or find that we can't
1348                  * read any more data (e.g short reads).
1349                  */
1350                 if (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))
1351                         ret = -EIOCBRETRY;
1352         }
1353
1354         /* This means we must have transferred all that we could */
1355         /* No need to retry anymore */
1356         if ((ret == 0) || (iocb->ki_left == 0))
1357                 ret = iocb->ki_nbytes - iocb->ki_left;
1358
1359         return ret;
1360 }
1361
1362 /*
1363  * Default retry method for aio_write (also used for first time submit)
1364  * Responsible for updating iocb state as retries progress
1365  */
1366 static ssize_t aio_pwrite(struct kiocb *iocb)
1367 {
1368         struct file *file = iocb->ki_filp;
1369         ssize_t ret = 0;
1370
1371         ret = file->f_op->aio_write(iocb, iocb->ki_buf,
1372                 iocb->ki_left, iocb->ki_pos);
1373
1374         if (ret > 0) {
1375                 iocb->ki_buf += ret;
1376                 iocb->ki_left -= ret;
1377
1378                 ret = -EIOCBRETRY;
1379         }
1380
1381         /* This means we must have transferred all that we could */
1382         /* No need to retry anymore */
1383         if ((ret == 0) || (iocb->ki_left == 0))
1384                 ret = iocb->ki_nbytes - iocb->ki_left;
1385
1386         return ret;
1387 }
1388
1389 static ssize_t aio_fdsync(struct kiocb *iocb)
1390 {
1391         struct file *file = iocb->ki_filp;
1392         ssize_t ret = -EINVAL;
1393
1394         if (file->f_op->aio_fsync)
1395                 ret = file->f_op->aio_fsync(iocb, 1);
1396         return ret;
1397 }
1398
1399 static ssize_t aio_fsync(struct kiocb *iocb)
1400 {
1401         struct file *file = iocb->ki_filp;
1402         ssize_t ret = -EINVAL;
1403
1404         if (file->f_op->aio_fsync)
1405                 ret = file->f_op->aio_fsync(iocb, 0);
1406         return ret;
1407 }
1408
1409 /*
1410  * aio_setup_iocb:
1411  *      Performs the initial checks and aio retry method
1412  *      setup for the kiocb at the time of io submission.
1413  */
1414 static ssize_t aio_setup_iocb(struct kiocb *kiocb)
1415 {
1416         struct file *file = kiocb->ki_filp;
1417         ssize_t ret = 0;
1418
1419         switch (kiocb->ki_opcode) {
1420         case IOCB_CMD_PREAD:
1421                 ret = -EBADF;
1422                 if (unlikely(!(file->f_mode & FMODE_READ)))
1423                         break;
1424                 ret = -EFAULT;
1425                 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1426                         kiocb->ki_left)))
1427                         break;
1428                 ret = -EINVAL;
1429                 if (file->f_op->aio_read)
1430                         kiocb->ki_retry = aio_pread;
1431                 break;
1432         case IOCB_CMD_PWRITE:
1433                 ret = -EBADF;
1434                 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1435                         break;
1436                 ret = -EFAULT;
1437                 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1438                         kiocb->ki_left)))
1439                         break;
1440                 ret = -EINVAL;
1441                 if (file->f_op->aio_write)
1442                         kiocb->ki_retry = aio_pwrite;
1443                 break;
1444         case IOCB_CMD_FDSYNC:
1445                 ret = -EINVAL;
1446                 if (file->f_op->aio_fsync)
1447                         kiocb->ki_retry = aio_fdsync;
1448                 break;
1449         case IOCB_CMD_FSYNC:
1450                 ret = -EINVAL;
1451                 if (file->f_op->aio_fsync)
1452                         kiocb->ki_retry = aio_fsync;
1453                 break;
1454         default:
1455                 dprintk("EINVAL: io_submit: no operation provided\n");
1456                 ret = -EINVAL;
1457         }
1458
1459         if (!kiocb->ki_retry)
1460                 return ret;
1461
1462         return 0;
1463 }
1464
1465 /*
1466  * aio_wake_function:
1467  *      wait queue callback function for aio notification,
1468  *      Simply triggers a retry of the operation via kick_iocb.
1469  *
1470  *      This callback is specified in the wait queue entry in
1471  *      a kiocb (current->io_wait points to this wait queue
1472  *      entry when an aio operation executes; it is used
1473  *      instead of a synchronous wait when an i/o blocking
1474  *      condition is encountered during aio).
1475  *
1476  * Note:
1477  * This routine is executed with the wait queue lock held.
1478  * Since kick_iocb acquires iocb->ctx->ctx_lock, it nests
1479  * the ioctx lock inside the wait queue lock. This is safe
1480  * because this callback isn't used for wait queues which
1481  * are nested inside ioctx lock (i.e. ctx->wait)
1482  */
1483 static int aio_wake_function(wait_queue_t *wait, unsigned mode,
1484                              int sync, void *key)
1485 {
1486         struct kiocb *iocb = container_of(wait, struct kiocb, ki_wait);
1487
1488         list_del_init(&wait->task_list);
1489         kick_iocb(iocb);
1490         return 1;
1491 }
1492
1493 int fastcall io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
1494                          struct iocb *iocb)
1495 {
1496         struct kiocb *req;
1497         struct file *file;
1498         ssize_t ret;
1499
1500         /* enforce forwards compatibility on users */
1501         if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2 ||
1502                      iocb->aio_reserved3)) {
1503                 pr_debug("EINVAL: io_submit: reserve field set\n");
1504                 return -EINVAL;
1505         }
1506
1507         /* prevent overflows */
1508         if (unlikely(
1509             (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1510             (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1511             ((ssize_t)iocb->aio_nbytes < 0)
1512            )) {
1513                 pr_debug("EINVAL: io_submit: overflow check\n");
1514                 return -EINVAL;
1515         }
1516
1517         file = fget(iocb->aio_fildes);
1518         if (unlikely(!file))
1519                 return -EBADF;
1520
1521         req = aio_get_req(ctx);         /* returns with 2 references to req */
1522         if (unlikely(!req)) {
1523                 fput(file);
1524                 return -EAGAIN;
1525         }
1526
1527         req->ki_filp = file;
1528         ret = put_user(req->ki_key, &user_iocb->aio_key);
1529         if (unlikely(ret)) {
1530                 dprintk("EFAULT: aio_key\n");
1531                 goto out_put_req;
1532         }
1533
1534         req->ki_obj.user = user_iocb;
1535         req->ki_user_data = iocb->aio_data;
1536         req->ki_pos = iocb->aio_offset;
1537
1538         req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1539         req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1540         req->ki_opcode = iocb->aio_lio_opcode;
1541         init_waitqueue_func_entry(&req->ki_wait, aio_wake_function);
1542         INIT_LIST_HEAD(&req->ki_wait.task_list);
1543         req->ki_retried = 0;
1544
1545         ret = aio_setup_iocb(req);
1546
1547         if (ret)
1548                 goto out_put_req;
1549
1550         spin_lock_irq(&ctx->ctx_lock);
1551         aio_run_iocb(req);
1552         unlock_kiocb(req);
1553         if (!list_empty(&ctx->run_list)) {
1554                 /* drain the run list */
1555                 while (__aio_run_iocbs(ctx))
1556                         ;
1557         }
1558         spin_unlock_irq(&ctx->ctx_lock);
1559         aio_put_req(req);       /* drop extra ref to req */
1560         return 0;
1561
1562 out_put_req:
1563         aio_put_req(req);       /* drop extra ref to req */
1564         aio_put_req(req);       /* drop i/o ref to req */
1565         return ret;
1566 }
1567
1568 /* sys_io_submit:
1569  *      Queue the nr iocbs pointed to by iocbpp for processing.  Returns
1570  *      the number of iocbs queued.  May return -EINVAL if the aio_context
1571  *      specified by ctx_id is invalid, if nr is < 0, if the iocb at
1572  *      *iocbpp[0] is not properly initialized, if the operation specified
1573  *      is invalid for the file descriptor in the iocb.  May fail with
1574  *      -EFAULT if any of the data structures point to invalid data.  May
1575  *      fail with -EBADF if the file descriptor specified in the first
1576  *      iocb is invalid.  May fail with -EAGAIN if insufficient resources
1577  *      are available to queue any iocbs.  Will return 0 if nr is 0.  Will
1578  *      fail with -ENOSYS if not implemented.
1579  */
1580 asmlinkage long sys_io_submit(aio_context_t ctx_id, long nr,
1581                               struct iocb __user * __user *iocbpp)
1582 {
1583         struct kioctx *ctx;
1584         long ret = 0;
1585         int i;
1586
1587         if (unlikely(nr < 0))
1588                 return -EINVAL;
1589
1590         if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1591                 return -EFAULT;
1592
1593         ctx = lookup_ioctx(ctx_id);
1594         if (unlikely(!ctx)) {
1595                 pr_debug("EINVAL: io_submit: invalid context id\n");
1596                 return -EINVAL;
1597         }
1598
1599         /*
1600          * AKPM: should this return a partial result if some of the IOs were
1601          * successfully submitted?
1602          */
1603         for (i=0; i<nr; i++) {
1604                 struct iocb __user *user_iocb;
1605                 struct iocb tmp;
1606
1607                 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1608                         ret = -EFAULT;
1609                         break;
1610                 }
1611
1612                 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1613                         ret = -EFAULT;
1614                         break;
1615                 }
1616
1617                 ret = io_submit_one(ctx, user_iocb, &tmp);
1618                 if (ret)
1619                         break;
1620         }
1621
1622         put_ioctx(ctx);
1623         return i ? i : ret;
1624 }
1625
1626 /* lookup_kiocb
1627  *      Finds a given iocb for cancellation.
1628  *      MUST be called with ctx->ctx_lock held.
1629  */
1630 static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1631                                   u32 key)
1632 {
1633         struct list_head *pos;
1634         /* TODO: use a hash or array, this sucks. */
1635         list_for_each(pos, &ctx->active_reqs) {
1636                 struct kiocb *kiocb = list_kiocb(pos);
1637                 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1638                         return kiocb;
1639         }
1640         return NULL;
1641 }
1642
1643 /* sys_io_cancel:
1644  *      Attempts to cancel an iocb previously passed to io_submit.  If
1645  *      the operation is successfully cancelled, the resulting event is
1646  *      copied into the memory pointed to by result without being placed
1647  *      into the completion queue and 0 is returned.  May fail with
1648  *      -EFAULT if any of the data structures pointed to are invalid.
1649  *      May fail with -EINVAL if aio_context specified by ctx_id is
1650  *      invalid.  May fail with -EAGAIN if the iocb specified was not
1651  *      cancelled.  Will fail with -ENOSYS if not implemented.
1652  */
1653 asmlinkage long sys_io_cancel(aio_context_t ctx_id, struct iocb __user *iocb,
1654                               struct io_event __user *result)
1655 {
1656         int (*cancel)(struct kiocb *iocb, struct io_event *res);
1657         struct kioctx *ctx;
1658         struct kiocb *kiocb;
1659         u32 key;
1660         int ret;
1661
1662         ret = get_user(key, &iocb->aio_key);
1663         if (unlikely(ret))
1664                 return -EFAULT;
1665
1666         ctx = lookup_ioctx(ctx_id);
1667         if (unlikely(!ctx))
1668                 return -EINVAL;
1669
1670         spin_lock_irq(&ctx->ctx_lock);
1671         ret = -EAGAIN;
1672         kiocb = lookup_kiocb(ctx, iocb, key);
1673         if (kiocb && kiocb->ki_cancel) {
1674                 cancel = kiocb->ki_cancel;
1675                 kiocb->ki_users ++;
1676                 kiocbSetCancelled(kiocb);
1677         } else
1678                 cancel = NULL;
1679         spin_unlock_irq(&ctx->ctx_lock);
1680
1681         if (NULL != cancel) {
1682                 struct io_event tmp;
1683                 pr_debug("calling cancel\n");
1684                 lock_kiocb(kiocb);
1685                 memset(&tmp, 0, sizeof(tmp));
1686                 tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
1687                 tmp.data = kiocb->ki_user_data;
1688                 ret = cancel(kiocb, &tmp);
1689                 if (!ret) {
1690                         /* Cancellation succeeded -- copy the result
1691                          * into the user's buffer.
1692                          */
1693                         if (copy_to_user(result, &tmp, sizeof(tmp)))
1694                                 ret = -EFAULT;
1695                 }
1696                 unlock_kiocb(kiocb);
1697         } else
1698                 ret = -EINVAL;
1699
1700         put_ioctx(ctx);
1701
1702         return ret;
1703 }
1704
1705 /* io_getevents:
1706  *      Attempts to read at least min_nr events and up to nr events from
1707  *      the completion queue for the aio_context specified by ctx_id.  May
1708  *      fail with -EINVAL if ctx_id is invalid, if min_nr is out of range,
1709  *      if nr is out of range, if when is out of range.  May fail with
1710  *      -EFAULT if any of the memory specified to is invalid.  May return
1711  *      0 or < min_nr if no events are available and the timeout specified
1712  *      by when has elapsed, where when == NULL specifies an infinite
1713  *      timeout.  Note that the timeout pointed to by when is relative and
1714  *      will be updated if not NULL and the operation blocks.  Will fail
1715  *      with -ENOSYS if not implemented.
1716  */
1717 asmlinkage long sys_io_getevents(aio_context_t ctx_id,
1718                                  long min_nr,
1719                                  long nr,
1720                                  struct io_event __user *events,
1721                                  struct timespec __user *timeout)
1722 {
1723         struct kioctx *ioctx = lookup_ioctx(ctx_id);
1724         long ret = -EINVAL;
1725
1726         if (likely(ioctx)) {
1727                 if (likely(min_nr <= nr && min_nr >= 0 && nr >= 0))
1728                         ret = read_events(ioctx, min_nr, nr, events, timeout);
1729                 put_ioctx(ioctx);
1730         }
1731
1732         return ret;
1733 }
1734
1735 __initcall(aio_setup);
1736
1737 EXPORT_SYMBOL(aio_complete);
1738 EXPORT_SYMBOL(aio_put_req);
1739 EXPORT_SYMBOL(wait_on_sync_kiocb);