blob: 020de5cb4a67f931c63efaba4960585b15f912e4 [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>
16#include <linux/module.h>
17#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 Moyer9d85cba2010-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
78 aio_wq = create_workqueue("aio");
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
95 if (info->mmap_size) {
96 down_write(&ctx->mm->mmap_sem);
97 do_munmap(ctx->mm, info->mmap_base, info->mmap_size);
98 up_write(&ctx->mm->mmap_sem);
99 }
100
101 if (info->ring_pages && info->ring_pages != info->internal_pages)
102 kfree(info->ring_pages);
103 info->ring_pages = NULL;
104 info->nr = 0;
105}
106
107static int aio_setup_ring(struct kioctx *ctx)
108{
109 struct aio_ring *ring;
110 struct aio_ring_info *info = &ctx->ring_info;
111 unsigned nr_events = ctx->max_reqs;
112 unsigned long size;
113 int nr_pages;
114
115 /* Compensate for the ring buffer's head/tail overlap entry */
116 nr_events += 2; /* 1 is required, 2 for good luck */
117
118 size = sizeof(struct aio_ring);
119 size += sizeof(struct io_event) * nr_events;
120 nr_pages = (size + PAGE_SIZE-1) >> PAGE_SHIFT;
121
122 if (nr_pages < 0)
123 return -EINVAL;
124
125 nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring)) / sizeof(struct io_event);
126
127 info->nr = 0;
128 info->ring_pages = info->internal_pages;
129 if (nr_pages > AIO_RING_PAGES) {
Oliver Neukum11b0b5a2006-03-25 03:08:13 -0800130 info->ring_pages = kcalloc(nr_pages, sizeof(struct page *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 if (!info->ring_pages)
132 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 }
134
135 info->mmap_size = nr_pages * PAGE_SIZE;
136 dprintk("attempting mmap of %lu bytes\n", info->mmap_size);
137 down_write(&ctx->mm->mmap_sem);
138 info->mmap_base = do_mmap(NULL, 0, info->mmap_size,
Robert P. J. Daye10a4432007-02-10 01:42:56 -0800139 PROT_READ|PROT_WRITE, MAP_ANONYMOUS|MAP_PRIVATE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 0);
141 if (IS_ERR((void *)info->mmap_base)) {
142 up_write(&ctx->mm->mmap_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 info->mmap_size = 0;
144 aio_free_ring(ctx);
145 return -EAGAIN;
146 }
147
148 dprintk("mmap address: 0x%08lx\n", info->mmap_base);
149 info->nr_pages = get_user_pages(current, ctx->mm,
150 info->mmap_base, nr_pages,
151 1, 0, info->ring_pages, NULL);
152 up_write(&ctx->mm->mmap_sem);
153
154 if (unlikely(info->nr_pages != nr_pages)) {
155 aio_free_ring(ctx);
156 return -EAGAIN;
157 }
158
159 ctx->user_id = info->mmap_base;
160
161 info->nr = nr_events; /* trusted copy */
162
163 ring = kmap_atomic(info->ring_pages[0], KM_USER0);
164 ring->nr = nr_events; /* user copy */
165 ring->id = ctx->user_id;
166 ring->head = ring->tail = 0;
167 ring->magic = AIO_RING_MAGIC;
168 ring->compat_features = AIO_RING_COMPAT_FEATURES;
169 ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
170 ring->header_length = sizeof(struct aio_ring);
171 kunmap_atomic(ring, KM_USER0);
172
173 return 0;
174}
175
176
177/* aio_ring_event: returns a pointer to the event at the given index from
178 * kmap_atomic(, km). Release the pointer with put_aio_ring_event();
179 */
180#define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
181#define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
182#define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
183
184#define aio_ring_event(info, nr, km) ({ \
185 unsigned pos = (nr) + AIO_EVENTS_OFFSET; \
186 struct io_event *__event; \
187 __event = kmap_atomic( \
188 (info)->ring_pages[pos / AIO_EVENTS_PER_PAGE], km); \
189 __event += pos % AIO_EVENTS_PER_PAGE; \
190 __event; \
191})
192
193#define put_aio_ring_event(event, km) do { \
194 struct io_event *__event = (event); \
195 (void)__event; \
196 kunmap_atomic((void *)((unsigned long)__event & PAGE_MASK), km); \
197} while(0)
198
Jens Axboeabf137d2008-12-09 08:11:22 +0100199static void ctx_rcu_free(struct rcu_head *head)
Adrian Bunkd5470b52008-04-29 00:58:57 -0700200{
Jens Axboeabf137d2008-12-09 08:11:22 +0100201 struct kioctx *ctx = container_of(head, struct kioctx, rcu_head);
Adrian Bunkd5470b52008-04-29 00:58:57 -0700202 unsigned nr_events = ctx->max_reqs;
203
Adrian Bunkd5470b52008-04-29 00:58:57 -0700204 kmem_cache_free(kioctx_cachep, ctx);
205
206 if (nr_events) {
207 spin_lock(&aio_nr_lock);
208 BUG_ON(aio_nr - nr_events > aio_nr);
209 aio_nr -= nr_events;
210 spin_unlock(&aio_nr_lock);
211 }
212}
213
Jens Axboeabf137d2008-12-09 08:11:22 +0100214/* __put_ioctx
215 * Called when the last user of an aio context has gone away,
216 * and the struct needs to be freed.
217 */
218static void __put_ioctx(struct kioctx *ctx)
219{
220 BUG_ON(ctx->reqs_active);
221
222 cancel_delayed_work(&ctx->wq);
223 cancel_work_sync(&ctx->wq.work);
224 aio_free_ring(ctx);
225 mmdrop(ctx->mm);
226 ctx->mm = NULL;
227 pr_debug("__put_ioctx: freeing %p\n", ctx);
228 call_rcu(&ctx->rcu_head, ctx_rcu_free);
229}
230
Adrian Bunkd5470b52008-04-29 00:58:57 -0700231#define get_ioctx(kioctx) do { \
232 BUG_ON(atomic_read(&(kioctx)->users) <= 0); \
233 atomic_inc(&(kioctx)->users); \
234} while (0)
235#define put_ioctx(kioctx) do { \
236 BUG_ON(atomic_read(&(kioctx)->users) <= 0); \
237 if (unlikely(atomic_dec_and_test(&(kioctx)->users))) \
238 __put_ioctx(kioctx); \
239} while (0)
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241/* ioctx_alloc
242 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
243 */
244static struct kioctx *ioctx_alloc(unsigned nr_events)
245{
246 struct mm_struct *mm;
247 struct kioctx *ctx;
Jens Axboeabf137d2008-12-09 08:11:22 +0100248 int did_sync = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250 /* Prevent overflows */
251 if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
252 (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
253 pr_debug("ENOMEM: nr_events too high\n");
254 return ERR_PTR(-EINVAL);
255 }
256
Zach Brownd55b5fd2005-11-07 00:59:31 -0800257 if ((unsigned long)nr_events > aio_max_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 return ERR_PTR(-EAGAIN);
259
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800260 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 if (!ctx)
262 return ERR_PTR(-ENOMEM);
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 ctx->max_reqs = nr_events;
265 mm = ctx->mm = current->mm;
266 atomic_inc(&mm->mm_count);
267
268 atomic_set(&ctx->users, 1);
269 spin_lock_init(&ctx->ctx_lock);
270 spin_lock_init(&ctx->ring_info.ring_lock);
271 init_waitqueue_head(&ctx->wait);
272
273 INIT_LIST_HEAD(&ctx->active_reqs);
274 INIT_LIST_HEAD(&ctx->run_list);
David Howells65f27f32006-11-22 14:55:48 +0000275 INIT_DELAYED_WORK(&ctx->wq, aio_kick_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277 if (aio_setup_ring(ctx) < 0)
278 goto out_freectx;
279
280 /* limit the number of system wide aios */
Jens Axboeabf137d2008-12-09 08:11:22 +0100281 do {
282 spin_lock_bh(&aio_nr_lock);
283 if (aio_nr + nr_events > aio_max_nr ||
284 aio_nr + nr_events < aio_nr)
285 ctx->max_reqs = 0;
286 else
287 aio_nr += ctx->max_reqs;
288 spin_unlock_bh(&aio_nr_lock);
289 if (ctx->max_reqs || did_sync)
290 break;
291
292 /* wait for rcu callbacks to have completed before giving up */
293 synchronize_rcu();
294 did_sync = 1;
295 ctx->max_reqs = nr_events;
296 } while (1);
297
Zach Brownd55b5fd2005-11-07 00:59:31 -0800298 if (ctx->max_reqs == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 goto out_cleanup;
300
Jeff Moyer39fa0032008-04-29 01:03:48 -0700301 /* now link into global list. */
Jens Axboeabf137d2008-12-09 08:11:22 +0100302 spin_lock(&mm->ioctx_lock);
303 hlist_add_head_rcu(&ctx->list, &mm->ioctx_list);
304 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306 dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
307 ctx, ctx->user_id, current->mm, ctx->ring_info.nr);
308 return ctx;
309
310out_cleanup:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 __put_ioctx(ctx);
312 return ERR_PTR(-EAGAIN);
313
314out_freectx:
315 mmdrop(mm);
316 kmem_cache_free(kioctx_cachep, ctx);
317 ctx = ERR_PTR(-ENOMEM);
318
319 dprintk("aio: error allocating ioctx %p\n", ctx);
320 return ctx;
321}
322
323/* aio_cancel_all
324 * Cancels all outstanding aio requests on an aio context. Used
325 * when the processes owning a context have all exited to encourage
326 * the rapid destruction of the kioctx.
327 */
328static void aio_cancel_all(struct kioctx *ctx)
329{
330 int (*cancel)(struct kiocb *, struct io_event *);
331 struct io_event res;
332 spin_lock_irq(&ctx->ctx_lock);
333 ctx->dead = 1;
334 while (!list_empty(&ctx->active_reqs)) {
335 struct list_head *pos = ctx->active_reqs.next;
336 struct kiocb *iocb = list_kiocb(pos);
337 list_del_init(&iocb->ki_list);
338 cancel = iocb->ki_cancel;
339 kiocbSetCancelled(iocb);
340 if (cancel) {
341 iocb->ki_users++;
342 spin_unlock_irq(&ctx->ctx_lock);
343 cancel(iocb, &res);
344 spin_lock_irq(&ctx->ctx_lock);
345 }
346 }
347 spin_unlock_irq(&ctx->ctx_lock);
348}
349
Adrian Bunk25ee7e32005-04-25 08:18:14 -0700350static void wait_for_all_aios(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351{
352 struct task_struct *tsk = current;
353 DECLARE_WAITQUEUE(wait, tsk);
354
Ken Chendee11c22007-02-03 01:13:45 -0800355 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 if (!ctx->reqs_active)
Ken Chendee11c22007-02-03 01:13:45 -0800357 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359 add_wait_queue(&ctx->wait, &wait);
360 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
361 while (ctx->reqs_active) {
Ken Chendee11c22007-02-03 01:13:45 -0800362 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer41d10da2007-10-16 23:27:20 -0700363 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
Ken Chendee11c22007-02-03 01:13:45 -0800365 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 }
367 __set_task_state(tsk, TASK_RUNNING);
368 remove_wait_queue(&ctx->wait, &wait);
Ken Chendee11c22007-02-03 01:13:45 -0800369
370out:
371 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372}
373
374/* wait_on_sync_kiocb:
375 * Waits on the given sync kiocb to complete.
376 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800377ssize_t wait_on_sync_kiocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378{
379 while (iocb->ki_users) {
380 set_current_state(TASK_UNINTERRUPTIBLE);
381 if (!iocb->ki_users)
382 break;
Jeff Moyer41d10da2007-10-16 23:27:20 -0700383 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 }
385 __set_current_state(TASK_RUNNING);
386 return iocb->ki_user_data;
387}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700388EXPORT_SYMBOL(wait_on_sync_kiocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390/* exit_aio: called when the last user of mm goes away. At this point,
391 * there is no way for any new requests to be submited or any of the
392 * io_* syscalls to be called on the context. However, there may be
393 * outstanding requests which hold references to the context; as they
394 * go away, they will call put_ioctx and release any pinned memory
395 * associated with the request (held via struct page * references).
396 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800397void exit_aio(struct mm_struct *mm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Jens Axboeabf137d2008-12-09 08:11:22 +0100399 struct kioctx *ctx;
400
401 while (!hlist_empty(&mm->ioctx_list)) {
402 ctx = hlist_entry(mm->ioctx_list.first, struct kioctx, list);
403 hlist_del_rcu(&ctx->list);
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 aio_cancel_all(ctx);
406
407 wait_for_all_aios(ctx);
408 /*
Andrew Mortona9df62c2007-05-09 02:33:54 -0700409 * Ensure we don't leave the ctx on the aio_wq
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700411 cancel_work_sync(&ctx->wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413 if (1 != atomic_read(&ctx->users))
414 printk(KERN_DEBUG
415 "exit_aio:ioctx still alive: %d %d %d\n",
416 atomic_read(&ctx->users), ctx->dead,
417 ctx->reqs_active);
418 put_ioctx(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 }
420}
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/* aio_get_req
423 * Allocate a slot for an aio request. Increments the users count
424 * of the kioctx so that the kioctx stays around until all requests are
425 * complete. Returns NULL if no requests are free.
426 *
427 * Returns with kiocb->users set to 2. The io submit code path holds
428 * an extra reference while submitting the i/o.
429 * This prevents races between the aio code path referencing the
430 * req (after submitting it) and aio_complete() freeing the req.
431 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800432static struct kiocb *__aio_get_req(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433{
434 struct kiocb *req = NULL;
435 struct aio_ring *ring;
436 int okay = 0;
437
438 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
439 if (unlikely(!req))
440 return NULL;
441
Zach Brown4faa5282005-10-17 16:43:33 -0700442 req->ki_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 req->ki_users = 2;
444 req->ki_key = 0;
445 req->ki_ctx = ctx;
446 req->ki_cancel = NULL;
447 req->ki_retry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 req->ki_dtor = NULL;
449 req->private = NULL;
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700450 req->ki_iovec = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 INIT_LIST_HEAD(&req->ki_run_list);
Davide Libenzi87c3a862009-03-18 17:04:19 -0700452 req->ki_eventfd = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
454 /* Check if the completion queue has enough free space to
455 * accept an event from this io.
456 */
457 spin_lock_irq(&ctx->ctx_lock);
458 ring = kmap_atomic(ctx->ring_info.ring_pages[0], KM_USER0);
459 if (ctx->reqs_active < aio_ring_avail(&ctx->ring_info, ring)) {
460 list_add(&req->ki_list, &ctx->active_reqs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 ctx->reqs_active++;
462 okay = 1;
463 }
464 kunmap_atomic(ring, KM_USER0);
465 spin_unlock_irq(&ctx->ctx_lock);
466
467 if (!okay) {
468 kmem_cache_free(kiocb_cachep, req);
469 req = NULL;
470 }
471
472 return req;
473}
474
475static inline struct kiocb *aio_get_req(struct kioctx *ctx)
476{
477 struct kiocb *req;
478 /* Handle a potential starvation case -- should be exceedingly rare as
479 * requests will be stuck on fput_head only if the aio_fput_routine is
480 * delayed and the requests were the last user of the struct file.
481 */
482 req = __aio_get_req(ctx);
483 if (unlikely(NULL == req)) {
484 aio_fput_routine(NULL);
485 req = __aio_get_req(ctx);
486 }
487 return req;
488}
489
490static inline void really_put_req(struct kioctx *ctx, struct kiocb *req)
491{
Zach Brownd00689a2005-11-13 16:07:34 -0800492 assert_spin_locked(&ctx->ctx_lock);
493
Davide Libenzi13389012009-06-30 11:41:11 -0700494 if (req->ki_eventfd != NULL)
495 eventfd_ctx_put(req->ki_eventfd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 if (req->ki_dtor)
497 req->ki_dtor(req);
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700498 if (req->ki_iovec != &req->ki_inline_vec)
499 kfree(req->ki_iovec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 kmem_cache_free(kiocb_cachep, req);
501 ctx->reqs_active--;
502
503 if (unlikely(!ctx->reqs_active && ctx->dead))
504 wake_up(&ctx->wait);
505}
506
David Howells65f27f32006-11-22 14:55:48 +0000507static void aio_fput_routine(struct work_struct *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
509 spin_lock_irq(&fput_lock);
510 while (likely(!list_empty(&fput_head))) {
511 struct kiocb *req = list_kiocb(fput_head.next);
512 struct kioctx *ctx = req->ki_ctx;
513
514 list_del(&req->ki_list);
515 spin_unlock_irq(&fput_lock);
516
Davide Libenzi87c3a862009-03-18 17:04:19 -0700517 /* Complete the fput(s) */
518 if (req->ki_filp != NULL)
Al Virod7065da2010-05-26 15:13:55 -0400519 fput(req->ki_filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
521 /* Link the iocb into the context's free list */
522 spin_lock_irq(&ctx->ctx_lock);
523 really_put_req(ctx, req);
524 spin_unlock_irq(&ctx->ctx_lock);
525
526 put_ioctx(ctx);
527 spin_lock_irq(&fput_lock);
528 }
529 spin_unlock_irq(&fput_lock);
530}
531
532/* __aio_put_req
533 * Returns true if this put was the last user of the request.
534 */
535static int __aio_put_req(struct kioctx *ctx, struct kiocb *req)
536{
Al Viro516e0cc2008-07-26 00:39:17 -0400537 dprintk(KERN_DEBUG "aio_put(%p): f_count=%ld\n",
538 req, atomic_long_read(&req->ki_filp->f_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Zach Brownd00689a2005-11-13 16:07:34 -0800540 assert_spin_locked(&ctx->ctx_lock);
541
Davide Libenzi87c3a862009-03-18 17:04:19 -0700542 req->ki_users--;
Eric Sesterhenn93e06b42006-11-30 05:29:23 +0100543 BUG_ON(req->ki_users < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 if (likely(req->ki_users))
545 return 0;
546 list_del(&req->ki_list); /* remove from active_reqs */
547 req->ki_cancel = NULL;
548 req->ki_retry = NULL;
549
Davide Libenzi87c3a862009-03-18 17:04:19 -0700550 /*
551 * Try to optimize the aio and eventfd file* puts, by avoiding to
Al Virod7065da2010-05-26 15:13:55 -0400552 * schedule work in case it is not final fput() time. In normal cases,
Davide Libenzi87c3a862009-03-18 17:04:19 -0700553 * we would not be holding the last reference to the file*, so
554 * this function will be executed w/out any aio kthread wakeup.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 */
Al Virod7065da2010-05-26 15:13:55 -0400556 if (unlikely(!fput_atomic(req->ki_filp))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 get_ioctx(ctx);
558 spin_lock(&fput_lock);
559 list_add(&req->ki_list, &fput_head);
560 spin_unlock(&fput_lock);
561 queue_work(aio_wq, &fput_work);
Davide Libenzi13389012009-06-30 11:41:11 -0700562 } else {
563 req->ki_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 really_put_req(ctx, req);
Davide Libenzi13389012009-06-30 11:41:11 -0700565 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 return 1;
567}
568
569/* aio_put_req
570 * Returns true if this put was the last user of the kiocb,
571 * false if the request is still in use.
572 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800573int aio_put_req(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574{
575 struct kioctx *ctx = req->ki_ctx;
576 int ret;
577 spin_lock_irq(&ctx->ctx_lock);
578 ret = __aio_put_req(ctx, req);
579 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 return ret;
581}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700582EXPORT_SYMBOL(aio_put_req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Adrian Bunkd5470b52008-04-29 00:58:57 -0700584static struct kioctx *lookup_ioctx(unsigned long ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
Jens Axboeabf137d2008-12-09 08:11:22 +0100586 struct mm_struct *mm = current->mm;
Jeff Moyer65c24492009-03-18 17:04:21 -0700587 struct kioctx *ctx, *ret = NULL;
Jens Axboeabf137d2008-12-09 08:11:22 +0100588 struct hlist_node *n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Jens Axboeabf137d2008-12-09 08:11:22 +0100590 rcu_read_lock();
591
592 hlist_for_each_entry_rcu(ctx, n, &mm->ioctx_list, list) {
593 if (ctx->user_id == ctx_id && !ctx->dead) {
594 get_ioctx(ctx);
Jeff Moyer65c24492009-03-18 17:04:21 -0700595 ret = ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 break;
597 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100598 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Jens Axboeabf137d2008-12-09 08:11:22 +0100600 rcu_read_unlock();
Jeff Moyer65c24492009-03-18 17:04:21 -0700601 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
603
604/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 * Queue up a kiocb to be retried. Assumes that the kiocb
606 * has already been marked as kicked, and places it on
607 * the retry run list for the corresponding ioctx, if it
608 * isn't already queued. Returns 1 if it actually queued
609 * the kiocb (to tell the caller to activate the work
610 * queue to process it), or 0, if it found that it was
611 * already queued.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 */
613static inline int __queue_kicked_iocb(struct kiocb *iocb)
614{
615 struct kioctx *ctx = iocb->ki_ctx;
616
Zach Brownd00689a2005-11-13 16:07:34 -0800617 assert_spin_locked(&ctx->ctx_lock);
618
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 if (list_empty(&iocb->ki_run_list)) {
620 list_add_tail(&iocb->ki_run_list,
621 &ctx->run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return 1;
623 }
624 return 0;
625}
626
627/* aio_run_iocb
628 * This is the core aio execution routine. It is
629 * invoked both for initial i/o submission and
630 * subsequent retries via the aio_kick_handler.
631 * Expects to be invoked with iocb->ki_ctx->lock
Andreas Mohrd6e05ed2006-06-26 18:35:02 +0200632 * already held. The lock is released and reacquired
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 * as needed during processing.
634 *
635 * Calls the iocb retry method (already setup for the
636 * iocb on initial submission) for operation specific
637 * handling, but takes care of most of common retry
638 * execution details for a given iocb. The retry method
639 * needs to be non-blocking as far as possible, to avoid
640 * holding up other iocbs waiting to be serviced by the
641 * retry kernel thread.
642 *
643 * The trickier parts in this code have to do with
644 * ensuring that only one retry instance is in progress
645 * for a given iocb at any time. Providing that guarantee
646 * simplifies the coding of individual aio operations as
647 * it avoids various potential races.
648 */
649static ssize_t aio_run_iocb(struct kiocb *iocb)
650{
651 struct kioctx *ctx = iocb->ki_ctx;
652 ssize_t (*retry)(struct kiocb *);
653 ssize_t ret;
654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (!(retry = iocb->ki_retry)) {
656 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
657 return 0;
658 }
659
660 /*
661 * We don't want the next retry iteration for this
662 * operation to start until this one has returned and
663 * updated the iocb state. However, wait_queue functions
664 * can trigger a kick_iocb from interrupt context in the
665 * meantime, indicating that data is available for the next
666 * iteration. We want to remember that and enable the
667 * next retry iteration _after_ we are through with
668 * this one.
669 *
670 * So, in order to be able to register a "kick", but
671 * prevent it from being queued now, we clear the kick
672 * flag, but make the kick code *think* that the iocb is
673 * still on the run list until we are actually done.
674 * When we are done with this iteration, we check if
675 * the iocb was kicked in the meantime and if so, queue
676 * it up afresh.
677 */
678
679 kiocbClearKicked(iocb);
680
681 /*
682 * This is so that aio_complete knows it doesn't need to
683 * pull the iocb off the run list (We can't just call
684 * INIT_LIST_HEAD because we don't want a kick_iocb to
685 * queue this on the run list yet)
686 */
687 iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
688 spin_unlock_irq(&ctx->ctx_lock);
689
690 /* Quit retrying if the i/o has been cancelled */
691 if (kiocbIsCancelled(iocb)) {
692 ret = -EINTR;
693 aio_complete(iocb, ret, 0);
694 /* must not access the iocb after this */
695 goto out;
696 }
697
698 /*
699 * Now we are all set to call the retry method in async
Alexey Dobriyan6212e3a2007-10-18 03:04:56 -0700700 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 ret = retry(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Jan Karaa0c42ba2010-09-22 13:05:03 -0700704 if (ret != -EIOCBRETRY && ret != -EIOCBQUEUED) {
705 /*
706 * There's no easy way to restart the syscall since other AIO's
707 * may be already running. Just fail this IO with EINTR.
708 */
709 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
710 ret == -ERESTARTNOHAND || ret == -ERESTART_RESTARTBLOCK))
711 ret = -EINTR;
Zach Brown897f15f2005-09-30 11:58:55 -0700712 aio_complete(iocb, ret, 0);
Jan Karaa0c42ba2010-09-22 13:05:03 -0700713 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714out:
715 spin_lock_irq(&ctx->ctx_lock);
716
717 if (-EIOCBRETRY == ret) {
718 /*
719 * OK, now that we are done with this iteration
720 * and know that there is more left to go,
721 * this is where we let go so that a subsequent
722 * "kick" can start the next iteration
723 */
724
725 /* will make __queue_kicked_iocb succeed from here on */
726 INIT_LIST_HEAD(&iocb->ki_run_list);
727 /* we must queue the next iteration ourselves, if it
728 * has already been kicked */
729 if (kiocbIsKicked(iocb)) {
730 __queue_kicked_iocb(iocb);
Sébastien Duguc016e222005-06-28 20:44:59 -0700731
732 /*
733 * __queue_kicked_iocb will always return 1 here, because
734 * iocb->ki_run_list is empty at this point so it should
735 * be safe to unconditionally queue the context into the
736 * work queue.
737 */
738 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 }
740 }
741 return ret;
742}
743
744/*
745 * __aio_run_iocbs:
746 * Process all pending retries queued on the ioctx
747 * run list.
748 * Assumes it is operating within the aio issuer's mm
Zach Brownd00689a2005-11-13 16:07:34 -0800749 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 */
751static int __aio_run_iocbs(struct kioctx *ctx)
752{
753 struct kiocb *iocb;
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700754 struct list_head run_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Zach Brownd00689a2005-11-13 16:07:34 -0800756 assert_spin_locked(&ctx->ctx_lock);
757
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700758 list_replace_init(&ctx->run_list, &run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 while (!list_empty(&run_list)) {
760 iocb = list_entry(run_list.next, struct kiocb,
761 ki_run_list);
762 list_del(&iocb->ki_run_list);
763 /*
764 * Hold an extra reference while retrying i/o.
765 */
766 iocb->ki_users++; /* grab extra reference */
767 aio_run_iocb(iocb);
Ken Chendee11c22007-02-03 01:13:45 -0800768 __aio_put_req(ctx, iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (!list_empty(&ctx->run_list))
771 return 1;
772 return 0;
773}
774
775static void aio_queue_work(struct kioctx * ctx)
776{
777 unsigned long timeout;
778 /*
779 * if someone is waiting, get the work started right
780 * away, otherwise, use a longer delay
781 */
782 smp_mb();
783 if (waitqueue_active(&ctx->wait))
784 timeout = 1;
785 else
786 timeout = HZ/10;
787 queue_delayed_work(aio_wq, &ctx->wq, timeout);
788}
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790/*
Jeff Moyerd3486f82011-01-12 17:01:08 -0800791 * aio_run_all_iocbs:
792 * Process all pending retries queued on the ioctx
793 * run list, and keep running them until the list
794 * stays empty.
795 * Assumes it is operating within the aio issuer's mm context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 */
797static inline void aio_run_all_iocbs(struct kioctx *ctx)
798{
799 spin_lock_irq(&ctx->ctx_lock);
800 while (__aio_run_iocbs(ctx))
801 ;
802 spin_unlock_irq(&ctx->ctx_lock);
803}
804
805/*
806 * aio_kick_handler:
807 * Work queue handler triggered to process pending
808 * retries on an ioctx. Takes on the aio issuer's
809 * mm context before running the iocbs, so that
810 * copy_xxx_user operates on the issuer's address
811 * space.
812 * Run on aiod's context.
813 */
David Howells65f27f32006-11-22 14:55:48 +0000814static void aio_kick_handler(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815{
David Howells65f27f32006-11-22 14:55:48 +0000816 struct kioctx *ctx = container_of(work, struct kioctx, wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 mm_segment_t oldfs = get_fs();
Zach Brown1ebb1102006-12-29 16:47:02 -0800818 struct mm_struct *mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 int requeue;
820
821 set_fs(USER_DS);
822 use_mm(ctx->mm);
823 spin_lock_irq(&ctx->ctx_lock);
824 requeue =__aio_run_iocbs(ctx);
Zach Brown1ebb1102006-12-29 16:47:02 -0800825 mm = ctx->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 spin_unlock_irq(&ctx->ctx_lock);
Zach Brown1ebb1102006-12-29 16:47:02 -0800827 unuse_mm(mm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 set_fs(oldfs);
829 /*
830 * we're in a worker thread already, don't use queue_delayed_work,
831 */
832 if (requeue)
David Howells52bad642006-11-22 14:54:01 +0000833 queue_delayed_work(aio_wq, &ctx->wq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
836
837/*
838 * Called by kick_iocb to queue the kiocb for retry
839 * and if required activate the aio work queue to process
840 * it
841 */
Zach Brown998765e2005-09-30 11:58:54 -0700842static void try_queue_kicked_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843{
844 struct kioctx *ctx = iocb->ki_ctx;
845 unsigned long flags;
846 int run = 0;
847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 spin_lock_irqsave(&ctx->ctx_lock, flags);
Zach Brown998765e2005-09-30 11:58:54 -0700849 /* set this inside the lock so that we can't race with aio_run_iocb()
850 * testing it and putting the iocb on the run list under the lock */
851 if (!kiocbTryKick(iocb))
852 run = __queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Ken Chen644d3a02005-05-01 08:59:15 -0700854 if (run)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856}
857
858/*
859 * kick_iocb:
860 * Called typically from a wait queue callback context
Shaohua Lifac046a2009-12-15 16:47:47 -0800861 * to trigger a retry of the iocb.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 * The retry is usually executed by aio workqueue
863 * threads (See aio_kick_handler).
864 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800865void kick_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
867 /* sync iocbs are easy: they can only ever be executing from a
868 * single context. */
869 if (is_sync_kiocb(iocb)) {
870 kiocbSetKicked(iocb);
871 wake_up_process(iocb->ki_obj.tsk);
872 return;
873 }
874
Zach Brown998765e2005-09-30 11:58:54 -0700875 try_queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876}
877EXPORT_SYMBOL(kick_iocb);
878
879/* aio_complete
880 * Called when the io request on the given iocb is complete.
881 * Returns true if this is the last user of the request. The
882 * only other user of the request can be the cancellation code.
883 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800884int aio_complete(struct kiocb *iocb, long res, long res2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885{
886 struct kioctx *ctx = iocb->ki_ctx;
887 struct aio_ring_info *info;
888 struct aio_ring *ring;
889 struct io_event *event;
890 unsigned long flags;
891 unsigned long tail;
892 int ret;
893
Zach Brown20dcae32005-11-13 16:07:33 -0800894 /*
895 * Special case handling for sync iocbs:
896 * - events go directly into the iocb for fast handling
897 * - the sync task with the iocb in its stack holds the single iocb
898 * ref, no other paths have a way to get another ref
899 * - the sync task helpfully left a reference to itself in the iocb
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 */
901 if (is_sync_kiocb(iocb)) {
Zach Brown20dcae32005-11-13 16:07:33 -0800902 BUG_ON(iocb->ki_users != 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 iocb->ki_user_data = res;
Zach Brown20dcae32005-11-13 16:07:33 -0800904 iocb->ki_users = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 wake_up_process(iocb->ki_obj.tsk);
Zach Brown20dcae32005-11-13 16:07:33 -0800906 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 }
908
909 info = &ctx->ring_info;
910
911 /* add a completion event to the ring buffer.
912 * must be done holding ctx->ctx_lock to prevent
913 * other code from messing with the tail
914 * pointer since we might be called from irq
915 * context.
916 */
917 spin_lock_irqsave(&ctx->ctx_lock, flags);
918
919 if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
920 list_del_init(&iocb->ki_run_list);
921
922 /*
923 * cancelled requests don't get events, userland was given one
924 * when the event got cancelled.
925 */
926 if (kiocbIsCancelled(iocb))
927 goto put_rq;
928
929 ring = kmap_atomic(info->ring_pages[0], KM_IRQ1);
930
931 tail = info->tail;
932 event = aio_ring_event(info, tail, KM_IRQ0);
Ken Chen4bf69b22005-05-01 08:59:15 -0700933 if (++tail >= info->nr)
934 tail = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
936 event->obj = (u64)(unsigned long)iocb->ki_obj.user;
937 event->data = iocb->ki_user_data;
938 event->res = res;
939 event->res2 = res2;
940
941 dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
942 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
943 res, res2);
944
945 /* after flagging the request as done, we
946 * must never even look at it again
947 */
948 smp_wmb(); /* make event visible before updating tail */
949
950 info->tail = tail;
951 ring->tail = tail;
952
953 put_aio_ring_event(event, KM_IRQ0);
954 kunmap_atomic(ring, KM_IRQ1);
955
956 pr_debug("added to ring %p at [%lu]\n", iocb, tail);
Davide Libenzi8d1c98b2008-04-10 21:29:19 -0700957
958 /*
959 * Check if the user asked us to deliver the result through an
960 * eventfd. The eventfd_signal() function is safe to be called
961 * from IRQ context.
962 */
Davide Libenzi87c3a862009-03-18 17:04:19 -0700963 if (iocb->ki_eventfd != NULL)
Davide Libenzi8d1c98b2008-04-10 21:29:19 -0700964 eventfd_signal(iocb->ki_eventfd, 1);
965
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966put_rq:
967 /* everything turned out well, dispose of the aiocb. */
968 ret = __aio_put_req(ctx, iocb);
969
Quentin Barnes6cb2a212008-03-19 17:00:39 -0700970 /*
971 * We have to order our ring_info tail store above and test
972 * of the wait list below outside the wait lock. This is
973 * like in wake_up_bit() where clearing a bit has to be
974 * ordered with the unlocked test.
975 */
976 smp_mb();
977
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 if (waitqueue_active(&ctx->wait))
979 wake_up(&ctx->wait);
980
Ken Chendee11c22007-02-03 01:13:45 -0800981 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 return ret;
983}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700984EXPORT_SYMBOL(aio_complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
986/* aio_read_evt
987 * Pull an event off of the ioctx's event ring. Returns the number of
988 * events fetched (0 or 1 ;-)
989 * FIXME: make this use cmpxchg.
990 * TODO: make the ringbuffer user mmap()able (requires FIXME).
991 */
992static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
993{
994 struct aio_ring_info *info = &ioctx->ring_info;
995 struct aio_ring *ring;
996 unsigned long head;
997 int ret = 0;
998
999 ring = kmap_atomic(info->ring_pages[0], KM_USER0);
1000 dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1001 (unsigned long)ring->head, (unsigned long)ring->tail,
1002 (unsigned long)ring->nr);
1003
1004 if (ring->head == ring->tail)
1005 goto out;
1006
1007 spin_lock(&info->ring_lock);
1008
1009 head = ring->head % info->nr;
1010 if (head != ring->tail) {
1011 struct io_event *evp = aio_ring_event(info, head, KM_USER1);
1012 *ent = *evp;
1013 head = (head + 1) % info->nr;
1014 smp_mb(); /* finish reading the event before updatng the head */
1015 ring->head = head;
1016 ret = 1;
1017 put_aio_ring_event(evp, KM_USER1);
1018 }
1019 spin_unlock(&info->ring_lock);
1020
1021out:
1022 kunmap_atomic(ring, KM_USER0);
1023 dprintk("leaving aio_read_evt: %d h%lu t%lu\n", ret,
1024 (unsigned long)ring->head, (unsigned long)ring->tail);
1025 return ret;
1026}
1027
1028struct aio_timeout {
1029 struct timer_list timer;
1030 int timed_out;
1031 struct task_struct *p;
1032};
1033
1034static void timeout_func(unsigned long data)
1035{
1036 struct aio_timeout *to = (struct aio_timeout *)data;
1037
1038 to->timed_out = 1;
1039 wake_up_process(to->p);
1040}
1041
1042static inline void init_timeout(struct aio_timeout *to)
1043{
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001044 setup_timer_on_stack(&to->timer, timeout_func, (unsigned long) to);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 to->timed_out = 0;
1046 to->p = current;
1047}
1048
1049static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
1050 const struct timespec *ts)
1051{
1052 to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
1053 if (time_after(to->timer.expires, jiffies))
1054 add_timer(&to->timer);
1055 else
1056 to->timed_out = 1;
1057}
1058
1059static inline void clear_timeout(struct aio_timeout *to)
1060{
1061 del_singleshot_timer_sync(&to->timer);
1062}
1063
1064static int read_events(struct kioctx *ctx,
1065 long min_nr, long nr,
1066 struct io_event __user *event,
1067 struct timespec __user *timeout)
1068{
1069 long start_jiffies = jiffies;
1070 struct task_struct *tsk = current;
1071 DECLARE_WAITQUEUE(wait, tsk);
1072 int ret;
1073 int i = 0;
1074 struct io_event ent;
1075 struct aio_timeout to;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 int retry = 0;
1077
1078 /* needed to zero any padding within an entry (there shouldn't be
1079 * any, but C is fun!
1080 */
1081 memset(&ent, 0, sizeof(ent));
1082retry:
1083 ret = 0;
1084 while (likely(i < nr)) {
1085 ret = aio_read_evt(ctx, &ent);
1086 if (unlikely(ret <= 0))
1087 break;
1088
1089 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1090 ent.data, ent.obj, ent.res, ent.res2);
1091
1092 /* Could we split the check in two? */
1093 ret = -EFAULT;
1094 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1095 dprintk("aio: lost an event due to EFAULT.\n");
1096 break;
1097 }
1098 ret = 0;
1099
1100 /* Good, event copied to userland, update counts. */
1101 event ++;
1102 i ++;
1103 }
1104
1105 if (min_nr <= i)
1106 return i;
1107 if (ret)
1108 return ret;
1109
1110 /* End fast path */
1111
1112 /* racey check, but it gets redone */
1113 if (!retry && unlikely(!list_empty(&ctx->run_list))) {
1114 retry = 1;
1115 aio_run_all_iocbs(ctx);
1116 goto retry;
1117 }
1118
1119 init_timeout(&to);
1120 if (timeout) {
1121 struct timespec ts;
1122 ret = -EFAULT;
1123 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1124 goto out;
1125
1126 set_timeout(start_jiffies, &to, &ts);
1127 }
1128
1129 while (likely(i < nr)) {
1130 add_wait_queue_exclusive(&ctx->wait, &wait);
1131 do {
1132 set_task_state(tsk, TASK_INTERRUPTIBLE);
1133 ret = aio_read_evt(ctx, &ent);
1134 if (ret)
1135 break;
1136 if (min_nr <= i)
1137 break;
Jeff Moyere92adcb2008-04-28 02:12:04 -07001138 if (unlikely(ctx->dead)) {
1139 ret = -EINVAL;
1140 break;
1141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 if (to.timed_out) /* Only check after read evt */
1143 break;
Jeff Moyere00ba3d2007-12-04 23:45:02 -08001144 /* Try to only show up in io wait if there are ops
1145 * in flight */
1146 if (ctx->reqs_active)
1147 io_schedule();
1148 else
1149 schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 if (signal_pending(tsk)) {
1151 ret = -EINTR;
1152 break;
1153 }
1154 /*ret = aio_read_evt(ctx, &ent);*/
1155 } while (1) ;
1156
1157 set_task_state(tsk, TASK_RUNNING);
1158 remove_wait_queue(&ctx->wait, &wait);
1159
1160 if (unlikely(ret <= 0))
1161 break;
1162
1163 ret = -EFAULT;
1164 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1165 dprintk("aio: lost an event due to EFAULT.\n");
1166 break;
1167 }
1168
1169 /* Good, event copied to userland, update counts. */
1170 event ++;
1171 i ++;
1172 }
1173
1174 if (timeout)
1175 clear_timeout(&to);
1176out:
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001177 destroy_timer_on_stack(&to.timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 return i ? i : ret;
1179}
1180
1181/* Take an ioctx and remove it from the list of ioctx's. Protects
1182 * against races with itself via ->dead.
1183 */
1184static void io_destroy(struct kioctx *ioctx)
1185{
1186 struct mm_struct *mm = current->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 int was_dead;
1188
1189 /* delete the entry from the list is someone else hasn't already */
Jens Axboeabf137d2008-12-09 08:11:22 +01001190 spin_lock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 was_dead = ioctx->dead;
1192 ioctx->dead = 1;
Jens Axboeabf137d2008-12-09 08:11:22 +01001193 hlist_del_rcu(&ioctx->list);
1194 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
1196 dprintk("aio_release(%p)\n", ioctx);
1197 if (likely(!was_dead))
1198 put_ioctx(ioctx); /* twice for the list */
1199
1200 aio_cancel_all(ioctx);
1201 wait_for_all_aios(ioctx);
Jeff Moyere92adcb2008-04-28 02:12:04 -07001202
1203 /*
1204 * Wake up any waiters. The setting of ctx->dead must be seen
1205 * by other CPUs at this point. Right now, we rely on the
1206 * locking done by the above calls to ensure this consistency.
1207 */
1208 wake_up(&ioctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 put_ioctx(ioctx); /* once for the lookup */
1210}
1211
1212/* sys_io_setup:
1213 * Create an aio_context capable of receiving at least nr_events.
1214 * ctxp must not point to an aio_context that already exists, and
1215 * must be initialized to 0 prior to the call. On successful
1216 * creation of the aio_context, *ctxp is filled in with the resulting
1217 * handle. May fail with -EINVAL if *ctxp is not initialized,
1218 * if the specified nr_events exceeds internal limits. May fail
1219 * with -EAGAIN if the specified nr_events exceeds the user's limit
1220 * of available events. May fail with -ENOMEM if insufficient kernel
1221 * resources are available. May fail with -EFAULT if an invalid
1222 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1223 * implemented.
1224 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001225SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226{
1227 struct kioctx *ioctx = NULL;
1228 unsigned long ctx;
1229 long ret;
1230
1231 ret = get_user(ctx, ctxp);
1232 if (unlikely(ret))
1233 goto out;
1234
1235 ret = -EINVAL;
Zach Brownd55b5fd2005-11-07 00:59:31 -08001236 if (unlikely(ctx || nr_events == 0)) {
1237 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1238 ctx, nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 goto out;
1240 }
1241
1242 ioctx = ioctx_alloc(nr_events);
1243 ret = PTR_ERR(ioctx);
1244 if (!IS_ERR(ioctx)) {
1245 ret = put_user(ioctx->user_id, ctxp);
1246 if (!ret)
1247 return 0;
1248
1249 get_ioctx(ioctx); /* io_destroy() expects us to hold a ref */
1250 io_destroy(ioctx);
1251 }
1252
1253out:
1254 return ret;
1255}
1256
1257/* sys_io_destroy:
1258 * Destroy the aio_context specified. May cancel any outstanding
1259 * AIOs and block on completion. Will fail with -ENOSYS if not
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001260 * implemented. May fail with -EINVAL if the context pointed to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 * is invalid.
1262 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001263SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264{
1265 struct kioctx *ioctx = lookup_ioctx(ctx);
1266 if (likely(NULL != ioctx)) {
1267 io_destroy(ioctx);
1268 return 0;
1269 }
1270 pr_debug("EINVAL: io_destroy: invalid context id\n");
1271 return -EINVAL;
1272}
1273
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001274static void aio_advance_iovec(struct kiocb *iocb, ssize_t ret)
1275{
1276 struct iovec *iov = &iocb->ki_iovec[iocb->ki_cur_seg];
1277
1278 BUG_ON(ret <= 0);
1279
1280 while (iocb->ki_cur_seg < iocb->ki_nr_segs && ret > 0) {
1281 ssize_t this = min((ssize_t)iov->iov_len, ret);
1282 iov->iov_base += this;
1283 iov->iov_len -= this;
1284 iocb->ki_left -= this;
1285 ret -= this;
1286 if (iov->iov_len == 0) {
1287 iocb->ki_cur_seg++;
1288 iov++;
1289 }
1290 }
1291
1292 /* the caller should not have done more io than what fit in
1293 * the remaining iovecs */
1294 BUG_ON(ret > 0 && iocb->ki_left == 0);
1295}
1296
1297static ssize_t aio_rw_vect_retry(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298{
1299 struct file *file = iocb->ki_filp;
1300 struct address_space *mapping = file->f_mapping;
1301 struct inode *inode = mapping->host;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001302 ssize_t (*rw_op)(struct kiocb *, const struct iovec *,
1303 unsigned long, loff_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 ssize_t ret = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001305 unsigned short opcode;
1306
1307 if ((iocb->ki_opcode == IOCB_CMD_PREADV) ||
1308 (iocb->ki_opcode == IOCB_CMD_PREAD)) {
1309 rw_op = file->f_op->aio_read;
1310 opcode = IOCB_CMD_PREADV;
1311 } else {
1312 rw_op = file->f_op->aio_write;
1313 opcode = IOCB_CMD_PWRITEV;
1314 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315
Rusty Russellc2ec6682008-02-08 04:20:15 -08001316 /* This matches the pread()/pwrite() logic */
1317 if (iocb->ki_pos < 0)
1318 return -EINVAL;
1319
Zach Brown897f15f2005-09-30 11:58:55 -07001320 do {
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001321 ret = rw_op(iocb, &iocb->ki_iovec[iocb->ki_cur_seg],
1322 iocb->ki_nr_segs - iocb->ki_cur_seg,
1323 iocb->ki_pos);
1324 if (ret > 0)
1325 aio_advance_iovec(iocb, ret);
Badari Pulavarty027445c2006-09-30 23:28:46 -07001326
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001327 /* retry all partial writes. retry partial reads as long as its a
1328 * regular file. */
Zach Brown353fb072005-09-30 11:58:56 -07001329 } while (ret > 0 && iocb->ki_left > 0 &&
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001330 (opcode == IOCB_CMD_PWRITEV ||
1331 (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332
1333 /* This means we must have transferred all that we could */
1334 /* No need to retry anymore */
1335 if ((ret == 0) || (iocb->ki_left == 0))
1336 ret = iocb->ki_nbytes - iocb->ki_left;
1337
Rusty Russell7adfa2f2008-02-08 04:20:14 -08001338 /* If we managed to write some out we return that, rather than
1339 * the eventual error. */
1340 if (opcode == IOCB_CMD_PWRITEV
1341 && ret < 0 && ret != -EIOCBQUEUED && ret != -EIOCBRETRY
1342 && iocb->ki_nbytes - iocb->ki_left)
1343 ret = iocb->ki_nbytes - iocb->ki_left;
1344
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 return ret;
1346}
1347
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348static ssize_t aio_fdsync(struct kiocb *iocb)
1349{
1350 struct file *file = iocb->ki_filp;
1351 ssize_t ret = -EINVAL;
1352
1353 if (file->f_op->aio_fsync)
1354 ret = file->f_op->aio_fsync(iocb, 1);
1355 return ret;
1356}
1357
1358static ssize_t aio_fsync(struct kiocb *iocb)
1359{
1360 struct file *file = iocb->ki_filp;
1361 ssize_t ret = -EINVAL;
1362
1363 if (file->f_op->aio_fsync)
1364 ret = file->f_op->aio_fsync(iocb, 0);
1365 return ret;
1366}
1367
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001368static ssize_t aio_setup_vectored_rw(int type, struct kiocb *kiocb, bool compat)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001369{
1370 ssize_t ret;
1371
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001372#ifdef CONFIG_COMPAT
1373 if (compat)
1374 ret = compat_rw_copy_check_uvector(type,
1375 (struct compat_iovec __user *)kiocb->ki_buf,
1376 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
1377 &kiocb->ki_iovec);
1378 else
1379#endif
1380 ret = rw_copy_check_uvector(type,
1381 (struct iovec __user *)kiocb->ki_buf,
1382 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
1383 &kiocb->ki_iovec);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001384 if (ret < 0)
1385 goto out;
1386
1387 kiocb->ki_nr_segs = kiocb->ki_nbytes;
1388 kiocb->ki_cur_seg = 0;
1389 /* ki_nbytes/left now reflect bytes instead of segs */
1390 kiocb->ki_nbytes = ret;
1391 kiocb->ki_left = ret;
1392
1393 ret = 0;
1394out:
1395 return ret;
1396}
1397
1398static ssize_t aio_setup_single_vector(struct kiocb *kiocb)
1399{
1400 kiocb->ki_iovec = &kiocb->ki_inline_vec;
1401 kiocb->ki_iovec->iov_base = kiocb->ki_buf;
1402 kiocb->ki_iovec->iov_len = kiocb->ki_left;
1403 kiocb->ki_nr_segs = 1;
1404 kiocb->ki_cur_seg = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001405 return 0;
1406}
1407
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408/*
1409 * aio_setup_iocb:
1410 * Performs the initial checks and aio retry method
1411 * setup for the kiocb at the time of io submission.
1412 */
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001413static ssize_t aio_setup_iocb(struct kiocb *kiocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414{
1415 struct file *file = kiocb->ki_filp;
1416 ssize_t ret = 0;
1417
1418 switch (kiocb->ki_opcode) {
1419 case IOCB_CMD_PREAD:
1420 ret = -EBADF;
1421 if (unlikely(!(file->f_mode & FMODE_READ)))
1422 break;
1423 ret = -EFAULT;
1424 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1425 kiocb->ki_left)))
1426 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001427 ret = security_file_permission(file, MAY_READ);
1428 if (unlikely(ret))
1429 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001430 ret = aio_setup_single_vector(kiocb);
1431 if (ret)
1432 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 ret = -EINVAL;
1434 if (file->f_op->aio_read)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001435 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 break;
1437 case IOCB_CMD_PWRITE:
1438 ret = -EBADF;
1439 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1440 break;
1441 ret = -EFAULT;
1442 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1443 kiocb->ki_left)))
1444 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001445 ret = security_file_permission(file, MAY_WRITE);
1446 if (unlikely(ret))
1447 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001448 ret = aio_setup_single_vector(kiocb);
1449 if (ret)
1450 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 ret = -EINVAL;
1452 if (file->f_op->aio_write)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001453 kiocb->ki_retry = aio_rw_vect_retry;
1454 break;
1455 case IOCB_CMD_PREADV:
1456 ret = -EBADF;
1457 if (unlikely(!(file->f_mode & FMODE_READ)))
1458 break;
1459 ret = security_file_permission(file, MAY_READ);
1460 if (unlikely(ret))
1461 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001462 ret = aio_setup_vectored_rw(READ, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001463 if (ret)
1464 break;
1465 ret = -EINVAL;
1466 if (file->f_op->aio_read)
1467 kiocb->ki_retry = aio_rw_vect_retry;
1468 break;
1469 case IOCB_CMD_PWRITEV:
1470 ret = -EBADF;
1471 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1472 break;
1473 ret = security_file_permission(file, MAY_WRITE);
1474 if (unlikely(ret))
1475 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001476 ret = aio_setup_vectored_rw(WRITE, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001477 if (ret)
1478 break;
1479 ret = -EINVAL;
1480 if (file->f_op->aio_write)
1481 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 break;
1483 case IOCB_CMD_FDSYNC:
1484 ret = -EINVAL;
1485 if (file->f_op->aio_fsync)
1486 kiocb->ki_retry = aio_fdsync;
1487 break;
1488 case IOCB_CMD_FSYNC:
1489 ret = -EINVAL;
1490 if (file->f_op->aio_fsync)
1491 kiocb->ki_retry = aio_fsync;
1492 break;
1493 default:
1494 dprintk("EINVAL: io_submit: no operation provided\n");
1495 ret = -EINVAL;
1496 }
1497
1498 if (!kiocb->ki_retry)
1499 return ret;
1500
1501 return 0;
1502}
1503
Adrian Bunkd5470b52008-04-29 00:58:57 -07001504static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
Jens Axboecf159002011-03-02 20:12:18 -05001505 struct iocb *iocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
1507 struct kiocb *req;
1508 struct file *file;
1509 ssize_t ret;
1510
1511 /* enforce forwards compatibility on users */
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001512 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 pr_debug("EINVAL: io_submit: reserve field set\n");
1514 return -EINVAL;
1515 }
1516
1517 /* prevent overflows */
1518 if (unlikely(
1519 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1520 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1521 ((ssize_t)iocb->aio_nbytes < 0)
1522 )) {
1523 pr_debug("EINVAL: io_submit: overflow check\n");
1524 return -EINVAL;
1525 }
1526
1527 file = fget(iocb->aio_fildes);
1528 if (unlikely(!file))
1529 return -EBADF;
1530
1531 req = aio_get_req(ctx); /* returns with 2 references to req */
1532 if (unlikely(!req)) {
1533 fput(file);
1534 return -EAGAIN;
1535 }
Yan Zheng87e28312007-10-08 12:16:20 -07001536 req->ki_filp = file;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001537 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1538 /*
1539 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1540 * instance of the file* now. The file descriptor must be
1541 * an eventfd() fd, and will be signaled for each completed
1542 * event using the eventfd_signal() function.
1543 */
Davide Libenzi13389012009-06-30 11:41:11 -07001544 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -07001545 if (IS_ERR(req->ki_eventfd)) {
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001546 ret = PTR_ERR(req->ki_eventfd);
Davide Libenzi87c3a862009-03-18 17:04:19 -07001547 req->ki_eventfd = NULL;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001548 goto out_put_req;
1549 }
1550 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
Ken Chen212079c2005-05-01 08:59:15 -07001552 ret = put_user(req->ki_key, &user_iocb->aio_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 if (unlikely(ret)) {
1554 dprintk("EFAULT: aio_key\n");
1555 goto out_put_req;
1556 }
1557
1558 req->ki_obj.user = user_iocb;
1559 req->ki_user_data = iocb->aio_data;
1560 req->ki_pos = iocb->aio_offset;
1561
1562 req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1563 req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1564 req->ki_opcode = iocb->aio_lio_opcode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001566 ret = aio_setup_iocb(req, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
1568 if (ret)
1569 goto out_put_req;
1570
1571 spin_lock_irq(&ctx->ctx_lock);
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001572 aio_run_iocb(req);
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001573 if (!list_empty(&ctx->run_list)) {
Ken Chen954d3e92005-05-01 08:59:16 -07001574 /* drain the run list */
1575 while (__aio_run_iocbs(ctx))
1576 ;
1577 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyercfb1e332009-10-02 18:57:36 -04001579
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 aio_put_req(req); /* drop extra ref to req */
1581 return 0;
1582
1583out_put_req:
1584 aio_put_req(req); /* drop extra ref to req */
1585 aio_put_req(req); /* drop i/o ref to req */
1586 return ret;
1587}
1588
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001589long do_io_submit(aio_context_t ctx_id, long nr,
1590 struct iocb __user *__user *iocbpp, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591{
1592 struct kioctx *ctx;
1593 long ret = 0;
1594 int i;
Shaohua Li9f5b9422010-07-01 07:55:01 +02001595 struct blk_plug plug;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596
1597 if (unlikely(nr < 0))
1598 return -EINVAL;
1599
Jeff Moyer75e1c702010-09-10 14:16:00 -07001600 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1601 nr = LONG_MAX/sizeof(*iocbpp);
1602
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1604 return -EFAULT;
1605
1606 ctx = lookup_ioctx(ctx_id);
1607 if (unlikely(!ctx)) {
1608 pr_debug("EINVAL: io_submit: invalid context id\n");
1609 return -EINVAL;
1610 }
1611
Shaohua Li9f5b9422010-07-01 07:55:01 +02001612 blk_start_plug(&plug);
1613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 /*
1615 * AKPM: should this return a partial result if some of the IOs were
1616 * successfully submitted?
1617 */
1618 for (i=0; i<nr; i++) {
1619 struct iocb __user *user_iocb;
1620 struct iocb tmp;
1621
1622 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1623 ret = -EFAULT;
1624 break;
1625 }
1626
1627 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1628 ret = -EFAULT;
1629 break;
1630 }
1631
Jens Axboecf159002011-03-02 20:12:18 -05001632 ret = io_submit_one(ctx, user_iocb, &tmp, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 if (ret)
1634 break;
1635 }
Shaohua Li9f5b9422010-07-01 07:55:01 +02001636 blk_finish_plug(&plug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
1638 put_ioctx(ctx);
1639 return i ? i : ret;
1640}
1641
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001642/* sys_io_submit:
1643 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1644 * the number of iocbs queued. May return -EINVAL if the aio_context
1645 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1646 * *iocbpp[0] is not properly initialized, if the operation specified
1647 * is invalid for the file descriptor in the iocb. May fail with
1648 * -EFAULT if any of the data structures point to invalid data. May
1649 * fail with -EBADF if the file descriptor specified in the first
1650 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1651 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1652 * fail with -ENOSYS if not implemented.
1653 */
1654SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1655 struct iocb __user * __user *, iocbpp)
1656{
1657 return do_io_submit(ctx_id, nr, iocbpp, 0);
1658}
1659
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660/* lookup_kiocb
1661 * Finds a given iocb for cancellation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 */
Adrian Bunk25ee7e32005-04-25 08:18:14 -07001663static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1664 u32 key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665{
1666 struct list_head *pos;
Zach Brownd00689a2005-11-13 16:07:34 -08001667
1668 assert_spin_locked(&ctx->ctx_lock);
1669
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 /* TODO: use a hash or array, this sucks. */
1671 list_for_each(pos, &ctx->active_reqs) {
1672 struct kiocb *kiocb = list_kiocb(pos);
1673 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1674 return kiocb;
1675 }
1676 return NULL;
1677}
1678
1679/* sys_io_cancel:
1680 * Attempts to cancel an iocb previously passed to io_submit. If
1681 * the operation is successfully cancelled, the resulting event is
1682 * copied into the memory pointed to by result without being placed
1683 * into the completion queue and 0 is returned. May fail with
1684 * -EFAULT if any of the data structures pointed to are invalid.
1685 * May fail with -EINVAL if aio_context specified by ctx_id is
1686 * invalid. May fail with -EAGAIN if the iocb specified was not
1687 * cancelled. Will fail with -ENOSYS if not implemented.
1688 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001689SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1690 struct io_event __user *, result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691{
1692 int (*cancel)(struct kiocb *iocb, struct io_event *res);
1693 struct kioctx *ctx;
1694 struct kiocb *kiocb;
1695 u32 key;
1696 int ret;
1697
1698 ret = get_user(key, &iocb->aio_key);
1699 if (unlikely(ret))
1700 return -EFAULT;
1701
1702 ctx = lookup_ioctx(ctx_id);
1703 if (unlikely(!ctx))
1704 return -EINVAL;
1705
1706 spin_lock_irq(&ctx->ctx_lock);
1707 ret = -EAGAIN;
1708 kiocb = lookup_kiocb(ctx, iocb, key);
1709 if (kiocb && kiocb->ki_cancel) {
1710 cancel = kiocb->ki_cancel;
1711 kiocb->ki_users ++;
1712 kiocbSetCancelled(kiocb);
1713 } else
1714 cancel = NULL;
1715 spin_unlock_irq(&ctx->ctx_lock);
1716
1717 if (NULL != cancel) {
1718 struct io_event tmp;
1719 pr_debug("calling cancel\n");
1720 memset(&tmp, 0, sizeof(tmp));
1721 tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
1722 tmp.data = kiocb->ki_user_data;
1723 ret = cancel(kiocb, &tmp);
1724 if (!ret) {
1725 /* Cancellation succeeded -- copy the result
1726 * into the user's buffer.
1727 */
1728 if (copy_to_user(result, &tmp, sizeof(tmp)))
1729 ret = -EFAULT;
1730 }
1731 } else
Wendy Cheng8f582022005-09-09 13:02:08 -07001732 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733
1734 put_ioctx(ctx);
1735
1736 return ret;
1737}
1738
1739/* io_getevents:
1740 * Attempts to read at least min_nr events and up to nr events from
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001741 * the completion queue for the aio_context specified by ctx_id. If
1742 * it succeeds, the number of read events is returned. May fail with
1743 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1744 * out of range, if timeout is out of range. May fail with -EFAULT
1745 * if any of the memory specified is invalid. May return 0 or
1746 * < min_nr if the timeout specified by timeout has elapsed
1747 * before sufficient events are available, where timeout == NULL
1748 * specifies an infinite timeout. Note that the timeout pointed to by
1749 * timeout is relative and will be updated if not NULL and the
1750 * operation blocks. Will fail with -ENOSYS if not implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001752SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1753 long, min_nr,
1754 long, nr,
1755 struct io_event __user *, events,
1756 struct timespec __user *, timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757{
1758 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1759 long ret = -EINVAL;
1760
1761 if (likely(ioctx)) {
Namhyung Kim2e410252011-01-12 17:01:08 -08001762 if (likely(min_nr <= nr && min_nr >= 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 ret = read_events(ioctx, min_nr, nr, events, timeout);
1764 put_ioctx(ioctx);
1765 }
1766
Roland McGrath598af052008-04-10 15:38:45 -07001767 asmlinkage_protect(5, ret, ctx_id, min_nr, nr, events, timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 return ret;
1769}