blob: a92d7547b6f63344d56d8e1ed15d24685129879a [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
Al Virobf507222012-03-11 00:58:40 -0500214 cancel_delayed_work_sync(&ctx->wq);
Jens Axboeabf137d2008-12-09 08:11:22 +0100215 aio_free_ring(ctx);
216 mmdrop(ctx->mm);
217 ctx->mm = NULL;
Al Viro2dd542b2012-03-10 23:10:35 -0500218 if (nr_events) {
219 spin_lock(&aio_nr_lock);
220 BUG_ON(aio_nr - nr_events > aio_nr);
221 aio_nr -= nr_events;
222 spin_unlock(&aio_nr_lock);
223 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100224 pr_debug("__put_ioctx: freeing %p\n", ctx);
225 call_rcu(&ctx->rcu_head, ctx_rcu_free);
226}
227
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800228static inline int try_get_ioctx(struct kioctx *kioctx)
229{
230 return atomic_inc_not_zero(&kioctx->users);
231}
232
233static inline void put_ioctx(struct kioctx *kioctx)
234{
235 BUG_ON(atomic_read(&kioctx->users) <= 0);
236 if (unlikely(atomic_dec_and_test(&kioctx->users)))
237 __put_ioctx(kioctx);
238}
Adrian Bunkd5470b52008-04-29 00:58:57 -0700239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240/* ioctx_alloc
241 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
242 */
243static struct kioctx *ioctx_alloc(unsigned nr_events)
244{
245 struct mm_struct *mm;
246 struct kioctx *ctx;
Al Viroe23754f2012-03-06 14:33:22 -0500247 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 /* Prevent overflows */
250 if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
251 (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
252 pr_debug("ENOMEM: nr_events too high\n");
253 return ERR_PTR(-EINVAL);
254 }
255
Al Viro2dd542b2012-03-10 23:10:35 -0500256 if (!nr_events || (unsigned long)nr_events > aio_max_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 return ERR_PTR(-EAGAIN);
258
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800259 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 if (!ctx)
261 return ERR_PTR(-ENOMEM);
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 ctx->max_reqs = nr_events;
264 mm = ctx->mm = current->mm;
265 atomic_inc(&mm->mm_count);
266
Al Viro86b62a22012-03-07 05:16:35 +0000267 atomic_set(&ctx->users, 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 spin_lock_init(&ctx->ctx_lock);
269 spin_lock_init(&ctx->ring_info.ring_lock);
270 init_waitqueue_head(&ctx->wait);
271
272 INIT_LIST_HEAD(&ctx->active_reqs);
273 INIT_LIST_HEAD(&ctx->run_list);
David Howells65f27f32006-11-22 14:55:48 +0000274 INIT_DELAYED_WORK(&ctx->wq, aio_kick_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276 if (aio_setup_ring(ctx) < 0)
277 goto out_freectx;
278
279 /* limit the number of system wide aios */
Al Viro9fa1cb32012-03-10 23:14:05 -0500280 spin_lock(&aio_nr_lock);
Al Viro2dd542b2012-03-10 23:10:35 -0500281 if (aio_nr + nr_events > aio_max_nr ||
282 aio_nr + nr_events < aio_nr) {
Al Viro9fa1cb32012-03-10 23:14:05 -0500283 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 goto out_cleanup;
Al Viro2dd542b2012-03-10 23:10:35 -0500285 }
286 aio_nr += ctx->max_reqs;
Al Viro9fa1cb32012-03-10 23:14:05 -0500287 spin_unlock(&aio_nr_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Jeff Moyer39fa0032008-04-29 01:03:48 -0700289 /* now link into global list. */
Jens Axboeabf137d2008-12-09 08:11:22 +0100290 spin_lock(&mm->ioctx_lock);
291 hlist_add_head_rcu(&ctx->list, &mm->ioctx_list);
292 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294 dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
295 ctx, ctx->user_id, current->mm, ctx->ring_info.nr);
296 return ctx;
297
298out_cleanup:
Al Viroe23754f2012-03-06 14:33:22 -0500299 err = -EAGAIN;
300 aio_free_ring(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301out_freectx:
302 mmdrop(mm);
303 kmem_cache_free(kioctx_cachep, ctx);
Al Viroe23754f2012-03-06 14:33:22 -0500304 dprintk("aio: error allocating ioctx %d\n", err);
305 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306}
307
308/* aio_cancel_all
309 * Cancels all outstanding aio requests on an aio context. Used
310 * when the processes owning a context have all exited to encourage
311 * the rapid destruction of the kioctx.
312 */
313static void aio_cancel_all(struct kioctx *ctx)
314{
315 int (*cancel)(struct kiocb *, struct io_event *);
316 struct io_event res;
317 spin_lock_irq(&ctx->ctx_lock);
318 ctx->dead = 1;
319 while (!list_empty(&ctx->active_reqs)) {
320 struct list_head *pos = ctx->active_reqs.next;
321 struct kiocb *iocb = list_kiocb(pos);
322 list_del_init(&iocb->ki_list);
323 cancel = iocb->ki_cancel;
324 kiocbSetCancelled(iocb);
325 if (cancel) {
326 iocb->ki_users++;
327 spin_unlock_irq(&ctx->ctx_lock);
328 cancel(iocb, &res);
329 spin_lock_irq(&ctx->ctx_lock);
330 }
331 }
332 spin_unlock_irq(&ctx->ctx_lock);
333}
334
Adrian Bunk25ee7e32005-04-25 08:18:14 -0700335static void wait_for_all_aios(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336{
337 struct task_struct *tsk = current;
338 DECLARE_WAITQUEUE(wait, tsk);
339
Ken Chendee11c22007-02-03 01:13:45 -0800340 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 if (!ctx->reqs_active)
Ken Chendee11c22007-02-03 01:13:45 -0800342 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344 add_wait_queue(&ctx->wait, &wait);
345 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
346 while (ctx->reqs_active) {
Ken Chendee11c22007-02-03 01:13:45 -0800347 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer41d10da2007-10-16 23:27:20 -0700348 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
Ken Chendee11c22007-02-03 01:13:45 -0800350 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 }
352 __set_task_state(tsk, TASK_RUNNING);
353 remove_wait_queue(&ctx->wait, &wait);
Ken Chendee11c22007-02-03 01:13:45 -0800354
355out:
356 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357}
358
359/* wait_on_sync_kiocb:
360 * Waits on the given sync kiocb to complete.
361 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800362ssize_t wait_on_sync_kiocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363{
364 while (iocb->ki_users) {
365 set_current_state(TASK_UNINTERRUPTIBLE);
366 if (!iocb->ki_users)
367 break;
Jeff Moyer41d10da2007-10-16 23:27:20 -0700368 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 }
370 __set_current_state(TASK_RUNNING);
371 return iocb->ki_user_data;
372}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700373EXPORT_SYMBOL(wait_on_sync_kiocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375/* exit_aio: called when the last user of mm goes away. At this point,
376 * there is no way for any new requests to be submited or any of the
377 * io_* syscalls to be called on the context. However, there may be
378 * outstanding requests which hold references to the context; as they
379 * go away, they will call put_ioctx and release any pinned memory
380 * associated with the request (held via struct page * references).
381 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800382void exit_aio(struct mm_struct *mm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Jens Axboeabf137d2008-12-09 08:11:22 +0100384 struct kioctx *ctx;
385
386 while (!hlist_empty(&mm->ioctx_list)) {
387 ctx = hlist_entry(mm->ioctx_list.first, struct kioctx, list);
388 hlist_del_rcu(&ctx->list);
389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 aio_cancel_all(ctx);
391
392 wait_for_all_aios(ctx);
393 /*
Andrew Mortona9df62c2007-05-09 02:33:54 -0700394 * Ensure we don't leave the ctx on the aio_wq
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700396 cancel_work_sync(&ctx->wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398 if (1 != atomic_read(&ctx->users))
399 printk(KERN_DEBUG
400 "exit_aio:ioctx still alive: %d %d %d\n",
401 atomic_read(&ctx->users), ctx->dead,
402 ctx->reqs_active);
403 put_ioctx(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 }
405}
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/* aio_get_req
408 * Allocate a slot for an aio request. Increments the users count
409 * of the kioctx so that the kioctx stays around until all requests are
410 * complete. Returns NULL if no requests are free.
411 *
412 * Returns with kiocb->users set to 2. The io submit code path holds
413 * an extra reference while submitting the i/o.
414 * This prevents races between the aio code path referencing the
415 * req (after submitting it) and aio_complete() freeing the req.
416 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800417static struct kiocb *__aio_get_req(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
419 struct kiocb *req = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
422 if (unlikely(!req))
423 return NULL;
424
Zach Brown4faa5282005-10-17 16:43:33 -0700425 req->ki_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 req->ki_users = 2;
427 req->ki_key = 0;
428 req->ki_ctx = ctx;
429 req->ki_cancel = NULL;
430 req->ki_retry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 req->ki_dtor = NULL;
432 req->private = NULL;
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700433 req->ki_iovec = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 INIT_LIST_HEAD(&req->ki_run_list);
Davide Libenzi87c3a862009-03-18 17:04:19 -0700435 req->ki_eventfd = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return req;
438}
439
Jeff Moyer080d6762011-11-02 13:40:10 -0700440/*
441 * struct kiocb's are allocated in batches to reduce the number of
442 * times the ctx lock is acquired and released.
443 */
444#define KIOCB_BATCH_SIZE 32L
445struct kiocb_batch {
446 struct list_head head;
447 long count; /* number of requests left to allocate */
448};
449
450static void kiocb_batch_init(struct kiocb_batch *batch, long total)
451{
452 INIT_LIST_HEAD(&batch->head);
453 batch->count = total;
454}
455
Gleb Natapov69e47472012-01-08 17:07:28 +0200456static void kiocb_batch_free(struct kioctx *ctx, struct kiocb_batch *batch)
Jeff Moyer080d6762011-11-02 13:40:10 -0700457{
458 struct kiocb *req, *n;
459
Gleb Natapov69e47472012-01-08 17:07:28 +0200460 if (list_empty(&batch->head))
461 return;
462
463 spin_lock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700464 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
465 list_del(&req->ki_batch);
Gleb Natapov69e47472012-01-08 17:07:28 +0200466 list_del(&req->ki_list);
Jeff Moyer080d6762011-11-02 13:40:10 -0700467 kmem_cache_free(kiocb_cachep, req);
Gleb Natapov69e47472012-01-08 17:07:28 +0200468 ctx->reqs_active--;
Jeff Moyer080d6762011-11-02 13:40:10 -0700469 }
Jeff Moyer880641b2012-03-05 14:59:12 -0800470 if (unlikely(!ctx->reqs_active && ctx->dead))
471 wake_up_all(&ctx->wait);
Gleb Natapov69e47472012-01-08 17:07:28 +0200472 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700473}
474
475/*
476 * Allocate a batch of kiocbs. This avoids taking and dropping the
477 * context lock a lot during setup.
478 */
479static int kiocb_batch_refill(struct kioctx *ctx, struct kiocb_batch *batch)
480{
481 unsigned short allocated, to_alloc;
482 long avail;
483 bool called_fput = false;
484 struct kiocb *req, *n;
485 struct aio_ring *ring;
486
487 to_alloc = min(batch->count, KIOCB_BATCH_SIZE);
488 for (allocated = 0; allocated < to_alloc; allocated++) {
489 req = __aio_get_req(ctx);
490 if (!req)
491 /* allocation failed, go with what we've got */
492 break;
493 list_add(&req->ki_batch, &batch->head);
494 }
495
496 if (allocated == 0)
497 goto out;
498
499retry:
500 spin_lock_irq(&ctx->ctx_lock);
501 ring = kmap_atomic(ctx->ring_info.ring_pages[0]);
502
503 avail = aio_ring_avail(&ctx->ring_info, ring) - ctx->reqs_active;
504 BUG_ON(avail < 0);
505 if (avail == 0 && !called_fput) {
506 /*
507 * Handle a potential starvation case. It is possible that
508 * we hold the last reference on a struct file, causing us
509 * to delay the final fput to non-irq context. In this case,
510 * ctx->reqs_active is artificially high. Calling the fput
511 * routine here may free up a slot in the event completion
512 * ring, allowing this allocation to succeed.
513 */
514 kunmap_atomic(ring);
515 spin_unlock_irq(&ctx->ctx_lock);
516 aio_fput_routine(NULL);
517 called_fput = true;
518 goto retry;
519 }
520
521 if (avail < allocated) {
522 /* Trim back the number of requests. */
523 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
524 list_del(&req->ki_batch);
525 kmem_cache_free(kiocb_cachep, req);
526 if (--allocated <= avail)
527 break;
528 }
529 }
530
531 batch->count -= allocated;
532 list_for_each_entry(req, &batch->head, ki_batch) {
533 list_add(&req->ki_list, &ctx->active_reqs);
534 ctx->reqs_active++;
535 }
536
537 kunmap_atomic(ring);
538 spin_unlock_irq(&ctx->ctx_lock);
539
540out:
541 return allocated;
542}
543
544static inline struct kiocb *aio_get_req(struct kioctx *ctx,
545 struct kiocb_batch *batch)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
547 struct kiocb *req;
Jeff Moyer080d6762011-11-02 13:40:10 -0700548
549 if (list_empty(&batch->head))
550 if (kiocb_batch_refill(ctx, batch) == 0)
551 return NULL;
552 req = list_first_entry(&batch->head, struct kiocb, ki_batch);
553 list_del(&req->ki_batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 return req;
555}
556
557static inline void really_put_req(struct kioctx *ctx, struct kiocb *req)
558{
Zach Brownd00689a2005-11-13 16:07:34 -0800559 assert_spin_locked(&ctx->ctx_lock);
560
Davide Libenzi13389012009-06-30 11:41:11 -0700561 if (req->ki_eventfd != NULL)
562 eventfd_ctx_put(req->ki_eventfd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 if (req->ki_dtor)
564 req->ki_dtor(req);
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700565 if (req->ki_iovec != &req->ki_inline_vec)
566 kfree(req->ki_iovec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 kmem_cache_free(kiocb_cachep, req);
568 ctx->reqs_active--;
569
570 if (unlikely(!ctx->reqs_active && ctx->dead))
Roland Dreiere91f90b2011-03-22 16:35:10 -0700571 wake_up_all(&ctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572}
573
David Howells65f27f32006-11-22 14:55:48 +0000574static void aio_fput_routine(struct work_struct *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
576 spin_lock_irq(&fput_lock);
577 while (likely(!list_empty(&fput_head))) {
578 struct kiocb *req = list_kiocb(fput_head.next);
579 struct kioctx *ctx = req->ki_ctx;
580
581 list_del(&req->ki_list);
582 spin_unlock_irq(&fput_lock);
583
Davide Libenzi87c3a862009-03-18 17:04:19 -0700584 /* Complete the fput(s) */
585 if (req->ki_filp != NULL)
Al Virod7065da2010-05-26 15:13:55 -0400586 fput(req->ki_filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588 /* Link the iocb into the context's free list */
Al Viroc7b28552012-03-08 17:51:19 +0000589 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 spin_lock_irq(&ctx->ctx_lock);
591 really_put_req(ctx, req);
Al Viroc7b28552012-03-08 17:51:19 +0000592 /*
593 * at that point ctx might've been killed, but actual
594 * freeing is RCU'd
595 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 spin_unlock_irq(&ctx->ctx_lock);
Al Viroc7b28552012-03-08 17:51:19 +0000597 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 spin_lock_irq(&fput_lock);
600 }
601 spin_unlock_irq(&fput_lock);
602}
603
604/* __aio_put_req
605 * Returns true if this put was the last user of the request.
606 */
607static int __aio_put_req(struct kioctx *ctx, struct kiocb *req)
608{
Al Viro516e0cc2008-07-26 00:39:17 -0400609 dprintk(KERN_DEBUG "aio_put(%p): f_count=%ld\n",
610 req, atomic_long_read(&req->ki_filp->f_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Zach Brownd00689a2005-11-13 16:07:34 -0800612 assert_spin_locked(&ctx->ctx_lock);
613
Davide Libenzi87c3a862009-03-18 17:04:19 -0700614 req->ki_users--;
Eric Sesterhenn93e06b42006-11-30 05:29:23 +0100615 BUG_ON(req->ki_users < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 if (likely(req->ki_users))
617 return 0;
618 list_del(&req->ki_list); /* remove from active_reqs */
619 req->ki_cancel = NULL;
620 req->ki_retry = NULL;
621
Davide Libenzi87c3a862009-03-18 17:04:19 -0700622 /*
623 * Try to optimize the aio and eventfd file* puts, by avoiding to
Al Virod7065da2010-05-26 15:13:55 -0400624 * schedule work in case it is not final fput() time. In normal cases,
Davide Libenzi87c3a862009-03-18 17:04:19 -0700625 * we would not be holding the last reference to the file*, so
626 * this function will be executed w/out any aio kthread wakeup.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 */
Al Virod7065da2010-05-26 15:13:55 -0400628 if (unlikely(!fput_atomic(req->ki_filp))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 spin_lock(&fput_lock);
630 list_add(&req->ki_list, &fput_head);
631 spin_unlock(&fput_lock);
Tejun Heod37adaa2011-01-26 17:42:27 +0100632 schedule_work(&fput_work);
Davide Libenzi13389012009-06-30 11:41:11 -0700633 } else {
634 req->ki_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 really_put_req(ctx, req);
Davide Libenzi13389012009-06-30 11:41:11 -0700636 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 return 1;
638}
639
640/* aio_put_req
641 * Returns true if this put was the last user of the kiocb,
642 * false if the request is still in use.
643 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800644int aio_put_req(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
646 struct kioctx *ctx = req->ki_ctx;
647 int ret;
648 spin_lock_irq(&ctx->ctx_lock);
649 ret = __aio_put_req(ctx, req);
650 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 return ret;
652}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700653EXPORT_SYMBOL(aio_put_req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Adrian Bunkd5470b52008-04-29 00:58:57 -0700655static struct kioctx *lookup_ioctx(unsigned long ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656{
Jens Axboeabf137d2008-12-09 08:11:22 +0100657 struct mm_struct *mm = current->mm;
Jeff Moyer65c24492009-03-18 17:04:21 -0700658 struct kioctx *ctx, *ret = NULL;
Jens Axboeabf137d2008-12-09 08:11:22 +0100659 struct hlist_node *n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Jens Axboeabf137d2008-12-09 08:11:22 +0100661 rcu_read_lock();
662
663 hlist_for_each_entry_rcu(ctx, n, &mm->ioctx_list, list) {
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800664 /*
665 * RCU protects us against accessing freed memory but
666 * we have to be careful not to get a reference when the
667 * reference count already dropped to 0 (ctx->dead test
668 * is unreliable because of races).
669 */
670 if (ctx->user_id == ctx_id && !ctx->dead && try_get_ioctx(ctx)){
Jeff Moyer65c24492009-03-18 17:04:21 -0700671 ret = ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 break;
673 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100674 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Jens Axboeabf137d2008-12-09 08:11:22 +0100676 rcu_read_unlock();
Jeff Moyer65c24492009-03-18 17:04:21 -0700677 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678}
679
680/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 * Queue up a kiocb to be retried. Assumes that the kiocb
682 * has already been marked as kicked, and places it on
683 * the retry run list for the corresponding ioctx, if it
684 * isn't already queued. Returns 1 if it actually queued
685 * the kiocb (to tell the caller to activate the work
686 * queue to process it), or 0, if it found that it was
687 * already queued.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 */
689static inline int __queue_kicked_iocb(struct kiocb *iocb)
690{
691 struct kioctx *ctx = iocb->ki_ctx;
692
Zach Brownd00689a2005-11-13 16:07:34 -0800693 assert_spin_locked(&ctx->ctx_lock);
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 if (list_empty(&iocb->ki_run_list)) {
696 list_add_tail(&iocb->ki_run_list,
697 &ctx->run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 return 1;
699 }
700 return 0;
701}
702
703/* aio_run_iocb
704 * This is the core aio execution routine. It is
705 * invoked both for initial i/o submission and
706 * subsequent retries via the aio_kick_handler.
707 * Expects to be invoked with iocb->ki_ctx->lock
Andreas Mohrd6e05ed2006-06-26 18:35:02 +0200708 * already held. The lock is released and reacquired
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 * as needed during processing.
710 *
711 * Calls the iocb retry method (already setup for the
712 * iocb on initial submission) for operation specific
713 * handling, but takes care of most of common retry
714 * execution details for a given iocb. The retry method
715 * needs to be non-blocking as far as possible, to avoid
716 * holding up other iocbs waiting to be serviced by the
717 * retry kernel thread.
718 *
719 * The trickier parts in this code have to do with
720 * ensuring that only one retry instance is in progress
721 * for a given iocb at any time. Providing that guarantee
722 * simplifies the coding of individual aio operations as
723 * it avoids various potential races.
724 */
725static ssize_t aio_run_iocb(struct kiocb *iocb)
726{
727 struct kioctx *ctx = iocb->ki_ctx;
728 ssize_t (*retry)(struct kiocb *);
729 ssize_t ret;
730
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 if (!(retry = iocb->ki_retry)) {
732 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
733 return 0;
734 }
735
736 /*
737 * We don't want the next retry iteration for this
738 * operation to start until this one has returned and
739 * updated the iocb state. However, wait_queue functions
740 * can trigger a kick_iocb from interrupt context in the
741 * meantime, indicating that data is available for the next
742 * iteration. We want to remember that and enable the
743 * next retry iteration _after_ we are through with
744 * this one.
745 *
746 * So, in order to be able to register a "kick", but
747 * prevent it from being queued now, we clear the kick
748 * flag, but make the kick code *think* that the iocb is
749 * still on the run list until we are actually done.
750 * When we are done with this iteration, we check if
751 * the iocb was kicked in the meantime and if so, queue
752 * it up afresh.
753 */
754
755 kiocbClearKicked(iocb);
756
757 /*
758 * This is so that aio_complete knows it doesn't need to
759 * pull the iocb off the run list (We can't just call
760 * INIT_LIST_HEAD because we don't want a kick_iocb to
761 * queue this on the run list yet)
762 */
763 iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
764 spin_unlock_irq(&ctx->ctx_lock);
765
766 /* Quit retrying if the i/o has been cancelled */
767 if (kiocbIsCancelled(iocb)) {
768 ret = -EINTR;
769 aio_complete(iocb, ret, 0);
770 /* must not access the iocb after this */
771 goto out;
772 }
773
774 /*
775 * Now we are all set to call the retry method in async
Alexey Dobriyan6212e3a2007-10-18 03:04:56 -0700776 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 ret = retry(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Jan Karaa0c42ba2010-09-22 13:05:03 -0700780 if (ret != -EIOCBRETRY && ret != -EIOCBQUEUED) {
781 /*
782 * There's no easy way to restart the syscall since other AIO's
783 * may be already running. Just fail this IO with EINTR.
784 */
785 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
786 ret == -ERESTARTNOHAND || ret == -ERESTART_RESTARTBLOCK))
787 ret = -EINTR;
Zach Brown897f15f2005-09-30 11:58:55 -0700788 aio_complete(iocb, ret, 0);
Jan Karaa0c42ba2010-09-22 13:05:03 -0700789 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790out:
791 spin_lock_irq(&ctx->ctx_lock);
792
793 if (-EIOCBRETRY == ret) {
794 /*
795 * OK, now that we are done with this iteration
796 * and know that there is more left to go,
797 * this is where we let go so that a subsequent
798 * "kick" can start the next iteration
799 */
800
801 /* will make __queue_kicked_iocb succeed from here on */
802 INIT_LIST_HEAD(&iocb->ki_run_list);
803 /* we must queue the next iteration ourselves, if it
804 * has already been kicked */
805 if (kiocbIsKicked(iocb)) {
806 __queue_kicked_iocb(iocb);
Sébastien Duguc016e222005-06-28 20:44:59 -0700807
808 /*
809 * __queue_kicked_iocb will always return 1 here, because
810 * iocb->ki_run_list is empty at this point so it should
811 * be safe to unconditionally queue the context into the
812 * work queue.
813 */
814 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 }
816 }
817 return ret;
818}
819
820/*
821 * __aio_run_iocbs:
822 * Process all pending retries queued on the ioctx
823 * run list.
824 * Assumes it is operating within the aio issuer's mm
Zach Brownd00689a2005-11-13 16:07:34 -0800825 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 */
827static int __aio_run_iocbs(struct kioctx *ctx)
828{
829 struct kiocb *iocb;
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700830 struct list_head run_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Zach Brownd00689a2005-11-13 16:07:34 -0800832 assert_spin_locked(&ctx->ctx_lock);
833
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700834 list_replace_init(&ctx->run_list, &run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 while (!list_empty(&run_list)) {
836 iocb = list_entry(run_list.next, struct kiocb,
837 ki_run_list);
838 list_del(&iocb->ki_run_list);
839 /*
840 * Hold an extra reference while retrying i/o.
841 */
842 iocb->ki_users++; /* grab extra reference */
843 aio_run_iocb(iocb);
Ken Chendee11c22007-02-03 01:13:45 -0800844 __aio_put_req(ctx, iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 if (!list_empty(&ctx->run_list))
847 return 1;
848 return 0;
849}
850
851static void aio_queue_work(struct kioctx * ctx)
852{
853 unsigned long timeout;
854 /*
855 * if someone is waiting, get the work started right
856 * away, otherwise, use a longer delay
857 */
858 smp_mb();
859 if (waitqueue_active(&ctx->wait))
860 timeout = 1;
861 else
862 timeout = HZ/10;
863 queue_delayed_work(aio_wq, &ctx->wq, timeout);
864}
865
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866/*
Jeff Moyerd3486f82011-01-12 17:01:08 -0800867 * aio_run_all_iocbs:
868 * Process all pending retries queued on the ioctx
869 * run list, and keep running them until the list
870 * stays empty.
871 * Assumes it is operating within the aio issuer's mm context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 */
873static inline void aio_run_all_iocbs(struct kioctx *ctx)
874{
875 spin_lock_irq(&ctx->ctx_lock);
876 while (__aio_run_iocbs(ctx))
877 ;
878 spin_unlock_irq(&ctx->ctx_lock);
879}
880
881/*
882 * aio_kick_handler:
883 * Work queue handler triggered to process pending
884 * retries on an ioctx. Takes on the aio issuer's
885 * mm context before running the iocbs, so that
886 * copy_xxx_user operates on the issuer's address
887 * space.
888 * Run on aiod's context.
889 */
David Howells65f27f32006-11-22 14:55:48 +0000890static void aio_kick_handler(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891{
David Howells65f27f32006-11-22 14:55:48 +0000892 struct kioctx *ctx = container_of(work, struct kioctx, wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 mm_segment_t oldfs = get_fs();
Zach Brown1ebb1102006-12-29 16:47:02 -0800894 struct mm_struct *mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 int requeue;
896
897 set_fs(USER_DS);
898 use_mm(ctx->mm);
899 spin_lock_irq(&ctx->ctx_lock);
900 requeue =__aio_run_iocbs(ctx);
Zach Brown1ebb1102006-12-29 16:47:02 -0800901 mm = ctx->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 spin_unlock_irq(&ctx->ctx_lock);
Zach Brown1ebb1102006-12-29 16:47:02 -0800903 unuse_mm(mm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 set_fs(oldfs);
905 /*
906 * we're in a worker thread already, don't use queue_delayed_work,
907 */
908 if (requeue)
David Howells52bad642006-11-22 14:54:01 +0000909 queue_delayed_work(aio_wq, &ctx->wq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910}
911
912
913/*
914 * Called by kick_iocb to queue the kiocb for retry
915 * and if required activate the aio work queue to process
916 * it
917 */
Zach Brown998765e2005-09-30 11:58:54 -0700918static void try_queue_kicked_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
920 struct kioctx *ctx = iocb->ki_ctx;
921 unsigned long flags;
922 int run = 0;
923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 spin_lock_irqsave(&ctx->ctx_lock, flags);
Zach Brown998765e2005-09-30 11:58:54 -0700925 /* set this inside the lock so that we can't race with aio_run_iocb()
926 * testing it and putting the iocb on the run list under the lock */
927 if (!kiocbTryKick(iocb))
928 run = __queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Ken Chen644d3a02005-05-01 08:59:15 -0700930 if (run)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932}
933
934/*
935 * kick_iocb:
936 * Called typically from a wait queue callback context
Shaohua Lifac046a2009-12-15 16:47:47 -0800937 * to trigger a retry of the iocb.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 * The retry is usually executed by aio workqueue
939 * threads (See aio_kick_handler).
940 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800941void kick_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942{
943 /* sync iocbs are easy: they can only ever be executing from a
944 * single context. */
945 if (is_sync_kiocb(iocb)) {
946 kiocbSetKicked(iocb);
947 wake_up_process(iocb->ki_obj.tsk);
948 return;
949 }
950
Zach Brown998765e2005-09-30 11:58:54 -0700951 try_queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952}
953EXPORT_SYMBOL(kick_iocb);
954
955/* aio_complete
956 * Called when the io request on the given iocb is complete.
957 * Returns true if this is the last user of the request. The
958 * only other user of the request can be the cancellation code.
959 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800960int aio_complete(struct kiocb *iocb, long res, long res2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961{
962 struct kioctx *ctx = iocb->ki_ctx;
963 struct aio_ring_info *info;
964 struct aio_ring *ring;
965 struct io_event *event;
966 unsigned long flags;
967 unsigned long tail;
968 int ret;
969
Zach Brown20dcae32005-11-13 16:07:33 -0800970 /*
971 * Special case handling for sync iocbs:
972 * - events go directly into the iocb for fast handling
973 * - the sync task with the iocb in its stack holds the single iocb
974 * ref, no other paths have a way to get another ref
975 * - the sync task helpfully left a reference to itself in the iocb
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 */
977 if (is_sync_kiocb(iocb)) {
Zach Brown20dcae32005-11-13 16:07:33 -0800978 BUG_ON(iocb->ki_users != 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 iocb->ki_user_data = res;
Zach Brown20dcae32005-11-13 16:07:33 -0800980 iocb->ki_users = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 wake_up_process(iocb->ki_obj.tsk);
Zach Brown20dcae32005-11-13 16:07:33 -0800982 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 }
984
985 info = &ctx->ring_info;
986
987 /* add a completion event to the ring buffer.
988 * must be done holding ctx->ctx_lock to prevent
989 * other code from messing with the tail
990 * pointer since we might be called from irq
991 * context.
992 */
993 spin_lock_irqsave(&ctx->ctx_lock, flags);
994
995 if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
996 list_del_init(&iocb->ki_run_list);
997
998 /*
999 * cancelled requests don't get events, userland was given one
1000 * when the event got cancelled.
1001 */
1002 if (kiocbIsCancelled(iocb))
1003 goto put_rq;
1004
1005 ring = kmap_atomic(info->ring_pages[0], KM_IRQ1);
1006
1007 tail = info->tail;
1008 event = aio_ring_event(info, tail, KM_IRQ0);
Ken Chen4bf69b22005-05-01 08:59:15 -07001009 if (++tail >= info->nr)
1010 tail = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
1012 event->obj = (u64)(unsigned long)iocb->ki_obj.user;
1013 event->data = iocb->ki_user_data;
1014 event->res = res;
1015 event->res2 = res2;
1016
1017 dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
1018 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
1019 res, res2);
1020
1021 /* after flagging the request as done, we
1022 * must never even look at it again
1023 */
1024 smp_wmb(); /* make event visible before updating tail */
1025
1026 info->tail = tail;
1027 ring->tail = tail;
1028
1029 put_aio_ring_event(event, KM_IRQ0);
1030 kunmap_atomic(ring, KM_IRQ1);
1031
1032 pr_debug("added to ring %p at [%lu]\n", iocb, tail);
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001033
1034 /*
1035 * Check if the user asked us to deliver the result through an
1036 * eventfd. The eventfd_signal() function is safe to be called
1037 * from IRQ context.
1038 */
Davide Libenzi87c3a862009-03-18 17:04:19 -07001039 if (iocb->ki_eventfd != NULL)
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001040 eventfd_signal(iocb->ki_eventfd, 1);
1041
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042put_rq:
1043 /* everything turned out well, dispose of the aiocb. */
1044 ret = __aio_put_req(ctx, iocb);
1045
Quentin Barnes6cb2a212008-03-19 17:00:39 -07001046 /*
1047 * We have to order our ring_info tail store above and test
1048 * of the wait list below outside the wait lock. This is
1049 * like in wake_up_bit() where clearing a bit has to be
1050 * ordered with the unlocked test.
1051 */
1052 smp_mb();
1053
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 if (waitqueue_active(&ctx->wait))
1055 wake_up(&ctx->wait);
1056
Ken Chendee11c22007-02-03 01:13:45 -08001057 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 return ret;
1059}
H Hartley Sweeten385773e2009-09-22 16:43:53 -07001060EXPORT_SYMBOL(aio_complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
1062/* aio_read_evt
1063 * Pull an event off of the ioctx's event ring. Returns the number of
1064 * events fetched (0 or 1 ;-)
1065 * FIXME: make this use cmpxchg.
1066 * TODO: make the ringbuffer user mmap()able (requires FIXME).
1067 */
1068static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
1069{
1070 struct aio_ring_info *info = &ioctx->ring_info;
1071 struct aio_ring *ring;
1072 unsigned long head;
1073 int ret = 0;
1074
1075 ring = kmap_atomic(info->ring_pages[0], KM_USER0);
1076 dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1077 (unsigned long)ring->head, (unsigned long)ring->tail,
1078 (unsigned long)ring->nr);
1079
1080 if (ring->head == ring->tail)
1081 goto out;
1082
1083 spin_lock(&info->ring_lock);
1084
1085 head = ring->head % info->nr;
1086 if (head != ring->tail) {
1087 struct io_event *evp = aio_ring_event(info, head, KM_USER1);
1088 *ent = *evp;
1089 head = (head + 1) % info->nr;
1090 smp_mb(); /* finish reading the event before updatng the head */
1091 ring->head = head;
1092 ret = 1;
1093 put_aio_ring_event(evp, KM_USER1);
1094 }
1095 spin_unlock(&info->ring_lock);
1096
1097out:
1098 kunmap_atomic(ring, KM_USER0);
1099 dprintk("leaving aio_read_evt: %d h%lu t%lu\n", ret,
1100 (unsigned long)ring->head, (unsigned long)ring->tail);
1101 return ret;
1102}
1103
1104struct aio_timeout {
1105 struct timer_list timer;
1106 int timed_out;
1107 struct task_struct *p;
1108};
1109
1110static void timeout_func(unsigned long data)
1111{
1112 struct aio_timeout *to = (struct aio_timeout *)data;
1113
1114 to->timed_out = 1;
1115 wake_up_process(to->p);
1116}
1117
1118static inline void init_timeout(struct aio_timeout *to)
1119{
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001120 setup_timer_on_stack(&to->timer, timeout_func, (unsigned long) to);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 to->timed_out = 0;
1122 to->p = current;
1123}
1124
1125static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
1126 const struct timespec *ts)
1127{
1128 to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
1129 if (time_after(to->timer.expires, jiffies))
1130 add_timer(&to->timer);
1131 else
1132 to->timed_out = 1;
1133}
1134
1135static inline void clear_timeout(struct aio_timeout *to)
1136{
1137 del_singleshot_timer_sync(&to->timer);
1138}
1139
1140static int read_events(struct kioctx *ctx,
1141 long min_nr, long nr,
1142 struct io_event __user *event,
1143 struct timespec __user *timeout)
1144{
1145 long start_jiffies = jiffies;
1146 struct task_struct *tsk = current;
1147 DECLARE_WAITQUEUE(wait, tsk);
1148 int ret;
1149 int i = 0;
1150 struct io_event ent;
1151 struct aio_timeout to;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 int retry = 0;
1153
1154 /* needed to zero any padding within an entry (there shouldn't be
1155 * any, but C is fun!
1156 */
1157 memset(&ent, 0, sizeof(ent));
1158retry:
1159 ret = 0;
1160 while (likely(i < nr)) {
1161 ret = aio_read_evt(ctx, &ent);
1162 if (unlikely(ret <= 0))
1163 break;
1164
1165 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1166 ent.data, ent.obj, ent.res, ent.res2);
1167
1168 /* Could we split the check in two? */
1169 ret = -EFAULT;
1170 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1171 dprintk("aio: lost an event due to EFAULT.\n");
1172 break;
1173 }
1174 ret = 0;
1175
1176 /* Good, event copied to userland, update counts. */
1177 event ++;
1178 i ++;
1179 }
1180
1181 if (min_nr <= i)
1182 return i;
1183 if (ret)
1184 return ret;
1185
1186 /* End fast path */
1187
1188 /* racey check, but it gets redone */
1189 if (!retry && unlikely(!list_empty(&ctx->run_list))) {
1190 retry = 1;
1191 aio_run_all_iocbs(ctx);
1192 goto retry;
1193 }
1194
1195 init_timeout(&to);
1196 if (timeout) {
1197 struct timespec ts;
1198 ret = -EFAULT;
1199 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1200 goto out;
1201
1202 set_timeout(start_jiffies, &to, &ts);
1203 }
1204
1205 while (likely(i < nr)) {
1206 add_wait_queue_exclusive(&ctx->wait, &wait);
1207 do {
1208 set_task_state(tsk, TASK_INTERRUPTIBLE);
1209 ret = aio_read_evt(ctx, &ent);
1210 if (ret)
1211 break;
1212 if (min_nr <= i)
1213 break;
Jeff Moyere92adcb2008-04-28 02:12:04 -07001214 if (unlikely(ctx->dead)) {
1215 ret = -EINVAL;
1216 break;
1217 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 if (to.timed_out) /* Only check after read evt */
1219 break;
Jeff Moyere00ba3d2007-12-04 23:45:02 -08001220 /* Try to only show up in io wait if there are ops
1221 * in flight */
1222 if (ctx->reqs_active)
1223 io_schedule();
1224 else
1225 schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 if (signal_pending(tsk)) {
1227 ret = -EINTR;
1228 break;
1229 }
1230 /*ret = aio_read_evt(ctx, &ent);*/
1231 } while (1) ;
1232
1233 set_task_state(tsk, TASK_RUNNING);
1234 remove_wait_queue(&ctx->wait, &wait);
1235
1236 if (unlikely(ret <= 0))
1237 break;
1238
1239 ret = -EFAULT;
1240 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1241 dprintk("aio: lost an event due to EFAULT.\n");
1242 break;
1243 }
1244
1245 /* Good, event copied to userland, update counts. */
1246 event ++;
1247 i ++;
1248 }
1249
1250 if (timeout)
1251 clear_timeout(&to);
1252out:
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001253 destroy_timer_on_stack(&to.timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 return i ? i : ret;
1255}
1256
1257/* Take an ioctx and remove it from the list of ioctx's. Protects
1258 * against races with itself via ->dead.
1259 */
1260static void io_destroy(struct kioctx *ioctx)
1261{
1262 struct mm_struct *mm = current->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 int was_dead;
1264
1265 /* delete the entry from the list is someone else hasn't already */
Jens Axboeabf137d2008-12-09 08:11:22 +01001266 spin_lock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 was_dead = ioctx->dead;
1268 ioctx->dead = 1;
Jens Axboeabf137d2008-12-09 08:11:22 +01001269 hlist_del_rcu(&ioctx->list);
1270 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
1272 dprintk("aio_release(%p)\n", ioctx);
1273 if (likely(!was_dead))
1274 put_ioctx(ioctx); /* twice for the list */
1275
1276 aio_cancel_all(ioctx);
1277 wait_for_all_aios(ioctx);
Jeff Moyere92adcb2008-04-28 02:12:04 -07001278
1279 /*
1280 * Wake up any waiters. The setting of ctx->dead must be seen
1281 * by other CPUs at this point. Right now, we rely on the
1282 * locking done by the above calls to ensure this consistency.
1283 */
Roland Dreiere91f90b2011-03-22 16:35:10 -07001284 wake_up_all(&ioctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 put_ioctx(ioctx); /* once for the lookup */
1286}
1287
1288/* sys_io_setup:
1289 * Create an aio_context capable of receiving at least nr_events.
1290 * ctxp must not point to an aio_context that already exists, and
1291 * must be initialized to 0 prior to the call. On successful
1292 * creation of the aio_context, *ctxp is filled in with the resulting
1293 * handle. May fail with -EINVAL if *ctxp is not initialized,
1294 * if the specified nr_events exceeds internal limits. May fail
1295 * with -EAGAIN if the specified nr_events exceeds the user's limit
1296 * of available events. May fail with -ENOMEM if insufficient kernel
1297 * resources are available. May fail with -EFAULT if an invalid
1298 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1299 * implemented.
1300 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001301SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302{
1303 struct kioctx *ioctx = NULL;
1304 unsigned long ctx;
1305 long ret;
1306
1307 ret = get_user(ctx, ctxp);
1308 if (unlikely(ret))
1309 goto out;
1310
1311 ret = -EINVAL;
Zach Brownd55b5fd2005-11-07 00:59:31 -08001312 if (unlikely(ctx || nr_events == 0)) {
1313 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1314 ctx, nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 goto out;
1316 }
1317
1318 ioctx = ioctx_alloc(nr_events);
1319 ret = PTR_ERR(ioctx);
1320 if (!IS_ERR(ioctx)) {
1321 ret = put_user(ioctx->user_id, ctxp);
Al Viro86b62a22012-03-07 05:16:35 +00001322 if (!ret) {
1323 put_ioctx(ioctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 return 0;
Al Viro86b62a22012-03-07 05:16:35 +00001325 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 io_destroy(ioctx);
1327 }
1328
1329out:
1330 return ret;
1331}
1332
1333/* sys_io_destroy:
1334 * Destroy the aio_context specified. May cancel any outstanding
1335 * AIOs and block on completion. Will fail with -ENOSYS if not
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001336 * implemented. May fail with -EINVAL if the context pointed to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 * is invalid.
1338 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001339SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340{
1341 struct kioctx *ioctx = lookup_ioctx(ctx);
1342 if (likely(NULL != ioctx)) {
1343 io_destroy(ioctx);
1344 return 0;
1345 }
1346 pr_debug("EINVAL: io_destroy: invalid context id\n");
1347 return -EINVAL;
1348}
1349
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001350static void aio_advance_iovec(struct kiocb *iocb, ssize_t ret)
1351{
1352 struct iovec *iov = &iocb->ki_iovec[iocb->ki_cur_seg];
1353
1354 BUG_ON(ret <= 0);
1355
1356 while (iocb->ki_cur_seg < iocb->ki_nr_segs && ret > 0) {
1357 ssize_t this = min((ssize_t)iov->iov_len, ret);
1358 iov->iov_base += this;
1359 iov->iov_len -= this;
1360 iocb->ki_left -= this;
1361 ret -= this;
1362 if (iov->iov_len == 0) {
1363 iocb->ki_cur_seg++;
1364 iov++;
1365 }
1366 }
1367
1368 /* the caller should not have done more io than what fit in
1369 * the remaining iovecs */
1370 BUG_ON(ret > 0 && iocb->ki_left == 0);
1371}
1372
1373static ssize_t aio_rw_vect_retry(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374{
1375 struct file *file = iocb->ki_filp;
1376 struct address_space *mapping = file->f_mapping;
1377 struct inode *inode = mapping->host;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001378 ssize_t (*rw_op)(struct kiocb *, const struct iovec *,
1379 unsigned long, loff_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 ssize_t ret = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001381 unsigned short opcode;
1382
1383 if ((iocb->ki_opcode == IOCB_CMD_PREADV) ||
1384 (iocb->ki_opcode == IOCB_CMD_PREAD)) {
1385 rw_op = file->f_op->aio_read;
1386 opcode = IOCB_CMD_PREADV;
1387 } else {
1388 rw_op = file->f_op->aio_write;
1389 opcode = IOCB_CMD_PWRITEV;
1390 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391
Rusty Russellc2ec6682008-02-08 04:20:15 -08001392 /* This matches the pread()/pwrite() logic */
1393 if (iocb->ki_pos < 0)
1394 return -EINVAL;
1395
Zach Brown897f15f2005-09-30 11:58:55 -07001396 do {
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001397 ret = rw_op(iocb, &iocb->ki_iovec[iocb->ki_cur_seg],
1398 iocb->ki_nr_segs - iocb->ki_cur_seg,
1399 iocb->ki_pos);
1400 if (ret > 0)
1401 aio_advance_iovec(iocb, ret);
Badari Pulavarty027445c2006-09-30 23:28:46 -07001402
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001403 /* retry all partial writes. retry partial reads as long as its a
1404 * regular file. */
Zach Brown353fb072005-09-30 11:58:56 -07001405 } while (ret > 0 && iocb->ki_left > 0 &&
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001406 (opcode == IOCB_CMD_PWRITEV ||
1407 (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
1409 /* This means we must have transferred all that we could */
1410 /* No need to retry anymore */
1411 if ((ret == 0) || (iocb->ki_left == 0))
1412 ret = iocb->ki_nbytes - iocb->ki_left;
1413
Rusty Russell7adfa2f2008-02-08 04:20:14 -08001414 /* If we managed to write some out we return that, rather than
1415 * the eventual error. */
1416 if (opcode == IOCB_CMD_PWRITEV
1417 && ret < 0 && ret != -EIOCBQUEUED && ret != -EIOCBRETRY
1418 && iocb->ki_nbytes - iocb->ki_left)
1419 ret = iocb->ki_nbytes - iocb->ki_left;
1420
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 return ret;
1422}
1423
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424static ssize_t aio_fdsync(struct kiocb *iocb)
1425{
1426 struct file *file = iocb->ki_filp;
1427 ssize_t ret = -EINVAL;
1428
1429 if (file->f_op->aio_fsync)
1430 ret = file->f_op->aio_fsync(iocb, 1);
1431 return ret;
1432}
1433
1434static ssize_t aio_fsync(struct kiocb *iocb)
1435{
1436 struct file *file = iocb->ki_filp;
1437 ssize_t ret = -EINVAL;
1438
1439 if (file->f_op->aio_fsync)
1440 ret = file->f_op->aio_fsync(iocb, 0);
1441 return ret;
1442}
1443
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001444static ssize_t aio_setup_vectored_rw(int type, struct kiocb *kiocb, bool compat)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001445{
1446 ssize_t ret;
1447
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001448#ifdef CONFIG_COMPAT
1449 if (compat)
1450 ret = compat_rw_copy_check_uvector(type,
1451 (struct compat_iovec __user *)kiocb->ki_buf,
1452 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001453 &kiocb->ki_iovec, 1);
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001454 else
1455#endif
1456 ret = rw_copy_check_uvector(type,
1457 (struct iovec __user *)kiocb->ki_buf,
1458 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001459 &kiocb->ki_iovec, 1);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001460 if (ret < 0)
1461 goto out;
1462
1463 kiocb->ki_nr_segs = kiocb->ki_nbytes;
1464 kiocb->ki_cur_seg = 0;
1465 /* ki_nbytes/left now reflect bytes instead of segs */
1466 kiocb->ki_nbytes = ret;
1467 kiocb->ki_left = ret;
1468
1469 ret = 0;
1470out:
1471 return ret;
1472}
1473
1474static ssize_t aio_setup_single_vector(struct kiocb *kiocb)
1475{
1476 kiocb->ki_iovec = &kiocb->ki_inline_vec;
1477 kiocb->ki_iovec->iov_base = kiocb->ki_buf;
1478 kiocb->ki_iovec->iov_len = kiocb->ki_left;
1479 kiocb->ki_nr_segs = 1;
1480 kiocb->ki_cur_seg = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001481 return 0;
1482}
1483
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484/*
1485 * aio_setup_iocb:
1486 * Performs the initial checks and aio retry method
1487 * setup for the kiocb at the time of io submission.
1488 */
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001489static ssize_t aio_setup_iocb(struct kiocb *kiocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490{
1491 struct file *file = kiocb->ki_filp;
1492 ssize_t ret = 0;
1493
1494 switch (kiocb->ki_opcode) {
1495 case IOCB_CMD_PREAD:
1496 ret = -EBADF;
1497 if (unlikely(!(file->f_mode & FMODE_READ)))
1498 break;
1499 ret = -EFAULT;
1500 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1501 kiocb->ki_left)))
1502 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001503 ret = security_file_permission(file, MAY_READ);
1504 if (unlikely(ret))
1505 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001506 ret = aio_setup_single_vector(kiocb);
1507 if (ret)
1508 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 ret = -EINVAL;
1510 if (file->f_op->aio_read)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001511 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 break;
1513 case IOCB_CMD_PWRITE:
1514 ret = -EBADF;
1515 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1516 break;
1517 ret = -EFAULT;
1518 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1519 kiocb->ki_left)))
1520 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001521 ret = security_file_permission(file, MAY_WRITE);
1522 if (unlikely(ret))
1523 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001524 ret = aio_setup_single_vector(kiocb);
1525 if (ret)
1526 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 ret = -EINVAL;
1528 if (file->f_op->aio_write)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001529 kiocb->ki_retry = aio_rw_vect_retry;
1530 break;
1531 case IOCB_CMD_PREADV:
1532 ret = -EBADF;
1533 if (unlikely(!(file->f_mode & FMODE_READ)))
1534 break;
1535 ret = security_file_permission(file, MAY_READ);
1536 if (unlikely(ret))
1537 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001538 ret = aio_setup_vectored_rw(READ, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001539 if (ret)
1540 break;
1541 ret = -EINVAL;
1542 if (file->f_op->aio_read)
1543 kiocb->ki_retry = aio_rw_vect_retry;
1544 break;
1545 case IOCB_CMD_PWRITEV:
1546 ret = -EBADF;
1547 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1548 break;
1549 ret = security_file_permission(file, MAY_WRITE);
1550 if (unlikely(ret))
1551 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001552 ret = aio_setup_vectored_rw(WRITE, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001553 if (ret)
1554 break;
1555 ret = -EINVAL;
1556 if (file->f_op->aio_write)
1557 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 break;
1559 case IOCB_CMD_FDSYNC:
1560 ret = -EINVAL;
1561 if (file->f_op->aio_fsync)
1562 kiocb->ki_retry = aio_fdsync;
1563 break;
1564 case IOCB_CMD_FSYNC:
1565 ret = -EINVAL;
1566 if (file->f_op->aio_fsync)
1567 kiocb->ki_retry = aio_fsync;
1568 break;
1569 default:
1570 dprintk("EINVAL: io_submit: no operation provided\n");
1571 ret = -EINVAL;
1572 }
1573
1574 if (!kiocb->ki_retry)
1575 return ret;
1576
1577 return 0;
1578}
1579
Adrian Bunkd5470b52008-04-29 00:58:57 -07001580static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
Jeff Moyer080d6762011-11-02 13:40:10 -07001581 struct iocb *iocb, struct kiocb_batch *batch,
1582 bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583{
1584 struct kiocb *req;
1585 struct file *file;
1586 ssize_t ret;
1587
1588 /* enforce forwards compatibility on users */
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001589 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 pr_debug("EINVAL: io_submit: reserve field set\n");
1591 return -EINVAL;
1592 }
1593
1594 /* prevent overflows */
1595 if (unlikely(
1596 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1597 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1598 ((ssize_t)iocb->aio_nbytes < 0)
1599 )) {
1600 pr_debug("EINVAL: io_submit: overflow check\n");
1601 return -EINVAL;
1602 }
1603
1604 file = fget(iocb->aio_fildes);
1605 if (unlikely(!file))
1606 return -EBADF;
1607
Jeff Moyer080d6762011-11-02 13:40:10 -07001608 req = aio_get_req(ctx, batch); /* returns with 2 references to req */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 if (unlikely(!req)) {
1610 fput(file);
1611 return -EAGAIN;
1612 }
Yan Zheng87e28312007-10-08 12:16:20 -07001613 req->ki_filp = file;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001614 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1615 /*
1616 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1617 * instance of the file* now. The file descriptor must be
1618 * an eventfd() fd, and will be signaled for each completed
1619 * event using the eventfd_signal() function.
1620 */
Davide Libenzi13389012009-06-30 11:41:11 -07001621 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -07001622 if (IS_ERR(req->ki_eventfd)) {
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001623 ret = PTR_ERR(req->ki_eventfd);
Davide Libenzi87c3a862009-03-18 17:04:19 -07001624 req->ki_eventfd = NULL;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001625 goto out_put_req;
1626 }
1627 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Ken Chen212079c2005-05-01 08:59:15 -07001629 ret = put_user(req->ki_key, &user_iocb->aio_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 if (unlikely(ret)) {
1631 dprintk("EFAULT: aio_key\n");
1632 goto out_put_req;
1633 }
1634
1635 req->ki_obj.user = user_iocb;
1636 req->ki_user_data = iocb->aio_data;
1637 req->ki_pos = iocb->aio_offset;
1638
1639 req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1640 req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1641 req->ki_opcode = iocb->aio_lio_opcode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001643 ret = aio_setup_iocb(req, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644
1645 if (ret)
1646 goto out_put_req;
1647
1648 spin_lock_irq(&ctx->ctx_lock);
Jan Kara7137c6bd2011-02-25 14:44:27 -08001649 /*
1650 * We could have raced with io_destroy() and are currently holding a
1651 * reference to ctx which should be destroyed. We cannot submit IO
1652 * since ctx gets freed as soon as io_submit() puts its reference. The
1653 * check here is reliable: io_destroy() sets ctx->dead before waiting
1654 * for outstanding IO and the barrier between these two is realized by
1655 * unlock of mm->ioctx_lock and lock of ctx->ctx_lock. Analogously we
1656 * increment ctx->reqs_active before checking for ctx->dead and the
1657 * barrier is realized by unlock and lock of ctx->ctx_lock. Thus if we
1658 * don't see ctx->dead set here, io_destroy() waits for our IO to
1659 * finish.
1660 */
1661 if (ctx->dead) {
1662 spin_unlock_irq(&ctx->ctx_lock);
1663 ret = -EINVAL;
1664 goto out_put_req;
1665 }
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001666 aio_run_iocb(req);
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001667 if (!list_empty(&ctx->run_list)) {
Ken Chen954d3e92005-05-01 08:59:16 -07001668 /* drain the run list */
1669 while (__aio_run_iocbs(ctx))
1670 ;
1671 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyercfb1e332009-10-02 18:57:36 -04001673
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 aio_put_req(req); /* drop extra ref to req */
1675 return 0;
1676
1677out_put_req:
1678 aio_put_req(req); /* drop extra ref to req */
1679 aio_put_req(req); /* drop i/o ref to req */
1680 return ret;
1681}
1682
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001683long do_io_submit(aio_context_t ctx_id, long nr,
1684 struct iocb __user *__user *iocbpp, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685{
1686 struct kioctx *ctx;
1687 long ret = 0;
Jeff Moyer080d6762011-11-02 13:40:10 -07001688 int i = 0;
Shaohua Li9f5b9422010-07-01 07:55:01 +02001689 struct blk_plug plug;
Jeff Moyer080d6762011-11-02 13:40:10 -07001690 struct kiocb_batch batch;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
1692 if (unlikely(nr < 0))
1693 return -EINVAL;
1694
Jeff Moyer75e1c702010-09-10 14:16:00 -07001695 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1696 nr = LONG_MAX/sizeof(*iocbpp);
1697
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1699 return -EFAULT;
1700
1701 ctx = lookup_ioctx(ctx_id);
1702 if (unlikely(!ctx)) {
1703 pr_debug("EINVAL: io_submit: invalid context id\n");
1704 return -EINVAL;
1705 }
1706
Jeff Moyer080d6762011-11-02 13:40:10 -07001707 kiocb_batch_init(&batch, nr);
1708
Shaohua Li9f5b9422010-07-01 07:55:01 +02001709 blk_start_plug(&plug);
1710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 /*
1712 * AKPM: should this return a partial result if some of the IOs were
1713 * successfully submitted?
1714 */
1715 for (i=0; i<nr; i++) {
1716 struct iocb __user *user_iocb;
1717 struct iocb tmp;
1718
1719 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1720 ret = -EFAULT;
1721 break;
1722 }
1723
1724 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1725 ret = -EFAULT;
1726 break;
1727 }
1728
Jeff Moyer080d6762011-11-02 13:40:10 -07001729 ret = io_submit_one(ctx, user_iocb, &tmp, &batch, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 if (ret)
1731 break;
1732 }
Shaohua Li9f5b9422010-07-01 07:55:01 +02001733 blk_finish_plug(&plug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
Gleb Natapov69e47472012-01-08 17:07:28 +02001735 kiocb_batch_free(ctx, &batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 put_ioctx(ctx);
1737 return i ? i : ret;
1738}
1739
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001740/* sys_io_submit:
1741 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1742 * the number of iocbs queued. May return -EINVAL if the aio_context
1743 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1744 * *iocbpp[0] is not properly initialized, if the operation specified
1745 * is invalid for the file descriptor in the iocb. May fail with
1746 * -EFAULT if any of the data structures point to invalid data. May
1747 * fail with -EBADF if the file descriptor specified in the first
1748 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1749 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1750 * fail with -ENOSYS if not implemented.
1751 */
1752SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1753 struct iocb __user * __user *, iocbpp)
1754{
1755 return do_io_submit(ctx_id, nr, iocbpp, 0);
1756}
1757
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758/* lookup_kiocb
1759 * Finds a given iocb for cancellation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 */
Adrian Bunk25ee7e32005-04-25 08:18:14 -07001761static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1762 u32 key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763{
1764 struct list_head *pos;
Zach Brownd00689a2005-11-13 16:07:34 -08001765
1766 assert_spin_locked(&ctx->ctx_lock);
1767
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 /* TODO: use a hash or array, this sucks. */
1769 list_for_each(pos, &ctx->active_reqs) {
1770 struct kiocb *kiocb = list_kiocb(pos);
1771 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1772 return kiocb;
1773 }
1774 return NULL;
1775}
1776
1777/* sys_io_cancel:
1778 * Attempts to cancel an iocb previously passed to io_submit. If
1779 * the operation is successfully cancelled, the resulting event is
1780 * copied into the memory pointed to by result without being placed
1781 * into the completion queue and 0 is returned. May fail with
1782 * -EFAULT if any of the data structures pointed to are invalid.
1783 * May fail with -EINVAL if aio_context specified by ctx_id is
1784 * invalid. May fail with -EAGAIN if the iocb specified was not
1785 * cancelled. Will fail with -ENOSYS if not implemented.
1786 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001787SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1788 struct io_event __user *, result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789{
1790 int (*cancel)(struct kiocb *iocb, struct io_event *res);
1791 struct kioctx *ctx;
1792 struct kiocb *kiocb;
1793 u32 key;
1794 int ret;
1795
1796 ret = get_user(key, &iocb->aio_key);
1797 if (unlikely(ret))
1798 return -EFAULT;
1799
1800 ctx = lookup_ioctx(ctx_id);
1801 if (unlikely(!ctx))
1802 return -EINVAL;
1803
1804 spin_lock_irq(&ctx->ctx_lock);
1805 ret = -EAGAIN;
1806 kiocb = lookup_kiocb(ctx, iocb, key);
1807 if (kiocb && kiocb->ki_cancel) {
1808 cancel = kiocb->ki_cancel;
1809 kiocb->ki_users ++;
1810 kiocbSetCancelled(kiocb);
1811 } else
1812 cancel = NULL;
1813 spin_unlock_irq(&ctx->ctx_lock);
1814
1815 if (NULL != cancel) {
1816 struct io_event tmp;
1817 pr_debug("calling cancel\n");
1818 memset(&tmp, 0, sizeof(tmp));
1819 tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
1820 tmp.data = kiocb->ki_user_data;
1821 ret = cancel(kiocb, &tmp);
1822 if (!ret) {
1823 /* Cancellation succeeded -- copy the result
1824 * into the user's buffer.
1825 */
1826 if (copy_to_user(result, &tmp, sizeof(tmp)))
1827 ret = -EFAULT;
1828 }
1829 } else
Wendy Cheng8f582022005-09-09 13:02:08 -07001830 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
1832 put_ioctx(ctx);
1833
1834 return ret;
1835}
1836
1837/* io_getevents:
1838 * Attempts to read at least min_nr events and up to nr events from
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001839 * the completion queue for the aio_context specified by ctx_id. If
1840 * it succeeds, the number of read events is returned. May fail with
1841 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1842 * out of range, if timeout is out of range. May fail with -EFAULT
1843 * if any of the memory specified is invalid. May return 0 or
1844 * < min_nr if the timeout specified by timeout has elapsed
1845 * before sufficient events are available, where timeout == NULL
1846 * specifies an infinite timeout. Note that the timeout pointed to by
1847 * timeout is relative and will be updated if not NULL and the
1848 * operation blocks. Will fail with -ENOSYS if not implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001850SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1851 long, min_nr,
1852 long, nr,
1853 struct io_event __user *, events,
1854 struct timespec __user *, timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855{
1856 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1857 long ret = -EINVAL;
1858
1859 if (likely(ioctx)) {
Namhyung Kim2e410252011-01-12 17:01:08 -08001860 if (likely(min_nr <= nr && min_nr >= 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 ret = read_events(ioctx, min_nr, nr, events, timeout);
1862 put_ioctx(ioctx);
1863 }
1864
Roland McGrath598af052008-04-10 15:38:45 -07001865 asmlinkage_protect(5, ret, ctx_id, min_nr, nr, events, timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 return ret;
1867}