2 * An async IO implementation for Linux
3 * Written by Benjamin LaHaise <bcrl@kvack.org>
5 * Implements an efficient asynchronous io interface.
7 * Copyright 2000, 2001, 2002 Red Hat, Inc. All Rights Reserved.
9 * See ../COPYING for licensing terms.
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>
18 #include <linux/uio.h>
22 #include <linux/sched.h>
24 #include <linux/file.h>
26 #include <linux/mman.h>
27 #include <linux/slab.h>
28 #include <linux/timer.h>
29 #include <linux/aio.h>
30 #include <linux/highmem.h>
31 #include <linux/workqueue.h>
32 #include <linux/security.h>
34 #include <asm/kmap_types.h>
35 #include <asm/uaccess.h>
36 #include <asm/mmu_context.h>
39 #define dprintk printk
41 #define dprintk(x...) do { ; } while (0)
44 /*------ sysctl variables----*/
45 static DEFINE_SPINLOCK(aio_nr_lock
);
46 unsigned long aio_nr
; /* current system wide number of aio requests */
47 unsigned long aio_max_nr
= 0x10000; /* system wide maximum number of aio requests */
48 /*----end sysctl variables---*/
50 static struct kmem_cache
*kiocb_cachep
;
51 static struct kmem_cache
*kioctx_cachep
;
53 static struct workqueue_struct
*aio_wq
;
55 /* Used for rare fput completion. */
56 static void aio_fput_routine(struct work_struct
*);
57 static DECLARE_WORK(fput_work
, aio_fput_routine
);
59 static DEFINE_SPINLOCK(fput_lock
);
60 static LIST_HEAD(fput_head
);
62 static void aio_kick_handler(struct work_struct
*);
63 static void aio_queue_work(struct kioctx
*);
66 * Creates the slab caches used by the aio routines, panic on
67 * failure as this is done early during the boot sequence.
69 static int __init
aio_setup(void)
71 kiocb_cachep
= kmem_cache_create("kiocb", sizeof(struct kiocb
),
72 0, SLAB_HWCACHE_ALIGN
|SLAB_PANIC
, NULL
, NULL
);
73 kioctx_cachep
= kmem_cache_create("kioctx", sizeof(struct kioctx
),
74 0, SLAB_HWCACHE_ALIGN
|SLAB_PANIC
, NULL
, NULL
);
76 aio_wq
= create_workqueue("aio");
78 pr_debug("aio_setup: sizeof(struct page) = %d\n", (int)sizeof(struct page
));
83 static void aio_free_ring(struct kioctx
*ctx
)
85 struct aio_ring_info
*info
= &ctx
->ring_info
;
88 for (i
=0; i
<info
->nr_pages
; i
++)
89 put_page(info
->ring_pages
[i
]);
91 if (info
->mmap_size
) {
92 down_write(&ctx
->mm
->mmap_sem
);
93 do_munmap(ctx
->mm
, info
->mmap_base
, info
->mmap_size
);
94 up_write(&ctx
->mm
->mmap_sem
);
97 if (info
->ring_pages
&& info
->ring_pages
!= info
->internal_pages
)
98 kfree(info
->ring_pages
);
99 info
->ring_pages
= NULL
;
103 static int aio_setup_ring(struct kioctx
*ctx
)
105 struct aio_ring
*ring
;
106 struct aio_ring_info
*info
= &ctx
->ring_info
;
107 unsigned nr_events
= ctx
->max_reqs
;
111 /* Compensate for the ring buffer's head/tail overlap entry */
112 nr_events
+= 2; /* 1 is required, 2 for good luck */
114 size
= sizeof(struct aio_ring
);
115 size
+= sizeof(struct io_event
) * nr_events
;
116 nr_pages
= (size
+ PAGE_SIZE
-1) >> PAGE_SHIFT
;
121 nr_events
= (PAGE_SIZE
* nr_pages
- sizeof(struct aio_ring
)) / sizeof(struct io_event
);
124 info
->ring_pages
= info
->internal_pages
;
125 if (nr_pages
> AIO_RING_PAGES
) {
126 info
->ring_pages
= kcalloc(nr_pages
, sizeof(struct page
*), GFP_KERNEL
);
127 if (!info
->ring_pages
)
131 info
->mmap_size
= nr_pages
* PAGE_SIZE
;
132 dprintk("attempting mmap of %lu bytes\n", info
->mmap_size
);
133 down_write(&ctx
->mm
->mmap_sem
);
134 info
->mmap_base
= do_mmap(NULL
, 0, info
->mmap_size
,
135 PROT_READ
|PROT_WRITE
, MAP_ANON
|MAP_PRIVATE
,
137 if (IS_ERR((void *)info
->mmap_base
)) {
138 up_write(&ctx
->mm
->mmap_sem
);
139 printk("mmap err: %ld\n", -info
->mmap_base
);
145 dprintk("mmap address: 0x%08lx\n", info
->mmap_base
);
146 info
->nr_pages
= get_user_pages(current
, ctx
->mm
,
147 info
->mmap_base
, nr_pages
,
148 1, 0, info
->ring_pages
, NULL
);
149 up_write(&ctx
->mm
->mmap_sem
);
151 if (unlikely(info
->nr_pages
!= nr_pages
)) {
156 ctx
->user_id
= info
->mmap_base
;
158 info
->nr
= nr_events
; /* trusted copy */
160 ring
= kmap_atomic(info
->ring_pages
[0], KM_USER0
);
161 ring
->nr
= nr_events
; /* user copy */
162 ring
->id
= ctx
->user_id
;
163 ring
->head
= ring
->tail
= 0;
164 ring
->magic
= AIO_RING_MAGIC
;
165 ring
->compat_features
= AIO_RING_COMPAT_FEATURES
;
166 ring
->incompat_features
= AIO_RING_INCOMPAT_FEATURES
;
167 ring
->header_length
= sizeof(struct aio_ring
);
168 kunmap_atomic(ring
, KM_USER0
);
174 /* aio_ring_event: returns a pointer to the event at the given index from
175 * kmap_atomic(, km). Release the pointer with put_aio_ring_event();
177 #define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
178 #define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
179 #define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
181 #define aio_ring_event(info, nr, km) ({ \
182 unsigned pos = (nr) + AIO_EVENTS_OFFSET; \
183 struct io_event *__event; \
184 __event = kmap_atomic( \
185 (info)->ring_pages[pos / AIO_EVENTS_PER_PAGE], km); \
186 __event += pos % AIO_EVENTS_PER_PAGE; \
190 #define put_aio_ring_event(event, km) do { \
191 struct io_event *__event = (event); \
193 kunmap_atomic((void *)((unsigned long)__event & PAGE_MASK), km); \
197 * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
199 static struct kioctx
*ioctx_alloc(unsigned nr_events
)
201 struct mm_struct
*mm
;
204 /* Prevent overflows */
205 if ((nr_events
> (0x10000000U
/ sizeof(struct io_event
))) ||
206 (nr_events
> (0x10000000U
/ sizeof(struct kiocb
)))) {
207 pr_debug("ENOMEM: nr_events too high\n");
208 return ERR_PTR(-EINVAL
);
211 if ((unsigned long)nr_events
> aio_max_nr
)
212 return ERR_PTR(-EAGAIN
);
214 ctx
= kmem_cache_alloc(kioctx_cachep
, GFP_KERNEL
);
216 return ERR_PTR(-ENOMEM
);
218 memset(ctx
, 0, sizeof(*ctx
));
219 ctx
->max_reqs
= nr_events
;
220 mm
= ctx
->mm
= current
->mm
;
221 atomic_inc(&mm
->mm_count
);
223 atomic_set(&ctx
->users
, 1);
224 spin_lock_init(&ctx
->ctx_lock
);
225 spin_lock_init(&ctx
->ring_info
.ring_lock
);
226 init_waitqueue_head(&ctx
->wait
);
228 INIT_LIST_HEAD(&ctx
->active_reqs
);
229 INIT_LIST_HEAD(&ctx
->run_list
);
230 INIT_DELAYED_WORK(&ctx
->wq
, aio_kick_handler
);
232 if (aio_setup_ring(ctx
) < 0)
235 /* limit the number of system wide aios */
236 spin_lock(&aio_nr_lock
);
237 if (aio_nr
+ ctx
->max_reqs
> aio_max_nr
||
238 aio_nr
+ ctx
->max_reqs
< aio_nr
)
241 aio_nr
+= ctx
->max_reqs
;
242 spin_unlock(&aio_nr_lock
);
243 if (ctx
->max_reqs
== 0)
246 /* now link into global list. kludge. FIXME */
247 write_lock(&mm
->ioctx_list_lock
);
248 ctx
->next
= mm
->ioctx_list
;
249 mm
->ioctx_list
= ctx
;
250 write_unlock(&mm
->ioctx_list_lock
);
252 dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
253 ctx
, ctx
->user_id
, current
->mm
, ctx
->ring_info
.nr
);
258 return ERR_PTR(-EAGAIN
);
262 kmem_cache_free(kioctx_cachep
, ctx
);
263 ctx
= ERR_PTR(-ENOMEM
);
265 dprintk("aio: error allocating ioctx %p\n", ctx
);
270 * Cancels all outstanding aio requests on an aio context. Used
271 * when the processes owning a context have all exited to encourage
272 * the rapid destruction of the kioctx.
274 static void aio_cancel_all(struct kioctx
*ctx
)
276 int (*cancel
)(struct kiocb
*, struct io_event
*);
278 spin_lock_irq(&ctx
->ctx_lock
);
280 while (!list_empty(&ctx
->active_reqs
)) {
281 struct list_head
*pos
= ctx
->active_reqs
.next
;
282 struct kiocb
*iocb
= list_kiocb(pos
);
283 list_del_init(&iocb
->ki_list
);
284 cancel
= iocb
->ki_cancel
;
285 kiocbSetCancelled(iocb
);
288 spin_unlock_irq(&ctx
->ctx_lock
);
290 spin_lock_irq(&ctx
->ctx_lock
);
293 spin_unlock_irq(&ctx
->ctx_lock
);
296 static void wait_for_all_aios(struct kioctx
*ctx
)
298 struct task_struct
*tsk
= current
;
299 DECLARE_WAITQUEUE(wait
, tsk
);
301 if (!ctx
->reqs_active
)
304 add_wait_queue(&ctx
->wait
, &wait
);
305 set_task_state(tsk
, TASK_UNINTERRUPTIBLE
);
306 while (ctx
->reqs_active
) {
308 set_task_state(tsk
, TASK_UNINTERRUPTIBLE
);
310 __set_task_state(tsk
, TASK_RUNNING
);
311 remove_wait_queue(&ctx
->wait
, &wait
);
314 /* wait_on_sync_kiocb:
315 * Waits on the given sync kiocb to complete.
317 ssize_t fastcall
wait_on_sync_kiocb(struct kiocb
*iocb
)
319 while (iocb
->ki_users
) {
320 set_current_state(TASK_UNINTERRUPTIBLE
);
325 __set_current_state(TASK_RUNNING
);
326 return iocb
->ki_user_data
;
329 /* exit_aio: called when the last user of mm goes away. At this point,
330 * there is no way for any new requests to be submited or any of the
331 * io_* syscalls to be called on the context. However, there may be
332 * outstanding requests which hold references to the context; as they
333 * go away, they will call put_ioctx and release any pinned memory
334 * associated with the request (held via struct page * references).
336 void fastcall
exit_aio(struct mm_struct
*mm
)
338 struct kioctx
*ctx
= mm
->ioctx_list
;
339 mm
->ioctx_list
= NULL
;
341 struct kioctx
*next
= ctx
->next
;
345 wait_for_all_aios(ctx
);
347 * this is an overkill, but ensures we don't leave
348 * the ctx on the aio_wq
350 flush_workqueue(aio_wq
);
352 if (1 != atomic_read(&ctx
->users
))
354 "exit_aio:ioctx still alive: %d %d %d\n",
355 atomic_read(&ctx
->users
), ctx
->dead
,
363 * Called when the last user of an aio context has gone away,
364 * and the struct needs to be freed.
366 void fastcall
__put_ioctx(struct kioctx
*ctx
)
368 unsigned nr_events
= ctx
->max_reqs
;
370 BUG_ON(ctx
->reqs_active
);
372 cancel_delayed_work(&ctx
->wq
);
373 flush_workqueue(aio_wq
);
377 pr_debug("__put_ioctx: freeing %p\n", ctx
);
378 kmem_cache_free(kioctx_cachep
, ctx
);
381 spin_lock(&aio_nr_lock
);
382 BUG_ON(aio_nr
- nr_events
> aio_nr
);
384 spin_unlock(&aio_nr_lock
);
389 * Allocate a slot for an aio request. Increments the users count
390 * of the kioctx so that the kioctx stays around until all requests are
391 * complete. Returns NULL if no requests are free.
393 * Returns with kiocb->users set to 2. The io submit code path holds
394 * an extra reference while submitting the i/o.
395 * This prevents races between the aio code path referencing the
396 * req (after submitting it) and aio_complete() freeing the req.
398 static struct kiocb
*FASTCALL(__aio_get_req(struct kioctx
*ctx
));
399 static struct kiocb fastcall
*__aio_get_req(struct kioctx
*ctx
)
401 struct kiocb
*req
= NULL
;
402 struct aio_ring
*ring
;
405 req
= kmem_cache_alloc(kiocb_cachep
, GFP_KERNEL
);
413 req
->ki_cancel
= NULL
;
414 req
->ki_retry
= NULL
;
417 req
->ki_iovec
= NULL
;
418 INIT_LIST_HEAD(&req
->ki_run_list
);
420 /* Check if the completion queue has enough free space to
421 * accept an event from this io.
423 spin_lock_irq(&ctx
->ctx_lock
);
424 ring
= kmap_atomic(ctx
->ring_info
.ring_pages
[0], KM_USER0
);
425 if (ctx
->reqs_active
< aio_ring_avail(&ctx
->ring_info
, ring
)) {
426 list_add(&req
->ki_list
, &ctx
->active_reqs
);
431 kunmap_atomic(ring
, KM_USER0
);
432 spin_unlock_irq(&ctx
->ctx_lock
);
435 kmem_cache_free(kiocb_cachep
, req
);
442 static inline struct kiocb
*aio_get_req(struct kioctx
*ctx
)
445 /* Handle a potential starvation case -- should be exceedingly rare as
446 * requests will be stuck on fput_head only if the aio_fput_routine is
447 * delayed and the requests were the last user of the struct file.
449 req
= __aio_get_req(ctx
);
450 if (unlikely(NULL
== req
)) {
451 aio_fput_routine(NULL
);
452 req
= __aio_get_req(ctx
);
457 static inline void really_put_req(struct kioctx
*ctx
, struct kiocb
*req
)
459 assert_spin_locked(&ctx
->ctx_lock
);
463 if (req
->ki_iovec
!= &req
->ki_inline_vec
)
464 kfree(req
->ki_iovec
);
465 kmem_cache_free(kiocb_cachep
, req
);
468 if (unlikely(!ctx
->reqs_active
&& ctx
->dead
))
472 static void aio_fput_routine(struct work_struct
*data
)
474 spin_lock_irq(&fput_lock
);
475 while (likely(!list_empty(&fput_head
))) {
476 struct kiocb
*req
= list_kiocb(fput_head
.next
);
477 struct kioctx
*ctx
= req
->ki_ctx
;
479 list_del(&req
->ki_list
);
480 spin_unlock_irq(&fput_lock
);
482 /* Complete the fput */
483 __fput(req
->ki_filp
);
485 /* Link the iocb into the context's free list */
486 spin_lock_irq(&ctx
->ctx_lock
);
487 really_put_req(ctx
, req
);
488 spin_unlock_irq(&ctx
->ctx_lock
);
491 spin_lock_irq(&fput_lock
);
493 spin_unlock_irq(&fput_lock
);
497 * Returns true if this put was the last user of the request.
499 static int __aio_put_req(struct kioctx
*ctx
, struct kiocb
*req
)
501 dprintk(KERN_DEBUG
"aio_put(%p): f_count=%d\n",
502 req
, atomic_read(&req
->ki_filp
->f_count
));
504 assert_spin_locked(&ctx
->ctx_lock
);
507 BUG_ON(req
->ki_users
< 0);
508 if (likely(req
->ki_users
))
510 list_del(&req
->ki_list
); /* remove from active_reqs */
511 req
->ki_cancel
= NULL
;
512 req
->ki_retry
= NULL
;
514 /* Must be done under the lock to serialise against cancellation.
515 * Call this aio_fput as it duplicates fput via the fput_work.
517 if (unlikely(atomic_dec_and_test(&req
->ki_filp
->f_count
))) {
519 spin_lock(&fput_lock
);
520 list_add(&req
->ki_list
, &fput_head
);
521 spin_unlock(&fput_lock
);
522 queue_work(aio_wq
, &fput_work
);
524 really_put_req(ctx
, req
);
529 * Returns true if this put was the last user of the kiocb,
530 * false if the request is still in use.
532 int fastcall
aio_put_req(struct kiocb
*req
)
534 struct kioctx
*ctx
= req
->ki_ctx
;
536 spin_lock_irq(&ctx
->ctx_lock
);
537 ret
= __aio_put_req(ctx
, req
);
538 spin_unlock_irq(&ctx
->ctx_lock
);
544 /* Lookup an ioctx id. ioctx_list is lockless for reads.
545 * FIXME: this is O(n) and is only suitable for development.
547 struct kioctx
*lookup_ioctx(unsigned long ctx_id
)
549 struct kioctx
*ioctx
;
550 struct mm_struct
*mm
;
553 read_lock(&mm
->ioctx_list_lock
);
554 for (ioctx
= mm
->ioctx_list
; ioctx
; ioctx
= ioctx
->next
)
555 if (likely(ioctx
->user_id
== ctx_id
&& !ioctx
->dead
)) {
559 read_unlock(&mm
->ioctx_list_lock
);
566 * Makes the calling kernel thread take on the specified
568 * Called by the retry thread execute retries within the
569 * iocb issuer's mm context, so that copy_from/to_user
570 * operations work seamlessly for aio.
571 * (Note: this routine is intended to be called only
572 * from a kernel thread context)
574 static void use_mm(struct mm_struct
*mm
)
576 struct mm_struct
*active_mm
;
577 struct task_struct
*tsk
= current
;
580 tsk
->flags
|= PF_BORROWED_MM
;
581 active_mm
= tsk
->active_mm
;
582 atomic_inc(&mm
->mm_count
);
586 * Note that on UML this *requires* PF_BORROWED_MM to be set, otherwise
587 * it won't work. Update it accordingly if you change it here
589 activate_mm(active_mm
, mm
);
597 * Reverses the effect of use_mm, i.e. releases the
598 * specified mm context which was earlier taken on
599 * by the calling kernel thread
600 * (Note: this routine is intended to be called only
601 * from a kernel thread context)
603 * Comments: Called with ctx->ctx_lock held. This nests
604 * task_lock instead ctx_lock.
606 static void unuse_mm(struct mm_struct
*mm
)
608 struct task_struct
*tsk
= current
;
611 tsk
->flags
&= ~PF_BORROWED_MM
;
613 /* active_mm is still 'mm' */
614 enter_lazy_tlb(mm
, tsk
);
619 * Queue up a kiocb to be retried. Assumes that the kiocb
620 * has already been marked as kicked, and places it on
621 * the retry run list for the corresponding ioctx, if it
622 * isn't already queued. Returns 1 if it actually queued
623 * the kiocb (to tell the caller to activate the work
624 * queue to process it), or 0, if it found that it was
627 static inline int __queue_kicked_iocb(struct kiocb
*iocb
)
629 struct kioctx
*ctx
= iocb
->ki_ctx
;
631 assert_spin_locked(&ctx
->ctx_lock
);
633 if (list_empty(&iocb
->ki_run_list
)) {
634 list_add_tail(&iocb
->ki_run_list
,
642 * This is the core aio execution routine. It is
643 * invoked both for initial i/o submission and
644 * subsequent retries via the aio_kick_handler.
645 * Expects to be invoked with iocb->ki_ctx->lock
646 * already held. The lock is released and reacquired
647 * as needed during processing.
649 * Calls the iocb retry method (already setup for the
650 * iocb on initial submission) for operation specific
651 * handling, but takes care of most of common retry
652 * execution details for a given iocb. The retry method
653 * needs to be non-blocking as far as possible, to avoid
654 * holding up other iocbs waiting to be serviced by the
655 * retry kernel thread.
657 * The trickier parts in this code have to do with
658 * ensuring that only one retry instance is in progress
659 * for a given iocb at any time. Providing that guarantee
660 * simplifies the coding of individual aio operations as
661 * it avoids various potential races.
663 static ssize_t
aio_run_iocb(struct kiocb
*iocb
)
665 struct kioctx
*ctx
= iocb
->ki_ctx
;
666 ssize_t (*retry
)(struct kiocb
*);
669 if (iocb
->ki_retried
++ > 1024*1024) {
670 printk("Maximal retry count. Bytes done %Zd\n",
671 iocb
->ki_nbytes
- iocb
->ki_left
);
675 if (!(iocb
->ki_retried
& 0xff)) {
676 pr_debug("%ld retry: %zd of %zd\n", iocb
->ki_retried
,
677 iocb
->ki_nbytes
- iocb
->ki_left
, iocb
->ki_nbytes
);
680 if (!(retry
= iocb
->ki_retry
)) {
681 printk("aio_run_iocb: iocb->ki_retry = NULL\n");
686 * We don't want the next retry iteration for this
687 * operation to start until this one has returned and
688 * updated the iocb state. However, wait_queue functions
689 * can trigger a kick_iocb from interrupt context in the
690 * meantime, indicating that data is available for the next
691 * iteration. We want to remember that and enable the
692 * next retry iteration _after_ we are through with
695 * So, in order to be able to register a "kick", but
696 * prevent it from being queued now, we clear the kick
697 * flag, but make the kick code *think* that the iocb is
698 * still on the run list until we are actually done.
699 * When we are done with this iteration, we check if
700 * the iocb was kicked in the meantime and if so, queue
704 kiocbClearKicked(iocb
);
707 * This is so that aio_complete knows it doesn't need to
708 * pull the iocb off the run list (We can't just call
709 * INIT_LIST_HEAD because we don't want a kick_iocb to
710 * queue this on the run list yet)
712 iocb
->ki_run_list
.next
= iocb
->ki_run_list
.prev
= NULL
;
713 spin_unlock_irq(&ctx
->ctx_lock
);
715 /* Quit retrying if the i/o has been cancelled */
716 if (kiocbIsCancelled(iocb
)) {
718 aio_complete(iocb
, ret
, 0);
719 /* must not access the iocb after this */
724 * Now we are all set to call the retry method in async
725 * context. By setting this thread's io_wait context
726 * to point to the wait queue entry inside the currently
727 * running iocb for the duration of the retry, we ensure
728 * that async notification wakeups are queued by the
729 * operation instead of blocking waits, and when notified,
730 * cause the iocb to be kicked for continuation (through
731 * the aio_wake_function callback).
733 BUG_ON(current
->io_wait
!= NULL
);
734 current
->io_wait
= &iocb
->ki_wait
;
736 current
->io_wait
= NULL
;
738 if (ret
!= -EIOCBRETRY
&& ret
!= -EIOCBQUEUED
) {
739 BUG_ON(!list_empty(&iocb
->ki_wait
.task_list
));
740 aio_complete(iocb
, ret
, 0);
743 spin_lock_irq(&ctx
->ctx_lock
);
745 if (-EIOCBRETRY
== ret
) {
747 * OK, now that we are done with this iteration
748 * and know that there is more left to go,
749 * this is where we let go so that a subsequent
750 * "kick" can start the next iteration
753 /* will make __queue_kicked_iocb succeed from here on */
754 INIT_LIST_HEAD(&iocb
->ki_run_list
);
755 /* we must queue the next iteration ourselves, if it
756 * has already been kicked */
757 if (kiocbIsKicked(iocb
)) {
758 __queue_kicked_iocb(iocb
);
761 * __queue_kicked_iocb will always return 1 here, because
762 * iocb->ki_run_list is empty at this point so it should
763 * be safe to unconditionally queue the context into the
774 * Process all pending retries queued on the ioctx
776 * Assumes it is operating within the aio issuer's mm
779 static int __aio_run_iocbs(struct kioctx
*ctx
)
782 struct list_head run_list
;
784 assert_spin_locked(&ctx
->ctx_lock
);
786 list_replace_init(&ctx
->run_list
, &run_list
);
787 while (!list_empty(&run_list
)) {
788 iocb
= list_entry(run_list
.next
, struct kiocb
,
790 list_del(&iocb
->ki_run_list
);
792 * Hold an extra reference while retrying i/o.
794 iocb
->ki_users
++; /* grab extra reference */
796 if (__aio_put_req(ctx
, iocb
)) /* drop extra ref */
799 if (!list_empty(&ctx
->run_list
))
804 static void aio_queue_work(struct kioctx
* ctx
)
806 unsigned long timeout
;
808 * if someone is waiting, get the work started right
809 * away, otherwise, use a longer delay
812 if (waitqueue_active(&ctx
->wait
))
816 queue_delayed_work(aio_wq
, &ctx
->wq
, timeout
);
822 * Process all pending retries queued on the ioctx
824 * Assumes it is operating within the aio issuer's mm
827 static inline void aio_run_iocbs(struct kioctx
*ctx
)
831 spin_lock_irq(&ctx
->ctx_lock
);
833 requeue
= __aio_run_iocbs(ctx
);
834 spin_unlock_irq(&ctx
->ctx_lock
);
840 * just like aio_run_iocbs, but keeps running them until
841 * the list stays empty
843 static inline void aio_run_all_iocbs(struct kioctx
*ctx
)
845 spin_lock_irq(&ctx
->ctx_lock
);
846 while (__aio_run_iocbs(ctx
))
848 spin_unlock_irq(&ctx
->ctx_lock
);
853 * Work queue handler triggered to process pending
854 * retries on an ioctx. Takes on the aio issuer's
855 * mm context before running the iocbs, so that
856 * copy_xxx_user operates on the issuer's address
858 * Run on aiod's context.
860 static void aio_kick_handler(struct work_struct
*work
)
862 struct kioctx
*ctx
= container_of(work
, struct kioctx
, wq
.work
);
863 mm_segment_t oldfs
= get_fs();
868 spin_lock_irq(&ctx
->ctx_lock
);
869 requeue
=__aio_run_iocbs(ctx
);
871 spin_unlock_irq(&ctx
->ctx_lock
);
874 * we're in a worker thread already, don't use queue_delayed_work,
877 queue_delayed_work(aio_wq
, &ctx
->wq
, 0);
882 * Called by kick_iocb to queue the kiocb for retry
883 * and if required activate the aio work queue to process
886 static void try_queue_kicked_iocb(struct kiocb
*iocb
)
888 struct kioctx
*ctx
= iocb
->ki_ctx
;
892 /* We're supposed to be the only path putting the iocb back on the run
893 * list. If we find that the iocb is *back* on a wait queue already
894 * than retry has happened before we could queue the iocb. This also
895 * means that the retry could have completed and freed our iocb, no
897 BUG_ON((!list_empty(&iocb
->ki_wait
.task_list
)));
899 spin_lock_irqsave(&ctx
->ctx_lock
, flags
);
900 /* set this inside the lock so that we can't race with aio_run_iocb()
901 * testing it and putting the iocb on the run list under the lock */
902 if (!kiocbTryKick(iocb
))
903 run
= __queue_kicked_iocb(iocb
);
904 spin_unlock_irqrestore(&ctx
->ctx_lock
, flags
);
911 * Called typically from a wait queue callback context
912 * (aio_wake_function) to trigger a retry of the iocb.
913 * The retry is usually executed by aio workqueue
914 * threads (See aio_kick_handler).
916 void fastcall
kick_iocb(struct kiocb
*iocb
)
918 /* sync iocbs are easy: they can only ever be executing from a
920 if (is_sync_kiocb(iocb
)) {
921 kiocbSetKicked(iocb
);
922 wake_up_process(iocb
->ki_obj
.tsk
);
926 try_queue_kicked_iocb(iocb
);
928 EXPORT_SYMBOL(kick_iocb
);
931 * Called when the io request on the given iocb is complete.
932 * Returns true if this is the last user of the request. The
933 * only other user of the request can be the cancellation code.
935 int fastcall
aio_complete(struct kiocb
*iocb
, long res
, long res2
)
937 struct kioctx
*ctx
= iocb
->ki_ctx
;
938 struct aio_ring_info
*info
;
939 struct aio_ring
*ring
;
940 struct io_event
*event
;
946 * Special case handling for sync iocbs:
947 * - events go directly into the iocb for fast handling
948 * - the sync task with the iocb in its stack holds the single iocb
949 * ref, no other paths have a way to get another ref
950 * - the sync task helpfully left a reference to itself in the iocb
952 if (is_sync_kiocb(iocb
)) {
953 BUG_ON(iocb
->ki_users
!= 1);
954 iocb
->ki_user_data
= res
;
956 wake_up_process(iocb
->ki_obj
.tsk
);
960 info
= &ctx
->ring_info
;
962 /* add a completion event to the ring buffer.
963 * must be done holding ctx->ctx_lock to prevent
964 * other code from messing with the tail
965 * pointer since we might be called from irq
968 spin_lock_irqsave(&ctx
->ctx_lock
, flags
);
970 if (iocb
->ki_run_list
.prev
&& !list_empty(&iocb
->ki_run_list
))
971 list_del_init(&iocb
->ki_run_list
);
974 * cancelled requests don't get events, userland was given one
975 * when the event got cancelled.
977 if (kiocbIsCancelled(iocb
))
980 ring
= kmap_atomic(info
->ring_pages
[0], KM_IRQ1
);
983 event
= aio_ring_event(info
, tail
, KM_IRQ0
);
984 if (++tail
>= info
->nr
)
987 event
->obj
= (u64
)(unsigned long)iocb
->ki_obj
.user
;
988 event
->data
= iocb
->ki_user_data
;
992 dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
993 ctx
, tail
, iocb
, iocb
->ki_obj
.user
, iocb
->ki_user_data
,
996 /* after flagging the request as done, we
997 * must never even look at it again
999 smp_wmb(); /* make event visible before updating tail */
1004 put_aio_ring_event(event
, KM_IRQ0
);
1005 kunmap_atomic(ring
, KM_IRQ1
);
1007 pr_debug("added to ring %p at [%lu]\n", iocb
, tail
);
1009 pr_debug("%ld retries: %zd of %zd\n", iocb
->ki_retried
,
1010 iocb
->ki_nbytes
- iocb
->ki_left
, iocb
->ki_nbytes
);
1012 /* everything turned out well, dispose of the aiocb. */
1013 ret
= __aio_put_req(ctx
, iocb
);
1015 spin_unlock_irqrestore(&ctx
->ctx_lock
, flags
);
1017 if (waitqueue_active(&ctx
->wait
))
1018 wake_up(&ctx
->wait
);
1027 * Pull an event off of the ioctx's event ring. Returns the number of
1028 * events fetched (0 or 1 ;-)
1029 * FIXME: make this use cmpxchg.
1030 * TODO: make the ringbuffer user mmap()able (requires FIXME).
1032 static int aio_read_evt(struct kioctx
*ioctx
, struct io_event
*ent
)
1034 struct aio_ring_info
*info
= &ioctx
->ring_info
;
1035 struct aio_ring
*ring
;
1039 ring
= kmap_atomic(info
->ring_pages
[0], KM_USER0
);
1040 dprintk("in aio_read_evt h%lu t%lu m%lu\n",
1041 (unsigned long)ring
->head
, (unsigned long)ring
->tail
,
1042 (unsigned long)ring
->nr
);
1044 if (ring
->head
== ring
->tail
)
1047 spin_lock(&info
->ring_lock
);
1049 head
= ring
->head
% info
->nr
;
1050 if (head
!= ring
->tail
) {
1051 struct io_event
*evp
= aio_ring_event(info
, head
, KM_USER1
);
1053 head
= (head
+ 1) % info
->nr
;
1054 smp_mb(); /* finish reading the event before updatng the head */
1057 put_aio_ring_event(evp
, KM_USER1
);
1059 spin_unlock(&info
->ring_lock
);
1062 kunmap_atomic(ring
, KM_USER0
);
1063 dprintk("leaving aio_read_evt: %d h%lu t%lu\n", ret
,
1064 (unsigned long)ring
->head
, (unsigned long)ring
->tail
);
1068 struct aio_timeout
{
1069 struct timer_list timer
;
1071 struct task_struct
*p
;
1074 static void timeout_func(unsigned long data
)
1076 struct aio_timeout
*to
= (struct aio_timeout
*)data
;
1079 wake_up_process(to
->p
);
1082 static inline void init_timeout(struct aio_timeout
*to
)
1084 init_timer(&to
->timer
);
1085 to
->timer
.data
= (unsigned long)to
;
1086 to
->timer
.function
= timeout_func
;
1091 static inline void set_timeout(long start_jiffies
, struct aio_timeout
*to
,
1092 const struct timespec
*ts
)
1094 to
->timer
.expires
= start_jiffies
+ timespec_to_jiffies(ts
);
1095 if (time_after(to
->timer
.expires
, jiffies
))
1096 add_timer(&to
->timer
);
1101 static inline void clear_timeout(struct aio_timeout
*to
)
1103 del_singleshot_timer_sync(&to
->timer
);
1106 static int read_events(struct kioctx
*ctx
,
1107 long min_nr
, long nr
,
1108 struct io_event __user
*event
,
1109 struct timespec __user
*timeout
)
1111 long start_jiffies
= jiffies
;
1112 struct task_struct
*tsk
= current
;
1113 DECLARE_WAITQUEUE(wait
, tsk
);
1116 struct io_event ent
;
1117 struct aio_timeout to
;
1120 /* needed to zero any padding within an entry (there shouldn't be
1121 * any, but C is fun!
1123 memset(&ent
, 0, sizeof(ent
));
1126 while (likely(i
< nr
)) {
1127 ret
= aio_read_evt(ctx
, &ent
);
1128 if (unlikely(ret
<= 0))
1131 dprintk("read event: %Lx %Lx %Lx %Lx\n",
1132 ent
.data
, ent
.obj
, ent
.res
, ent
.res2
);
1134 /* Could we split the check in two? */
1136 if (unlikely(copy_to_user(event
, &ent
, sizeof(ent
)))) {
1137 dprintk("aio: lost an event due to EFAULT.\n");
1142 /* Good, event copied to userland, update counts. */
1154 /* racey check, but it gets redone */
1155 if (!retry
&& unlikely(!list_empty(&ctx
->run_list
))) {
1157 aio_run_all_iocbs(ctx
);
1165 if (unlikely(copy_from_user(&ts
, timeout
, sizeof(ts
))))
1168 set_timeout(start_jiffies
, &to
, &ts
);
1171 while (likely(i
< nr
)) {
1172 add_wait_queue_exclusive(&ctx
->wait
, &wait
);
1174 set_task_state(tsk
, TASK_INTERRUPTIBLE
);
1175 ret
= aio_read_evt(ctx
, &ent
);
1181 if (to
.timed_out
) /* Only check after read evt */
1184 if (signal_pending(tsk
)) {
1188 /*ret = aio_read_evt(ctx, &ent);*/
1191 set_task_state(tsk
, TASK_RUNNING
);
1192 remove_wait_queue(&ctx
->wait
, &wait
);
1194 if (unlikely(ret
<= 0))
1198 if (unlikely(copy_to_user(event
, &ent
, sizeof(ent
)))) {
1199 dprintk("aio: lost an event due to EFAULT.\n");
1203 /* Good, event copied to userland, update counts. */
1214 /* Take an ioctx and remove it from the list of ioctx's. Protects
1215 * against races with itself via ->dead.
1217 static void io_destroy(struct kioctx
*ioctx
)
1219 struct mm_struct
*mm
= current
->mm
;
1220 struct kioctx
**tmp
;
1223 /* delete the entry from the list is someone else hasn't already */
1224 write_lock(&mm
->ioctx_list_lock
);
1225 was_dead
= ioctx
->dead
;
1227 for (tmp
= &mm
->ioctx_list
; *tmp
&& *tmp
!= ioctx
;
1228 tmp
= &(*tmp
)->next
)
1232 write_unlock(&mm
->ioctx_list_lock
);
1234 dprintk("aio_release(%p)\n", ioctx
);
1235 if (likely(!was_dead
))
1236 put_ioctx(ioctx
); /* twice for the list */
1238 aio_cancel_all(ioctx
);
1239 wait_for_all_aios(ioctx
);
1240 put_ioctx(ioctx
); /* once for the lookup */
1244 * Create an aio_context capable of receiving at least nr_events.
1245 * ctxp must not point to an aio_context that already exists, and
1246 * must be initialized to 0 prior to the call. On successful
1247 * creation of the aio_context, *ctxp is filled in with the resulting
1248 * handle. May fail with -EINVAL if *ctxp is not initialized,
1249 * if the specified nr_events exceeds internal limits. May fail
1250 * with -EAGAIN if the specified nr_events exceeds the user's limit
1251 * of available events. May fail with -ENOMEM if insufficient kernel
1252 * resources are available. May fail with -EFAULT if an invalid
1253 * pointer is passed for ctxp. Will fail with -ENOSYS if not
1256 asmlinkage
long sys_io_setup(unsigned nr_events
, aio_context_t __user
*ctxp
)
1258 struct kioctx
*ioctx
= NULL
;
1262 ret
= get_user(ctx
, ctxp
);
1267 if (unlikely(ctx
|| nr_events
== 0)) {
1268 pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
1273 ioctx
= ioctx_alloc(nr_events
);
1274 ret
= PTR_ERR(ioctx
);
1275 if (!IS_ERR(ioctx
)) {
1276 ret
= put_user(ioctx
->user_id
, ctxp
);
1280 get_ioctx(ioctx
); /* io_destroy() expects us to hold a ref */
1289 * Destroy the aio_context specified. May cancel any outstanding
1290 * AIOs and block on completion. Will fail with -ENOSYS if not
1291 * implemented. May fail with -EFAULT if the context pointed to
1294 asmlinkage
long sys_io_destroy(aio_context_t ctx
)
1296 struct kioctx
*ioctx
= lookup_ioctx(ctx
);
1297 if (likely(NULL
!= ioctx
)) {
1301 pr_debug("EINVAL: io_destroy: invalid context id\n");
1305 static void aio_advance_iovec(struct kiocb
*iocb
, ssize_t ret
)
1307 struct iovec
*iov
= &iocb
->ki_iovec
[iocb
->ki_cur_seg
];
1311 while (iocb
->ki_cur_seg
< iocb
->ki_nr_segs
&& ret
> 0) {
1312 ssize_t
this = min((ssize_t
)iov
->iov_len
, ret
);
1313 iov
->iov_base
+= this;
1314 iov
->iov_len
-= this;
1315 iocb
->ki_left
-= this;
1317 if (iov
->iov_len
== 0) {
1323 /* the caller should not have done more io than what fit in
1324 * the remaining iovecs */
1325 BUG_ON(ret
> 0 && iocb
->ki_left
== 0);
1328 static ssize_t
aio_rw_vect_retry(struct kiocb
*iocb
)
1330 struct file
*file
= iocb
->ki_filp
;
1331 struct address_space
*mapping
= file
->f_mapping
;
1332 struct inode
*inode
= mapping
->host
;
1333 ssize_t (*rw_op
)(struct kiocb
*, const struct iovec
*,
1334 unsigned long, loff_t
);
1336 unsigned short opcode
;
1338 if ((iocb
->ki_opcode
== IOCB_CMD_PREADV
) ||
1339 (iocb
->ki_opcode
== IOCB_CMD_PREAD
)) {
1340 rw_op
= file
->f_op
->aio_read
;
1341 opcode
= IOCB_CMD_PREADV
;
1343 rw_op
= file
->f_op
->aio_write
;
1344 opcode
= IOCB_CMD_PWRITEV
;
1348 ret
= rw_op(iocb
, &iocb
->ki_iovec
[iocb
->ki_cur_seg
],
1349 iocb
->ki_nr_segs
- iocb
->ki_cur_seg
,
1352 aio_advance_iovec(iocb
, ret
);
1354 /* retry all partial writes. retry partial reads as long as its a
1356 } while (ret
> 0 && iocb
->ki_left
> 0 &&
1357 (opcode
== IOCB_CMD_PWRITEV
||
1358 (!S_ISFIFO(inode
->i_mode
) && !S_ISSOCK(inode
->i_mode
))));
1360 /* This means we must have transferred all that we could */
1361 /* No need to retry anymore */
1362 if ((ret
== 0) || (iocb
->ki_left
== 0))
1363 ret
= iocb
->ki_nbytes
- iocb
->ki_left
;
1368 static ssize_t
aio_fdsync(struct kiocb
*iocb
)
1370 struct file
*file
= iocb
->ki_filp
;
1371 ssize_t ret
= -EINVAL
;
1373 if (file
->f_op
->aio_fsync
)
1374 ret
= file
->f_op
->aio_fsync(iocb
, 1);
1378 static ssize_t
aio_fsync(struct kiocb
*iocb
)
1380 struct file
*file
= iocb
->ki_filp
;
1381 ssize_t ret
= -EINVAL
;
1383 if (file
->f_op
->aio_fsync
)
1384 ret
= file
->f_op
->aio_fsync(iocb
, 0);
1388 static ssize_t
aio_setup_vectored_rw(int type
, struct kiocb
*kiocb
)
1392 ret
= rw_copy_check_uvector(type
, (struct iovec __user
*)kiocb
->ki_buf
,
1393 kiocb
->ki_nbytes
, 1,
1394 &kiocb
->ki_inline_vec
, &kiocb
->ki_iovec
);
1398 kiocb
->ki_nr_segs
= kiocb
->ki_nbytes
;
1399 kiocb
->ki_cur_seg
= 0;
1400 /* ki_nbytes/left now reflect bytes instead of segs */
1401 kiocb
->ki_nbytes
= ret
;
1402 kiocb
->ki_left
= ret
;
1409 static ssize_t
aio_setup_single_vector(struct kiocb
*kiocb
)
1411 kiocb
->ki_iovec
= &kiocb
->ki_inline_vec
;
1412 kiocb
->ki_iovec
->iov_base
= kiocb
->ki_buf
;
1413 kiocb
->ki_iovec
->iov_len
= kiocb
->ki_left
;
1414 kiocb
->ki_nr_segs
= 1;
1415 kiocb
->ki_cur_seg
= 0;
1416 kiocb
->ki_nbytes
= kiocb
->ki_left
;
1422 * Performs the initial checks and aio retry method
1423 * setup for the kiocb at the time of io submission.
1425 static ssize_t
aio_setup_iocb(struct kiocb
*kiocb
)
1427 struct file
*file
= kiocb
->ki_filp
;
1430 switch (kiocb
->ki_opcode
) {
1431 case IOCB_CMD_PREAD
:
1433 if (unlikely(!(file
->f_mode
& FMODE_READ
)))
1436 if (unlikely(!access_ok(VERIFY_WRITE
, kiocb
->ki_buf
,
1439 ret
= security_file_permission(file
, MAY_READ
);
1442 ret
= aio_setup_single_vector(kiocb
);
1446 if (file
->f_op
->aio_read
)
1447 kiocb
->ki_retry
= aio_rw_vect_retry
;
1449 case IOCB_CMD_PWRITE
:
1451 if (unlikely(!(file
->f_mode
& FMODE_WRITE
)))
1454 if (unlikely(!access_ok(VERIFY_READ
, kiocb
->ki_buf
,
1457 ret
= security_file_permission(file
, MAY_WRITE
);
1460 ret
= aio_setup_single_vector(kiocb
);
1464 if (file
->f_op
->aio_write
)
1465 kiocb
->ki_retry
= aio_rw_vect_retry
;
1467 case IOCB_CMD_PREADV
:
1469 if (unlikely(!(file
->f_mode
& FMODE_READ
)))
1471 ret
= security_file_permission(file
, MAY_READ
);
1474 ret
= aio_setup_vectored_rw(READ
, kiocb
);
1478 if (file
->f_op
->aio_read
)
1479 kiocb
->ki_retry
= aio_rw_vect_retry
;
1481 case IOCB_CMD_PWRITEV
:
1483 if (unlikely(!(file
->f_mode
& FMODE_WRITE
)))
1485 ret
= security_file_permission(file
, MAY_WRITE
);
1488 ret
= aio_setup_vectored_rw(WRITE
, kiocb
);
1492 if (file
->f_op
->aio_write
)
1493 kiocb
->ki_retry
= aio_rw_vect_retry
;
1495 case IOCB_CMD_FDSYNC
:
1497 if (file
->f_op
->aio_fsync
)
1498 kiocb
->ki_retry
= aio_fdsync
;
1500 case IOCB_CMD_FSYNC
:
1502 if (file
->f_op
->aio_fsync
)
1503 kiocb
->ki_retry
= aio_fsync
;
1506 dprintk("EINVAL: io_submit: no operation provided\n");
1510 if (!kiocb
->ki_retry
)
1517 * aio_wake_function:
1518 * wait queue callback function for aio notification,
1519 * Simply triggers a retry of the operation via kick_iocb.
1521 * This callback is specified in the wait queue entry in
1522 * a kiocb (current->io_wait points to this wait queue
1523 * entry when an aio operation executes; it is used
1524 * instead of a synchronous wait when an i/o blocking
1525 * condition is encountered during aio).
1528 * This routine is executed with the wait queue lock held.
1529 * Since kick_iocb acquires iocb->ctx->ctx_lock, it nests
1530 * the ioctx lock inside the wait queue lock. This is safe
1531 * because this callback isn't used for wait queues which
1532 * are nested inside ioctx lock (i.e. ctx->wait)
1534 static int aio_wake_function(wait_queue_t
*wait
, unsigned mode
,
1535 int sync
, void *key
)
1537 struct kiocb
*iocb
= container_of(wait
, struct kiocb
, ki_wait
);
1539 list_del_init(&wait
->task_list
);
1544 int fastcall
io_submit_one(struct kioctx
*ctx
, struct iocb __user
*user_iocb
,
1551 /* enforce forwards compatibility on users */
1552 if (unlikely(iocb
->aio_reserved1
|| iocb
->aio_reserved2
||
1553 iocb
->aio_reserved3
)) {
1554 pr_debug("EINVAL: io_submit: reserve field set\n");
1558 /* prevent overflows */
1560 (iocb
->aio_buf
!= (unsigned long)iocb
->aio_buf
) ||
1561 (iocb
->aio_nbytes
!= (size_t)iocb
->aio_nbytes
) ||
1562 ((ssize_t
)iocb
->aio_nbytes
< 0)
1564 pr_debug("EINVAL: io_submit: overflow check\n");
1568 file
= fget(iocb
->aio_fildes
);
1569 if (unlikely(!file
))
1572 req
= aio_get_req(ctx
); /* returns with 2 references to req */
1573 if (unlikely(!req
)) {
1578 req
->ki_filp
= file
;
1579 ret
= put_user(req
->ki_key
, &user_iocb
->aio_key
);
1580 if (unlikely(ret
)) {
1581 dprintk("EFAULT: aio_key\n");
1585 req
->ki_obj
.user
= user_iocb
;
1586 req
->ki_user_data
= iocb
->aio_data
;
1587 req
->ki_pos
= iocb
->aio_offset
;
1589 req
->ki_buf
= (char __user
*)(unsigned long)iocb
->aio_buf
;
1590 req
->ki_left
= req
->ki_nbytes
= iocb
->aio_nbytes
;
1591 req
->ki_opcode
= iocb
->aio_lio_opcode
;
1592 init_waitqueue_func_entry(&req
->ki_wait
, aio_wake_function
);
1593 INIT_LIST_HEAD(&req
->ki_wait
.task_list
);
1594 req
->ki_retried
= 0;
1596 ret
= aio_setup_iocb(req
);
1601 spin_lock_irq(&ctx
->ctx_lock
);
1603 if (!list_empty(&ctx
->run_list
)) {
1604 /* drain the run list */
1605 while (__aio_run_iocbs(ctx
))
1608 spin_unlock_irq(&ctx
->ctx_lock
);
1609 aio_put_req(req
); /* drop extra ref to req */
1613 aio_put_req(req
); /* drop extra ref to req */
1614 aio_put_req(req
); /* drop i/o ref to req */
1619 * Queue the nr iocbs pointed to by iocbpp for processing. Returns
1620 * the number of iocbs queued. May return -EINVAL if the aio_context
1621 * specified by ctx_id is invalid, if nr is < 0, if the iocb at
1622 * *iocbpp[0] is not properly initialized, if the operation specified
1623 * is invalid for the file descriptor in the iocb. May fail with
1624 * -EFAULT if any of the data structures point to invalid data. May
1625 * fail with -EBADF if the file descriptor specified in the first
1626 * iocb is invalid. May fail with -EAGAIN if insufficient resources
1627 * are available to queue any iocbs. Will return 0 if nr is 0. Will
1628 * fail with -ENOSYS if not implemented.
1630 asmlinkage
long sys_io_submit(aio_context_t ctx_id
, long nr
,
1631 struct iocb __user
* __user
*iocbpp
)
1637 if (unlikely(nr
< 0))
1640 if (unlikely(!access_ok(VERIFY_READ
, iocbpp
, (nr
*sizeof(*iocbpp
)))))
1643 ctx
= lookup_ioctx(ctx_id
);
1644 if (unlikely(!ctx
)) {
1645 pr_debug("EINVAL: io_submit: invalid context id\n");
1650 * AKPM: should this return a partial result if some of the IOs were
1651 * successfully submitted?
1653 for (i
=0; i
<nr
; i
++) {
1654 struct iocb __user
*user_iocb
;
1657 if (unlikely(__get_user(user_iocb
, iocbpp
+ i
))) {
1662 if (unlikely(copy_from_user(&tmp
, user_iocb
, sizeof(tmp
)))) {
1667 ret
= io_submit_one(ctx
, user_iocb
, &tmp
);
1677 * Finds a given iocb for cancellation.
1679 static struct kiocb
*lookup_kiocb(struct kioctx
*ctx
, struct iocb __user
*iocb
,
1682 struct list_head
*pos
;
1684 assert_spin_locked(&ctx
->ctx_lock
);
1686 /* TODO: use a hash or array, this sucks. */
1687 list_for_each(pos
, &ctx
->active_reqs
) {
1688 struct kiocb
*kiocb
= list_kiocb(pos
);
1689 if (kiocb
->ki_obj
.user
== iocb
&& kiocb
->ki_key
== key
)
1696 * Attempts to cancel an iocb previously passed to io_submit. If
1697 * the operation is successfully cancelled, the resulting event is
1698 * copied into the memory pointed to by result without being placed
1699 * into the completion queue and 0 is returned. May fail with
1700 * -EFAULT if any of the data structures pointed to are invalid.
1701 * May fail with -EINVAL if aio_context specified by ctx_id is
1702 * invalid. May fail with -EAGAIN if the iocb specified was not
1703 * cancelled. Will fail with -ENOSYS if not implemented.
1705 asmlinkage
long sys_io_cancel(aio_context_t ctx_id
, struct iocb __user
*iocb
,
1706 struct io_event __user
*result
)
1708 int (*cancel
)(struct kiocb
*iocb
, struct io_event
*res
);
1710 struct kiocb
*kiocb
;
1714 ret
= get_user(key
, &iocb
->aio_key
);
1718 ctx
= lookup_ioctx(ctx_id
);
1722 spin_lock_irq(&ctx
->ctx_lock
);
1724 kiocb
= lookup_kiocb(ctx
, iocb
, key
);
1725 if (kiocb
&& kiocb
->ki_cancel
) {
1726 cancel
= kiocb
->ki_cancel
;
1728 kiocbSetCancelled(kiocb
);
1731 spin_unlock_irq(&ctx
->ctx_lock
);
1733 if (NULL
!= cancel
) {
1734 struct io_event tmp
;
1735 pr_debug("calling cancel\n");
1736 memset(&tmp
, 0, sizeof(tmp
));
1737 tmp
.obj
= (u64
)(unsigned long)kiocb
->ki_obj
.user
;
1738 tmp
.data
= kiocb
->ki_user_data
;
1739 ret
= cancel(kiocb
, &tmp
);
1741 /* Cancellation succeeded -- copy the result
1742 * into the user's buffer.
1744 if (copy_to_user(result
, &tmp
, sizeof(tmp
)))
1756 * Attempts to read at least min_nr events and up to nr events from
1757 * the completion queue for the aio_context specified by ctx_id. May
1758 * fail with -EINVAL if ctx_id is invalid, if min_nr is out of range,
1759 * if nr is out of range, if when is out of range. May fail with
1760 * -EFAULT if any of the memory specified to is invalid. May return
1761 * 0 or < min_nr if no events are available and the timeout specified
1762 * by when has elapsed, where when == NULL specifies an infinite
1763 * timeout. Note that the timeout pointed to by when is relative and
1764 * will be updated if not NULL and the operation blocks. Will fail
1765 * with -ENOSYS if not implemented.
1767 asmlinkage
long sys_io_getevents(aio_context_t ctx_id
,
1770 struct io_event __user
*events
,
1771 struct timespec __user
*timeout
)
1773 struct kioctx
*ioctx
= lookup_ioctx(ctx_id
);
1776 if (likely(ioctx
)) {
1777 if (likely(min_nr
<= nr
&& min_nr
>= 0 && nr
>= 0))
1778 ret
= read_events(ioctx
, min_nr
, nr
, events
, timeout
);
1785 __initcall(aio_setup
);
1787 EXPORT_SYMBOL(aio_complete
);
1788 EXPORT_SYMBOL(aio_put_req
);
1789 EXPORT_SYMBOL(wait_on_sync_kiocb
);