blob: 99bd790e8cd253479befd5013d6b38a5781d3927 [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 */
11#include <linux/kernel.h>
12#include <linux/init.h>
13#include <linux/errno.h>
14#include <linux/time.h>
15#include <linux/aio_abi.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050016#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
Jens Axboeb9d128f2009-10-29 13:59:26 +010018#include <linux/backing-dev.h>
Badari Pulavarty027445c2006-09-30 23:28:46 -070019#include <linux/uio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#define DEBUG 0
22
23#include <linux/sched.h>
24#include <linux/fs.h>
25#include <linux/file.h>
26#include <linux/mm.h>
27#include <linux/mman.h>
Michael S. Tsirkin3d2d8272009-09-21 17:03:51 -070028#include <linux/mmu_context.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/slab.h>
30#include <linux/timer.h>
31#include <linux/aio.h>
32#include <linux/highmem.h>
33#include <linux/workqueue.h>
34#include <linux/security.h>
Davide Libenzi9c3060b2007-05-10 22:23:21 -070035#include <linux/eventfd.h>
Jeff Moyercfb1e332009-10-02 18:57:36 -040036#include <linux/blkdev.h>
Jeff Moyer9d85cba72010-05-26 14:44:26 -070037#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39#include <asm/kmap_types.h>
40#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42#if DEBUG > 1
43#define dprintk printk
44#else
45#define dprintk(x...) do { ; } while (0)
46#endif
47
Linus Torvalds1da177e2005-04-16 15:20:36 -070048/*------ sysctl variables----*/
Zach Brownd55b5fd2005-11-07 00:59:31 -080049static DEFINE_SPINLOCK(aio_nr_lock);
50unsigned long aio_nr; /* current system wide number of aio requests */
51unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*----end sysctl variables---*/
53
Christoph Lametere18b8902006-12-06 20:33:20 -080054static struct kmem_cache *kiocb_cachep;
55static struct kmem_cache *kioctx_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57static struct workqueue_struct *aio_wq;
58
59/* Used for rare fput completion. */
David Howells65f27f32006-11-22 14:55:48 +000060static void aio_fput_routine(struct work_struct *);
61static DECLARE_WORK(fput_work, aio_fput_routine);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63static DEFINE_SPINLOCK(fput_lock);
Adrian Bunk25ee7e32005-04-25 08:18:14 -070064static LIST_HEAD(fput_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
David Howells65f27f32006-11-22 14:55:48 +000066static void aio_kick_handler(struct work_struct *);
Sébastien Duguc016e222005-06-28 20:44:59 -070067static void aio_queue_work(struct kioctx *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69/* aio_setup
70 * Creates the slab caches used by the aio routines, panic on
71 * failure as this is done early during the boot sequence.
72 */
73static int __init aio_setup(void)
74{
Christoph Lameter0a31bd52007-05-06 14:49:57 -070075 kiocb_cachep = KMEM_CACHE(kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
76 kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Tejun Heod37adaa2011-01-26 17:42:27 +010078 aio_wq = alloc_workqueue("aio", 0, 1); /* used to limit concurrency */
Jens Axboecf159002011-03-02 20:12:18 -050079 BUG_ON(!aio_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81 pr_debug("aio_setup: sizeof(struct page) = %d\n", (int)sizeof(struct page));
82
83 return 0;
84}
H Hartley Sweeten385773e2009-09-22 16:43:53 -070085__initcall(aio_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87static void aio_free_ring(struct kioctx *ctx)
88{
89 struct aio_ring_info *info = &ctx->ring_info;
90 long i;
91
92 for (i=0; i<info->nr_pages; i++)
93 put_page(info->ring_pages[i]);
94
Linus Torvaldsa46ef992012-04-20 16:20:01 -070095 if (info->mmap_size)
96 vm_munmap(ctx->mm, info->mmap_base, info->mmap_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98 if (info->ring_pages && info->ring_pages != info->internal_pages)
99 kfree(info->ring_pages);
100 info->ring_pages = NULL;
101 info->nr = 0;
102}
103
104static int aio_setup_ring(struct kioctx *ctx)
105{
106 struct aio_ring *ring;
107 struct aio_ring_info *info = &ctx->ring_info;
108 unsigned nr_events = ctx->max_reqs;
109 unsigned long size;
110 int nr_pages;
111
112 /* Compensate for the ring buffer's head/tail overlap entry */
113 nr_events += 2; /* 1 is required, 2 for good luck */
114
115 size = sizeof(struct aio_ring);
116 size += sizeof(struct io_event) * nr_events;
117 nr_pages = (size + PAGE_SIZE-1) >> PAGE_SHIFT;
118
119 if (nr_pages < 0)
120 return -EINVAL;
121
122 nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring)) / sizeof(struct io_event);
123
124 info->nr = 0;
125 info->ring_pages = info->internal_pages;
126 if (nr_pages > AIO_RING_PAGES) {
Oliver Neukum11b0b5a2006-03-25 03:08:13 -0800127 info->ring_pages = kcalloc(nr_pages, sizeof(struct page *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 if (!info->ring_pages)
129 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 }
131
132 info->mmap_size = nr_pages * PAGE_SIZE;
133 dprintk("attempting mmap of %lu bytes\n", info->mmap_size);
134 down_write(&ctx->mm->mmap_sem);
135 info->mmap_base = do_mmap(NULL, 0, info->mmap_size,
Robert P. J. Daye10a4432007-02-10 01:42:56 -0800136 PROT_READ|PROT_WRITE, MAP_ANONYMOUS|MAP_PRIVATE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 0);
138 if (IS_ERR((void *)info->mmap_base)) {
139 up_write(&ctx->mm->mmap_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 info->mmap_size = 0;
141 aio_free_ring(ctx);
142 return -EAGAIN;
143 }
144
145 dprintk("mmap address: 0x%08lx\n", info->mmap_base);
146 info->nr_pages = get_user_pages(current, ctx->mm,
147 info->mmap_base, nr_pages,
148 1, 0, info->ring_pages, NULL);
149 up_write(&ctx->mm->mmap_sem);
150
151 if (unlikely(info->nr_pages != nr_pages)) {
152 aio_free_ring(ctx);
153 return -EAGAIN;
154 }
155
156 ctx->user_id = info->mmap_base;
157
158 info->nr = nr_events; /* trusted copy */
159
Cong Wange8e3c3d2011-11-25 23:14:27 +0800160 ring = kmap_atomic(info->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 ring->nr = nr_events; /* user copy */
162 ring->id = ctx->user_id;
163 ring->head = ring->tail = 0;
164 ring->magic = AIO_RING_MAGIC;
165 ring->compat_features = AIO_RING_COMPAT_FEATURES;
166 ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
167 ring->header_length = sizeof(struct aio_ring);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800168 kunmap_atomic(ring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 return 0;
171}
172
173
174/* aio_ring_event: returns a pointer to the event at the given index from
Cong Wange8e3c3d2011-11-25 23:14:27 +0800175 * kmap_atomic(). Release the pointer with put_aio_ring_event();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 */
177#define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
178#define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
179#define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
180
Cong Wange8e3c3d2011-11-25 23:14:27 +0800181#define aio_ring_event(info, nr) ({ \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 unsigned pos = (nr) + AIO_EVENTS_OFFSET; \
183 struct io_event *__event; \
184 __event = kmap_atomic( \
Cong Wange8e3c3d2011-11-25 23:14:27 +0800185 (info)->ring_pages[pos / AIO_EVENTS_PER_PAGE]); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 __event += pos % AIO_EVENTS_PER_PAGE; \
187 __event; \
188})
189
Cong Wange8e3c3d2011-11-25 23:14:27 +0800190#define put_aio_ring_event(event) do { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 struct io_event *__event = (event); \
192 (void)__event; \
Cong Wange8e3c3d2011-11-25 23:14:27 +0800193 kunmap_atomic((void *)((unsigned long)__event & PAGE_MASK)); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194} while(0)
195
Jens Axboeabf137d2008-12-09 08:11:22 +0100196static void ctx_rcu_free(struct rcu_head *head)
Adrian Bunkd5470b52008-04-29 00:58:57 -0700197{
Jens Axboeabf137d2008-12-09 08:11:22 +0100198 struct kioctx *ctx = container_of(head, struct kioctx, rcu_head);
Adrian Bunkd5470b52008-04-29 00:58:57 -0700199 kmem_cache_free(kioctx_cachep, ctx);
Adrian Bunkd5470b52008-04-29 00:58:57 -0700200}
201
Jens Axboeabf137d2008-12-09 08:11:22 +0100202/* __put_ioctx
203 * Called when the last user of an aio context has gone away,
204 * and the struct needs to be freed.
205 */
206static void __put_ioctx(struct kioctx *ctx)
207{
Al Viro2dd542b2012-03-10 23:10:35 -0500208 unsigned nr_events = ctx->max_reqs;
Jens Axboeabf137d2008-12-09 08:11:22 +0100209 BUG_ON(ctx->reqs_active);
210
Al Virobf507222012-03-11 00:58:40 -0500211 cancel_delayed_work_sync(&ctx->wq);
Jens Axboeabf137d2008-12-09 08:11:22 +0100212 aio_free_ring(ctx);
213 mmdrop(ctx->mm);
214 ctx->mm = NULL;
Al Viro2dd542b2012-03-10 23:10:35 -0500215 if (nr_events) {
216 spin_lock(&aio_nr_lock);
217 BUG_ON(aio_nr - nr_events > aio_nr);
218 aio_nr -= nr_events;
219 spin_unlock(&aio_nr_lock);
220 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100221 pr_debug("__put_ioctx: freeing %p\n", ctx);
222 call_rcu(&ctx->rcu_head, ctx_rcu_free);
223}
224
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800225static inline int try_get_ioctx(struct kioctx *kioctx)
226{
227 return atomic_inc_not_zero(&kioctx->users);
228}
229
230static inline void put_ioctx(struct kioctx *kioctx)
231{
232 BUG_ON(atomic_read(&kioctx->users) <= 0);
233 if (unlikely(atomic_dec_and_test(&kioctx->users)))
234 __put_ioctx(kioctx);
235}
Adrian Bunkd5470b52008-04-29 00:58:57 -0700236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/* ioctx_alloc
238 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
239 */
240static struct kioctx *ioctx_alloc(unsigned nr_events)
241{
242 struct mm_struct *mm;
243 struct kioctx *ctx;
Al Viroe23754f2012-03-06 14:33:22 -0500244 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246 /* Prevent overflows */
247 if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
248 (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
249 pr_debug("ENOMEM: nr_events too high\n");
250 return ERR_PTR(-EINVAL);
251 }
252
Al Viro2dd542b2012-03-10 23:10:35 -0500253 if (!nr_events || (unsigned long)nr_events > aio_max_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 return ERR_PTR(-EAGAIN);
255
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800256 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 if (!ctx)
258 return ERR_PTR(-ENOMEM);
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 ctx->max_reqs = nr_events;
261 mm = ctx->mm = current->mm;
262 atomic_inc(&mm->mm_count);
263
Al Viro86b62a22012-03-07 05:16:35 +0000264 atomic_set(&ctx->users, 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 spin_lock_init(&ctx->ctx_lock);
266 spin_lock_init(&ctx->ring_info.ring_lock);
267 init_waitqueue_head(&ctx->wait);
268
269 INIT_LIST_HEAD(&ctx->active_reqs);
270 INIT_LIST_HEAD(&ctx->run_list);
David Howells65f27f32006-11-22 14:55:48 +0000271 INIT_DELAYED_WORK(&ctx->wq, aio_kick_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273 if (aio_setup_ring(ctx) < 0)
274 goto out_freectx;
275
276 /* limit the number of system wide aios */
Al Viro9fa1cb32012-03-10 23:14:05 -0500277 spin_lock(&aio_nr_lock);
Al Viro2dd542b2012-03-10 23:10:35 -0500278 if (aio_nr + nr_events > aio_max_nr ||
279 aio_nr + nr_events < aio_nr) {
Al Viro9fa1cb32012-03-10 23:14:05 -0500280 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 goto out_cleanup;
Al Viro2dd542b2012-03-10 23:10:35 -0500282 }
283 aio_nr += ctx->max_reqs;
Al Viro9fa1cb32012-03-10 23:14:05 -0500284 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Jeff Moyer39fa0032008-04-29 01:03:48 -0700286 /* now link into global list. */
Jens Axboeabf137d2008-12-09 08:11:22 +0100287 spin_lock(&mm->ioctx_lock);
288 hlist_add_head_rcu(&ctx->list, &mm->ioctx_list);
289 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291 dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
292 ctx, ctx->user_id, current->mm, ctx->ring_info.nr);
293 return ctx;
294
295out_cleanup:
Al Viroe23754f2012-03-06 14:33:22 -0500296 err = -EAGAIN;
297 aio_free_ring(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298out_freectx:
299 mmdrop(mm);
300 kmem_cache_free(kioctx_cachep, ctx);
Al Viroe23754f2012-03-06 14:33:22 -0500301 dprintk("aio: error allocating ioctx %d\n", err);
302 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303}
304
Al Viro06af1212012-03-20 16:26:24 -0400305/* kill_ctx
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 * Cancels all outstanding aio requests on an aio context. Used
307 * when the processes owning a context have all exited to encourage
308 * the rapid destruction of the kioctx.
309 */
Al Viro06af1212012-03-20 16:26:24 -0400310static void kill_ctx(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
312 int (*cancel)(struct kiocb *, struct io_event *);
Al Viro06af1212012-03-20 16:26:24 -0400313 struct task_struct *tsk = current;
314 DECLARE_WAITQUEUE(wait, tsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 struct io_event res;
Al Viro06af1212012-03-20 16:26:24 -0400316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 spin_lock_irq(&ctx->ctx_lock);
318 ctx->dead = 1;
319 while (!list_empty(&ctx->active_reqs)) {
320 struct list_head *pos = ctx->active_reqs.next;
321 struct kiocb *iocb = list_kiocb(pos);
322 list_del_init(&iocb->ki_list);
323 cancel = iocb->ki_cancel;
324 kiocbSetCancelled(iocb);
325 if (cancel) {
326 iocb->ki_users++;
327 spin_unlock_irq(&ctx->ctx_lock);
328 cancel(iocb, &res);
329 spin_lock_irq(&ctx->ctx_lock);
330 }
331 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 if (!ctx->reqs_active)
Ken Chendee11c22007-02-03 01:13:45 -0800334 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336 add_wait_queue(&ctx->wait, &wait);
337 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
338 while (ctx->reqs_active) {
Ken Chendee11c22007-02-03 01:13:45 -0800339 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer41d10da2007-10-16 23:27:20 -0700340 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
Ken Chendee11c22007-02-03 01:13:45 -0800342 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 }
344 __set_task_state(tsk, TASK_RUNNING);
345 remove_wait_queue(&ctx->wait, &wait);
Ken Chendee11c22007-02-03 01:13:45 -0800346
347out:
348 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349}
350
351/* wait_on_sync_kiocb:
352 * Waits on the given sync kiocb to complete.
353 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800354ssize_t wait_on_sync_kiocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355{
356 while (iocb->ki_users) {
357 set_current_state(TASK_UNINTERRUPTIBLE);
358 if (!iocb->ki_users)
359 break;
Jeff Moyer41d10da2007-10-16 23:27:20 -0700360 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 }
362 __set_current_state(TASK_RUNNING);
363 return iocb->ki_user_data;
364}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700365EXPORT_SYMBOL(wait_on_sync_kiocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367/* exit_aio: called when the last user of mm goes away. At this point,
368 * there is no way for any new requests to be submited or any of the
369 * io_* syscalls to be called on the context. However, there may be
370 * outstanding requests which hold references to the context; as they
371 * go away, they will call put_ioctx and release any pinned memory
372 * associated with the request (held via struct page * references).
373 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800374void exit_aio(struct mm_struct *mm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375{
Jens Axboeabf137d2008-12-09 08:11:22 +0100376 struct kioctx *ctx;
377
378 while (!hlist_empty(&mm->ioctx_list)) {
379 ctx = hlist_entry(mm->ioctx_list.first, struct kioctx, list);
380 hlist_del_rcu(&ctx->list);
381
Al Viro06af1212012-03-20 16:26:24 -0400382 kill_ctx(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384 if (1 != atomic_read(&ctx->users))
385 printk(KERN_DEBUG
386 "exit_aio:ioctx still alive: %d %d %d\n",
387 atomic_read(&ctx->users), ctx->dead,
388 ctx->reqs_active);
389 put_ioctx(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 }
391}
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393/* aio_get_req
394 * Allocate a slot for an aio request. Increments the users count
395 * of the kioctx so that the kioctx stays around until all requests are
396 * complete. Returns NULL if no requests are free.
397 *
398 * Returns with kiocb->users set to 2. The io submit code path holds
399 * an extra reference while submitting the i/o.
400 * This prevents races between the aio code path referencing the
401 * req (after submitting it) and aio_complete() freeing the req.
402 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800403static struct kiocb *__aio_get_req(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
405 struct kiocb *req = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
407 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
408 if (unlikely(!req))
409 return NULL;
410
Zach Brown4faa5282005-10-17 16:43:33 -0700411 req->ki_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 req->ki_users = 2;
413 req->ki_key = 0;
414 req->ki_ctx = ctx;
415 req->ki_cancel = NULL;
416 req->ki_retry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 req->ki_dtor = NULL;
418 req->private = NULL;
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700419 req->ki_iovec = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 INIT_LIST_HEAD(&req->ki_run_list);
Davide Libenzi87c3a862009-03-18 17:04:19 -0700421 req->ki_eventfd = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 return req;
424}
425
Jeff Moyer080d6762011-11-02 13:40:10 -0700426/*
427 * struct kiocb's are allocated in batches to reduce the number of
428 * times the ctx lock is acquired and released.
429 */
430#define KIOCB_BATCH_SIZE 32L
431struct kiocb_batch {
432 struct list_head head;
433 long count; /* number of requests left to allocate */
434};
435
436static void kiocb_batch_init(struct kiocb_batch *batch, long total)
437{
438 INIT_LIST_HEAD(&batch->head);
439 batch->count = total;
440}
441
Gleb Natapov69e47472012-01-08 17:07:28 +0200442static void kiocb_batch_free(struct kioctx *ctx, struct kiocb_batch *batch)
Jeff Moyer080d6762011-11-02 13:40:10 -0700443{
444 struct kiocb *req, *n;
445
Gleb Natapov69e47472012-01-08 17:07:28 +0200446 if (list_empty(&batch->head))
447 return;
448
449 spin_lock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700450 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
451 list_del(&req->ki_batch);
Gleb Natapov69e47472012-01-08 17:07:28 +0200452 list_del(&req->ki_list);
Jeff Moyer080d6762011-11-02 13:40:10 -0700453 kmem_cache_free(kiocb_cachep, req);
Gleb Natapov69e47472012-01-08 17:07:28 +0200454 ctx->reqs_active--;
Jeff Moyer080d6762011-11-02 13:40:10 -0700455 }
Jeff Moyer880641b2012-03-05 14:59:12 -0800456 if (unlikely(!ctx->reqs_active && ctx->dead))
457 wake_up_all(&ctx->wait);
Gleb Natapov69e47472012-01-08 17:07:28 +0200458 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700459}
460
461/*
462 * Allocate a batch of kiocbs. This avoids taking and dropping the
463 * context lock a lot during setup.
464 */
465static int kiocb_batch_refill(struct kioctx *ctx, struct kiocb_batch *batch)
466{
467 unsigned short allocated, to_alloc;
468 long avail;
469 bool called_fput = false;
470 struct kiocb *req, *n;
471 struct aio_ring *ring;
472
473 to_alloc = min(batch->count, KIOCB_BATCH_SIZE);
474 for (allocated = 0; allocated < to_alloc; allocated++) {
475 req = __aio_get_req(ctx);
476 if (!req)
477 /* allocation failed, go with what we've got */
478 break;
479 list_add(&req->ki_batch, &batch->head);
480 }
481
482 if (allocated == 0)
483 goto out;
484
485retry:
486 spin_lock_irq(&ctx->ctx_lock);
487 ring = kmap_atomic(ctx->ring_info.ring_pages[0]);
488
489 avail = aio_ring_avail(&ctx->ring_info, ring) - ctx->reqs_active;
490 BUG_ON(avail < 0);
491 if (avail == 0 && !called_fput) {
492 /*
493 * Handle a potential starvation case. It is possible that
494 * we hold the last reference on a struct file, causing us
495 * to delay the final fput to non-irq context. In this case,
496 * ctx->reqs_active is artificially high. Calling the fput
497 * routine here may free up a slot in the event completion
498 * ring, allowing this allocation to succeed.
499 */
500 kunmap_atomic(ring);
501 spin_unlock_irq(&ctx->ctx_lock);
502 aio_fput_routine(NULL);
503 called_fput = true;
504 goto retry;
505 }
506
507 if (avail < allocated) {
508 /* Trim back the number of requests. */
509 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
510 list_del(&req->ki_batch);
511 kmem_cache_free(kiocb_cachep, req);
512 if (--allocated <= avail)
513 break;
514 }
515 }
516
517 batch->count -= allocated;
518 list_for_each_entry(req, &batch->head, ki_batch) {
519 list_add(&req->ki_list, &ctx->active_reqs);
520 ctx->reqs_active++;
521 }
522
523 kunmap_atomic(ring);
524 spin_unlock_irq(&ctx->ctx_lock);
525
526out:
527 return allocated;
528}
529
530static inline struct kiocb *aio_get_req(struct kioctx *ctx,
531 struct kiocb_batch *batch)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
533 struct kiocb *req;
Jeff Moyer080d6762011-11-02 13:40:10 -0700534
535 if (list_empty(&batch->head))
536 if (kiocb_batch_refill(ctx, batch) == 0)
537 return NULL;
538 req = list_first_entry(&batch->head, struct kiocb, ki_batch);
539 list_del(&req->ki_batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 return req;
541}
542
543static inline void really_put_req(struct kioctx *ctx, struct kiocb *req)
544{
Zach Brownd00689a2005-11-13 16:07:34 -0800545 assert_spin_locked(&ctx->ctx_lock);
546
Davide Libenzi13389012009-06-30 11:41:11 -0700547 if (req->ki_eventfd != NULL)
548 eventfd_ctx_put(req->ki_eventfd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 if (req->ki_dtor)
550 req->ki_dtor(req);
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700551 if (req->ki_iovec != &req->ki_inline_vec)
552 kfree(req->ki_iovec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 kmem_cache_free(kiocb_cachep, req);
554 ctx->reqs_active--;
555
556 if (unlikely(!ctx->reqs_active && ctx->dead))
Roland Dreiere91f90b2011-03-22 16:35:10 -0700557 wake_up_all(&ctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558}
559
David Howells65f27f32006-11-22 14:55:48 +0000560static void aio_fput_routine(struct work_struct *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
562 spin_lock_irq(&fput_lock);
563 while (likely(!list_empty(&fput_head))) {
564 struct kiocb *req = list_kiocb(fput_head.next);
565 struct kioctx *ctx = req->ki_ctx;
566
567 list_del(&req->ki_list);
568 spin_unlock_irq(&fput_lock);
569
Davide Libenzi87c3a862009-03-18 17:04:19 -0700570 /* Complete the fput(s) */
571 if (req->ki_filp != NULL)
Al Virod7065da2010-05-26 15:13:55 -0400572 fput(req->ki_filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
574 /* Link the iocb into the context's free list */
Al Viroc7b28552012-03-08 17:51:19 +0000575 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 spin_lock_irq(&ctx->ctx_lock);
577 really_put_req(ctx, req);
Al Viroc7b28552012-03-08 17:51:19 +0000578 /*
579 * at that point ctx might've been killed, but actual
580 * freeing is RCU'd
581 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 spin_unlock_irq(&ctx->ctx_lock);
Al Viroc7b28552012-03-08 17:51:19 +0000583 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 spin_lock_irq(&fput_lock);
586 }
587 spin_unlock_irq(&fput_lock);
588}
589
590/* __aio_put_req
591 * Returns true if this put was the last user of the request.
592 */
593static int __aio_put_req(struct kioctx *ctx, struct kiocb *req)
594{
Al Viro516e0cc2008-07-26 00:39:17 -0400595 dprintk(KERN_DEBUG "aio_put(%p): f_count=%ld\n",
596 req, atomic_long_read(&req->ki_filp->f_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Zach Brownd00689a2005-11-13 16:07:34 -0800598 assert_spin_locked(&ctx->ctx_lock);
599
Davide Libenzi87c3a862009-03-18 17:04:19 -0700600 req->ki_users--;
Eric Sesterhenn93e06b42006-11-30 05:29:23 +0100601 BUG_ON(req->ki_users < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 if (likely(req->ki_users))
603 return 0;
604 list_del(&req->ki_list); /* remove from active_reqs */
605 req->ki_cancel = NULL;
606 req->ki_retry = NULL;
607
Davide Libenzi87c3a862009-03-18 17:04:19 -0700608 /*
609 * Try to optimize the aio and eventfd file* puts, by avoiding to
Al Virod7065da2010-05-26 15:13:55 -0400610 * schedule work in case it is not final fput() time. In normal cases,
Davide Libenzi87c3a862009-03-18 17:04:19 -0700611 * we would not be holding the last reference to the file*, so
612 * this function will be executed w/out any aio kthread wakeup.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 */
Al Virod7065da2010-05-26 15:13:55 -0400614 if (unlikely(!fput_atomic(req->ki_filp))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 spin_lock(&fput_lock);
616 list_add(&req->ki_list, &fput_head);
617 spin_unlock(&fput_lock);
Tejun Heod37adaa2011-01-26 17:42:27 +0100618 schedule_work(&fput_work);
Davide Libenzi13389012009-06-30 11:41:11 -0700619 } else {
620 req->ki_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 really_put_req(ctx, req);
Davide Libenzi13389012009-06-30 11:41:11 -0700622 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 return 1;
624}
625
626/* aio_put_req
627 * Returns true if this put was the last user of the kiocb,
628 * false if the request is still in use.
629 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800630int aio_put_req(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
632 struct kioctx *ctx = req->ki_ctx;
633 int ret;
634 spin_lock_irq(&ctx->ctx_lock);
635 ret = __aio_put_req(ctx, req);
636 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 return ret;
638}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700639EXPORT_SYMBOL(aio_put_req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Adrian Bunkd5470b52008-04-29 00:58:57 -0700641static struct kioctx *lookup_ioctx(unsigned long ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642{
Jens Axboeabf137d2008-12-09 08:11:22 +0100643 struct mm_struct *mm = current->mm;
Jeff Moyer65c24492009-03-18 17:04:21 -0700644 struct kioctx *ctx, *ret = NULL;
Jens Axboeabf137d2008-12-09 08:11:22 +0100645 struct hlist_node *n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Jens Axboeabf137d2008-12-09 08:11:22 +0100647 rcu_read_lock();
648
649 hlist_for_each_entry_rcu(ctx, n, &mm->ioctx_list, list) {
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800650 /*
651 * RCU protects us against accessing freed memory but
652 * we have to be careful not to get a reference when the
653 * reference count already dropped to 0 (ctx->dead test
654 * is unreliable because of races).
655 */
656 if (ctx->user_id == ctx_id && !ctx->dead && try_get_ioctx(ctx)){
Jeff Moyer65c24492009-03-18 17:04:21 -0700657 ret = ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 break;
659 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100660 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Jens Axboeabf137d2008-12-09 08:11:22 +0100662 rcu_read_unlock();
Jeff Moyer65c24492009-03-18 17:04:21 -0700663 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664}
665
666/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 * Queue up a kiocb to be retried. Assumes that the kiocb
668 * has already been marked as kicked, and places it on
669 * the retry run list for the corresponding ioctx, if it
670 * isn't already queued. Returns 1 if it actually queued
671 * the kiocb (to tell the caller to activate the work
672 * queue to process it), or 0, if it found that it was
673 * already queued.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 */
675static inline int __queue_kicked_iocb(struct kiocb *iocb)
676{
677 struct kioctx *ctx = iocb->ki_ctx;
678
Zach Brownd00689a2005-11-13 16:07:34 -0800679 assert_spin_locked(&ctx->ctx_lock);
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 if (list_empty(&iocb->ki_run_list)) {
682 list_add_tail(&iocb->ki_run_list,
683 &ctx->run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 return 1;
685 }
686 return 0;
687}
688
689/* aio_run_iocb
690 * This is the core aio execution routine. It is
691 * invoked both for initial i/o submission and
692 * subsequent retries via the aio_kick_handler.
693 * Expects to be invoked with iocb->ki_ctx->lock
Andreas Mohrd6e05ed2006-06-26 18:35:02 +0200694 * already held. The lock is released and reacquired
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 * as needed during processing.
696 *
697 * Calls the iocb retry method (already setup for the
698 * iocb on initial submission) for operation specific
699 * handling, but takes care of most of common retry
700 * execution details for a given iocb. The retry method
701 * needs to be non-blocking as far as possible, to avoid
702 * holding up other iocbs waiting to be serviced by the
703 * retry kernel thread.
704 *
705 * The trickier parts in this code have to do with
706 * ensuring that only one retry instance is in progress
707 * for a given iocb at any time. Providing that guarantee
708 * simplifies the coding of individual aio operations as
709 * it avoids various potential races.
710 */
711static ssize_t aio_run_iocb(struct kiocb *iocb)
712{
713 struct kioctx *ctx = iocb->ki_ctx;
714 ssize_t (*retry)(struct kiocb *);
715 ssize_t ret;
716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 if (!(retry = iocb->ki_retry)) {
718 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
719 return 0;
720 }
721
722 /*
723 * We don't want the next retry iteration for this
724 * operation to start until this one has returned and
725 * updated the iocb state. However, wait_queue functions
726 * can trigger a kick_iocb from interrupt context in the
727 * meantime, indicating that data is available for the next
728 * iteration. We want to remember that and enable the
729 * next retry iteration _after_ we are through with
730 * this one.
731 *
732 * So, in order to be able to register a "kick", but
733 * prevent it from being queued now, we clear the kick
734 * flag, but make the kick code *think* that the iocb is
735 * still on the run list until we are actually done.
736 * When we are done with this iteration, we check if
737 * the iocb was kicked in the meantime and if so, queue
738 * it up afresh.
739 */
740
741 kiocbClearKicked(iocb);
742
743 /*
744 * This is so that aio_complete knows it doesn't need to
745 * pull the iocb off the run list (We can't just call
746 * INIT_LIST_HEAD because we don't want a kick_iocb to
747 * queue this on the run list yet)
748 */
749 iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
750 spin_unlock_irq(&ctx->ctx_lock);
751
752 /* Quit retrying if the i/o has been cancelled */
753 if (kiocbIsCancelled(iocb)) {
754 ret = -EINTR;
755 aio_complete(iocb, ret, 0);
756 /* must not access the iocb after this */
757 goto out;
758 }
759
760 /*
761 * Now we are all set to call the retry method in async
Alexey Dobriyan6212e3a2007-10-18 03:04:56 -0700762 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 ret = retry(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Jan Karaa0c42ba2010-09-22 13:05:03 -0700766 if (ret != -EIOCBRETRY && ret != -EIOCBQUEUED) {
767 /*
768 * There's no easy way to restart the syscall since other AIO's
769 * may be already running. Just fail this IO with EINTR.
770 */
771 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
772 ret == -ERESTARTNOHAND || ret == -ERESTART_RESTARTBLOCK))
773 ret = -EINTR;
Zach Brown897f15f2005-09-30 11:58:55 -0700774 aio_complete(iocb, ret, 0);
Jan Karaa0c42ba2010-09-22 13:05:03 -0700775 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776out:
777 spin_lock_irq(&ctx->ctx_lock);
778
779 if (-EIOCBRETRY == ret) {
780 /*
781 * OK, now that we are done with this iteration
782 * and know that there is more left to go,
783 * this is where we let go so that a subsequent
784 * "kick" can start the next iteration
785 */
786
787 /* will make __queue_kicked_iocb succeed from here on */
788 INIT_LIST_HEAD(&iocb->ki_run_list);
789 /* we must queue the next iteration ourselves, if it
790 * has already been kicked */
791 if (kiocbIsKicked(iocb)) {
792 __queue_kicked_iocb(iocb);
Sébastien Duguc016e222005-06-28 20:44:59 -0700793
794 /*
795 * __queue_kicked_iocb will always return 1 here, because
796 * iocb->ki_run_list is empty at this point so it should
797 * be safe to unconditionally queue the context into the
798 * work queue.
799 */
800 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 }
802 }
803 return ret;
804}
805
806/*
807 * __aio_run_iocbs:
808 * Process all pending retries queued on the ioctx
809 * run list.
810 * Assumes it is operating within the aio issuer's mm
Zach Brownd00689a2005-11-13 16:07:34 -0800811 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 */
813static int __aio_run_iocbs(struct kioctx *ctx)
814{
815 struct kiocb *iocb;
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700816 struct list_head run_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Zach Brownd00689a2005-11-13 16:07:34 -0800818 assert_spin_locked(&ctx->ctx_lock);
819
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700820 list_replace_init(&ctx->run_list, &run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 while (!list_empty(&run_list)) {
822 iocb = list_entry(run_list.next, struct kiocb,
823 ki_run_list);
824 list_del(&iocb->ki_run_list);
825 /*
826 * Hold an extra reference while retrying i/o.
827 */
828 iocb->ki_users++; /* grab extra reference */
829 aio_run_iocb(iocb);
Ken Chendee11c22007-02-03 01:13:45 -0800830 __aio_put_req(ctx, iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 if (!list_empty(&ctx->run_list))
833 return 1;
834 return 0;
835}
836
837static void aio_queue_work(struct kioctx * ctx)
838{
839 unsigned long timeout;
840 /*
841 * if someone is waiting, get the work started right
842 * away, otherwise, use a longer delay
843 */
844 smp_mb();
845 if (waitqueue_active(&ctx->wait))
846 timeout = 1;
847 else
848 timeout = HZ/10;
849 queue_delayed_work(aio_wq, &ctx->wq, timeout);
850}
851
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852/*
Jeff Moyerd3486f82011-01-12 17:01:08 -0800853 * aio_run_all_iocbs:
854 * Process all pending retries queued on the ioctx
855 * run list, and keep running them until the list
856 * stays empty.
857 * Assumes it is operating within the aio issuer's mm context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 */
859static inline void aio_run_all_iocbs(struct kioctx *ctx)
860{
861 spin_lock_irq(&ctx->ctx_lock);
862 while (__aio_run_iocbs(ctx))
863 ;
864 spin_unlock_irq(&ctx->ctx_lock);
865}
866
867/*
868 * aio_kick_handler:
869 * Work queue handler triggered to process pending
870 * retries on an ioctx. Takes on the aio issuer's
871 * mm context before running the iocbs, so that
872 * copy_xxx_user operates on the issuer's address
873 * space.
874 * Run on aiod's context.
875 */
David Howells65f27f32006-11-22 14:55:48 +0000876static void aio_kick_handler(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877{
David Howells65f27f32006-11-22 14:55:48 +0000878 struct kioctx *ctx = container_of(work, struct kioctx, wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 mm_segment_t oldfs = get_fs();
Zach Brown1ebb1102006-12-29 16:47:02 -0800880 struct mm_struct *mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 int requeue;
882
883 set_fs(USER_DS);
884 use_mm(ctx->mm);
885 spin_lock_irq(&ctx->ctx_lock);
886 requeue =__aio_run_iocbs(ctx);
Zach Brown1ebb1102006-12-29 16:47:02 -0800887 mm = ctx->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 spin_unlock_irq(&ctx->ctx_lock);
Zach Brown1ebb1102006-12-29 16:47:02 -0800889 unuse_mm(mm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 set_fs(oldfs);
891 /*
Al Viro9fcf03d2012-03-13 22:06:28 -0400892 * we're in a worker thread already; no point using non-zero delay
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 */
894 if (requeue)
David Howells52bad642006-11-22 14:54:01 +0000895 queue_delayed_work(aio_wq, &ctx->wq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896}
897
898
899/*
900 * Called by kick_iocb to queue the kiocb for retry
901 * and if required activate the aio work queue to process
902 * it
903 */
Zach Brown998765e2005-09-30 11:58:54 -0700904static void try_queue_kicked_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905{
906 struct kioctx *ctx = iocb->ki_ctx;
907 unsigned long flags;
908 int run = 0;
909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 spin_lock_irqsave(&ctx->ctx_lock, flags);
Zach Brown998765e2005-09-30 11:58:54 -0700911 /* set this inside the lock so that we can't race with aio_run_iocb()
912 * testing it and putting the iocb on the run list under the lock */
913 if (!kiocbTryKick(iocb))
914 run = __queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Ken Chen644d3a02005-05-01 08:59:15 -0700916 if (run)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918}
919
920/*
921 * kick_iocb:
922 * Called typically from a wait queue callback context
Shaohua Lifac046a2009-12-15 16:47:47 -0800923 * to trigger a retry of the iocb.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 * The retry is usually executed by aio workqueue
925 * threads (See aio_kick_handler).
926 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800927void kick_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928{
929 /* sync iocbs are easy: they can only ever be executing from a
930 * single context. */
931 if (is_sync_kiocb(iocb)) {
932 kiocbSetKicked(iocb);
933 wake_up_process(iocb->ki_obj.tsk);
934 return;
935 }
936
Zach Brown998765e2005-09-30 11:58:54 -0700937 try_queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938}
939EXPORT_SYMBOL(kick_iocb);
940
941/* aio_complete
942 * Called when the io request on the given iocb is complete.
943 * Returns true if this is the last user of the request. The
944 * only other user of the request can be the cancellation code.
945 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800946int aio_complete(struct kiocb *iocb, long res, long res2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947{
948 struct kioctx *ctx = iocb->ki_ctx;
949 struct aio_ring_info *info;
950 struct aio_ring *ring;
951 struct io_event *event;
952 unsigned long flags;
953 unsigned long tail;
954 int ret;
955
Zach Brown20dcae32005-11-13 16:07:33 -0800956 /*
957 * Special case handling for sync iocbs:
958 * - events go directly into the iocb for fast handling
959 * - the sync task with the iocb in its stack holds the single iocb
960 * ref, no other paths have a way to get another ref
961 * - the sync task helpfully left a reference to itself in the iocb
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 */
963 if (is_sync_kiocb(iocb)) {
Zach Brown20dcae32005-11-13 16:07:33 -0800964 BUG_ON(iocb->ki_users != 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 iocb->ki_user_data = res;
Zach Brown20dcae32005-11-13 16:07:33 -0800966 iocb->ki_users = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 wake_up_process(iocb->ki_obj.tsk);
Zach Brown20dcae32005-11-13 16:07:33 -0800968 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 }
970
971 info = &ctx->ring_info;
972
973 /* add a completion event to the ring buffer.
974 * must be done holding ctx->ctx_lock to prevent
975 * other code from messing with the tail
976 * pointer since we might be called from irq
977 * context.
978 */
979 spin_lock_irqsave(&ctx->ctx_lock, flags);
980
981 if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
982 list_del_init(&iocb->ki_run_list);
983
984 /*
985 * cancelled requests don't get events, userland was given one
986 * when the event got cancelled.
987 */
988 if (kiocbIsCancelled(iocb))
989 goto put_rq;
990
Cong Wange8e3c3d2011-11-25 23:14:27 +0800991 ring = kmap_atomic(info->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
993 tail = info->tail;
Cong Wange8e3c3d2011-11-25 23:14:27 +0800994 event = aio_ring_event(info, tail);
Ken Chen4bf69b22005-05-01 08:59:15 -0700995 if (++tail >= info->nr)
996 tail = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
998 event->obj = (u64)(unsigned long)iocb->ki_obj.user;
999 event->data = iocb->ki_user_data;
1000 event->res = res;
1001 event->res2 = res2;
1002
1003 dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
1004 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
1005 res, res2);
1006
1007 /* after flagging the request as done, we
1008 * must never even look at it again
1009 */
1010 smp_wmb(); /* make event visible before updating tail */
1011
1012 info->tail = tail;
1013 ring->tail = tail;
1014
Cong Wange8e3c3d2011-11-25 23:14:27 +08001015 put_aio_ring_event(event);
1016 kunmap_atomic(ring);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
1018 pr_debug("added to ring %p at [%lu]\n", iocb, tail);
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001019
1020 /*
1021 * Check if the user asked us to deliver the result through an
1022 * eventfd. The eventfd_signal() function is safe to be called
1023 * from IRQ context.
1024 */
Davide Libenzi87c3a862009-03-18 17:04:19 -07001025 if (iocb->ki_eventfd != NULL)
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001026 eventfd_signal(iocb->ki_eventfd, 1);
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028put_rq:
1029 /* everything turned out well, dispose of the aiocb. */
1030 ret = __aio_put_req(ctx, iocb);
1031
Quentin Barnes6cb2a212008-03-19 17:00:39 -07001032 /*
1033 * We have to order our ring_info tail store above and test
1034 * of the wait list below outside the wait lock. This is
1035 * like in wake_up_bit() where clearing a bit has to be
1036 * ordered with the unlocked test.
1037 */
1038 smp_mb();
1039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 if (waitqueue_active(&ctx->wait))
1041 wake_up(&ctx->wait);
1042
Ken Chendee11c22007-02-03 01:13:45 -08001043 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 return ret;
1045}
H Hartley Sweeten385773e2009-09-22 16:43:53 -07001046EXPORT_SYMBOL(aio_complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
1048/* aio_read_evt
1049 * Pull an event off of the ioctx's event ring. Returns the number of
1050 * events fetched (0 or 1 ;-)
1051 * FIXME: make this use cmpxchg.
1052 * TODO: make the ringbuffer user mmap()able (requires FIXME).
1053 */
1054static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
1055{
1056 struct aio_ring_info *info = &ioctx->ring_info;
1057 struct aio_ring *ring;
1058 unsigned long head;
1059 int ret = 0;
1060
Cong Wange8e3c3d2011-11-25 23:14:27 +08001061 ring = kmap_atomic(info->ring_pages[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1063 (unsigned long)ring->head, (unsigned long)ring->tail,
1064 (unsigned long)ring->nr);
1065
1066 if (ring->head == ring->tail)
1067 goto out;
1068
1069 spin_lock(&info->ring_lock);
1070
1071 head = ring->head % info->nr;
1072 if (head != ring->tail) {
Cong Wange8e3c3d2011-11-25 23:14:27 +08001073 struct io_event *evp = aio_ring_event(info, head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 *ent = *evp;
1075 head = (head + 1) % info->nr;
1076 smp_mb(); /* finish reading the event before updatng the head */
1077 ring->head = head;
1078 ret = 1;
Cong Wange8e3c3d2011-11-25 23:14:27 +08001079 put_aio_ring_event(evp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 }
1081 spin_unlock(&info->ring_lock);
1082
1083out:
Cong Wange8e3c3d2011-11-25 23:14:27 +08001084 kunmap_atomic(ring);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 dprintk("leaving aio_read_evt: %d h%lu t%lu\n", ret,
1086 (unsigned long)ring->head, (unsigned long)ring->tail);
1087 return ret;
1088}
1089
1090struct aio_timeout {
1091 struct timer_list timer;
1092 int timed_out;
1093 struct task_struct *p;
1094};
1095
1096static void timeout_func(unsigned long data)
1097{
1098 struct aio_timeout *to = (struct aio_timeout *)data;
1099
1100 to->timed_out = 1;
1101 wake_up_process(to->p);
1102}
1103
1104static inline void init_timeout(struct aio_timeout *to)
1105{
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001106 setup_timer_on_stack(&to->timer, timeout_func, (unsigned long) to);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 to->timed_out = 0;
1108 to->p = current;
1109}
1110
1111static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
1112 const struct timespec *ts)
1113{
1114 to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
1115 if (time_after(to->timer.expires, jiffies))
1116 add_timer(&to->timer);
1117 else
1118 to->timed_out = 1;
1119}
1120
1121static inline void clear_timeout(struct aio_timeout *to)
1122{
1123 del_singleshot_timer_sync(&to->timer);
1124}
1125
1126static int read_events(struct kioctx *ctx,
1127 long min_nr, long nr,
1128 struct io_event __user *event,
1129 struct timespec __user *timeout)
1130{
1131 long start_jiffies = jiffies;
1132 struct task_struct *tsk = current;
1133 DECLARE_WAITQUEUE(wait, tsk);
1134 int ret;
1135 int i = 0;
1136 struct io_event ent;
1137 struct aio_timeout to;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 int retry = 0;
1139
1140 /* needed to zero any padding within an entry (there shouldn't be
1141 * any, but C is fun!
1142 */
1143 memset(&ent, 0, sizeof(ent));
1144retry:
1145 ret = 0;
1146 while (likely(i < nr)) {
1147 ret = aio_read_evt(ctx, &ent);
1148 if (unlikely(ret <= 0))
1149 break;
1150
1151 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1152 ent.data, ent.obj, ent.res, ent.res2);
1153
1154 /* Could we split the check in two? */
1155 ret = -EFAULT;
1156 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1157 dprintk("aio: lost an event due to EFAULT.\n");
1158 break;
1159 }
1160 ret = 0;
1161
1162 /* Good, event copied to userland, update counts. */
1163 event ++;
1164 i ++;
1165 }
1166
1167 if (min_nr <= i)
1168 return i;
1169 if (ret)
1170 return ret;
1171
1172 /* End fast path */
1173
1174 /* racey check, but it gets redone */
1175 if (!retry && unlikely(!list_empty(&ctx->run_list))) {
1176 retry = 1;
1177 aio_run_all_iocbs(ctx);
1178 goto retry;
1179 }
1180
1181 init_timeout(&to);
1182 if (timeout) {
1183 struct timespec ts;
1184 ret = -EFAULT;
1185 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1186 goto out;
1187
1188 set_timeout(start_jiffies, &to, &ts);
1189 }
1190
1191 while (likely(i < nr)) {
1192 add_wait_queue_exclusive(&ctx->wait, &wait);
1193 do {
1194 set_task_state(tsk, TASK_INTERRUPTIBLE);
1195 ret = aio_read_evt(ctx, &ent);
1196 if (ret)
1197 break;
1198 if (min_nr <= i)
1199 break;
Jeff Moyere92adcb2008-04-28 02:12:04 -07001200 if (unlikely(ctx->dead)) {
1201 ret = -EINVAL;
1202 break;
1203 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 if (to.timed_out) /* Only check after read evt */
1205 break;
Jeff Moyere00ba3d2007-12-04 23:45:02 -08001206 /* Try to only show up in io wait if there are ops
1207 * in flight */
1208 if (ctx->reqs_active)
1209 io_schedule();
1210 else
1211 schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 if (signal_pending(tsk)) {
1213 ret = -EINTR;
1214 break;
1215 }
1216 /*ret = aio_read_evt(ctx, &ent);*/
1217 } while (1) ;
1218
1219 set_task_state(tsk, TASK_RUNNING);
1220 remove_wait_queue(&ctx->wait, &wait);
1221
1222 if (unlikely(ret <= 0))
1223 break;
1224
1225 ret = -EFAULT;
1226 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1227 dprintk("aio: lost an event due to EFAULT.\n");
1228 break;
1229 }
1230
1231 /* Good, event copied to userland, update counts. */
1232 event ++;
1233 i ++;
1234 }
1235
1236 if (timeout)
1237 clear_timeout(&to);
1238out:
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001239 destroy_timer_on_stack(&to.timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 return i ? i : ret;
1241}
1242
1243/* Take an ioctx and remove it from the list of ioctx's. Protects
1244 * against races with itself via ->dead.
1245 */
1246static void io_destroy(struct kioctx *ioctx)
1247{
1248 struct mm_struct *mm = current->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 int was_dead;
1250
1251 /* delete the entry from the list is someone else hasn't already */
Jens Axboeabf137d2008-12-09 08:11:22 +01001252 spin_lock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 was_dead = ioctx->dead;
1254 ioctx->dead = 1;
Jens Axboeabf137d2008-12-09 08:11:22 +01001255 hlist_del_rcu(&ioctx->list);
1256 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257
1258 dprintk("aio_release(%p)\n", ioctx);
1259 if (likely(!was_dead))
1260 put_ioctx(ioctx); /* twice for the list */
1261
Al Viro06af1212012-03-20 16:26:24 -04001262 kill_ctx(ioctx);
Jeff Moyere92adcb2008-04-28 02:12:04 -07001263
1264 /*
1265 * Wake up any waiters. The setting of ctx->dead must be seen
1266 * by other CPUs at this point. Right now, we rely on the
1267 * locking done by the above calls to ensure this consistency.
1268 */
Roland Dreiere91f90b2011-03-22 16:35:10 -07001269 wake_up_all(&ioctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270}
1271
1272/* sys_io_setup:
1273 * Create an aio_context capable of receiving at least nr_events.
1274 * ctxp must not point to an aio_context that already exists, and
1275 * must be initialized to 0 prior to the call. On successful
1276 * creation of the aio_context, *ctxp is filled in with the resulting
1277 * handle. May fail with -EINVAL if *ctxp is not initialized,
1278 * if the specified nr_events exceeds internal limits. May fail
1279 * with -EAGAIN if the specified nr_events exceeds the user's limit
1280 * of available events. May fail with -ENOMEM if insufficient kernel
1281 * resources are available. May fail with -EFAULT if an invalid
1282 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1283 * implemented.
1284 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001285SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286{
1287 struct kioctx *ioctx = NULL;
1288 unsigned long ctx;
1289 long ret;
1290
1291 ret = get_user(ctx, ctxp);
1292 if (unlikely(ret))
1293 goto out;
1294
1295 ret = -EINVAL;
Zach Brownd55b5fd2005-11-07 00:59:31 -08001296 if (unlikely(ctx || nr_events == 0)) {
1297 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1298 ctx, nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 goto out;
1300 }
1301
1302 ioctx = ioctx_alloc(nr_events);
1303 ret = PTR_ERR(ioctx);
1304 if (!IS_ERR(ioctx)) {
1305 ret = put_user(ioctx->user_id, ctxp);
Al Viroa2e18592012-03-20 16:27:57 -04001306 if (ret)
1307 io_destroy(ioctx);
1308 put_ioctx(ioctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 }
1310
1311out:
1312 return ret;
1313}
1314
1315/* sys_io_destroy:
1316 * Destroy the aio_context specified. May cancel any outstanding
1317 * AIOs and block on completion. Will fail with -ENOSYS if not
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001318 * implemented. May fail with -EINVAL if the context pointed to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 * is invalid.
1320 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001321SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322{
1323 struct kioctx *ioctx = lookup_ioctx(ctx);
1324 if (likely(NULL != ioctx)) {
1325 io_destroy(ioctx);
Al Viroa2e18592012-03-20 16:27:57 -04001326 put_ioctx(ioctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 return 0;
1328 }
1329 pr_debug("EINVAL: io_destroy: invalid context id\n");
1330 return -EINVAL;
1331}
1332
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001333static void aio_advance_iovec(struct kiocb *iocb, ssize_t ret)
1334{
1335 struct iovec *iov = &iocb->ki_iovec[iocb->ki_cur_seg];
1336
1337 BUG_ON(ret <= 0);
1338
1339 while (iocb->ki_cur_seg < iocb->ki_nr_segs && ret > 0) {
1340 ssize_t this = min((ssize_t)iov->iov_len, ret);
1341 iov->iov_base += this;
1342 iov->iov_len -= this;
1343 iocb->ki_left -= this;
1344 ret -= this;
1345 if (iov->iov_len == 0) {
1346 iocb->ki_cur_seg++;
1347 iov++;
1348 }
1349 }
1350
1351 /* the caller should not have done more io than what fit in
1352 * the remaining iovecs */
1353 BUG_ON(ret > 0 && iocb->ki_left == 0);
1354}
1355
1356static ssize_t aio_rw_vect_retry(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357{
1358 struct file *file = iocb->ki_filp;
1359 struct address_space *mapping = file->f_mapping;
1360 struct inode *inode = mapping->host;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001361 ssize_t (*rw_op)(struct kiocb *, const struct iovec *,
1362 unsigned long, loff_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 ssize_t ret = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001364 unsigned short opcode;
1365
1366 if ((iocb->ki_opcode == IOCB_CMD_PREADV) ||
1367 (iocb->ki_opcode == IOCB_CMD_PREAD)) {
1368 rw_op = file->f_op->aio_read;
1369 opcode = IOCB_CMD_PREADV;
1370 } else {
1371 rw_op = file->f_op->aio_write;
1372 opcode = IOCB_CMD_PWRITEV;
1373 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Rusty Russellc2ec6682008-02-08 04:20:15 -08001375 /* This matches the pread()/pwrite() logic */
1376 if (iocb->ki_pos < 0)
1377 return -EINVAL;
1378
Zach Brown897f15f2005-09-30 11:58:55 -07001379 do {
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001380 ret = rw_op(iocb, &iocb->ki_iovec[iocb->ki_cur_seg],
1381 iocb->ki_nr_segs - iocb->ki_cur_seg,
1382 iocb->ki_pos);
1383 if (ret > 0)
1384 aio_advance_iovec(iocb, ret);
Badari Pulavarty027445c2006-09-30 23:28:46 -07001385
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001386 /* retry all partial writes. retry partial reads as long as its a
1387 * regular file. */
Zach Brown353fb072005-09-30 11:58:56 -07001388 } while (ret > 0 && iocb->ki_left > 0 &&
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001389 (opcode == IOCB_CMD_PWRITEV ||
1390 (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391
1392 /* This means we must have transferred all that we could */
1393 /* No need to retry anymore */
1394 if ((ret == 0) || (iocb->ki_left == 0))
1395 ret = iocb->ki_nbytes - iocb->ki_left;
1396
Rusty Russell7adfa2f2008-02-08 04:20:14 -08001397 /* If we managed to write some out we return that, rather than
1398 * the eventual error. */
1399 if (opcode == IOCB_CMD_PWRITEV
1400 && ret < 0 && ret != -EIOCBQUEUED && ret != -EIOCBRETRY
1401 && iocb->ki_nbytes - iocb->ki_left)
1402 ret = iocb->ki_nbytes - iocb->ki_left;
1403
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 return ret;
1405}
1406
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407static ssize_t aio_fdsync(struct kiocb *iocb)
1408{
1409 struct file *file = iocb->ki_filp;
1410 ssize_t ret = -EINVAL;
1411
1412 if (file->f_op->aio_fsync)
1413 ret = file->f_op->aio_fsync(iocb, 1);
1414 return ret;
1415}
1416
1417static ssize_t aio_fsync(struct kiocb *iocb)
1418{
1419 struct file *file = iocb->ki_filp;
1420 ssize_t ret = -EINVAL;
1421
1422 if (file->f_op->aio_fsync)
1423 ret = file->f_op->aio_fsync(iocb, 0);
1424 return ret;
1425}
1426
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001427static ssize_t aio_setup_vectored_rw(int type, struct kiocb *kiocb, bool compat)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001428{
1429 ssize_t ret;
1430
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001431#ifdef CONFIG_COMPAT
1432 if (compat)
1433 ret = compat_rw_copy_check_uvector(type,
1434 (struct compat_iovec __user *)kiocb->ki_buf,
1435 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001436 &kiocb->ki_iovec, 1);
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001437 else
1438#endif
1439 ret = rw_copy_check_uvector(type,
1440 (struct iovec __user *)kiocb->ki_buf,
1441 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001442 &kiocb->ki_iovec, 1);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001443 if (ret < 0)
1444 goto out;
1445
1446 kiocb->ki_nr_segs = kiocb->ki_nbytes;
1447 kiocb->ki_cur_seg = 0;
1448 /* ki_nbytes/left now reflect bytes instead of segs */
1449 kiocb->ki_nbytes = ret;
1450 kiocb->ki_left = ret;
1451
1452 ret = 0;
1453out:
1454 return ret;
1455}
1456
1457static ssize_t aio_setup_single_vector(struct kiocb *kiocb)
1458{
1459 kiocb->ki_iovec = &kiocb->ki_inline_vec;
1460 kiocb->ki_iovec->iov_base = kiocb->ki_buf;
1461 kiocb->ki_iovec->iov_len = kiocb->ki_left;
1462 kiocb->ki_nr_segs = 1;
1463 kiocb->ki_cur_seg = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001464 return 0;
1465}
1466
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467/*
1468 * aio_setup_iocb:
1469 * Performs the initial checks and aio retry method
1470 * setup for the kiocb at the time of io submission.
1471 */
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001472static ssize_t aio_setup_iocb(struct kiocb *kiocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473{
1474 struct file *file = kiocb->ki_filp;
1475 ssize_t ret = 0;
1476
1477 switch (kiocb->ki_opcode) {
1478 case IOCB_CMD_PREAD:
1479 ret = -EBADF;
1480 if (unlikely(!(file->f_mode & FMODE_READ)))
1481 break;
1482 ret = -EFAULT;
1483 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1484 kiocb->ki_left)))
1485 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001486 ret = security_file_permission(file, MAY_READ);
1487 if (unlikely(ret))
1488 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001489 ret = aio_setup_single_vector(kiocb);
1490 if (ret)
1491 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 ret = -EINVAL;
1493 if (file->f_op->aio_read)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001494 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 break;
1496 case IOCB_CMD_PWRITE:
1497 ret = -EBADF;
1498 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1499 break;
1500 ret = -EFAULT;
1501 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1502 kiocb->ki_left)))
1503 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001504 ret = security_file_permission(file, MAY_WRITE);
1505 if (unlikely(ret))
1506 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001507 ret = aio_setup_single_vector(kiocb);
1508 if (ret)
1509 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 ret = -EINVAL;
1511 if (file->f_op->aio_write)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001512 kiocb->ki_retry = aio_rw_vect_retry;
1513 break;
1514 case IOCB_CMD_PREADV:
1515 ret = -EBADF;
1516 if (unlikely(!(file->f_mode & FMODE_READ)))
1517 break;
1518 ret = security_file_permission(file, MAY_READ);
1519 if (unlikely(ret))
1520 break;
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001521 ret = aio_setup_vectored_rw(READ, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001522 if (ret)
1523 break;
1524 ret = -EINVAL;
1525 if (file->f_op->aio_read)
1526 kiocb->ki_retry = aio_rw_vect_retry;
1527 break;
1528 case IOCB_CMD_PWRITEV:
1529 ret = -EBADF;
1530 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1531 break;
1532 ret = security_file_permission(file, MAY_WRITE);
1533 if (unlikely(ret))
1534 break;
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001535 ret = aio_setup_vectored_rw(WRITE, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001536 if (ret)
1537 break;
1538 ret = -EINVAL;
1539 if (file->f_op->aio_write)
1540 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 break;
1542 case IOCB_CMD_FDSYNC:
1543 ret = -EINVAL;
1544 if (file->f_op->aio_fsync)
1545 kiocb->ki_retry = aio_fdsync;
1546 break;
1547 case IOCB_CMD_FSYNC:
1548 ret = -EINVAL;
1549 if (file->f_op->aio_fsync)
1550 kiocb->ki_retry = aio_fsync;
1551 break;
1552 default:
1553 dprintk("EINVAL: io_submit: no operation provided\n");
1554 ret = -EINVAL;
1555 }
1556
1557 if (!kiocb->ki_retry)
1558 return ret;
1559
1560 return 0;
1561}
1562
Adrian Bunkd5470b52008-04-29 00:58:57 -07001563static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
Jeff Moyer080d6762011-11-02 13:40:10 -07001564 struct iocb *iocb, struct kiocb_batch *batch,
1565 bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566{
1567 struct kiocb *req;
1568 struct file *file;
1569 ssize_t ret;
1570
1571 /* enforce forwards compatibility on users */
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001572 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 pr_debug("EINVAL: io_submit: reserve field set\n");
1574 return -EINVAL;
1575 }
1576
1577 /* prevent overflows */
1578 if (unlikely(
1579 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1580 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1581 ((ssize_t)iocb->aio_nbytes < 0)
1582 )) {
1583 pr_debug("EINVAL: io_submit: overflow check\n");
1584 return -EINVAL;
1585 }
1586
1587 file = fget(iocb->aio_fildes);
1588 if (unlikely(!file))
1589 return -EBADF;
1590
Jeff Moyer080d6762011-11-02 13:40:10 -07001591 req = aio_get_req(ctx, batch); /* returns with 2 references to req */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 if (unlikely(!req)) {
1593 fput(file);
1594 return -EAGAIN;
1595 }
Yan Zheng87e28312007-10-08 12:16:20 -07001596 req->ki_filp = file;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001597 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1598 /*
1599 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1600 * instance of the file* now. The file descriptor must be
1601 * an eventfd() fd, and will be signaled for each completed
1602 * event using the eventfd_signal() function.
1603 */
Davide Libenzi13389012009-06-30 11:41:11 -07001604 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -07001605 if (IS_ERR(req->ki_eventfd)) {
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001606 ret = PTR_ERR(req->ki_eventfd);
Davide Libenzi87c3a862009-03-18 17:04:19 -07001607 req->ki_eventfd = NULL;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001608 goto out_put_req;
1609 }
1610 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
Ken Chen212079c2005-05-01 08:59:15 -07001612 ret = put_user(req->ki_key, &user_iocb->aio_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 if (unlikely(ret)) {
1614 dprintk("EFAULT: aio_key\n");
1615 goto out_put_req;
1616 }
1617
1618 req->ki_obj.user = user_iocb;
1619 req->ki_user_data = iocb->aio_data;
1620 req->ki_pos = iocb->aio_offset;
1621
1622 req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1623 req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1624 req->ki_opcode = iocb->aio_lio_opcode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001626 ret = aio_setup_iocb(req, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627
1628 if (ret)
1629 goto out_put_req;
1630
1631 spin_lock_irq(&ctx->ctx_lock);
Jan Kara7137c6bd2011-02-25 14:44:27 -08001632 /*
1633 * We could have raced with io_destroy() and are currently holding a
1634 * reference to ctx which should be destroyed. We cannot submit IO
1635 * since ctx gets freed as soon as io_submit() puts its reference. The
1636 * check here is reliable: io_destroy() sets ctx->dead before waiting
1637 * for outstanding IO and the barrier between these two is realized by
1638 * unlock of mm->ioctx_lock and lock of ctx->ctx_lock. Analogously we
1639 * increment ctx->reqs_active before checking for ctx->dead and the
1640 * barrier is realized by unlock and lock of ctx->ctx_lock. Thus if we
1641 * don't see ctx->dead set here, io_destroy() waits for our IO to
1642 * finish.
1643 */
1644 if (ctx->dead) {
1645 spin_unlock_irq(&ctx->ctx_lock);
1646 ret = -EINVAL;
1647 goto out_put_req;
1648 }
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001649 aio_run_iocb(req);
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001650 if (!list_empty(&ctx->run_list)) {
Ken Chen954d3e92005-05-01 08:59:16 -07001651 /* drain the run list */
1652 while (__aio_run_iocbs(ctx))
1653 ;
1654 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyercfb1e332009-10-02 18:57:36 -04001656
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 aio_put_req(req); /* drop extra ref to req */
1658 return 0;
1659
1660out_put_req:
1661 aio_put_req(req); /* drop extra ref to req */
1662 aio_put_req(req); /* drop i/o ref to req */
1663 return ret;
1664}
1665
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001666long do_io_submit(aio_context_t ctx_id, long nr,
1667 struct iocb __user *__user *iocbpp, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668{
1669 struct kioctx *ctx;
1670 long ret = 0;
Jeff Moyer080d6762011-11-02 13:40:10 -07001671 int i = 0;
Shaohua Li9f5b9422010-07-01 07:55:01 +02001672 struct blk_plug plug;
Jeff Moyer080d6762011-11-02 13:40:10 -07001673 struct kiocb_batch batch;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674
1675 if (unlikely(nr < 0))
1676 return -EINVAL;
1677
Jeff Moyer75e1c702010-09-10 14:16:00 -07001678 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1679 nr = LONG_MAX/sizeof(*iocbpp);
1680
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1682 return -EFAULT;
1683
1684 ctx = lookup_ioctx(ctx_id);
1685 if (unlikely(!ctx)) {
1686 pr_debug("EINVAL: io_submit: invalid context id\n");
1687 return -EINVAL;
1688 }
1689
Jeff Moyer080d6762011-11-02 13:40:10 -07001690 kiocb_batch_init(&batch, nr);
1691
Shaohua Li9f5b9422010-07-01 07:55:01 +02001692 blk_start_plug(&plug);
1693
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 /*
1695 * AKPM: should this return a partial result if some of the IOs were
1696 * successfully submitted?
1697 */
1698 for (i=0; i<nr; i++) {
1699 struct iocb __user *user_iocb;
1700 struct iocb tmp;
1701
1702 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1703 ret = -EFAULT;
1704 break;
1705 }
1706
1707 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1708 ret = -EFAULT;
1709 break;
1710 }
1711
Jeff Moyer080d6762011-11-02 13:40:10 -07001712 ret = io_submit_one(ctx, user_iocb, &tmp, &batch, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 if (ret)
1714 break;
1715 }
Shaohua Li9f5b9422010-07-01 07:55:01 +02001716 blk_finish_plug(&plug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
Gleb Natapov69e47472012-01-08 17:07:28 +02001718 kiocb_batch_free(ctx, &batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 put_ioctx(ctx);
1720 return i ? i : ret;
1721}
1722
Jeff Moyer9d85cba72010-05-26 14:44:26 -07001723/* sys_io_submit:
1724 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1725 * the number of iocbs queued. May return -EINVAL if the aio_context
1726 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1727 * *iocbpp[0] is not properly initialized, if the operation specified
1728 * is invalid for the file descriptor in the iocb. May fail with
1729 * -EFAULT if any of the data structures point to invalid data. May
1730 * fail with -EBADF if the file descriptor specified in the first
1731 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1732 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1733 * fail with -ENOSYS if not implemented.
1734 */
1735SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1736 struct iocb __user * __user *, iocbpp)
1737{
1738 return do_io_submit(ctx_id, nr, iocbpp, 0);
1739}
1740
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741/* lookup_kiocb
1742 * Finds a given iocb for cancellation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 */
Adrian Bunk25ee7e32005-04-25 08:18:14 -07001744static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1745 u32 key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746{
1747 struct list_head *pos;
Zach Brownd00689a2005-11-13 16:07:34 -08001748
1749 assert_spin_locked(&ctx->ctx_lock);
1750
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 /* TODO: use a hash or array, this sucks. */
1752 list_for_each(pos, &ctx->active_reqs) {
1753 struct kiocb *kiocb = list_kiocb(pos);
1754 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1755 return kiocb;
1756 }
1757 return NULL;
1758}
1759
1760/* sys_io_cancel:
1761 * Attempts to cancel an iocb previously passed to io_submit. If
1762 * the operation is successfully cancelled, the resulting event is
1763 * copied into the memory pointed to by result without being placed
1764 * into the completion queue and 0 is returned. May fail with
1765 * -EFAULT if any of the data structures pointed to are invalid.
1766 * May fail with -EINVAL if aio_context specified by ctx_id is
1767 * invalid. May fail with -EAGAIN if the iocb specified was not
1768 * cancelled. Will fail with -ENOSYS if not implemented.
1769 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001770SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1771 struct io_event __user *, result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772{
1773 int (*cancel)(struct kiocb *iocb, struct io_event *res);
1774 struct kioctx *ctx;
1775 struct kiocb *kiocb;
1776 u32 key;
1777 int ret;
1778
1779 ret = get_user(key, &iocb->aio_key);
1780 if (unlikely(ret))
1781 return -EFAULT;
1782
1783 ctx = lookup_ioctx(ctx_id);
1784 if (unlikely(!ctx))
1785 return -EINVAL;
1786
1787 spin_lock_irq(&ctx->ctx_lock);
1788 ret = -EAGAIN;
1789 kiocb = lookup_kiocb(ctx, iocb, key);
1790 if (kiocb && kiocb->ki_cancel) {
1791 cancel = kiocb->ki_cancel;
1792 kiocb->ki_users ++;
1793 kiocbSetCancelled(kiocb);
1794 } else
1795 cancel = NULL;
1796 spin_unlock_irq(&ctx->ctx_lock);
1797
1798 if (NULL != cancel) {
1799 struct io_event tmp;
1800 pr_debug("calling cancel\n");
1801 memset(&tmp, 0, sizeof(tmp));
1802 tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
1803 tmp.data = kiocb->ki_user_data;
1804 ret = cancel(kiocb, &tmp);
1805 if (!ret) {
1806 /* Cancellation succeeded -- copy the result
1807 * into the user's buffer.
1808 */
1809 if (copy_to_user(result, &tmp, sizeof(tmp)))
1810 ret = -EFAULT;
1811 }
1812 } else
Wendy Cheng8f582022005-09-09 13:02:08 -07001813 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
1815 put_ioctx(ctx);
1816
1817 return ret;
1818}
1819
1820/* io_getevents:
1821 * Attempts to read at least min_nr events and up to nr events from
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001822 * the completion queue for the aio_context specified by ctx_id. If
1823 * it succeeds, the number of read events is returned. May fail with
1824 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1825 * out of range, if timeout is out of range. May fail with -EFAULT
1826 * if any of the memory specified is invalid. May return 0 or
1827 * < min_nr if the timeout specified by timeout has elapsed
1828 * before sufficient events are available, where timeout == NULL
1829 * specifies an infinite timeout. Note that the timeout pointed to by
1830 * timeout is relative and will be updated if not NULL and the
1831 * operation blocks. Will fail with -ENOSYS if not implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001833SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1834 long, min_nr,
1835 long, nr,
1836 struct io_event __user *, events,
1837 struct timespec __user *, timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838{
1839 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1840 long ret = -EINVAL;
1841
1842 if (likely(ioctx)) {
Namhyung Kim2e410252011-01-12 17:01:08 -08001843 if (likely(min_nr <= nr && min_nr >= 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 ret = read_events(ioctx, min_nr, nr, events, timeout);
1845 put_ioctx(ioctx);
1846 }
1847
Roland McGrath598af052008-04-10 15:38:45 -07001848 asmlinkage_protect(5, ret, ctx_id, min_nr, nr, events, timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 return ret;
1850}