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