2 * An async IO implementation for Linux
3 * Written by Benjamin LaHaise <bcrl@kvack.org>
5 * Implements an efficient asynchronous io interface.
7 * Copyright 2000, 2001, 2002 Red Hat, Inc. All Rights Reserved.
9 * See ../COPYING for licensing terms.
11 #define pr_fmt(fmt) "%s: " fmt, __func__
13 #include <linux/kernel.h>
14 #include <linux/init.h>
15 #include <linux/errno.h>
16 #include <linux/time.h>
17 #include <linux/aio_abi.h>
18 #include <linux/export.h>
19 #include <linux/syscalls.h>
20 #include <linux/backing-dev.h>
21 #include <linux/uio.h>
23 #include <linux/sched.h>
25 #include <linux/file.h>
27 #include <linux/mman.h>
28 #include <linux/mmu_context.h>
29 #include <linux/percpu.h>
30 #include <linux/slab.h>
31 #include <linux/timer.h>
32 #include <linux/aio.h>
33 #include <linux/highmem.h>
34 #include <linux/workqueue.h>
35 #include <linux/security.h>
36 #include <linux/eventfd.h>
37 #include <linux/blkdev.h>
38 #include <linux/compat.h>
39 #include <linux/migrate.h>
40 #include <linux/ramfs.h>
41 #include <linux/percpu-refcount.h>
42 #include <linux/mount.h>
43 #include <linux/work-simple.h>
45 #include <asm/kmap_types.h>
46 #include <asm/uaccess.h>
50 #define AIO_RING_MAGIC 0xa10a10a1
51 #define AIO_RING_COMPAT_FEATURES 1
52 #define AIO_RING_INCOMPAT_FEATURES 0
54 unsigned id; /* kernel internal index number */
55 unsigned nr; /* number of io_events */
56 unsigned head; /* Written to by userland or under ring_lock
57 * mutex by aio_read_events_ring(). */
61 unsigned compat_features;
62 unsigned incompat_features;
63 unsigned header_length; /* size of aio_ring */
66 struct io_event io_events[0];
67 }; /* 128 bytes + ring size */
69 #define AIO_RING_PAGES 8
74 struct kioctx *table[];
78 unsigned reqs_available;
82 struct completion comp;
87 struct percpu_ref users;
90 struct percpu_ref reqs;
92 unsigned long user_id;
94 struct __percpu kioctx_cpu *cpu;
97 * For percpu reqs_available, number of slots we move to/from global
102 * This is what userspace passed to io_setup(), it's not used for
103 * anything but counting against the global max_reqs quota.
105 * The real limit is nr_events - 1, which will be larger (see
110 /* Size of ringbuffer, in units of struct io_event */
113 unsigned long mmap_base;
114 unsigned long mmap_size;
116 struct page **ring_pages;
119 struct swork_event free_work;
122 * signals when all in-flight requests are done
124 struct ctx_rq_wait *rq_wait;
128 * This counts the number of available slots in the ringbuffer,
129 * so we avoid overflowing it: it's decremented (if positive)
130 * when allocating a kiocb and incremented when the resulting
131 * io_event is pulled off the ringbuffer.
133 * We batch accesses to it with a percpu version.
135 atomic_t reqs_available;
136 } ____cacheline_aligned_in_smp;
140 struct list_head active_reqs; /* used for cancellation */
141 } ____cacheline_aligned_in_smp;
144 struct mutex ring_lock;
145 wait_queue_head_t wait;
146 } ____cacheline_aligned_in_smp;
150 unsigned completed_events;
151 spinlock_t completion_lock;
152 } ____cacheline_aligned_in_smp;
154 struct page *internal_pages[AIO_RING_PAGES];
155 struct file *aio_ring_file;
161 * We use ki_cancel == KIOCB_CANCELLED to indicate that a kiocb has been either
162 * cancelled or completed (this makes a certain amount of sense because
163 * successful cancellation - io_cancel() - does deliver the completion to
166 * And since most things don't implement kiocb cancellation and we'd really like
167 * kiocb completion to be lockless when possible, we use ki_cancel to
168 * synchronize cancellation and completion - we only set it to KIOCB_CANCELLED
169 * with xchg() or cmpxchg(), see batch_complete_aio() and kiocb_cancel().
171 #define KIOCB_CANCELLED ((void *) (~0ULL))
176 struct kioctx *ki_ctx;
177 kiocb_cancel_fn *ki_cancel;
179 struct iocb __user *ki_user_iocb; /* user's aiocb */
180 __u64 ki_user_data; /* user's data for completion */
182 struct list_head ki_list; /* the aio core uses this
183 * for cancellation */
186 * If the aio_resfd field of the userspace iocb is not zero,
187 * this is the underlying eventfd context to deliver events to.
189 struct eventfd_ctx *ki_eventfd;
192 /*------ sysctl variables----*/
193 static DEFINE_SPINLOCK(aio_nr_lock);
194 unsigned long aio_nr; /* current system wide number of aio requests */
195 unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
196 /*----end sysctl variables---*/
198 static struct kmem_cache *kiocb_cachep;
199 static struct kmem_cache *kioctx_cachep;
201 static struct vfsmount *aio_mnt;
203 static const struct file_operations aio_ring_fops;
204 static const struct address_space_operations aio_ctx_aops;
206 static struct file *aio_private_file(struct kioctx *ctx, loff_t nr_pages)
208 struct qstr this = QSTR_INIT("[aio]", 5);
211 struct inode *inode = alloc_anon_inode(aio_mnt->mnt_sb);
213 return ERR_CAST(inode);
215 inode->i_mapping->a_ops = &aio_ctx_aops;
216 inode->i_mapping->private_data = ctx;
217 inode->i_size = PAGE_SIZE * nr_pages;
219 path.dentry = d_alloc_pseudo(aio_mnt->mnt_sb, &this);
222 return ERR_PTR(-ENOMEM);
224 path.mnt = mntget(aio_mnt);
226 d_instantiate(path.dentry, inode);
227 file = alloc_file(&path, FMODE_READ | FMODE_WRITE, &aio_ring_fops);
233 file->f_flags = O_RDWR;
237 static struct dentry *aio_mount(struct file_system_type *fs_type,
238 int flags, const char *dev_name, void *data)
240 static const struct dentry_operations ops = {
241 .d_dname = simple_dname,
243 return mount_pseudo(fs_type, "aio:", NULL, &ops, AIO_RING_MAGIC);
247 * Creates the slab caches used by the aio routines, panic on
248 * failure as this is done early during the boot sequence.
250 static int __init aio_setup(void)
252 static struct file_system_type aio_fs = {
255 .kill_sb = kill_anon_super,
258 aio_mnt = kern_mount(&aio_fs);
260 panic("Failed to create aio fs mount.");
262 kiocb_cachep = KMEM_CACHE(aio_kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
263 kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
265 pr_debug("sizeof(struct page) = %zu\n", sizeof(struct page));
269 __initcall(aio_setup);
271 static void put_aio_ring_file(struct kioctx *ctx)
273 struct file *aio_ring_file = ctx->aio_ring_file;
275 truncate_setsize(aio_ring_file->f_inode, 0);
277 /* Prevent further access to the kioctx from migratepages */
278 spin_lock(&aio_ring_file->f_inode->i_mapping->private_lock);
279 aio_ring_file->f_inode->i_mapping->private_data = NULL;
280 ctx->aio_ring_file = NULL;
281 spin_unlock(&aio_ring_file->f_inode->i_mapping->private_lock);
287 static void aio_free_ring(struct kioctx *ctx)
291 /* Disconnect the kiotx from the ring file. This prevents future
292 * accesses to the kioctx from page migration.
294 put_aio_ring_file(ctx);
296 for (i = 0; i < ctx->nr_pages; i++) {
298 pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
299 page_count(ctx->ring_pages[i]));
300 page = ctx->ring_pages[i];
303 ctx->ring_pages[i] = NULL;
307 if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
308 kfree(ctx->ring_pages);
309 ctx->ring_pages = NULL;
313 static int aio_ring_mmap(struct file *file, struct vm_area_struct *vma)
315 vma->vm_flags |= VM_DONTEXPAND;
316 vma->vm_ops = &generic_file_vm_ops;
320 static int aio_ring_remap(struct file *file, struct vm_area_struct *vma)
322 struct mm_struct *mm = vma->vm_mm;
323 struct kioctx_table *table;
324 int i, res = -EINVAL;
326 spin_lock(&mm->ioctx_lock);
328 table = rcu_dereference(mm->ioctx_table);
329 for (i = 0; i < table->nr; i++) {
332 ctx = table->table[i];
333 if (ctx && ctx->aio_ring_file == file) {
334 if (!atomic_read(&ctx->dead)) {
335 ctx->user_id = ctx->mmap_base = vma->vm_start;
343 spin_unlock(&mm->ioctx_lock);
347 static const struct file_operations aio_ring_fops = {
348 .mmap = aio_ring_mmap,
349 .mremap = aio_ring_remap,
352 #if IS_ENABLED(CONFIG_MIGRATION)
353 static int aio_migratepage(struct address_space *mapping, struct page *new,
354 struct page *old, enum migrate_mode mode)
363 /* mapping->private_lock here protects against the kioctx teardown. */
364 spin_lock(&mapping->private_lock);
365 ctx = mapping->private_data;
371 /* The ring_lock mutex. The prevents aio_read_events() from writing
372 * to the ring's head, and prevents page migration from mucking in
373 * a partially initialized kiotx.
375 if (!mutex_trylock(&ctx->ring_lock)) {
381 if (idx < (pgoff_t)ctx->nr_pages) {
382 /* Make sure the old page hasn't already been changed */
383 if (ctx->ring_pages[idx] != old)
391 /* Writeback must be complete */
392 BUG_ON(PageWriteback(old));
395 rc = migrate_page_move_mapping(mapping, new, old, NULL, mode, 1);
396 if (rc != MIGRATEPAGE_SUCCESS) {
401 /* Take completion_lock to prevent other writes to the ring buffer
402 * while the old page is copied to the new. This prevents new
403 * events from being lost.
405 spin_lock_irqsave(&ctx->completion_lock, flags);
406 migrate_page_copy(new, old);
407 BUG_ON(ctx->ring_pages[idx] != old);
408 ctx->ring_pages[idx] = new;
409 spin_unlock_irqrestore(&ctx->completion_lock, flags);
411 /* The old page is no longer accessible. */
415 mutex_unlock(&ctx->ring_lock);
417 spin_unlock(&mapping->private_lock);
422 static const struct address_space_operations aio_ctx_aops = {
423 .set_page_dirty = __set_page_dirty_no_writeback,
424 #if IS_ENABLED(CONFIG_MIGRATION)
425 .migratepage = aio_migratepage,
429 static int aio_setup_ring(struct kioctx *ctx)
431 struct aio_ring *ring;
432 unsigned nr_events = ctx->max_reqs;
433 struct mm_struct *mm = current->mm;
434 unsigned long size, unused;
439 /* Compensate for the ring buffer's head/tail overlap entry */
440 nr_events += 2; /* 1 is required, 2 for good luck */
442 size = sizeof(struct aio_ring);
443 size += sizeof(struct io_event) * nr_events;
445 nr_pages = PFN_UP(size);
449 file = aio_private_file(ctx, nr_pages);
451 ctx->aio_ring_file = NULL;
455 ctx->aio_ring_file = file;
456 nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring))
457 / sizeof(struct io_event);
459 ctx->ring_pages = ctx->internal_pages;
460 if (nr_pages > AIO_RING_PAGES) {
461 ctx->ring_pages = kcalloc(nr_pages, sizeof(struct page *),
463 if (!ctx->ring_pages) {
464 put_aio_ring_file(ctx);
469 for (i = 0; i < nr_pages; i++) {
471 page = find_or_create_page(file->f_inode->i_mapping,
472 i, GFP_HIGHUSER | __GFP_ZERO);
475 pr_debug("pid(%d) page[%d]->count=%d\n",
476 current->pid, i, page_count(page));
477 SetPageUptodate(page);
480 ctx->ring_pages[i] = page;
484 if (unlikely(i != nr_pages)) {
489 ctx->mmap_size = nr_pages * PAGE_SIZE;
490 pr_debug("attempting mmap of %lu bytes\n", ctx->mmap_size);
492 down_write(&mm->mmap_sem);
493 ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
494 PROT_READ | PROT_WRITE,
495 MAP_SHARED, 0, &unused);
496 up_write(&mm->mmap_sem);
497 if (IS_ERR((void *)ctx->mmap_base)) {
503 pr_debug("mmap address: 0x%08lx\n", ctx->mmap_base);
505 ctx->user_id = ctx->mmap_base;
506 ctx->nr_events = nr_events; /* trusted copy */
508 ring = kmap_atomic(ctx->ring_pages[0]);
509 ring->nr = nr_events; /* user copy */
511 ring->head = ring->tail = 0;
512 ring->magic = AIO_RING_MAGIC;
513 ring->compat_features = AIO_RING_COMPAT_FEATURES;
514 ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
515 ring->header_length = sizeof(struct aio_ring);
517 flush_dcache_page(ctx->ring_pages[0]);
522 #define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
523 #define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
524 #define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
526 void kiocb_set_cancel_fn(struct kiocb *iocb, kiocb_cancel_fn *cancel)
528 struct aio_kiocb *req = container_of(iocb, struct aio_kiocb, common);
529 struct kioctx *ctx = req->ki_ctx;
532 spin_lock_irqsave(&ctx->ctx_lock, flags);
534 if (!req->ki_list.next)
535 list_add(&req->ki_list, &ctx->active_reqs);
537 req->ki_cancel = cancel;
539 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
541 EXPORT_SYMBOL(kiocb_set_cancel_fn);
543 static int kiocb_cancel(struct aio_kiocb *kiocb)
545 kiocb_cancel_fn *old, *cancel;
548 * Don't want to set kiocb->ki_cancel = KIOCB_CANCELLED unless it
549 * actually has a cancel function, hence the cmpxchg()
552 cancel = ACCESS_ONCE(kiocb->ki_cancel);
554 if (!cancel || cancel == KIOCB_CANCELLED)
558 cancel = cmpxchg(&kiocb->ki_cancel, old, KIOCB_CANCELLED);
559 } while (cancel != old);
561 return cancel(&kiocb->common);
564 static void free_ioctx(struct swork_event *sev)
566 struct kioctx *ctx = container_of(sev, struct kioctx, free_work);
568 pr_debug("freeing %p\n", ctx);
571 free_percpu(ctx->cpu);
572 percpu_ref_exit(&ctx->reqs);
573 percpu_ref_exit(&ctx->users);
574 kmem_cache_free(kioctx_cachep, ctx);
577 static void free_ioctx_reqs(struct percpu_ref *ref)
579 struct kioctx *ctx = container_of(ref, struct kioctx, reqs);
581 /* At this point we know that there are no any in-flight requests */
582 if (ctx->rq_wait && atomic_dec_and_test(&ctx->rq_wait->count))
583 complete(&ctx->rq_wait->comp);
585 INIT_SWORK(&ctx->free_work, free_ioctx);
586 swork_queue(&ctx->free_work);
590 * When this function runs, the kioctx has been removed from the "hash table"
591 * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
592 * now it's safe to cancel any that need to be.
594 static void free_ioctx_users_work(struct swork_event *sev)
596 struct kioctx *ctx = container_of(sev, struct kioctx, free_work);
597 struct aio_kiocb *req;
599 spin_lock_irq(&ctx->ctx_lock);
601 while (!list_empty(&ctx->active_reqs)) {
602 req = list_first_entry(&ctx->active_reqs,
603 struct aio_kiocb, ki_list);
605 list_del_init(&req->ki_list);
609 spin_unlock_irq(&ctx->ctx_lock);
611 percpu_ref_kill(&ctx->reqs);
612 percpu_ref_put(&ctx->reqs);
615 static void free_ioctx_users(struct percpu_ref *ref)
617 struct kioctx *ctx = container_of(ref, struct kioctx, users);
619 INIT_SWORK(&ctx->free_work, free_ioctx_users_work);
620 swork_queue(&ctx->free_work);
623 static int ioctx_add_table(struct kioctx *ctx, struct mm_struct *mm)
626 struct kioctx_table *table, *old;
627 struct aio_ring *ring;
629 spin_lock(&mm->ioctx_lock);
630 table = rcu_dereference_raw(mm->ioctx_table);
634 for (i = 0; i < table->nr; i++)
635 if (!table->table[i]) {
637 table->table[i] = ctx;
638 spin_unlock(&mm->ioctx_lock);
640 /* While kioctx setup is in progress,
641 * we are protected from page migration
642 * changes ring_pages by ->ring_lock.
644 ring = kmap_atomic(ctx->ring_pages[0]);
650 new_nr = (table ? table->nr : 1) * 4;
651 spin_unlock(&mm->ioctx_lock);
653 table = kzalloc(sizeof(*table) + sizeof(struct kioctx *) *
660 spin_lock(&mm->ioctx_lock);
661 old = rcu_dereference_raw(mm->ioctx_table);
664 rcu_assign_pointer(mm->ioctx_table, table);
665 } else if (table->nr > old->nr) {
666 memcpy(table->table, old->table,
667 old->nr * sizeof(struct kioctx *));
669 rcu_assign_pointer(mm->ioctx_table, table);
678 static void aio_nr_sub(unsigned nr)
680 spin_lock(&aio_nr_lock);
681 if (WARN_ON(aio_nr - nr > aio_nr))
685 spin_unlock(&aio_nr_lock);
689 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
691 static struct kioctx *ioctx_alloc(unsigned nr_events)
693 struct mm_struct *mm = current->mm;
698 * We keep track of the number of available ringbuffer slots, to prevent
699 * overflow (reqs_available), and we also use percpu counters for this.
701 * So since up to half the slots might be on other cpu's percpu counters
702 * and unavailable, double nr_events so userspace sees what they
703 * expected: additionally, we move req_batch slots to/from percpu
704 * counters at a time, so make sure that isn't 0:
706 nr_events = max(nr_events, num_possible_cpus() * 4);
709 /* Prevent overflows */
710 if (nr_events > (0x10000000U / sizeof(struct io_event))) {
711 pr_debug("ENOMEM: nr_events too high\n");
712 return ERR_PTR(-EINVAL);
715 if (!nr_events || (unsigned long)nr_events > (aio_max_nr * 2UL))
716 return ERR_PTR(-EAGAIN);
718 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
720 return ERR_PTR(-ENOMEM);
722 ctx->max_reqs = nr_events;
724 spin_lock_init(&ctx->ctx_lock);
725 spin_lock_init(&ctx->completion_lock);
726 mutex_init(&ctx->ring_lock);
727 /* Protect against page migration throughout kiotx setup by keeping
728 * the ring_lock mutex held until setup is complete. */
729 mutex_lock(&ctx->ring_lock);
730 init_waitqueue_head(&ctx->wait);
732 INIT_LIST_HEAD(&ctx->active_reqs);
734 if (percpu_ref_init(&ctx->users, free_ioctx_users, 0, GFP_KERNEL))
737 if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs, 0, GFP_KERNEL))
740 ctx->cpu = alloc_percpu(struct kioctx_cpu);
744 err = aio_setup_ring(ctx);
748 atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
749 ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
750 if (ctx->req_batch < 1)
753 /* limit the number of system wide aios */
754 spin_lock(&aio_nr_lock);
755 if (aio_nr + nr_events > (aio_max_nr * 2UL) ||
756 aio_nr + nr_events < aio_nr) {
757 spin_unlock(&aio_nr_lock);
761 aio_nr += ctx->max_reqs;
762 spin_unlock(&aio_nr_lock);
764 percpu_ref_get(&ctx->users); /* io_setup() will drop this ref */
765 percpu_ref_get(&ctx->reqs); /* free_ioctx_users() will drop this */
767 err = ioctx_add_table(ctx, mm);
771 /* Release the ring_lock mutex now that all setup is complete. */
772 mutex_unlock(&ctx->ring_lock);
774 pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
775 ctx, ctx->user_id, mm, ctx->nr_events);
779 aio_nr_sub(ctx->max_reqs);
781 atomic_set(&ctx->dead, 1);
783 vm_munmap(ctx->mmap_base, ctx->mmap_size);
786 mutex_unlock(&ctx->ring_lock);
787 free_percpu(ctx->cpu);
788 percpu_ref_exit(&ctx->reqs);
789 percpu_ref_exit(&ctx->users);
790 kmem_cache_free(kioctx_cachep, ctx);
791 pr_debug("error allocating ioctx %d\n", err);
796 * Cancels all outstanding aio requests on an aio context. Used
797 * when the processes owning a context have all exited to encourage
798 * the rapid destruction of the kioctx.
800 static int kill_ioctx(struct mm_struct *mm, struct kioctx *ctx,
801 struct ctx_rq_wait *wait)
803 struct kioctx_table *table;
805 spin_lock(&mm->ioctx_lock);
806 if (atomic_xchg(&ctx->dead, 1)) {
807 spin_unlock(&mm->ioctx_lock);
811 table = rcu_dereference_raw(mm->ioctx_table);
812 WARN_ON(ctx != table->table[ctx->id]);
813 table->table[ctx->id] = NULL;
814 spin_unlock(&mm->ioctx_lock);
816 /* percpu_ref_kill() will do the necessary call_rcu() */
817 wake_up_all(&ctx->wait);
820 * It'd be more correct to do this in free_ioctx(), after all
821 * the outstanding kiocbs have finished - but by then io_destroy
822 * has already returned, so io_setup() could potentially return
823 * -EAGAIN with no ioctxs actually in use (as far as userspace
826 aio_nr_sub(ctx->max_reqs);
829 vm_munmap(ctx->mmap_base, ctx->mmap_size);
832 percpu_ref_kill(&ctx->users);
837 * exit_aio: called when the last user of mm goes away. At this point, there is
838 * no way for any new requests to be submited or any of the io_* syscalls to be
839 * called on the context.
841 * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
844 void exit_aio(struct mm_struct *mm)
846 struct kioctx_table *table = rcu_dereference_raw(mm->ioctx_table);
847 struct ctx_rq_wait wait;
853 atomic_set(&wait.count, table->nr);
854 init_completion(&wait.comp);
857 for (i = 0; i < table->nr; ++i) {
858 struct kioctx *ctx = table->table[i];
866 * We don't need to bother with munmap() here - exit_mmap(mm)
867 * is coming and it'll unmap everything. And we simply can't,
868 * this is not necessarily our ->mm.
869 * Since kill_ioctx() uses non-zero ->mmap_size as indicator
870 * that it needs to unmap the area, just set it to 0.
873 kill_ioctx(mm, ctx, &wait);
876 if (!atomic_sub_and_test(skipped, &wait.count)) {
877 /* Wait until all IO for the context are done. */
878 wait_for_completion(&wait.comp);
881 RCU_INIT_POINTER(mm->ioctx_table, NULL);
885 static void put_reqs_available(struct kioctx *ctx, unsigned nr)
887 struct kioctx_cpu *kcpu;
890 local_irq_save(flags);
891 kcpu = this_cpu_ptr(ctx->cpu);
892 kcpu->reqs_available += nr;
894 while (kcpu->reqs_available >= ctx->req_batch * 2) {
895 kcpu->reqs_available -= ctx->req_batch;
896 atomic_add(ctx->req_batch, &ctx->reqs_available);
899 local_irq_restore(flags);
902 static bool get_reqs_available(struct kioctx *ctx)
904 struct kioctx_cpu *kcpu;
908 local_irq_save(flags);
909 kcpu = this_cpu_ptr(ctx->cpu);
910 if (!kcpu->reqs_available) {
911 int old, avail = atomic_read(&ctx->reqs_available);
914 if (avail < ctx->req_batch)
918 avail = atomic_cmpxchg(&ctx->reqs_available,
919 avail, avail - ctx->req_batch);
920 } while (avail != old);
922 kcpu->reqs_available += ctx->req_batch;
926 kcpu->reqs_available--;
928 local_irq_restore(flags);
932 /* refill_reqs_available
933 * Updates the reqs_available reference counts used for tracking the
934 * number of free slots in the completion ring. This can be called
935 * from aio_complete() (to optimistically update reqs_available) or
936 * from aio_get_req() (the we're out of events case). It must be
937 * called holding ctx->completion_lock.
939 static void refill_reqs_available(struct kioctx *ctx, unsigned head,
942 unsigned events_in_ring, completed;
944 /* Clamp head since userland can write to it. */
945 head %= ctx->nr_events;
947 events_in_ring = tail - head;
949 events_in_ring = ctx->nr_events - (head - tail);
951 completed = ctx->completed_events;
952 if (events_in_ring < completed)
953 completed -= events_in_ring;
960 ctx->completed_events -= completed;
961 put_reqs_available(ctx, completed);
964 /* user_refill_reqs_available
965 * Called to refill reqs_available when aio_get_req() encounters an
966 * out of space in the completion ring.
968 static void user_refill_reqs_available(struct kioctx *ctx)
970 spin_lock_irq(&ctx->completion_lock);
971 if (ctx->completed_events) {
972 struct aio_ring *ring;
975 /* Access of ring->head may race with aio_read_events_ring()
976 * here, but that's okay since whether we read the old version
977 * or the new version, and either will be valid. The important
978 * part is that head cannot pass tail since we prevent
979 * aio_complete() from updating tail by holding
980 * ctx->completion_lock. Even if head is invalid, the check
981 * against ctx->completed_events below will make sure we do the
984 ring = kmap_atomic(ctx->ring_pages[0]);
988 refill_reqs_available(ctx, head, ctx->tail);
991 spin_unlock_irq(&ctx->completion_lock);
995 * Allocate a slot for an aio request.
996 * Returns NULL if no requests are free.
998 static inline struct aio_kiocb *aio_get_req(struct kioctx *ctx)
1000 struct aio_kiocb *req;
1002 if (!get_reqs_available(ctx)) {
1003 user_refill_reqs_available(ctx);
1004 if (!get_reqs_available(ctx))
1008 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
1012 percpu_ref_get(&ctx->reqs);
1017 put_reqs_available(ctx, 1);
1021 static void kiocb_free(struct aio_kiocb *req)
1023 if (req->common.ki_filp)
1024 fput(req->common.ki_filp);
1025 if (req->ki_eventfd != NULL)
1026 eventfd_ctx_put(req->ki_eventfd);
1027 kmem_cache_free(kiocb_cachep, req);
1030 static struct kioctx *lookup_ioctx(unsigned long ctx_id)
1032 struct aio_ring __user *ring = (void __user *)ctx_id;
1033 struct mm_struct *mm = current->mm;
1034 struct kioctx *ctx, *ret = NULL;
1035 struct kioctx_table *table;
1038 if (get_user(id, &ring->id))
1042 table = rcu_dereference(mm->ioctx_table);
1044 if (!table || id >= table->nr)
1047 ctx = table->table[id];
1048 if (ctx && ctx->user_id == ctx_id) {
1049 percpu_ref_get(&ctx->users);
1058 * Called when the io request on the given iocb is complete.
1060 static void aio_complete(struct kiocb *kiocb, long res, long res2)
1062 struct aio_kiocb *iocb = container_of(kiocb, struct aio_kiocb, common);
1063 struct kioctx *ctx = iocb->ki_ctx;
1064 struct aio_ring *ring;
1065 struct io_event *ev_page, *event;
1066 unsigned tail, pos, head;
1067 unsigned long flags;
1070 * Special case handling for sync iocbs:
1071 * - events go directly into the iocb for fast handling
1072 * - the sync task with the iocb in its stack holds the single iocb
1073 * ref, no other paths have a way to get another ref
1074 * - the sync task helpfully left a reference to itself in the iocb
1076 BUG_ON(is_sync_kiocb(kiocb));
1078 if (iocb->ki_list.next) {
1079 unsigned long flags;
1081 spin_lock_irqsave(&ctx->ctx_lock, flags);
1082 list_del(&iocb->ki_list);
1083 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
1087 * Add a completion event to the ring buffer. Must be done holding
1088 * ctx->completion_lock to prevent other code from messing with the tail
1089 * pointer since we might be called from irq context.
1091 spin_lock_irqsave(&ctx->completion_lock, flags);
1094 pos = tail + AIO_EVENTS_OFFSET;
1096 if (++tail >= ctx->nr_events)
1099 ev_page = kmap_atomic(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
1100 event = ev_page + pos % AIO_EVENTS_PER_PAGE;
1102 event->obj = (u64)(unsigned long)iocb->ki_user_iocb;
1103 event->data = iocb->ki_user_data;
1107 kunmap_atomic(ev_page);
1108 flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
1110 pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
1111 ctx, tail, iocb, iocb->ki_user_iocb, iocb->ki_user_data,
1114 /* after flagging the request as done, we
1115 * must never even look at it again
1117 smp_wmb(); /* make event visible before updating tail */
1121 ring = kmap_atomic(ctx->ring_pages[0]);
1124 kunmap_atomic(ring);
1125 flush_dcache_page(ctx->ring_pages[0]);
1127 ctx->completed_events++;
1128 if (ctx->completed_events > 1)
1129 refill_reqs_available(ctx, head, tail);
1130 spin_unlock_irqrestore(&ctx->completion_lock, flags);
1132 pr_debug("added to ring %p at [%u]\n", iocb, tail);
1135 * Check if the user asked us to deliver the result through an
1136 * eventfd. The eventfd_signal() function is safe to be called
1139 if (iocb->ki_eventfd != NULL)
1140 eventfd_signal(iocb->ki_eventfd, 1);
1142 /* everything turned out well, dispose of the aiocb. */
1146 * We have to order our ring_info tail store above and test
1147 * of the wait list below outside the wait lock. This is
1148 * like in wake_up_bit() where clearing a bit has to be
1149 * ordered with the unlocked test.
1153 if (waitqueue_active(&ctx->wait))
1154 wake_up(&ctx->wait);
1156 percpu_ref_put(&ctx->reqs);
1159 /* aio_read_events_ring
1160 * Pull an event off of the ioctx's event ring. Returns the number of
1163 static long aio_read_events_ring(struct kioctx *ctx,
1164 struct io_event __user *event, long nr)
1166 struct aio_ring *ring;
1167 unsigned head, tail, pos;
1172 * The mutex can block and wake us up and that will cause
1173 * wait_event_interruptible_hrtimeout() to schedule without sleeping
1174 * and repeat. This should be rare enough that it doesn't cause
1175 * peformance issues. See the comment in read_events() for more detail.
1177 sched_annotate_sleep();
1178 mutex_lock(&ctx->ring_lock);
1180 /* Access to ->ring_pages here is protected by ctx->ring_lock. */
1181 ring = kmap_atomic(ctx->ring_pages[0]);
1184 kunmap_atomic(ring);
1187 * Ensure that once we've read the current tail pointer, that
1188 * we also see the events that were stored up to the tail.
1192 pr_debug("h%u t%u m%u\n", head, tail, ctx->nr_events);
1197 head %= ctx->nr_events;
1198 tail %= ctx->nr_events;
1202 struct io_event *ev;
1205 avail = (head <= tail ? tail : ctx->nr_events) - head;
1209 avail = min(avail, nr - ret);
1210 avail = min_t(long, avail, AIO_EVENTS_PER_PAGE -
1211 ((head + AIO_EVENTS_OFFSET) % AIO_EVENTS_PER_PAGE));
1213 pos = head + AIO_EVENTS_OFFSET;
1214 page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
1215 pos %= AIO_EVENTS_PER_PAGE;
1218 copy_ret = copy_to_user(event + ret, ev + pos,
1219 sizeof(*ev) * avail);
1222 if (unlikely(copy_ret)) {
1229 head %= ctx->nr_events;
1232 ring = kmap_atomic(ctx->ring_pages[0]);
1234 kunmap_atomic(ring);
1235 flush_dcache_page(ctx->ring_pages[0]);
1237 pr_debug("%li h%u t%u\n", ret, head, tail);
1239 mutex_unlock(&ctx->ring_lock);
1244 static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
1245 struct io_event __user *event, long *i)
1247 long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
1252 if (unlikely(atomic_read(&ctx->dead)))
1258 return ret < 0 || *i >= min_nr;
1261 static long read_events(struct kioctx *ctx, long min_nr, long nr,
1262 struct io_event __user *event,
1263 struct timespec __user *timeout)
1265 ktime_t until = { .tv64 = KTIME_MAX };
1271 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1274 until = timespec_to_ktime(ts);
1278 * Note that aio_read_events() is being called as the conditional - i.e.
1279 * we're calling it after prepare_to_wait() has set task state to
1280 * TASK_INTERRUPTIBLE.
1282 * But aio_read_events() can block, and if it blocks it's going to flip
1283 * the task state back to TASK_RUNNING.
1285 * This should be ok, provided it doesn't flip the state back to
1286 * TASK_RUNNING and return 0 too much - that causes us to spin. That
1287 * will only happen if the mutex_lock() call blocks, and we then find
1288 * the ringbuffer empty. So in practice we should be ok, but it's
1289 * something to be aware of when touching this code.
1291 if (until.tv64 == 0)
1292 aio_read_events(ctx, min_nr, nr, event, &ret);
1294 wait_event_interruptible_hrtimeout(ctx->wait,
1295 aio_read_events(ctx, min_nr, nr, event, &ret),
1298 if (!ret && signal_pending(current))
1305 * Create an aio_context capable of receiving at least nr_events.
1306 * ctxp must not point to an aio_context that already exists, and
1307 * must be initialized to 0 prior to the call. On successful
1308 * creation of the aio_context, *ctxp is filled in with the resulting
1309 * handle. May fail with -EINVAL if *ctxp is not initialized,
1310 * if the specified nr_events exceeds internal limits. May fail
1311 * with -EAGAIN if the specified nr_events exceeds the user's limit
1312 * of available events. May fail with -ENOMEM if insufficient kernel
1313 * resources are available. May fail with -EFAULT if an invalid
1314 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1317 SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
1319 struct kioctx *ioctx = NULL;
1323 ret = get_user(ctx, ctxp);
1328 if (unlikely(ctx || nr_events == 0)) {
1329 pr_debug("EINVAL: ctx %lu nr_events %u\n",
1334 ioctx = ioctx_alloc(nr_events);
1335 ret = PTR_ERR(ioctx);
1336 if (!IS_ERR(ioctx)) {
1337 ret = put_user(ioctx->user_id, ctxp);
1339 kill_ioctx(current->mm, ioctx, NULL);
1340 percpu_ref_put(&ioctx->users);
1348 * Destroy the aio_context specified. May cancel any outstanding
1349 * AIOs and block on completion. Will fail with -ENOSYS if not
1350 * implemented. May fail with -EINVAL if the context pointed to
1353 SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
1355 struct kioctx *ioctx = lookup_ioctx(ctx);
1356 if (likely(NULL != ioctx)) {
1357 struct ctx_rq_wait wait;
1360 init_completion(&wait.comp);
1361 atomic_set(&wait.count, 1);
1363 /* Pass requests_done to kill_ioctx() where it can be set
1364 * in a thread-safe way. If we try to set it here then we have
1365 * a race condition if two io_destroy() called simultaneously.
1367 ret = kill_ioctx(current->mm, ioctx, &wait);
1368 percpu_ref_put(&ioctx->users);
1370 /* Wait until all IO for the context are done. Otherwise kernel
1371 * keep using user-space buffers even if user thinks the context
1375 wait_for_completion(&wait.comp);
1379 pr_debug("EINVAL: invalid context id\n");
1383 typedef ssize_t (rw_iter_op)(struct kiocb *, struct iov_iter *);
1385 static int aio_setup_vectored_rw(int rw, char __user *buf, size_t len,
1386 struct iovec **iovec,
1388 struct iov_iter *iter)
1390 #ifdef CONFIG_COMPAT
1392 return compat_import_iovec(rw,
1393 (struct compat_iovec __user *)buf,
1394 len, UIO_FASTIOV, iovec, iter);
1396 return import_iovec(rw, (struct iovec __user *)buf,
1397 len, UIO_FASTIOV, iovec, iter);
1402 * Performs the initial checks and io submission.
1404 static ssize_t aio_run_iocb(struct kiocb *req, unsigned opcode,
1405 char __user *buf, size_t len, bool compat)
1407 struct file *file = req->ki_filp;
1411 rw_iter_op *iter_op;
1412 struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1413 struct iov_iter iter;
1416 case IOCB_CMD_PREAD:
1417 case IOCB_CMD_PREADV:
1420 iter_op = file->f_op->read_iter;
1423 case IOCB_CMD_PWRITE:
1424 case IOCB_CMD_PWRITEV:
1427 iter_op = file->f_op->write_iter;
1430 if (unlikely(!(file->f_mode & mode)))
1436 if (opcode == IOCB_CMD_PREADV || opcode == IOCB_CMD_PWRITEV)
1437 ret = aio_setup_vectored_rw(rw, buf, len,
1438 &iovec, compat, &iter);
1440 ret = import_single_range(rw, buf, len, iovec, &iter);
1444 ret = rw_verify_area(rw, file, &req->ki_pos,
1445 iov_iter_count(&iter));
1454 file_start_write(file);
1456 ret = iter_op(req, &iter);
1459 file_end_write(file);
1463 case IOCB_CMD_FDSYNC:
1464 if (!file->f_op->aio_fsync)
1467 ret = file->f_op->aio_fsync(req, 1);
1470 case IOCB_CMD_FSYNC:
1471 if (!file->f_op->aio_fsync)
1474 ret = file->f_op->aio_fsync(req, 0);
1478 pr_debug("EINVAL: no operation provided\n");
1482 if (ret != -EIOCBQUEUED) {
1484 * There's no easy way to restart the syscall since other AIO's
1485 * may be already running. Just fail this IO with EINTR.
1487 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
1488 ret == -ERESTARTNOHAND ||
1489 ret == -ERESTART_RESTARTBLOCK))
1491 aio_complete(req, ret, 0);
1497 static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
1498 struct iocb *iocb, bool compat)
1500 struct aio_kiocb *req;
1503 /* enforce forwards compatibility on users */
1504 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
1505 pr_debug("EINVAL: reserve field set\n");
1509 /* prevent overflows */
1511 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1512 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1513 ((ssize_t)iocb->aio_nbytes < 0)
1515 pr_debug("EINVAL: overflow check\n");
1519 req = aio_get_req(ctx);
1523 req->common.ki_filp = fget(iocb->aio_fildes);
1524 if (unlikely(!req->common.ki_filp)) {
1528 req->common.ki_pos = iocb->aio_offset;
1529 req->common.ki_complete = aio_complete;
1530 req->common.ki_flags = iocb_flags(req->common.ki_filp);
1532 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1534 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1535 * instance of the file* now. The file descriptor must be
1536 * an eventfd() fd, and will be signaled for each completed
1537 * event using the eventfd_signal() function.
1539 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
1540 if (IS_ERR(req->ki_eventfd)) {
1541 ret = PTR_ERR(req->ki_eventfd);
1542 req->ki_eventfd = NULL;
1546 req->common.ki_flags |= IOCB_EVENTFD;
1549 ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
1550 if (unlikely(ret)) {
1551 pr_debug("EFAULT: aio_key\n");
1555 req->ki_user_iocb = user_iocb;
1556 req->ki_user_data = iocb->aio_data;
1558 ret = aio_run_iocb(&req->common, iocb->aio_lio_opcode,
1559 (char __user *)(unsigned long)iocb->aio_buf,
1567 put_reqs_available(ctx, 1);
1568 percpu_ref_put(&ctx->reqs);
1573 long do_io_submit(aio_context_t ctx_id, long nr,
1574 struct iocb __user *__user *iocbpp, bool compat)
1579 struct blk_plug plug;
1581 if (unlikely(nr < 0))
1584 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1585 nr = LONG_MAX/sizeof(*iocbpp);
1587 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1590 ctx = lookup_ioctx(ctx_id);
1591 if (unlikely(!ctx)) {
1592 pr_debug("EINVAL: invalid context id\n");
1596 blk_start_plug(&plug);
1599 * AKPM: should this return a partial result if some of the IOs were
1600 * successfully submitted?
1602 for (i=0; i<nr; i++) {
1603 struct iocb __user *user_iocb;
1606 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1611 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1616 ret = io_submit_one(ctx, user_iocb, &tmp, compat);
1620 blk_finish_plug(&plug);
1622 percpu_ref_put(&ctx->users);
1627 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1628 * the number of iocbs queued. May return -EINVAL if the aio_context
1629 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1630 * *iocbpp[0] is not properly initialized, if the operation specified
1631 * is invalid for the file descriptor in the iocb. May fail with
1632 * -EFAULT if any of the data structures point to invalid data. May
1633 * fail with -EBADF if the file descriptor specified in the first
1634 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1635 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1636 * fail with -ENOSYS if not implemented.
1638 SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1639 struct iocb __user * __user *, iocbpp)
1641 return do_io_submit(ctx_id, nr, iocbpp, 0);
1645 * Finds a given iocb for cancellation.
1647 static struct aio_kiocb *
1648 lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb, u32 key)
1650 struct aio_kiocb *kiocb;
1652 assert_spin_locked(&ctx->ctx_lock);
1654 if (key != KIOCB_KEY)
1657 /* TODO: use a hash or array, this sucks. */
1658 list_for_each_entry(kiocb, &ctx->active_reqs, ki_list) {
1659 if (kiocb->ki_user_iocb == iocb)
1666 * Attempts to cancel an iocb previously passed to io_submit. If
1667 * the operation is successfully cancelled, the resulting event is
1668 * copied into the memory pointed to by result without being placed
1669 * into the completion queue and 0 is returned. May fail with
1670 * -EFAULT if any of the data structures pointed to are invalid.
1671 * May fail with -EINVAL if aio_context specified by ctx_id is
1672 * invalid. May fail with -EAGAIN if the iocb specified was not
1673 * cancelled. Will fail with -ENOSYS if not implemented.
1675 SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1676 struct io_event __user *, result)
1679 struct aio_kiocb *kiocb;
1683 ret = get_user(key, &iocb->aio_key);
1687 ctx = lookup_ioctx(ctx_id);
1691 spin_lock_irq(&ctx->ctx_lock);
1693 kiocb = lookup_kiocb(ctx, iocb, key);
1695 ret = kiocb_cancel(kiocb);
1699 spin_unlock_irq(&ctx->ctx_lock);
1703 * The result argument is no longer used - the io_event is
1704 * always delivered via the ring buffer. -EINPROGRESS indicates
1705 * cancellation is progress:
1710 percpu_ref_put(&ctx->users);
1716 * Attempts to read at least min_nr events and up to nr events from
1717 * the completion queue for the aio_context specified by ctx_id. If
1718 * it succeeds, the number of read events is returned. May fail with
1719 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1720 * out of range, if timeout is out of range. May fail with -EFAULT
1721 * if any of the memory specified is invalid. May return 0 or
1722 * < min_nr if the timeout specified by timeout has elapsed
1723 * before sufficient events are available, where timeout == NULL
1724 * specifies an infinite timeout. Note that the timeout pointed to by
1725 * timeout is relative. Will fail with -ENOSYS if not implemented.
1727 SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1730 struct io_event __user *, events,
1731 struct timespec __user *, timeout)
1733 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1736 if (likely(ioctx)) {
1737 if (likely(min_nr <= nr && min_nr >= 0))
1738 ret = read_events(ioctx, min_nr, nr, events, timeout);
1739 percpu_ref_put(&ioctx->users);