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