blob: d09b56090aa5e7d1a2a9d60999b2a1048f539162 [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 unsigned nr_events = ctx->max_reqs;
203
Adrian Bunkd5470b52008-04-29 00:58:57 -0700204 kmem_cache_free(kioctx_cachep, ctx);
205
206 if (nr_events) {
207 spin_lock(&aio_nr_lock);
208 BUG_ON(aio_nr - nr_events > aio_nr);
209 aio_nr -= nr_events;
210 spin_unlock(&aio_nr_lock);
211 }
212}
213
Jens Axboeabf137d2008-12-09 08:11:22 +0100214/* __put_ioctx
215 * Called when the last user of an aio context has gone away,
216 * and the struct needs to be freed.
217 */
218static void __put_ioctx(struct kioctx *ctx)
219{
220 BUG_ON(ctx->reqs_active);
221
222 cancel_delayed_work(&ctx->wq);
223 cancel_work_sync(&ctx->wq.work);
224 aio_free_ring(ctx);
225 mmdrop(ctx->mm);
226 ctx->mm = NULL;
227 pr_debug("__put_ioctx: freeing %p\n", ctx);
228 call_rcu(&ctx->rcu_head, ctx_rcu_free);
229}
230
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800231static inline int try_get_ioctx(struct kioctx *kioctx)
232{
233 return atomic_inc_not_zero(&kioctx->users);
234}
235
236static inline void put_ioctx(struct kioctx *kioctx)
237{
238 BUG_ON(atomic_read(&kioctx->users) <= 0);
239 if (unlikely(atomic_dec_and_test(&kioctx->users)))
240 __put_ioctx(kioctx);
241}
Adrian Bunkd5470b52008-04-29 00:58:57 -0700242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243/* ioctx_alloc
244 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
245 */
246static struct kioctx *ioctx_alloc(unsigned nr_events)
247{
248 struct mm_struct *mm;
249 struct kioctx *ctx;
Jens Axboeabf137d2008-12-09 08:11:22 +0100250 int did_sync = 0;
Al Viroe23754f2012-03-06 14:33:22 -0500251 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253 /* Prevent overflows */
254 if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
255 (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
256 pr_debug("ENOMEM: nr_events too high\n");
257 return ERR_PTR(-EINVAL);
258 }
259
Zach Brownd55b5fd2005-11-07 00:59:31 -0800260 if ((unsigned long)nr_events > aio_max_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 return ERR_PTR(-EAGAIN);
262
Robert P. J. Dayc3762222007-02-10 01:45:03 -0800263 ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 if (!ctx)
265 return ERR_PTR(-ENOMEM);
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 ctx->max_reqs = nr_events;
268 mm = ctx->mm = current->mm;
269 atomic_inc(&mm->mm_count);
270
Al Viro86b62a22012-03-07 05:16:35 +0000271 atomic_set(&ctx->users, 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 spin_lock_init(&ctx->ctx_lock);
273 spin_lock_init(&ctx->ring_info.ring_lock);
274 init_waitqueue_head(&ctx->wait);
275
276 INIT_LIST_HEAD(&ctx->active_reqs);
277 INIT_LIST_HEAD(&ctx->run_list);
David Howells65f27f32006-11-22 14:55:48 +0000278 INIT_DELAYED_WORK(&ctx->wq, aio_kick_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280 if (aio_setup_ring(ctx) < 0)
281 goto out_freectx;
282
283 /* limit the number of system wide aios */
Jens Axboeabf137d2008-12-09 08:11:22 +0100284 do {
285 spin_lock_bh(&aio_nr_lock);
286 if (aio_nr + nr_events > aio_max_nr ||
287 aio_nr + nr_events < aio_nr)
288 ctx->max_reqs = 0;
289 else
290 aio_nr += ctx->max_reqs;
291 spin_unlock_bh(&aio_nr_lock);
292 if (ctx->max_reqs || did_sync)
293 break;
294
295 /* wait for rcu callbacks to have completed before giving up */
296 synchronize_rcu();
297 did_sync = 1;
298 ctx->max_reqs = nr_events;
299 } while (1);
300
Zach Brownd55b5fd2005-11-07 00:59:31 -0800301 if (ctx->max_reqs == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 goto out_cleanup;
303
Jeff Moyer39fa0032008-04-29 01:03:48 -0700304 /* now link into global list. */
Jens Axboeabf137d2008-12-09 08:11:22 +0100305 spin_lock(&mm->ioctx_lock);
306 hlist_add_head_rcu(&ctx->list, &mm->ioctx_list);
307 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309 dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
310 ctx, ctx->user_id, current->mm, ctx->ring_info.nr);
311 return ctx;
312
313out_cleanup:
Al Viroe23754f2012-03-06 14:33:22 -0500314 err = -EAGAIN;
315 aio_free_ring(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316out_freectx:
317 mmdrop(mm);
318 kmem_cache_free(kioctx_cachep, ctx);
Al Viroe23754f2012-03-06 14:33:22 -0500319 dprintk("aio: error allocating ioctx %d\n", err);
320 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321}
322
323/* aio_cancel_all
324 * Cancels all outstanding aio requests on an aio context. Used
325 * when the processes owning a context have all exited to encourage
326 * the rapid destruction of the kioctx.
327 */
328static void aio_cancel_all(struct kioctx *ctx)
329{
330 int (*cancel)(struct kiocb *, struct io_event *);
331 struct io_event res;
332 spin_lock_irq(&ctx->ctx_lock);
333 ctx->dead = 1;
334 while (!list_empty(&ctx->active_reqs)) {
335 struct list_head *pos = ctx->active_reqs.next;
336 struct kiocb *iocb = list_kiocb(pos);
337 list_del_init(&iocb->ki_list);
338 cancel = iocb->ki_cancel;
339 kiocbSetCancelled(iocb);
340 if (cancel) {
341 iocb->ki_users++;
342 spin_unlock_irq(&ctx->ctx_lock);
343 cancel(iocb, &res);
344 spin_lock_irq(&ctx->ctx_lock);
345 }
346 }
347 spin_unlock_irq(&ctx->ctx_lock);
348}
349
Adrian Bunk25ee7e32005-04-25 08:18:14 -0700350static void wait_for_all_aios(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351{
352 struct task_struct *tsk = current;
353 DECLARE_WAITQUEUE(wait, tsk);
354
Ken Chendee11c22007-02-03 01:13:45 -0800355 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 if (!ctx->reqs_active)
Ken Chendee11c22007-02-03 01:13:45 -0800357 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359 add_wait_queue(&ctx->wait, &wait);
360 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
361 while (ctx->reqs_active) {
Ken Chendee11c22007-02-03 01:13:45 -0800362 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer41d10da2007-10-16 23:27:20 -0700363 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 set_task_state(tsk, TASK_UNINTERRUPTIBLE);
Ken Chendee11c22007-02-03 01:13:45 -0800365 spin_lock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 }
367 __set_task_state(tsk, TASK_RUNNING);
368 remove_wait_queue(&ctx->wait, &wait);
Ken Chendee11c22007-02-03 01:13:45 -0800369
370out:
371 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372}
373
374/* wait_on_sync_kiocb:
375 * Waits on the given sync kiocb to complete.
376 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800377ssize_t wait_on_sync_kiocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378{
379 while (iocb->ki_users) {
380 set_current_state(TASK_UNINTERRUPTIBLE);
381 if (!iocb->ki_users)
382 break;
Jeff Moyer41d10da2007-10-16 23:27:20 -0700383 io_schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 }
385 __set_current_state(TASK_RUNNING);
386 return iocb->ki_user_data;
387}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700388EXPORT_SYMBOL(wait_on_sync_kiocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390/* exit_aio: called when the last user of mm goes away. At this point,
391 * there is no way for any new requests to be submited or any of the
392 * io_* syscalls to be called on the context. However, there may be
393 * outstanding requests which hold references to the context; as they
394 * go away, they will call put_ioctx and release any pinned memory
395 * associated with the request (held via struct page * references).
396 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800397void exit_aio(struct mm_struct *mm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Jens Axboeabf137d2008-12-09 08:11:22 +0100399 struct kioctx *ctx;
400
401 while (!hlist_empty(&mm->ioctx_list)) {
402 ctx = hlist_entry(mm->ioctx_list.first, struct kioctx, list);
403 hlist_del_rcu(&ctx->list);
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 aio_cancel_all(ctx);
406
407 wait_for_all_aios(ctx);
408 /*
Andrew Mortona9df62c2007-05-09 02:33:54 -0700409 * Ensure we don't leave the ctx on the aio_wq
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 */
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700411 cancel_work_sync(&ctx->wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413 if (1 != atomic_read(&ctx->users))
414 printk(KERN_DEBUG
415 "exit_aio:ioctx still alive: %d %d %d\n",
416 atomic_read(&ctx->users), ctx->dead,
417 ctx->reqs_active);
418 put_ioctx(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 }
420}
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/* aio_get_req
423 * Allocate a slot for an aio request. Increments the users count
424 * of the kioctx so that the kioctx stays around until all requests are
425 * complete. Returns NULL if no requests are free.
426 *
427 * Returns with kiocb->users set to 2. The io submit code path holds
428 * an extra reference while submitting the i/o.
429 * This prevents races between the aio code path referencing the
430 * req (after submitting it) and aio_complete() freeing the req.
431 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800432static struct kiocb *__aio_get_req(struct kioctx *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433{
434 struct kiocb *req = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436 req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
437 if (unlikely(!req))
438 return NULL;
439
Zach Brown4faa5282005-10-17 16:43:33 -0700440 req->ki_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 req->ki_users = 2;
442 req->ki_key = 0;
443 req->ki_ctx = ctx;
444 req->ki_cancel = NULL;
445 req->ki_retry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 req->ki_dtor = NULL;
447 req->private = NULL;
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700448 req->ki_iovec = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 INIT_LIST_HEAD(&req->ki_run_list);
Davide Libenzi87c3a862009-03-18 17:04:19 -0700450 req->ki_eventfd = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 return req;
453}
454
Jeff Moyer080d6762011-11-02 13:40:10 -0700455/*
456 * struct kiocb's are allocated in batches to reduce the number of
457 * times the ctx lock is acquired and released.
458 */
459#define KIOCB_BATCH_SIZE 32L
460struct kiocb_batch {
461 struct list_head head;
462 long count; /* number of requests left to allocate */
463};
464
465static void kiocb_batch_init(struct kiocb_batch *batch, long total)
466{
467 INIT_LIST_HEAD(&batch->head);
468 batch->count = total;
469}
470
Gleb Natapov69e47472012-01-08 17:07:28 +0200471static void kiocb_batch_free(struct kioctx *ctx, struct kiocb_batch *batch)
Jeff Moyer080d6762011-11-02 13:40:10 -0700472{
473 struct kiocb *req, *n;
474
Gleb Natapov69e47472012-01-08 17:07:28 +0200475 if (list_empty(&batch->head))
476 return;
477
478 spin_lock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700479 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
480 list_del(&req->ki_batch);
Gleb Natapov69e47472012-01-08 17:07:28 +0200481 list_del(&req->ki_list);
Jeff Moyer080d6762011-11-02 13:40:10 -0700482 kmem_cache_free(kiocb_cachep, req);
Gleb Natapov69e47472012-01-08 17:07:28 +0200483 ctx->reqs_active--;
Jeff Moyer080d6762011-11-02 13:40:10 -0700484 }
Jeff Moyer880641b2012-03-05 14:59:12 -0800485 if (unlikely(!ctx->reqs_active && ctx->dead))
486 wake_up_all(&ctx->wait);
Gleb Natapov69e47472012-01-08 17:07:28 +0200487 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyer080d6762011-11-02 13:40:10 -0700488}
489
490/*
491 * Allocate a batch of kiocbs. This avoids taking and dropping the
492 * context lock a lot during setup.
493 */
494static int kiocb_batch_refill(struct kioctx *ctx, struct kiocb_batch *batch)
495{
496 unsigned short allocated, to_alloc;
497 long avail;
498 bool called_fput = false;
499 struct kiocb *req, *n;
500 struct aio_ring *ring;
501
502 to_alloc = min(batch->count, KIOCB_BATCH_SIZE);
503 for (allocated = 0; allocated < to_alloc; allocated++) {
504 req = __aio_get_req(ctx);
505 if (!req)
506 /* allocation failed, go with what we've got */
507 break;
508 list_add(&req->ki_batch, &batch->head);
509 }
510
511 if (allocated == 0)
512 goto out;
513
514retry:
515 spin_lock_irq(&ctx->ctx_lock);
516 ring = kmap_atomic(ctx->ring_info.ring_pages[0]);
517
518 avail = aio_ring_avail(&ctx->ring_info, ring) - ctx->reqs_active;
519 BUG_ON(avail < 0);
520 if (avail == 0 && !called_fput) {
521 /*
522 * Handle a potential starvation case. It is possible that
523 * we hold the last reference on a struct file, causing us
524 * to delay the final fput to non-irq context. In this case,
525 * ctx->reqs_active is artificially high. Calling the fput
526 * routine here may free up a slot in the event completion
527 * ring, allowing this allocation to succeed.
528 */
529 kunmap_atomic(ring);
530 spin_unlock_irq(&ctx->ctx_lock);
531 aio_fput_routine(NULL);
532 called_fput = true;
533 goto retry;
534 }
535
536 if (avail < allocated) {
537 /* Trim back the number of requests. */
538 list_for_each_entry_safe(req, n, &batch->head, ki_batch) {
539 list_del(&req->ki_batch);
540 kmem_cache_free(kiocb_cachep, req);
541 if (--allocated <= avail)
542 break;
543 }
544 }
545
546 batch->count -= allocated;
547 list_for_each_entry(req, &batch->head, ki_batch) {
548 list_add(&req->ki_list, &ctx->active_reqs);
549 ctx->reqs_active++;
550 }
551
552 kunmap_atomic(ring);
553 spin_unlock_irq(&ctx->ctx_lock);
554
555out:
556 return allocated;
557}
558
559static inline struct kiocb *aio_get_req(struct kioctx *ctx,
560 struct kiocb_batch *batch)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
562 struct kiocb *req;
Jeff Moyer080d6762011-11-02 13:40:10 -0700563
564 if (list_empty(&batch->head))
565 if (kiocb_batch_refill(ctx, batch) == 0)
566 return NULL;
567 req = list_first_entry(&batch->head, struct kiocb, ki_batch);
568 list_del(&req->ki_batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return req;
570}
571
572static inline void really_put_req(struct kioctx *ctx, struct kiocb *req)
573{
Zach Brownd00689a2005-11-13 16:07:34 -0800574 assert_spin_locked(&ctx->ctx_lock);
575
Davide Libenzi13389012009-06-30 11:41:11 -0700576 if (req->ki_eventfd != NULL)
577 eventfd_ctx_put(req->ki_eventfd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 if (req->ki_dtor)
579 req->ki_dtor(req);
Badari Pulavartyeed4e512006-09-30 23:28:49 -0700580 if (req->ki_iovec != &req->ki_inline_vec)
581 kfree(req->ki_iovec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 kmem_cache_free(kiocb_cachep, req);
583 ctx->reqs_active--;
584
585 if (unlikely(!ctx->reqs_active && ctx->dead))
Roland Dreiere91f90b2011-03-22 16:35:10 -0700586 wake_up_all(&ctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
588
David Howells65f27f32006-11-22 14:55:48 +0000589static void aio_fput_routine(struct work_struct *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
591 spin_lock_irq(&fput_lock);
592 while (likely(!list_empty(&fput_head))) {
593 struct kiocb *req = list_kiocb(fput_head.next);
594 struct kioctx *ctx = req->ki_ctx;
595
596 list_del(&req->ki_list);
597 spin_unlock_irq(&fput_lock);
598
Davide Libenzi87c3a862009-03-18 17:04:19 -0700599 /* Complete the fput(s) */
600 if (req->ki_filp != NULL)
Al Virod7065da2010-05-26 15:13:55 -0400601 fput(req->ki_filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
603 /* Link the iocb into the context's free list */
Al Viroc7b28552012-03-08 17:51:19 +0000604 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 spin_lock_irq(&ctx->ctx_lock);
606 really_put_req(ctx, req);
Al Viroc7b28552012-03-08 17:51:19 +0000607 /*
608 * at that point ctx might've been killed, but actual
609 * freeing is RCU'd
610 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 spin_unlock_irq(&ctx->ctx_lock);
Al Viroc7b28552012-03-08 17:51:19 +0000612 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 spin_lock_irq(&fput_lock);
615 }
616 spin_unlock_irq(&fput_lock);
617}
618
619/* __aio_put_req
620 * Returns true if this put was the last user of the request.
621 */
622static int __aio_put_req(struct kioctx *ctx, struct kiocb *req)
623{
Al Viro516e0cc2008-07-26 00:39:17 -0400624 dprintk(KERN_DEBUG "aio_put(%p): f_count=%ld\n",
625 req, atomic_long_read(&req->ki_filp->f_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Zach Brownd00689a2005-11-13 16:07:34 -0800627 assert_spin_locked(&ctx->ctx_lock);
628
Davide Libenzi87c3a862009-03-18 17:04:19 -0700629 req->ki_users--;
Eric Sesterhenn93e06b42006-11-30 05:29:23 +0100630 BUG_ON(req->ki_users < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 if (likely(req->ki_users))
632 return 0;
633 list_del(&req->ki_list); /* remove from active_reqs */
634 req->ki_cancel = NULL;
635 req->ki_retry = NULL;
636
Davide Libenzi87c3a862009-03-18 17:04:19 -0700637 /*
638 * Try to optimize the aio and eventfd file* puts, by avoiding to
Al Virod7065da2010-05-26 15:13:55 -0400639 * schedule work in case it is not final fput() time. In normal cases,
Davide Libenzi87c3a862009-03-18 17:04:19 -0700640 * we would not be holding the last reference to the file*, so
641 * this function will be executed w/out any aio kthread wakeup.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 */
Al Virod7065da2010-05-26 15:13:55 -0400643 if (unlikely(!fput_atomic(req->ki_filp))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 spin_lock(&fput_lock);
645 list_add(&req->ki_list, &fput_head);
646 spin_unlock(&fput_lock);
Tejun Heod37adaa2011-01-26 17:42:27 +0100647 schedule_work(&fput_work);
Davide Libenzi13389012009-06-30 11:41:11 -0700648 } else {
649 req->ki_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 really_put_req(ctx, req);
Davide Libenzi13389012009-06-30 11:41:11 -0700651 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return 1;
653}
654
655/* aio_put_req
656 * Returns true if this put was the last user of the kiocb,
657 * false if the request is still in use.
658 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800659int aio_put_req(struct kiocb *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
661 struct kioctx *ctx = req->ki_ctx;
662 int ret;
663 spin_lock_irq(&ctx->ctx_lock);
664 ret = __aio_put_req(ctx, req);
665 spin_unlock_irq(&ctx->ctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 return ret;
667}
H Hartley Sweeten385773e2009-09-22 16:43:53 -0700668EXPORT_SYMBOL(aio_put_req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Adrian Bunkd5470b52008-04-29 00:58:57 -0700670static struct kioctx *lookup_ioctx(unsigned long ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671{
Jens Axboeabf137d2008-12-09 08:11:22 +0100672 struct mm_struct *mm = current->mm;
Jeff Moyer65c24492009-03-18 17:04:21 -0700673 struct kioctx *ctx, *ret = NULL;
Jens Axboeabf137d2008-12-09 08:11:22 +0100674 struct hlist_node *n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Jens Axboeabf137d2008-12-09 08:11:22 +0100676 rcu_read_lock();
677
678 hlist_for_each_entry_rcu(ctx, n, &mm->ioctx_list, list) {
Nick Piggin3bd9a5d2011-02-25 14:44:26 -0800679 /*
680 * RCU protects us against accessing freed memory but
681 * we have to be careful not to get a reference when the
682 * reference count already dropped to 0 (ctx->dead test
683 * is unreliable because of races).
684 */
685 if (ctx->user_id == ctx_id && !ctx->dead && try_get_ioctx(ctx)){
Jeff Moyer65c24492009-03-18 17:04:21 -0700686 ret = ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 break;
688 }
Jens Axboeabf137d2008-12-09 08:11:22 +0100689 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Jens Axboeabf137d2008-12-09 08:11:22 +0100691 rcu_read_unlock();
Jeff Moyer65c24492009-03-18 17:04:21 -0700692 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693}
694
695/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 * Queue up a kiocb to be retried. Assumes that the kiocb
697 * has already been marked as kicked, and places it on
698 * the retry run list for the corresponding ioctx, if it
699 * isn't already queued. Returns 1 if it actually queued
700 * the kiocb (to tell the caller to activate the work
701 * queue to process it), or 0, if it found that it was
702 * already queued.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 */
704static inline int __queue_kicked_iocb(struct kiocb *iocb)
705{
706 struct kioctx *ctx = iocb->ki_ctx;
707
Zach Brownd00689a2005-11-13 16:07:34 -0800708 assert_spin_locked(&ctx->ctx_lock);
709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 if (list_empty(&iocb->ki_run_list)) {
711 list_add_tail(&iocb->ki_run_list,
712 &ctx->run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 return 1;
714 }
715 return 0;
716}
717
718/* aio_run_iocb
719 * This is the core aio execution routine. It is
720 * invoked both for initial i/o submission and
721 * subsequent retries via the aio_kick_handler.
722 * Expects to be invoked with iocb->ki_ctx->lock
Andreas Mohrd6e05ed2006-06-26 18:35:02 +0200723 * already held. The lock is released and reacquired
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 * as needed during processing.
725 *
726 * Calls the iocb retry method (already setup for the
727 * iocb on initial submission) for operation specific
728 * handling, but takes care of most of common retry
729 * execution details for a given iocb. The retry method
730 * needs to be non-blocking as far as possible, to avoid
731 * holding up other iocbs waiting to be serviced by the
732 * retry kernel thread.
733 *
734 * The trickier parts in this code have to do with
735 * ensuring that only one retry instance is in progress
736 * for a given iocb at any time. Providing that guarantee
737 * simplifies the coding of individual aio operations as
738 * it avoids various potential races.
739 */
740static ssize_t aio_run_iocb(struct kiocb *iocb)
741{
742 struct kioctx *ctx = iocb->ki_ctx;
743 ssize_t (*retry)(struct kiocb *);
744 ssize_t ret;
745
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 if (!(retry = iocb->ki_retry)) {
747 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
748 return 0;
749 }
750
751 /*
752 * We don't want the next retry iteration for this
753 * operation to start until this one has returned and
754 * updated the iocb state. However, wait_queue functions
755 * can trigger a kick_iocb from interrupt context in the
756 * meantime, indicating that data is available for the next
757 * iteration. We want to remember that and enable the
758 * next retry iteration _after_ we are through with
759 * this one.
760 *
761 * So, in order to be able to register a "kick", but
762 * prevent it from being queued now, we clear the kick
763 * flag, but make the kick code *think* that the iocb is
764 * still on the run list until we are actually done.
765 * When we are done with this iteration, we check if
766 * the iocb was kicked in the meantime and if so, queue
767 * it up afresh.
768 */
769
770 kiocbClearKicked(iocb);
771
772 /*
773 * This is so that aio_complete knows it doesn't need to
774 * pull the iocb off the run list (We can't just call
775 * INIT_LIST_HEAD because we don't want a kick_iocb to
776 * queue this on the run list yet)
777 */
778 iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
779 spin_unlock_irq(&ctx->ctx_lock);
780
781 /* Quit retrying if the i/o has been cancelled */
782 if (kiocbIsCancelled(iocb)) {
783 ret = -EINTR;
784 aio_complete(iocb, ret, 0);
785 /* must not access the iocb after this */
786 goto out;
787 }
788
789 /*
790 * Now we are all set to call the retry method in async
Alexey Dobriyan6212e3a2007-10-18 03:04:56 -0700791 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 ret = retry(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Jan Karaa0c42ba2010-09-22 13:05:03 -0700795 if (ret != -EIOCBRETRY && ret != -EIOCBQUEUED) {
796 /*
797 * There's no easy way to restart the syscall since other AIO's
798 * may be already running. Just fail this IO with EINTR.
799 */
800 if (unlikely(ret == -ERESTARTSYS || ret == -ERESTARTNOINTR ||
801 ret == -ERESTARTNOHAND || ret == -ERESTART_RESTARTBLOCK))
802 ret = -EINTR;
Zach Brown897f15f2005-09-30 11:58:55 -0700803 aio_complete(iocb, ret, 0);
Jan Karaa0c42ba2010-09-22 13:05:03 -0700804 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805out:
806 spin_lock_irq(&ctx->ctx_lock);
807
808 if (-EIOCBRETRY == ret) {
809 /*
810 * OK, now that we are done with this iteration
811 * and know that there is more left to go,
812 * this is where we let go so that a subsequent
813 * "kick" can start the next iteration
814 */
815
816 /* will make __queue_kicked_iocb succeed from here on */
817 INIT_LIST_HEAD(&iocb->ki_run_list);
818 /* we must queue the next iteration ourselves, if it
819 * has already been kicked */
820 if (kiocbIsKicked(iocb)) {
821 __queue_kicked_iocb(iocb);
Sébastien Duguc016e222005-06-28 20:44:59 -0700822
823 /*
824 * __queue_kicked_iocb will always return 1 here, because
825 * iocb->ki_run_list is empty at this point so it should
826 * be safe to unconditionally queue the context into the
827 * work queue.
828 */
829 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 }
831 }
832 return ret;
833}
834
835/*
836 * __aio_run_iocbs:
837 * Process all pending retries queued on the ioctx
838 * run list.
839 * Assumes it is operating within the aio issuer's mm
Zach Brownd00689a2005-11-13 16:07:34 -0800840 * context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 */
842static int __aio_run_iocbs(struct kioctx *ctx)
843{
844 struct kiocb *iocb;
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700845 struct list_head run_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846
Zach Brownd00689a2005-11-13 16:07:34 -0800847 assert_spin_locked(&ctx->ctx_lock);
848
Oleg Nesterov626ab0e2006-06-23 02:05:55 -0700849 list_replace_init(&ctx->run_list, &run_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 while (!list_empty(&run_list)) {
851 iocb = list_entry(run_list.next, struct kiocb,
852 ki_run_list);
853 list_del(&iocb->ki_run_list);
854 /*
855 * Hold an extra reference while retrying i/o.
856 */
857 iocb->ki_users++; /* grab extra reference */
858 aio_run_iocb(iocb);
Ken Chendee11c22007-02-03 01:13:45 -0800859 __aio_put_req(ctx, iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 if (!list_empty(&ctx->run_list))
862 return 1;
863 return 0;
864}
865
866static void aio_queue_work(struct kioctx * ctx)
867{
868 unsigned long timeout;
869 /*
870 * if someone is waiting, get the work started right
871 * away, otherwise, use a longer delay
872 */
873 smp_mb();
874 if (waitqueue_active(&ctx->wait))
875 timeout = 1;
876 else
877 timeout = HZ/10;
878 queue_delayed_work(aio_wq, &ctx->wq, timeout);
879}
880
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881/*
Jeff Moyerd3486f82011-01-12 17:01:08 -0800882 * aio_run_all_iocbs:
883 * Process all pending retries queued on the ioctx
884 * run list, and keep running them until the list
885 * stays empty.
886 * Assumes it is operating within the aio issuer's mm context.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 */
888static inline void aio_run_all_iocbs(struct kioctx *ctx)
889{
890 spin_lock_irq(&ctx->ctx_lock);
891 while (__aio_run_iocbs(ctx))
892 ;
893 spin_unlock_irq(&ctx->ctx_lock);
894}
895
896/*
897 * aio_kick_handler:
898 * Work queue handler triggered to process pending
899 * retries on an ioctx. Takes on the aio issuer's
900 * mm context before running the iocbs, so that
901 * copy_xxx_user operates on the issuer's address
902 * space.
903 * Run on aiod's context.
904 */
David Howells65f27f32006-11-22 14:55:48 +0000905static void aio_kick_handler(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906{
David Howells65f27f32006-11-22 14:55:48 +0000907 struct kioctx *ctx = container_of(work, struct kioctx, wq.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 mm_segment_t oldfs = get_fs();
Zach Brown1ebb1102006-12-29 16:47:02 -0800909 struct mm_struct *mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 int requeue;
911
912 set_fs(USER_DS);
913 use_mm(ctx->mm);
914 spin_lock_irq(&ctx->ctx_lock);
915 requeue =__aio_run_iocbs(ctx);
Zach Brown1ebb1102006-12-29 16:47:02 -0800916 mm = ctx->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 spin_unlock_irq(&ctx->ctx_lock);
Zach Brown1ebb1102006-12-29 16:47:02 -0800918 unuse_mm(mm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 set_fs(oldfs);
920 /*
921 * we're in a worker thread already, don't use queue_delayed_work,
922 */
923 if (requeue)
David Howells52bad642006-11-22 14:54:01 +0000924 queue_delayed_work(aio_wq, &ctx->wq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925}
926
927
928/*
929 * Called by kick_iocb to queue the kiocb for retry
930 * and if required activate the aio work queue to process
931 * it
932 */
Zach Brown998765e2005-09-30 11:58:54 -0700933static void try_queue_kicked_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934{
935 struct kioctx *ctx = iocb->ki_ctx;
936 unsigned long flags;
937 int run = 0;
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 spin_lock_irqsave(&ctx->ctx_lock, flags);
Zach Brown998765e2005-09-30 11:58:54 -0700940 /* set this inside the lock so that we can't race with aio_run_iocb()
941 * testing it and putting the iocb on the run list under the lock */
942 if (!kiocbTryKick(iocb))
943 run = __queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Ken Chen644d3a02005-05-01 08:59:15 -0700945 if (run)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 aio_queue_work(ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947}
948
949/*
950 * kick_iocb:
951 * Called typically from a wait queue callback context
Shaohua Lifac046a2009-12-15 16:47:47 -0800952 * to trigger a retry of the iocb.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 * The retry is usually executed by aio workqueue
954 * threads (See aio_kick_handler).
955 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800956void kick_iocb(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957{
958 /* sync iocbs are easy: they can only ever be executing from a
959 * single context. */
960 if (is_sync_kiocb(iocb)) {
961 kiocbSetKicked(iocb);
962 wake_up_process(iocb->ki_obj.tsk);
963 return;
964 }
965
Zach Brown998765e2005-09-30 11:58:54 -0700966 try_queue_kicked_iocb(iocb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967}
968EXPORT_SYMBOL(kick_iocb);
969
970/* aio_complete
971 * Called when the io request on the given iocb is complete.
972 * Returns true if this is the last user of the request. The
973 * only other user of the request can be the cancellation code.
974 */
Harvey Harrisonfc9b52c2008-02-08 04:19:52 -0800975int aio_complete(struct kiocb *iocb, long res, long res2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
977 struct kioctx *ctx = iocb->ki_ctx;
978 struct aio_ring_info *info;
979 struct aio_ring *ring;
980 struct io_event *event;
981 unsigned long flags;
982 unsigned long tail;
983 int ret;
984
Zach Brown20dcae32005-11-13 16:07:33 -0800985 /*
986 * Special case handling for sync iocbs:
987 * - events go directly into the iocb for fast handling
988 * - the sync task with the iocb in its stack holds the single iocb
989 * ref, no other paths have a way to get another ref
990 * - the sync task helpfully left a reference to itself in the iocb
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 */
992 if (is_sync_kiocb(iocb)) {
Zach Brown20dcae32005-11-13 16:07:33 -0800993 BUG_ON(iocb->ki_users != 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 iocb->ki_user_data = res;
Zach Brown20dcae32005-11-13 16:07:33 -0800995 iocb->ki_users = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 wake_up_process(iocb->ki_obj.tsk);
Zach Brown20dcae32005-11-13 16:07:33 -0800997 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 }
999
1000 info = &ctx->ring_info;
1001
1002 /* add a completion event to the ring buffer.
1003 * must be done holding ctx->ctx_lock to prevent
1004 * other code from messing with the tail
1005 * pointer since we might be called from irq
1006 * context.
1007 */
1008 spin_lock_irqsave(&ctx->ctx_lock, flags);
1009
1010 if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
1011 list_del_init(&iocb->ki_run_list);
1012
1013 /*
1014 * cancelled requests don't get events, userland was given one
1015 * when the event got cancelled.
1016 */
1017 if (kiocbIsCancelled(iocb))
1018 goto put_rq;
1019
1020 ring = kmap_atomic(info->ring_pages[0], KM_IRQ1);
1021
1022 tail = info->tail;
1023 event = aio_ring_event(info, tail, KM_IRQ0);
Ken Chen4bf69b22005-05-01 08:59:15 -07001024 if (++tail >= info->nr)
1025 tail = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
1027 event->obj = (u64)(unsigned long)iocb->ki_obj.user;
1028 event->data = iocb->ki_user_data;
1029 event->res = res;
1030 event->res2 = res2;
1031
1032 dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
1033 ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
1034 res, res2);
1035
1036 /* after flagging the request as done, we
1037 * must never even look at it again
1038 */
1039 smp_wmb(); /* make event visible before updating tail */
1040
1041 info->tail = tail;
1042 ring->tail = tail;
1043
1044 put_aio_ring_event(event, KM_IRQ0);
1045 kunmap_atomic(ring, KM_IRQ1);
1046
1047 pr_debug("added to ring %p at [%lu]\n", iocb, tail);
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001048
1049 /*
1050 * Check if the user asked us to deliver the result through an
1051 * eventfd. The eventfd_signal() function is safe to be called
1052 * from IRQ context.
1053 */
Davide Libenzi87c3a862009-03-18 17:04:19 -07001054 if (iocb->ki_eventfd != NULL)
Davide Libenzi8d1c98b2008-04-10 21:29:19 -07001055 eventfd_signal(iocb->ki_eventfd, 1);
1056
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057put_rq:
1058 /* everything turned out well, dispose of the aiocb. */
1059 ret = __aio_put_req(ctx, iocb);
1060
Quentin Barnes6cb2a212008-03-19 17:00:39 -07001061 /*
1062 * We have to order our ring_info tail store above and test
1063 * of the wait list below outside the wait lock. This is
1064 * like in wake_up_bit() where clearing a bit has to be
1065 * ordered with the unlocked test.
1066 */
1067 smp_mb();
1068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 if (waitqueue_active(&ctx->wait))
1070 wake_up(&ctx->wait);
1071
Ken Chendee11c22007-02-03 01:13:45 -08001072 spin_unlock_irqrestore(&ctx->ctx_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 return ret;
1074}
H Hartley Sweeten385773e2009-09-22 16:43:53 -07001075EXPORT_SYMBOL(aio_complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077/* aio_read_evt
1078 * Pull an event off of the ioctx's event ring. Returns the number of
1079 * events fetched (0 or 1 ;-)
1080 * FIXME: make this use cmpxchg.
1081 * TODO: make the ringbuffer user mmap()able (requires FIXME).
1082 */
1083static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
1084{
1085 struct aio_ring_info *info = &ioctx->ring_info;
1086 struct aio_ring *ring;
1087 unsigned long head;
1088 int ret = 0;
1089
1090 ring = kmap_atomic(info->ring_pages[0], KM_USER0);
1091 dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1092 (unsigned long)ring->head, (unsigned long)ring->tail,
1093 (unsigned long)ring->nr);
1094
1095 if (ring->head == ring->tail)
1096 goto out;
1097
1098 spin_lock(&info->ring_lock);
1099
1100 head = ring->head % info->nr;
1101 if (head != ring->tail) {
1102 struct io_event *evp = aio_ring_event(info, head, KM_USER1);
1103 *ent = *evp;
1104 head = (head + 1) % info->nr;
1105 smp_mb(); /* finish reading the event before updatng the head */
1106 ring->head = head;
1107 ret = 1;
1108 put_aio_ring_event(evp, KM_USER1);
1109 }
1110 spin_unlock(&info->ring_lock);
1111
1112out:
1113 kunmap_atomic(ring, KM_USER0);
1114 dprintk("leaving aio_read_evt: %d h%lu t%lu\n", ret,
1115 (unsigned long)ring->head, (unsigned long)ring->tail);
1116 return ret;
1117}
1118
1119struct aio_timeout {
1120 struct timer_list timer;
1121 int timed_out;
1122 struct task_struct *p;
1123};
1124
1125static void timeout_func(unsigned long data)
1126{
1127 struct aio_timeout *to = (struct aio_timeout *)data;
1128
1129 to->timed_out = 1;
1130 wake_up_process(to->p);
1131}
1132
1133static inline void init_timeout(struct aio_timeout *to)
1134{
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001135 setup_timer_on_stack(&to->timer, timeout_func, (unsigned long) to);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 to->timed_out = 0;
1137 to->p = current;
1138}
1139
1140static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
1141 const struct timespec *ts)
1142{
1143 to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
1144 if (time_after(to->timer.expires, jiffies))
1145 add_timer(&to->timer);
1146 else
1147 to->timed_out = 1;
1148}
1149
1150static inline void clear_timeout(struct aio_timeout *to)
1151{
1152 del_singleshot_timer_sync(&to->timer);
1153}
1154
1155static int read_events(struct kioctx *ctx,
1156 long min_nr, long nr,
1157 struct io_event __user *event,
1158 struct timespec __user *timeout)
1159{
1160 long start_jiffies = jiffies;
1161 struct task_struct *tsk = current;
1162 DECLARE_WAITQUEUE(wait, tsk);
1163 int ret;
1164 int i = 0;
1165 struct io_event ent;
1166 struct aio_timeout to;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 int retry = 0;
1168
1169 /* needed to zero any padding within an entry (there shouldn't be
1170 * any, but C is fun!
1171 */
1172 memset(&ent, 0, sizeof(ent));
1173retry:
1174 ret = 0;
1175 while (likely(i < nr)) {
1176 ret = aio_read_evt(ctx, &ent);
1177 if (unlikely(ret <= 0))
1178 break;
1179
1180 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1181 ent.data, ent.obj, ent.res, ent.res2);
1182
1183 /* Could we split the check in two? */
1184 ret = -EFAULT;
1185 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1186 dprintk("aio: lost an event due to EFAULT.\n");
1187 break;
1188 }
1189 ret = 0;
1190
1191 /* Good, event copied to userland, update counts. */
1192 event ++;
1193 i ++;
1194 }
1195
1196 if (min_nr <= i)
1197 return i;
1198 if (ret)
1199 return ret;
1200
1201 /* End fast path */
1202
1203 /* racey check, but it gets redone */
1204 if (!retry && unlikely(!list_empty(&ctx->run_list))) {
1205 retry = 1;
1206 aio_run_all_iocbs(ctx);
1207 goto retry;
1208 }
1209
1210 init_timeout(&to);
1211 if (timeout) {
1212 struct timespec ts;
1213 ret = -EFAULT;
1214 if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
1215 goto out;
1216
1217 set_timeout(start_jiffies, &to, &ts);
1218 }
1219
1220 while (likely(i < nr)) {
1221 add_wait_queue_exclusive(&ctx->wait, &wait);
1222 do {
1223 set_task_state(tsk, TASK_INTERRUPTIBLE);
1224 ret = aio_read_evt(ctx, &ent);
1225 if (ret)
1226 break;
1227 if (min_nr <= i)
1228 break;
Jeff Moyere92adcb2008-04-28 02:12:04 -07001229 if (unlikely(ctx->dead)) {
1230 ret = -EINVAL;
1231 break;
1232 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 if (to.timed_out) /* Only check after read evt */
1234 break;
Jeff Moyere00ba3d2007-12-04 23:45:02 -08001235 /* Try to only show up in io wait if there are ops
1236 * in flight */
1237 if (ctx->reqs_active)
1238 io_schedule();
1239 else
1240 schedule();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 if (signal_pending(tsk)) {
1242 ret = -EINTR;
1243 break;
1244 }
1245 /*ret = aio_read_evt(ctx, &ent);*/
1246 } while (1) ;
1247
1248 set_task_state(tsk, TASK_RUNNING);
1249 remove_wait_queue(&ctx->wait, &wait);
1250
1251 if (unlikely(ret <= 0))
1252 break;
1253
1254 ret = -EFAULT;
1255 if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
1256 dprintk("aio: lost an event due to EFAULT.\n");
1257 break;
1258 }
1259
1260 /* Good, event copied to userland, update counts. */
1261 event ++;
1262 i ++;
1263 }
1264
1265 if (timeout)
1266 clear_timeout(&to);
1267out:
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07001268 destroy_timer_on_stack(&to.timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 return i ? i : ret;
1270}
1271
1272/* Take an ioctx and remove it from the list of ioctx's. Protects
1273 * against races with itself via ->dead.
1274 */
1275static void io_destroy(struct kioctx *ioctx)
1276{
1277 struct mm_struct *mm = current->mm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 int was_dead;
1279
1280 /* delete the entry from the list is someone else hasn't already */
Jens Axboeabf137d2008-12-09 08:11:22 +01001281 spin_lock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 was_dead = ioctx->dead;
1283 ioctx->dead = 1;
Jens Axboeabf137d2008-12-09 08:11:22 +01001284 hlist_del_rcu(&ioctx->list);
1285 spin_unlock(&mm->ioctx_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287 dprintk("aio_release(%p)\n", ioctx);
1288 if (likely(!was_dead))
1289 put_ioctx(ioctx); /* twice for the list */
1290
1291 aio_cancel_all(ioctx);
1292 wait_for_all_aios(ioctx);
Jeff Moyere92adcb2008-04-28 02:12:04 -07001293
1294 /*
1295 * Wake up any waiters. The setting of ctx->dead must be seen
1296 * by other CPUs at this point. Right now, we rely on the
1297 * locking done by the above calls to ensure this consistency.
1298 */
Roland Dreiere91f90b2011-03-22 16:35:10 -07001299 wake_up_all(&ioctx->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 put_ioctx(ioctx); /* once for the lookup */
1301}
1302
1303/* sys_io_setup:
1304 * Create an aio_context capable of receiving at least nr_events.
1305 * ctxp must not point to an aio_context that already exists, and
1306 * must be initialized to 0 prior to the call. On successful
1307 * creation of the aio_context, *ctxp is filled in with the resulting
1308 * handle. May fail with -EINVAL if *ctxp is not initialized,
1309 * if the specified nr_events exceeds internal limits. May fail
1310 * with -EAGAIN if the specified nr_events exceeds the user's limit
1311 * of available events. May fail with -ENOMEM if insufficient kernel
1312 * resources are available. May fail with -EFAULT if an invalid
1313 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1314 * implemented.
1315 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001316SYSCALL_DEFINE2(io_setup, unsigned, nr_events, aio_context_t __user *, ctxp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317{
1318 struct kioctx *ioctx = NULL;
1319 unsigned long ctx;
1320 long ret;
1321
1322 ret = get_user(ctx, ctxp);
1323 if (unlikely(ret))
1324 goto out;
1325
1326 ret = -EINVAL;
Zach Brownd55b5fd2005-11-07 00:59:31 -08001327 if (unlikely(ctx || nr_events == 0)) {
1328 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1329 ctx, nr_events);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 goto out;
1331 }
1332
1333 ioctx = ioctx_alloc(nr_events);
1334 ret = PTR_ERR(ioctx);
1335 if (!IS_ERR(ioctx)) {
1336 ret = put_user(ioctx->user_id, ctxp);
Al Viro86b62a22012-03-07 05:16:35 +00001337 if (!ret) {
1338 put_ioctx(ioctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 return 0;
Al Viro86b62a22012-03-07 05:16:35 +00001340 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 io_destroy(ioctx);
1342 }
1343
1344out:
1345 return ret;
1346}
1347
1348/* sys_io_destroy:
1349 * Destroy the aio_context specified. May cancel any outstanding
1350 * AIOs and block on completion. Will fail with -ENOSYS if not
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001351 * implemented. May fail with -EINVAL if the context pointed to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 * is invalid.
1353 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001354SYSCALL_DEFINE1(io_destroy, aio_context_t, ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355{
1356 struct kioctx *ioctx = lookup_ioctx(ctx);
1357 if (likely(NULL != ioctx)) {
1358 io_destroy(ioctx);
1359 return 0;
1360 }
1361 pr_debug("EINVAL: io_destroy: invalid context id\n");
1362 return -EINVAL;
1363}
1364
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001365static void aio_advance_iovec(struct kiocb *iocb, ssize_t ret)
1366{
1367 struct iovec *iov = &iocb->ki_iovec[iocb->ki_cur_seg];
1368
1369 BUG_ON(ret <= 0);
1370
1371 while (iocb->ki_cur_seg < iocb->ki_nr_segs && ret > 0) {
1372 ssize_t this = min((ssize_t)iov->iov_len, ret);
1373 iov->iov_base += this;
1374 iov->iov_len -= this;
1375 iocb->ki_left -= this;
1376 ret -= this;
1377 if (iov->iov_len == 0) {
1378 iocb->ki_cur_seg++;
1379 iov++;
1380 }
1381 }
1382
1383 /* the caller should not have done more io than what fit in
1384 * the remaining iovecs */
1385 BUG_ON(ret > 0 && iocb->ki_left == 0);
1386}
1387
1388static ssize_t aio_rw_vect_retry(struct kiocb *iocb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389{
1390 struct file *file = iocb->ki_filp;
1391 struct address_space *mapping = file->f_mapping;
1392 struct inode *inode = mapping->host;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001393 ssize_t (*rw_op)(struct kiocb *, const struct iovec *,
1394 unsigned long, loff_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 ssize_t ret = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001396 unsigned short opcode;
1397
1398 if ((iocb->ki_opcode == IOCB_CMD_PREADV) ||
1399 (iocb->ki_opcode == IOCB_CMD_PREAD)) {
1400 rw_op = file->f_op->aio_read;
1401 opcode = IOCB_CMD_PREADV;
1402 } else {
1403 rw_op = file->f_op->aio_write;
1404 opcode = IOCB_CMD_PWRITEV;
1405 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
Rusty Russellc2ec6682008-02-08 04:20:15 -08001407 /* This matches the pread()/pwrite() logic */
1408 if (iocb->ki_pos < 0)
1409 return -EINVAL;
1410
Zach Brown897f15f2005-09-30 11:58:55 -07001411 do {
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001412 ret = rw_op(iocb, &iocb->ki_iovec[iocb->ki_cur_seg],
1413 iocb->ki_nr_segs - iocb->ki_cur_seg,
1414 iocb->ki_pos);
1415 if (ret > 0)
1416 aio_advance_iovec(iocb, ret);
Badari Pulavarty027445c2006-09-30 23:28:46 -07001417
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001418 /* retry all partial writes. retry partial reads as long as its a
1419 * regular file. */
Zach Brown353fb072005-09-30 11:58:56 -07001420 } while (ret > 0 && iocb->ki_left > 0 &&
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001421 (opcode == IOCB_CMD_PWRITEV ||
1422 (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
1424 /* This means we must have transferred all that we could */
1425 /* No need to retry anymore */
1426 if ((ret == 0) || (iocb->ki_left == 0))
1427 ret = iocb->ki_nbytes - iocb->ki_left;
1428
Rusty Russell7adfa2f2008-02-08 04:20:14 -08001429 /* If we managed to write some out we return that, rather than
1430 * the eventual error. */
1431 if (opcode == IOCB_CMD_PWRITEV
1432 && ret < 0 && ret != -EIOCBQUEUED && ret != -EIOCBRETRY
1433 && iocb->ki_nbytes - iocb->ki_left)
1434 ret = iocb->ki_nbytes - iocb->ki_left;
1435
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 return ret;
1437}
1438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439static ssize_t aio_fdsync(struct kiocb *iocb)
1440{
1441 struct file *file = iocb->ki_filp;
1442 ssize_t ret = -EINVAL;
1443
1444 if (file->f_op->aio_fsync)
1445 ret = file->f_op->aio_fsync(iocb, 1);
1446 return ret;
1447}
1448
1449static ssize_t aio_fsync(struct kiocb *iocb)
1450{
1451 struct file *file = iocb->ki_filp;
1452 ssize_t ret = -EINVAL;
1453
1454 if (file->f_op->aio_fsync)
1455 ret = file->f_op->aio_fsync(iocb, 0);
1456 return ret;
1457}
1458
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001459static ssize_t aio_setup_vectored_rw(int type, struct kiocb *kiocb, bool compat)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001460{
1461 ssize_t ret;
1462
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001463#ifdef CONFIG_COMPAT
1464 if (compat)
1465 ret = compat_rw_copy_check_uvector(type,
1466 (struct compat_iovec __user *)kiocb->ki_buf,
1467 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001468 &kiocb->ki_iovec, 1);
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001469 else
1470#endif
1471 ret = rw_copy_check_uvector(type,
1472 (struct iovec __user *)kiocb->ki_buf,
1473 kiocb->ki_nbytes, 1, &kiocb->ki_inline_vec,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001474 &kiocb->ki_iovec, 1);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001475 if (ret < 0)
1476 goto out;
1477
1478 kiocb->ki_nr_segs = kiocb->ki_nbytes;
1479 kiocb->ki_cur_seg = 0;
1480 /* ki_nbytes/left now reflect bytes instead of segs */
1481 kiocb->ki_nbytes = ret;
1482 kiocb->ki_left = ret;
1483
1484 ret = 0;
1485out:
1486 return ret;
1487}
1488
1489static ssize_t aio_setup_single_vector(struct kiocb *kiocb)
1490{
1491 kiocb->ki_iovec = &kiocb->ki_inline_vec;
1492 kiocb->ki_iovec->iov_base = kiocb->ki_buf;
1493 kiocb->ki_iovec->iov_len = kiocb->ki_left;
1494 kiocb->ki_nr_segs = 1;
1495 kiocb->ki_cur_seg = 0;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001496 return 0;
1497}
1498
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499/*
1500 * aio_setup_iocb:
1501 * Performs the initial checks and aio retry method
1502 * setup for the kiocb at the time of io submission.
1503 */
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001504static ssize_t aio_setup_iocb(struct kiocb *kiocb, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505{
1506 struct file *file = kiocb->ki_filp;
1507 ssize_t ret = 0;
1508
1509 switch (kiocb->ki_opcode) {
1510 case IOCB_CMD_PREAD:
1511 ret = -EBADF;
1512 if (unlikely(!(file->f_mode & FMODE_READ)))
1513 break;
1514 ret = -EFAULT;
1515 if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
1516 kiocb->ki_left)))
1517 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001518 ret = security_file_permission(file, MAY_READ);
1519 if (unlikely(ret))
1520 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001521 ret = aio_setup_single_vector(kiocb);
1522 if (ret)
1523 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 ret = -EINVAL;
1525 if (file->f_op->aio_read)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001526 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 break;
1528 case IOCB_CMD_PWRITE:
1529 ret = -EBADF;
1530 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1531 break;
1532 ret = -EFAULT;
1533 if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
1534 kiocb->ki_left)))
1535 break;
Kostik Belousov8766ce42005-10-23 12:57:13 -07001536 ret = security_file_permission(file, MAY_WRITE);
1537 if (unlikely(ret))
1538 break;
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001539 ret = aio_setup_single_vector(kiocb);
1540 if (ret)
1541 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 ret = -EINVAL;
1543 if (file->f_op->aio_write)
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001544 kiocb->ki_retry = aio_rw_vect_retry;
1545 break;
1546 case IOCB_CMD_PREADV:
1547 ret = -EBADF;
1548 if (unlikely(!(file->f_mode & FMODE_READ)))
1549 break;
1550 ret = security_file_permission(file, MAY_READ);
1551 if (unlikely(ret))
1552 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001553 ret = aio_setup_vectored_rw(READ, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001554 if (ret)
1555 break;
1556 ret = -EINVAL;
1557 if (file->f_op->aio_read)
1558 kiocb->ki_retry = aio_rw_vect_retry;
1559 break;
1560 case IOCB_CMD_PWRITEV:
1561 ret = -EBADF;
1562 if (unlikely(!(file->f_mode & FMODE_WRITE)))
1563 break;
1564 ret = security_file_permission(file, MAY_WRITE);
1565 if (unlikely(ret))
1566 break;
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001567 ret = aio_setup_vectored_rw(WRITE, kiocb, compat);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001568 if (ret)
1569 break;
1570 ret = -EINVAL;
1571 if (file->f_op->aio_write)
1572 kiocb->ki_retry = aio_rw_vect_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 break;
1574 case IOCB_CMD_FDSYNC:
1575 ret = -EINVAL;
1576 if (file->f_op->aio_fsync)
1577 kiocb->ki_retry = aio_fdsync;
1578 break;
1579 case IOCB_CMD_FSYNC:
1580 ret = -EINVAL;
1581 if (file->f_op->aio_fsync)
1582 kiocb->ki_retry = aio_fsync;
1583 break;
1584 default:
1585 dprintk("EINVAL: io_submit: no operation provided\n");
1586 ret = -EINVAL;
1587 }
1588
1589 if (!kiocb->ki_retry)
1590 return ret;
1591
1592 return 0;
1593}
1594
Adrian Bunkd5470b52008-04-29 00:58:57 -07001595static int io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
Jeff Moyer080d6762011-11-02 13:40:10 -07001596 struct iocb *iocb, struct kiocb_batch *batch,
1597 bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598{
1599 struct kiocb *req;
1600 struct file *file;
1601 ssize_t ret;
1602
1603 /* enforce forwards compatibility on users */
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001604 if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 pr_debug("EINVAL: io_submit: reserve field set\n");
1606 return -EINVAL;
1607 }
1608
1609 /* prevent overflows */
1610 if (unlikely(
1611 (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
1612 (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
1613 ((ssize_t)iocb->aio_nbytes < 0)
1614 )) {
1615 pr_debug("EINVAL: io_submit: overflow check\n");
1616 return -EINVAL;
1617 }
1618
1619 file = fget(iocb->aio_fildes);
1620 if (unlikely(!file))
1621 return -EBADF;
1622
Jeff Moyer080d6762011-11-02 13:40:10 -07001623 req = aio_get_req(ctx, batch); /* returns with 2 references to req */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 if (unlikely(!req)) {
1625 fput(file);
1626 return -EAGAIN;
1627 }
Yan Zheng87e28312007-10-08 12:16:20 -07001628 req->ki_filp = file;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001629 if (iocb->aio_flags & IOCB_FLAG_RESFD) {
1630 /*
1631 * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
1632 * instance of the file* now. The file descriptor must be
1633 * an eventfd() fd, and will be signaled for each completed
1634 * event using the eventfd_signal() function.
1635 */
Davide Libenzi13389012009-06-30 11:41:11 -07001636 req->ki_eventfd = eventfd_ctx_fdget((int) iocb->aio_resfd);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -07001637 if (IS_ERR(req->ki_eventfd)) {
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001638 ret = PTR_ERR(req->ki_eventfd);
Davide Libenzi87c3a862009-03-18 17:04:19 -07001639 req->ki_eventfd = NULL;
Davide Libenzi9c3060b2007-05-10 22:23:21 -07001640 goto out_put_req;
1641 }
1642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Ken Chen212079c2005-05-01 08:59:15 -07001644 ret = put_user(req->ki_key, &user_iocb->aio_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 if (unlikely(ret)) {
1646 dprintk("EFAULT: aio_key\n");
1647 goto out_put_req;
1648 }
1649
1650 req->ki_obj.user = user_iocb;
1651 req->ki_user_data = iocb->aio_data;
1652 req->ki_pos = iocb->aio_offset;
1653
1654 req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
1655 req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
1656 req->ki_opcode = iocb->aio_lio_opcode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001658 ret = aio_setup_iocb(req, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
1660 if (ret)
1661 goto out_put_req;
1662
1663 spin_lock_irq(&ctx->ctx_lock);
Jan Kara7137c6bd2011-02-25 14:44:27 -08001664 /*
1665 * We could have raced with io_destroy() and are currently holding a
1666 * reference to ctx which should be destroyed. We cannot submit IO
1667 * since ctx gets freed as soon as io_submit() puts its reference. The
1668 * check here is reliable: io_destroy() sets ctx->dead before waiting
1669 * for outstanding IO and the barrier between these two is realized by
1670 * unlock of mm->ioctx_lock and lock of ctx->ctx_lock. Analogously we
1671 * increment ctx->reqs_active before checking for ctx->dead and the
1672 * barrier is realized by unlock and lock of ctx->ctx_lock. Thus if we
1673 * don't see ctx->dead set here, io_destroy() waits for our IO to
1674 * finish.
1675 */
1676 if (ctx->dead) {
1677 spin_unlock_irq(&ctx->ctx_lock);
1678 ret = -EINVAL;
1679 goto out_put_req;
1680 }
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001681 aio_run_iocb(req);
Benjamin LaHaiseac0b1bc2005-09-09 13:02:09 -07001682 if (!list_empty(&ctx->run_list)) {
Ken Chen954d3e92005-05-01 08:59:16 -07001683 /* drain the run list */
1684 while (__aio_run_iocbs(ctx))
1685 ;
1686 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 spin_unlock_irq(&ctx->ctx_lock);
Jeff Moyercfb1e332009-10-02 18:57:36 -04001688
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 aio_put_req(req); /* drop extra ref to req */
1690 return 0;
1691
1692out_put_req:
1693 aio_put_req(req); /* drop extra ref to req */
1694 aio_put_req(req); /* drop i/o ref to req */
1695 return ret;
1696}
1697
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001698long do_io_submit(aio_context_t ctx_id, long nr,
1699 struct iocb __user *__user *iocbpp, bool compat)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700{
1701 struct kioctx *ctx;
1702 long ret = 0;
Jeff Moyer080d6762011-11-02 13:40:10 -07001703 int i = 0;
Shaohua Li9f5b9422010-07-01 07:55:01 +02001704 struct blk_plug plug;
Jeff Moyer080d6762011-11-02 13:40:10 -07001705 struct kiocb_batch batch;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706
1707 if (unlikely(nr < 0))
1708 return -EINVAL;
1709
Jeff Moyer75e1c702010-09-10 14:16:00 -07001710 if (unlikely(nr > LONG_MAX/sizeof(*iocbpp)))
1711 nr = LONG_MAX/sizeof(*iocbpp);
1712
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
1714 return -EFAULT;
1715
1716 ctx = lookup_ioctx(ctx_id);
1717 if (unlikely(!ctx)) {
1718 pr_debug("EINVAL: io_submit: invalid context id\n");
1719 return -EINVAL;
1720 }
1721
Jeff Moyer080d6762011-11-02 13:40:10 -07001722 kiocb_batch_init(&batch, nr);
1723
Shaohua Li9f5b9422010-07-01 07:55:01 +02001724 blk_start_plug(&plug);
1725
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 /*
1727 * AKPM: should this return a partial result if some of the IOs were
1728 * successfully submitted?
1729 */
1730 for (i=0; i<nr; i++) {
1731 struct iocb __user *user_iocb;
1732 struct iocb tmp;
1733
1734 if (unlikely(__get_user(user_iocb, iocbpp + i))) {
1735 ret = -EFAULT;
1736 break;
1737 }
1738
1739 if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
1740 ret = -EFAULT;
1741 break;
1742 }
1743
Jeff Moyer080d6762011-11-02 13:40:10 -07001744 ret = io_submit_one(ctx, user_iocb, &tmp, &batch, compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 if (ret)
1746 break;
1747 }
Shaohua Li9f5b9422010-07-01 07:55:01 +02001748 blk_finish_plug(&plug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749
Gleb Natapov69e47472012-01-08 17:07:28 +02001750 kiocb_batch_free(ctx, &batch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 put_ioctx(ctx);
1752 return i ? i : ret;
1753}
1754
Jeff Moyer9d85cba2010-05-26 14:44:26 -07001755/* sys_io_submit:
1756 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1757 * the number of iocbs queued. May return -EINVAL if the aio_context
1758 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1759 * *iocbpp[0] is not properly initialized, if the operation specified
1760 * is invalid for the file descriptor in the iocb. May fail with
1761 * -EFAULT if any of the data structures point to invalid data. May
1762 * fail with -EBADF if the file descriptor specified in the first
1763 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1764 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1765 * fail with -ENOSYS if not implemented.
1766 */
1767SYSCALL_DEFINE3(io_submit, aio_context_t, ctx_id, long, nr,
1768 struct iocb __user * __user *, iocbpp)
1769{
1770 return do_io_submit(ctx_id, nr, iocbpp, 0);
1771}
1772
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773/* lookup_kiocb
1774 * Finds a given iocb for cancellation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 */
Adrian Bunk25ee7e32005-04-25 08:18:14 -07001776static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
1777 u32 key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778{
1779 struct list_head *pos;
Zach Brownd00689a2005-11-13 16:07:34 -08001780
1781 assert_spin_locked(&ctx->ctx_lock);
1782
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 /* TODO: use a hash or array, this sucks. */
1784 list_for_each(pos, &ctx->active_reqs) {
1785 struct kiocb *kiocb = list_kiocb(pos);
1786 if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
1787 return kiocb;
1788 }
1789 return NULL;
1790}
1791
1792/* sys_io_cancel:
1793 * Attempts to cancel an iocb previously passed to io_submit. If
1794 * the operation is successfully cancelled, the resulting event is
1795 * copied into the memory pointed to by result without being placed
1796 * into the completion queue and 0 is returned. May fail with
1797 * -EFAULT if any of the data structures pointed to are invalid.
1798 * May fail with -EINVAL if aio_context specified by ctx_id is
1799 * invalid. May fail with -EAGAIN if the iocb specified was not
1800 * cancelled. Will fail with -ENOSYS if not implemented.
1801 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001802SYSCALL_DEFINE3(io_cancel, aio_context_t, ctx_id, struct iocb __user *, iocb,
1803 struct io_event __user *, result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804{
1805 int (*cancel)(struct kiocb *iocb, struct io_event *res);
1806 struct kioctx *ctx;
1807 struct kiocb *kiocb;
1808 u32 key;
1809 int ret;
1810
1811 ret = get_user(key, &iocb->aio_key);
1812 if (unlikely(ret))
1813 return -EFAULT;
1814
1815 ctx = lookup_ioctx(ctx_id);
1816 if (unlikely(!ctx))
1817 return -EINVAL;
1818
1819 spin_lock_irq(&ctx->ctx_lock);
1820 ret = -EAGAIN;
1821 kiocb = lookup_kiocb(ctx, iocb, key);
1822 if (kiocb && kiocb->ki_cancel) {
1823 cancel = kiocb->ki_cancel;
1824 kiocb->ki_users ++;
1825 kiocbSetCancelled(kiocb);
1826 } else
1827 cancel = NULL;
1828 spin_unlock_irq(&ctx->ctx_lock);
1829
1830 if (NULL != cancel) {
1831 struct io_event tmp;
1832 pr_debug("calling cancel\n");
1833 memset(&tmp, 0, sizeof(tmp));
1834 tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
1835 tmp.data = kiocb->ki_user_data;
1836 ret = cancel(kiocb, &tmp);
1837 if (!ret) {
1838 /* Cancellation succeeded -- copy the result
1839 * into the user's buffer.
1840 */
1841 if (copy_to_user(result, &tmp, sizeof(tmp)))
1842 ret = -EFAULT;
1843 }
1844 } else
Wendy Cheng8f582022005-09-09 13:02:08 -07001845 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846
1847 put_ioctx(ctx);
1848
1849 return ret;
1850}
1851
1852/* io_getevents:
1853 * Attempts to read at least min_nr events and up to nr events from
Satoru Takeuchi642b5122010-08-05 11:23:11 -07001854 * the completion queue for the aio_context specified by ctx_id. If
1855 * it succeeds, the number of read events is returned. May fail with
1856 * -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is
1857 * out of range, if timeout is out of range. May fail with -EFAULT
1858 * if any of the memory specified is invalid. May return 0 or
1859 * < min_nr if the timeout specified by timeout has elapsed
1860 * before sufficient events are available, where timeout == NULL
1861 * specifies an infinite timeout. Note that the timeout pointed to by
1862 * timeout is relative and will be updated if not NULL and the
1863 * operation blocks. Will fail with -ENOSYS if not implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 */
Heiko Carstens002c8972009-01-14 14:14:18 +01001865SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id,
1866 long, min_nr,
1867 long, nr,
1868 struct io_event __user *, events,
1869 struct timespec __user *, timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870{
1871 struct kioctx *ioctx = lookup_ioctx(ctx_id);
1872 long ret = -EINVAL;
1873
1874 if (likely(ioctx)) {
Namhyung Kim2e410252011-01-12 17:01:08 -08001875 if (likely(min_nr <= nr && min_nr >= 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 ret = read_events(ioctx, min_nr, nr, events, timeout);
1877 put_ioctx(ioctx);
1878 }
1879
Roland McGrath598af052008-04-10 15:38:45 -07001880 asmlinkage_protect(5, ret, ctx_id, min_nr, nr, events, timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 return ret;
1882}