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