blob: 823efcbb6ccd1dc7936f77890183cee0ac93ed94 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * An async IO implementation for Linux
3 * Written by Benjamin LaHaise <bcrl@kvack.org>
4 *
5 * Implements an efficient asynchronous io interface.
6 *
7 * Copyright 2000, 2001, 2002 Red Hat, Inc. All Rights Reserved.
8 *
9 * See ../COPYING for licensing terms.
10 */
Kent Overstreetcaf41672013-05-07 16:18:35 -070011#define pr_fmt(fmt) "%s: " fmt, __func__
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#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>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050018#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/syscalls.h>
Jens Axboeb9d128f2009-10-29 13:59:26 +010020#include <linux/backing-dev.h>
Badari Pulavarty027445c2006-09-30 23:28:46 -070021#include <linux/uio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/sched.h>
24#include <linux/fs.h>
25#include <linux/file.h>
26#include <linux/mm.h>
27#include <linux/mman.h>
Michael S. Tsirkin3d2d8272009-09-21 17:03:51 -070028#include <linux/mmu_context.h>
Kent Overstreete1bdd5f2013-04-26 10:58:39 +100029#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#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>
Davide Libenzi9c3060b2007-05-10 22:23:21 -070036#include <linux/eventfd.h>
Jeff Moyercfb1e332009-10-02 18:57:36 -040037#include <linux/blkdev.h>
Jeff Moyer9d85cba2010-05-26 14:44:26 -070038#include <linux/compat.h>
Gu Zheng36bc08c2013-07-16 17:56:16 +080039#include <linux/migrate.h>
40#include <linux/ramfs.h>
Kent Overstreet723be6e2013-05-28 15:14:48 -070041#include <linux/percpu-refcount.h>
Benjamin LaHaise71ad7492013-09-17 10:18:25 -040042#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44#include <asm/kmap_types.h>
45#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Al Viro68d70d02013-06-19 15:26:04 +040047#include "internal.h"
48
Kent Overstreet4e179bc2013-05-07 16:18:33 -070049#define AIO_RING_MAGIC 0xa10a10a1
50#define AIO_RING_COMPAT_FEATURES 1
51#define AIO_RING_INCOMPAT_FEATURES 0
52struct aio_ring {
53 unsigned id; /* kernel internal index number */
54 unsigned nr; /* number of io_events */
55 unsigned head;
56 unsigned tail;
57
58 unsigned magic;
59 unsigned compat_features;
60 unsigned incompat_features;
61 unsigned header_length; /* size of aio_ring */
62
63
64 struct io_event io_events[0];
65}; /* 128 bytes + ring size */
66
67#define AIO_RING_PAGES 8
Kent Overstreet4e179bc2013-05-07 16:18:33 -070068
Benjamin LaHaisedb446a02013-07-30 12:54:40 -040069struct kioctx_table {
70 struct rcu_head rcu;
71 unsigned nr;
72 struct kioctx *table[];
73};
74
Kent Overstreete1bdd5f2013-04-26 10:58:39 +100075struct kioctx_cpu {
76 unsigned reqs_available;
77};
78
Kent Overstreet4e179bc2013-05-07 16:18:33 -070079struct kioctx {
Kent Overstreet723be6e2013-05-28 15:14:48 -070080 struct percpu_ref users;
Kent Overstreet36f55882013-05-07 16:18:41 -070081 atomic_t dead;
Kent Overstreet4e179bc2013-05-07 16:18:33 -070082
Kent Overstreet4e179bc2013-05-07 16:18:33 -070083 unsigned long user_id;
Kent Overstreet4e179bc2013-05-07 16:18:33 -070084
Kent Overstreete1bdd5f2013-04-26 10:58:39 +100085 struct __percpu kioctx_cpu *cpu;
86
87 /*
88 * For percpu reqs_available, number of slots we move to/from global
89 * counter at a time:
90 */
91 unsigned req_batch;
Kent Overstreet3e845ce2013-05-07 16:18:51 -070092 /*
93 * This is what userspace passed to io_setup(), it's not used for
94 * anything but counting against the global max_reqs quota.
95 *
Kent Overstreet58c85dc2013-05-07 16:18:55 -070096 * The real limit is nr_events - 1, which will be larger (see
Kent Overstreet3e845ce2013-05-07 16:18:51 -070097 * aio_setup_ring())
98 */
Kent Overstreet4e179bc2013-05-07 16:18:33 -070099 unsigned max_reqs;
100
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700101 /* Size of ringbuffer, in units of struct io_event */
102 unsigned nr_events;
Kent Overstreet4e179bc2013-05-07 16:18:33 -0700103
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700104 unsigned long mmap_base;
105 unsigned long mmap_size;
106
107 struct page **ring_pages;
108 long nr_pages;
109
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700110 struct rcu_head rcu_head;
Kent Overstreet723be6e2013-05-28 15:14:48 -0700111 struct work_struct free_work;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700112
113 struct {
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000114 /*
115 * This counts the number of available slots in the ringbuffer,
116 * so we avoid overflowing it: it's decremented (if positive)
117 * when allocating a kiocb and incremented when the resulting
118 * io_event is pulled off the ringbuffer.
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000119 *
120 * We batch accesses to it with a percpu version.
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000121 */
122 atomic_t reqs_available;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700123 } ____cacheline_aligned_in_smp;
124
125 struct {
126 spinlock_t ctx_lock;
127 struct list_head active_reqs; /* used for cancellation */
128 } ____cacheline_aligned_in_smp;
129
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700130 struct {
131 struct mutex ring_lock;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700132 wait_queue_head_t wait;
133 } ____cacheline_aligned_in_smp;
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700134
135 struct {
136 unsigned tail;
137 spinlock_t completion_lock;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700138 } ____cacheline_aligned_in_smp;
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700139
140 struct page *internal_pages[AIO_RING_PAGES];
Gu Zheng36bc08c2013-07-16 17:56:16 +0800141 struct file *aio_ring_file;
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400142
143 unsigned id;
Kent Overstreet4e179bc2013-05-07 16:18:33 -0700144};
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146/*------ sysctl variables----*/
Zach Brownd55b5fd2005-11-07 00:59:31 -0800147static DEFINE_SPINLOCK(aio_nr_lock);
148unsigned long aio_nr; /* current system wide number of aio requests */
149unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150/*----end sysctl variables---*/
151
Christoph Lametere18b8902006-12-06 20:33:20 -0800152static struct kmem_cache *kiocb_cachep;
153static struct kmem_cache *kioctx_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400155static struct vfsmount *aio_mnt;
156
157static const struct file_operations aio_ring_fops;
158static const struct address_space_operations aio_ctx_aops;
159
160static struct file *aio_private_file(struct kioctx *ctx, loff_t nr_pages)
161{
162 struct qstr this = QSTR_INIT("[aio]", 5);
163 struct file *file;
164 struct path path;
165 struct inode *inode = alloc_anon_inode(aio_mnt->mnt_sb);
Dan Carpenter7f626562013-11-13 10:49:40 +0300166 if (IS_ERR(inode))
167 return ERR_CAST(inode);
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400168
169 inode->i_mapping->a_ops = &aio_ctx_aops;
170 inode->i_mapping->private_data = ctx;
171 inode->i_size = PAGE_SIZE * nr_pages;
172
173 path.dentry = d_alloc_pseudo(aio_mnt->mnt_sb, &this);
174 if (!path.dentry) {
175 iput(inode);
176 return ERR_PTR(-ENOMEM);
177 }
178 path.mnt = mntget(aio_mnt);
179
180 d_instantiate(path.dentry, inode);
181 file = alloc_file(&path, FMODE_READ | FMODE_WRITE, &aio_ring_fops);
182 if (IS_ERR(file)) {
183 path_put(&path);
184 return file;
185 }
186
187 file->f_flags = O_RDWR;
188 file->private_data = ctx;
189 return file;
190}
191
192static struct dentry *aio_mount(struct file_system_type *fs_type,
193 int flags, const char *dev_name, void *data)
194{
195 static const struct dentry_operations ops = {
196 .d_dname = simple_dname,
197 };
198 return mount_pseudo(fs_type, "aio:", NULL, &ops, 0xa10a10a1);
199}
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201/* aio_setup
202 * Creates the slab caches used by the aio routines, panic on
203 * failure as this is done early during the boot sequence.
204 */
205static int __init aio_setup(void)
206{
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400207 static struct file_system_type aio_fs = {
208 .name = "aio",
209 .mount = aio_mount,
210 .kill_sb = kill_anon_super,
211 };
212 aio_mnt = kern_mount(&aio_fs);
213 if (IS_ERR(aio_mnt))
214 panic("Failed to create aio fs mount.");
215
Christoph Lameter0a31bd52007-05-06 14:49:57 -0700216 kiocb_cachep = KMEM_CACHE(kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
217 kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Kent Overstreetcaf41672013-05-07 16:18:35 -0700219 pr_debug("sizeof(struct page) = %zu\n", sizeof(struct page));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221 return 0;
222}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700223__initcall(aio_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400225static void put_aio_ring_file(struct kioctx *ctx)
226{
227 struct file *aio_ring_file = ctx->aio_ring_file;
228 if (aio_ring_file) {
229 truncate_setsize(aio_ring_file->f_inode, 0);
230
231 /* Prevent further access to the kioctx from migratepages */
232 spin_lock(&aio_ring_file->f_inode->i_mapping->private_lock);
233 aio_ring_file->f_inode->i_mapping->private_data = NULL;
234 ctx->aio_ring_file = NULL;
235 spin_unlock(&aio_ring_file->f_inode->i_mapping->private_lock);
236
237 fput(aio_ring_file);
238 }
239}
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241static void aio_free_ring(struct kioctx *ctx)
242{
Gu Zheng36bc08c2013-07-16 17:56:16 +0800243 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Gu Zheng36bc08c2013-07-16 17:56:16 +0800245 for (i = 0; i < ctx->nr_pages; i++) {
246 pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
247 page_count(ctx->ring_pages[i]));
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700248 put_page(ctx->ring_pages[i]);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800249 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400251 put_aio_ring_file(ctx);
252
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700253 if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages)
254 kfree(ctx->ring_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
256
Gu Zheng36bc08c2013-07-16 17:56:16 +0800257static int aio_ring_mmap(struct file *file, struct vm_area_struct *vma)
258{
259 vma->vm_ops = &generic_file_vm_ops;
260 return 0;
261}
262
263static const struct file_operations aio_ring_fops = {
264 .mmap = aio_ring_mmap,
265};
266
267static int aio_set_page_dirty(struct page *page)
268{
269 return 0;
270}
271
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400272#if IS_ENABLED(CONFIG_MIGRATION)
Gu Zheng36bc08c2013-07-16 17:56:16 +0800273static int aio_migratepage(struct address_space *mapping, struct page *new,
274 struct page *old, enum migrate_mode mode)
275{
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400276 struct kioctx *ctx;
Gu Zheng36bc08c2013-07-16 17:56:16 +0800277 unsigned long flags;
Gu Zheng36bc08c2013-07-16 17:56:16 +0800278 int rc;
279
280 /* Writeback must be complete */
281 BUG_ON(PageWriteback(old));
282 put_page(old);
283
284 rc = migrate_page_move_mapping(mapping, new, old, NULL, mode);
285 if (rc != MIGRATEPAGE_SUCCESS) {
286 get_page(old);
287 return rc;
288 }
289
290 get_page(new);
291
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400292 /* We can potentially race against kioctx teardown here. Use the
293 * address_space's private data lock to protect the mapping's
294 * private_data.
295 */
296 spin_lock(&mapping->private_lock);
297 ctx = mapping->private_data;
298 if (ctx) {
299 pgoff_t idx;
300 spin_lock_irqsave(&ctx->completion_lock, flags);
301 migrate_page_copy(new, old);
302 idx = old->index;
303 if (idx < (pgoff_t)ctx->nr_pages)
304 ctx->ring_pages[idx] = new;
305 spin_unlock_irqrestore(&ctx->completion_lock, flags);
306 } else
307 rc = -EBUSY;
308 spin_unlock(&mapping->private_lock);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800309
310 return rc;
311}
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400312#endif
Gu Zheng36bc08c2013-07-16 17:56:16 +0800313
314static const struct address_space_operations aio_ctx_aops = {
315 .set_page_dirty = aio_set_page_dirty,
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400316#if IS_ENABLED(CONFIG_MIGRATION)
Gu Zheng36bc08c2013-07-16 17:56:16 +0800317 .migratepage = aio_migratepage,
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400318#endif
Gu Zheng36bc08c2013-07-16 17:56:16 +0800319};
320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321static int aio_setup_ring(struct kioctx *ctx)
322{
323 struct aio_ring *ring;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 unsigned nr_events = ctx->max_reqs;
Zach Brown41003a72013-05-07 16:18:25 -0700325 struct mm_struct *mm = current->mm;
Michel Lespinasse41badc12013-02-22 16:32:47 -0800326 unsigned long size, populate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 int nr_pages;
Gu Zheng36bc08c2013-07-16 17:56:16 +0800328 int i;
329 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331 /* Compensate for the ring buffer's head/tail overlap entry */
332 nr_events += 2; /* 1 is required, 2 for good luck */
333
334 size = sizeof(struct aio_ring);
335 size += sizeof(struct io_event) * nr_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
Gu Zheng36bc08c2013-07-16 17:56:16 +0800337 nr_pages = PFN_UP(size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 if (nr_pages < 0)
339 return -EINVAL;
340
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400341 file = aio_private_file(ctx, nr_pages);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800342 if (IS_ERR(file)) {
343 ctx->aio_ring_file = NULL;
344 return -EAGAIN;
345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Gu Zheng36bc08c2013-07-16 17:56:16 +0800347 for (i = 0; i < nr_pages; i++) {
348 struct page *page;
349 page = find_or_create_page(file->f_inode->i_mapping,
350 i, GFP_HIGHUSER | __GFP_ZERO);
351 if (!page)
352 break;
353 pr_debug("pid(%d) page[%d]->count=%d\n",
354 current->pid, i, page_count(page));
355 SetPageUptodate(page);
356 SetPageDirty(page);
357 unlock_page(page);
358 }
359 ctx->aio_ring_file = file;
360 nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring))
361 / sizeof(struct io_event);
362
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700363 ctx->ring_pages = ctx->internal_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 if (nr_pages > AIO_RING_PAGES) {
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700365 ctx->ring_pages = kcalloc(nr_pages, sizeof(struct page *),
366 GFP_KERNEL);
367 if (!ctx->ring_pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 }
370
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700371 ctx->mmap_size = nr_pages * PAGE_SIZE;
372 pr_debug("attempting mmap of %lu bytes\n", ctx->mmap_size);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800373
Zach Brown41003a72013-05-07 16:18:25 -0700374 down_write(&mm->mmap_sem);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800375 ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
376 PROT_READ | PROT_WRITE,
377 MAP_SHARED | MAP_POPULATE, 0, &populate);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700378 if (IS_ERR((void *)ctx->mmap_base)) {
Zach Brown41003a72013-05-07 16:18:25 -0700379 up_write(&mm->mmap_sem);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700380 ctx->mmap_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 aio_free_ring(ctx);
382 return -EAGAIN;
383 }
384
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700385 pr_debug("mmap address: 0x%08lx\n", ctx->mmap_base);
Benjamin LaHaised6c355c2013-09-09 11:57:59 -0400386
387 /* We must do this while still holding mmap_sem for write, as we
388 * need to be protected against userspace attempting to mremap()
389 * or munmap() the ring buffer.
390 */
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700391 ctx->nr_pages = get_user_pages(current, mm, ctx->mmap_base, nr_pages,
392 1, 0, ctx->ring_pages, NULL);
Benjamin LaHaised6c355c2013-09-09 11:57:59 -0400393
394 /* Dropping the reference here is safe as the page cache will hold
395 * onto the pages for us. It is also required so that page migration
396 * can unmap the pages and get the right reference count.
397 */
Gu Zheng36bc08c2013-07-16 17:56:16 +0800398 for (i = 0; i < ctx->nr_pages; i++)
399 put_page(ctx->ring_pages[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
Benjamin LaHaised6c355c2013-09-09 11:57:59 -0400401 up_write(&mm->mmap_sem);
402
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700403 if (unlikely(ctx->nr_pages != nr_pages)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 aio_free_ring(ctx);
405 return -EAGAIN;
406 }
407
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700408 ctx->user_id = ctx->mmap_base;
409 ctx->nr_events = nr_events; /* trusted copy */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700411 ring = kmap_atomic(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 ring->nr = nr_events; /* user copy */
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400413 ring->id = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 ring->head = ring->tail = 0;
415 ring->magic = AIO_RING_MAGIC;
416 ring->compat_features = AIO_RING_COMPAT_FEATURES;
417 ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
418 ring->header_length = sizeof(struct aio_ring);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800419 kunmap_atomic(ring);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700420 flush_dcache_page(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422 return 0;
423}
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425#define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
426#define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
427#define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
428
Kent Overstreet0460fef2013-05-07 16:18:49 -0700429void kiocb_set_cancel_fn(struct kiocb *req, kiocb_cancel_fn *cancel)
430{
431 struct kioctx *ctx = req->ki_ctx;
432 unsigned long flags;
433
434 spin_lock_irqsave(&ctx->ctx_lock, flags);
435
436 if (!req->ki_list.next)
437 list_add(&req->ki_list, &ctx->active_reqs);
438
439 req->ki_cancel = cancel;
440
441 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
442}
443EXPORT_SYMBOL(kiocb_set_cancel_fn);
444
Kent Overstreetbec68faa2013-05-13 14:45:08 -0700445static int kiocb_cancel(struct kioctx *ctx, struct kiocb *kiocb)
Kent Overstreet906b9732013-05-07 16:18:31 -0700446{
Kent Overstreet0460fef2013-05-07 16:18:49 -0700447 kiocb_cancel_fn *old, *cancel;
Kent Overstreet906b9732013-05-07 16:18:31 -0700448
Kent Overstreet0460fef2013-05-07 16:18:49 -0700449 /*
450 * Don't want to set kiocb->ki_cancel = KIOCB_CANCELLED unless it
451 * actually has a cancel function, hence the cmpxchg()
452 */
Kent Overstreet906b9732013-05-07 16:18:31 -0700453
Kent Overstreet0460fef2013-05-07 16:18:49 -0700454 cancel = ACCESS_ONCE(kiocb->ki_cancel);
455 do {
456 if (!cancel || cancel == KIOCB_CANCELLED)
Kent Overstreet57282d82013-05-13 13:42:52 -0700457 return -EINVAL;
Kent Overstreet906b9732013-05-07 16:18:31 -0700458
Kent Overstreet0460fef2013-05-07 16:18:49 -0700459 old = cancel;
460 cancel = cmpxchg(&kiocb->ki_cancel, old, KIOCB_CANCELLED);
461 } while (cancel != old);
462
Kent Overstreet57282d82013-05-13 13:42:52 -0700463 return cancel(kiocb);
Kent Overstreet906b9732013-05-07 16:18:31 -0700464}
465
Kent Overstreet36f55882013-05-07 16:18:41 -0700466static void free_ioctx_rcu(struct rcu_head *head)
467{
468 struct kioctx *ctx = container_of(head, struct kioctx, rcu_head);
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000469
470 free_percpu(ctx->cpu);
Kent Overstreet36f55882013-05-07 16:18:41 -0700471 kmem_cache_free(kioctx_cachep, ctx);
472}
473
474/*
475 * When this function runs, the kioctx has been removed from the "hash table"
476 * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
477 * now it's safe to cancel any that need to be.
478 */
Kent Overstreet723be6e2013-05-28 15:14:48 -0700479static void free_ioctx(struct work_struct *work)
Kent Overstreet36f55882013-05-07 16:18:41 -0700480{
Kent Overstreet723be6e2013-05-28 15:14:48 -0700481 struct kioctx *ctx = container_of(work, struct kioctx, free_work);
Kent Overstreet3e845ce2013-05-07 16:18:51 -0700482 struct aio_ring *ring;
Kent Overstreet36f55882013-05-07 16:18:41 -0700483 struct kiocb *req;
Kent Overstreet5ffac122013-05-09 15:36:07 -0700484 unsigned cpu, avail;
485 DEFINE_WAIT(wait);
Kent Overstreet36f55882013-05-07 16:18:41 -0700486
487 spin_lock_irq(&ctx->ctx_lock);
488
489 while (!list_empty(&ctx->active_reqs)) {
490 req = list_first_entry(&ctx->active_reqs,
491 struct kiocb, ki_list);
492
493 list_del_init(&req->ki_list);
Kent Overstreetbec68faa2013-05-13 14:45:08 -0700494 kiocb_cancel(ctx, req);
Kent Overstreet36f55882013-05-07 16:18:41 -0700495 }
496
497 spin_unlock_irq(&ctx->ctx_lock);
498
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000499 for_each_possible_cpu(cpu) {
500 struct kioctx_cpu *kcpu = per_cpu_ptr(ctx->cpu, cpu);
501
502 atomic_add(kcpu->reqs_available, &ctx->reqs_available);
503 kcpu->reqs_available = 0;
504 }
505
Kent Overstreet5ffac122013-05-09 15:36:07 -0700506 while (1) {
507 prepare_to_wait(&ctx->wait, &wait, TASK_UNINTERRUPTIBLE);
Kent Overstreet3e845ce2013-05-07 16:18:51 -0700508
Kent Overstreet5ffac122013-05-09 15:36:07 -0700509 ring = kmap_atomic(ctx->ring_pages[0]);
510 avail = (ring->head <= ring->tail)
511 ? ring->tail - ring->head
512 : ctx->nr_events - ring->head + ring->tail;
Kent Overstreet3e845ce2013-05-07 16:18:51 -0700513
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000514 atomic_add(avail, &ctx->reqs_available);
Kent Overstreet5ffac122013-05-09 15:36:07 -0700515 ring->head = ring->tail;
516 kunmap_atomic(ring);
517
518 if (atomic_read(&ctx->reqs_available) >= ctx->nr_events - 1)
519 break;
520
521 schedule();
Kent Overstreet3e845ce2013-05-07 16:18:51 -0700522 }
Kent Overstreet5ffac122013-05-09 15:36:07 -0700523 finish_wait(&ctx->wait, &wait);
Kent Overstreet3e845ce2013-05-07 16:18:51 -0700524
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000525 WARN_ON(atomic_read(&ctx->reqs_available) > ctx->nr_events - 1);
Kent Overstreet36f55882013-05-07 16:18:41 -0700526
527 aio_free_ring(ctx);
528
Kent Overstreet36f55882013-05-07 16:18:41 -0700529 pr_debug("freeing %p\n", ctx);
530
531 /*
532 * Here the call_rcu() is between the wait_event() for reqs_active to
533 * hit 0, and freeing the ioctx.
534 *
535 * aio_complete() decrements reqs_active, but it has to touch the ioctx
536 * after to issue a wakeup so we use rcu.
537 */
538 call_rcu(&ctx->rcu_head, free_ioctx_rcu);
539}
540
Kent Overstreet723be6e2013-05-28 15:14:48 -0700541static void free_ioctx_ref(struct percpu_ref *ref)
Kent Overstreet36f55882013-05-07 16:18:41 -0700542{
Kent Overstreet723be6e2013-05-28 15:14:48 -0700543 struct kioctx *ctx = container_of(ref, struct kioctx, users);
544
545 INIT_WORK(&ctx->free_work, free_ioctx);
546 schedule_work(&ctx->free_work);
Kent Overstreet36f55882013-05-07 16:18:41 -0700547}
548
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400549static int ioctx_add_table(struct kioctx *ctx, struct mm_struct *mm)
550{
551 unsigned i, new_nr;
552 struct kioctx_table *table, *old;
553 struct aio_ring *ring;
554
555 spin_lock(&mm->ioctx_lock);
Artem Savkovd9b2c872013-09-09 12:29:35 -0400556 rcu_read_lock();
Benjamin LaHaise77d30b12013-08-30 11:12:50 -0400557 table = rcu_dereference(mm->ioctx_table);
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400558
559 while (1) {
560 if (table)
561 for (i = 0; i < table->nr; i++)
562 if (!table->table[i]) {
563 ctx->id = i;
564 table->table[i] = ctx;
Artem Savkovd9b2c872013-09-09 12:29:35 -0400565 rcu_read_unlock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400566 spin_unlock(&mm->ioctx_lock);
567
568 ring = kmap_atomic(ctx->ring_pages[0]);
569 ring->id = ctx->id;
570 kunmap_atomic(ring);
571 return 0;
572 }
573
574 new_nr = (table ? table->nr : 1) * 4;
575
Artem Savkovd9b2c872013-09-09 12:29:35 -0400576 rcu_read_unlock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400577 spin_unlock(&mm->ioctx_lock);
578
579 table = kzalloc(sizeof(*table) + sizeof(struct kioctx *) *
580 new_nr, GFP_KERNEL);
581 if (!table)
582 return -ENOMEM;
583
584 table->nr = new_nr;
585
586 spin_lock(&mm->ioctx_lock);
Artem Savkovd9b2c872013-09-09 12:29:35 -0400587 rcu_read_lock();
Benjamin LaHaise77d30b12013-08-30 11:12:50 -0400588 old = rcu_dereference(mm->ioctx_table);
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400589
590 if (!old) {
591 rcu_assign_pointer(mm->ioctx_table, table);
592 } else if (table->nr > old->nr) {
593 memcpy(table->table, old->table,
594 old->nr * sizeof(struct kioctx *));
595
596 rcu_assign_pointer(mm->ioctx_table, table);
597 kfree_rcu(old, rcu);
598 } else {
599 kfree(table);
600 table = old;
601 }
602 }
603}
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605/* ioctx_alloc
606 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
607 */
608static struct kioctx *ioctx_alloc(unsigned nr_events)
609{
Zach Brown41003a72013-05-07 16:18:25 -0700610 struct mm_struct *mm = current->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 struct kioctx *ctx;
Al Viroe23754f2012-03-06 14:33:22 -0500612 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000614 /*
615 * We keep track of the number of available ringbuffer slots, to prevent
616 * overflow (reqs_available), and we also use percpu counters for this.
617 *
618 * So since up to half the slots might be on other cpu's percpu counters
619 * and unavailable, double nr_events so userspace sees what they
620 * expected: additionally, we move req_batch slots to/from percpu
621 * counters at a time, so make sure that isn't 0:
622 */
623 nr_events = max(nr_events, num_possible_cpus() * 4);
624 nr_events *= 2;
625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 /* Prevent overflows */
627 if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
628 (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
629 pr_debug("ENOMEM: nr_events too high\n");
630 return ERR_PTR(-EINVAL);
631 }
632
Benjamin LaHaise4cd81c32013-07-30 12:06:37 -0400633 if (!nr_events || (unsigned long)nr_events > (aio_max_nr * 2UL))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 return ERR_PTR(-EAGAIN);
635
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800636 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 if (!ctx)
638 return ERR_PTR(-ENOMEM);
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 ctx->max_reqs = nr_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Kent Overstreet723be6e2013-05-28 15:14:48 -0700642 if (percpu_ref_init(&ctx->users, free_ioctx_ref))
643 goto out_freectx;
644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 spin_lock_init(&ctx->ctx_lock);
Kent Overstreet0460fef2013-05-07 16:18:49 -0700646 spin_lock_init(&ctx->completion_lock);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700647 mutex_init(&ctx->ring_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 init_waitqueue_head(&ctx->wait);
649
650 INIT_LIST_HEAD(&ctx->active_reqs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000652 ctx->cpu = alloc_percpu(struct kioctx_cpu);
653 if (!ctx->cpu)
Kent Overstreet723be6e2013-05-28 15:14:48 -0700654 goto out_freeref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000656 if (aio_setup_ring(ctx) < 0)
657 goto out_freepcpu;
658
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000659 atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000660 ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
Benjamin LaHaise6878ea72013-07-31 10:34:18 -0400661 if (ctx->req_batch < 1)
662 ctx->req_batch = 1;
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 /* limit the number of system wide aios */
Al Viro9fa1cb32012-03-10 23:14:05 -0500665 spin_lock(&aio_nr_lock);
Benjamin LaHaise4cd81c32013-07-30 12:06:37 -0400666 if (aio_nr + nr_events > (aio_max_nr * 2UL) ||
Al Viro2dd542b2012-03-10 23:10:35 -0500667 aio_nr + nr_events < aio_nr) {
Al Viro9fa1cb32012-03-10 23:14:05 -0500668 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 goto out_cleanup;
Al Viro2dd542b2012-03-10 23:10:35 -0500670 }
671 aio_nr += ctx->max_reqs;
Al Viro9fa1cb32012-03-10 23:14:05 -0500672 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
Kent Overstreet723be6e2013-05-28 15:14:48 -0700674 percpu_ref_get(&ctx->users); /* io_setup() will drop this ref */
675
Benjamin LaHaiseda903822013-08-05 13:21:43 -0400676 err = ioctx_add_table(ctx, mm);
677 if (err)
678 goto out_cleanup_put;
679
Kent Overstreetcaf41672013-05-07 16:18:35 -0700680 pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700681 ctx, ctx->user_id, mm, ctx->nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return ctx;
683
Benjamin LaHaiseda903822013-08-05 13:21:43 -0400684out_cleanup_put:
685 percpu_ref_put(&ctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686out_cleanup:
Al Viroe23754f2012-03-06 14:33:22 -0500687 err = -EAGAIN;
688 aio_free_ring(ctx);
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000689out_freepcpu:
690 free_percpu(ctx->cpu);
Kent Overstreet723be6e2013-05-28 15:14:48 -0700691out_freeref:
692 free_percpu(ctx->users.pcpu_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693out_freectx:
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400694 put_aio_ring_file(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 kmem_cache_free(kioctx_cachep, ctx);
Kent Overstreetcaf41672013-05-07 16:18:35 -0700696 pr_debug("error allocating ioctx %d\n", err);
Al Viroe23754f2012-03-06 14:33:22 -0500697 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698}
699
Kent Overstreet36f55882013-05-07 16:18:41 -0700700/* kill_ioctx
701 * Cancels all outstanding aio requests on an aio context. Used
702 * when the processes owning a context have all exited to encourage
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 * the rapid destruction of the kioctx.
704 */
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400705static void kill_ioctx(struct mm_struct *mm, struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
Kent Overstreet36f55882013-05-07 16:18:41 -0700707 if (!atomic_xchg(&ctx->dead, 1)) {
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400708 struct kioctx_table *table;
709
710 spin_lock(&mm->ioctx_lock);
Artem Savkovd9b2c872013-09-09 12:29:35 -0400711 rcu_read_lock();
Benjamin LaHaise77d30b12013-08-30 11:12:50 -0400712 table = rcu_dereference(mm->ioctx_table);
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400713
714 WARN_ON(ctx != table->table[ctx->id]);
715 table->table[ctx->id] = NULL;
Artem Savkovd9b2c872013-09-09 12:29:35 -0400716 rcu_read_unlock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400717 spin_unlock(&mm->ioctx_lock);
718
Kent Overstreet723be6e2013-05-28 15:14:48 -0700719 /* percpu_ref_kill() will do the necessary call_rcu() */
720 wake_up_all(&ctx->wait);
Al Viro06af1212012-03-20 16:26:24 -0400721
Kent Overstreet36f55882013-05-07 16:18:41 -0700722 /*
Kent Overstreet4fcc7122013-06-12 14:04:59 -0700723 * It'd be more correct to do this in free_ioctx(), after all
724 * the outstanding kiocbs have finished - but by then io_destroy
725 * has already returned, so io_setup() could potentially return
726 * -EAGAIN with no ioctxs actually in use (as far as userspace
727 * could tell).
Kent Overstreet36f55882013-05-07 16:18:41 -0700728 */
Kent Overstreet4fcc7122013-06-12 14:04:59 -0700729 spin_lock(&aio_nr_lock);
730 BUG_ON(aio_nr - ctx->max_reqs > aio_nr);
731 aio_nr -= ctx->max_reqs;
732 spin_unlock(&aio_nr_lock);
733
734 if (ctx->mmap_size)
735 vm_munmap(ctx->mmap_base, ctx->mmap_size);
736
Kent Overstreet723be6e2013-05-28 15:14:48 -0700737 percpu_ref_kill(&ctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739}
740
741/* wait_on_sync_kiocb:
742 * Waits on the given sync kiocb to complete.
743 */
Kent Overstreet57282d82013-05-13 13:42:52 -0700744ssize_t wait_on_sync_kiocb(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
Kent Overstreet57282d82013-05-13 13:42:52 -0700746 while (!req->ki_ctx) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 set_current_state(TASK_UNINTERRUPTIBLE);
Kent Overstreet57282d82013-05-13 13:42:52 -0700748 if (req->ki_ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 break;
Jeff Moyer41d10da2007-10-16 23:27:20 -0700750 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 }
752 __set_current_state(TASK_RUNNING);
Kent Overstreet57282d82013-05-13 13:42:52 -0700753 return req->ki_user_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700755EXPORT_SYMBOL(wait_on_sync_kiocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Kent Overstreet36f55882013-05-07 16:18:41 -0700757/*
758 * exit_aio: called when the last user of mm goes away. At this point, there is
759 * no way for any new requests to be submited or any of the io_* syscalls to be
760 * called on the context.
761 *
762 * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
763 * them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800765void exit_aio(struct mm_struct *mm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766{
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400767 struct kioctx_table *table;
Jens Axboeabf137d2008-12-09 08:11:22 +0100768 struct kioctx *ctx;
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400769 unsigned i = 0;
Jens Axboeabf137d2008-12-09 08:11:22 +0100770
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400771 while (1) {
772 rcu_read_lock();
773 table = rcu_dereference(mm->ioctx_table);
774
775 do {
776 if (!table || i >= table->nr) {
777 rcu_read_unlock();
778 rcu_assign_pointer(mm->ioctx_table, NULL);
779 if (table)
780 kfree(table);
781 return;
782 }
783
784 ctx = table->table[i++];
785 } while (!ctx);
786
787 rcu_read_unlock();
788
Al Viro936af152012-04-20 21:49:41 -0400789 /*
790 * We don't need to bother with munmap() here -
791 * exit_mmap(mm) is coming and it'll unmap everything.
792 * Since aio_free_ring() uses non-zero ->mmap_size
793 * as indicator that it needs to unmap the area,
794 * just set it to 0; aio_free_ring() is the only
795 * place that uses ->mmap_size, so it's safe.
Al Viro936af152012-04-20 21:49:41 -0400796 */
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700797 ctx->mmap_size = 0;
Kent Overstreet36f55882013-05-07 16:18:41 -0700798
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400799 kill_ioctx(mm, ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 }
801}
802
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000803static void put_reqs_available(struct kioctx *ctx, unsigned nr)
804{
805 struct kioctx_cpu *kcpu;
806
807 preempt_disable();
808 kcpu = this_cpu_ptr(ctx->cpu);
809
810 kcpu->reqs_available += nr;
811 while (kcpu->reqs_available >= ctx->req_batch * 2) {
812 kcpu->reqs_available -= ctx->req_batch;
813 atomic_add(ctx->req_batch, &ctx->reqs_available);
814 }
815
816 preempt_enable();
817}
818
819static bool get_reqs_available(struct kioctx *ctx)
820{
821 struct kioctx_cpu *kcpu;
822 bool ret = false;
823
824 preempt_disable();
825 kcpu = this_cpu_ptr(ctx->cpu);
826
827 if (!kcpu->reqs_available) {
828 int old, avail = atomic_read(&ctx->reqs_available);
829
830 do {
831 if (avail < ctx->req_batch)
832 goto out;
833
834 old = avail;
835 avail = atomic_cmpxchg(&ctx->reqs_available,
836 avail, avail - ctx->req_batch);
837 } while (avail != old);
838
839 kcpu->reqs_available += ctx->req_batch;
840 }
841
842 ret = true;
843 kcpu->reqs_available--;
844out:
845 preempt_enable();
846 return ret;
847}
848
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849/* aio_get_req
Kent Overstreet57282d82013-05-13 13:42:52 -0700850 * Allocate a slot for an aio request.
851 * Returns NULL if no requests are free.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 */
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700853static inline struct kiocb *aio_get_req(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854{
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700855 struct kiocb *req;
856
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000857 if (!get_reqs_available(ctx))
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700858 return NULL;
859
Kent Overstreet0460fef2013-05-07 16:18:49 -0700860 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 if (unlikely(!req))
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700862 goto out_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 req->ki_ctx = ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 return req;
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700866out_put:
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000867 put_reqs_available(ctx, 1);
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700868 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869}
870
Kent Overstreet11599eb2013-05-07 16:18:39 -0700871static void kiocb_free(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872{
Kent Overstreet1d98ebf2013-05-07 16:18:37 -0700873 if (req->ki_filp)
874 fput(req->ki_filp);
Davide Libenzi13389012009-06-30 11:41:11 -0700875 if (req->ki_eventfd != NULL)
876 eventfd_ctx_put(req->ki_eventfd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 kmem_cache_free(kiocb_cachep, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878}
879
Adrian Bunkd5470b52008-04-29 00:58:57 -0700880static struct kioctx *lookup_ioctx(unsigned long ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881{
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400882 struct aio_ring __user *ring = (void __user *)ctx_id;
Jens Axboeabf137d2008-12-09 08:11:22 +0100883 struct mm_struct *mm = current->mm;
Jeff Moyer65c24492009-03-18 17:04:21 -0700884 struct kioctx *ctx, *ret = NULL;
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400885 struct kioctx_table *table;
886 unsigned id;
887
888 if (get_user(id, &ring->id))
889 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Jens Axboeabf137d2008-12-09 08:11:22 +0100891 rcu_read_lock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400892 table = rcu_dereference(mm->ioctx_table);
Jens Axboeabf137d2008-12-09 08:11:22 +0100893
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400894 if (!table || id >= table->nr)
895 goto out;
896
897 ctx = table->table[id];
Benjamin LaHaisef30d7042013-08-07 18:23:48 -0400898 if (ctx && ctx->user_id == ctx_id) {
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400899 percpu_ref_get(&ctx->users);
900 ret = ctx;
Jens Axboeabf137d2008-12-09 08:11:22 +0100901 }
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400902out:
Jens Axboeabf137d2008-12-09 08:11:22 +0100903 rcu_read_unlock();
Jeff Moyer65c24492009-03-18 17:04:21 -0700904 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905}
906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907/* aio_complete
908 * Called when the io request on the given iocb is complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 */
Kent Overstreet2d684492013-05-07 16:18:29 -0700910void aio_complete(struct kiocb *iocb, long res, long res2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911{
912 struct kioctx *ctx = iocb->ki_ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 struct aio_ring *ring;
Kent Overstreet21b40202013-05-07 16:18:47 -0700914 struct io_event *ev_page, *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 unsigned long flags;
Kent Overstreet21b40202013-05-07 16:18:47 -0700916 unsigned tail, pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Zach Brown20dcae32005-11-13 16:07:33 -0800918 /*
919 * Special case handling for sync iocbs:
920 * - events go directly into the iocb for fast handling
921 * - the sync task with the iocb in its stack holds the single iocb
922 * ref, no other paths have a way to get another ref
923 * - the sync task helpfully left a reference to itself in the iocb
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 */
925 if (is_sync_kiocb(iocb)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 iocb->ki_user_data = res;
Kent Overstreet57282d82013-05-13 13:42:52 -0700927 smp_wmb();
928 iocb->ki_ctx = ERR_PTR(-EXDEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 wake_up_process(iocb->ki_obj.tsk);
Kent Overstreet2d684492013-05-07 16:18:29 -0700930 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 }
932
Kent Overstreet36f55882013-05-07 16:18:41 -0700933 /*
Kent Overstreet36f55882013-05-07 16:18:41 -0700934 * Take rcu_read_lock() in case the kioctx is being destroyed, as we
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000935 * need to issue a wakeup after incrementing reqs_available.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 */
Kent Overstreet36f55882013-05-07 16:18:41 -0700937 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Kent Overstreet0460fef2013-05-07 16:18:49 -0700939 if (iocb->ki_list.next) {
940 unsigned long flags;
941
942 spin_lock_irqsave(&ctx->ctx_lock, flags);
943 list_del(&iocb->ki_list);
944 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
945 }
Kent Overstreet11599eb2013-05-07 16:18:39 -0700946
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 /*
Kent Overstreet0460fef2013-05-07 16:18:49 -0700948 * Add a completion event to the ring buffer. Must be done holding
Tang Chen4b30f072013-07-03 15:09:16 -0700949 * ctx->completion_lock to prevent other code from messing with the tail
Kent Overstreet0460fef2013-05-07 16:18:49 -0700950 * pointer since we might be called from irq context.
951 */
952 spin_lock_irqsave(&ctx->completion_lock, flags);
953
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700954 tail = ctx->tail;
Kent Overstreet21b40202013-05-07 16:18:47 -0700955 pos = tail + AIO_EVENTS_OFFSET;
956
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700957 if (++tail >= ctx->nr_events)
Ken Chen4bf69b22005-05-01 08:59:15 -0700958 tail = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700960 ev_page = kmap_atomic(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
Kent Overstreet21b40202013-05-07 16:18:47 -0700961 event = ev_page + pos % AIO_EVENTS_PER_PAGE;
962
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 event->obj = (u64)(unsigned long)iocb->ki_obj.user;
964 event->data = iocb->ki_user_data;
965 event->res = res;
966 event->res2 = res2;
967
Kent Overstreet21b40202013-05-07 16:18:47 -0700968 kunmap_atomic(ev_page);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700969 flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
Kent Overstreet21b40202013-05-07 16:18:47 -0700970
971 pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
Kent Overstreetcaf41672013-05-07 16:18:35 -0700972 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
973 res, res2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
975 /* after flagging the request as done, we
976 * must never even look at it again
977 */
978 smp_wmb(); /* make event visible before updating tail */
979
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700980 ctx->tail = tail;
Kent Overstreet21b40202013-05-07 16:18:47 -0700981
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700982 ring = kmap_atomic(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 ring->tail = tail;
Cong Wange8e3c3d2011-11-25 23:14:27 +0800984 kunmap_atomic(ring);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700985 flush_dcache_page(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Kent Overstreet0460fef2013-05-07 16:18:49 -0700987 spin_unlock_irqrestore(&ctx->completion_lock, flags);
988
Kent Overstreet21b40202013-05-07 16:18:47 -0700989 pr_debug("added to ring %p at [%u]\n", iocb, tail);
Davide Libenzi8d1c98b2008-04-10 21:29:19 -0700990
991 /*
992 * Check if the user asked us to deliver the result through an
993 * eventfd. The eventfd_signal() function is safe to be called
994 * from IRQ context.
995 */
Davide Libenzi87c3a862009-03-18 17:04:19 -0700996 if (iocb->ki_eventfd != NULL)
Davide Libenzi8d1c98b2008-04-10 21:29:19 -0700997 eventfd_signal(iocb->ki_eventfd, 1);
998
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 /* everything turned out well, dispose of the aiocb. */
Kent Overstreet57282d82013-05-13 13:42:52 -07001000 kiocb_free(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
Quentin Barnes6cb2a212008-03-19 17:00:39 -07001002 /*
1003 * We have to order our ring_info tail store above and test
1004 * of the wait list below outside the wait lock. This is
1005 * like in wake_up_bit() where clearing a bit has to be
1006 * ordered with the unlocked test.
1007 */
1008 smp_mb();
1009
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 if (waitqueue_active(&ctx->wait))
1011 wake_up(&ctx->wait);
1012
Kent Overstreet36f55882013-05-07 16:18:41 -07001013 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014}
H Hartley Sweeten385773e2009-09-22 16:43:53 -07001015EXPORT_SYMBOL(aio_complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Kent Overstreeta31ad382013-05-07 16:18:45 -07001017/* aio_read_events
1018 * Pull an event off of the ioctx's event ring. Returns the number of
1019 * events fetched
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 */
Kent Overstreeta31ad382013-05-07 16:18:45 -07001021static long aio_read_events_ring(struct kioctx *ctx,
1022 struct io_event __user *event, long nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 struct aio_ring *ring;
Kent Overstreet5ffac122013-05-09 15:36:07 -07001025 unsigned head, tail, pos;
Kent Overstreeta31ad382013-05-07 16:18:45 -07001026 long ret = 0;
1027 int copy_ret;
1028
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001029 mutex_lock(&ctx->ring_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001031 ring = kmap_atomic(ctx->ring_pages[0]);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001032 head = ring->head;
Kent Overstreet5ffac122013-05-09 15:36:07 -07001033 tail = ring->tail;
Kent Overstreeta31ad382013-05-07 16:18:45 -07001034 kunmap_atomic(ring);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Kent Overstreet5ffac122013-05-09 15:36:07 -07001036 pr_debug("h%u t%u m%u\n", head, tail, ctx->nr_events);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001037
Kent Overstreet5ffac122013-05-09 15:36:07 -07001038 if (head == tail)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 goto out;
1040
Kent Overstreeta31ad382013-05-07 16:18:45 -07001041 while (ret < nr) {
1042 long avail;
1043 struct io_event *ev;
1044 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
Kent Overstreet5ffac122013-05-09 15:36:07 -07001046 avail = (head <= tail ? tail : ctx->nr_events) - head;
1047 if (head == tail)
Kent Overstreeta31ad382013-05-07 16:18:45 -07001048 break;
1049
1050 avail = min(avail, nr - ret);
1051 avail = min_t(long, avail, AIO_EVENTS_PER_PAGE -
1052 ((head + AIO_EVENTS_OFFSET) % AIO_EVENTS_PER_PAGE));
1053
1054 pos = head + AIO_EVENTS_OFFSET;
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001055 page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
Kent Overstreeta31ad382013-05-07 16:18:45 -07001056 pos %= AIO_EVENTS_PER_PAGE;
1057
1058 ev = kmap(page);
1059 copy_ret = copy_to_user(event + ret, ev + pos,
1060 sizeof(*ev) * avail);
1061 kunmap(page);
1062
1063 if (unlikely(copy_ret)) {
1064 ret = -EFAULT;
1065 goto out;
1066 }
1067
1068 ret += avail;
1069 head += avail;
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001070 head %= ctx->nr_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001073 ring = kmap_atomic(ctx->ring_pages[0]);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001074 ring->head = head;
Zhao Hongjiang91d80a82013-04-26 11:03:53 +08001075 kunmap_atomic(ring);
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001076 flush_dcache_page(ctx->ring_pages[0]);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001077
Kent Overstreet5ffac122013-05-09 15:36:07 -07001078 pr_debug("%li h%u t%u\n", ret, head, tail);
Kent Overstreet3e845ce2013-05-07 16:18:51 -07001079
Kent Overstreete1bdd5f2013-04-26 10:58:39 +10001080 put_reqs_available(ctx, ret);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001081out:
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001082 mutex_unlock(&ctx->ring_lock);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001083
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 return ret;
1085}
1086
Kent Overstreeta31ad382013-05-07 16:18:45 -07001087static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
1088 struct io_event __user *event, long *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089{
Kent Overstreeta31ad382013-05-07 16:18:45 -07001090 long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Kent Overstreeta31ad382013-05-07 16:18:45 -07001092 if (ret > 0)
1093 *i += ret;
1094
1095 if (unlikely(atomic_read(&ctx->dead)))
1096 ret = -EINVAL;
1097
1098 if (!*i)
1099 *i = ret;
1100
1101 return ret < 0 || *i >= min_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102}
1103
Kent Overstreeta31ad382013-05-07 16:18:45 -07001104static long read_events(struct kioctx *ctx, long min_nr, long nr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 struct io_event __user *event,
1106 struct timespec __user *timeout)
1107{
Kent Overstreeta31ad382013-05-07 16:18:45 -07001108 ktime_t until = { .tv64 = KTIME_MAX };
1109 long ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 if (timeout) {
1112 struct timespec ts;
Kent Overstreeta31ad382013-05-07 16:18:45 -07001113
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
Kent Overstreeta31ad382013-05-07 16:18:45 -07001115 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Kent Overstreeta31ad382013-05-07 16:18:45 -07001117 until = timespec_to_ktime(ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 }
1119
Kent Overstreeta31ad382013-05-07 16:18:45 -07001120 /*
1121 * Note that aio_read_events() is being called as the conditional - i.e.
1122 * we're calling it after prepare_to_wait() has set task state to
1123 * TASK_INTERRUPTIBLE.
1124 *
1125 * But aio_read_events() can block, and if it blocks it's going to flip
1126 * the task state back to TASK_RUNNING.
1127 *
1128 * This should be ok, provided it doesn't flip the state back to
1129 * TASK_RUNNING and return 0 too much - that causes us to spin. That
1130 * will only happen if the mutex_lock() call blocks, and we then find
1131 * the ringbuffer empty. So in practice we should be ok, but it's
1132 * something to be aware of when touching this code.
1133 */
1134 wait_event_interruptible_hrtimeout(ctx->wait,
1135 aio_read_events(ctx, min_nr, nr, event, &ret), until);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136
Kent Overstreeta31ad382013-05-07 16:18:45 -07001137 if (!ret && signal_pending(current))
1138 ret = -EINTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Kent Overstreeta31ad382013-05-07 16:18:45 -07001140 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141}
1142
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143/* sys_io_setup:
1144 * Create an aio_context capable of receiving at least nr_events.
1145 * ctxp must not point to an aio_context that already exists, and
1146 * must be initialized to 0 prior to the call. On successful
1147 * creation of the aio_context, *ctxp is filled in with the resulting
1148 * handle. May fail with -EINVAL if *ctxp is not initialized,
1149 * if the specified nr_events exceeds internal limits. May fail
1150 * with -EAGAIN if the specified nr_events exceeds the user's limit
1151 * of available events. May fail with -ENOMEM if insufficient kernel
1152 * resources are available. May fail with -EFAULT if an invalid
1153 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1154 * implemented.
1155 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001156SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157{
1158 struct kioctx *ioctx = NULL;
1159 unsigned long ctx;
1160 long ret;
1161
1162 ret = get_user(ctx, ctxp);
1163 if (unlikely(ret))
1164 goto out;
1165
1166 ret = -EINVAL;
Zach Brownd55b5fd2005-11-07 00:59:31 -08001167 if (unlikely(ctx || nr_events == 0)) {
1168 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1169 ctx, nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 goto out;
1171 }
1172
1173 ioctx = ioctx_alloc(nr_events);
1174 ret = PTR_ERR(ioctx);
1175 if (!IS_ERR(ioctx)) {
1176 ret = put_user(ioctx->user_id, ctxp);
Al Viroa2e18592012-03-20 16:27:57 -04001177 if (ret)
Benjamin LaHaisedb446a02013-07-30 12:54:40 -04001178 kill_ioctx(current->mm, ioctx);
Kent Overstreet723be6e2013-05-28 15:14:48 -07001179 percpu_ref_put(&ioctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 }
1181
1182out:
1183 return ret;
1184}
1185
1186/* sys_io_destroy:
1187 * Destroy the aio_context specified. May cancel any outstanding
1188 * AIOs and block on completion. Will fail with -ENOSYS if not
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001189 * implemented. May fail with -EINVAL if the context pointed to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 * is invalid.
1191 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001192SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193{
1194 struct kioctx *ioctx = lookup_ioctx(ctx);
1195 if (likely(NULL != ioctx)) {
Benjamin LaHaisedb446a02013-07-30 12:54:40 -04001196 kill_ioctx(current->mm, ioctx);
Kent Overstreet723be6e2013-05-28 15:14:48 -07001197 percpu_ref_put(&ioctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 return 0;
1199 }
1200 pr_debug("EINVAL: io_destroy: invalid context id\n");
1201 return -EINVAL;
1202}
1203
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001204typedef ssize_t (aio_rw_op)(struct kiocb *, const struct iovec *,
1205 unsigned long, loff_t);
1206
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001207static ssize_t aio_setup_vectored_rw(struct kiocb *kiocb,
1208 int rw, char __user *buf,
1209 unsigned long *nr_segs,
1210 struct iovec **iovec,
1211 bool compat)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001212{
1213 ssize_t ret;
1214
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001215 *nr_segs = kiocb->ki_nbytes;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001216
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001217#ifdef CONFIG_COMPAT
1218 if (compat)
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001219 ret = compat_rw_copy_check_uvector(rw,
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001220 (struct compat_iovec __user *)buf,
1221 *nr_segs, 1, *iovec, iovec);
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001222 else
1223#endif
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001224 ret = rw_copy_check_uvector(rw,
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001225 (struct iovec __user *)buf,
1226 *nr_segs, 1, *iovec, iovec);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001227 if (ret < 0)
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001228 return ret;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001229
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001230 /* ki_nbytes now reflect bytes instead of segs */
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001231 kiocb->ki_nbytes = ret;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001232 return 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001233}
1234
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001235static ssize_t aio_setup_single_vector(struct kiocb *kiocb,
1236 int rw, char __user *buf,
1237 unsigned long *nr_segs,
1238 struct iovec *iovec)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001239{
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001240 if (unlikely(!access_ok(!rw, buf, kiocb->ki_nbytes)))
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001241 return -EFAULT;
Linus Torvaldsa70b52e2012-05-21 16:06:20 -07001242
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001243 iovec->iov_base = buf;
1244 iovec->iov_len = kiocb->ki_nbytes;
1245 *nr_segs = 1;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001246 return 0;
1247}
1248
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249/*
1250 * aio_setup_iocb:
1251 * Performs the initial checks and aio retry method
1252 * setup for the kiocb at the time of io submission.
1253 */
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001254static ssize_t aio_run_iocb(struct kiocb *req, unsigned opcode,
1255 char __user *buf, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256{
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001257 struct file *file = req->ki_filp;
1258 ssize_t ret;
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001259 unsigned long nr_segs;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001260 int rw;
1261 fmode_t mode;
1262 aio_rw_op *rw_op;
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001263 struct iovec inline_vec, *iovec = &inline_vec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001265 switch (opcode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 case IOCB_CMD_PREAD:
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001267 case IOCB_CMD_PREADV:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001268 mode = FMODE_READ;
1269 rw = READ;
1270 rw_op = file->f_op->aio_read;
1271 goto rw_common;
1272
1273 case IOCB_CMD_PWRITE:
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001274 case IOCB_CMD_PWRITEV:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001275 mode = FMODE_WRITE;
1276 rw = WRITE;
1277 rw_op = file->f_op->aio_write;
1278 goto rw_common;
1279rw_common:
1280 if (unlikely(!(file->f_mode & mode)))
1281 return -EBADF;
1282
1283 if (!rw_op)
1284 return -EINVAL;
1285
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001286 ret = (opcode == IOCB_CMD_PREADV ||
1287 opcode == IOCB_CMD_PWRITEV)
1288 ? aio_setup_vectored_rw(req, rw, buf, &nr_segs,
1289 &iovec, compat)
1290 : aio_setup_single_vector(req, rw, buf, &nr_segs,
1291 iovec);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001292 if (ret)
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001293 return ret;
1294
1295 ret = rw_verify_area(rw, file, &req->ki_pos, req->ki_nbytes);
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001296 if (ret < 0) {
1297 if (iovec != &inline_vec)
1298 kfree(iovec);
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001299 return ret;
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001300 }
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001301
1302 req->ki_nbytes = ret;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001303
Kent Overstreet73a70752013-05-09 15:03:42 -07001304 /* XXX: move/kill - rw_verify_area()? */
1305 /* This matches the pread()/pwrite() logic */
1306 if (req->ki_pos < 0) {
1307 ret = -EINVAL;
1308 break;
1309 }
1310
1311 if (rw == WRITE)
1312 file_start_write(file);
1313
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001314 ret = rw_op(req, iovec, nr_segs, req->ki_pos);
Kent Overstreet73a70752013-05-09 15:03:42 -07001315
1316 if (rw == WRITE)
1317 file_end_write(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 break;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 case IOCB_CMD_FDSYNC:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001321 if (!file->f_op->aio_fsync)
1322 return -EINVAL;
1323
1324 ret = file->f_op->aio_fsync(req, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 break;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 case IOCB_CMD_FSYNC:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001328 if (!file->f_op->aio_fsync)
1329 return -EINVAL;
1330
1331 ret = file->f_op->aio_fsync(req, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 break;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001333
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 default:
Kent Overstreetcaf41672013-05-07 16:18:35 -07001335 pr_debug("EINVAL: no operation provided\n");
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001336 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 }
1338
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001339 if (iovec != &inline_vec)
1340 kfree(iovec);
1341
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001342 if (ret != -EIOCBQUEUED) {
1343 /*
1344 * There's no easy way to restart the syscall since other AIO's
1345 * may be already running. Just fail this IO with EINTR.
1346 */
1347 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
1348 ret == -ERESTARTNOHAND ||
1349 ret == -ERESTART_RESTARTBLOCK))
1350 ret = -EINTR;
1351 aio_complete(req, ret, 0);
1352 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
1354 return 0;
1355}
1356
Adrian Bunkd5470b52008-04-29 00:58:57 -07001357static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
Kent Overstreeta1c8eae2013-05-07 16:18:53 -07001358 struct iocb *iocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359{
1360 struct kiocb *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 ssize_t ret;
1362
1363 /* enforce forwards compatibility on users */
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001364 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
Kent Overstreetcaf41672013-05-07 16:18:35 -07001365 pr_debug("EINVAL: reserve field set\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 return -EINVAL;
1367 }
1368
1369 /* prevent overflows */
1370 if (unlikely(
1371 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1372 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1373 ((ssize_t)iocb->aio_nbytes < 0)
1374 )) {
1375 pr_debug("EINVAL: io_submit: overflow check\n");
1376 return -EINVAL;
1377 }
1378
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001379 req = aio_get_req(ctx);
Kent Overstreet1d98ebf2013-05-07 16:18:37 -07001380 if (unlikely(!req))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 return -EAGAIN;
Kent Overstreet1d98ebf2013-05-07 16:18:37 -07001382
1383 req->ki_filp = fget(iocb->aio_fildes);
1384 if (unlikely(!req->ki_filp)) {
1385 ret = -EBADF;
1386 goto out_put_req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 }
Kent Overstreet1d98ebf2013-05-07 16:18:37 -07001388
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001389 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1390 /*
1391 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1392 * instance of the file* now. The file descriptor must be
1393 * an eventfd() fd, and will be signaled for each completed
1394 * event using the eventfd_signal() function.
1395 */
Davide Libenzi13389012009-06-30 11:41:11 -07001396 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -07001397 if (IS_ERR(req->ki_eventfd)) {
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001398 ret = PTR_ERR(req->ki_eventfd);
Davide Libenzi87c3a862009-03-18 17:04:19 -07001399 req->ki_eventfd = NULL;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001400 goto out_put_req;
1401 }
1402 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Kent Overstreet8a660892013-05-07 16:19:10 -07001404 ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 if (unlikely(ret)) {
Kent Overstreetcaf41672013-05-07 16:18:35 -07001406 pr_debug("EFAULT: aio_key\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 goto out_put_req;
1408 }
1409
1410 req->ki_obj.user = user_iocb;
1411 req->ki_user_data = iocb->aio_data;
1412 req->ki_pos = iocb->aio_offset;
Kent Overstreet73a70752013-05-09 15:03:42 -07001413 req->ki_nbytes = iocb->aio_nbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001415 ret = aio_run_iocb(req, iocb->aio_lio_opcode,
1416 (char __user *)(unsigned long)iocb->aio_buf,
1417 compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 if (ret)
1419 goto out_put_req;
1420
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422out_put_req:
Kent Overstreete1bdd5f2013-04-26 10:58:39 +10001423 put_reqs_available(ctx, 1);
Kent Overstreet57282d82013-05-13 13:42:52 -07001424 kiocb_free(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 return ret;
1426}
1427
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001428long do_io_submit(aio_context_t ctx_id, long nr,
1429 struct iocb __user *__user *iocbpp, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430{
1431 struct kioctx *ctx;
1432 long ret = 0;
Jeff Moyer080d6762011-11-02 13:40:10 -07001433 int i = 0;
Shaohua Li9f5b9422010-07-01 07:55:01 +02001434 struct blk_plug plug;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
1436 if (unlikely(nr < 0))
1437 return -EINVAL;
1438
Jeff Moyer75e1c702010-09-10 14:16:00 -07001439 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1440 nr = LONG_MAX/sizeof(*iocbpp);
1441
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1443 return -EFAULT;
1444
1445 ctx = lookup_ioctx(ctx_id);
1446 if (unlikely(!ctx)) {
Kent Overstreetcaf41672013-05-07 16:18:35 -07001447 pr_debug("EINVAL: invalid context id\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 return -EINVAL;
1449 }
1450
Shaohua Li9f5b9422010-07-01 07:55:01 +02001451 blk_start_plug(&plug);
1452
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 /*
1454 * AKPM: should this return a partial result if some of the IOs were
1455 * successfully submitted?
1456 */
1457 for (i=0; i<nr; i++) {
1458 struct iocb __user *user_iocb;
1459 struct iocb tmp;
1460
1461 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1462 ret = -EFAULT;
1463 break;
1464 }
1465
1466 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1467 ret = -EFAULT;
1468 break;
1469 }
1470
Kent Overstreeta1c8eae2013-05-07 16:18:53 -07001471 ret = io_submit_one(ctx, user_iocb, &tmp, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 if (ret)
1473 break;
1474 }
Shaohua Li9f5b9422010-07-01 07:55:01 +02001475 blk_finish_plug(&plug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Kent Overstreet723be6e2013-05-28 15:14:48 -07001477 percpu_ref_put(&ctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 return i ? i : ret;
1479}
1480
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001481/* sys_io_submit:
1482 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1483 * the number of iocbs queued. May return -EINVAL if the aio_context
1484 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1485 * *iocbpp[0] is not properly initialized, if the operation specified
1486 * is invalid for the file descriptor in the iocb. May fail with
1487 * -EFAULT if any of the data structures point to invalid data. May
1488 * fail with -EBADF if the file descriptor specified in the first
1489 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1490 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1491 * fail with -ENOSYS if not implemented.
1492 */
1493SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1494 struct iocb __user * __user *, iocbpp)
1495{
1496 return do_io_submit(ctx_id, nr, iocbpp, 0);
1497}
1498
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499/* lookup_kiocb
1500 * Finds a given iocb for cancellation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 */
Adrian Bunk25ee7e32005-04-25 08:18:14 -07001502static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1503 u32 key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
1505 struct list_head *pos;
Zach Brownd00689a2005-11-13 16:07:34 -08001506
1507 assert_spin_locked(&ctx->ctx_lock);
1508
Kent Overstreet8a660892013-05-07 16:19:10 -07001509 if (key != KIOCB_KEY)
1510 return NULL;
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 /* TODO: use a hash or array, this sucks. */
1513 list_for_each(pos, &ctx->active_reqs) {
1514 struct kiocb *kiocb = list_kiocb(pos);
Kent Overstreet8a660892013-05-07 16:19:10 -07001515 if (kiocb->ki_obj.user == iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 return kiocb;
1517 }
1518 return NULL;
1519}
1520
1521/* sys_io_cancel:
1522 * Attempts to cancel an iocb previously passed to io_submit. If
1523 * the operation is successfully cancelled, the resulting event is
1524 * copied into the memory pointed to by result without being placed
1525 * into the completion queue and 0 is returned. May fail with
1526 * -EFAULT if any of the data structures pointed to are invalid.
1527 * May fail with -EINVAL if aio_context specified by ctx_id is
1528 * invalid. May fail with -EAGAIN if the iocb specified was not
1529 * cancelled. Will fail with -ENOSYS if not implemented.
1530 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001531SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1532 struct io_event __user *, result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 struct kioctx *ctx;
1535 struct kiocb *kiocb;
1536 u32 key;
1537 int ret;
1538
1539 ret = get_user(key, &iocb->aio_key);
1540 if (unlikely(ret))
1541 return -EFAULT;
1542
1543 ctx = lookup_ioctx(ctx_id);
1544 if (unlikely(!ctx))
1545 return -EINVAL;
1546
1547 spin_lock_irq(&ctx->ctx_lock);
Kent Overstreet906b9732013-05-07 16:18:31 -07001548
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 kiocb = lookup_kiocb(ctx, iocb, key);
Kent Overstreet906b9732013-05-07 16:18:31 -07001550 if (kiocb)
Kent Overstreetbec68faa2013-05-13 14:45:08 -07001551 ret = kiocb_cancel(ctx, kiocb);
Kent Overstreet906b9732013-05-07 16:18:31 -07001552 else
1553 ret = -EINVAL;
1554
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 spin_unlock_irq(&ctx->ctx_lock);
1556
Kent Overstreet906b9732013-05-07 16:18:31 -07001557 if (!ret) {
Kent Overstreetbec68faa2013-05-13 14:45:08 -07001558 /*
1559 * The result argument is no longer used - the io_event is
1560 * always delivered via the ring buffer. -EINPROGRESS indicates
1561 * cancellation is progress:
Kent Overstreet906b9732013-05-07 16:18:31 -07001562 */
Kent Overstreetbec68faa2013-05-13 14:45:08 -07001563 ret = -EINPROGRESS;
Kent Overstreet906b9732013-05-07 16:18:31 -07001564 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Kent Overstreet723be6e2013-05-28 15:14:48 -07001566 percpu_ref_put(&ctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
1568 return ret;
1569}
1570
1571/* io_getevents:
1572 * Attempts to read at least min_nr events and up to nr events from
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001573 * the completion queue for the aio_context specified by ctx_id. If
1574 * it succeeds, the number of read events is returned. May fail with
1575 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1576 * out of range, if timeout is out of range. May fail with -EFAULT
1577 * if any of the memory specified is invalid. May return 0 or
1578 * < min_nr if the timeout specified by timeout has elapsed
1579 * before sufficient events are available, where timeout == NULL
1580 * specifies an infinite timeout. Note that the timeout pointed to by
Jeff Moyer69008072013-05-24 15:55:24 -07001581 * timeout is relative. Will fail with -ENOSYS if not implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001583SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1584 long, min_nr,
1585 long, nr,
1586 struct io_event __user *, events,
1587 struct timespec __user *, timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588{
1589 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1590 long ret = -EINVAL;
1591
1592 if (likely(ioctx)) {
Namhyung Kim2e410252011-01-12 17:01:08 -08001593 if (likely(min_nr <= nr && min_nr >= 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 ret = read_events(ioctx, min_nr, nr, events, timeout);
Kent Overstreet723be6e2013-05-28 15:14:48 -07001595 percpu_ref_put(&ioctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 return ret;
1598}