fs/aio.c

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