blob: efa708b29054fe5cecf629dea4e7e54421ac04a6 [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 Overstreete34ecee2013-10-10 19:31:47 -070083 struct percpu_ref reqs;
84
Kent Overstreet4e179bc2013-05-07 16:18:33 -070085 unsigned long user_id;
Kent Overstreet4e179bc2013-05-07 16:18:33 -070086
Kent Overstreete1bdd5f2013-04-26 10:58:39 +100087 struct __percpu kioctx_cpu *cpu;
88
89 /*
90 * For percpu reqs_available, number of slots we move to/from global
91 * counter at a time:
92 */
93 unsigned req_batch;
Kent Overstreet3e845ce2013-05-07 16:18:51 -070094 /*
95 * This is what userspace passed to io_setup(), it's not used for
96 * anything but counting against the global max_reqs quota.
97 *
Kent Overstreet58c85dc2013-05-07 16:18:55 -070098 * The real limit is nr_events - 1, which will be larger (see
Kent Overstreet3e845ce2013-05-07 16:18:51 -070099 * aio_setup_ring())
100 */
Kent Overstreet4e179bc2013-05-07 16:18:33 -0700101 unsigned max_reqs;
102
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700103 /* Size of ringbuffer, in units of struct io_event */
104 unsigned nr_events;
Kent Overstreet4e179bc2013-05-07 16:18:33 -0700105
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700106 unsigned long mmap_base;
107 unsigned long mmap_size;
108
109 struct page **ring_pages;
110 long nr_pages;
111
Kent Overstreet723be6e2013-05-28 15:14:48 -0700112 struct work_struct free_work;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700113
114 struct {
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000115 /*
116 * This counts the number of available slots in the ringbuffer,
117 * so we avoid overflowing it: it's decremented (if positive)
118 * when allocating a kiocb and incremented when the resulting
119 * io_event is pulled off the ringbuffer.
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000120 *
121 * We batch accesses to it with a percpu version.
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000122 */
123 atomic_t reqs_available;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700124 } ____cacheline_aligned_in_smp;
125
126 struct {
127 spinlock_t ctx_lock;
128 struct list_head active_reqs; /* used for cancellation */
129 } ____cacheline_aligned_in_smp;
130
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700131 struct {
132 struct mutex ring_lock;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700133 wait_queue_head_t wait;
134 } ____cacheline_aligned_in_smp;
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700135
136 struct {
137 unsigned tail;
138 spinlock_t completion_lock;
Kent Overstreet4e23bca2013-05-07 16:18:56 -0700139 } ____cacheline_aligned_in_smp;
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700140
141 struct page *internal_pages[AIO_RING_PAGES];
Gu Zheng36bc08c2013-07-16 17:56:16 +0800142 struct file *aio_ring_file;
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400143
144 unsigned id;
Kent Overstreet4e179bc2013-05-07 16:18:33 -0700145};
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/*------ sysctl variables----*/
Zach Brownd55b5fd2005-11-07 00:59:31 -0800148static DEFINE_SPINLOCK(aio_nr_lock);
149unsigned long aio_nr; /* current system wide number of aio requests */
150unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/*----end sysctl variables---*/
152
Christoph Lametere18b8902006-12-06 20:33:20 -0800153static struct kmem_cache *kiocb_cachep;
154static struct kmem_cache *kioctx_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400156static struct vfsmount *aio_mnt;
157
158static const struct file_operations aio_ring_fops;
159static const struct address_space_operations aio_ctx_aops;
160
161static struct file *aio_private_file(struct kioctx *ctx, loff_t nr_pages)
162{
163 struct qstr this = QSTR_INIT("[aio]", 5);
164 struct file *file;
165 struct path path;
166 struct inode *inode = alloc_anon_inode(aio_mnt->mnt_sb);
Dan Carpenter7f626562013-11-13 10:49:40 +0300167 if (IS_ERR(inode))
168 return ERR_CAST(inode);
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400169
170 inode->i_mapping->a_ops = &aio_ctx_aops;
171 inode->i_mapping->private_data = ctx;
172 inode->i_size = PAGE_SIZE * nr_pages;
173
174 path.dentry = d_alloc_pseudo(aio_mnt->mnt_sb, &this);
175 if (!path.dentry) {
176 iput(inode);
177 return ERR_PTR(-ENOMEM);
178 }
179 path.mnt = mntget(aio_mnt);
180
181 d_instantiate(path.dentry, inode);
182 file = alloc_file(&path, FMODE_READ | FMODE_WRITE, &aio_ring_fops);
183 if (IS_ERR(file)) {
184 path_put(&path);
185 return file;
186 }
187
188 file->f_flags = O_RDWR;
189 file->private_data = ctx;
190 return file;
191}
192
193static struct dentry *aio_mount(struct file_system_type *fs_type,
194 int flags, const char *dev_name, void *data)
195{
196 static const struct dentry_operations ops = {
197 .d_dname = simple_dname,
198 };
199 return mount_pseudo(fs_type, "aio:", NULL, &ops, 0xa10a10a1);
200}
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202/* aio_setup
203 * Creates the slab caches used by the aio routines, panic on
204 * failure as this is done early during the boot sequence.
205 */
206static int __init aio_setup(void)
207{
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400208 static struct file_system_type aio_fs = {
209 .name = "aio",
210 .mount = aio_mount,
211 .kill_sb = kill_anon_super,
212 };
213 aio_mnt = kern_mount(&aio_fs);
214 if (IS_ERR(aio_mnt))
215 panic("Failed to create aio fs mount.");
216
Christoph Lameter0a31bd52007-05-06 14:49:57 -0700217 kiocb_cachep = KMEM_CACHE(kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
218 kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Kent Overstreetcaf41672013-05-07 16:18:35 -0700220 pr_debug("sizeof(struct page) = %zu\n", sizeof(struct page));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222 return 0;
223}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700224__initcall(aio_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400226static void put_aio_ring_file(struct kioctx *ctx)
227{
228 struct file *aio_ring_file = ctx->aio_ring_file;
229 if (aio_ring_file) {
230 truncate_setsize(aio_ring_file->f_inode, 0);
231
232 /* Prevent further access to the kioctx from migratepages */
233 spin_lock(&aio_ring_file->f_inode->i_mapping->private_lock);
234 aio_ring_file->f_inode->i_mapping->private_data = NULL;
235 ctx->aio_ring_file = NULL;
236 spin_unlock(&aio_ring_file->f_inode->i_mapping->private_lock);
237
238 fput(aio_ring_file);
239 }
240}
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242static void aio_free_ring(struct kioctx *ctx)
243{
Gu Zheng36bc08c2013-07-16 17:56:16 +0800244 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Gu Zheng36bc08c2013-07-16 17:56:16 +0800246 for (i = 0; i < ctx->nr_pages; i++) {
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500247 struct page *page;
Gu Zheng36bc08c2013-07-16 17:56:16 +0800248 pr_debug("pid(%d) [%d] page->count=%d\n", current->pid, i,
249 page_count(ctx->ring_pages[i]));
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500250 page = ctx->ring_pages[i];
251 if (!page)
252 continue;
253 ctx->ring_pages[i] = NULL;
254 put_page(page);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800255 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400257 put_aio_ring_file(ctx);
258
Sasha Levinddb8c452013-11-19 17:33:03 -0500259 if (ctx->ring_pages && ctx->ring_pages != ctx->internal_pages) {
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700260 kfree(ctx->ring_pages);
Sasha Levinddb8c452013-11-19 17:33:03 -0500261 ctx->ring_pages = NULL;
262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
264
Gu Zheng36bc08c2013-07-16 17:56:16 +0800265static int aio_ring_mmap(struct file *file, struct vm_area_struct *vma)
266{
267 vma->vm_ops = &generic_file_vm_ops;
268 return 0;
269}
270
271static const struct file_operations aio_ring_fops = {
272 .mmap = aio_ring_mmap,
273};
274
275static int aio_set_page_dirty(struct page *page)
276{
277 return 0;
278}
279
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400280#if IS_ENABLED(CONFIG_MIGRATION)
Gu Zheng36bc08c2013-07-16 17:56:16 +0800281static int aio_migratepage(struct address_space *mapping, struct page *new,
282 struct page *old, enum migrate_mode mode)
283{
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400284 struct kioctx *ctx;
Gu Zheng36bc08c2013-07-16 17:56:16 +0800285 unsigned long flags;
Gu Zheng36bc08c2013-07-16 17:56:16 +0800286 int rc;
287
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500288 rc = 0;
289
290 /* Make sure the old page hasn't already been changed */
291 spin_lock(&mapping->private_lock);
292 ctx = mapping->private_data;
293 if (ctx) {
294 pgoff_t idx;
295 spin_lock_irqsave(&ctx->completion_lock, flags);
296 idx = old->index;
297 if (idx < (pgoff_t)ctx->nr_pages) {
298 if (ctx->ring_pages[idx] != old)
299 rc = -EAGAIN;
300 } else
301 rc = -EINVAL;
302 spin_unlock_irqrestore(&ctx->completion_lock, flags);
303 } else
304 rc = -EINVAL;
305 spin_unlock(&mapping->private_lock);
306
307 if (rc != 0)
308 return rc;
309
Gu Zheng36bc08c2013-07-16 17:56:16 +0800310 /* Writeback must be complete */
311 BUG_ON(PageWriteback(old));
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500312 get_page(new);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800313
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500314 rc = migrate_page_move_mapping(mapping, new, old, NULL, mode, 1);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800315 if (rc != MIGRATEPAGE_SUCCESS) {
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500316 put_page(new);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800317 return rc;
318 }
319
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400320 /* We can potentially race against kioctx teardown here. Use the
321 * address_space's private data lock to protect the mapping's
322 * private_data.
323 */
324 spin_lock(&mapping->private_lock);
325 ctx = mapping->private_data;
326 if (ctx) {
327 pgoff_t idx;
328 spin_lock_irqsave(&ctx->completion_lock, flags);
329 migrate_page_copy(new, old);
330 idx = old->index;
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500331 if (idx < (pgoff_t)ctx->nr_pages) {
332 /* And only do the move if things haven't changed */
333 if (ctx->ring_pages[idx] == old)
334 ctx->ring_pages[idx] = new;
335 else
336 rc = -EAGAIN;
337 } else
338 rc = -EINVAL;
Benjamin LaHaise5e9ae2e2013-09-26 20:34:51 -0400339 spin_unlock_irqrestore(&ctx->completion_lock, flags);
340 } else
341 rc = -EBUSY;
342 spin_unlock(&mapping->private_lock);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800343
Benjamin LaHaise8e321fe2013-12-21 17:56:08 -0500344 if (rc == MIGRATEPAGE_SUCCESS)
345 put_page(old);
346 else
347 put_page(new);
348
Gu Zheng36bc08c2013-07-16 17:56:16 +0800349 return rc;
350}
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400351#endif
Gu Zheng36bc08c2013-07-16 17:56:16 +0800352
353static const struct address_space_operations aio_ctx_aops = {
354 .set_page_dirty = aio_set_page_dirty,
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400355#if IS_ENABLED(CONFIG_MIGRATION)
Gu Zheng36bc08c2013-07-16 17:56:16 +0800356 .migratepage = aio_migratepage,
Benjamin LaHaise0c453552013-07-17 09:34:24 -0400357#endif
Gu Zheng36bc08c2013-07-16 17:56:16 +0800358};
359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360static int aio_setup_ring(struct kioctx *ctx)
361{
362 struct aio_ring *ring;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 unsigned nr_events = ctx->max_reqs;
Zach Brown41003a72013-05-07 16:18:25 -0700364 struct mm_struct *mm = current->mm;
Michel Lespinasse41badc12013-02-22 16:32:47 -0800365 unsigned long size, populate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 int nr_pages;
Gu Zheng36bc08c2013-07-16 17:56:16 +0800367 int i;
368 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
370 /* Compensate for the ring buffer's head/tail overlap entry */
371 nr_events += 2; /* 1 is required, 2 for good luck */
372
373 size = sizeof(struct aio_ring);
374 size += sizeof(struct io_event) * nr_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Gu Zheng36bc08c2013-07-16 17:56:16 +0800376 nr_pages = PFN_UP(size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 if (nr_pages < 0)
378 return -EINVAL;
379
Benjamin LaHaise71ad7492013-09-17 10:18:25 -0400380 file = aio_private_file(ctx, nr_pages);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800381 if (IS_ERR(file)) {
382 ctx->aio_ring_file = NULL;
383 return -EAGAIN;
384 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Gu Zheng36bc08c2013-07-16 17:56:16 +0800386 for (i = 0; i < nr_pages; i++) {
387 struct page *page;
388 page = find_or_create_page(file->f_inode->i_mapping,
389 i, GFP_HIGHUSER | __GFP_ZERO);
390 if (!page)
391 break;
392 pr_debug("pid(%d) page[%d]->count=%d\n",
393 current->pid, i, page_count(page));
394 SetPageUptodate(page);
395 SetPageDirty(page);
396 unlock_page(page);
397 }
398 ctx->aio_ring_file = file;
399 nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring))
400 / sizeof(struct io_event);
401
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700402 ctx->ring_pages = ctx->internal_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 if (nr_pages > AIO_RING_PAGES) {
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700404 ctx->ring_pages = kcalloc(nr_pages, sizeof(struct page *),
405 GFP_KERNEL);
Gu Zhengd1b94322013-12-04 18:19:06 +0800406 if (!ctx->ring_pages) {
407 put_aio_ring_file(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 return -ENOMEM;
Gu Zhengd1b94322013-12-04 18:19:06 +0800409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 }
411
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700412 ctx->mmap_size = nr_pages * PAGE_SIZE;
413 pr_debug("attempting mmap of %lu bytes\n", ctx->mmap_size);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800414
Zach Brown41003a72013-05-07 16:18:25 -0700415 down_write(&mm->mmap_sem);
Gu Zheng36bc08c2013-07-16 17:56:16 +0800416 ctx->mmap_base = do_mmap_pgoff(ctx->aio_ring_file, 0, ctx->mmap_size,
417 PROT_READ | PROT_WRITE,
418 MAP_SHARED | MAP_POPULATE, 0, &populate);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700419 if (IS_ERR((void *)ctx->mmap_base)) {
Zach Brown41003a72013-05-07 16:18:25 -0700420 up_write(&mm->mmap_sem);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700421 ctx->mmap_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 aio_free_ring(ctx);
423 return -EAGAIN;
424 }
425
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700426 pr_debug("mmap address: 0x%08lx\n", ctx->mmap_base);
Benjamin LaHaised6c355c2013-09-09 11:57:59 -0400427
428 /* We must do this while still holding mmap_sem for write, as we
429 * need to be protected against userspace attempting to mremap()
430 * or munmap() the ring buffer.
431 */
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700432 ctx->nr_pages = get_user_pages(current, mm, ctx->mmap_base, nr_pages,
433 1, 0, ctx->ring_pages, NULL);
Benjamin LaHaised6c355c2013-09-09 11:57:59 -0400434
435 /* Dropping the reference here is safe as the page cache will hold
436 * onto the pages for us. It is also required so that page migration
437 * can unmap the pages and get the right reference count.
438 */
Gu Zheng36bc08c2013-07-16 17:56:16 +0800439 for (i = 0; i < ctx->nr_pages; i++)
440 put_page(ctx->ring_pages[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
Benjamin LaHaised6c355c2013-09-09 11:57:59 -0400442 up_write(&mm->mmap_sem);
443
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700444 if (unlikely(ctx->nr_pages != nr_pages)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 aio_free_ring(ctx);
446 return -EAGAIN;
447 }
448
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700449 ctx->user_id = ctx->mmap_base;
450 ctx->nr_events = nr_events; /* trusted copy */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700452 ring = kmap_atomic(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 ring->nr = nr_events; /* user copy */
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400454 ring->id = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 ring->head = ring->tail = 0;
456 ring->magic = AIO_RING_MAGIC;
457 ring->compat_features = AIO_RING_COMPAT_FEATURES;
458 ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
459 ring->header_length = sizeof(struct aio_ring);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800460 kunmap_atomic(ring);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700461 flush_dcache_page(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 return 0;
464}
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466#define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
467#define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
468#define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
469
Kent Overstreet0460fef2013-05-07 16:18:49 -0700470void kiocb_set_cancel_fn(struct kiocb *req, kiocb_cancel_fn *cancel)
471{
472 struct kioctx *ctx = req->ki_ctx;
473 unsigned long flags;
474
475 spin_lock_irqsave(&ctx->ctx_lock, flags);
476
477 if (!req->ki_list.next)
478 list_add(&req->ki_list, &ctx->active_reqs);
479
480 req->ki_cancel = cancel;
481
482 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
483}
484EXPORT_SYMBOL(kiocb_set_cancel_fn);
485
Kent Overstreetbec68faa2013-05-13 14:45:08 -0700486static int kiocb_cancel(struct kioctx *ctx, struct kiocb *kiocb)
Kent Overstreet906b9732013-05-07 16:18:31 -0700487{
Kent Overstreet0460fef2013-05-07 16:18:49 -0700488 kiocb_cancel_fn *old, *cancel;
Kent Overstreet906b9732013-05-07 16:18:31 -0700489
Kent Overstreet0460fef2013-05-07 16:18:49 -0700490 /*
491 * Don't want to set kiocb->ki_cancel = KIOCB_CANCELLED unless it
492 * actually has a cancel function, hence the cmpxchg()
493 */
Kent Overstreet906b9732013-05-07 16:18:31 -0700494
Kent Overstreet0460fef2013-05-07 16:18:49 -0700495 cancel = ACCESS_ONCE(kiocb->ki_cancel);
496 do {
497 if (!cancel || cancel == KIOCB_CANCELLED)
Kent Overstreet57282d82013-05-13 13:42:52 -0700498 return -EINVAL;
Kent Overstreet906b9732013-05-07 16:18:31 -0700499
Kent Overstreet0460fef2013-05-07 16:18:49 -0700500 old = cancel;
501 cancel = cmpxchg(&kiocb->ki_cancel, old, KIOCB_CANCELLED);
502 } while (cancel != old);
503
Kent Overstreet57282d82013-05-13 13:42:52 -0700504 return cancel(kiocb);
Kent Overstreet906b9732013-05-07 16:18:31 -0700505}
506
Kent Overstreete34ecee2013-10-10 19:31:47 -0700507static void free_ioctx(struct work_struct *work)
Kent Overstreet36f55882013-05-07 16:18:41 -0700508{
Kent Overstreete34ecee2013-10-10 19:31:47 -0700509 struct kioctx *ctx = container_of(work, struct kioctx, free_work);
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000510
Kent Overstreete34ecee2013-10-10 19:31:47 -0700511 pr_debug("freeing %p\n", ctx);
512
513 aio_free_ring(ctx);
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000514 free_percpu(ctx->cpu);
Kent Overstreet36f55882013-05-07 16:18:41 -0700515 kmem_cache_free(kioctx_cachep, ctx);
516}
517
Kent Overstreete34ecee2013-10-10 19:31:47 -0700518static void free_ioctx_reqs(struct percpu_ref *ref)
519{
520 struct kioctx *ctx = container_of(ref, struct kioctx, reqs);
521
522 INIT_WORK(&ctx->free_work, free_ioctx);
523 schedule_work(&ctx->free_work);
524}
525
Kent Overstreet36f55882013-05-07 16:18:41 -0700526/*
527 * When this function runs, the kioctx has been removed from the "hash table"
528 * and ctx->users has dropped to 0, so we know no more kiocbs can be submitted -
529 * now it's safe to cancel any that need to be.
530 */
Kent Overstreete34ecee2013-10-10 19:31:47 -0700531static void free_ioctx_users(struct percpu_ref *ref)
Kent Overstreet36f55882013-05-07 16:18:41 -0700532{
Kent Overstreete34ecee2013-10-10 19:31:47 -0700533 struct kioctx *ctx = container_of(ref, struct kioctx, users);
Kent Overstreet36f55882013-05-07 16:18:41 -0700534 struct kiocb *req;
535
536 spin_lock_irq(&ctx->ctx_lock);
537
538 while (!list_empty(&ctx->active_reqs)) {
539 req = list_first_entry(&ctx->active_reqs,
540 struct kiocb, ki_list);
541
542 list_del_init(&req->ki_list);
Kent Overstreetbec68faa2013-05-13 14:45:08 -0700543 kiocb_cancel(ctx, req);
Kent Overstreet36f55882013-05-07 16:18:41 -0700544 }
545
546 spin_unlock_irq(&ctx->ctx_lock);
547
Kent Overstreete34ecee2013-10-10 19:31:47 -0700548 percpu_ref_kill(&ctx->reqs);
549 percpu_ref_put(&ctx->reqs);
Kent Overstreet36f55882013-05-07 16:18:41 -0700550}
551
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400552static int ioctx_add_table(struct kioctx *ctx, struct mm_struct *mm)
553{
554 unsigned i, new_nr;
555 struct kioctx_table *table, *old;
556 struct aio_ring *ring;
557
558 spin_lock(&mm->ioctx_lock);
Artem Savkovd9b2c872013-09-09 12:29:35 -0400559 rcu_read_lock();
Benjamin LaHaise77d30b12013-08-30 11:12:50 -0400560 table = rcu_dereference(mm->ioctx_table);
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400561
562 while (1) {
563 if (table)
564 for (i = 0; i < table->nr; i++)
565 if (!table->table[i]) {
566 ctx->id = i;
567 table->table[i] = ctx;
Artem Savkovd9b2c872013-09-09 12:29:35 -0400568 rcu_read_unlock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400569 spin_unlock(&mm->ioctx_lock);
570
571 ring = kmap_atomic(ctx->ring_pages[0]);
572 ring->id = ctx->id;
573 kunmap_atomic(ring);
574 return 0;
575 }
576
577 new_nr = (table ? table->nr : 1) * 4;
578
Artem Savkovd9b2c872013-09-09 12:29:35 -0400579 rcu_read_unlock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400580 spin_unlock(&mm->ioctx_lock);
581
582 table = kzalloc(sizeof(*table) + sizeof(struct kioctx *) *
583 new_nr, GFP_KERNEL);
584 if (!table)
585 return -ENOMEM;
586
587 table->nr = new_nr;
588
589 spin_lock(&mm->ioctx_lock);
Artem Savkovd9b2c872013-09-09 12:29:35 -0400590 rcu_read_lock();
Benjamin LaHaise77d30b12013-08-30 11:12:50 -0400591 old = rcu_dereference(mm->ioctx_table);
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400592
593 if (!old) {
594 rcu_assign_pointer(mm->ioctx_table, table);
595 } else if (table->nr > old->nr) {
596 memcpy(table->table, old->table,
597 old->nr * sizeof(struct kioctx *));
598
599 rcu_assign_pointer(mm->ioctx_table, table);
600 kfree_rcu(old, rcu);
601 } else {
602 kfree(table);
603 table = old;
604 }
605 }
606}
607
Kent Overstreete34ecee2013-10-10 19:31:47 -0700608static void aio_nr_sub(unsigned nr)
609{
610 spin_lock(&aio_nr_lock);
611 if (WARN_ON(aio_nr - nr > aio_nr))
612 aio_nr = 0;
613 else
614 aio_nr -= nr;
615 spin_unlock(&aio_nr_lock);
616}
617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618/* ioctx_alloc
619 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
620 */
621static struct kioctx *ioctx_alloc(unsigned nr_events)
622{
Zach Brown41003a72013-05-07 16:18:25 -0700623 struct mm_struct *mm = current->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 struct kioctx *ctx;
Al Viroe23754f2012-03-06 14:33:22 -0500625 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000627 /*
628 * We keep track of the number of available ringbuffer slots, to prevent
629 * overflow (reqs_available), and we also use percpu counters for this.
630 *
631 * So since up to half the slots might be on other cpu's percpu counters
632 * and unavailable, double nr_events so userspace sees what they
633 * expected: additionally, we move req_batch slots to/from percpu
634 * counters at a time, so make sure that isn't 0:
635 */
636 nr_events = max(nr_events, num_possible_cpus() * 4);
637 nr_events *= 2;
638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 /* Prevent overflows */
640 if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
641 (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
642 pr_debug("ENOMEM: nr_events too high\n");
643 return ERR_PTR(-EINVAL);
644 }
645
Benjamin LaHaise4cd81c32013-07-30 12:06:37 -0400646 if (!nr_events || (unsigned long)nr_events > (aio_max_nr * 2UL))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 return ERR_PTR(-EAGAIN);
648
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800649 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 if (!ctx)
651 return ERR_PTR(-ENOMEM);
652
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 ctx->max_reqs = nr_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Kent Overstreete34ecee2013-10-10 19:31:47 -0700655 if (percpu_ref_init(&ctx->users, free_ioctx_users))
656 goto err;
657
658 if (percpu_ref_init(&ctx->reqs, free_ioctx_reqs))
659 goto err;
Kent Overstreet723be6e2013-05-28 15:14:48 -0700660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 spin_lock_init(&ctx->ctx_lock);
Kent Overstreet0460fef2013-05-07 16:18:49 -0700662 spin_lock_init(&ctx->completion_lock);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700663 mutex_init(&ctx->ring_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 init_waitqueue_head(&ctx->wait);
665
666 INIT_LIST_HEAD(&ctx->active_reqs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000668 ctx->cpu = alloc_percpu(struct kioctx_cpu);
669 if (!ctx->cpu)
Kent Overstreete34ecee2013-10-10 19:31:47 -0700670 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000672 if (aio_setup_ring(ctx) < 0)
Kent Overstreete34ecee2013-10-10 19:31:47 -0700673 goto err;
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000674
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000675 atomic_set(&ctx->reqs_available, ctx->nr_events - 1);
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000676 ctx->req_batch = (ctx->nr_events - 1) / (num_possible_cpus() * 4);
Benjamin LaHaise6878ea72013-07-31 10:34:18 -0400677 if (ctx->req_batch < 1)
678 ctx->req_batch = 1;
Kent Overstreet34e83fc2013-04-26 10:58:39 +1000679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 /* limit the number of system wide aios */
Al Viro9fa1cb32012-03-10 23:14:05 -0500681 spin_lock(&aio_nr_lock);
Benjamin LaHaise4cd81c32013-07-30 12:06:37 -0400682 if (aio_nr + nr_events > (aio_max_nr * 2UL) ||
Al Viro2dd542b2012-03-10 23:10:35 -0500683 aio_nr + nr_events < aio_nr) {
Al Viro9fa1cb32012-03-10 23:14:05 -0500684 spin_unlock(&aio_nr_lock);
Kent Overstreete34ecee2013-10-10 19:31:47 -0700685 err = -EAGAIN;
Gu Zhengd1b94322013-12-04 18:19:06 +0800686 goto err_ctx;
Al Viro2dd542b2012-03-10 23:10:35 -0500687 }
688 aio_nr += ctx->max_reqs;
Al Viro9fa1cb32012-03-10 23:14:05 -0500689 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Benjamin LaHaise18816862013-12-21 15:49:28 -0500691 percpu_ref_get(&ctx->users); /* io_setup() will drop this ref */
692 percpu_ref_get(&ctx->reqs); /* free_ioctx_users() will drop this */
Kent Overstreet723be6e2013-05-28 15:14:48 -0700693
Benjamin LaHaiseda903822013-08-05 13:21:43 -0400694 err = ioctx_add_table(ctx, mm);
695 if (err)
Kent Overstreete34ecee2013-10-10 19:31:47 -0700696 goto err_cleanup;
Benjamin LaHaiseda903822013-08-05 13:21:43 -0400697
Kent Overstreetcaf41672013-05-07 16:18:35 -0700698 pr_debug("allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700699 ctx, ctx->user_id, mm, ctx->nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return ctx;
701
Kent Overstreete34ecee2013-10-10 19:31:47 -0700702err_cleanup:
703 aio_nr_sub(ctx->max_reqs);
Gu Zhengd1b94322013-12-04 18:19:06 +0800704err_ctx:
705 aio_free_ring(ctx);
Kent Overstreete34ecee2013-10-10 19:31:47 -0700706err:
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000707 free_percpu(ctx->cpu);
Kent Overstreete34ecee2013-10-10 19:31:47 -0700708 free_percpu(ctx->reqs.pcpu_count);
Kent Overstreet723be6e2013-05-28 15:14:48 -0700709 free_percpu(ctx->users.pcpu_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 kmem_cache_free(kioctx_cachep, ctx);
Kent Overstreetcaf41672013-05-07 16:18:35 -0700711 pr_debug("error allocating ioctx %d\n", err);
Al Viroe23754f2012-03-06 14:33:22 -0500712 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713}
714
Kent Overstreet36f55882013-05-07 16:18:41 -0700715/* kill_ioctx
716 * Cancels all outstanding aio requests on an aio context. Used
717 * when the processes owning a context have all exited to encourage
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 * the rapid destruction of the kioctx.
719 */
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400720static void kill_ioctx(struct mm_struct *mm, struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721{
Kent Overstreet36f55882013-05-07 16:18:41 -0700722 if (!atomic_xchg(&ctx->dead, 1)) {
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400723 struct kioctx_table *table;
724
725 spin_lock(&mm->ioctx_lock);
Artem Savkovd9b2c872013-09-09 12:29:35 -0400726 rcu_read_lock();
Benjamin LaHaise77d30b12013-08-30 11:12:50 -0400727 table = rcu_dereference(mm->ioctx_table);
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400728
729 WARN_ON(ctx != table->table[ctx->id]);
730 table->table[ctx->id] = NULL;
Artem Savkovd9b2c872013-09-09 12:29:35 -0400731 rcu_read_unlock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400732 spin_unlock(&mm->ioctx_lock);
733
Kent Overstreet723be6e2013-05-28 15:14:48 -0700734 /* percpu_ref_kill() will do the necessary call_rcu() */
735 wake_up_all(&ctx->wait);
Al Viro06af1212012-03-20 16:26:24 -0400736
Kent Overstreet36f55882013-05-07 16:18:41 -0700737 /*
Kent Overstreet4fcc7122013-06-12 14:04:59 -0700738 * It'd be more correct to do this in free_ioctx(), after all
739 * the outstanding kiocbs have finished - but by then io_destroy
740 * has already returned, so io_setup() could potentially return
741 * -EAGAIN with no ioctxs actually in use (as far as userspace
742 * could tell).
Kent Overstreet36f55882013-05-07 16:18:41 -0700743 */
Kent Overstreete34ecee2013-10-10 19:31:47 -0700744 aio_nr_sub(ctx->max_reqs);
Kent Overstreet4fcc7122013-06-12 14:04:59 -0700745
746 if (ctx->mmap_size)
747 vm_munmap(ctx->mmap_base, ctx->mmap_size);
748
Kent Overstreet723be6e2013-05-28 15:14:48 -0700749 percpu_ref_kill(&ctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751}
752
753/* wait_on_sync_kiocb:
754 * Waits on the given sync kiocb to complete.
755 */
Kent Overstreet57282d82013-05-13 13:42:52 -0700756ssize_t wait_on_sync_kiocb(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757{
Kent Overstreet57282d82013-05-13 13:42:52 -0700758 while (!req->ki_ctx) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 set_current_state(TASK_UNINTERRUPTIBLE);
Kent Overstreet57282d82013-05-13 13:42:52 -0700760 if (req->ki_ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 break;
Jeff Moyer41d10da2007-10-16 23:27:20 -0700762 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 }
764 __set_current_state(TASK_RUNNING);
Kent Overstreet57282d82013-05-13 13:42:52 -0700765 return req->ki_user_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700767EXPORT_SYMBOL(wait_on_sync_kiocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Kent Overstreet36f55882013-05-07 16:18:41 -0700769/*
770 * exit_aio: called when the last user of mm goes away. At this point, there is
771 * no way for any new requests to be submited or any of the io_* syscalls to be
772 * called on the context.
773 *
774 * There may be outstanding kiocbs, but free_ioctx() will explicitly wait on
775 * them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800777void exit_aio(struct mm_struct *mm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778{
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400779 struct kioctx_table *table;
Jens Axboeabf137d2008-12-09 08:11:22 +0100780 struct kioctx *ctx;
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400781 unsigned i = 0;
Jens Axboeabf137d2008-12-09 08:11:22 +0100782
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400783 while (1) {
784 rcu_read_lock();
785 table = rcu_dereference(mm->ioctx_table);
786
787 do {
788 if (!table || i >= table->nr) {
789 rcu_read_unlock();
790 rcu_assign_pointer(mm->ioctx_table, NULL);
791 if (table)
792 kfree(table);
793 return;
794 }
795
796 ctx = table->table[i++];
797 } while (!ctx);
798
799 rcu_read_unlock();
800
Al Viro936af152012-04-20 21:49:41 -0400801 /*
802 * We don't need to bother with munmap() here -
803 * exit_mmap(mm) is coming and it'll unmap everything.
804 * Since aio_free_ring() uses non-zero ->mmap_size
805 * as indicator that it needs to unmap the area,
806 * just set it to 0; aio_free_ring() is the only
807 * place that uses ->mmap_size, so it's safe.
Al Viro936af152012-04-20 21:49:41 -0400808 */
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700809 ctx->mmap_size = 0;
Kent Overstreet36f55882013-05-07 16:18:41 -0700810
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400811 kill_ioctx(mm, ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 }
813}
814
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000815static void put_reqs_available(struct kioctx *ctx, unsigned nr)
816{
817 struct kioctx_cpu *kcpu;
818
819 preempt_disable();
820 kcpu = this_cpu_ptr(ctx->cpu);
821
822 kcpu->reqs_available += nr;
823 while (kcpu->reqs_available >= ctx->req_batch * 2) {
824 kcpu->reqs_available -= ctx->req_batch;
825 atomic_add(ctx->req_batch, &ctx->reqs_available);
826 }
827
828 preempt_enable();
829}
830
831static bool get_reqs_available(struct kioctx *ctx)
832{
833 struct kioctx_cpu *kcpu;
834 bool ret = false;
835
836 preempt_disable();
837 kcpu = this_cpu_ptr(ctx->cpu);
838
839 if (!kcpu->reqs_available) {
840 int old, avail = atomic_read(&ctx->reqs_available);
841
842 do {
843 if (avail < ctx->req_batch)
844 goto out;
845
846 old = avail;
847 avail = atomic_cmpxchg(&ctx->reqs_available,
848 avail, avail - ctx->req_batch);
849 } while (avail != old);
850
851 kcpu->reqs_available += ctx->req_batch;
852 }
853
854 ret = true;
855 kcpu->reqs_available--;
856out:
857 preempt_enable();
858 return ret;
859}
860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861/* aio_get_req
Kent Overstreet57282d82013-05-13 13:42:52 -0700862 * Allocate a slot for an aio request.
863 * Returns NULL if no requests are free.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 */
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700865static inline struct kiocb *aio_get_req(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700867 struct kiocb *req;
868
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000869 if (!get_reqs_available(ctx))
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700870 return NULL;
871
Kent Overstreet0460fef2013-05-07 16:18:49 -0700872 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL|__GFP_ZERO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 if (unlikely(!req))
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700874 goto out_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875
Kent Overstreete34ecee2013-10-10 19:31:47 -0700876 percpu_ref_get(&ctx->reqs);
877
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 req->ki_ctx = ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 return req;
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700880out_put:
Kent Overstreete1bdd5f2013-04-26 10:58:39 +1000881 put_reqs_available(ctx, 1);
Kent Overstreeta1c8eae2013-05-07 16:18:53 -0700882 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
884
Kent Overstreet11599eb2013-05-07 16:18:39 -0700885static void kiocb_free(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886{
Kent Overstreet1d98ebf2013-05-07 16:18:37 -0700887 if (req->ki_filp)
888 fput(req->ki_filp);
Davide Libenzi13389012009-06-30 11:41:11 -0700889 if (req->ki_eventfd != NULL)
890 eventfd_ctx_put(req->ki_eventfd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 kmem_cache_free(kiocb_cachep, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892}
893
Adrian Bunkd5470b52008-04-29 00:58:57 -0700894static struct kioctx *lookup_ioctx(unsigned long ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895{
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400896 struct aio_ring __user *ring = (void __user *)ctx_id;
Jens Axboeabf137d2008-12-09 08:11:22 +0100897 struct mm_struct *mm = current->mm;
Jeff Moyer65c24492009-03-18 17:04:21 -0700898 struct kioctx *ctx, *ret = NULL;
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400899 struct kioctx_table *table;
900 unsigned id;
901
902 if (get_user(id, &ring->id))
903 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Jens Axboeabf137d2008-12-09 08:11:22 +0100905 rcu_read_lock();
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400906 table = rcu_dereference(mm->ioctx_table);
Jens Axboeabf137d2008-12-09 08:11:22 +0100907
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400908 if (!table || id >= table->nr)
909 goto out;
910
911 ctx = table->table[id];
Benjamin LaHaisef30d7042013-08-07 18:23:48 -0400912 if (ctx && ctx->user_id == ctx_id) {
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400913 percpu_ref_get(&ctx->users);
914 ret = ctx;
Jens Axboeabf137d2008-12-09 08:11:22 +0100915 }
Benjamin LaHaisedb446a02013-07-30 12:54:40 -0400916out:
Jens Axboeabf137d2008-12-09 08:11:22 +0100917 rcu_read_unlock();
Jeff Moyer65c24492009-03-18 17:04:21 -0700918 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919}
920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921/* aio_complete
922 * Called when the io request on the given iocb is complete.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 */
Kent Overstreet2d684492013-05-07 16:18:29 -0700924void aio_complete(struct kiocb *iocb, long res, long res2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925{
926 struct kioctx *ctx = iocb->ki_ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 struct aio_ring *ring;
Kent Overstreet21b40202013-05-07 16:18:47 -0700928 struct io_event *ev_page, *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 unsigned long flags;
Kent Overstreet21b40202013-05-07 16:18:47 -0700930 unsigned tail, pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
Zach Brown20dcae32005-11-13 16:07:33 -0800932 /*
933 * Special case handling for sync iocbs:
934 * - events go directly into the iocb for fast handling
935 * - the sync task with the iocb in its stack holds the single iocb
936 * ref, no other paths have a way to get another ref
937 * - the sync task helpfully left a reference to itself in the iocb
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 */
939 if (is_sync_kiocb(iocb)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 iocb->ki_user_data = res;
Kent Overstreet57282d82013-05-13 13:42:52 -0700941 smp_wmb();
942 iocb->ki_ctx = ERR_PTR(-EXDEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 wake_up_process(iocb->ki_obj.tsk);
Kent Overstreet2d684492013-05-07 16:18:29 -0700944 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 }
946
Kent Overstreet0460fef2013-05-07 16:18:49 -0700947 if (iocb->ki_list.next) {
948 unsigned long flags;
949
950 spin_lock_irqsave(&ctx->ctx_lock, flags);
951 list_del(&iocb->ki_list);
952 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
953 }
Kent Overstreet11599eb2013-05-07 16:18:39 -0700954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 /*
Kent Overstreet0460fef2013-05-07 16:18:49 -0700956 * Add a completion event to the ring buffer. Must be done holding
Tang Chen4b30f072013-07-03 15:09:16 -0700957 * ctx->completion_lock to prevent other code from messing with the tail
Kent Overstreet0460fef2013-05-07 16:18:49 -0700958 * pointer since we might be called from irq context.
959 */
960 spin_lock_irqsave(&ctx->completion_lock, flags);
961
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700962 tail = ctx->tail;
Kent Overstreet21b40202013-05-07 16:18:47 -0700963 pos = tail + AIO_EVENTS_OFFSET;
964
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700965 if (++tail >= ctx->nr_events)
Ken Chen4bf69b22005-05-01 08:59:15 -0700966 tail = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700968 ev_page = kmap_atomic(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
Kent Overstreet21b40202013-05-07 16:18:47 -0700969 event = ev_page + pos % AIO_EVENTS_PER_PAGE;
970
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 event->obj = (u64)(unsigned long)iocb->ki_obj.user;
972 event->data = iocb->ki_user_data;
973 event->res = res;
974 event->res2 = res2;
975
Kent Overstreet21b40202013-05-07 16:18:47 -0700976 kunmap_atomic(ev_page);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700977 flush_dcache_page(ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE]);
Kent Overstreet21b40202013-05-07 16:18:47 -0700978
979 pr_debug("%p[%u]: %p: %p %Lx %lx %lx\n",
Kent Overstreetcaf41672013-05-07 16:18:35 -0700980 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
981 res, res2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
983 /* after flagging the request as done, we
984 * must never even look at it again
985 */
986 smp_wmb(); /* make event visible before updating tail */
987
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700988 ctx->tail = tail;
Kent Overstreet21b40202013-05-07 16:18:47 -0700989
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700990 ring = kmap_atomic(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 ring->tail = tail;
Cong Wange8e3c3d2011-11-25 23:14:27 +0800992 kunmap_atomic(ring);
Kent Overstreet58c85dc2013-05-07 16:18:55 -0700993 flush_dcache_page(ctx->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
Kent Overstreet0460fef2013-05-07 16:18:49 -0700995 spin_unlock_irqrestore(&ctx->completion_lock, flags);
996
Kent Overstreet21b40202013-05-07 16:18:47 -0700997 pr_debug("added to ring %p at [%u]\n", iocb, tail);
Davide Libenzi8d1c98b2008-04-10 21:29:19 -0700998
999 /*
1000 * Check if the user asked us to deliver the result through an
1001 * eventfd. The eventfd_signal() function is safe to be called
1002 * from IRQ context.
1003 */
Davide Libenzi87c3a862009-03-18 17:04:19 -07001004 if (iocb->ki_eventfd != NULL)
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001005 eventfd_signal(iocb->ki_eventfd, 1);
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 /* everything turned out well, dispose of the aiocb. */
Kent Overstreet57282d82013-05-13 13:42:52 -07001008 kiocb_free(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Quentin Barnes6cb2a212008-03-19 17:00:39 -07001010 /*
1011 * We have to order our ring_info tail store above and test
1012 * of the wait list below outside the wait lock. This is
1013 * like in wake_up_bit() where clearing a bit has to be
1014 * ordered with the unlocked test.
1015 */
1016 smp_mb();
1017
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 if (waitqueue_active(&ctx->wait))
1019 wake_up(&ctx->wait);
1020
Kent Overstreete34ecee2013-10-10 19:31:47 -07001021 percpu_ref_put(&ctx->reqs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022}
H Hartley Sweeten385773e2009-09-22 16:43:53 -07001023EXPORT_SYMBOL(aio_complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Kent Overstreeta31ad382013-05-07 16:18:45 -07001025/* aio_read_events
1026 * Pull an event off of the ioctx's event ring. Returns the number of
1027 * events fetched
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 */
Kent Overstreeta31ad382013-05-07 16:18:45 -07001029static long aio_read_events_ring(struct kioctx *ctx,
1030 struct io_event __user *event, long nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 struct aio_ring *ring;
Kent Overstreet5ffac122013-05-09 15:36:07 -07001033 unsigned head, tail, pos;
Kent Overstreeta31ad382013-05-07 16:18:45 -07001034 long ret = 0;
1035 int copy_ret;
1036
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001037 mutex_lock(&ctx->ring_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001039 ring = kmap_atomic(ctx->ring_pages[0]);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001040 head = ring->head;
Kent Overstreet5ffac122013-05-09 15:36:07 -07001041 tail = ring->tail;
Kent Overstreeta31ad382013-05-07 16:18:45 -07001042 kunmap_atomic(ring);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Kent Overstreet5ffac122013-05-09 15:36:07 -07001044 pr_debug("h%u t%u m%u\n", head, tail, ctx->nr_events);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001045
Kent Overstreet5ffac122013-05-09 15:36:07 -07001046 if (head == tail)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 goto out;
1048
Kent Overstreeta31ad382013-05-07 16:18:45 -07001049 while (ret < nr) {
1050 long avail;
1051 struct io_event *ev;
1052 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053
Kent Overstreet5ffac122013-05-09 15:36:07 -07001054 avail = (head <= tail ? tail : ctx->nr_events) - head;
1055 if (head == tail)
Kent Overstreeta31ad382013-05-07 16:18:45 -07001056 break;
1057
1058 avail = min(avail, nr - ret);
1059 avail = min_t(long, avail, AIO_EVENTS_PER_PAGE -
1060 ((head + AIO_EVENTS_OFFSET) % AIO_EVENTS_PER_PAGE));
1061
1062 pos = head + AIO_EVENTS_OFFSET;
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001063 page = ctx->ring_pages[pos / AIO_EVENTS_PER_PAGE];
Kent Overstreeta31ad382013-05-07 16:18:45 -07001064 pos %= AIO_EVENTS_PER_PAGE;
1065
1066 ev = kmap(page);
1067 copy_ret = copy_to_user(event + ret, ev + pos,
1068 sizeof(*ev) * avail);
1069 kunmap(page);
1070
1071 if (unlikely(copy_ret)) {
1072 ret = -EFAULT;
1073 goto out;
1074 }
1075
1076 ret += avail;
1077 head += avail;
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001078 head %= ctx->nr_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001081 ring = kmap_atomic(ctx->ring_pages[0]);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001082 ring->head = head;
Zhao Hongjiang91d80a82013-04-26 11:03:53 +08001083 kunmap_atomic(ring);
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001084 flush_dcache_page(ctx->ring_pages[0]);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001085
Kent Overstreet5ffac122013-05-09 15:36:07 -07001086 pr_debug("%li h%u t%u\n", ret, head, tail);
Kent Overstreet3e845ce2013-05-07 16:18:51 -07001087
Kent Overstreete1bdd5f2013-04-26 10:58:39 +10001088 put_reqs_available(ctx, ret);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001089out:
Kent Overstreet58c85dc2013-05-07 16:18:55 -07001090 mutex_unlock(&ctx->ring_lock);
Kent Overstreeta31ad382013-05-07 16:18:45 -07001091
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 return ret;
1093}
1094
Kent Overstreeta31ad382013-05-07 16:18:45 -07001095static bool aio_read_events(struct kioctx *ctx, long min_nr, long nr,
1096 struct io_event __user *event, long *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097{
Kent Overstreeta31ad382013-05-07 16:18:45 -07001098 long ret = aio_read_events_ring(ctx, event + *i, nr - *i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Kent Overstreeta31ad382013-05-07 16:18:45 -07001100 if (ret > 0)
1101 *i += ret;
1102
1103 if (unlikely(atomic_read(&ctx->dead)))
1104 ret = -EINVAL;
1105
1106 if (!*i)
1107 *i = ret;
1108
1109 return ret < 0 || *i >= min_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110}
1111
Kent Overstreeta31ad382013-05-07 16:18:45 -07001112static long read_events(struct kioctx *ctx, long min_nr, long nr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 struct io_event __user *event,
1114 struct timespec __user *timeout)
1115{
Kent Overstreeta31ad382013-05-07 16:18:45 -07001116 ktime_t until = { .tv64 = KTIME_MAX };
1117 long ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 if (timeout) {
1120 struct timespec ts;
Kent Overstreeta31ad382013-05-07 16:18:45 -07001121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
Kent Overstreeta31ad382013-05-07 16:18:45 -07001123 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Kent Overstreeta31ad382013-05-07 16:18:45 -07001125 until = timespec_to_ktime(ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 }
1127
Kent Overstreeta31ad382013-05-07 16:18:45 -07001128 /*
1129 * Note that aio_read_events() is being called as the conditional - i.e.
1130 * we're calling it after prepare_to_wait() has set task state to
1131 * TASK_INTERRUPTIBLE.
1132 *
1133 * But aio_read_events() can block, and if it blocks it's going to flip
1134 * the task state back to TASK_RUNNING.
1135 *
1136 * This should be ok, provided it doesn't flip the state back to
1137 * TASK_RUNNING and return 0 too much - that causes us to spin. That
1138 * will only happen if the mutex_lock() call blocks, and we then find
1139 * the ringbuffer empty. So in practice we should be ok, but it's
1140 * something to be aware of when touching this code.
1141 */
1142 wait_event_interruptible_hrtimeout(ctx->wait,
1143 aio_read_events(ctx, min_nr, nr, event, &ret), until);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
Kent Overstreeta31ad382013-05-07 16:18:45 -07001145 if (!ret && signal_pending(current))
1146 ret = -EINTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147
Kent Overstreeta31ad382013-05-07 16:18:45 -07001148 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149}
1150
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151/* sys_io_setup:
1152 * Create an aio_context capable of receiving at least nr_events.
1153 * ctxp must not point to an aio_context that already exists, and
1154 * must be initialized to 0 prior to the call. On successful
1155 * creation of the aio_context, *ctxp is filled in with the resulting
1156 * handle. May fail with -EINVAL if *ctxp is not initialized,
1157 * if the specified nr_events exceeds internal limits. May fail
1158 * with -EAGAIN if the specified nr_events exceeds the user's limit
1159 * of available events. May fail with -ENOMEM if insufficient kernel
1160 * resources are available. May fail with -EFAULT if an invalid
1161 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1162 * implemented.
1163 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001164SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165{
1166 struct kioctx *ioctx = NULL;
1167 unsigned long ctx;
1168 long ret;
1169
1170 ret = get_user(ctx, ctxp);
1171 if (unlikely(ret))
1172 goto out;
1173
1174 ret = -EINVAL;
Zach Brownd55b5fd2005-11-07 00:59:31 -08001175 if (unlikely(ctx || nr_events == 0)) {
1176 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1177 ctx, nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 goto out;
1179 }
1180
1181 ioctx = ioctx_alloc(nr_events);
1182 ret = PTR_ERR(ioctx);
1183 if (!IS_ERR(ioctx)) {
1184 ret = put_user(ioctx->user_id, ctxp);
Al Viroa2e18592012-03-20 16:27:57 -04001185 if (ret)
Benjamin LaHaisedb446a02013-07-30 12:54:40 -04001186 kill_ioctx(current->mm, ioctx);
Kent Overstreet723be6e2013-05-28 15:14:48 -07001187 percpu_ref_put(&ioctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 }
1189
1190out:
1191 return ret;
1192}
1193
1194/* sys_io_destroy:
1195 * Destroy the aio_context specified. May cancel any outstanding
1196 * AIOs and block on completion. Will fail with -ENOSYS if not
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001197 * implemented. May fail with -EINVAL if the context pointed to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 * is invalid.
1199 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001200SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201{
1202 struct kioctx *ioctx = lookup_ioctx(ctx);
1203 if (likely(NULL != ioctx)) {
Benjamin LaHaisedb446a02013-07-30 12:54:40 -04001204 kill_ioctx(current->mm, ioctx);
Kent Overstreet723be6e2013-05-28 15:14:48 -07001205 percpu_ref_put(&ioctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 return 0;
1207 }
1208 pr_debug("EINVAL: io_destroy: invalid context id\n");
1209 return -EINVAL;
1210}
1211
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001212typedef ssize_t (aio_rw_op)(struct kiocb *, const struct iovec *,
1213 unsigned long, loff_t);
1214
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001215static ssize_t aio_setup_vectored_rw(struct kiocb *kiocb,
1216 int rw, char __user *buf,
1217 unsigned long *nr_segs,
1218 struct iovec **iovec,
1219 bool compat)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001220{
1221 ssize_t ret;
1222
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001223 *nr_segs = kiocb->ki_nbytes;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001224
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001225#ifdef CONFIG_COMPAT
1226 if (compat)
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001227 ret = compat_rw_copy_check_uvector(rw,
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001228 (struct compat_iovec __user *)buf,
1229 *nr_segs, 1, *iovec, iovec);
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001230 else
1231#endif
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001232 ret = rw_copy_check_uvector(rw,
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001233 (struct iovec __user *)buf,
1234 *nr_segs, 1, *iovec, iovec);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001235 if (ret < 0)
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001236 return ret;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001237
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001238 /* ki_nbytes now reflect bytes instead of segs */
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001239 kiocb->ki_nbytes = ret;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001240 return 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001241}
1242
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001243static ssize_t aio_setup_single_vector(struct kiocb *kiocb,
1244 int rw, char __user *buf,
1245 unsigned long *nr_segs,
1246 struct iovec *iovec)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001247{
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001248 if (unlikely(!access_ok(!rw, buf, kiocb->ki_nbytes)))
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001249 return -EFAULT;
Linus Torvaldsa70b52e2012-05-21 16:06:20 -07001250
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001251 iovec->iov_base = buf;
1252 iovec->iov_len = kiocb->ki_nbytes;
1253 *nr_segs = 1;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001254 return 0;
1255}
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257/*
1258 * aio_setup_iocb:
1259 * Performs the initial checks and aio retry method
1260 * setup for the kiocb at the time of io submission.
1261 */
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001262static ssize_t aio_run_iocb(struct kiocb *req, unsigned opcode,
1263 char __user *buf, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264{
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001265 struct file *file = req->ki_filp;
1266 ssize_t ret;
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001267 unsigned long nr_segs;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001268 int rw;
1269 fmode_t mode;
1270 aio_rw_op *rw_op;
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001271 struct iovec inline_vec, *iovec = &inline_vec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001273 switch (opcode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 case IOCB_CMD_PREAD:
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001275 case IOCB_CMD_PREADV:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001276 mode = FMODE_READ;
1277 rw = READ;
1278 rw_op = file->f_op->aio_read;
1279 goto rw_common;
1280
1281 case IOCB_CMD_PWRITE:
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001282 case IOCB_CMD_PWRITEV:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001283 mode = FMODE_WRITE;
1284 rw = WRITE;
1285 rw_op = file->f_op->aio_write;
1286 goto rw_common;
1287rw_common:
1288 if (unlikely(!(file->f_mode & mode)))
1289 return -EBADF;
1290
1291 if (!rw_op)
1292 return -EINVAL;
1293
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001294 ret = (opcode == IOCB_CMD_PREADV ||
1295 opcode == IOCB_CMD_PWRITEV)
1296 ? aio_setup_vectored_rw(req, rw, buf, &nr_segs,
1297 &iovec, compat)
1298 : aio_setup_single_vector(req, rw, buf, &nr_segs,
1299 iovec);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001300 if (ret)
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001301 return ret;
1302
1303 ret = rw_verify_area(rw, file, &req->ki_pos, req->ki_nbytes);
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001304 if (ret < 0) {
1305 if (iovec != &inline_vec)
1306 kfree(iovec);
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001307 return ret;
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001308 }
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001309
1310 req->ki_nbytes = ret;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001311
Kent Overstreet73a70752013-05-09 15:03:42 -07001312 /* XXX: move/kill - rw_verify_area()? */
1313 /* This matches the pread()/pwrite() logic */
1314 if (req->ki_pos < 0) {
1315 ret = -EINVAL;
1316 break;
1317 }
1318
1319 if (rw == WRITE)
1320 file_start_write(file);
1321
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001322 ret = rw_op(req, iovec, nr_segs, req->ki_pos);
Kent Overstreet73a70752013-05-09 15:03:42 -07001323
1324 if (rw == WRITE)
1325 file_end_write(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 break;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001327
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 case IOCB_CMD_FDSYNC:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001329 if (!file->f_op->aio_fsync)
1330 return -EINVAL;
1331
1332 ret = file->f_op->aio_fsync(req, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 break;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001334
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 case IOCB_CMD_FSYNC:
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001336 if (!file->f_op->aio_fsync)
1337 return -EINVAL;
1338
1339 ret = file->f_op->aio_fsync(req, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 break;
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001341
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 default:
Kent Overstreetcaf41672013-05-07 16:18:35 -07001343 pr_debug("EINVAL: no operation provided\n");
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001344 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 }
1346
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001347 if (iovec != &inline_vec)
1348 kfree(iovec);
1349
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001350 if (ret != -EIOCBQUEUED) {
1351 /*
1352 * There's no easy way to restart the syscall since other AIO's
1353 * may be already running. Just fail this IO with EINTR.
1354 */
1355 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
1356 ret == -ERESTARTNOHAND ||
1357 ret == -ERESTART_RESTARTBLOCK))
1358 ret = -EINTR;
1359 aio_complete(req, ret, 0);
1360 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
1362 return 0;
1363}
1364
Adrian Bunkd5470b52008-04-29 00:58:57 -07001365static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
Kent Overstreeta1c8eae2013-05-07 16:18:53 -07001366 struct iocb *iocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367{
1368 struct kiocb *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 ssize_t ret;
1370
1371 /* enforce forwards compatibility on users */
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001372 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
Kent Overstreetcaf41672013-05-07 16:18:35 -07001373 pr_debug("EINVAL: reserve field set\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 return -EINVAL;
1375 }
1376
1377 /* prevent overflows */
1378 if (unlikely(
1379 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1380 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1381 ((ssize_t)iocb->aio_nbytes < 0)
1382 )) {
1383 pr_debug("EINVAL: io_submit: overflow check\n");
1384 return -EINVAL;
1385 }
1386
Kent Overstreet41ef4eb2013-05-07 16:19:11 -07001387 req = aio_get_req(ctx);
Kent Overstreet1d98ebf2013-05-07 16:18:37 -07001388 if (unlikely(!req))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 return -EAGAIN;
Kent Overstreet1d98ebf2013-05-07 16:18:37 -07001390
1391 req->ki_filp = fget(iocb->aio_fildes);
1392 if (unlikely(!req->ki_filp)) {
1393 ret = -EBADF;
1394 goto out_put_req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 }
Kent Overstreet1d98ebf2013-05-07 16:18:37 -07001396
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001397 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1398 /*
1399 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1400 * instance of the file* now. The file descriptor must be
1401 * an eventfd() fd, and will be signaled for each completed
1402 * event using the eventfd_signal() function.
1403 */
Davide Libenzi13389012009-06-30 11:41:11 -07001404 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -07001405 if (IS_ERR(req->ki_eventfd)) {
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001406 ret = PTR_ERR(req->ki_eventfd);
Davide Libenzi87c3a862009-03-18 17:04:19 -07001407 req->ki_eventfd = NULL;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001408 goto out_put_req;
1409 }
1410 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Kent Overstreet8a660892013-05-07 16:19:10 -07001412 ret = put_user(KIOCB_KEY, &user_iocb->aio_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 if (unlikely(ret)) {
Kent Overstreetcaf41672013-05-07 16:18:35 -07001414 pr_debug("EFAULT: aio_key\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 goto out_put_req;
1416 }
1417
1418 req->ki_obj.user = user_iocb;
1419 req->ki_user_data = iocb->aio_data;
1420 req->ki_pos = iocb->aio_offset;
Kent Overstreet73a70752013-05-09 15:03:42 -07001421 req->ki_nbytes = iocb->aio_nbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Kent Overstreet8bc92af2013-02-25 16:36:27 -08001423 ret = aio_run_iocb(req, iocb->aio_lio_opcode,
1424 (char __user *)(unsigned long)iocb->aio_buf,
1425 compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 if (ret)
1427 goto out_put_req;
1428
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430out_put_req:
Kent Overstreete1bdd5f2013-04-26 10:58:39 +10001431 put_reqs_available(ctx, 1);
Kent Overstreete34ecee2013-10-10 19:31:47 -07001432 percpu_ref_put(&ctx->reqs);
Kent Overstreet57282d82013-05-13 13:42:52 -07001433 kiocb_free(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 return ret;
1435}
1436
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001437long do_io_submit(aio_context_t ctx_id, long nr,
1438 struct iocb __user *__user *iocbpp, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439{
1440 struct kioctx *ctx;
1441 long ret = 0;
Jeff Moyer080d6762011-11-02 13:40:10 -07001442 int i = 0;
Shaohua Li9f5b9422010-07-01 07:55:01 +02001443 struct blk_plug plug;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
1445 if (unlikely(nr < 0))
1446 return -EINVAL;
1447
Jeff Moyer75e1c702010-09-10 14:16:00 -07001448 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1449 nr = LONG_MAX/sizeof(*iocbpp);
1450
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1452 return -EFAULT;
1453
1454 ctx = lookup_ioctx(ctx_id);
1455 if (unlikely(!ctx)) {
Kent Overstreetcaf41672013-05-07 16:18:35 -07001456 pr_debug("EINVAL: invalid context id\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 return -EINVAL;
1458 }
1459
Shaohua Li9f5b9422010-07-01 07:55:01 +02001460 blk_start_plug(&plug);
1461
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 /*
1463 * AKPM: should this return a partial result if some of the IOs were
1464 * successfully submitted?
1465 */
1466 for (i=0; i<nr; i++) {
1467 struct iocb __user *user_iocb;
1468 struct iocb tmp;
1469
1470 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1471 ret = -EFAULT;
1472 break;
1473 }
1474
1475 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1476 ret = -EFAULT;
1477 break;
1478 }
1479
Kent Overstreeta1c8eae2013-05-07 16:18:53 -07001480 ret = io_submit_one(ctx, user_iocb, &tmp, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 if (ret)
1482 break;
1483 }
Shaohua Li9f5b9422010-07-01 07:55:01 +02001484 blk_finish_plug(&plug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
Kent Overstreet723be6e2013-05-28 15:14:48 -07001486 percpu_ref_put(&ctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 return i ? i : ret;
1488}
1489
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001490/* sys_io_submit:
1491 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1492 * the number of iocbs queued. May return -EINVAL if the aio_context
1493 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1494 * *iocbpp[0] is not properly initialized, if the operation specified
1495 * is invalid for the file descriptor in the iocb. May fail with
1496 * -EFAULT if any of the data structures point to invalid data. May
1497 * fail with -EBADF if the file descriptor specified in the first
1498 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1499 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1500 * fail with -ENOSYS if not implemented.
1501 */
1502SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1503 struct iocb __user * __user *, iocbpp)
1504{
1505 return do_io_submit(ctx_id, nr, iocbpp, 0);
1506}
1507
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508/* lookup_kiocb
1509 * Finds a given iocb for cancellation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 */
Adrian Bunk25ee7e32005-04-25 08:18:14 -07001511static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1512 u32 key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513{
1514 struct list_head *pos;
Zach Brownd00689a2005-11-13 16:07:34 -08001515
1516 assert_spin_locked(&ctx->ctx_lock);
1517
Kent Overstreet8a660892013-05-07 16:19:10 -07001518 if (key != KIOCB_KEY)
1519 return NULL;
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 /* TODO: use a hash or array, this sucks. */
1522 list_for_each(pos, &ctx->active_reqs) {
1523 struct kiocb *kiocb = list_kiocb(pos);
Kent Overstreet8a660892013-05-07 16:19:10 -07001524 if (kiocb->ki_obj.user == iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 return kiocb;
1526 }
1527 return NULL;
1528}
1529
1530/* sys_io_cancel:
1531 * Attempts to cancel an iocb previously passed to io_submit. If
1532 * the operation is successfully cancelled, the resulting event is
1533 * copied into the memory pointed to by result without being placed
1534 * into the completion queue and 0 is returned. May fail with
1535 * -EFAULT if any of the data structures pointed to are invalid.
1536 * May fail with -EINVAL if aio_context specified by ctx_id is
1537 * invalid. May fail with -EAGAIN if the iocb specified was not
1538 * cancelled. Will fail with -ENOSYS if not implemented.
1539 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001540SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1541 struct io_event __user *, result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 struct kioctx *ctx;
1544 struct kiocb *kiocb;
1545 u32 key;
1546 int ret;
1547
1548 ret = get_user(key, &iocb->aio_key);
1549 if (unlikely(ret))
1550 return -EFAULT;
1551
1552 ctx = lookup_ioctx(ctx_id);
1553 if (unlikely(!ctx))
1554 return -EINVAL;
1555
1556 spin_lock_irq(&ctx->ctx_lock);
Kent Overstreet906b9732013-05-07 16:18:31 -07001557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 kiocb = lookup_kiocb(ctx, iocb, key);
Kent Overstreet906b9732013-05-07 16:18:31 -07001559 if (kiocb)
Kent Overstreetbec68faa2013-05-13 14:45:08 -07001560 ret = kiocb_cancel(ctx, kiocb);
Kent Overstreet906b9732013-05-07 16:18:31 -07001561 else
1562 ret = -EINVAL;
1563
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 spin_unlock_irq(&ctx->ctx_lock);
1565
Kent Overstreet906b9732013-05-07 16:18:31 -07001566 if (!ret) {
Kent Overstreetbec68faa2013-05-13 14:45:08 -07001567 /*
1568 * The result argument is no longer used - the io_event is
1569 * always delivered via the ring buffer. -EINPROGRESS indicates
1570 * cancellation is progress:
Kent Overstreet906b9732013-05-07 16:18:31 -07001571 */
Kent Overstreetbec68faa2013-05-13 14:45:08 -07001572 ret = -EINPROGRESS;
Kent Overstreet906b9732013-05-07 16:18:31 -07001573 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Kent Overstreet723be6e2013-05-28 15:14:48 -07001575 percpu_ref_put(&ctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
1577 return ret;
1578}
1579
1580/* io_getevents:
1581 * Attempts to read at least min_nr events and up to nr events from
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001582 * the completion queue for the aio_context specified by ctx_id. If
1583 * it succeeds, the number of read events is returned. May fail with
1584 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1585 * out of range, if timeout is out of range. May fail with -EFAULT
1586 * if any of the memory specified is invalid. May return 0 or
1587 * < min_nr if the timeout specified by timeout has elapsed
1588 * before sufficient events are available, where timeout == NULL
1589 * specifies an infinite timeout. Note that the timeout pointed to by
Jeff Moyer69008072013-05-24 15:55:24 -07001590 * timeout is relative. Will fail with -ENOSYS if not implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001592SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1593 long, min_nr,
1594 long, nr,
1595 struct io_event __user *, events,
1596 struct timespec __user *, timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597{
1598 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1599 long ret = -EINVAL;
1600
1601 if (likely(ioctx)) {
Namhyung Kim2e410252011-01-12 17:01:08 -08001602 if (likely(min_nr <= nr && min_nr >= 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 ret = read_events(ioctx, min_nr, nr, events, timeout);
Kent Overstreet723be6e2013-05-28 15:14:48 -07001604 percpu_ref_put(&ioctx->users);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 return ret;
1607}