1/*
2 * Coroutine internals
3 *
4 * Copyright (c) 2011 Kevin Wolf <kwolf@redhat.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25#ifndef QEMU_COROUTINE_INT_H
26#define QEMU_COROUTINE_INT_H
27
28#include "qemu/queue.h"
29#include "qemu/coroutine.h"
30
31#define COROUTINE_STACK_SIZE (1 << 20)
32
33typedef enum {
34 COROUTINE_YIELD = 1,
35 COROUTINE_TERMINATE = 2,
36 COROUTINE_ENTER = 3,
37} CoroutineAction;
38
39struct Coroutine {
40 CoroutineEntry *entry;
41 void *entry_arg;
42 Coroutine *caller;
43
44 /* Only used when the coroutine has terminated. */
45 QSLIST_ENTRY(Coroutine) pool_next;
46
47 size_t locks_held;
48
49 /* Only used when the coroutine has yielded. */
50 AioContext *ctx;
51
52 /* Used to catch and abort on illegal co-routine entry.
53 * Will contain the name of the function that had first
54 * scheduled the coroutine. */
55 const char *scheduled;
56
57 QSIMPLEQ_ENTRY(Coroutine) co_queue_next;
58
59 /* Coroutines that should be woken up when we yield or terminate.
60 * Only used when the coroutine is running.
61 */
62 QSIMPLEQ_HEAD(, Coroutine) co_queue_wakeup;
63
64 QSLIST_ENTRY(Coroutine) co_scheduled_next;
65};
66
67Coroutine *qemu_coroutine_new(void);
68void qemu_coroutine_delete(Coroutine *co);
69CoroutineAction qemu_coroutine_switch(Coroutine *from, Coroutine *to,
70 CoroutineAction action);
71
72#endif
73