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  *      Copyright 2018 Christoph Hellwig.
   9  *
  10  *      See ../COPYING for licensing terms.
  11  */
  12 #define pr_fmt(fmt) "%s: " fmt, __func__
  13
  14 #include <linux/kernel.h>
  15 #include <linux/init.h>
  16 #include <linux/errno.h>
  17 #include <linux/time.h>
  18 #include <linux/aio_abi.h>
  19 #include <linux/export.h>
  20 #include <linux/syscalls.h>
  21 #include <linux/backing-dev.h>
  22 #include <linux/refcount.h>
  23 #include <linux/uio.h>
  24
  25 #include <linux/sched/signal.h>
  26 #include <linux/fs.h>
  27 #include <linux/file.h>
  28 #include <linux/mm.h>
  29 #include <linux/mman.h>
  30 #include <linux/percpu.h>
  31 #include <linux/slab.h>
  32 #include <linux/timer.h>
  33 #include <linux/aio.h>
  34 #include <linux/highmem.h>
  35 #include <linux/workqueue.h>
  36 #include <linux/security.h>
  37 #include <linux/eventfd.h>
  38 #include <linux/blkdev.h>
  39 #include <linux/compat.h>
  40 #include <linux/migrate.h>
  41 #include <linux/ramfs.h>
  42 #include <linux/percpu-refcount.h>
  43 #include <linux/mount.h>
  44 #include <linux/pseudo_fs.h>
  45
  46 #include <linux/uaccess.h>
  47 #include <linux/nospec.h>
  48
  49 #include "internal.h"
  50
  51 #define KIOCB_KEY               0
  52
  53 #define AIO_RING_MAGIC                  0xa10a10a1
  54 #define AIO_RING_COMPAT_FEATURES        1
  55 #define AIO_RING_INCOMPAT_FEATURES      0
  56 struct aio_ring {
  57         unsigned        id;     /* kernel internal index number */
  58         unsigned        nr;     /* number of io_events */
  59         unsigned        head;   /* Written to by userland or under ring_lock
  60                                  * mutex by aio_read_events_ring(). */
  61         unsigned        tail;
  62
  63         unsigned        magic;
  64         unsigned        compat_features;
  65         unsigned        incompat_features;
  66         unsigned        header_length;  /* size of aio_ring */
  67
  68
  69         struct io_event         io_events[];
  70 }; /* 128 bytes + ring size */
  71
  72 /*
  73  * Plugging is meant to work with larger batches of IOs. If we don't
  74  * have more than the below, then don't bother setting up a plug.
  75  */
  76 #define AIO_PLUG_THRESHOLD      2
  77
  78 #define AIO_RING_PAGES  8
  79
  80 struct kioctx_table {
  81         struct rcu_head         rcu;
  82         unsigned                nr;
  83         struct kioctx __rcu     *table[];
  84 };
  85
  86 struct kioctx_cpu {
  87         unsigned                reqs_available;
  88 };
  89
  90 struct ctx_rq_wait {
  91         struct completion comp;
  92         atomic_t count;
  93 };
  94
  95 struct kioctx {
  96         struct percpu_ref       users;
  97         atomic_t                dead;
  98
  99         struct percpu_ref       reqs;
 100
 101         unsigned long           user_id;
 102
 103         struct __percpu kioctx_cpu *cpu;
 104
 105         /*
 106          * For percpu reqs_available, number of slots we move to/from global
 107          * counter at a time:
 108          */
 109         unsigned                req_batch;
 110         /*
 111          * This is what userspace passed to io_setup(), it's not used for
 112          * anything but counting against the global max_reqs quota.
 113          *
 114          * The real limit is nr_events - 1, which will be larger (see
 115          * aio_setup_ring())
 116          */
 117         unsigned                max_reqs;
 118
 119         /* Size of ringbuffer, in units of struct io_event */
 120         unsigned                nr_events;
 121
 122         unsigned long           mmap_base;
 123         unsigned long           mmap_size;
 124
 125         struct page             **ring_pages;
 126         long                    nr_pages;
 127
 128         struct rcu_work         free_rwork;     /* see free_ioctx() */
 129
 130         /*
 131          * signals when all in-flight requests are done
 132          */
 133         struct ctx_rq_wait      *rq_wait;
 134
 135         struct {
 136                 /*
 137                  * This counts the number of available slots in the ringbuffer,
 138                  * so we avoid overflowing it: it's decremented (if positive)
 139                  * when allocating a kiocb and incremented when the resulting
 140                  * io_event is pulled off the ringbuffer.
 141                  *
 142                  * We batch accesses to it with a percpu version.
 143                  */
 144                 atomic_t        reqs_available;
 145         } ____cacheline_aligned_in_smp;
 146
 147         struct {
 148                 spinlock_t      ctx_lock;
 149                 struct list_head active_reqs;   /* used for cancellation */
 150         } ____cacheline_aligned_in_smp;
 151
 152         struct {
 153                 struct mutex    ring_lock;
 154                 wait_queue_head_t wait;
 155         } ____cacheline_aligned_in_smp;
 156
 157         struct {
 158                 unsigned        tail;
 159                 unsigned        completed_events;
 160                 spinlock_t      completion_lock;
 161         } ____cacheline_aligned_in_smp;
 162
 163         struct page             *internal_pages[AIO_RING_PAGES];
 164         struct file             *aio_ring_file;
 165
 166         unsigned                id;
 167 };
 168
 169 /*
 170  * First field must be the file pointer in all the
 171  * iocb unions! See also 'struct kiocb' in <linux/fs.h>
 172  */
 173 struct fsync_iocb {
 174         struct file             *file;
 175         struct work_struct      work;
 176         bool                    datasync;
 177         struct cred             *creds;
 178 };
 179
 180 struct poll_iocb {
 181         struct file             *file;
 182         struct wait_queue_head  *head;
 183         __poll_t                events;
 184         bool                    cancelled;
 185         bool                    work_scheduled;
 186         bool                    work_need_resched;
 187         struct wait_queue_entry wait;
 188         struct work_struct      work;
 189 };
 190
 191 /*
 192  * NOTE! Each of the iocb union members has the file pointer
 193  * as the first entry in their struct definition. So you can
 194  * access the file pointer through any of the sub-structs,
 195  * or directly as just 'ki_filp' in this struct.
 196  */
 197 struct aio_kiocb {
 198         union {
 199                 struct file             *ki_filp;
 200                 struct kiocb            rw;
 201                 struct fsync_iocb       fsync;
 202                 struct poll_iocb        poll;
 203         };
 204
 205         struct kioctx           *ki_ctx;
 206         kiocb_cancel_fn         *ki_cancel;
 207
 208         struct io_event         ki_res;
 209
 210         struct list_head        ki_list;        /* the aio core uses this
 211                                                  * for cancellation */
 212         refcount_t              ki_refcnt;
 213
 214         /*
 215          * If the aio_resfd field of the userspace iocb is not zero,
 216          * this is the underlying eventfd context to deliver events to.
 217          */
 218         struct eventfd_ctx      *ki_eventfd;
 219 };
 220
 221 /*------ sysctl variables----*/
 222 static DEFINE_SPINLOCK(aio_nr_lock);
 223 static unsigned long aio_nr;            /* current system wide number of aio requests */
 224 static unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
 225 /*----end sysctl variables---*/
 226 #ifdef CONFIG_SYSCTL
 227 static struct ctl_table aio_sysctls[] = {
 228         {
 229                 .procname       = "aio-nr",
 230                 .data           = &aio_nr,
 231                 .maxlen         = sizeof(aio_nr),
 232                 .mode           = 0444,
 233                 .proc_handler   = proc_doulongvec_minmax,
 234         },
 235         {
 236                 .procname       = "aio-max-nr",
 237                 .data           = &aio_max_nr,
 238                 .maxlen         = sizeof(aio_max_nr),
 239                 .mode           = 0644,
 240                 .proc_handler   = proc_doulongvec_minmax,
 241         },
 242         {}
 243 };
 244
 245 static void __init aio_sysctl_init(void)
 246 {
 247         register_sysctl_init("fs", aio_sysctls);
 248 }
 249 #else
 250 #define aio_sysctl_init() do { } while (0)
 251 #endif
 252
 253 static struct kmem_cache        *kiocb_cachep;
 254 static struct kmem_cache        *kioctx_cachep;
 255
 256 static struct vfsmount *aio_mnt;
 257
 258 static const struct file_operations aio_ring_fops;
 259 static const struct address_space_operations aio_ctx_aops;
 260
 261 static struct file *aio_private_file(struct kioctx *ctx, loff_t nr_pages)
 262 {
 263         struct file *file;
 264         struct inode *inode = alloc_anon_inode(aio_mnt->mnt_sb);
 265         if (IS_ERR(inode))
 266                 return ERR_CAST(inode);
 267
 268         inode->i_mapping->a_ops = &aio_ctx_aops;
 269         inode->i_mapping->private_data = ctx;
 270         inode->i_size = PAGE_SIZE * nr_pages;
 271
 272         file = alloc_file_pseudo(inode, aio_mnt, "[aio]",
 273                                 O_RDWR, &aio_ring_fops);
 274         if (IS_ERR(file))
 275                 iput(inode);
 276         return file;
 277 }
 278
 279 static int aio_init_fs_context(struct fs_context *fc)
 280 {
 281         if (!init_pseudo(fc, AIO_RING_MAGIC))
 282                 return -ENOMEM;
 283         fc->s_iflags |= SB_I_NOEXEC;
 284         return 0;
 285 }
 286
 287 /* aio_setup
 288  *      Creates the slab caches used by the aio routines, panic on
 289  *      failure as this is done early during the boot sequence.
 290  */
 291 static int __init aio_setup(void)
 292 {
 293         static struct file_system_type aio_fs = {
 294                 .name           = "aio",
 295                 .init_fs_context = aio_init_fs_context,
 296                 .kill_sb        = kill_anon_super,
 297         };
 298         aio_mnt = kern_mount(&aio_fs);
 299         if (IS_ERR(aio_mnt))
 300                 panic("Failed to create aio fs mount.");
 301
 302         kiocb_cachep = KMEM_CACHE(aio_kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
 303         kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
 304         aio_sysctl_init();
 305         return 0;
 306 }
 307 __initcall(aio_setup);
 308
 309 static void put_aio_ring_file(struct kioctx *ctx)
 310 {
 311         struct file *aio_ring_file = ctx->aio_ring_file;
 312         struct address_space *i_mapping;
 313
 314         if (aio_ring_file) {
 315                 truncate_setsize(file_inode(aio_ring_file), 0);
 316
 317                 /* Prevent further access to the kioctx from migratepages */
 318                 i_mapping = aio_ring_file->f_mapping;
 319                 spin_lock(&i_mapping->private_lock);
 320                 i_mapping->private_data = NULL;
 321                 ctx->aio_ring_file = NULL;
 322                 spin_unlock(&i_mapping->private_lock);
 323
 324                 fput(aio_ring_file);
 325         }
 326 }
 327
 328 static void aio_free_ring(struct kioctx *ctx)
 329 {
 330         int i;
 331
 332         /* Disconnect the kiotx from the ring file.  This prevents future
 333          * accesses to the kioctx from page migration.
 334          */
 335         put_aio_ring_file(ctx);
 336
 337         for (i = 0; i < ctx->nr_pages; i++) {
 338                 struct page *page;
 339                 pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
 340                                 page_count(ctx->ring_pages[i]));
 341                 page = ctx->ring_pages[i];
 342                 if (!page)
 343                         continue;
 344                 ctx->ring_pages[i] = NULL;
 345                 put_page(page);
 346         }
 347
 348         if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
 349                 kfree(ctx->ring_pages);
 350                 ctx->ring_pages = NULL;
 351         }
 352 }
 353
 354 static int aio_ring_mremap(struct vm_area_struct *vma)
 355 {
 356         struct file *file = vma->vm_file;
 357         struct mm_struct *mm = vma->vm_mm;
 358         struct kioctx_table *table;
 359         int i, res = -EINVAL;
 360
 361         spin_lock(&mm->ioctx_lock);
 362         rcu_read_lock();
 363         table = rcu_dereference(mm->ioctx_table);
 364         if (!table)
 365                 goto out_unlock;
 366
 367         for (i = 0; i < table->nr; i++) {
 368                 struct kioctx *ctx;
 369
 370                 ctx = rcu_dereference(table->table[i]);
 371                 if (ctx && ctx->aio_ring_file == file) {
 372                         if (!atomic_read(&ctx->dead)) {
 373                                 ctx->user_id = ctx->mmap_base = vma->vm_start;
 374                                 res = 0;
 375                         }
 376                         break;
 377                 }
 378         }
 379
 380 out_unlock:
 381         rcu_read_unlock();
 382         spin_unlock(&mm->ioctx_lock);
 383         return res;
 384 }
 385
 386 static const struct vm_operations_struct aio_ring_vm_ops = {
 387         .mremap         = aio_ring_mremap,
 388 #if IS_ENABLED(CONFIG_MMU)
 389         .fault          = filemap_fault,
 390         .map_pages      = filemap_map_pages,
 391         .page_mkwrite   = filemap_page_mkwrite,
 392 #endif
 393 };
 394
 395 static int aio_ring_mmap(struct file *file, struct vm_area_struct *vma)
 396 {
 397         vma->vm_flags |= VM_DONTEXPAND;
 398         vma->vm_ops = &aio_ring_vm_ops;
 399         return 0;
 400 }
 401
 402 static const struct file_operations aio_ring_fops = {
 403         .mmap = aio_ring_mmap,
 404 };
 405
 406 #if IS_ENABLED(CONFIG_MIGRATION)
 407 static int aio_migrate_folio(struct address_space *mapping, struct folio *dst,
 408                         struct folio *src, enum migrate_mode mode)
 409 {
 410         struct kioctx *ctx;
 411         unsigned long flags;
 412         pgoff_t idx;
 413         int rc;
 414
 415         /*
 416          * We cannot support the _NO_COPY case here, because copy needs to
 417          * happen under the ctx->completion_lock. That does not work with the
 418          * migration workflow of MIGRATE_SYNC_NO_COPY.
 419          */
 420         if (mode == MIGRATE_SYNC_NO_COPY)
 421                 return -EINVAL;
 422
 423         rc = 0;
 424
 425         /* mapping->private_lock here protects against the kioctx teardown.  */
 426         spin_lock(&mapping->private_lock);
 427         ctx = mapping->private_data;
 428         if (!ctx) {
 429                 rc = -EINVAL;
 430                 goto out;
 431         }
 432
 433         /* The ring_lock mutex.  The prevents aio_read_events() from writing
 434          * to the ring's head, and prevents page migration from mucking in
 435          * a partially initialized kiotx.
 436          */
 437         if (!mutex_trylock(&ctx->ring_lock)) {
 438                 rc = -EAGAIN;
 439                 goto out;
 440         }
 441
 442         idx = src->index;
 443         if (idx < (pgoff_t)ctx->nr_pages) {
 444                 /* Make sure the old folio hasn't already been changed */
 445                 if (ctx->ring_pages[idx] != &src->page)
 446                         rc = -EAGAIN;
 447         } else
 448                 rc = -EINVAL;
 449
 450         if (rc != 0)
 451                 goto out_unlock;
 452
 453         /* Writeback must be complete */
 454         BUG_ON(folio_test_writeback(src));
 455         folio_get(dst);
 456
 457         rc = folio_migrate_mapping(mapping, dst, src, 1);
 458         if (rc != MIGRATEPAGE_SUCCESS) {
 459                 folio_put(dst);
 460                 goto out_unlock;
 461         }
 462
 463         /* Take completion_lock to prevent other writes to the ring buffer
 464          * while the old folio is copied to the new.  This prevents new
 465          * events from being lost.
 466          */
 467         spin_lock_irqsave(&ctx->completion_lock, flags);
 468         folio_migrate_copy(dst, src);
 469         BUG_ON(ctx->ring_pages[idx] != &src->page);
 470         ctx->ring_pages[idx] = &dst->page;
 471         spin_unlock_irqrestore(&ctx->completion_lock, flags);
 472
 473         /* The old folio is no longer accessible. */
 474         folio_put(src);
 475
 476 out_unlock:
 477         mutex_unlock(&ctx->ring_lock);
 478 out:
 479         spin_unlock(&mapping->private_lock);
 480         return rc;
 481 }
 482 #else
 483 #define aio_migrate_folio NULL
 484 #endif
 485
 486 static const struct address_space_operations aio_ctx_aops = {
 487         .dirty_folio    = noop_dirty_folio,
 488         .migrate_folio  = aio_migrate_folio,
 489 };
 490
 491 static int aio_setup_ring(struct kioctx *ctx, unsigned int nr_events)
 492 {
 493         struct aio_ring *ring;
 494         struct mm_struct *mm = current->mm;
 495         unsigned long size, unused;
 496         int nr_pages;
 497         int i;
 498         struct file *file;
 499
 500         /* Compensate for the ring buffer's head/tail overlap entry */
 501         nr_events += 2; /* 1 is required, 2 for good luck */
 502
 503         size = sizeof(struct aio_ring);
 504         size += sizeof(struct io_event) * nr_events;
 505
 506         nr_pages = PFN_UP(size);
 507         if (nr_pages < 0)
 508                 return -EINVAL;
 509
 510         file = aio_private_file(ctx, nr_pages);
 511         if (IS_ERR(file)) {
 512                 ctx->aio_ring_file = NULL;
 513                 return -ENOMEM;
 514         }
 515
 516         ctx->aio_ring_file = file;
 517         nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring))
 518                         / sizeof(struct io_event);
 519
 520         ctx->ring_pages = ctx->internal_pages;
 521         if (nr_pages > AIO_RING_PAGES) {
 522                 ctx->ring_pages = kcalloc(nr_pages, sizeof(struct page *),
 523                                           GFP_KERNEL);
 524                 if (!ctx->ring_pages) {
 525                         put_aio_ring_file(ctx);
 526                         return -ENOMEM;
 527                 }
 528         }
 529
 530         for (i = 0; i < nr_pages; i++) {
 531                 struct page *page;
 532                 page = find_or_create_page(file->f_mapping,
 533                                            i, GFP_HIGHUSER | __GFP_ZERO);
 534                 if (!page)
 535                         break;
 536                 pr_debug("pid(%d) page[%d]->count=%d\n",
 537                          current->pid, i, page_count(page));
 538                 SetPageUptodate(page);
 539                 unlock_page(page);
 540
 541                 ctx->ring_pages[i] = page;
 542         }
 543         ctx->nr_pages = i;
 544
 545         if (unlikely(i != nr_pages)) {
 546                 aio_free_ring(ctx);
 547                 return -ENOMEM;
 548         }
 549
 550         ctx->mmap_size = nr_pages * PAGE_SIZE;
 551         pr_debug("attempting mmap of %lu bytes\n", ctx->mmap_size);
 552
 553         if (mmap_write_lock_killable(mm)) {
 554                 ctx->mmap_size = 0;
 555                 aio_free_ring(ctx);
 556                 return -EINTR;
 557         }
 558
 559         ctx->mmap_base = do_mmap(ctx->aio_ring_file, 0, ctx->mmap_size,
 560                                  PROT_READ | PROT_WRITE,
 561                                  MAP_SHARED, 0, &unused, NULL);
 562         mmap_write_unlock(mm);
 563         if (IS_ERR((void *)ctx->mmap_base)) {
 564                 ctx->mmap_size = 0;
 565                 aio_free_ring(ctx);
 566                 return -ENOMEM;
 567         }
 568
 569         pr_debug("mmap address: 0x%08lx\n", ctx->mmap_base);
 570
 571         ctx->user_id = ctx->mmap_base;
 572         ctx->nr_events = nr_events; /* trusted copy */
 573
 574         ring = kmap_atomic(ctx->ring_pages[0]);
 575         ring->nr = nr_events;   /* user copy */
 576         ring->id = ~0U;
 577         ring->head = ring->tail = 0;
 578         ring->magic = AIO_RING_MAGIC;
 579         ring->compat_features = AIO_RING_COMPAT_FEATURES;
 580         ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
 581         ring->header_length = sizeof(struct aio_ring);
 582         kunmap_atomic(ring);
 583         flush_dcache_page(ctx->ring_pages[0]);
 584
 585         return 0;
 586 }
 587
 588 #define AIO_EVENTS_PER_PAGE     (PAGE_SIZE / sizeof(struct io_event))
 589 #define AIO_EVENTS_FIRST_PAGE   ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
 590 #define AIO_EVENTS_OFFSET       (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
 591
 592 void kiocb_set_cancel_fn(struct kiocb *iocb, kiocb_cancel_fn *cancel)
 593 {
 594         struct aio_kiocb *req;
 595         struct kioctx *ctx;
 596         unsigned long flags;
 597
 598         /*
 599          * kiocb didn't come from aio or is neither a read nor a write, hence
 600          * ignore it.
 601          */
 602         if (!(iocb->ki_flags & IOCB_AIO_RW))
 603                 return;
 604
 605         req = container_of(iocb, struct aio_kiocb, rw);
 606
 607         if (WARN_ON_ONCE(!list_empty(&req->ki_list)))
 608                 return;
 609
 610         ctx = req->ki_ctx;
 611
 612         spin_lock_irqsave(&ctx->ctx_lock, flags);
 613         list_add_tail(&req->ki_list, &ctx->active_reqs);
 614         req->ki_cancel = cancel;
 615         spin_unlock_irqrestore(&ctx->ctx_lock, flags);
 616 }
 617 EXPORT_SYMBOL(kiocb_set_cancel_fn);
 618
 619 /*
 620  * free_ioctx() should be RCU delayed to synchronize against the RCU
 621  * protected lookup_ioctx() and also needs process context to call
 622  * aio_free_ring().  Use rcu_work.
 623  */
 624 static void free_ioctx(struct work_struct *work)
 625 {
 626         struct kioctx *ctx = container_of(to_rcu_work(work), struct kioctx,
 627                                           free_rwork);
 628         pr_debug("freeing %p\n", ctx);
 629
 630         aio_free_ring(ctx);
 631         free_percpu(ctx->cpu);
 632         percpu_ref_exit(&ctx->reqs);
 633         percpu_ref_exit(&ctx->users);
 634         kmem_cache_free(kioctx_cachep, ctx);
 635 }
 636
 637 static void free_ioctx_reqs(struct percpu_ref *ref)
 638 {
 639         struct kioctx *ctx = container_of(ref, struct kioctx, reqs);
 640
 641         /* At this point we know that there are no any in-flight requests */
 642         if (ctx->rq_wait && atomic_dec_and_test(&ctx->rq_wait->count))
 643                 complete(&ctx->rq_wait->comp);
 644
 645         /* Synchronize against RCU protected table->table[] dereferences */
 646         INIT_RCU_WORK(&ctx->free_rwork, free_ioctx);
 647         queue_rcu_work(system_wq, &ctx->free_rwork);
 648 }
 649
 650 /*
 651  * When this function runs, the kioctx has been removed from the "hash table"
 652  * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
 653  * now it's safe to cancel any that need to be.
 654  */
 655 static void free_ioctx_users(struct percpu_ref *ref)
 656 {
 657         struct kioctx *ctx = container_of(ref, struct kioctx, users);
 658         struct aio_kiocb *req;
 659
 660         spin_lock_irq(&ctx->ctx_lock);
 661
 662         while (!list_empty(&ctx->active_reqs)) {
 663                 req = list_first_entry(&ctx->active_reqs,
 664                                        struct aio_kiocb, ki_list);
 665                 req->ki_cancel(&req->rw);
 666                 list_del_init(&req->ki_list);
 667         }
 668
 669         spin_unlock_irq(&ctx->ctx_lock);
 670
 671         percpu_ref_kill(&ctx->reqs);
 672         percpu_ref_put(&ctx->reqs);
 673 }
 674
 675 static int ioctx_add_table(struct kioctx *ctx, struct mm_struct *mm)
 676 {
 677         unsigned i, new_nr;
 678         struct kioctx_table *table, *old;
 679         struct aio_ring *ring;
 680
 681         spin_lock(&mm->ioctx_lock);
 682         table = rcu_dereference_raw(mm->ioctx_table);
 683
 684         while (1) {
 685                 if (table)
 686                         for (i = 0; i < table->nr; i++)
 687                                 if (!rcu_access_pointer(table->table[i])) {
 688                                         ctx->id = i;
 689                                         rcu_assign_pointer(table->table[i], ctx);
 690                                         spin_unlock(&mm->ioctx_lock);
 691
 692                                         /* While kioctx setup is in progress,
 693                                          * we are protected from page migration
 694                                          * changes ring_pages by ->ring_lock.
 695                                          */
 696                                         ring = kmap_atomic(ctx->ring_pages[0]);
 697                                         ring->id = ctx->id;
 698                                         kunmap_atomic(ring);
 699                                         return 0;
 700                                 }
 701
 702                 new_nr = (table ? table->nr : 1) * 4;
 703                 spin_unlock(&mm->ioctx_lock);
 704
 705                 table = kzalloc(struct_size(table, table, new_nr), GFP_KERNEL);
 706                 if (!table)
 707                         return -ENOMEM;
 708
 709                 table->nr = new_nr;
 710
 711                 spin_lock(&mm->ioctx_lock);
 712                 old = rcu_dereference_raw(mm->ioctx_table);
 713
 714                 if (!old) {
 715                         rcu_assign_pointer(mm->ioctx_table, table);
 716                 } else if (table->nr > old->nr) {
 717                         memcpy(table->table, old->table,
 718                                old->nr * sizeof(struct kioctx *));
 719
 720                         rcu_assign_pointer(mm->ioctx_table, table);
 721                         kfree_rcu(old, rcu);
 722                 } else {
 723                         kfree(table);
 724                         table = old;
 725                 }
 726         }
 727 }
 728
 729 static void aio_nr_sub(unsigned nr)
 730 {
 731         spin_lock(&aio_nr_lock);
 732         if (WARN_ON(aio_nr - nr > aio_nr))
 733                 aio_nr = 0;
 734         else
 735                 aio_nr -= nr;
 736         spin_unlock(&aio_nr_lock);
 737 }
 738
 739 /* ioctx_alloc
 740  *      Allocates and initializes an ioctx.  Returns an ERR_PTR if it failed.
 741  */
 742 static struct kioctx *ioctx_alloc(unsigned nr_events)
 743 {
 744         struct mm_struct *mm = current->mm;
 745         struct kioctx *ctx;
 746         int err = -ENOMEM;
 747
 748         /*
 749          * Store the original nr_events -- what userspace passed to io_setup(),
 750          * for counting against the global limit -- before it changes.
 751          */
 752         unsigned int max_reqs = nr_events;
 753
 754         /*
 755          * We keep track of the number of available ringbuffer slots, to prevent
 756          * overflow (reqs_available), and we also use percpu counters for this.
 757          *
 758          * So since up to half the slots might be on other cpu's percpu counters
 759          * and unavailable, double nr_events so userspace sees what they
 760          * expected: additionally, we move req_batch slots to/from percpu
 761          * counters at a time, so make sure that isn't 0:
 762          */
 763         nr_events = max(nr_events, num_possible_cpus() * 4);
 764         nr_events *= 2;
 765
 766         /* Prevent overflows */
 767         if (nr_events > (0x10000000U / sizeof(struct io_event))) {
 768                 pr_debug("ENOMEM: nr_events too high\n");
 769                 return ERR_PTR(-EINVAL);
 770         }
 771
 772         if (!nr_events || (unsigned long)max_reqs > aio_max_nr)
 773                 return ERR_PTR(-EAGAIN);
 774
 775         ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
 776         if (!ctx)
 777                 return ERR_PTR(-ENOMEM);
 778
 779         ctx->max_reqs = max_reqs;
 780
 781         spin_lock_init(&ctx->ctx_lock);
 782         spin_lock_init(&ctx->completion_lock);
 783         mutex_init(&ctx->ring_lock);
 784         /* Protect against page migration throughout kiotx setup by keeping
 785          * the ring_lock mutex held until setup is complete. */
 786         mutex_lock(&ctx->ring_lock);
 787         init_waitqueue_head(&ctx->wait);
 788
 789         INIT_LIST_HEAD(&ctx->active_reqs);
 790
 791         if (percpu_ref_init(&ctx->users, free_ioctx_users, 0, GFP_KERNEL))
 792                 goto err;
 793
 794         if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs, 0, GFP_KERNEL))
 795                 goto err;
 796
 797         ctx->cpu = alloc_percpu(struct kioctx_cpu);
 798         if (!ctx->cpu)
 799                 goto err;
 800
 801         err = aio_setup_ring(ctx, nr_events);
 802         if (err < 0)
 803                 goto err;
 804
 805         atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
 806         ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
 807         if (ctx->req_batch < 1)
 808                 ctx->req_batch = 1;
 809
 810         /* limit the number of system wide aios */
 811         spin_lock(&aio_nr_lock);
 812         if (aio_nr + ctx->max_reqs > aio_max_nr ||
 813             aio_nr + ctx->max_reqs < aio_nr) {
 814                 spin_unlock(&aio_nr_lock);
 815                 err = -EAGAIN;
 816                 goto err_ctx;
 817         }
 818         aio_nr += ctx->max_reqs;
 819         spin_unlock(&aio_nr_lock);
 820
 821         percpu_ref_get(&ctx->users);    /* io_setup() will drop this ref */
 822         percpu_ref_get(&ctx->reqs);     /* free_ioctx_users() will drop this */
 823
 824         err = ioctx_add_table(ctx, mm);
 825         if (err)
 826                 goto err_cleanup;
 827
 828         /* Release the ring_lock mutex now that all setup is complete. */
 829         mutex_unlock(&ctx->ring_lock);
 830
 831         pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
 832                  ctx, ctx->user_id, mm, ctx->nr_events);
 833         return ctx;
 834
 835 err_cleanup:
 836         aio_nr_sub(ctx->max_reqs);
 837 err_ctx:
 838         atomic_set(&ctx->dead, 1);
 839         if (ctx->mmap_size)
 840                 vm_munmap(ctx->mmap_base, ctx->mmap_size);
 841         aio_free_ring(ctx);
 842 err:
 843         mutex_unlock(&ctx->ring_lock);
 844         free_percpu(ctx->cpu);
 845         percpu_ref_exit(&ctx->reqs);
 846         percpu_ref_exit(&ctx->users);
 847         kmem_cache_free(kioctx_cachep, ctx);
 848         pr_debug("error allocating ioctx %d\n", err);
 849         return ERR_PTR(err);
 850 }
 851
 852 /* kill_ioctx
 853  *      Cancels all outstanding aio requests on an aio context.  Used
 854  *      when the processes owning a context have all exited to encourage
 855  *      the rapid destruction of the kioctx.
 856  */
 857 static int kill_ioctx(struct mm_struct *mm, struct kioctx *ctx,
 858                       struct ctx_rq_wait *wait)
 859 {
 860         struct kioctx_table *table;
 861
 862         spin_lock(&mm->ioctx_lock);
 863         if (atomic_xchg(&ctx->dead, 1)) {
 864                 spin_unlock(&mm->ioctx_lock);
 865                 return -EINVAL;
 866         }
 867
 868         table = rcu_dereference_raw(mm->ioctx_table);
 869         WARN_ON(ctx != rcu_access_pointer(table->table[ctx->id]));
 870         RCU_INIT_POINTER(table->table[ctx->id], NULL);
 871         spin_unlock(&mm->ioctx_lock);
 872
 873         /* free_ioctx_reqs() will do the necessary RCU synchronization */
 874         wake_up_all(&ctx->wait);
 875
 876         /*
 877          * It'd be more correct to do this in free_ioctx(), after all
 878          * the outstanding kiocbs have finished - but by then io_destroy
 879          * has already returned, so io_setup() could potentially return
 880          * -EAGAIN with no ioctxs actually in use (as far as userspace
 881          *  could tell).
 882          */
 883         aio_nr_sub(ctx->max_reqs);
 884
 885         if (ctx->mmap_size)
 886                 vm_munmap(ctx->mmap_base, ctx->mmap_size);
 887
 888         ctx->rq_wait = wait;
 889         percpu_ref_kill(&ctx->users);
 890         return 0;
 891 }
 892
 893 /*
 894  * exit_aio: called when the last user of mm goes away.  At this point, there is
 895  * no way for any new requests to be submited or any of the io_* syscalls to be
 896  * called on the context.
 897  *
 898  * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
 899  * them.
 900  */
 901 void exit_aio(struct mm_struct *mm)
 902 {
 903         struct kioctx_table *table = rcu_dereference_raw(mm->ioctx_table);
 904         struct ctx_rq_wait wait;
 905         int i, skipped;
 906
 907         if (!table)
 908                 return;
 909
 910         atomic_set(&wait.count, table->nr);
 911         init_completion(&wait.comp);
 912
 913         skipped = 0;
 914         for (i = 0; i < table->nr; ++i) {
 915                 struct kioctx *ctx =
 916                         rcu_dereference_protected(table->table[i], true);
 917
 918                 if (!ctx) {
 919                         skipped++;
 920                         continue;
 921                 }
 922
 923                 /*
 924                  * We don't need to bother with munmap() here - exit_mmap(mm)
 925                  * is coming and it'll unmap everything. And we simply can't,
 926                  * this is not necessarily our ->mm.
 927                  * Since kill_ioctx() uses non-zero ->mmap_size as indicator
 928                  * that it needs to unmap the area, just set it to 0.
 929                  */
 930                 ctx->mmap_size = 0;
 931                 kill_ioctx(mm, ctx, &wait);
 932         }
 933
 934         if (!atomic_sub_and_test(skipped, &wait.count)) {
 935                 /* Wait until all IO for the context are done. */
 936                 wait_for_completion(&wait.comp);
 937         }
 938
 939         RCU_INIT_POINTER(mm->ioctx_table, NULL);
 940         kfree(table);
 941 }
 942
 943 static void put_reqs_available(struct kioctx *ctx, unsigned nr)
 944 {
 945         struct kioctx_cpu *kcpu;
 946         unsigned long flags;
 947
 948         local_irq_save(flags);
 949         kcpu = this_cpu_ptr(ctx->cpu);
 950         kcpu->reqs_available += nr;
 951
 952         while (kcpu->reqs_available >= ctx->req_batch * 2) {
 953                 kcpu->reqs_available -= ctx->req_batch;
 954                 atomic_add(ctx->req_batch, &ctx->reqs_available);
 955         }
 956
 957         local_irq_restore(flags);
 958 }
 959
 960 static bool __get_reqs_available(struct kioctx *ctx)
 961 {
 962         struct kioctx_cpu *kcpu;
 963         bool ret = false;
 964         unsigned long flags;
 965
 966         local_irq_save(flags);
 967         kcpu = this_cpu_ptr(ctx->cpu);
 968         if (!kcpu->reqs_available) {
 969                 int avail = atomic_read(&ctx->reqs_available);
 970
 971                 do {
 972                         if (avail < ctx->req_batch)
 973                                 goto out;
 974                 } while (!atomic_try_cmpxchg(&ctx->reqs_available,
 975                                              &avail, avail - ctx->req_batch));
 976
 977                 kcpu->reqs_available += ctx->req_batch;
 978         }
 979
 980         ret = true;
 981         kcpu->reqs_available--;
 982 out:
 983         local_irq_restore(flags);
 984         return ret;
 985 }
 986
 987 /* refill_reqs_available
 988  *      Updates the reqs_available reference counts used for tracking the
 989  *      number of free slots in the completion ring.  This can be called
 990  *      from aio_complete() (to optimistically update reqs_available) or
 991  *      from aio_get_req() (the we're out of events case).  It must be
 992  *      called holding ctx->completion_lock.
 993  */
 994 static void refill_reqs_available(struct kioctx *ctx, unsigned head,
 995                                   unsigned tail)
 996 {
 997         unsigned events_in_ring, completed;
 998
 999         /* Clamp head since userland can write to it. */
1000         head %= ctx->nr_events;
1001         if (head <= tail)
1002                 events_in_ring = tail - head;
1003         else
1004                 events_in_ring = ctx->nr_events - (head - tail);
1005
1006         completed = ctx->completed_events;
1007         if (events_in_ring < completed)
1008                 completed -= events_in_ring;
1009         else
1010                 completed = 0;
1011
1012         if (!completed)
1013                 return;
1014
1015         ctx->completed_events -= completed;
1016         put_reqs_available(ctx, completed);
1017 }
1018
1019 /* user_refill_reqs_available
1020  *      Called to refill reqs_available when aio_get_req() encounters an
1021  *      out of space in the completion ring.
1022  */
1023 static void user_refill_reqs_available(struct kioctx *ctx)
1024 {
1025         spin_lock_irq(&ctx->completion_lock);
1026         if (ctx->completed_events) {
1027                 struct aio_ring *ring;
1028                 unsigned head;
1029
1030                 /* Access of ring->head may race with aio_read_events_ring()
1031                  * here, but that's okay since whether we read the old version
1032                  * or the new version, and either will be valid.  The important
1033                  * part is that head cannot pass tail since we prevent
1034                  * aio_complete() from updating tail by holding
1035                  * ctx->completion_lock.  Even if head is invalid, the check
1036                  * against ctx->completed_events below will make sure we do the
1037                  * safe/right thing.
1038                  */
1039                 ring = kmap_atomic(ctx->ring_pages[0]);
1040                 head = ring->head;
1041                 kunmap_atomic(ring);
1042
1043                 refill_reqs_available(ctx, head, ctx->tail);
1044         }
1045
1046         spin_unlock_irq(&ctx->completion_lock);
1047 }
1048
1049 static bool get_reqs_available(struct kioctx *ctx)
1050 {
1051         if (__get_reqs_available(ctx))
1052                 return true;
1053         user_refill_reqs_available(ctx);
1054         return __get_reqs_available(ctx);
1055 }
1056
1057 /* aio_get_req
1058  *      Allocate a slot for an aio request.
1059  * Returns NULL if no requests are free.
1060  *
1061  * The refcount is initialized to 2 - one for the async op completion,
1062  * one for the synchronous code that does this.
1063  */
1064 static inline struct aio_kiocb *aio_get_req(struct kioctx *ctx)
1065 {
1066         struct aio_kiocb *req;
1067
1068         req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
1069         if (unlikely(!req))
1070                 return NULL;
1071
1072         if (unlikely(!get_reqs_available(ctx))) {
1073                 kmem_cache_free(kiocb_cachep, req);
1074                 return NULL;
1075         }
1076
1077         percpu_ref_get(&ctx->reqs);
1078         req->ki_ctx = ctx;
1079         INIT_LIST_HEAD(&req->ki_list);
1080         refcount_set(&req->ki_refcnt, 2);
1081         req->ki_eventfd = NULL;
1082         return req;
1083 }
1084
1085 static struct kioctx *lookup_ioctx(unsigned long ctx_id)
1086 {
1087         struct aio_ring __user *ring  = (void __user *)ctx_id;
1088         struct mm_struct *mm = current->mm;
1089         struct kioctx *ctx, *ret = NULL;
1090         struct kioctx_table *table;
1091         unsigned id;
1092
1093         if (get_user(id, &ring->id))
1094                 return NULL;
1095
1096         rcu_read_lock();
1097         table = rcu_dereference(mm->ioctx_table);
1098
1099         if (!table || id >= table->nr)
1100                 goto out;
1101
1102         id = array_index_nospec(id, table->nr);
1103         ctx = rcu_dereference(table->table[id]);
1104         if (ctx && ctx->user_id == ctx_id) {
1105                 if (percpu_ref_tryget_live(&ctx->users))
1106                         ret = ctx;
1107         }
1108 out:
1109         rcu_read_unlock();
1110         return ret;
1111 }
1112
1113 static inline void iocb_destroy(struct aio_kiocb *iocb)
1114 {
1115         if (iocb->ki_eventfd)
1116                 eventfd_ctx_put(iocb->ki_eventfd);
1117         if (iocb->ki_filp)
1118                 fput(iocb->ki_filp);
1119         percpu_ref_put(&iocb->ki_ctx->reqs);
1120         kmem_cache_free(kiocb_cachep, iocb);
1121 }
1122
1123 /* aio_complete
1124  *      Called when the io request on the given iocb is complete.
1125  */
1126 static void aio_complete(struct aio_kiocb *iocb)
1127 {
1128         struct kioctx   *ctx = iocb->ki_ctx;
1129         struct aio_ring *ring;
1130         struct io_event *ev_page, *event;
1131         unsigned tail, pos, head;
1132         unsigned long   flags;
1133
1134         /*
1135          * Add a completion event to the ring buffer. Must be done holding
1136          * ctx->completion_lock to prevent other code from messing with the tail
1137          * pointer since we might be called from irq context.
1138          */
1139         spin_lock_irqsave(&ctx->completion_lock, flags);
1140
1141         tail = ctx->tail;
1142         pos = tail + AIO_EVENTS_OFFSET;
1143
1144         if (++tail >= ctx->nr_events)
1145                 tail = 0;
1146
1147         ev_page = kmap_atomic(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
1148         event = ev_page + pos % AIO_EVENTS_PER_PAGE;
1149
1150         *event = iocb->ki_res;
1151
1152         kunmap_atomic(ev_page);
1153         flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
1154
1155         pr_debug("%p[%u]: %p: %p %Lx %Lx %Lx\n", ctx, tail, iocb,
1156                  (void __user *)(unsigned long)iocb->ki_res.obj,
1157                  iocb->ki_res.data, iocb->ki_res.res, iocb->ki_res.res2);
1158
1159         /* after flagging the request as done, we
1160          * must never even look at it again
1161          */
1162         smp_wmb();      /* make event visible before updating tail */
1163
1164         ctx->tail = tail;
1165
1166         ring = kmap_atomic(ctx->ring_pages[0]);
1167         head = ring->head;
1168         ring->tail = tail;
1169         kunmap_atomic(ring);
1170         flush_dcache_page(ctx->ring_pages[0]);
1171
1172         ctx->completed_events++;
1173         if (ctx->completed_events > 1)
1174                 refill_reqs_available(ctx, head, tail);
1175         spin_unlock_irqrestore(&ctx->completion_lock, flags);
1176
1177         pr_debug("added to ring %p at [%u]\n", iocb, tail);
1178
1179         /*
1180          * Check if the user asked us to deliver the result through an
1181          * eventfd. The eventfd_signal() function is safe to be called
1182          * from IRQ context.
1183          */
1184         if (iocb->ki_eventfd)
1185                 eventfd_signal(iocb->ki_eventfd, 1);
1186
1187         /*
1188          * We have to order our ring_info tail store above and test
1189          * of the wait list below outside the wait lock.  This is
1190          * like in wake_up_bit() where clearing a bit has to be
1191          * ordered with the unlocked test.
1192          */
1193         smp_mb();
1194
1195         if (waitqueue_active(&ctx->wait))
1196                 wake_up(&ctx->wait);
1197 }
1198
1199 static inline void iocb_put(struct aio_kiocb *iocb)
1200 {
1201         if (refcount_dec_and_test(&iocb->ki_refcnt)) {
1202                 aio_complete(iocb);
1203                 iocb_destroy(iocb);
1204         }
1205 }
1206
1207 /* aio_read_events_ring
1208  *      Pull an event off of the ioctx's event ring.  Returns the number of
1209  *      events fetched
1210  */
1211 static long aio_read_events_ring(struct kioctx *ctx,
1212                                  struct io_event __user *event, long nr)
1213 {
1214         struct aio_ring *ring;
1215         unsigned head, tail, pos;
1216         long ret = 0;
1217         int copy_ret;
1218
1219         /*
1220          * The mutex can block and wake us up and that will cause
1221          * wait_event_interruptible_hrtimeout() to schedule without sleeping
1222          * and repeat. This should be rare enough that it doesn't cause
1223          * peformance issues. See the comment in read_events() for more detail.
1224          */
1225         sched_annotate_sleep();
1226         mutex_lock(&ctx->ring_lock);
1227
1228         /* Access to ->ring_pages here is protected by ctx->ring_lock. */
1229         ring = kmap_atomic(ctx->ring_pages[0]);
1230         head = ring->head;
1231         tail = ring->tail;
1232         kunmap_atomic(ring);
1233
1234         /*
1235          * Ensure that once we've read the current tail pointer, that
1236          * we also see the events that were stored up to the tail.
1237          */
1238         smp_rmb();
1239
1240         pr_debug("h%u t%u m%u\n", head, tail, ctx->nr_events);
1241
1242         if (head == tail)
1243                 goto out;
1244
1245         head %= ctx->nr_events;
1246         tail %= ctx->nr_events;
1247
1248         while (ret < nr) {
1249                 long avail;
1250                 struct io_event *ev;
1251                 struct page *page;
1252
1253                 avail = (head <= tail ?  tail : ctx->nr_events) - head;
1254                 if (head == tail)
1255                         break;
1256
1257                 pos = head + AIO_EVENTS_OFFSET;
1258                 page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
1259                 pos %= AIO_EVENTS_PER_PAGE;
1260
1261                 avail = min(avail, nr - ret);
1262                 avail = min_t(long, avail, AIO_EVENTS_PER_PAGE - pos);
1263
1264                 ev = kmap(page);
1265                 copy_ret = copy_to_user(event + ret, ev + pos,
1266                                         sizeof(*ev) * avail);
1267                 kunmap(page);
1268
1269                 if (unlikely(copy_ret)) {
1270                         ret = -EFAULT;
1271                         goto out;
1272                 }
1273
1274                 ret += avail;
1275                 head += avail;
1276                 head %= ctx->nr_events;
1277         }
1278
1279         ring = kmap_atomic(ctx->ring_pages[0]);
1280         ring->head = head;
1281         kunmap_atomic(ring);
1282         flush_dcache_page(ctx->ring_pages[0]);
1283
1284         pr_debug("%li  h%u t%u\n", ret, head, tail);
1285 out:
1286         mutex_unlock(&ctx->ring_lock);
1287
1288         return ret;
1289 }
1290
1291 static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
1292                             struct io_event __user *event, long *i)
1293 {
1294         long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
1295
1296         if (ret > 0)
1297                 *i += ret;
1298
1299         if (unlikely(atomic_read(&ctx->dead)))
1300                 ret = -EINVAL;
1301
1302         if (!*i)
1303                 *i = ret;
1304
1305         return ret < 0 || *i >= min_nr;
1306 }
1307
1308 static long read_events(struct kioctx *ctx, long min_nr, long nr,
1309                         struct io_event __user *event,
1310                         ktime_t until)
1311 {
1312         long ret = 0;
1313
1314         /*
1315          * Note that aio_read_events() is being called as the conditional - i.e.
1316          * we're calling it after prepare_to_wait() has set task state to
1317          * TASK_INTERRUPTIBLE.
1318          *
1319          * But aio_read_events() can block, and if it blocks it's going to flip
1320          * the task state back to TASK_RUNNING.
1321          *
1322          * This should be ok, provided it doesn't flip the state back to
1323          * TASK_RUNNING and return 0 too much - that causes us to spin. That
1324          * will only happen if the mutex_lock() call blocks, and we then find
1325          * the ringbuffer empty. So in practice we should be ok, but it's
1326          * something to be aware of when touching this code.
1327          */
1328         if (until == 0)
1329                 aio_read_events(ctx, min_nr, nr, event, &ret);
1330         else
1331                 wait_event_interruptible_hrtimeout(ctx->wait,
1332                                 aio_read_events(ctx, min_nr, nr, event, &ret),
1333                                 until);
1334         return ret;
1335 }
1336
1337 /* sys_io_setup:
1338  *      Create an aio_context capable of receiving at least nr_events.
1339  *      ctxp must not point to an aio_context that already exists, and
1340  *      must be initialized to 0 prior to the call.  On successful
1341  *      creation of the aio_context, *ctxp is filled in with the resulting
1342  *      handle.  May fail with -EINVAL if *ctxp is not initialized,
1343  *      if the specified nr_events exceeds internal limits.  May fail
1344  *      with -EAGAIN if the specified nr_events exceeds the user's limit
1345  *      of available events.  May fail with -ENOMEM if insufficient kernel
1346  *      resources are available.  May fail with -EFAULT if an invalid
1347  *      pointer is passed for ctxp.  Will fail with -ENOSYS if not
1348  *      implemented.
1349  */
1350 SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
1351 {
1352         struct kioctx *ioctx = NULL;
1353         unsigned long ctx;
1354         long ret;
1355
1356         ret = get_user(ctx, ctxp);
1357         if (unlikely(ret))
1358                 goto out;
1359
1360         ret = -EINVAL;
1361         if (unlikely(ctx || nr_events == 0)) {
1362                 pr_debug("EINVAL: ctx %lu nr_events %u\n",
1363                          ctx, nr_events);
1364                 goto out;
1365         }
1366
1367         ioctx = ioctx_alloc(nr_events);
1368         ret = PTR_ERR(ioctx);
1369         if (!IS_ERR(ioctx)) {
1370                 ret = put_user(ioctx->user_id, ctxp);
1371                 if (ret)
1372                         kill_ioctx(current->mm, ioctx, NULL);
1373                 percpu_ref_put(&ioctx->users);
1374         }
1375
1376 out:
1377         return ret;
1378 }
1379
1380 #ifdef CONFIG_COMPAT
1381 COMPAT_SYSCALL_DEFINE2(io_setup, unsigned, nr_events, u32 __user *, ctx32p)
1382 {
1383         struct kioctx *ioctx = NULL;
1384         unsigned long ctx;
1385         long ret;
1386
1387         ret = get_user(ctx, ctx32p);
1388         if (unlikely(ret))
1389                 goto out;
1390
1391         ret = -EINVAL;
1392         if (unlikely(ctx || nr_events == 0)) {
1393                 pr_debug("EINVAL: ctx %lu nr_events %u\n",
1394                          ctx, nr_events);
1395                 goto out;
1396         }
1397
1398         ioctx = ioctx_alloc(nr_events);
1399         ret = PTR_ERR(ioctx);
1400         if (!IS_ERR(ioctx)) {
1401                 /* truncating is ok because it's a user address */
1402                 ret = put_user((u32)ioctx->user_id, ctx32p);
1403                 if (ret)
1404                         kill_ioctx(current->mm, ioctx, NULL);
1405                 percpu_ref_put(&ioctx->users);
1406         }
1407
1408 out:
1409         return ret;
1410 }
1411 #endif
1412
1413 /* sys_io_destroy:
1414  *      Destroy the aio_context specified.  May cancel any outstanding
1415  *      AIOs and block on completion.  Will fail with -ENOSYS if not
1416  *      implemented.  May fail with -EINVAL if the context pointed to
1417  *      is invalid.
1418  */
1419 SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
1420 {
1421         struct kioctx *ioctx = lookup_ioctx(ctx);
1422         if (likely(NULL != ioctx)) {
1423                 struct ctx_rq_wait wait;
1424                 int ret;
1425
1426                 init_completion(&wait.comp);
1427                 atomic_set(&wait.count, 1);
1428
1429                 /* Pass requests_done to kill_ioctx() where it can be set
1430                  * in a thread-safe way. If we try to set it here then we have
1431                  * a race condition if two io_destroy() called simultaneously.
1432                  */
1433                 ret = kill_ioctx(current->mm, ioctx, &wait);
1434                 percpu_ref_put(&ioctx->users);
1435
1436                 /* Wait until all IO for the context are done. Otherwise kernel
1437                  * keep using user-space buffers even if user thinks the context
1438                  * is destroyed.
1439                  */
1440                 if (!ret)
1441                         wait_for_completion(&wait.comp);
1442
1443                 return ret;
1444         }
1445         pr_debug("EINVAL: invalid context id\n");
1446         return -EINVAL;
1447 }
1448
1449 static void aio_remove_iocb(struct aio_kiocb *iocb)
1450 {
1451         struct kioctx *ctx = iocb->ki_ctx;
1452         unsigned long flags;
1453
1454         spin_lock_irqsave(&ctx->ctx_lock, flags);
1455         list_del(&iocb->ki_list);
1456         spin_unlock_irqrestore(&ctx->ctx_lock, flags);
1457 }
1458
1459 static void aio_complete_rw(struct kiocb *kiocb, long res)
1460 {
1461         struct aio_kiocb *iocb = container_of(kiocb, struct aio_kiocb, rw);
1462
1463         if (!list_empty_careful(&iocb->ki_list))
1464                 aio_remove_iocb(iocb);
1465
1466         if (kiocb->ki_flags & IOCB_WRITE) {
1467                 struct inode *inode = file_inode(kiocb->ki_filp);
1468
1469                 /*
1470                  * Tell lockdep we inherited freeze protection from submission
1471                  * thread.
1472                  */
1473                 if (S_ISREG(inode->i_mode))
1474                         __sb_writers_acquired(inode->i_sb, SB_FREEZE_WRITE);
1475                 file_end_write(kiocb->ki_filp);
1476         }
1477
1478         iocb->ki_res.res = res;
1479         iocb->ki_res.res2 = 0;
1480         iocb_put(iocb);
1481 }
1482
1483 static int aio_prep_rw(struct kiocb *req, const struct iocb *iocb)
1484 {
1485         int ret;
1486
1487         req->ki_complete = aio_complete_rw;
1488         req->private = NULL;
1489         req->ki_pos = iocb->aio_offset;
1490         req->ki_flags = req->ki_filp->f_iocb_flags | IOCB_AIO_RW;
1491         if (iocb->aio_flags & IOCB_FLAG_RESFD)
1492                 req->ki_flags |= IOCB_EVENTFD;
1493         if (iocb->aio_flags & IOCB_FLAG_IOPRIO) {
1494                 /*
1495                  * If the IOCB_FLAG_IOPRIO flag of aio_flags is set, then
1496                  * aio_reqprio is interpreted as an I/O scheduling
1497                  * class and priority.
1498                  */
1499                 ret = ioprio_check_cap(iocb->aio_reqprio);
1500                 if (ret) {
1501                         pr_debug("aio ioprio check cap error: %d\n", ret);
1502                         return ret;
1503                 }
1504
1505                 req->ki_ioprio = iocb->aio_reqprio;
1506         } else
1507                 req->ki_ioprio = get_current_ioprio();
1508
1509         ret = kiocb_set_rw_flags(req, iocb->aio_rw_flags);
1510         if (unlikely(ret))
1511                 return ret;
1512
1513         req->ki_flags &= ~IOCB_HIPRI; /* no one is going to poll for this I/O */
1514         return 0;
1515 }
1516
1517 static ssize_t aio_setup_rw(int rw, const struct iocb *iocb,
1518                 struct iovec **iovec, bool vectored, bool compat,
1519                 struct iov_iter *iter)
1520 {
1521         void __user *buf = (void __user *)(uintptr_t)iocb->aio_buf;
1522         size_t len = iocb->aio_nbytes;
1523
1524         if (!vectored) {
1525                 ssize_t ret = import_single_range(rw, buf, len, *iovec, iter);
1526                 *iovec = NULL;
1527                 return ret;
1528         }
1529
1530         return __import_iovec(rw, buf, len, UIO_FASTIOV, iovec, iter, compat);
1531 }
1532
1533 static inline void aio_rw_done(struct kiocb *req, ssize_t ret)
1534 {
1535         switch (ret) {
1536         case -EIOCBQUEUED:
1537                 break;
1538         case -ERESTARTSYS:
1539         case -ERESTARTNOINTR:
1540         case -ERESTARTNOHAND:
1541         case -ERESTART_RESTARTBLOCK:
1542                 /*
1543                  * There's no easy way to restart the syscall since other AIO's
1544                  * may be already running. Just fail this IO with EINTR.
1545                  */
1546                 ret = -EINTR;
1547                 fallthrough;
1548         default:
1549                 req->ki_complete(req, ret);
1550         }
1551 }
1552
1553 static int aio_read(struct kiocb *req, const struct iocb *iocb,
1554                         bool vectored, bool compat)
1555 {
1556         struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1557         struct iov_iter iter;
1558         struct file *file;
1559         int ret;
1560
1561         ret = aio_prep_rw(req, iocb);
1562         if (ret)
1563                 return ret;
1564         file = req->ki_filp;
1565         if (unlikely(!(file->f_mode & FMODE_READ)))
1566                 return -EBADF;
1567         if (unlikely(!file->f_op->read_iter))
1568                 return -EINVAL;
1569
1570         ret = aio_setup_rw(ITER_DEST, iocb, &iovec, vectored, compat, &iter);
1571         if (ret < 0)
1572                 return ret;
1573         ret = rw_verify_area(READ, file, &req->ki_pos, iov_iter_count(&iter));
1574         if (!ret)
1575                 aio_rw_done(req, call_read_iter(file, req, &iter));
1576         kfree(iovec);
1577         return ret;
1578 }
1579
1580 static int aio_write(struct kiocb *req, const struct iocb *iocb,
1581                          bool vectored, bool compat)
1582 {
1583         struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1584         struct iov_iter iter;
1585         struct file *file;
1586         int ret;
1587
1588         ret = aio_prep_rw(req, iocb);
1589         if (ret)
1590                 return ret;
1591         file = req->ki_filp;
1592
1593         if (unlikely(!(file->f_mode & FMODE_WRITE)))
1594                 return -EBADF;
1595         if (unlikely(!file->f_op->write_iter))
1596                 return -EINVAL;
1597
1598         ret = aio_setup_rw(ITER_SOURCE, iocb, &iovec, vectored, compat, &iter);
1599         if (ret < 0)
1600                 return ret;
1601         ret = rw_verify_area(WRITE, file, &req->ki_pos, iov_iter_count(&iter));
1602         if (!ret) {
1603                 /*
1604                  * Open-code file_start_write here to grab freeze protection,
1605                  * which will be released by another thread in
1606                  * aio_complete_rw().  Fool lockdep by telling it the lock got
1607                  * released so that it doesn't complain about the held lock when
1608                  * we return to userspace.
1609                  */
1610                 if (S_ISREG(file_inode(file)->i_mode)) {
1611                         sb_start_write(file_inode(file)->i_sb);
1612                         __sb_writers_release(file_inode(file)->i_sb, SB_FREEZE_WRITE);
1613                 }
1614                 req->ki_flags |= IOCB_WRITE;
1615                 aio_rw_done(req, call_write_iter(file, req, &iter));
1616         }
1617         kfree(iovec);
1618         return ret;
1619 }
1620
1621 static void aio_fsync_work(struct work_struct *work)
1622 {
1623         struct aio_kiocb *iocb = container_of(work, struct aio_kiocb, fsync.work);
1624         const struct cred *old_cred = override_creds(iocb->fsync.creds);
1625
1626         iocb->ki_res.res = vfs_fsync(iocb->fsync.file, iocb->fsync.datasync);
1627         revert_creds(old_cred);
1628         put_cred(iocb->fsync.creds);
1629         iocb_put(iocb);
1630 }
1631
1632 static int aio_fsync(struct fsync_iocb *req, const struct iocb *iocb,
1633                      bool datasync)
1634 {
1635         if (unlikely(iocb->aio_buf || iocb->aio_offset || iocb->aio_nbytes ||
1636                         iocb->aio_rw_flags))
1637                 return -EINVAL;
1638
1639         if (unlikely(!req->file->f_op->fsync))
1640                 return -EINVAL;
1641
1642         req->creds = prepare_creds();
1643         if (!req->creds)
1644                 return -ENOMEM;
1645
1646         req->datasync = datasync;
1647         INIT_WORK(&req->work, aio_fsync_work);
1648         schedule_work(&req->work);
1649         return 0;
1650 }
1651
1652 static void aio_poll_put_work(struct work_struct *work)
1653 {
1654         struct poll_iocb *req = container_of(work, struct poll_iocb, work);
1655         struct aio_kiocb *iocb = container_of(req, struct aio_kiocb, poll);
1656
1657         iocb_put(iocb);
1658 }
1659
1660 /*
1661  * Safely lock the waitqueue which the request is on, synchronizing with the
1662  * case where the ->poll() provider decides to free its waitqueue early.
1663  *
1664  * Returns true on success, meaning that req->head->lock was locked, req->wait
1665  * is on req->head, and an RCU read lock was taken.  Returns false if the
1666  * request was already removed from its waitqueue (which might no longer exist).
1667  */
1668 static bool poll_iocb_lock_wq(struct poll_iocb *req)
1669 {
1670         wait_queue_head_t *head;
1671
1672         /*
1673          * While we hold the waitqueue lock and the waitqueue is nonempty,
1674          * wake_up_pollfree() will wait for us.  However, taking the waitqueue
1675          * lock in the first place can race with the waitqueue being freed.
1676          *
1677          * We solve this as eventpoll does: by taking advantage of the fact that
1678          * all users of wake_up_pollfree() will RCU-delay the actual free.  If
1679          * we enter rcu_read_lock() and see that the pointer to the queue is
1680          * non-NULL, we can then lock it without the memory being freed out from
1681          * under us, then check whether the request is still on the queue.
1682          *
1683          * Keep holding rcu_read_lock() as long as we hold the queue lock, in
1684          * case the caller deletes the entry from the queue, leaving it empty.
1685          * In that case, only RCU prevents the queue memory from being freed.
1686          */
1687         rcu_read_lock();
1688         head = smp_load_acquire(&req->head);
1689         if (head) {
1690                 spin_lock(&head->lock);
1691                 if (!list_empty(&req->wait.entry))
1692                         return true;
1693                 spin_unlock(&head->lock);
1694         }
1695         rcu_read_unlock();
1696         return false;
1697 }
1698
1699 static void poll_iocb_unlock_wq(struct poll_iocb *req)
1700 {
1701         spin_unlock(&req->head->lock);
1702         rcu_read_unlock();
1703 }
1704
1705 static void aio_poll_complete_work(struct work_struct *work)
1706 {
1707         struct poll_iocb *req = container_of(work, struct poll_iocb, work);
1708         struct aio_kiocb *iocb = container_of(req, struct aio_kiocb, poll);
1709         struct poll_table_struct pt = { ._key = req->events };
1710         struct kioctx *ctx = iocb->ki_ctx;
1711         __poll_t mask = 0;
1712
1713         if (!READ_ONCE(req->cancelled))
1714                 mask = vfs_poll(req->file, &pt) & req->events;
1715
1716         /*
1717          * Note that ->ki_cancel callers also delete iocb from active_reqs after
1718          * calling ->ki_cancel.  We need the ctx_lock roundtrip here to
1719          * synchronize with them.  In the cancellation case the list_del_init
1720          * itself is not actually needed, but harmless so we keep it in to
1721          * avoid further branches in the fast path.
1722          */
1723         spin_lock_irq(&ctx->ctx_lock);
1724         if (poll_iocb_lock_wq(req)) {
1725                 if (!mask && !READ_ONCE(req->cancelled)) {
1726                         /*
1727                          * The request isn't actually ready to be completed yet.
1728                          * Reschedule completion if another wakeup came in.
1729                          */
1730                         if (req->work_need_resched) {
1731                                 schedule_work(&req->work);
1732                                 req->work_need_resched = false;
1733                         } else {
1734                                 req->work_scheduled = false;
1735                         }
1736                         poll_iocb_unlock_wq(req);
1737                         spin_unlock_irq(&ctx->ctx_lock);
1738                         return;
1739                 }
1740                 list_del_init(&req->wait.entry);
1741                 poll_iocb_unlock_wq(req);
1742         } /* else, POLLFREE has freed the waitqueue, so we must complete */
1743         list_del_init(&iocb->ki_list);
1744         iocb->ki_res.res = mangle_poll(mask);
1745         spin_unlock_irq(&ctx->ctx_lock);
1746
1747         iocb_put(iocb);
1748 }
1749
1750 /* assumes we are called with irqs disabled */
1751 static int aio_poll_cancel(struct kiocb *iocb)
1752 {
1753         struct aio_kiocb *aiocb = container_of(iocb, struct aio_kiocb, rw);
1754         struct poll_iocb *req = &aiocb->poll;
1755
1756         if (poll_iocb_lock_wq(req)) {
1757                 WRITE_ONCE(req->cancelled, true);
1758                 if (!req->work_scheduled) {
1759                         schedule_work(&aiocb->poll.work);
1760                         req->work_scheduled = true;
1761                 }
1762                 poll_iocb_unlock_wq(req);
1763         } /* else, the request was force-cancelled by POLLFREE already */
1764
1765         return 0;
1766 }
1767
1768 static int aio_poll_wake(struct wait_queue_entry *wait, unsigned mode, int sync,
1769                 void *key)
1770 {
1771         struct poll_iocb *req = container_of(wait, struct poll_iocb, wait);
1772         struct aio_kiocb *iocb = container_of(req, struct aio_kiocb, poll);
1773         __poll_t mask = key_to_poll(key);
1774         unsigned long flags;
1775
1776         /* for instances that support it check for an event match first: */
1777         if (mask && !(mask & req->events))
1778                 return 0;
1779
1780         /*
1781          * Complete the request inline if possible.  This requires that three
1782          * conditions be met:
1783          *   1. An event mask must have been passed.  If a plain wakeup was done
1784          *      instead, then mask == 0 and we have to call vfs_poll() to get
1785          *      the events, so inline completion isn't possible.
1786          *   2. The completion work must not have already been scheduled.
1787          *   3. ctx_lock must not be busy.  We have to use trylock because we
1788          *      already hold the waitqueue lock, so this inverts the normal
1789          *      locking order.  Use irqsave/irqrestore because not all
1790          *      filesystems (e.g. fuse) call this function with IRQs disabled,
1791          *      yet IRQs have to be disabled before ctx_lock is obtained.
1792          */
1793         if (mask && !req->work_scheduled &&
1794             spin_trylock_irqsave(&iocb->ki_ctx->ctx_lock, flags)) {
1795                 struct kioctx *ctx = iocb->ki_ctx;
1796
1797                 list_del_init(&req->wait.entry);
1798                 list_del(&iocb->ki_list);
1799                 iocb->ki_res.res = mangle_poll(mask);
1800                 if (iocb->ki_eventfd && !eventfd_signal_allowed()) {
1801                         iocb = NULL;
1802                         INIT_WORK(&req->work, aio_poll_put_work);
1803                         schedule_work(&req->work);
1804                 }
1805                 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
1806                 if (iocb)
1807                         iocb_put(iocb);
1808         } else {
1809                 /*
1810                  * Schedule the completion work if needed.  If it was already
1811                  * scheduled, record that another wakeup came in.
1812                  *
1813                  * Don't remove the request from the waitqueue here, as it might
1814                  * not actually be complete yet (we won't know until vfs_poll()
1815                  * is called), and we must not miss any wakeups.  POLLFREE is an
1816                  * exception to this; see below.
1817                  */
1818                 if (req->work_scheduled) {
1819                         req->work_need_resched = true;
1820                 } else {
1821                         schedule_work(&req->work);
1822                         req->work_scheduled = true;
1823                 }
1824
1825                 /*
1826                  * If the waitqueue is being freed early but we can't complete
1827                  * the request inline, we have to tear down the request as best
1828                  * we can.  That means immediately removing the request from its
1829                  * waitqueue and preventing all further accesses to the
1830                  * waitqueue via the request.  We also need to schedule the
1831                  * completion work (done above).  Also mark the request as
1832                  * cancelled, to potentially skip an unneeded call to ->poll().
1833                  */
1834                 if (mask & POLLFREE) {
1835                         WRITE_ONCE(req->cancelled, true);
1836                         list_del_init(&req->wait.entry);
1837
1838                         /*
1839                          * Careful: this *must* be the last step, since as soon
1840                          * as req->head is NULL'ed out, the request can be
1841                          * completed and freed, since aio_poll_complete_work()
1842                          * will no longer need to take the waitqueue lock.
1843                          */
1844                         smp_store_release(&req->head, NULL);
1845                 }
1846         }
1847         return 1;
1848 }
1849
1850 struct aio_poll_table {
1851         struct poll_table_struct        pt;
1852         struct aio_kiocb                *iocb;
1853         bool                            queued;
1854         int                             error;
1855 };
1856
1857 static void
1858 aio_poll_queue_proc(struct file *file, struct wait_queue_head *head,
1859                 struct poll_table_struct *p)
1860 {
1861         struct aio_poll_table *pt = container_of(p, struct aio_poll_table, pt);
1862
1863         /* multiple wait queues per file are not supported */
1864         if (unlikely(pt->queued)) {
1865                 pt->error = -EINVAL;
1866                 return;
1867         }
1868
1869         pt->queued = true;
1870         pt->error = 0;
1871         pt->iocb->poll.head = head;
1872         add_wait_queue(head, &pt->iocb->poll.wait);
1873 }
1874
1875 static int aio_poll(struct aio_kiocb *aiocb, const struct iocb *iocb)
1876 {
1877         struct kioctx *ctx = aiocb->ki_ctx;
1878         struct poll_iocb *req = &aiocb->poll;
1879         struct aio_poll_table apt;
1880         bool cancel = false;
1881         __poll_t mask;
1882
1883         /* reject any unknown events outside the normal event mask. */
1884         if ((u16)iocb->aio_buf != iocb->aio_buf)
1885                 return -EINVAL;
1886         /* reject fields that are not defined for poll */
1887         if (iocb->aio_offset || iocb->aio_nbytes || iocb->aio_rw_flags)
1888                 return -EINVAL;
1889
1890         INIT_WORK(&req->work, aio_poll_complete_work);
1891         req->events = demangle_poll(iocb->aio_buf) | EPOLLERR | EPOLLHUP;
1892
1893         req->head = NULL;
1894         req->cancelled = false;
1895         req->work_scheduled = false;
1896         req->work_need_resched = false;
1897
1898         apt.pt._qproc = aio_poll_queue_proc;
1899         apt.pt._key = req->events;
1900         apt.iocb = aiocb;
1901         apt.queued = false;
1902         apt.error = -EINVAL; /* same as no support for IOCB_CMD_POLL */
1903
1904         /* initialized the list so that we can do list_empty checks */
1905         INIT_LIST_HEAD(&req->wait.entry);
1906         init_waitqueue_func_entry(&req->wait, aio_poll_wake);
1907
1908         mask = vfs_poll(req->file, &apt.pt) & req->events;
1909         spin_lock_irq(&ctx->ctx_lock);
1910         if (likely(apt.queued)) {
1911                 bool on_queue = poll_iocb_lock_wq(req);
1912
1913                 if (!on_queue || req->work_scheduled) {
1914                         /*
1915                          * aio_poll_wake() already either scheduled the async
1916                          * completion work, or completed the request inline.
1917                          */
1918                         if (apt.error) /* unsupported case: multiple queues */
1919                                 cancel = true;
1920                         apt.error = 0;
1921                         mask = 0;
1922                 }
1923                 if (mask || apt.error) {
1924                         /* Steal to complete synchronously. */
1925                         list_del_init(&req->wait.entry);
1926                 } else if (cancel) {
1927                         /* Cancel if possible (may be too late though). */
1928                         WRITE_ONCE(req->cancelled, true);
1929                 } else if (on_queue) {
1930                         /*
1931                          * Actually waiting for an event, so add the request to
1932                          * active_reqs so that it can be cancelled if needed.
1933                          */
1934                         list_add_tail(&aiocb->ki_list, &ctx->active_reqs);
1935                         aiocb->ki_cancel = aio_poll_cancel;
1936                 }
1937                 if (on_queue)
1938                         poll_iocb_unlock_wq(req);
1939         }
1940         if (mask) { /* no async, we'd stolen it */
1941                 aiocb->ki_res.res = mangle_poll(mask);
1942                 apt.error = 0;
1943         }
1944         spin_unlock_irq(&ctx->ctx_lock);
1945         if (mask)
1946                 iocb_put(aiocb);
1947         return apt.error;
1948 }
1949
1950 static int __io_submit_one(struct kioctx *ctx, const struct iocb *iocb,
1951                            struct iocb __user *user_iocb, struct aio_kiocb *req,
1952                            bool compat)
1953 {
1954         req->ki_filp = fget(iocb->aio_fildes);
1955         if (unlikely(!req->ki_filp))
1956                 return -EBADF;
1957
1958         if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1959                 struct eventfd_ctx *eventfd;
1960                 /*
1961                  * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1962                  * instance of the file* now. The file descriptor must be
1963                  * an eventfd() fd, and will be signaled for each completed
1964                  * event using the eventfd_signal() function.
1965                  */
1966                 eventfd = eventfd_ctx_fdget(iocb->aio_resfd);
1967                 if (IS_ERR(eventfd))
1968                         return PTR_ERR(eventfd);
1969
1970                 req->ki_eventfd = eventfd;
1971         }
1972
1973         if (unlikely(put_user(KIOCB_KEY, &user_iocb->aio_key))) {
1974                 pr_debug("EFAULT: aio_key\n");
1975                 return -EFAULT;
1976         }
1977
1978         req->ki_res.obj = (u64)(unsigned long)user_iocb;
1979         req->ki_res.data = iocb->aio_data;
1980         req->ki_res.res = 0;
1981         req->ki_res.res2 = 0;
1982
1983         switch (iocb->aio_lio_opcode) {
1984         case IOCB_CMD_PREAD:
1985                 return aio_read(&req->rw, iocb, false, compat);
1986         case IOCB_CMD_PWRITE:
1987                 return aio_write(&req->rw, iocb, false, compat);
1988         case IOCB_CMD_PREADV:
1989                 return aio_read(&req->rw, iocb, true, compat);
1990         case IOCB_CMD_PWRITEV:
1991                 return aio_write(&req->rw, iocb, true, compat);
1992         case IOCB_CMD_FSYNC:
1993                 return aio_fsync(&req->fsync, iocb, false);
1994         case IOCB_CMD_FDSYNC:
1995                 return aio_fsync(&req->fsync, iocb, true);
1996         case IOCB_CMD_POLL:
1997                 return aio_poll(req, iocb);
1998         default:
1999                 pr_debug("invalid aio operation %d\n", iocb->aio_lio_opcode);
2000                 return -EINVAL;
2001         }
2002 }
2003
2004 static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
2005                          bool compat)
2006 {
2007         struct aio_kiocb *req;
2008         struct iocb iocb;
2009         int err;
2010
2011         if (unlikely(copy_from_user(&iocb, user_iocb, sizeof(iocb))))
2012                 return -EFAULT;
2013
2014         /* enforce forwards compatibility on users */
2015         if (unlikely(iocb.aio_reserved2)) {
2016                 pr_debug("EINVAL: reserve field set\n");
2017                 return -EINVAL;
2018         }
2019
2020         /* prevent overflows */
2021         if (unlikely(
2022             (iocb.aio_buf != (unsigned long)iocb.aio_buf) ||
2023             (iocb.aio_nbytes != (size_t)iocb.aio_nbytes) ||
2024             ((ssize_t)iocb.aio_nbytes < 0)
2025            )) {
2026                 pr_debug("EINVAL: overflow check\n");
2027                 return -EINVAL;
2028         }
2029
2030         req = aio_get_req(ctx);
2031         if (unlikely(!req))
2032                 return -EAGAIN;
2033
2034         err = __io_submit_one(ctx, &iocb, user_iocb, req, compat);
2035
2036         /* Done with the synchronous reference */
2037         iocb_put(req);
2038
2039         /*
2040          * If err is 0, we'd either done aio_complete() ourselves or have
2041          * arranged for that to be done asynchronously.  Anything non-zero
2042          * means that we need to destroy req ourselves.
2043          */
2044         if (unlikely(err)) {
2045                 iocb_destroy(req);
2046                 put_reqs_available(ctx, 1);
2047         }
2048         return err;
2049 }
2050
2051 /* sys_io_submit:
2052  *      Queue the nr iocbs pointed to by iocbpp for processing.  Returns
2053  *      the number of iocbs queued.  May return -EINVAL if the aio_context
2054  *      specified by ctx_id is invalid, if nr is < 0, if the iocb at
2055  *      *iocbpp[0] is not properly initialized, if the operation specified
2056  *      is invalid for the file descriptor in the iocb.  May fail with
2057  *      -EFAULT if any of the data structures point to invalid data.  May
2058  *      fail with -EBADF if the file descriptor specified in the first
2059  *      iocb is invalid.  May fail with -EAGAIN if insufficient resources
2060  *      are available to queue any iocbs.  Will return 0 if nr is 0.  Will
2061  *      fail with -ENOSYS if not implemented.
2062  */
2063 SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
2064                 struct iocb __user * __user *, iocbpp)
2065 {
2066         struct kioctx *ctx;
2067         long ret = 0;
2068         int i = 0;
2069         struct blk_plug plug;
2070
2071         if (unlikely(nr < 0))
2072                 return -EINVAL;
2073
2074         ctx = lookup_ioctx(ctx_id);
2075         if (unlikely(!ctx)) {
2076                 pr_debug("EINVAL: invalid context id\n");
2077                 return -EINVAL;
2078         }
2079
2080         if (nr > ctx->nr_events)
2081                 nr = ctx->nr_events;
2082
2083         if (nr > AIO_PLUG_THRESHOLD)
2084                 blk_start_plug(&plug);
2085         for (i = 0; i < nr; i++) {
2086                 struct iocb __user *user_iocb;
2087
2088                 if (unlikely(get_user(user_iocb, iocbpp + i))) {
2089                         ret = -EFAULT;
2090                         break;
2091                 }
2092
2093                 ret = io_submit_one(ctx, user_iocb, false);
2094                 if (ret)
2095                         break;
2096         }
2097         if (nr > AIO_PLUG_THRESHOLD)
2098                 blk_finish_plug(&plug);
2099
2100         percpu_ref_put(&ctx->users);
2101         return i ? i : ret;
2102 }
2103
2104 #ifdef CONFIG_COMPAT
2105 COMPAT_SYSCALL_DEFINE3(io_submit, compat_aio_context_t, ctx_id,
2106                        int, nr, compat_uptr_t __user *, iocbpp)
2107 {
2108         struct kioctx *ctx;
2109         long ret = 0;
2110         int i = 0;
2111         struct blk_plug plug;
2112
2113         if (unlikely(nr < 0))
2114                 return -EINVAL;
2115
2116         ctx = lookup_ioctx(ctx_id);
2117         if (unlikely(!ctx)) {
2118                 pr_debug("EINVAL: invalid context id\n");
2119                 return -EINVAL;
2120         }
2121
2122         if (nr > ctx->nr_events)
2123                 nr = ctx->nr_events;
2124
2125         if (nr > AIO_PLUG_THRESHOLD)
2126                 blk_start_plug(&plug);
2127         for (i = 0; i < nr; i++) {
2128                 compat_uptr_t user_iocb;
2129
2130                 if (unlikely(get_user(user_iocb, iocbpp + i))) {
2131                         ret = -EFAULT;
2132                         break;
2133                 }
2134
2135                 ret = io_submit_one(ctx, compat_ptr(user_iocb), true);
2136                 if (ret)
2137                         break;
2138         }
2139         if (nr > AIO_PLUG_THRESHOLD)
2140                 blk_finish_plug(&plug);
2141
2142         percpu_ref_put(&ctx->users);
2143         return i ? i : ret;
2144 }
2145 #endif
2146
2147 /* sys_io_cancel:
2148  *      Attempts to cancel an iocb previously passed to io_submit.  If
2149  *      the operation is successfully cancelled, the resulting event is
2150  *      copied into the memory pointed to by result without being placed
2151  *      into the completion queue and 0 is returned.  May fail with
2152  *      -EFAULT if any of the data structures pointed to are invalid.
2153  *      May fail with -EINVAL if aio_context specified by ctx_id is
2154  *      invalid.  May fail with -EAGAIN if the iocb specified was not
2155  *      cancelled.  Will fail with -ENOSYS if not implemented.
2156  */
2157 SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
2158                 struct io_event __user *, result)
2159 {
2160         struct kioctx *ctx;
2161         struct aio_kiocb *kiocb;
2162         int ret = -EINVAL;
2163         u32 key;
2164         u64 obj = (u64)(unsigned long)iocb;
2165
2166         if (unlikely(get_user(key, &iocb->aio_key)))
2167                 return -EFAULT;
2168         if (unlikely(key != KIOCB_KEY))
2169                 return -EINVAL;
2170
2171         ctx = lookup_ioctx(ctx_id);
2172         if (unlikely(!ctx))
2173                 return -EINVAL;
2174
2175         spin_lock_irq(&ctx->ctx_lock);
2176         /* TODO: use a hash or array, this sucks. */
2177         list_for_each_entry(kiocb, &ctx->active_reqs, ki_list) {
2178                 if (kiocb->ki_res.obj == obj) {
2179                         ret = kiocb->ki_cancel(&kiocb->rw);
2180                         list_del_init(&kiocb->ki_list);
2181                         break;
2182                 }
2183         }
2184         spin_unlock_irq(&ctx->ctx_lock);
2185
2186         if (!ret) {
2187                 /*
2188                  * The result argument is no longer used - the io_event is
2189                  * always delivered via the ring buffer. -EINPROGRESS indicates
2190                  * cancellation is progress:
2191                  */
2192                 ret = -EINPROGRESS;
2193         }
2194
2195         percpu_ref_put(&ctx->users);
2196
2197         return ret;
2198 }
2199
2200 static long do_io_getevents(aio_context_t ctx_id,
2201                 long min_nr,
2202                 long nr,
2203                 struct io_event __user *events,
2204                 struct timespec64 *ts)
2205 {
2206         ktime_t until = ts ? timespec64_to_ktime(*ts) : KTIME_MAX;
2207         struct kioctx *ioctx = lookup_ioctx(ctx_id);
2208         long ret = -EINVAL;
2209
2210         if (likely(ioctx)) {
2211                 if (likely(min_nr <= nr && min_nr >= 0))
2212                         ret = read_events(ioctx, min_nr, nr, events, until);
2213                 percpu_ref_put(&ioctx->users);
2214         }
2215
2216         return ret;
2217 }
2218
2219 /* io_getevents:
2220  *      Attempts to read at least min_nr events and up to nr events from
2221  *      the completion queue for the aio_context specified by ctx_id. If
2222  *      it succeeds, the number of read events is returned. May fail with
2223  *      -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
2224  *      out of range, if timeout is out of range.  May fail with -EFAULT
2225  *      if any of the memory specified is invalid.  May return 0 or
2226  *      < min_nr if the timeout specified by timeout has elapsed
2227  *      before sufficient events are available, where timeout == NULL
2228  *      specifies an infinite timeout. Note that the timeout pointed to by
2229  *      timeout is relative.  Will fail with -ENOSYS if not implemented.
2230  */
2231 #ifdef CONFIG_64BIT
2232
2233 SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
2234                 long, min_nr,
2235                 long, nr,
2236                 struct io_event __user *, events,
2237                 struct __kernel_timespec __user *, timeout)
2238 {
2239         struct timespec64       ts;
2240         int                     ret;
2241
2242         if (timeout && unlikely(get_timespec64(&ts, timeout)))
2243                 return -EFAULT;
2244
2245         ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &ts : NULL);
2246         if (!ret && signal_pending(current))
2247                 ret = -EINTR;
2248         return ret;
2249 }
2250
2251 #endif
2252
2253 struct __aio_sigset {
2254         const sigset_t __user   *sigmask;
2255         size_t          sigsetsize;
2256 };
2257
2258 SYSCALL_DEFINE6(io_pgetevents,
2259                 aio_context_t, ctx_id,
2260                 long, min_nr,
2261                 long, nr,
2262                 struct io_event __user *, events,
2263                 struct __kernel_timespec __user *, timeout,
2264                 const struct __aio_sigset __user *, usig)
2265 {
2266         struct __aio_sigset     ksig = { NULL, };
2267         struct timespec64       ts;
2268         bool interrupted;
2269         int ret;
2270
2271         if (timeout && unlikely(get_timespec64(&ts, timeout)))
2272                 return -EFAULT;
2273
2274         if (usig && copy_from_user(&ksig, usig, sizeof(ksig)))
2275                 return -EFAULT;
2276
2277         ret = set_user_sigmask(ksig.sigmask, ksig.sigsetsize);
2278         if (ret)
2279                 return ret;
2280
2281         ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &ts : NULL);
2282
2283         interrupted = signal_pending(current);
2284         restore_saved_sigmask_unless(interrupted);
2285         if (interrupted && !ret)
2286                 ret = -ERESTARTNOHAND;
2287
2288         return ret;
2289 }
2290
2291 #if defined(CONFIG_COMPAT_32BIT_TIME) && !defined(CONFIG_64BIT)
2292
2293 SYSCALL_DEFINE6(io_pgetevents_time32,
2294                 aio_context_t, ctx_id,
2295                 long, min_nr,
2296                 long, nr,
2297                 struct io_event __user *, events,
2298                 struct old_timespec32 __user *, timeout,
2299                 const struct __aio_sigset __user *, usig)
2300 {
2301         struct __aio_sigset     ksig = { NULL, };
2302         struct timespec64       ts;
2303         bool interrupted;
2304         int ret;
2305
2306         if (timeout && unlikely(get_old_timespec32(&ts, timeout)))
2307                 return -EFAULT;
2308
2309         if (usig && copy_from_user(&ksig, usig, sizeof(ksig)))
2310                 return -EFAULT;
2311
2312
2313         ret = set_user_sigmask(ksig.sigmask, ksig.sigsetsize);
2314         if (ret)
2315                 return ret;
2316
2317         ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &ts : NULL);
2318
2319         interrupted = signal_pending(current);
2320         restore_saved_sigmask_unless(interrupted);
2321         if (interrupted && !ret)
2322                 ret = -ERESTARTNOHAND;
2323
2324         return ret;
2325 }
2326
2327 #endif
2328
2329 #if defined(CONFIG_COMPAT_32BIT_TIME)
2330
2331 SYSCALL_DEFINE5(io_getevents_time32, __u32, ctx_id,
2332                 __s32, min_nr,
2333                 __s32, nr,
2334                 struct io_event __user *, events,
2335                 struct old_timespec32 __user *, timeout)
2336 {
2337         struct timespec64 t;
2338         int ret;
2339
2340         if (timeout && get_old_timespec32(&t, timeout))
2341                 return -EFAULT;
2342
2343         ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &t : NULL);
2344         if (!ret && signal_pending(current))
2345                 ret = -EINTR;
2346         return ret;
2347 }
2348
2349 #endif
2350
2351 #ifdef CONFIG_COMPAT
2352
2353 struct __compat_aio_sigset {
2354         compat_uptr_t           sigmask;
2355         compat_size_t           sigsetsize;
2356 };
2357
2358 #if defined(CONFIG_COMPAT_32BIT_TIME)
2359
2360 COMPAT_SYSCALL_DEFINE6(io_pgetevents,
2361                 compat_aio_context_t, ctx_id,
2362                 compat_long_t, min_nr,
2363                 compat_long_t, nr,
2364                 struct io_event __user *, events,
2365                 struct old_timespec32 __user *, timeout,
2366                 const struct __compat_aio_sigset __user *, usig)
2367 {
2368         struct __compat_aio_sigset ksig = { 0, };
2369         struct timespec64 t;
2370         bool interrupted;
2371         int ret;
2372
2373         if (timeout && get_old_timespec32(&t, timeout))
2374                 return -EFAULT;
2375
2376         if (usig && copy_from_user(&ksig, usig, sizeof(ksig)))
2377                 return -EFAULT;
2378
2379         ret = set_compat_user_sigmask(compat_ptr(ksig.sigmask), ksig.sigsetsize);
2380         if (ret)
2381                 return ret;
2382
2383         ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &t : NULL);
2384
2385         interrupted = signal_pending(current);
2386         restore_saved_sigmask_unless(interrupted);
2387         if (interrupted && !ret)
2388                 ret = -ERESTARTNOHAND;
2389
2390         return ret;
2391 }
2392
2393 #endif
2394
2395 COMPAT_SYSCALL_DEFINE6(io_pgetevents_time64,
2396                 compat_aio_context_t, ctx_id,
2397                 compat_long_t, min_nr,
2398                 compat_long_t, nr,
2399                 struct io_event __user *, events,
2400                 struct __kernel_timespec __user *, timeout,
2401                 const struct __compat_aio_sigset __user *, usig)
2402 {
2403         struct __compat_aio_sigset ksig = { 0, };
2404         struct timespec64 t;
2405         bool interrupted;
2406         int ret;
2407
2408         if (timeout && get_timespec64(&t, timeout))
2409                 return -EFAULT;
2410
2411         if (usig && copy_from_user(&ksig, usig, sizeof(ksig)))
2412                 return -EFAULT;
2413
2414         ret = set_compat_user_sigmask(compat_ptr(ksig.sigmask), ksig.sigsetsize);
2415         if (ret)
2416                 return ret;
2417
2418         ret = do_io_getevents(ctx_id, min_nr, nr, events, timeout ? &t : NULL);
2419
2420         interrupted = signal_pending(current);
2421         restore_saved_sigmask_unless(interrupted);
2422         if (interrupted && !ret)
2423                 ret = -ERESTARTNOHAND;
2424
2425         return ret;
2426 }
2427 #endif