fs/aio.c

   1 /*
   2  *      An async IO implementation for Linux
   3  *      Written by Benjamin LaHaise <bcrl@kvack.org>
   4  *
   5  *      Implements an efficient asynchronous io interface.
   6  *
   7  *      Copyright 2000, 2001, 2002 Red Hat, Inc.  All Rights Reserved.
   8  *
   9  *      See ../COPYING for licensing terms.
  10  */
  11 #define pr_fmt(fmt) "%s: " fmt, __func__
  12
  13 #include <linux/kernel.h>
  14 #include <linux/init.h>
  15 #include <linux/errno.h>
  16 #include <linux/time.h>
  17 #include <linux/aio_abi.h>
  18 #include <linux/export.h>
  19 #include <linux/syscalls.h>
  20 #include <linux/backing-dev.h>
  21 #include <linux/uio.h>
  22
  23 #include <linux/sched.h>
  24 #include <linux/fs.h>
  25 #include <linux/file.h>
  26 #include <linux/mm.h>
  27 #include <linux/mman.h>
  28 #include <linux/mmu_context.h>
  29 #include <linux/percpu.h>
  30 #include <linux/slab.h>
  31 #include <linux/timer.h>
  32 #include <linux/aio.h>
  33 #include <linux/highmem.h>
  34 #include <linux/workqueue.h>
  35 #include <linux/security.h>
  36 #include <linux/eventfd.h>
  37 #include <linux/blkdev.h>
  38 #include <linux/compat.h>
  39 #include <linux/migrate.h>
  40 #include <linux/ramfs.h>
  41 #include <linux/percpu-refcount.h>
  42 #include <linux/mount.h>
  43 #include <linux/swork.h>
  44
  45 #include <asm/kmap_types.h>
  46 #include <asm/uaccess.h>
  47
  48 #include "internal.h"
  49
  50 #define AIO_RING_MAGIC                  0xa10a10a1
  51 #define AIO_RING_COMPAT_FEATURES        1
  52 #define AIO_RING_INCOMPAT_FEATURES      0
  53 struct aio_ring {
  54         unsigned        id;     /* kernel internal index number */
  55         unsigned        nr;     /* number of io_events */
  56         unsigned        head;   /* Written to by userland or under ring_lock
  57                                  * mutex by aio_read_events_ring(). */
  58         unsigned        tail;
  59
  60         unsigned        magic;
  61         unsigned        compat_features;
  62         unsigned        incompat_features;
  63         unsigned        header_length;  /* size of aio_ring */
  64
  65
  66         struct io_event         io_events[0];
  67 }; /* 128 bytes + ring size */
  68
  69 #define AIO_RING_PAGES  8
  70
  71 struct kioctx_table {
  72         struct rcu_head rcu;
  73         unsigned        nr;
  74         struct kioctx   *table[];
  75 };
  76
  77 struct kioctx_cpu {
  78         unsigned                reqs_available;
  79 };
  80
  81 struct ctx_rq_wait {
  82         struct completion comp;
  83         atomic_t count;
  84 };
  85
  86 struct kioctx {
  87         struct percpu_ref       users;
  88         atomic_t                dead;
  89
  90         struct percpu_ref       reqs;
  91
  92         unsigned long           user_id;
  93
  94         struct __percpu kioctx_cpu *cpu;
  95
  96         /*
  97          * For percpu reqs_available, number of slots we move to/from global
  98          * counter at a time:
  99          */
 100         unsigned                req_batch;
 101         /*
 102          * This is what userspace passed to io_setup(), it's not used for
 103          * anything but counting against the global max_reqs quota.
 104          *
 105          * The real limit is nr_events - 1, which will be larger (see
 106          * aio_setup_ring())
 107          */
 108         unsigned                max_reqs;
 109
 110         /* Size of ringbuffer, in units of struct io_event */
 111         unsigned                nr_events;
 112
 113         unsigned long           mmap_base;
 114         unsigned long           mmap_size;
 115
 116         struct page             **ring_pages;
 117         long                    nr_pages;
 118
 119         struct swork_event      free_work;
 120
 121         /*
 122          * signals when all in-flight requests are done
 123          */
 124         struct ctx_rq_wait      *rq_wait;
 125
 126         struct {
 127                 /*
 128                  * This counts the number of available slots in the ringbuffer,
 129                  * so we avoid overflowing it: it's decremented (if positive)
 130                  * when allocating a kiocb and incremented when the resulting
 131                  * io_event is pulled off the ringbuffer.
 132                  *
 133                  * We batch accesses to it with a percpu version.
 134                  */
 135                 atomic_t        reqs_available;
 136         } ____cacheline_aligned_in_smp;
 137
 138         struct {
 139                 spinlock_t      ctx_lock;
 140                 struct list_head active_reqs;   /* used for cancellation */
 141         } ____cacheline_aligned_in_smp;
 142
 143         struct {
 144                 struct mutex    ring_lock;
 145                 wait_queue_head_t wait;
 146         } ____cacheline_aligned_in_smp;
 147
 148         struct {
 149                 unsigned        tail;
 150                 unsigned        completed_events;
 151                 spinlock_t      completion_lock;
 152         } ____cacheline_aligned_in_smp;
 153
 154         struct page             *internal_pages[AIO_RING_PAGES];
 155         struct file             *aio_ring_file;
 156
 157         unsigned                id;
 158 };
 159
 160 /*
 161  * We use ki_cancel == KIOCB_CANCELLED to indicate that a kiocb has been either
 162  * cancelled or completed (this makes a certain amount of sense because
 163  * successful cancellation - io_cancel() - does deliver the completion to
 164  * userspace).
 165  *
 166  * And since most things don't implement kiocb cancellation and we'd really like
 167  * kiocb completion to be lockless when possible, we use ki_cancel to
 168  * synchronize cancellation and completion - we only set it to KIOCB_CANCELLED
 169  * with xchg() or cmpxchg(), see batch_complete_aio() and kiocb_cancel().
 170  */
 171 #define KIOCB_CANCELLED         ((void *) (~0ULL))
 172
 173 struct aio_kiocb {
 174         struct kiocb            common;
 175
 176         struct kioctx           *ki_ctx;
 177         kiocb_cancel_fn         *ki_cancel;
 178
 179         struct iocb __user      *ki_user_iocb;  /* user's aiocb */
 180         __u64                   ki_user_data;   /* user's data for completion */
 181
 182         struct list_head        ki_list;        /* the aio core uses this
 183                                                  * for cancellation */
 184
 185         /*
 186          * If the aio_resfd field of the userspace iocb is not zero,
 187          * this is the underlying eventfd context to deliver events to.
 188          */
 189         struct eventfd_ctx      *ki_eventfd;
 190 };
 191
 192 /*------ sysctl variables----*/
 193 static DEFINE_SPINLOCK(aio_nr_lock);
 194 unsigned long aio_nr;           /* current system wide number of aio requests */
 195 unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
 196 /*----end sysctl variables---*/
 197
 198 static struct kmem_cache        *kiocb_cachep;
 199 static struct kmem_cache        *kioctx_cachep;
 200
 201 static struct vfsmount *aio_mnt;
 202
 203 static const struct file_operations aio_ring_fops;
 204 static const struct address_space_operations aio_ctx_aops;
 205
 206 static struct file *aio_private_file(struct kioctx *ctx, loff_t nr_pages)
 207 {
 208         struct qstr this = QSTR_INIT("[aio]", 5);
 209         struct file *file;
 210         struct path path;
 211         struct inode *inode = alloc_anon_inode(aio_mnt->mnt_sb);
 212         if (IS_ERR(inode))
 213                 return ERR_CAST(inode);
 214
 215         inode->i_mapping->a_ops = &aio_ctx_aops;
 216         inode->i_mapping->private_data = ctx;
 217         inode->i_size = PAGE_SIZE * nr_pages;
 218
 219         path.dentry = d_alloc_pseudo(aio_mnt->mnt_sb, &this);
 220         if (!path.dentry) {
 221                 iput(inode);
 222                 return ERR_PTR(-ENOMEM);
 223         }
 224         path.mnt = mntget(aio_mnt);
 225
 226         d_instantiate(path.dentry, inode);
 227         file = alloc_file(&path, FMODE_READ | FMODE_WRITE, &aio_ring_fops);
 228         if (IS_ERR(file)) {
 229                 path_put(&path);
 230                 return file;
 231         }
 232
 233         file->f_flags = O_RDWR;
 234         return file;
 235 }
 236
 237 static struct dentry *aio_mount(struct file_system_type *fs_type,
 238                                 int flags, const char *dev_name, void *data)
 239 {
 240         static const struct dentry_operations ops = {
 241                 .d_dname        = simple_dname,
 242         };
 243         struct dentry *root = mount_pseudo(fs_type, "aio:", NULL, &ops,
 244                                            AIO_RING_MAGIC);
 245
 246         if (!IS_ERR(root))
 247                 root->d_sb->s_iflags |= SB_I_NOEXEC;
 248         return root;
 249 }
 250
 251 /* aio_setup
 252  *      Creates the slab caches used by the aio routines, panic on
 253  *      failure as this is done early during the boot sequence.
 254  */
 255 static int __init aio_setup(void)
 256 {
 257         static struct file_system_type aio_fs = {
 258                 .name           = "aio",
 259                 .mount          = aio_mount,
 260                 .kill_sb        = kill_anon_super,
 261         };
 262         BUG_ON(swork_get());
 263         aio_mnt = kern_mount(&aio_fs);
 264         if (IS_ERR(aio_mnt))
 265                 panic("Failed to create aio fs mount.");
 266
 267         kiocb_cachep = KMEM_CACHE(aio_kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
 268         kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
 269
 270         pr_debug("sizeof(struct page) = %zu\n", sizeof(struct page));
 271
 272         return 0;
 273 }
 274 __initcall(aio_setup);
 275
 276 static void put_aio_ring_file(struct kioctx *ctx)
 277 {
 278         struct file *aio_ring_file = ctx->aio_ring_file;
 279         struct address_space *i_mapping;
 280
 281         if (aio_ring_file) {
 282                 truncate_setsize(aio_ring_file->f_inode, 0);
 283
 284                 /* Prevent further access to the kioctx from migratepages */
 285                 i_mapping = aio_ring_file->f_inode->i_mapping;
 286                 spin_lock(&i_mapping->private_lock);
 287                 i_mapping->private_data = NULL;
 288                 ctx->aio_ring_file = NULL;
 289                 spin_unlock(&i_mapping->private_lock);
 290
 291                 fput(aio_ring_file);
 292         }
 293 }
 294
 295 static void aio_free_ring(struct kioctx *ctx)
 296 {
 297         int i;
 298
 299         /* Disconnect the kiotx from the ring file.  This prevents future
 300          * accesses to the kioctx from page migration.
 301          */
 302         put_aio_ring_file(ctx);
 303
 304         for (i = 0; i < ctx->nr_pages; i++) {
 305                 struct page *page;
 306                 pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
 307                                 page_count(ctx->ring_pages[i]));
 308                 page = ctx->ring_pages[i];
 309                 if (!page)
 310                         continue;
 311                 ctx->ring_pages[i] = NULL;
 312                 put_page(page);
 313         }
 314
 315         if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
 316                 kfree(ctx->ring_pages);
 317                 ctx->ring_pages = NULL;
 318         }
 319 }
 320
 321 static int aio_ring_mremap(struct vm_area_struct *vma)
 322 {
 323         struct file *file = vma->vm_file;
 324         struct mm_struct *mm = vma->vm_mm;
 325         struct kioctx_table *table;
 326         int i, res = -EINVAL;
 327
 328         spin_lock(&mm->ioctx_lock);
 329         rcu_read_lock();
 330         table = rcu_dereference(mm->ioctx_table);
 331         for (i = 0; i < table->nr; i++) {
 332                 struct kioctx *ctx;
 333
 334                 ctx = table->table[i];
 335                 if (ctx && ctx->aio_ring_file == file) {
 336                         if (!atomic_read(&ctx->dead)) {
 337                                 ctx->user_id = ctx->mmap_base = vma->vm_start;
 338                                 res = 0;
 339                         }
 340                         break;
 341                 }
 342         }
 343
 344         rcu_read_unlock();
 345         spin_unlock(&mm->ioctx_lock);
 346         return res;
 347 }
 348
 349 static const struct vm_operations_struct aio_ring_vm_ops = {
 350         .mremap         = aio_ring_mremap,
 351 #if IS_ENABLED(CONFIG_MMU)
 352         .fault          = filemap_fault,
 353         .map_pages      = filemap_map_pages,
 354         .page_mkwrite   = filemap_page_mkwrite,
 355 #endif
 356 };
 357
 358 static int aio_ring_mmap(struct file *file, struct vm_area_struct *vma)
 359 {
 360         vma->vm_flags |= VM_DONTEXPAND;
 361         vma->vm_ops = &aio_ring_vm_ops;
 362         return 0;
 363 }
 364
 365 static const struct file_operations aio_ring_fops = {
 366         .mmap = aio_ring_mmap,
 367 };
 368
 369 #if IS_ENABLED(CONFIG_MIGRATION)
 370 static int aio_migratepage(struct address_space *mapping, struct page *new,
 371                         struct page *old, enum migrate_mode mode)
 372 {
 373         struct kioctx *ctx;
 374         unsigned long flags;
 375         pgoff_t idx;
 376         int rc;
 377
 378         rc = 0;
 379
 380         /* mapping->private_lock here protects against the kioctx teardown.  */
 381         spin_lock(&mapping->private_lock);
 382         ctx = mapping->private_data;
 383         if (!ctx) {
 384                 rc = -EINVAL;
 385                 goto out;
 386         }
 387
 388         /* The ring_lock mutex.  The prevents aio_read_events() from writing
 389          * to the ring's head, and prevents page migration from mucking in
 390          * a partially initialized kiotx.
 391          */
 392         if (!mutex_trylock(&ctx->ring_lock)) {
 393                 rc = -EAGAIN;
 394                 goto out;
 395         }
 396
 397         idx = old->index;
 398         if (idx < (pgoff_t)ctx->nr_pages) {
 399                 /* Make sure the old page hasn't already been changed */
 400                 if (ctx->ring_pages[idx] != old)
 401                         rc = -EAGAIN;
 402         } else
 403                 rc = -EINVAL;
 404
 405         if (rc != 0)
 406                 goto out_unlock;
 407
 408         /* Writeback must be complete */
 409         BUG_ON(PageWriteback(old));
 410         get_page(new);
 411
 412         rc = migrate_page_move_mapping(mapping, new, old, NULL, mode, 1);
 413         if (rc != MIGRATEPAGE_SUCCESS) {
 414                 put_page(new);
 415                 goto out_unlock;
 416         }
 417
 418         /* Take completion_lock to prevent other writes to the ring buffer
 419          * while the old page is copied to the new.  This prevents new
 420          * events from being lost.
 421          */
 422         spin_lock_irqsave(&ctx->completion_lock, flags);
 423         migrate_page_copy(new, old);
 424         BUG_ON(ctx->ring_pages[idx] != old);
 425         ctx->ring_pages[idx] = new;
 426         spin_unlock_irqrestore(&ctx->completion_lock, flags);
 427
 428         /* The old page is no longer accessible. */
 429         put_page(old);
 430
 431 out_unlock:
 432         mutex_unlock(&ctx->ring_lock);
 433 out:
 434         spin_unlock(&mapping->private_lock);
 435         return rc;
 436 }
 437 #endif
 438
 439 static const struct address_space_operations aio_ctx_aops = {
 440         .set_page_dirty = __set_page_dirty_no_writeback,
 441 #if IS_ENABLED(CONFIG_MIGRATION)
 442         .migratepage    = aio_migratepage,
 443 #endif
 444 };
 445
 446 static int aio_setup_ring(struct kioctx *ctx)
 447 {
 448         struct aio_ring *ring;
 449         unsigned nr_events = ctx->max_reqs;
 450         struct mm_struct *mm = current->mm;
 451         unsigned long size, unused;
 452         int nr_pages;
 453         int i;
 454         struct file *file;
 455
 456         /* Compensate for the ring buffer's head/tail overlap entry */
 457         nr_events += 2; /* 1 is required, 2 for good luck */
 458
 459         size = sizeof(struct aio_ring);
 460         size += sizeof(struct io_event) * nr_events;
 461
 462         nr_pages = PFN_UP(size);
 463         if (nr_pages < 0)
 464                 return -EINVAL;
 465
 466         file = aio_private_file(ctx, nr_pages);
 467         if (IS_ERR(file)) {
 468                 ctx->aio_ring_file = NULL;
 469                 return -ENOMEM;
 470         }
 471
 472         ctx->aio_ring_file = file;
 473         nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring))
 474                         / sizeof(struct io_event);
 475
 476         ctx->ring_pages = ctx->internal_pages;
 477         if (nr_pages > AIO_RING_PAGES) {
 478                 ctx->ring_pages = kcalloc(nr_pages, sizeof(struct page *),
 479                                           GFP_KERNEL);
 480                 if (!ctx->ring_pages) {
 481                         put_aio_ring_file(ctx);
 482                         return -ENOMEM;
 483                 }
 484         }
 485
 486         for (i = 0; i < nr_pages; i++) {
 487                 struct page *page;
 488                 page = find_or_create_page(file->f_inode->i_mapping,
 489                                            i, GFP_HIGHUSER | __GFP_ZERO);
 490                 if (!page)
 491                         break;
 492                 pr_debug("pid(%d) page[%d]->count=%d\n",
 493                          current->pid, i, page_count(page));
 494                 SetPageUptodate(page);
 495                 unlock_page(page);
 496
 497                 ctx->ring_pages[i] = page;
 498         }
 499         ctx->nr_pages = i;
 500
 501         if (unlikely(i != nr_pages)) {
 502                 aio_free_ring(ctx);
 503                 return -ENOMEM;
 504         }
 505
 506         ctx->mmap_size = nr_pages * PAGE_SIZE;
 507         pr_debug("attempting mmap of %lu bytes\n", ctx->mmap_size);
 508
 509         if (down_write_killable(&mm->mmap_sem)) {
 510                 ctx->mmap_size = 0;
 511                 aio_free_ring(ctx);
 512                 return -EINTR;
 513         }
 514
 515         ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
 516                                        PROT_READ | PROT_WRITE,
 517                                        MAP_SHARED, 0, &unused);
 518         up_write(&mm->mmap_sem);
 519         if (IS_ERR((void *)ctx->mmap_base)) {
 520                 ctx->mmap_size = 0;
 521                 aio_free_ring(ctx);
 522                 return -ENOMEM;
 523         }
 524
 525         pr_debug("mmap address: 0x%08lx\n", ctx->mmap_base);
 526
 527         ctx->user_id = ctx->mmap_base;
 528         ctx->nr_events = nr_events; /* trusted copy */
 529
 530         ring = kmap_atomic(ctx->ring_pages[0]);
 531         ring->nr = nr_events;   /* user copy */
 532         ring->id = ~0U;
 533         ring->head = ring->tail = 0;
 534         ring->magic = AIO_RING_MAGIC;
 535         ring->compat_features = AIO_RING_COMPAT_FEATURES;
 536         ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
 537         ring->header_length = sizeof(struct aio_ring);
 538         kunmap_atomic(ring);
 539         flush_dcache_page(ctx->ring_pages[0]);
 540
 541         return 0;
 542 }
 543
 544 #define AIO_EVENTS_PER_PAGE     (PAGE_SIZE / sizeof(struct io_event))
 545 #define AIO_EVENTS_FIRST_PAGE   ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
 546 #define AIO_EVENTS_OFFSET       (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
 547
 548 void kiocb_set_cancel_fn(struct kiocb *iocb, kiocb_cancel_fn *cancel)
 549 {
 550         struct aio_kiocb *req = container_of(iocb, struct aio_kiocb, common);
 551         struct kioctx *ctx = req->ki_ctx;
 552         unsigned long flags;
 553
 554         spin_lock_irqsave(&ctx->ctx_lock, flags);
 555
 556         if (!req->ki_list.next)
 557                 list_add(&req->ki_list, &ctx->active_reqs);
 558
 559         req->ki_cancel = cancel;
 560
 561         spin_unlock_irqrestore(&ctx->ctx_lock, flags);
 562 }
 563 EXPORT_SYMBOL(kiocb_set_cancel_fn);
 564
 565 static int kiocb_cancel(struct aio_kiocb *kiocb)
 566 {
 567         kiocb_cancel_fn *old, *cancel;
 568
 569         /*
 570          * Don't want to set kiocb->ki_cancel = KIOCB_CANCELLED unless it
 571          * actually has a cancel function, hence the cmpxchg()
 572          */
 573
 574         cancel = ACCESS_ONCE(kiocb->ki_cancel);
 575         do {
 576                 if (!cancel || cancel == KIOCB_CANCELLED)
 577                         return -EINVAL;
 578
 579                 old = cancel;
 580                 cancel = cmpxchg(&kiocb->ki_cancel, old, KIOCB_CANCELLED);
 581         } while (cancel != old);
 582
 583         return cancel(&kiocb->common);
 584 }
 585
 586 static void free_ioctx(struct swork_event *sev)
 587 {
 588         struct kioctx *ctx = container_of(sev, struct kioctx, free_work);
 589
 590         pr_debug("freeing %p\n", ctx);
 591
 592         aio_free_ring(ctx);
 593         free_percpu(ctx->cpu);
 594         percpu_ref_exit(&ctx->reqs);
 595         percpu_ref_exit(&ctx->users);
 596         kmem_cache_free(kioctx_cachep, ctx);
 597 }
 598
 599 static void free_ioctx_reqs(struct percpu_ref *ref)
 600 {
 601         struct kioctx *ctx = container_of(ref, struct kioctx, reqs);
 602
 603         /* At this point we know that there are no any in-flight requests */
 604         if (ctx->rq_wait && atomic_dec_and_test(&ctx->rq_wait->count))
 605                 complete(&ctx->rq_wait->comp);
 606
 607         INIT_SWORK(&ctx->free_work, free_ioctx);
 608         swork_queue(&ctx->free_work);
 609 }
 610
 611 /*
 612  * When this function runs, the kioctx has been removed from the "hash table"
 613  * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
 614  * now it's safe to cancel any that need to be.
 615  */
 616 static void free_ioctx_users_work(struct swork_event *sev)
 617 {
 618         struct kioctx *ctx = container_of(sev, struct kioctx, free_work);
 619         struct aio_kiocb *req;
 620
 621         spin_lock_irq(&ctx->ctx_lock);
 622
 623         while (!list_empty(&ctx->active_reqs)) {
 624                 req = list_first_entry(&ctx->active_reqs,
 625                                        struct aio_kiocb, ki_list);
 626
 627                 list_del_init(&req->ki_list);
 628                 kiocb_cancel(req);
 629         }
 630
 631         spin_unlock_irq(&ctx->ctx_lock);
 632
 633         percpu_ref_kill(&ctx->reqs);
 634         percpu_ref_put(&ctx->reqs);
 635 }
 636
 637 static void free_ioctx_users(struct percpu_ref *ref)
 638 {
 639         struct kioctx *ctx = container_of(ref, struct kioctx, users);
 640
 641         INIT_SWORK(&ctx->free_work, free_ioctx_users_work);
 642         swork_queue(&ctx->free_work);
 643 }
 644
 645 static int ioctx_add_table(struct kioctx *ctx, struct mm_struct *mm)
 646 {
 647         unsigned i, new_nr;
 648         struct kioctx_table *table, *old;
 649         struct aio_ring *ring;
 650
 651         spin_lock(&mm->ioctx_lock);
 652         table = rcu_dereference_raw(mm->ioctx_table);
 653
 654         while (1) {
 655                 if (table)
 656                         for (i = 0; i < table->nr; i++)
 657                                 if (!table->table[i]) {
 658                                         ctx->id = i;
 659                                         table->table[i] = ctx;
 660                                         spin_unlock(&mm->ioctx_lock);
 661
 662                                         /* While kioctx setup is in progress,
 663                                          * we are protected from page migration
 664                                          * changes ring_pages by ->ring_lock.
 665                                          */
 666                                         ring = kmap_atomic(ctx->ring_pages[0]);
 667                                         ring->id = ctx->id;
 668                                         kunmap_atomic(ring);
 669                                         return 0;
 670                                 }
 671
 672                 new_nr = (table ? table->nr : 1) * 4;
 673                 spin_unlock(&mm->ioctx_lock);
 674
 675                 table = kzalloc(sizeof(*table) + sizeof(struct kioctx *) *
 676                                 new_nr, GFP_KERNEL);
 677                 if (!table)
 678                         return -ENOMEM;
 679
 680                 table->nr = new_nr;
 681
 682                 spin_lock(&mm->ioctx_lock);
 683                 old = rcu_dereference_raw(mm->ioctx_table);
 684
 685                 if (!old) {
 686                         rcu_assign_pointer(mm->ioctx_table, table);
 687                 } else if (table->nr > old->nr) {
 688                         memcpy(table->table, old->table,
 689                                old->nr * sizeof(struct kioctx *));
 690
 691                         rcu_assign_pointer(mm->ioctx_table, table);
 692                         kfree_rcu(old, rcu);
 693                 } else {
 694                         kfree(table);
 695                         table = old;
 696                 }
 697         }
 698 }
 699
 700 static void aio_nr_sub(unsigned nr)
 701 {
 702         spin_lock(&aio_nr_lock);
 703         if (WARN_ON(aio_nr - nr > aio_nr))
 704                 aio_nr = 0;
 705         else
 706                 aio_nr -= nr;
 707         spin_unlock(&aio_nr_lock);
 708 }
 709
 710 /* ioctx_alloc
 711  *      Allocates and initializes an ioctx.  Returns an ERR_PTR if it failed.
 712  */
 713 static struct kioctx *ioctx_alloc(unsigned nr_events)
 714 {
 715         struct mm_struct *mm = current->mm;
 716         struct kioctx *ctx;
 717         int err = -ENOMEM;
 718
 719         /*
 720          * We keep track of the number of available ringbuffer slots, to prevent
 721          * overflow (reqs_available), and we also use percpu counters for this.
 722          *
 723          * So since up to half the slots might be on other cpu's percpu counters
 724          * and unavailable, double nr_events so userspace sees what they
 725          * expected: additionally, we move req_batch slots to/from percpu
 726          * counters at a time, so make sure that isn't 0:
 727          */
 728         nr_events = max(nr_events, num_possible_cpus() * 4);
 729         nr_events *= 2;
 730
 731         /* Prevent overflows */
 732         if (nr_events > (0x10000000U / sizeof(struct io_event))) {
 733                 pr_debug("ENOMEM: nr_events too high\n");
 734                 return ERR_PTR(-EINVAL);
 735         }
 736
 737         if (!nr_events || (unsigned long)nr_events > (aio_max_nr * 2UL))
 738                 return ERR_PTR(-EAGAIN);
 739
 740         ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
 741         if (!ctx)
 742                 return ERR_PTR(-ENOMEM);
 743
 744         ctx->max_reqs = nr_events;
 745
 746         spin_lock_init(&ctx->ctx_lock);
 747         spin_lock_init(&ctx->completion_lock);
 748         mutex_init(&ctx->ring_lock);
 749         /* Protect against page migration throughout kiotx setup by keeping
 750          * the ring_lock mutex held until setup is complete. */
 751         mutex_lock(&ctx->ring_lock);
 752         init_waitqueue_head(&ctx->wait);
 753
 754         INIT_LIST_HEAD(&ctx->active_reqs);
 755
 756         if (percpu_ref_init(&ctx->users, free_ioctx_users, 0, GFP_KERNEL))
 757                 goto err;
 758
 759         if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs, 0, GFP_KERNEL))
 760                 goto err;
 761
 762         ctx->cpu = alloc_percpu(struct kioctx_cpu);
 763         if (!ctx->cpu)
 764                 goto err;
 765
 766         err = aio_setup_ring(ctx);
 767         if (err < 0)
 768                 goto err;
 769
 770         atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
 771         ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
 772         if (ctx->req_batch < 1)
 773                 ctx->req_batch = 1;
 774
 775         /* limit the number of system wide aios */
 776         spin_lock(&aio_nr_lock);
 777         if (aio_nr + nr_events > (aio_max_nr * 2UL) ||
 778             aio_nr + nr_events < aio_nr) {
 779                 spin_unlock(&aio_nr_lock);
 780                 err = -EAGAIN;
 781                 goto err_ctx;
 782         }
 783         aio_nr += ctx->max_reqs;
 784         spin_unlock(&aio_nr_lock);
 785
 786         percpu_ref_get(&ctx->users);    /* io_setup() will drop this ref */
 787         percpu_ref_get(&ctx->reqs);     /* free_ioctx_users() will drop this */
 788
 789         err = ioctx_add_table(ctx, mm);
 790         if (err)
 791                 goto err_cleanup;
 792
 793         /* Release the ring_lock mutex now that all setup is complete. */
 794         mutex_unlock(&ctx->ring_lock);
 795
 796         pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
 797                  ctx, ctx->user_id, mm, ctx->nr_events);
 798         return ctx;
 799
 800 err_cleanup:
 801         aio_nr_sub(ctx->max_reqs);
 802 err_ctx:
 803         atomic_set(&ctx->dead, 1);
 804         if (ctx->mmap_size)
 805                 vm_munmap(ctx->mmap_base, ctx->mmap_size);
 806         aio_free_ring(ctx);
 807 err:
 808         mutex_unlock(&ctx->ring_lock);
 809         free_percpu(ctx->cpu);
 810         percpu_ref_exit(&ctx->reqs);
 811         percpu_ref_exit(&ctx->users);
 812         kmem_cache_free(kioctx_cachep, ctx);
 813         pr_debug("error allocating ioctx %d\n", err);
 814         return ERR_PTR(err);
 815 }
 816
 817 /* kill_ioctx
 818  *      Cancels all outstanding aio requests on an aio context.  Used
 819  *      when the processes owning a context have all exited to encourage
 820  *      the rapid destruction of the kioctx.
 821  */
 822 static int kill_ioctx(struct mm_struct *mm, struct kioctx *ctx,
 823                       struct ctx_rq_wait *wait)
 824 {
 825         struct kioctx_table *table;
 826
 827         spin_lock(&mm->ioctx_lock);
 828         if (atomic_xchg(&ctx->dead, 1)) {
 829                 spin_unlock(&mm->ioctx_lock);
 830                 return -EINVAL;
 831         }
 832
 833         table = rcu_dereference_raw(mm->ioctx_table);
 834         WARN_ON(ctx != table->table[ctx->id]);
 835         table->table[ctx->id] = NULL;
 836         spin_unlock(&mm->ioctx_lock);
 837
 838         /* percpu_ref_kill() will do the necessary call_rcu() */
 839         wake_up_all(&ctx->wait);
 840
 841         /*
 842          * It'd be more correct to do this in free_ioctx(), after all
 843          * the outstanding kiocbs have finished - but by then io_destroy
 844          * has already returned, so io_setup() could potentially return
 845          * -EAGAIN with no ioctxs actually in use (as far as userspace
 846          *  could tell).
 847          */
 848         aio_nr_sub(ctx->max_reqs);
 849
 850         if (ctx->mmap_size)
 851                 vm_munmap(ctx->mmap_base, ctx->mmap_size);
 852
 853         ctx->rq_wait = wait;
 854         percpu_ref_kill(&ctx->users);
 855         return 0;
 856 }
 857
 858 /*
 859  * exit_aio: called when the last user of mm goes away.  At this point, there is
 860  * no way for any new requests to be submited or any of the io_* syscalls to be
 861  * called on the context.
 862  *
 863  * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
 864  * them.
 865  */
 866 void exit_aio(struct mm_struct *mm)
 867 {
 868         struct kioctx_table *table = rcu_dereference_raw(mm->ioctx_table);
 869         struct ctx_rq_wait wait;
 870         int i, skipped;
 871
 872         if (!table)
 873                 return;
 874
 875         atomic_set(&wait.count, table->nr);
 876         init_completion(&wait.comp);
 877
 878         skipped = 0;
 879         for (i = 0; i < table->nr; ++i) {
 880                 struct kioctx *ctx = table->table[i];
 881
 882                 if (!ctx) {
 883                         skipped++;
 884                         continue;
 885                 }
 886
 887                 /*
 888                  * We don't need to bother with munmap() here - exit_mmap(mm)
 889                  * is coming and it'll unmap everything. And we simply can't,
 890                  * this is not necessarily our ->mm.
 891                  * Since kill_ioctx() uses non-zero ->mmap_size as indicator
 892                  * that it needs to unmap the area, just set it to 0.
 893                  */
 894                 ctx->mmap_size = 0;
 895                 kill_ioctx(mm, ctx, &wait);
 896         }
 897
 898         if (!atomic_sub_and_test(skipped, &wait.count)) {
 899                 /* Wait until all IO for the context are done. */
 900                 wait_for_completion(&wait.comp);
 901         }
 902
 903         RCU_INIT_POINTER(mm->ioctx_table, NULL);
 904         kfree(table);
 905 }
 906
 907 static void put_reqs_available(struct kioctx *ctx, unsigned nr)
 908 {
 909         struct kioctx_cpu *kcpu;
 910         unsigned long flags;
 911
 912         local_irq_save(flags);
 913         kcpu = this_cpu_ptr(ctx->cpu);
 914         kcpu->reqs_available += nr;
 915
 916         while (kcpu->reqs_available >= ctx->req_batch * 2) {
 917                 kcpu->reqs_available -= ctx->req_batch;
 918                 atomic_add(ctx->req_batch, &ctx->reqs_available);
 919         }
 920
 921         local_irq_restore(flags);
 922 }
 923
 924 static bool get_reqs_available(struct kioctx *ctx)
 925 {
 926         struct kioctx_cpu *kcpu;
 927         bool ret = false;
 928         unsigned long flags;
 929
 930         local_irq_save(flags);
 931         kcpu = this_cpu_ptr(ctx->cpu);
 932         if (!kcpu->reqs_available) {
 933                 int old, avail = atomic_read(&ctx->reqs_available);
 934
 935                 do {
 936                         if (avail < ctx->req_batch)
 937                                 goto out;
 938
 939                         old = avail;
 940                         avail = atomic_cmpxchg(&ctx->reqs_available,
 941                                                avail, avail - ctx->req_batch);
 942                 } while (avail != old);
 943
 944                 kcpu->reqs_available += ctx->req_batch;
 945         }
 946
 947         ret = true;
 948         kcpu->reqs_available--;
 949 out:
 950         local_irq_restore(flags);
 951         return ret;
 952 }
 953
 954 /* refill_reqs_available
 955  *      Updates the reqs_available reference counts used for tracking the
 956  *      number of free slots in the completion ring.  This can be called
 957  *      from aio_complete() (to optimistically update reqs_available) or
 958  *      from aio_get_req() (the we're out of events case).  It must be
 959  *      called holding ctx->completion_lock.
 960  */
 961 static void refill_reqs_available(struct kioctx *ctx, unsigned head,
 962                                   unsigned tail)
 963 {
 964         unsigned events_in_ring, completed;
 965
 966         /* Clamp head since userland can write to it. */
 967         head %= ctx->nr_events;
 968         if (head <= tail)
 969                 events_in_ring = tail - head;
 970         else
 971                 events_in_ring = ctx->nr_events - (head - tail);
 972
 973         completed = ctx->completed_events;
 974         if (events_in_ring < completed)
 975                 completed -= events_in_ring;
 976         else
 977                 completed = 0;
 978
 979         if (!completed)
 980                 return;
 981
 982         ctx->completed_events -= completed;
 983         put_reqs_available(ctx, completed);
 984 }
 985
 986 /* user_refill_reqs_available
 987  *      Called to refill reqs_available when aio_get_req() encounters an
 988  *      out of space in the completion ring.
 989  */
 990 static void user_refill_reqs_available(struct kioctx *ctx)
 991 {
 992         spin_lock_irq(&ctx->completion_lock);
 993         if (ctx->completed_events) {
 994                 struct aio_ring *ring;
 995                 unsigned head;
 996
 997                 /* Access of ring->head may race with aio_read_events_ring()
 998                  * here, but that's okay since whether we read the old version
 999                  * or the new version, and either will be valid.  The important
1000                  * part is that head cannot pass tail since we prevent
1001                  * aio_complete() from updating tail by holding
1002                  * ctx->completion_lock.  Even if head is invalid, the check
1003                  * against ctx->completed_events below will make sure we do the
1004                  * safe/right thing.
1005                  */
1006                 ring = kmap_atomic(ctx->ring_pages[0]);
1007                 head = ring->head;
1008                 kunmap_atomic(ring);
1009
1010                 refill_reqs_available(ctx, head, ctx->tail);
1011         }
1012
1013         spin_unlock_irq(&ctx->completion_lock);
1014 }
1015
1016 /* aio_get_req
1017  *      Allocate a slot for an aio request.
1018  * Returns NULL if no requests are free.
1019  */
1020 static inline struct aio_kiocb *aio_get_req(struct kioctx *ctx)
1021 {
1022         struct aio_kiocb *req;
1023
1024         if (!get_reqs_available(ctx)) {
1025                 user_refill_reqs_available(ctx);
1026                 if (!get_reqs_available(ctx))
1027                         return NULL;
1028         }
1029
1030         req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
1031         if (unlikely(!req))
1032                 goto out_put;
1033
1034         percpu_ref_get(&ctx->reqs);
1035
1036         req->ki_ctx = ctx;
1037         return req;
1038 out_put:
1039         put_reqs_available(ctx, 1);
1040         return NULL;
1041 }
1042
1043 static void kiocb_free(struct aio_kiocb *req)
1044 {
1045         if (req->common.ki_filp)
1046                 fput(req->common.ki_filp);
1047         if (req->ki_eventfd != NULL)
1048                 eventfd_ctx_put(req->ki_eventfd);
1049         kmem_cache_free(kiocb_cachep, req);
1050 }
1051
1052 static struct kioctx *lookup_ioctx(unsigned long ctx_id)
1053 {
1054         struct aio_ring __user *ring  = (void __user *)ctx_id;
1055         struct mm_struct *mm = current->mm;
1056         struct kioctx *ctx, *ret = NULL;
1057         struct kioctx_table *table;
1058         unsigned id;
1059
1060         if (get_user(id, &ring->id))
1061                 return NULL;
1062
1063         rcu_read_lock();
1064         table = rcu_dereference(mm->ioctx_table);
1065
1066         if (!table || id >= table->nr)
1067                 goto out;
1068
1069         ctx = table->table[id];
1070         if (ctx && ctx->user_id == ctx_id) {
1071                 percpu_ref_get(&ctx->users);
1072                 ret = ctx;
1073         }
1074 out:
1075         rcu_read_unlock();
1076         return ret;
1077 }
1078
1079 /* aio_complete
1080  *      Called when the io request on the given iocb is complete.
1081  */
1082 static void aio_complete(struct kiocb *kiocb, long res, long res2)
1083 {
1084         struct aio_kiocb *iocb = container_of(kiocb, struct aio_kiocb, common);
1085         struct kioctx   *ctx = iocb->ki_ctx;
1086         struct aio_ring *ring;
1087         struct io_event *ev_page, *event;
1088         unsigned tail, pos, head;
1089         unsigned long   flags;
1090
1091         if (kiocb->ki_flags & IOCB_WRITE) {
1092                 struct file *file = kiocb->ki_filp;
1093
1094                 /*
1095                  * Tell lockdep we inherited freeze protection from submission
1096                  * thread.
1097                  */
1098                 __sb_writers_acquired(file_inode(file)->i_sb, SB_FREEZE_WRITE);
1099                 file_end_write(file);
1100         }
1101
1102         /*
1103          * Special case handling for sync iocbs:
1104          *  - events go directly into the iocb for fast handling
1105          *  - the sync task with the iocb in its stack holds the single iocb
1106          *    ref, no other paths have a way to get another ref
1107          *  - the sync task helpfully left a reference to itself in the iocb
1108          */
1109         BUG_ON(is_sync_kiocb(kiocb));
1110
1111         if (iocb->ki_list.next) {
1112                 unsigned long flags;
1113
1114                 spin_lock_irqsave(&ctx->ctx_lock, flags);
1115                 list_del(&iocb->ki_list);
1116                 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
1117         }
1118
1119         /*
1120          * Add a completion event to the ring buffer. Must be done holding
1121          * ctx->completion_lock to prevent other code from messing with the tail
1122          * pointer since we might be called from irq context.
1123          */
1124         spin_lock_irqsave(&ctx->completion_lock, flags);
1125
1126         tail = ctx->tail;
1127         pos = tail + AIO_EVENTS_OFFSET;
1128
1129         if (++tail >= ctx->nr_events)
1130                 tail = 0;
1131
1132         ev_page = kmap_atomic(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
1133         event = ev_page + pos % AIO_EVENTS_PER_PAGE;
1134
1135         event->obj = (u64)(unsigned long)iocb->ki_user_iocb;
1136         event->data = iocb->ki_user_data;
1137         event->res = res;
1138         event->res2 = res2;
1139
1140         kunmap_atomic(ev_page);
1141         flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
1142
1143         pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
1144                  ctx, tail, iocb, iocb->ki_user_iocb, iocb->ki_user_data,
1145                  res, res2);
1146
1147         /* after flagging the request as done, we
1148          * must never even look at it again
1149          */
1150         smp_wmb();      /* make event visible before updating tail */
1151
1152         ctx->tail = tail;
1153
1154         ring = kmap_atomic(ctx->ring_pages[0]);
1155         head = ring->head;
1156         ring->tail = tail;
1157         kunmap_atomic(ring);
1158         flush_dcache_page(ctx->ring_pages[0]);
1159
1160         ctx->completed_events++;
1161         if (ctx->completed_events > 1)
1162                 refill_reqs_available(ctx, head, tail);
1163         spin_unlock_irqrestore(&ctx->completion_lock, flags);
1164
1165         pr_debug("added to ring %p at [%u]\n", iocb, tail);
1166
1167         /*
1168          * Check if the user asked us to deliver the result through an
1169          * eventfd. The eventfd_signal() function is safe to be called
1170          * from IRQ context.
1171          */
1172         if (iocb->ki_eventfd != NULL)
1173                 eventfd_signal(iocb->ki_eventfd, 1);
1174
1175         /* everything turned out well, dispose of the aiocb. */
1176         kiocb_free(iocb);
1177
1178         /*
1179          * We have to order our ring_info tail store above and test
1180          * of the wait list below outside the wait lock.  This is
1181          * like in wake_up_bit() where clearing a bit has to be
1182          * ordered with the unlocked test.
1183          */
1184         smp_mb();
1185
1186         if (waitqueue_active(&ctx->wait))
1187                 wake_up(&ctx->wait);
1188
1189         percpu_ref_put(&ctx->reqs);
1190 }
1191
1192 /* aio_read_events_ring
1193  *      Pull an event off of the ioctx's event ring.  Returns the number of
1194  *      events fetched
1195  */
1196 static long aio_read_events_ring(struct kioctx *ctx,
1197                                  struct io_event __user *event, long nr)
1198 {
1199         struct aio_ring *ring;
1200         unsigned head, tail, pos;
1201         long ret = 0;
1202         int copy_ret;
1203
1204         /*
1205          * The mutex can block and wake us up and that will cause
1206          * wait_event_interruptible_hrtimeout() to schedule without sleeping
1207          * and repeat. This should be rare enough that it doesn't cause
1208          * peformance issues. See the comment in read_events() for more detail.
1209          */
1210         sched_annotate_sleep();
1211         mutex_lock(&ctx->ring_lock);
1212
1213         /* Access to ->ring_pages here is protected by ctx->ring_lock. */
1214         ring = kmap_atomic(ctx->ring_pages[0]);
1215         head = ring->head;
1216         tail = ring->tail;
1217         kunmap_atomic(ring);
1218
1219         /*
1220          * Ensure that once we've read the current tail pointer, that
1221          * we also see the events that were stored up to the tail.
1222          */
1223         smp_rmb();
1224
1225         pr_debug("h%u t%u m%u\n", head, tail, ctx->nr_events);
1226
1227         if (head == tail)
1228                 goto out;
1229
1230         head %= ctx->nr_events;
1231         tail %= ctx->nr_events;
1232
1233         while (ret < nr) {
1234                 long avail;
1235                 struct io_event *ev;
1236                 struct page *page;
1237
1238                 avail = (head <= tail ?  tail : ctx->nr_events) - head;
1239                 if (head == tail)
1240                         break;
1241
1242                 avail = min(avail, nr - ret);
1243                 avail = min_t(long, avail, AIO_EVENTS_PER_PAGE -
1244                             ((head + AIO_EVENTS_OFFSET) % AIO_EVENTS_PER_PAGE));
1245
1246                 pos = head + AIO_EVENTS_OFFSET;
1247                 page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
1248                 pos %= AIO_EVENTS_PER_PAGE;
1249
1250                 ev = kmap(page);
1251                 copy_ret = copy_to_user(event + ret, ev + pos,
1252                                         sizeof(*ev) * avail);
1253                 kunmap(page);
1254
1255                 if (unlikely(copy_ret)) {
1256                         ret = -EFAULT;
1257                         goto out;
1258                 }
1259
1260                 ret += avail;
1261                 head += avail;
1262                 head %= ctx->nr_events;
1263         }
1264
1265         ring = kmap_atomic(ctx->ring_pages[0]);
1266         ring->head = head;
1267         kunmap_atomic(ring);
1268         flush_dcache_page(ctx->ring_pages[0]);
1269
1270         pr_debug("%li  h%u t%u\n", ret, head, tail);
1271 out:
1272         mutex_unlock(&ctx->ring_lock);
1273
1274         return ret;
1275 }
1276
1277 static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
1278                             struct io_event __user *event, long *i)
1279 {
1280         long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
1281
1282         if (ret > 0)
1283                 *i += ret;
1284
1285         if (unlikely(atomic_read(&ctx->dead)))
1286                 ret = -EINVAL;
1287
1288         if (!*i)
1289                 *i = ret;
1290
1291         return ret < 0 || *i >= min_nr;
1292 }
1293
1294 static long read_events(struct kioctx *ctx, long min_nr, long nr,
1295                         struct io_event __user *event,
1296                         struct timespec __user *timeout)
1297 {
1298         ktime_t until = { .tv64 = KTIME_MAX };
1299         long ret = 0;
1300
1301         if (timeout) {
1302                 struct timespec ts;
1303
1304                 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1305                         return -EFAULT;
1306
1307                 until = timespec_to_ktime(ts);
1308         }
1309
1310         /*
1311          * Note that aio_read_events() is being called as the conditional - i.e.
1312          * we're calling it after prepare_to_wait() has set task state to
1313          * TASK_INTERRUPTIBLE.
1314          *
1315          * But aio_read_events() can block, and if it blocks it's going to flip
1316          * the task state back to TASK_RUNNING.
1317          *
1318          * This should be ok, provided it doesn't flip the state back to
1319          * TASK_RUNNING and return 0 too much - that causes us to spin. That
1320          * will only happen if the mutex_lock() call blocks, and we then find
1321          * the ringbuffer empty. So in practice we should be ok, but it's
1322          * something to be aware of when touching this code.
1323          */
1324         if (until.tv64 == 0)
1325                 aio_read_events(ctx, min_nr, nr, event, &ret);
1326         else
1327                 wait_event_interruptible_hrtimeout(ctx->wait,
1328                                 aio_read_events(ctx, min_nr, nr, event, &ret),
1329                                 until);
1330
1331         if (!ret && signal_pending(current))
1332                 ret = -EINTR;
1333
1334         return ret;
1335 }
1336
1337 /* sys_io_setup:
1338  *      Create an aio_context capable of receiving at least nr_events.
1339  *      ctxp must not point to an aio_context that already exists, and
1340  *      must be initialized to 0 prior to the call.  On successful
1341  *      creation of the aio_context, *ctxp is filled in with the resulting
1342  *      handle.  May fail with -EINVAL if *ctxp is not initialized,
1343  *      if the specified nr_events exceeds internal limits.  May fail
1344  *      with -EAGAIN if the specified nr_events exceeds the user's limit
1345  *      of available events.  May fail with -ENOMEM if insufficient kernel
1346  *      resources are available.  May fail with -EFAULT if an invalid
1347  *      pointer is passed for ctxp.  Will fail with -ENOSYS if not
1348  *      implemented.
1349  */
1350 SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
1351 {
1352         struct kioctx *ioctx = NULL;
1353         unsigned long ctx;
1354         long ret;
1355
1356         ret = get_user(ctx, ctxp);
1357         if (unlikely(ret))
1358                 goto out;
1359
1360         ret = -EINVAL;
1361         if (unlikely(ctx || nr_events == 0)) {
1362                 pr_debug("EINVAL: ctx %lu nr_events %u\n",
1363                          ctx, nr_events);
1364                 goto out;
1365         }
1366
1367         ioctx = ioctx_alloc(nr_events);
1368         ret = PTR_ERR(ioctx);
1369         if (!IS_ERR(ioctx)) {
1370                 ret = put_user(ioctx->user_id, ctxp);
1371                 if (ret)
1372                         kill_ioctx(current->mm, ioctx, NULL);
1373                 percpu_ref_put(&ioctx->users);
1374         }
1375
1376 out:
1377         return ret;
1378 }
1379
1380 /* sys_io_destroy:
1381  *      Destroy the aio_context specified.  May cancel any outstanding
1382  *      AIOs and block on completion.  Will fail with -ENOSYS if not
1383  *      implemented.  May fail with -EINVAL if the context pointed to
1384  *      is invalid.
1385  */
1386 SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
1387 {
1388         struct kioctx *ioctx = lookup_ioctx(ctx);
1389         if (likely(NULL != ioctx)) {
1390                 struct ctx_rq_wait wait;
1391                 int ret;
1392
1393                 init_completion(&wait.comp);
1394                 atomic_set(&wait.count, 1);
1395
1396                 /* Pass requests_done to kill_ioctx() where it can be set
1397                  * in a thread-safe way. If we try to set it here then we have
1398                  * a race condition if two io_destroy() called simultaneously.
1399                  */
1400                 ret = kill_ioctx(current->mm, ioctx, &wait);
1401                 percpu_ref_put(&ioctx->users);
1402
1403                 /* Wait until all IO for the context are done. Otherwise kernel
1404                  * keep using user-space buffers even if user thinks the context
1405                  * is destroyed.
1406                  */
1407                 if (!ret)
1408                         wait_for_completion(&wait.comp);
1409
1410                 return ret;
1411         }
1412         pr_debug("EINVAL: invalid context id\n");
1413         return -EINVAL;
1414 }
1415
1416 static int aio_setup_rw(int rw, struct iocb *iocb, struct iovec **iovec,
1417                 bool vectored, bool compat, struct iov_iter *iter)
1418 {
1419         void __user *buf = (void __user *)(uintptr_t)iocb->aio_buf;
1420         size_t len = iocb->aio_nbytes;
1421
1422         if (!vectored) {
1423                 ssize_t ret = import_single_range(rw, buf, len, *iovec, iter);
1424                 *iovec = NULL;
1425                 return ret;
1426         }
1427 #ifdef CONFIG_COMPAT
1428         if (compat)
1429                 return compat_import_iovec(rw, buf, len, UIO_FASTIOV, iovec,
1430                                 iter);
1431 #endif
1432         return import_iovec(rw, buf, len, UIO_FASTIOV, iovec, iter);
1433 }
1434
1435 static inline ssize_t aio_ret(struct kiocb *req, ssize_t ret)
1436 {
1437         switch (ret) {
1438         case -EIOCBQUEUED:
1439                 return ret;
1440         case -ERESTARTSYS:
1441         case -ERESTARTNOINTR:
1442         case -ERESTARTNOHAND:
1443         case -ERESTART_RESTARTBLOCK:
1444                 /*
1445                  * There's no easy way to restart the syscall since other AIO's
1446                  * may be already running. Just fail this IO with EINTR.
1447                  */
1448                 ret = -EINTR;
1449                 /*FALLTHRU*/
1450         default:
1451                 aio_complete(req, ret, 0);
1452                 return 0;
1453         }
1454 }
1455
1456 static ssize_t aio_read(struct kiocb *req, struct iocb *iocb, bool vectored,
1457                 bool compat)
1458 {
1459         struct file *file = req->ki_filp;
1460         struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1461         struct iov_iter iter;
1462         ssize_t ret;
1463
1464         if (unlikely(!(file->f_mode & FMODE_READ)))
1465                 return -EBADF;
1466         if (unlikely(!file->f_op->read_iter))
1467                 return -EINVAL;
1468
1469         ret = aio_setup_rw(READ, iocb, &iovec, vectored, compat, &iter);
1470         if (ret)
1471                 return ret;
1472         ret = rw_verify_area(READ, file, &req->ki_pos, iov_iter_count(&iter));
1473         if (!ret)
1474                 ret = aio_ret(req, file->f_op->read_iter(req, &iter));
1475         kfree(iovec);
1476         return ret;
1477 }
1478
1479 static ssize_t aio_write(struct kiocb *req, struct iocb *iocb, bool vectored,
1480                 bool compat)
1481 {
1482         struct file *file = req->ki_filp;
1483         struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1484         struct iov_iter iter;
1485         ssize_t ret;
1486
1487         if (unlikely(!(file->f_mode & FMODE_WRITE)))
1488                 return -EBADF;
1489         if (unlikely(!file->f_op->write_iter))
1490                 return -EINVAL;
1491
1492         ret = aio_setup_rw(WRITE, iocb, &iovec, vectored, compat, &iter);
1493         if (ret)
1494                 return ret;
1495         ret = rw_verify_area(WRITE, file, &req->ki_pos, iov_iter_count(&iter));
1496         if (!ret) {
1497                 req->ki_flags |= IOCB_WRITE;
1498                 file_start_write(file);
1499                 ret = aio_ret(req, file->f_op->write_iter(req, &iter));
1500                 /*
1501                  * We release freeze protection in aio_complete().  Fool lockdep
1502                  * by telling it the lock got released so that it doesn't
1503                  * complain about held lock when we return to userspace.
1504                  */
1505                 __sb_writers_release(file_inode(file)->i_sb, SB_FREEZE_WRITE);
1506         }
1507         kfree(iovec);
1508         return ret;
1509 }
1510
1511 static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
1512                          struct iocb *iocb, bool compat)
1513 {
1514         struct aio_kiocb *req;
1515         struct file *file;
1516         ssize_t ret;
1517
1518         /* enforce forwards compatibility on users */
1519         if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
1520                 pr_debug("EINVAL: reserve field set\n");
1521                 return -EINVAL;
1522         }
1523
1524         /* prevent overflows */
1525         if (unlikely(
1526             (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1527             (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1528             ((ssize_t)iocb->aio_nbytes < 0)
1529            )) {
1530                 pr_debug("EINVAL: overflow check\n");
1531                 return -EINVAL;
1532         }
1533
1534         req = aio_get_req(ctx);
1535         if (unlikely(!req))
1536                 return -EAGAIN;
1537
1538         req->common.ki_filp = file = fget(iocb->aio_fildes);
1539         if (unlikely(!req->common.ki_filp)) {
1540                 ret = -EBADF;
1541                 goto out_put_req;
1542         }
1543         req->common.ki_pos = iocb->aio_offset;
1544         req->common.ki_complete = aio_complete;
1545         req->common.ki_flags = iocb_flags(req->common.ki_filp);
1546
1547         if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1548                 /*
1549                  * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1550                  * instance of the file* now. The file descriptor must be
1551                  * an eventfd() fd, and will be signaled for each completed
1552                  * event using the eventfd_signal() function.
1553                  */
1554                 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
1555                 if (IS_ERR(req->ki_eventfd)) {
1556                         ret = PTR_ERR(req->ki_eventfd);
1557                         req->ki_eventfd = NULL;
1558                         goto out_put_req;
1559                 }
1560
1561                 req->common.ki_flags |= IOCB_EVENTFD;
1562         }
1563
1564         ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
1565         if (unlikely(ret)) {
1566                 pr_debug("EFAULT: aio_key\n");
1567                 goto out_put_req;
1568         }
1569
1570         req->ki_user_iocb = user_iocb;
1571         req->ki_user_data = iocb->aio_data;
1572
1573         get_file(file);
1574         switch (iocb->aio_lio_opcode) {
1575         case IOCB_CMD_PREAD:
1576                 ret = aio_read(&req->common, iocb, false, compat);
1577                 break;
1578         case IOCB_CMD_PWRITE:
1579                 ret = aio_write(&req->common, iocb, false, compat);
1580                 break;
1581         case IOCB_CMD_PREADV:
1582                 ret = aio_read(&req->common, iocb, true, compat);
1583                 break;
1584         case IOCB_CMD_PWRITEV:
1585                 ret = aio_write(&req->common, iocb, true, compat);
1586                 break;
1587         default:
1588                 pr_debug("invalid aio operation %d\n", iocb->aio_lio_opcode);
1589                 ret = -EINVAL;
1590                 break;
1591         }
1592         fput(file);
1593
1594         if (ret && ret != -EIOCBQUEUED)
1595                 goto out_put_req;
1596         return 0;
1597 out_put_req:
1598         put_reqs_available(ctx, 1);
1599         percpu_ref_put(&ctx->reqs);
1600         kiocb_free(req);
1601         return ret;
1602 }
1603
1604 long do_io_submit(aio_context_t ctx_id, long nr,
1605                   struct iocb __user *__user *iocbpp, bool compat)
1606 {
1607         struct kioctx *ctx;
1608         long ret = 0;
1609         int i = 0;
1610         struct blk_plug plug;
1611
1612         if (unlikely(nr < 0))
1613                 return -EINVAL;
1614
1615         if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1616                 nr = LONG_MAX/sizeof(*iocbpp);
1617
1618         if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1619                 return -EFAULT;
1620
1621         ctx = lookup_ioctx(ctx_id);
1622         if (unlikely(!ctx)) {
1623                 pr_debug("EINVAL: invalid context id\n");
1624                 return -EINVAL;
1625         }
1626
1627         blk_start_plug(&plug);
1628
1629         /*
1630          * AKPM: should this return a partial result if some of the IOs were
1631          * successfully submitted?
1632          */
1633         for (i=0; i<nr; i++) {
1634                 struct iocb __user *user_iocb;
1635                 struct iocb tmp;
1636
1637                 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1638                         ret = -EFAULT;
1639                         break;
1640                 }
1641
1642                 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1643                         ret = -EFAULT;
1644                         break;
1645                 }
1646
1647                 ret = io_submit_one(ctx, user_iocb, &tmp, compat);
1648                 if (ret)
1649                         break;
1650         }
1651         blk_finish_plug(&plug);
1652
1653         percpu_ref_put(&ctx->users);
1654         return i ? i : ret;
1655 }
1656
1657 /* sys_io_submit:
1658  *      Queue the nr iocbs pointed to by iocbpp for processing.  Returns
1659  *      the number of iocbs queued.  May return -EINVAL if the aio_context
1660  *      specified by ctx_id is invalid, if nr is < 0, if the iocb at
1661  *      *iocbpp[0] is not properly initialized, if the operation specified
1662  *      is invalid for the file descriptor in the iocb.  May fail with
1663  *      -EFAULT if any of the data structures point to invalid data.  May
1664  *      fail with -EBADF if the file descriptor specified in the first
1665  *      iocb is invalid.  May fail with -EAGAIN if insufficient resources
1666  *      are available to queue any iocbs.  Will return 0 if nr is 0.  Will
1667  *      fail with -ENOSYS if not implemented.
1668  */
1669 SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1670                 struct iocb __user * __user *, iocbpp)
1671 {
1672         return do_io_submit(ctx_id, nr, iocbpp, 0);
1673 }
1674
1675 /* lookup_kiocb
1676  *      Finds a given iocb for cancellation.
1677  */
1678 static struct aio_kiocb *
1679 lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb, u32 key)
1680 {
1681         struct aio_kiocb *kiocb;
1682
1683         assert_spin_locked(&ctx->ctx_lock);
1684
1685         if (key != KIOCB_KEY)
1686                 return NULL;
1687
1688         /* TODO: use a hash or array, this sucks. */
1689         list_for_each_entry(kiocb, &ctx->active_reqs, ki_list) {
1690                 if (kiocb->ki_user_iocb == iocb)
1691                         return kiocb;
1692         }
1693         return NULL;
1694 }
1695
1696 /* sys_io_cancel:
1697  *      Attempts to cancel an iocb previously passed to io_submit.  If
1698  *      the operation is successfully cancelled, the resulting event is
1699  *      copied into the memory pointed to by result without being placed
1700  *      into the completion queue and 0 is returned.  May fail with
1701  *      -EFAULT if any of the data structures pointed to are invalid.
1702  *      May fail with -EINVAL if aio_context specified by ctx_id is
1703  *      invalid.  May fail with -EAGAIN if the iocb specified was not
1704  *      cancelled.  Will fail with -ENOSYS if not implemented.
1705  */
1706 SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1707                 struct io_event __user *, result)
1708 {
1709         struct kioctx *ctx;
1710         struct aio_kiocb *kiocb;
1711         u32 key;
1712         int ret;
1713
1714         ret = get_user(key, &iocb->aio_key);
1715         if (unlikely(ret))
1716                 return -EFAULT;
1717
1718         ctx = lookup_ioctx(ctx_id);
1719         if (unlikely(!ctx))
1720                 return -EINVAL;
1721
1722         spin_lock_irq(&ctx->ctx_lock);
1723
1724         kiocb = lookup_kiocb(ctx, iocb, key);
1725         if (kiocb)
1726                 ret = kiocb_cancel(kiocb);
1727         else
1728                 ret = -EINVAL;
1729
1730         spin_unlock_irq(&ctx->ctx_lock);
1731
1732         if (!ret) {
1733                 /*
1734                  * The result argument is no longer used - the io_event is
1735                  * always delivered via the ring buffer. -EINPROGRESS indicates
1736                  * cancellation is progress:
1737                  */
1738                 ret = -EINPROGRESS;
1739         }
1740
1741         percpu_ref_put(&ctx->users);
1742
1743         return ret;
1744 }
1745
1746 /* io_getevents:
1747  *      Attempts to read at least min_nr events and up to nr events from
1748  *      the completion queue for the aio_context specified by ctx_id. If
1749  *      it succeeds, the number of read events is returned. May fail with
1750  *      -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1751  *      out of range, if timeout is out of range.  May fail with -EFAULT
1752  *      if any of the memory specified is invalid.  May return 0 or
1753  *      < min_nr if the timeout specified by timeout has elapsed
1754  *      before sufficient events are available, where timeout == NULL
1755  *      specifies an infinite timeout. Note that the timeout pointed to by
1756  *      timeout is relative.  Will fail with -ENOSYS if not implemented.
1757  */
1758 SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1759                 long, min_nr,
1760                 long, nr,
1761                 struct io_event __user *, events,
1762                 struct timespec __user *, timeout)
1763 {
1764         struct kioctx *ioctx = lookup_ioctx(ctx_id);
1765         long ret = -EINVAL;
1766
1767         if (likely(ioctx)) {
1768                 if (likely(min_nr <= nr && min_nr >= 0))
1769                         ret = read_events(ioctx, min_nr, nr, events, timeout);
1770                 percpu_ref_put(&ioctx->users);
1771         }
1772         return ret;
1773 }