blob: 9c3de88e2eadd451556c2abc2aa803f2239dc7af [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
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
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 kmem_cache_free(kioctx_cachep, ctx);
Adrian Bunkd5470b52008-04-29 00:58:57 -0700203}
204
Jens Axboeabf137d2008-12-09 08:11:22 +0100205/* __put_ioctx
206 * Called when the last user of an aio context has gone away,
207 * and the struct needs to be freed.
208 */
209static void __put_ioctx(struct kioctx *ctx)
210{
Al Viro2dd542b2012-03-10 23:10:35 -0500211 unsigned nr_events = ctx->max_reqs;
Jens Axboeabf137d2008-12-09 08:11:22 +0100212 BUG_ON(ctx->reqs_active);
213
214 cancel_delayed_work(&ctx->wq);
215 cancel_work_sync(&ctx->wq.work);
216 aio_free_ring(ctx);
217 mmdrop(ctx->mm);
218 ctx->mm = NULL;
Al Viro2dd542b2012-03-10 23:10:35 -0500219 if (nr_events) {
220 spin_lock(&aio_nr_lock);
221 BUG_ON(aio_nr - nr_events > aio_nr);
222 aio_nr -= nr_events;
223 spin_unlock(&aio_nr_lock);
224 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100225 pr_debug("__put_ioctx: freeing %p\n", ctx);
226 call_rcu(&ctx->rcu_head, ctx_rcu_free);
227}
228
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800229static inline int try_get_ioctx(struct kioctx *kioctx)
230{
231 return atomic_inc_not_zero(&kioctx->users);
232}
233
234static inline void put_ioctx(struct kioctx *kioctx)
235{
236 BUG_ON(atomic_read(&kioctx->users) <= 0);
237 if (unlikely(atomic_dec_and_test(&kioctx->users)))
238 __put_ioctx(kioctx);
239}
Adrian Bunkd5470b52008-04-29 00:58:57 -0700240
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;
Al Viroe23754f2012-03-06 14:33:22 -0500248 int err = -ENOMEM;
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
Al Viro2dd542b2012-03-10 23:10:35 -0500257 if (!nr_events || (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
Al Viro86b62a22012-03-07 05:16:35 +0000268 atomic_set(&ctx->users, 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 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 */
Al Viro9fa1cb32012-03-10 23:14:05 -0500281 spin_lock(&aio_nr_lock);
Al Viro2dd542b2012-03-10 23:10:35 -0500282 if (aio_nr + nr_events > aio_max_nr ||
283 aio_nr + nr_events < aio_nr) {
Al Viro9fa1cb32012-03-10 23:14:05 -0500284 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 goto out_cleanup;
Al Viro2dd542b2012-03-10 23:10:35 -0500286 }
287 aio_nr += ctx->max_reqs;
Al Viro9fa1cb32012-03-10 23:14:05 -0500288 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Jeff Moyer39fa0032008-04-29 01:03:48 -0700290 /* now link into global list. */
Jens Axboeabf137d2008-12-09 08:11:22 +0100291 spin_lock(&mm->ioctx_lock);
292 hlist_add_head_rcu(&ctx->list, &mm->ioctx_list);
293 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
295 dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
296 ctx, ctx->user_id, current->mm, ctx->ring_info.nr);
297 return ctx;
298
299out_cleanup:
Al Viroe23754f2012-03-06 14:33:22 -0500300 err = -EAGAIN;
301 aio_free_ring(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302out_freectx:
303 mmdrop(mm);
304 kmem_cache_free(kioctx_cachep, ctx);
Al Viroe23754f2012-03-06 14:33:22 -0500305 dprintk("aio: error allocating ioctx %d\n", err);
306 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307}
308
309/* aio_cancel_all
310 * Cancels all outstanding aio requests on an aio context. Used
311 * when the processes owning a context have all exited to encourage
312 * the rapid destruction of the kioctx.
313 */
314static void aio_cancel_all(struct kioctx *ctx)
315{
316 int (*cancel)(struct kiocb *, struct io_event *);
317 struct io_event res;
318 spin_lock_irq(&ctx->ctx_lock);
319 ctx->dead = 1;
320 while (!list_empty(&ctx->active_reqs)) {
321 struct list_head *pos = ctx->active_reqs.next;
322 struct kiocb *iocb = list_kiocb(pos);
323 list_del_init(&iocb->ki_list);
324 cancel = iocb->ki_cancel;
325 kiocbSetCancelled(iocb);
326 if (cancel) {
327 iocb->ki_users++;
328 spin_unlock_irq(&ctx->ctx_lock);
329 cancel(iocb, &res);
330 spin_lock_irq(&ctx->ctx_lock);
331 }
332 }
333 spin_unlock_irq(&ctx->ctx_lock);
334}
335
Adrian Bunk25ee7e32005-04-25 08:18:14 -0700336static void wait_for_all_aios(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
338 struct task_struct *tsk = current;
339 DECLARE_WAITQUEUE(wait, tsk);
340
Ken Chendee11c22007-02-03 01:13:45 -0800341 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 if (!ctx->reqs_active)
Ken Chendee11c22007-02-03 01:13:45 -0800343 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345 add_wait_queue(&ctx->wait, &wait);
346 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
347 while (ctx->reqs_active) {
Ken Chendee11c22007-02-03 01:13:45 -0800348 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer41d10da2007-10-16 23:27:20 -0700349 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
Ken Chendee11c22007-02-03 01:13:45 -0800351 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 }
353 __set_task_state(tsk, TASK_RUNNING);
354 remove_wait_queue(&ctx->wait, &wait);
Ken Chendee11c22007-02-03 01:13:45 -0800355
356out:
357 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358}
359
360/* wait_on_sync_kiocb:
361 * Waits on the given sync kiocb to complete.
362 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800363ssize_t wait_on_sync_kiocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364{
365 while (iocb->ki_users) {
366 set_current_state(TASK_UNINTERRUPTIBLE);
367 if (!iocb->ki_users)
368 break;
Jeff Moyer41d10da2007-10-16 23:27:20 -0700369 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 }
371 __set_current_state(TASK_RUNNING);
372 return iocb->ki_user_data;
373}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700374EXPORT_SYMBOL(wait_on_sync_kiocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376/* exit_aio: called when the last user of mm goes away. At this point,
377 * there is no way for any new requests to be submited or any of the
378 * io_* syscalls to be called on the context. However, there may be
379 * outstanding requests which hold references to the context; as they
380 * go away, they will call put_ioctx and release any pinned memory
381 * associated with the request (held via struct page * references).
382 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800383void exit_aio(struct mm_struct *mm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384{
Jens Axboeabf137d2008-12-09 08:11:22 +0100385 struct kioctx *ctx;
386
387 while (!hlist_empty(&mm->ioctx_list)) {
388 ctx = hlist_entry(mm->ioctx_list.first, struct kioctx, list);
389 hlist_del_rcu(&ctx->list);
390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 aio_cancel_all(ctx);
392
393 wait_for_all_aios(ctx);
394 /*
Andrew Mortona9df62c2007-05-09 02:33:54 -0700395 * Ensure we don't leave the ctx on the aio_wq
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700397 cancel_work_sync(&ctx->wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399 if (1 != atomic_read(&ctx->users))
400 printk(KERN_DEBUG
401 "exit_aio:ioctx still alive: %d %d %d\n",
402 atomic_read(&ctx->users), ctx->dead,
403 ctx->reqs_active);
404 put_ioctx(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 }
406}
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408/* aio_get_req
409 * Allocate a slot for an aio request. Increments the users count
410 * of the kioctx so that the kioctx stays around until all requests are
411 * complete. Returns NULL if no requests are free.
412 *
413 * Returns with kiocb->users set to 2. The io submit code path holds
414 * an extra reference while submitting the i/o.
415 * This prevents races between the aio code path referencing the
416 * req (after submitting it) and aio_complete() freeing the req.
417 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800418static struct kiocb *__aio_get_req(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419{
420 struct kiocb *req = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
423 if (unlikely(!req))
424 return NULL;
425
Zach Brown4faa5282005-10-17 16:43:33 -0700426 req->ki_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 req->ki_users = 2;
428 req->ki_key = 0;
429 req->ki_ctx = ctx;
430 req->ki_cancel = NULL;
431 req->ki_retry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 req->ki_dtor = NULL;
433 req->private = NULL;
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700434 req->ki_iovec = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 INIT_LIST_HEAD(&req->ki_run_list);
Davide Libenzi87c3a862009-03-18 17:04:19 -0700436 req->ki_eventfd = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 return req;
439}
440
Jeff Moyer080d6762011-11-02 13:40:10 -0700441/*
442 * struct kiocb's are allocated in batches to reduce the number of
443 * times the ctx lock is acquired and released.
444 */
445#define KIOCB_BATCH_SIZE 32L
446struct kiocb_batch {
447 struct list_head head;
448 long count; /* number of requests left to allocate */
449};
450
451static void kiocb_batch_init(struct kiocb_batch *batch, long total)
452{
453 INIT_LIST_HEAD(&batch->head);
454 batch->count = total;
455}
456
Gleb Natapov69e47472012-01-08 17:07:28 +0200457static void kiocb_batch_free(struct kioctx *ctx, struct kiocb_batch *batch)
Jeff Moyer080d6762011-11-02 13:40:10 -0700458{
459 struct kiocb *req, *n;
460
Gleb Natapov69e47472012-01-08 17:07:28 +0200461 if (list_empty(&batch->head))
462 return;
463
464 spin_lock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700465 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
466 list_del(&req->ki_batch);
Gleb Natapov69e47472012-01-08 17:07:28 +0200467 list_del(&req->ki_list);
Jeff Moyer080d6762011-11-02 13:40:10 -0700468 kmem_cache_free(kiocb_cachep, req);
Gleb Natapov69e47472012-01-08 17:07:28 +0200469 ctx->reqs_active--;
Jeff Moyer080d6762011-11-02 13:40:10 -0700470 }
Jeff Moyer880641b2012-03-05 14:59:12 -0800471 if (unlikely(!ctx->reqs_active && ctx->dead))
472 wake_up_all(&ctx->wait);
Gleb Natapov69e47472012-01-08 17:07:28 +0200473 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700474}
475
476/*
477 * Allocate a batch of kiocbs. This avoids taking and dropping the
478 * context lock a lot during setup.
479 */
480static int kiocb_batch_refill(struct kioctx *ctx, struct kiocb_batch *batch)
481{
482 unsigned short allocated, to_alloc;
483 long avail;
484 bool called_fput = false;
485 struct kiocb *req, *n;
486 struct aio_ring *ring;
487
488 to_alloc = min(batch->count, KIOCB_BATCH_SIZE);
489 for (allocated = 0; allocated < to_alloc; allocated++) {
490 req = __aio_get_req(ctx);
491 if (!req)
492 /* allocation failed, go with what we've got */
493 break;
494 list_add(&req->ki_batch, &batch->head);
495 }
496
497 if (allocated == 0)
498 goto out;
499
500retry:
501 spin_lock_irq(&ctx->ctx_lock);
502 ring = kmap_atomic(ctx->ring_info.ring_pages[0]);
503
504 avail = aio_ring_avail(&ctx->ring_info, ring) - ctx->reqs_active;
505 BUG_ON(avail < 0);
506 if (avail == 0 && !called_fput) {
507 /*
508 * Handle a potential starvation case. It is possible that
509 * we hold the last reference on a struct file, causing us
510 * to delay the final fput to non-irq context. In this case,
511 * ctx->reqs_active is artificially high. Calling the fput
512 * routine here may free up a slot in the event completion
513 * ring, allowing this allocation to succeed.
514 */
515 kunmap_atomic(ring);
516 spin_unlock_irq(&ctx->ctx_lock);
517 aio_fput_routine(NULL);
518 called_fput = true;
519 goto retry;
520 }
521
522 if (avail < allocated) {
523 /* Trim back the number of requests. */
524 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
525 list_del(&req->ki_batch);
526 kmem_cache_free(kiocb_cachep, req);
527 if (--allocated <= avail)
528 break;
529 }
530 }
531
532 batch->count -= allocated;
533 list_for_each_entry(req, &batch->head, ki_batch) {
534 list_add(&req->ki_list, &ctx->active_reqs);
535 ctx->reqs_active++;
536 }
537
538 kunmap_atomic(ring);
539 spin_unlock_irq(&ctx->ctx_lock);
540
541out:
542 return allocated;
543}
544
545static inline struct kiocb *aio_get_req(struct kioctx *ctx,
546 struct kiocb_batch *batch)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547{
548 struct kiocb *req;
Jeff Moyer080d6762011-11-02 13:40:10 -0700549
550 if (list_empty(&batch->head))
551 if (kiocb_batch_refill(ctx, batch) == 0)
552 return NULL;
553 req = list_first_entry(&batch->head, struct kiocb, ki_batch);
554 list_del(&req->ki_batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 return req;
556}
557
558static inline void really_put_req(struct kioctx *ctx, struct kiocb *req)
559{
Zach Brownd00689a2005-11-13 16:07:34 -0800560 assert_spin_locked(&ctx->ctx_lock);
561
Davide Libenzi13389012009-06-30 11:41:11 -0700562 if (req->ki_eventfd != NULL)
563 eventfd_ctx_put(req->ki_eventfd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 if (req->ki_dtor)
565 req->ki_dtor(req);
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700566 if (req->ki_iovec != &req->ki_inline_vec)
567 kfree(req->ki_iovec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 kmem_cache_free(kiocb_cachep, req);
569 ctx->reqs_active--;
570
571 if (unlikely(!ctx->reqs_active && ctx->dead))
Roland Dreiere91f90b2011-03-22 16:35:10 -0700572 wake_up_all(&ctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573}
574
David Howells65f27f32006-11-22 14:55:48 +0000575static void aio_fput_routine(struct work_struct *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
577 spin_lock_irq(&fput_lock);
578 while (likely(!list_empty(&fput_head))) {
579 struct kiocb *req = list_kiocb(fput_head.next);
580 struct kioctx *ctx = req->ki_ctx;
581
582 list_del(&req->ki_list);
583 spin_unlock_irq(&fput_lock);
584
Davide Libenzi87c3a862009-03-18 17:04:19 -0700585 /* Complete the fput(s) */
586 if (req->ki_filp != NULL)
Al Virod7065da2010-05-26 15:13:55 -0400587 fput(req->ki_filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
589 /* Link the iocb into the context's free list */
Al Viroc7b28552012-03-08 17:51:19 +0000590 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 spin_lock_irq(&ctx->ctx_lock);
592 really_put_req(ctx, req);
Al Viroc7b28552012-03-08 17:51:19 +0000593 /*
594 * at that point ctx might've been killed, but actual
595 * freeing is RCU'd
596 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 spin_unlock_irq(&ctx->ctx_lock);
Al Viroc7b28552012-03-08 17:51:19 +0000598 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 spin_lock_irq(&fput_lock);
601 }
602 spin_unlock_irq(&fput_lock);
603}
604
605/* __aio_put_req
606 * Returns true if this put was the last user of the request.
607 */
608static int __aio_put_req(struct kioctx *ctx, struct kiocb *req)
609{
Al Viro516e0cc2008-07-26 00:39:17 -0400610 dprintk(KERN_DEBUG "aio_put(%p): f_count=%ld\n",
611 req, atomic_long_read(&req->ki_filp->f_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Zach Brownd00689a2005-11-13 16:07:34 -0800613 assert_spin_locked(&ctx->ctx_lock);
614
Davide Libenzi87c3a862009-03-18 17:04:19 -0700615 req->ki_users--;
Eric Sesterhenn93e06b42006-11-30 05:29:23 +0100616 BUG_ON(req->ki_users < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 if (likely(req->ki_users))
618 return 0;
619 list_del(&req->ki_list); /* remove from active_reqs */
620 req->ki_cancel = NULL;
621 req->ki_retry = NULL;
622
Davide Libenzi87c3a862009-03-18 17:04:19 -0700623 /*
624 * Try to optimize the aio and eventfd file* puts, by avoiding to
Al Virod7065da2010-05-26 15:13:55 -0400625 * schedule work in case it is not final fput() time. In normal cases,
Davide Libenzi87c3a862009-03-18 17:04:19 -0700626 * we would not be holding the last reference to the file*, so
627 * this function will be executed w/out any aio kthread wakeup.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 */
Al Virod7065da2010-05-26 15:13:55 -0400629 if (unlikely(!fput_atomic(req->ki_filp))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 spin_lock(&fput_lock);
631 list_add(&req->ki_list, &fput_head);
632 spin_unlock(&fput_lock);
Tejun Heod37adaa2011-01-26 17:42:27 +0100633 schedule_work(&fput_work);
Davide Libenzi13389012009-06-30 11:41:11 -0700634 } else {
635 req->ki_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 really_put_req(ctx, req);
Davide Libenzi13389012009-06-30 11:41:11 -0700637 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 return 1;
639}
640
641/* aio_put_req
642 * Returns true if this put was the last user of the kiocb,
643 * false if the request is still in use.
644 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800645int aio_put_req(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
647 struct kioctx *ctx = req->ki_ctx;
648 int ret;
649 spin_lock_irq(&ctx->ctx_lock);
650 ret = __aio_put_req(ctx, req);
651 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return ret;
653}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700654EXPORT_SYMBOL(aio_put_req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Adrian Bunkd5470b52008-04-29 00:58:57 -0700656static struct kioctx *lookup_ioctx(unsigned long ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657{
Jens Axboeabf137d2008-12-09 08:11:22 +0100658 struct mm_struct *mm = current->mm;
Jeff Moyer65c24492009-03-18 17:04:21 -0700659 struct kioctx *ctx, *ret = NULL;
Jens Axboeabf137d2008-12-09 08:11:22 +0100660 struct hlist_node *n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Jens Axboeabf137d2008-12-09 08:11:22 +0100662 rcu_read_lock();
663
664 hlist_for_each_entry_rcu(ctx, n, &mm->ioctx_list, list) {
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800665 /*
666 * RCU protects us against accessing freed memory but
667 * we have to be careful not to get a reference when the
668 * reference count already dropped to 0 (ctx->dead test
669 * is unreliable because of races).
670 */
671 if (ctx->user_id == ctx_id && !ctx->dead && try_get_ioctx(ctx)){
Jeff Moyer65c24492009-03-18 17:04:21 -0700672 ret = ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 break;
674 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100675 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Jens Axboeabf137d2008-12-09 08:11:22 +0100677 rcu_read_unlock();
Jeff Moyer65c24492009-03-18 17:04:21 -0700678 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679}
680
681/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 * Queue up a kiocb to be retried. Assumes that the kiocb
683 * has already been marked as kicked, and places it on
684 * the retry run list for the corresponding ioctx, if it
685 * isn't already queued. Returns 1 if it actually queued
686 * the kiocb (to tell the caller to activate the work
687 * queue to process it), or 0, if it found that it was
688 * already queued.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 */
690static inline int __queue_kicked_iocb(struct kiocb *iocb)
691{
692 struct kioctx *ctx = iocb->ki_ctx;
693
Zach Brownd00689a2005-11-13 16:07:34 -0800694 assert_spin_locked(&ctx->ctx_lock);
695
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 if (list_empty(&iocb->ki_run_list)) {
697 list_add_tail(&iocb->ki_run_list,
698 &ctx->run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return 1;
700 }
701 return 0;
702}
703
704/* aio_run_iocb
705 * This is the core aio execution routine. It is
706 * invoked both for initial i/o submission and
707 * subsequent retries via the aio_kick_handler.
708 * Expects to be invoked with iocb->ki_ctx->lock
Andreas Mohrd6e05ed2006-06-26 18:35:02 +0200709 * already held. The lock is released and reacquired
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 * as needed during processing.
711 *
712 * Calls the iocb retry method (already setup for the
713 * iocb on initial submission) for operation specific
714 * handling, but takes care of most of common retry
715 * execution details for a given iocb. The retry method
716 * needs to be non-blocking as far as possible, to avoid
717 * holding up other iocbs waiting to be serviced by the
718 * retry kernel thread.
719 *
720 * The trickier parts in this code have to do with
721 * ensuring that only one retry instance is in progress
722 * for a given iocb at any time. Providing that guarantee
723 * simplifies the coding of individual aio operations as
724 * it avoids various potential races.
725 */
726static ssize_t aio_run_iocb(struct kiocb *iocb)
727{
728 struct kioctx *ctx = iocb->ki_ctx;
729 ssize_t (*retry)(struct kiocb *);
730 ssize_t ret;
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 if (!(retry = iocb->ki_retry)) {
733 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
734 return 0;
735 }
736
737 /*
738 * We don't want the next retry iteration for this
739 * operation to start until this one has returned and
740 * updated the iocb state. However, wait_queue functions
741 * can trigger a kick_iocb from interrupt context in the
742 * meantime, indicating that data is available for the next
743 * iteration. We want to remember that and enable the
744 * next retry iteration _after_ we are through with
745 * this one.
746 *
747 * So, in order to be able to register a "kick", but
748 * prevent it from being queued now, we clear the kick
749 * flag, but make the kick code *think* that the iocb is
750 * still on the run list until we are actually done.
751 * When we are done with this iteration, we check if
752 * the iocb was kicked in the meantime and if so, queue
753 * it up afresh.
754 */
755
756 kiocbClearKicked(iocb);
757
758 /*
759 * This is so that aio_complete knows it doesn't need to
760 * pull the iocb off the run list (We can't just call
761 * INIT_LIST_HEAD because we don't want a kick_iocb to
762 * queue this on the run list yet)
763 */
764 iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
765 spin_unlock_irq(&ctx->ctx_lock);
766
767 /* Quit retrying if the i/o has been cancelled */
768 if (kiocbIsCancelled(iocb)) {
769 ret = -EINTR;
770 aio_complete(iocb, ret, 0);
771 /* must not access the iocb after this */
772 goto out;
773 }
774
775 /*
776 * Now we are all set to call the retry method in async
Alexey Dobriyan6212e3a2007-10-18 03:04:56 -0700777 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 ret = retry(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Jan Karaa0c42ba2010-09-22 13:05:03 -0700781 if (ret != -EIOCBRETRY && ret != -EIOCBQUEUED) {
782 /*
783 * There's no easy way to restart the syscall since other AIO's
784 * may be already running. Just fail this IO with EINTR.
785 */
786 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
787 ret == -ERESTARTNOHAND || ret == -ERESTART_RESTARTBLOCK))
788 ret = -EINTR;
Zach Brown897f15f2005-09-30 11:58:55 -0700789 aio_complete(iocb, ret, 0);
Jan Karaa0c42ba2010-09-22 13:05:03 -0700790 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791out:
792 spin_lock_irq(&ctx->ctx_lock);
793
794 if (-EIOCBRETRY == ret) {
795 /*
796 * OK, now that we are done with this iteration
797 * and know that there is more left to go,
798 * this is where we let go so that a subsequent
799 * "kick" can start the next iteration
800 */
801
802 /* will make __queue_kicked_iocb succeed from here on */
803 INIT_LIST_HEAD(&iocb->ki_run_list);
804 /* we must queue the next iteration ourselves, if it
805 * has already been kicked */
806 if (kiocbIsKicked(iocb)) {
807 __queue_kicked_iocb(iocb);
Sébastien Duguc016e222005-06-28 20:44:59 -0700808
809 /*
810 * __queue_kicked_iocb will always return 1 here, because
811 * iocb->ki_run_list is empty at this point so it should
812 * be safe to unconditionally queue the context into the
813 * work queue.
814 */
815 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 }
817 }
818 return ret;
819}
820
821/*
822 * __aio_run_iocbs:
823 * Process all pending retries queued on the ioctx
824 * run list.
825 * Assumes it is operating within the aio issuer's mm
Zach Brownd00689a2005-11-13 16:07:34 -0800826 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 */
828static int __aio_run_iocbs(struct kioctx *ctx)
829{
830 struct kiocb *iocb;
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700831 struct list_head run_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
Zach Brownd00689a2005-11-13 16:07:34 -0800833 assert_spin_locked(&ctx->ctx_lock);
834
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700835 list_replace_init(&ctx->run_list, &run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 while (!list_empty(&run_list)) {
837 iocb = list_entry(run_list.next, struct kiocb,
838 ki_run_list);
839 list_del(&iocb->ki_run_list);
840 /*
841 * Hold an extra reference while retrying i/o.
842 */
843 iocb->ki_users++; /* grab extra reference */
844 aio_run_iocb(iocb);
Ken Chendee11c22007-02-03 01:13:45 -0800845 __aio_put_req(ctx, iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 if (!list_empty(&ctx->run_list))
848 return 1;
849 return 0;
850}
851
852static void aio_queue_work(struct kioctx * ctx)
853{
854 unsigned long timeout;
855 /*
856 * if someone is waiting, get the work started right
857 * away, otherwise, use a longer delay
858 */
859 smp_mb();
860 if (waitqueue_active(&ctx->wait))
861 timeout = 1;
862 else
863 timeout = HZ/10;
864 queue_delayed_work(aio_wq, &ctx->wq, timeout);
865}
866
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867/*
Jeff Moyerd3486f82011-01-12 17:01:08 -0800868 * aio_run_all_iocbs:
869 * Process all pending retries queued on the ioctx
870 * run list, and keep running them until the list
871 * stays empty.
872 * Assumes it is operating within the aio issuer's mm context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 */
874static inline void aio_run_all_iocbs(struct kioctx *ctx)
875{
876 spin_lock_irq(&ctx->ctx_lock);
877 while (__aio_run_iocbs(ctx))
878 ;
879 spin_unlock_irq(&ctx->ctx_lock);
880}
881
882/*
883 * aio_kick_handler:
884 * Work queue handler triggered to process pending
885 * retries on an ioctx. Takes on the aio issuer's
886 * mm context before running the iocbs, so that
887 * copy_xxx_user operates on the issuer's address
888 * space.
889 * Run on aiod's context.
890 */
David Howells65f27f32006-11-22 14:55:48 +0000891static void aio_kick_handler(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892{
David Howells65f27f32006-11-22 14:55:48 +0000893 struct kioctx *ctx = container_of(work, struct kioctx, wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 mm_segment_t oldfs = get_fs();
Zach Brown1ebb1102006-12-29 16:47:02 -0800895 struct mm_struct *mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 int requeue;
897
898 set_fs(USER_DS);
899 use_mm(ctx->mm);
900 spin_lock_irq(&ctx->ctx_lock);
901 requeue =__aio_run_iocbs(ctx);
Zach Brown1ebb1102006-12-29 16:47:02 -0800902 mm = ctx->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 spin_unlock_irq(&ctx->ctx_lock);
Zach Brown1ebb1102006-12-29 16:47:02 -0800904 unuse_mm(mm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 set_fs(oldfs);
906 /*
907 * we're in a worker thread already, don't use queue_delayed_work,
908 */
909 if (requeue)
David Howells52bad642006-11-22 14:54:01 +0000910 queue_delayed_work(aio_wq, &ctx->wq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911}
912
913
914/*
915 * Called by kick_iocb to queue the kiocb for retry
916 * and if required activate the aio work queue to process
917 * it
918 */
Zach Brown998765e2005-09-30 11:58:54 -0700919static void try_queue_kicked_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920{
921 struct kioctx *ctx = iocb->ki_ctx;
922 unsigned long flags;
923 int run = 0;
924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 spin_lock_irqsave(&ctx->ctx_lock, flags);
Zach Brown998765e2005-09-30 11:58:54 -0700926 /* set this inside the lock so that we can't race with aio_run_iocb()
927 * testing it and putting the iocb on the run list under the lock */
928 if (!kiocbTryKick(iocb))
929 run = __queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Ken Chen644d3a02005-05-01 08:59:15 -0700931 if (run)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933}
934
935/*
936 * kick_iocb:
937 * Called typically from a wait queue callback context
Shaohua Lifac046a2009-12-15 16:47:47 -0800938 * to trigger a retry of the iocb.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 * The retry is usually executed by aio workqueue
940 * threads (See aio_kick_handler).
941 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800942void kick_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943{
944 /* sync iocbs are easy: they can only ever be executing from a
945 * single context. */
946 if (is_sync_kiocb(iocb)) {
947 kiocbSetKicked(iocb);
948 wake_up_process(iocb->ki_obj.tsk);
949 return;
950 }
951
Zach Brown998765e2005-09-30 11:58:54 -0700952 try_queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953}
954EXPORT_SYMBOL(kick_iocb);
955
956/* aio_complete
957 * Called when the io request on the given iocb is complete.
958 * Returns true if this is the last user of the request. The
959 * only other user of the request can be the cancellation code.
960 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800961int aio_complete(struct kiocb *iocb, long res, long res2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962{
963 struct kioctx *ctx = iocb->ki_ctx;
964 struct aio_ring_info *info;
965 struct aio_ring *ring;
966 struct io_event *event;
967 unsigned long flags;
968 unsigned long tail;
969 int ret;
970
Zach Brown20dcae32005-11-13 16:07:33 -0800971 /*
972 * Special case handling for sync iocbs:
973 * - events go directly into the iocb for fast handling
974 * - the sync task with the iocb in its stack holds the single iocb
975 * ref, no other paths have a way to get another ref
976 * - the sync task helpfully left a reference to itself in the iocb
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 */
978 if (is_sync_kiocb(iocb)) {
Zach Brown20dcae32005-11-13 16:07:33 -0800979 BUG_ON(iocb->ki_users != 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 iocb->ki_user_data = res;
Zach Brown20dcae32005-11-13 16:07:33 -0800981 iocb->ki_users = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 wake_up_process(iocb->ki_obj.tsk);
Zach Brown20dcae32005-11-13 16:07:33 -0800983 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 }
985
986 info = &ctx->ring_info;
987
988 /* add a completion event to the ring buffer.
989 * must be done holding ctx->ctx_lock to prevent
990 * other code from messing with the tail
991 * pointer since we might be called from irq
992 * context.
993 */
994 spin_lock_irqsave(&ctx->ctx_lock, flags);
995
996 if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
997 list_del_init(&iocb->ki_run_list);
998
999 /*
1000 * cancelled requests don't get events, userland was given one
1001 * when the event got cancelled.
1002 */
1003 if (kiocbIsCancelled(iocb))
1004 goto put_rq;
1005
1006 ring = kmap_atomic(info->ring_pages[0], KM_IRQ1);
1007
1008 tail = info->tail;
1009 event = aio_ring_event(info, tail, KM_IRQ0);
Ken Chen4bf69b22005-05-01 08:59:15 -07001010 if (++tail >= info->nr)
1011 tail = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013 event->obj = (u64)(unsigned long)iocb->ki_obj.user;
1014 event->data = iocb->ki_user_data;
1015 event->res = res;
1016 event->res2 = res2;
1017
1018 dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
1019 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
1020 res, res2);
1021
1022 /* after flagging the request as done, we
1023 * must never even look at it again
1024 */
1025 smp_wmb(); /* make event visible before updating tail */
1026
1027 info->tail = tail;
1028 ring->tail = tail;
1029
1030 put_aio_ring_event(event, KM_IRQ0);
1031 kunmap_atomic(ring, KM_IRQ1);
1032
1033 pr_debug("added to ring %p at [%lu]\n", iocb, tail);
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001034
1035 /*
1036 * Check if the user asked us to deliver the result through an
1037 * eventfd. The eventfd_signal() function is safe to be called
1038 * from IRQ context.
1039 */
Davide Libenzi87c3a862009-03-18 17:04:19 -07001040 if (iocb->ki_eventfd != NULL)
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001041 eventfd_signal(iocb->ki_eventfd, 1);
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043put_rq:
1044 /* everything turned out well, dispose of the aiocb. */
1045 ret = __aio_put_req(ctx, iocb);
1046
Quentin Barnes6cb2a212008-03-19 17:00:39 -07001047 /*
1048 * We have to order our ring_info tail store above and test
1049 * of the wait list below outside the wait lock. This is
1050 * like in wake_up_bit() where clearing a bit has to be
1051 * ordered with the unlocked test.
1052 */
1053 smp_mb();
1054
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 if (waitqueue_active(&ctx->wait))
1056 wake_up(&ctx->wait);
1057
Ken Chendee11c22007-02-03 01:13:45 -08001058 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 return ret;
1060}
H Hartley Sweeten385773e2009-09-22 16:43:53 -07001061EXPORT_SYMBOL(aio_complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
1063/* aio_read_evt
1064 * Pull an event off of the ioctx's event ring. Returns the number of
1065 * events fetched (0 or 1 ;-)
1066 * FIXME: make this use cmpxchg.
1067 * TODO: make the ringbuffer user mmap()able (requires FIXME).
1068 */
1069static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
1070{
1071 struct aio_ring_info *info = &ioctx->ring_info;
1072 struct aio_ring *ring;
1073 unsigned long head;
1074 int ret = 0;
1075
1076 ring = kmap_atomic(info->ring_pages[0], KM_USER0);
1077 dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1078 (unsigned long)ring->head, (unsigned long)ring->tail,
1079 (unsigned long)ring->nr);
1080
1081 if (ring->head == ring->tail)
1082 goto out;
1083
1084 spin_lock(&info->ring_lock);
1085
1086 head = ring->head % info->nr;
1087 if (head != ring->tail) {
1088 struct io_event *evp = aio_ring_event(info, head, KM_USER1);
1089 *ent = *evp;
1090 head = (head + 1) % info->nr;
1091 smp_mb(); /* finish reading the event before updatng the head */
1092 ring->head = head;
1093 ret = 1;
1094 put_aio_ring_event(evp, KM_USER1);
1095 }
1096 spin_unlock(&info->ring_lock);
1097
1098out:
1099 kunmap_atomic(ring, KM_USER0);
1100 dprintk("leaving aio_read_evt: %d h%lu t%lu\n", ret,
1101 (unsigned long)ring->head, (unsigned long)ring->tail);
1102 return ret;
1103}
1104
1105struct aio_timeout {
1106 struct timer_list timer;
1107 int timed_out;
1108 struct task_struct *p;
1109};
1110
1111static void timeout_func(unsigned long data)
1112{
1113 struct aio_timeout *to = (struct aio_timeout *)data;
1114
1115 to->timed_out = 1;
1116 wake_up_process(to->p);
1117}
1118
1119static inline void init_timeout(struct aio_timeout *to)
1120{
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001121 setup_timer_on_stack(&to->timer, timeout_func, (unsigned long) to);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 to->timed_out = 0;
1123 to->p = current;
1124}
1125
1126static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
1127 const struct timespec *ts)
1128{
1129 to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
1130 if (time_after(to->timer.expires, jiffies))
1131 add_timer(&to->timer);
1132 else
1133 to->timed_out = 1;
1134}
1135
1136static inline void clear_timeout(struct aio_timeout *to)
1137{
1138 del_singleshot_timer_sync(&to->timer);
1139}
1140
1141static int read_events(struct kioctx *ctx,
1142 long min_nr, long nr,
1143 struct io_event __user *event,
1144 struct timespec __user *timeout)
1145{
1146 long start_jiffies = jiffies;
1147 struct task_struct *tsk = current;
1148 DECLARE_WAITQUEUE(wait, tsk);
1149 int ret;
1150 int i = 0;
1151 struct io_event ent;
1152 struct aio_timeout to;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 int retry = 0;
1154
1155 /* needed to zero any padding within an entry (there shouldn't be
1156 * any, but C is fun!
1157 */
1158 memset(&ent, 0, sizeof(ent));
1159retry:
1160 ret = 0;
1161 while (likely(i < nr)) {
1162 ret = aio_read_evt(ctx, &ent);
1163 if (unlikely(ret <= 0))
1164 break;
1165
1166 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1167 ent.data, ent.obj, ent.res, ent.res2);
1168
1169 /* Could we split the check in two? */
1170 ret = -EFAULT;
1171 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1172 dprintk("aio: lost an event due to EFAULT.\n");
1173 break;
1174 }
1175 ret = 0;
1176
1177 /* Good, event copied to userland, update counts. */
1178 event ++;
1179 i ++;
1180 }
1181
1182 if (min_nr <= i)
1183 return i;
1184 if (ret)
1185 return ret;
1186
1187 /* End fast path */
1188
1189 /* racey check, but it gets redone */
1190 if (!retry && unlikely(!list_empty(&ctx->run_list))) {
1191 retry = 1;
1192 aio_run_all_iocbs(ctx);
1193 goto retry;
1194 }
1195
1196 init_timeout(&to);
1197 if (timeout) {
1198 struct timespec ts;
1199 ret = -EFAULT;
1200 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1201 goto out;
1202
1203 set_timeout(start_jiffies, &to, &ts);
1204 }
1205
1206 while (likely(i < nr)) {
1207 add_wait_queue_exclusive(&ctx->wait, &wait);
1208 do {
1209 set_task_state(tsk, TASK_INTERRUPTIBLE);
1210 ret = aio_read_evt(ctx, &ent);
1211 if (ret)
1212 break;
1213 if (min_nr <= i)
1214 break;
Jeff Moyere92adcb2008-04-28 02:12:04 -07001215 if (unlikely(ctx->dead)) {
1216 ret = -EINVAL;
1217 break;
1218 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 if (to.timed_out) /* Only check after read evt */
1220 break;
Jeff Moyere00ba3d2007-12-04 23:45:02 -08001221 /* Try to only show up in io wait if there are ops
1222 * in flight */
1223 if (ctx->reqs_active)
1224 io_schedule();
1225 else
1226 schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 if (signal_pending(tsk)) {
1228 ret = -EINTR;
1229 break;
1230 }
1231 /*ret = aio_read_evt(ctx, &ent);*/
1232 } while (1) ;
1233
1234 set_task_state(tsk, TASK_RUNNING);
1235 remove_wait_queue(&ctx->wait, &wait);
1236
1237 if (unlikely(ret <= 0))
1238 break;
1239
1240 ret = -EFAULT;
1241 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1242 dprintk("aio: lost an event due to EFAULT.\n");
1243 break;
1244 }
1245
1246 /* Good, event copied to userland, update counts. */
1247 event ++;
1248 i ++;
1249 }
1250
1251 if (timeout)
1252 clear_timeout(&to);
1253out:
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001254 destroy_timer_on_stack(&to.timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 return i ? i : ret;
1256}
1257
1258/* Take an ioctx and remove it from the list of ioctx's. Protects
1259 * against races with itself via ->dead.
1260 */
1261static void io_destroy(struct kioctx *ioctx)
1262{
1263 struct mm_struct *mm = current->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 int was_dead;
1265
1266 /* delete the entry from the list is someone else hasn't already */
Jens Axboeabf137d2008-12-09 08:11:22 +01001267 spin_lock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 was_dead = ioctx->dead;
1269 ioctx->dead = 1;
Jens Axboeabf137d2008-12-09 08:11:22 +01001270 hlist_del_rcu(&ioctx->list);
1271 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
1273 dprintk("aio_release(%p)\n", ioctx);
1274 if (likely(!was_dead))
1275 put_ioctx(ioctx); /* twice for the list */
1276
1277 aio_cancel_all(ioctx);
1278 wait_for_all_aios(ioctx);
Jeff Moyere92adcb2008-04-28 02:12:04 -07001279
1280 /*
1281 * Wake up any waiters. The setting of ctx->dead must be seen
1282 * by other CPUs at this point. Right now, we rely on the
1283 * locking done by the above calls to ensure this consistency.
1284 */
Roland Dreiere91f90b2011-03-22 16:35:10 -07001285 wake_up_all(&ioctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 put_ioctx(ioctx); /* once for the lookup */
1287}
1288
1289/* sys_io_setup:
1290 * Create an aio_context capable of receiving at least nr_events.
1291 * ctxp must not point to an aio_context that already exists, and
1292 * must be initialized to 0 prior to the call. On successful
1293 * creation of the aio_context, *ctxp is filled in with the resulting
1294 * handle. May fail with -EINVAL if *ctxp is not initialized,
1295 * if the specified nr_events exceeds internal limits. May fail
1296 * with -EAGAIN if the specified nr_events exceeds the user's limit
1297 * of available events. May fail with -ENOMEM if insufficient kernel
1298 * resources are available. May fail with -EFAULT if an invalid
1299 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1300 * implemented.
1301 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001302SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303{
1304 struct kioctx *ioctx = NULL;
1305 unsigned long ctx;
1306 long ret;
1307
1308 ret = get_user(ctx, ctxp);
1309 if (unlikely(ret))
1310 goto out;
1311
1312 ret = -EINVAL;
Zach Brownd55b5fd2005-11-07 00:59:31 -08001313 if (unlikely(ctx || nr_events == 0)) {
1314 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1315 ctx, nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 goto out;
1317 }
1318
1319 ioctx = ioctx_alloc(nr_events);
1320 ret = PTR_ERR(ioctx);
1321 if (!IS_ERR(ioctx)) {
1322 ret = put_user(ioctx->user_id, ctxp);
Al Viro86b62a22012-03-07 05:16:35 +00001323 if (!ret) {
1324 put_ioctx(ioctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 return 0;
Al Viro86b62a22012-03-07 05:16:35 +00001326 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 io_destroy(ioctx);
1328 }
1329
1330out:
1331 return ret;
1332}
1333
1334/* sys_io_destroy:
1335 * Destroy the aio_context specified. May cancel any outstanding
1336 * AIOs and block on completion. Will fail with -ENOSYS if not
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001337 * implemented. May fail with -EINVAL if the context pointed to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 * is invalid.
1339 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001340SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341{
1342 struct kioctx *ioctx = lookup_ioctx(ctx);
1343 if (likely(NULL != ioctx)) {
1344 io_destroy(ioctx);
1345 return 0;
1346 }
1347 pr_debug("EINVAL: io_destroy: invalid context id\n");
1348 return -EINVAL;
1349}
1350
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001351static void aio_advance_iovec(struct kiocb *iocb, ssize_t ret)
1352{
1353 struct iovec *iov = &iocb->ki_iovec[iocb->ki_cur_seg];
1354
1355 BUG_ON(ret <= 0);
1356
1357 while (iocb->ki_cur_seg < iocb->ki_nr_segs && ret > 0) {
1358 ssize_t this = min((ssize_t)iov->iov_len, ret);
1359 iov->iov_base += this;
1360 iov->iov_len -= this;
1361 iocb->ki_left -= this;
1362 ret -= this;
1363 if (iov->iov_len == 0) {
1364 iocb->ki_cur_seg++;
1365 iov++;
1366 }
1367 }
1368
1369 /* the caller should not have done more io than what fit in
1370 * the remaining iovecs */
1371 BUG_ON(ret > 0 && iocb->ki_left == 0);
1372}
1373
1374static ssize_t aio_rw_vect_retry(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375{
1376 struct file *file = iocb->ki_filp;
1377 struct address_space *mapping = file->f_mapping;
1378 struct inode *inode = mapping->host;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001379 ssize_t (*rw_op)(struct kiocb *, const struct iovec *,
1380 unsigned long, loff_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 ssize_t ret = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001382 unsigned short opcode;
1383
1384 if ((iocb->ki_opcode == IOCB_CMD_PREADV) ||
1385 (iocb->ki_opcode == IOCB_CMD_PREAD)) {
1386 rw_op = file->f_op->aio_read;
1387 opcode = IOCB_CMD_PREADV;
1388 } else {
1389 rw_op = file->f_op->aio_write;
1390 opcode = IOCB_CMD_PWRITEV;
1391 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Rusty Russellc2ec6682008-02-08 04:20:15 -08001393 /* This matches the pread()/pwrite() logic */
1394 if (iocb->ki_pos < 0)
1395 return -EINVAL;
1396
Zach Brown897f15f2005-09-30 11:58:55 -07001397 do {
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001398 ret = rw_op(iocb, &iocb->ki_iovec[iocb->ki_cur_seg],
1399 iocb->ki_nr_segs - iocb->ki_cur_seg,
1400 iocb->ki_pos);
1401 if (ret > 0)
1402 aio_advance_iovec(iocb, ret);
Badari Pulavarty027445c2006-09-30 23:28:46 -07001403
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001404 /* retry all partial writes. retry partial reads as long as its a
1405 * regular file. */
Zach Brown353fb072005-09-30 11:58:56 -07001406 } while (ret > 0 && iocb->ki_left > 0 &&
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001407 (opcode == IOCB_CMD_PWRITEV ||
1408 (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409
1410 /* This means we must have transferred all that we could */
1411 /* No need to retry anymore */
1412 if ((ret == 0) || (iocb->ki_left == 0))
1413 ret = iocb->ki_nbytes - iocb->ki_left;
1414
Rusty Russell7adfa2f2008-02-08 04:20:14 -08001415 /* If we managed to write some out we return that, rather than
1416 * the eventual error. */
1417 if (opcode == IOCB_CMD_PWRITEV
1418 && ret < 0 && ret != -EIOCBQUEUED && ret != -EIOCBRETRY
1419 && iocb->ki_nbytes - iocb->ki_left)
1420 ret = iocb->ki_nbytes - iocb->ki_left;
1421
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 return ret;
1423}
1424
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425static ssize_t aio_fdsync(struct kiocb *iocb)
1426{
1427 struct file *file = iocb->ki_filp;
1428 ssize_t ret = -EINVAL;
1429
1430 if (file->f_op->aio_fsync)
1431 ret = file->f_op->aio_fsync(iocb, 1);
1432 return ret;
1433}
1434
1435static ssize_t aio_fsync(struct kiocb *iocb)
1436{
1437 struct file *file = iocb->ki_filp;
1438 ssize_t ret = -EINVAL;
1439
1440 if (file->f_op->aio_fsync)
1441 ret = file->f_op->aio_fsync(iocb, 0);
1442 return ret;
1443}
1444
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001445static ssize_t aio_setup_vectored_rw(int type, struct kiocb *kiocb, bool compat)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001446{
1447 ssize_t ret;
1448
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001449#ifdef CONFIG_COMPAT
1450 if (compat)
1451 ret = compat_rw_copy_check_uvector(type,
1452 (struct compat_iovec __user *)kiocb->ki_buf,
1453 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001454 &kiocb->ki_iovec, 1);
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001455 else
1456#endif
1457 ret = rw_copy_check_uvector(type,
1458 (struct iovec __user *)kiocb->ki_buf,
1459 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001460 &kiocb->ki_iovec, 1);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001461 if (ret < 0)
1462 goto out;
1463
1464 kiocb->ki_nr_segs = kiocb->ki_nbytes;
1465 kiocb->ki_cur_seg = 0;
1466 /* ki_nbytes/left now reflect bytes instead of segs */
1467 kiocb->ki_nbytes = ret;
1468 kiocb->ki_left = ret;
1469
1470 ret = 0;
1471out:
1472 return ret;
1473}
1474
1475static ssize_t aio_setup_single_vector(struct kiocb *kiocb)
1476{
1477 kiocb->ki_iovec = &kiocb->ki_inline_vec;
1478 kiocb->ki_iovec->iov_base = kiocb->ki_buf;
1479 kiocb->ki_iovec->iov_len = kiocb->ki_left;
1480 kiocb->ki_nr_segs = 1;
1481 kiocb->ki_cur_seg = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001482 return 0;
1483}
1484
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485/*
1486 * aio_setup_iocb:
1487 * Performs the initial checks and aio retry method
1488 * setup for the kiocb at the time of io submission.
1489 */
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001490static ssize_t aio_setup_iocb(struct kiocb *kiocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491{
1492 struct file *file = kiocb->ki_filp;
1493 ssize_t ret = 0;
1494
1495 switch (kiocb->ki_opcode) {
1496 case IOCB_CMD_PREAD:
1497 ret = -EBADF;
1498 if (unlikely(!(file->f_mode & FMODE_READ)))
1499 break;
1500 ret = -EFAULT;
1501 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1502 kiocb->ki_left)))
1503 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001504 ret = security_file_permission(file, MAY_READ);
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_read)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001512 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 break;
1514 case IOCB_CMD_PWRITE:
1515 ret = -EBADF;
1516 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1517 break;
1518 ret = -EFAULT;
1519 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1520 kiocb->ki_left)))
1521 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001522 ret = security_file_permission(file, MAY_WRITE);
1523 if (unlikely(ret))
1524 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001525 ret = aio_setup_single_vector(kiocb);
1526 if (ret)
1527 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 ret = -EINVAL;
1529 if (file->f_op->aio_write)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001530 kiocb->ki_retry = aio_rw_vect_retry;
1531 break;
1532 case IOCB_CMD_PREADV:
1533 ret = -EBADF;
1534 if (unlikely(!(file->f_mode & FMODE_READ)))
1535 break;
1536 ret = security_file_permission(file, MAY_READ);
1537 if (unlikely(ret))
1538 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001539 ret = aio_setup_vectored_rw(READ, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001540 if (ret)
1541 break;
1542 ret = -EINVAL;
1543 if (file->f_op->aio_read)
1544 kiocb->ki_retry = aio_rw_vect_retry;
1545 break;
1546 case IOCB_CMD_PWRITEV:
1547 ret = -EBADF;
1548 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1549 break;
1550 ret = security_file_permission(file, MAY_WRITE);
1551 if (unlikely(ret))
1552 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001553 ret = aio_setup_vectored_rw(WRITE, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001554 if (ret)
1555 break;
1556 ret = -EINVAL;
1557 if (file->f_op->aio_write)
1558 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 break;
1560 case IOCB_CMD_FDSYNC:
1561 ret = -EINVAL;
1562 if (file->f_op->aio_fsync)
1563 kiocb->ki_retry = aio_fdsync;
1564 break;
1565 case IOCB_CMD_FSYNC:
1566 ret = -EINVAL;
1567 if (file->f_op->aio_fsync)
1568 kiocb->ki_retry = aio_fsync;
1569 break;
1570 default:
1571 dprintk("EINVAL: io_submit: no operation provided\n");
1572 ret = -EINVAL;
1573 }
1574
1575 if (!kiocb->ki_retry)
1576 return ret;
1577
1578 return 0;
1579}
1580
Adrian Bunkd5470b52008-04-29 00:58:57 -07001581static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
Jeff Moyer080d6762011-11-02 13:40:10 -07001582 struct iocb *iocb, struct kiocb_batch *batch,
1583 bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584{
1585 struct kiocb *req;
1586 struct file *file;
1587 ssize_t ret;
1588
1589 /* enforce forwards compatibility on users */
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001590 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 pr_debug("EINVAL: io_submit: reserve field set\n");
1592 return -EINVAL;
1593 }
1594
1595 /* prevent overflows */
1596 if (unlikely(
1597 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1598 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1599 ((ssize_t)iocb->aio_nbytes < 0)
1600 )) {
1601 pr_debug("EINVAL: io_submit: overflow check\n");
1602 return -EINVAL;
1603 }
1604
1605 file = fget(iocb->aio_fildes);
1606 if (unlikely(!file))
1607 return -EBADF;
1608
Jeff Moyer080d6762011-11-02 13:40:10 -07001609 req = aio_get_req(ctx, batch); /* returns with 2 references to req */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 if (unlikely(!req)) {
1611 fput(file);
1612 return -EAGAIN;
1613 }
Yan Zheng87e28312007-10-08 12:16:20 -07001614 req->ki_filp = file;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001615 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1616 /*
1617 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1618 * instance of the file* now. The file descriptor must be
1619 * an eventfd() fd, and will be signaled for each completed
1620 * event using the eventfd_signal() function.
1621 */
Davide Libenzi13389012009-06-30 11:41:11 -07001622 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -07001623 if (IS_ERR(req->ki_eventfd)) {
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001624 ret = PTR_ERR(req->ki_eventfd);
Davide Libenzi87c3a862009-03-18 17:04:19 -07001625 req->ki_eventfd = NULL;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001626 goto out_put_req;
1627 }
1628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Ken Chen212079c2005-05-01 08:59:15 -07001630 ret = put_user(req->ki_key, &user_iocb->aio_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 if (unlikely(ret)) {
1632 dprintk("EFAULT: aio_key\n");
1633 goto out_put_req;
1634 }
1635
1636 req->ki_obj.user = user_iocb;
1637 req->ki_user_data = iocb->aio_data;
1638 req->ki_pos = iocb->aio_offset;
1639
1640 req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1641 req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1642 req->ki_opcode = iocb->aio_lio_opcode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001644 ret = aio_setup_iocb(req, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
1646 if (ret)
1647 goto out_put_req;
1648
1649 spin_lock_irq(&ctx->ctx_lock);
Jan Kara7137c6bd2011-02-25 14:44:27 -08001650 /*
1651 * We could have raced with io_destroy() and are currently holding a
1652 * reference to ctx which should be destroyed. We cannot submit IO
1653 * since ctx gets freed as soon as io_submit() puts its reference. The
1654 * check here is reliable: io_destroy() sets ctx->dead before waiting
1655 * for outstanding IO and the barrier between these two is realized by
1656 * unlock of mm->ioctx_lock and lock of ctx->ctx_lock. Analogously we
1657 * increment ctx->reqs_active before checking for ctx->dead and the
1658 * barrier is realized by unlock and lock of ctx->ctx_lock. Thus if we
1659 * don't see ctx->dead set here, io_destroy() waits for our IO to
1660 * finish.
1661 */
1662 if (ctx->dead) {
1663 spin_unlock_irq(&ctx->ctx_lock);
1664 ret = -EINVAL;
1665 goto out_put_req;
1666 }
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001667 aio_run_iocb(req);
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001668 if (!list_empty(&ctx->run_list)) {
Ken Chen954d3e92005-05-01 08:59:16 -07001669 /* drain the run list */
1670 while (__aio_run_iocbs(ctx))
1671 ;
1672 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyercfb1e332009-10-02 18:57:36 -04001674
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 aio_put_req(req); /* drop extra ref to req */
1676 return 0;
1677
1678out_put_req:
1679 aio_put_req(req); /* drop extra ref to req */
1680 aio_put_req(req); /* drop i/o ref to req */
1681 return ret;
1682}
1683
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001684long do_io_submit(aio_context_t ctx_id, long nr,
1685 struct iocb __user *__user *iocbpp, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686{
1687 struct kioctx *ctx;
1688 long ret = 0;
Jeff Moyer080d6762011-11-02 13:40:10 -07001689 int i = 0;
Shaohua Li9f5b9422010-07-01 07:55:01 +02001690 struct blk_plug plug;
Jeff Moyer080d6762011-11-02 13:40:10 -07001691 struct kiocb_batch batch;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
1693 if (unlikely(nr < 0))
1694 return -EINVAL;
1695
Jeff Moyer75e1c702010-09-10 14:16:00 -07001696 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1697 nr = LONG_MAX/sizeof(*iocbpp);
1698
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1700 return -EFAULT;
1701
1702 ctx = lookup_ioctx(ctx_id);
1703 if (unlikely(!ctx)) {
1704 pr_debug("EINVAL: io_submit: invalid context id\n");
1705 return -EINVAL;
1706 }
1707
Jeff Moyer080d6762011-11-02 13:40:10 -07001708 kiocb_batch_init(&batch, nr);
1709
Shaohua Li9f5b9422010-07-01 07:55:01 +02001710 blk_start_plug(&plug);
1711
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 /*
1713 * AKPM: should this return a partial result if some of the IOs were
1714 * successfully submitted?
1715 */
1716 for (i=0; i<nr; i++) {
1717 struct iocb __user *user_iocb;
1718 struct iocb tmp;
1719
1720 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1721 ret = -EFAULT;
1722 break;
1723 }
1724
1725 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1726 ret = -EFAULT;
1727 break;
1728 }
1729
Jeff Moyer080d6762011-11-02 13:40:10 -07001730 ret = io_submit_one(ctx, user_iocb, &tmp, &batch, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 if (ret)
1732 break;
1733 }
Shaohua Li9f5b9422010-07-01 07:55:01 +02001734 blk_finish_plug(&plug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735
Gleb Natapov69e47472012-01-08 17:07:28 +02001736 kiocb_batch_free(ctx, &batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 put_ioctx(ctx);
1738 return i ? i : ret;
1739}
1740
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001741/* sys_io_submit:
1742 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1743 * the number of iocbs queued. May return -EINVAL if the aio_context
1744 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1745 * *iocbpp[0] is not properly initialized, if the operation specified
1746 * is invalid for the file descriptor in the iocb. May fail with
1747 * -EFAULT if any of the data structures point to invalid data. May
1748 * fail with -EBADF if the file descriptor specified in the first
1749 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1750 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1751 * fail with -ENOSYS if not implemented.
1752 */
1753SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1754 struct iocb __user * __user *, iocbpp)
1755{
1756 return do_io_submit(ctx_id, nr, iocbpp, 0);
1757}
1758
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759/* lookup_kiocb
1760 * Finds a given iocb for cancellation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 */
Adrian Bunk25ee7e32005-04-25 08:18:14 -07001762static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1763 u32 key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764{
1765 struct list_head *pos;
Zach Brownd00689a2005-11-13 16:07:34 -08001766
1767 assert_spin_locked(&ctx->ctx_lock);
1768
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 /* TODO: use a hash or array, this sucks. */
1770 list_for_each(pos, &ctx->active_reqs) {
1771 struct kiocb *kiocb = list_kiocb(pos);
1772 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1773 return kiocb;
1774 }
1775 return NULL;
1776}
1777
1778/* sys_io_cancel:
1779 * Attempts to cancel an iocb previously passed to io_submit. If
1780 * the operation is successfully cancelled, the resulting event is
1781 * copied into the memory pointed to by result without being placed
1782 * into the completion queue and 0 is returned. May fail with
1783 * -EFAULT if any of the data structures pointed to are invalid.
1784 * May fail with -EINVAL if aio_context specified by ctx_id is
1785 * invalid. May fail with -EAGAIN if the iocb specified was not
1786 * cancelled. Will fail with -ENOSYS if not implemented.
1787 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001788SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1789 struct io_event __user *, result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790{
1791 int (*cancel)(struct kiocb *iocb, struct io_event *res);
1792 struct kioctx *ctx;
1793 struct kiocb *kiocb;
1794 u32 key;
1795 int ret;
1796
1797 ret = get_user(key, &iocb->aio_key);
1798 if (unlikely(ret))
1799 return -EFAULT;
1800
1801 ctx = lookup_ioctx(ctx_id);
1802 if (unlikely(!ctx))
1803 return -EINVAL;
1804
1805 spin_lock_irq(&ctx->ctx_lock);
1806 ret = -EAGAIN;
1807 kiocb = lookup_kiocb(ctx, iocb, key);
1808 if (kiocb && kiocb->ki_cancel) {
1809 cancel = kiocb->ki_cancel;
1810 kiocb->ki_users ++;
1811 kiocbSetCancelled(kiocb);
1812 } else
1813 cancel = NULL;
1814 spin_unlock_irq(&ctx->ctx_lock);
1815
1816 if (NULL != cancel) {
1817 struct io_event tmp;
1818 pr_debug("calling cancel\n");
1819 memset(&tmp, 0, sizeof(tmp));
1820 tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
1821 tmp.data = kiocb->ki_user_data;
1822 ret = cancel(kiocb, &tmp);
1823 if (!ret) {
1824 /* Cancellation succeeded -- copy the result
1825 * into the user's buffer.
1826 */
1827 if (copy_to_user(result, &tmp, sizeof(tmp)))
1828 ret = -EFAULT;
1829 }
1830 } else
Wendy Cheng8f582022005-09-09 13:02:08 -07001831 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832
1833 put_ioctx(ctx);
1834
1835 return ret;
1836}
1837
1838/* io_getevents:
1839 * Attempts to read at least min_nr events and up to nr events from
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001840 * the completion queue for the aio_context specified by ctx_id. If
1841 * it succeeds, the number of read events is returned. May fail with
1842 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1843 * out of range, if timeout is out of range. May fail with -EFAULT
1844 * if any of the memory specified is invalid. May return 0 or
1845 * < min_nr if the timeout specified by timeout has elapsed
1846 * before sufficient events are available, where timeout == NULL
1847 * specifies an infinite timeout. Note that the timeout pointed to by
1848 * timeout is relative and will be updated if not NULL and the
1849 * operation blocks. Will fail with -ENOSYS if not implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001851SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1852 long, min_nr,
1853 long, nr,
1854 struct io_event __user *, events,
1855 struct timespec __user *, timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856{
1857 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1858 long ret = -EINVAL;
1859
1860 if (likely(ioctx)) {
Namhyung Kim2e410252011-01-12 17:01:08 -08001861 if (likely(min_nr <= nr && min_nr >= 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 ret = read_events(ioctx, min_nr, nr, events, timeout);
1863 put_ioctx(ioctx);
1864 }
1865
Roland McGrath598af052008-04-10 15:38:45 -07001866 asmlinkage_protect(5, ret, ctx_id, min_nr, nr, events, timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 return ret;
1868}