blob: d3e5b991f77a329d2ef52527f7f5c37695af76d7 [file] [log] [blame]
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +05301/*
2 * GThread coroutine initialization code
3 *
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2011 Aneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.com>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.0 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <glib.h>
22#include "qemu-common.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010023#include "block/coroutine_int.h"
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +053024
25typedef struct {
26 Coroutine base;
27 GThread *thread;
28 bool runnable;
Peter Maydelld1b719e2012-03-03 04:52:56 +000029 bool free_on_thread_exit;
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +053030 CoroutineAction action;
31} CoroutineGThread;
32
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +053033static GStaticMutex coroutine_lock = G_STATIC_MUTEX_INIT;
Peter Maydelld1b719e2012-03-03 04:52:56 +000034
35/* GLib 2.31 and beyond deprecated various parts of the thread API,
36 * but the new interfaces are not available in older GLib versions
37 * so we have to cope with both.
38 */
39#if GLIB_CHECK_VERSION(2, 31, 0)
40/* Default zero-initialisation is sufficient for 2.31+ GCond */
41static GCond the_coroutine_cond;
42static GCond *coroutine_cond = &the_coroutine_cond;
43static inline void init_coroutine_cond(void)
44{
45}
46
47/* Awkwardly, the GPrivate API doesn't provide a way to update the
48 * GDestroyNotify handler for the coroutine key dynamically. So instead
49 * we track whether or not the CoroutineGThread should be freed on
50 * thread exit / coroutine key update using the free_on_thread_exit
51 * field.
52 */
53static void coroutine_destroy_notify(gpointer data)
54{
55 CoroutineGThread *co = data;
56 if (co && co->free_on_thread_exit) {
57 g_free(co);
58 }
59}
60
61static GPrivate coroutine_key = G_PRIVATE_INIT(coroutine_destroy_notify);
62
63static inline CoroutineGThread *get_coroutine_key(void)
64{
65 return g_private_get(&coroutine_key);
66}
67
68static inline void set_coroutine_key(CoroutineGThread *co,
69 bool free_on_thread_exit)
70{
71 /* Unlike g_static_private_set() this does not call the GDestroyNotify
72 * if the previous value of the key was NULL. Fortunately we only need
73 * the GDestroyNotify in the non-NULL key case.
74 */
75 co->free_on_thread_exit = free_on_thread_exit;
76 g_private_replace(&coroutine_key, co);
77}
78
79static inline GThread *create_thread(GThreadFunc func, gpointer data)
80{
81 return g_thread_new("coroutine", func, data);
82}
83
84#else
85
86/* Handle older GLib versions */
87static GCond *coroutine_cond;
88static inline void init_coroutine_cond(void)
89{
90 coroutine_cond = g_cond_new();
91}
92
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +053093static GStaticPrivate coroutine_key = G_STATIC_PRIVATE_INIT;
94
Peter Maydelld1b719e2012-03-03 04:52:56 +000095static inline CoroutineGThread *get_coroutine_key(void)
96{
97 return g_static_private_get(&coroutine_key);
98}
99
100static inline void set_coroutine_key(CoroutineGThread *co,
101 bool free_on_thread_exit)
102{
103 g_static_private_set(&coroutine_key, co,
104 free_on_thread_exit ? (GDestroyNotify)g_free : NULL);
105}
106
107static inline GThread *create_thread(GThreadFunc func, gpointer data)
108{
109 return g_thread_create_full(func, data, 0, TRUE, TRUE,
110 G_THREAD_PRIORITY_NORMAL, NULL);
111}
112
113#endif
114
115
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530116static void __attribute__((constructor)) coroutine_init(void)
117{
118 if (!g_thread_supported()) {
Alon Levy42ed3722011-12-20 13:41:04 +0200119#if !GLIB_CHECK_VERSION(2, 31, 0)
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530120 g_thread_init(NULL);
Alon Levy42ed3722011-12-20 13:41:04 +0200121#else
122 fprintf(stderr, "glib threading failed to initialize.\n");
123 exit(1);
124#endif
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530125 }
126
Peter Maydelld1b719e2012-03-03 04:52:56 +0000127 init_coroutine_cond();
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530128}
129
130static void coroutine_wait_runnable_locked(CoroutineGThread *co)
131{
132 while (!co->runnable) {
133 g_cond_wait(coroutine_cond, g_static_mutex_get_mutex(&coroutine_lock));
134 }
135}
136
137static void coroutine_wait_runnable(CoroutineGThread *co)
138{
139 g_static_mutex_lock(&coroutine_lock);
140 coroutine_wait_runnable_locked(co);
141 g_static_mutex_unlock(&coroutine_lock);
142}
143
144static gpointer coroutine_thread(gpointer opaque)
145{
146 CoroutineGThread *co = opaque;
147
Peter Maydelld1b719e2012-03-03 04:52:56 +0000148 set_coroutine_key(co, false);
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530149 coroutine_wait_runnable(co);
150 co->base.entry(co->base.entry_arg);
151 qemu_coroutine_switch(&co->base, co->base.caller, COROUTINE_TERMINATE);
152 return NULL;
153}
154
155Coroutine *qemu_coroutine_new(void)
156{
157 CoroutineGThread *co;
158
Anthony Liguori7267c092011-08-20 22:09:37 -0500159 co = g_malloc0(sizeof(*co));
Peter Maydelld1b719e2012-03-03 04:52:56 +0000160 co->thread = create_thread(coroutine_thread, co);
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530161 if (!co->thread) {
Anthony Liguori7267c092011-08-20 22:09:37 -0500162 g_free(co);
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530163 return NULL;
164 }
165 return &co->base;
166}
167
168void qemu_coroutine_delete(Coroutine *co_)
169{
170 CoroutineGThread *co = DO_UPCAST(CoroutineGThread, base, co_);
171
172 g_thread_join(co->thread);
Anthony Liguori7267c092011-08-20 22:09:37 -0500173 g_free(co);
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530174}
175
176CoroutineAction qemu_coroutine_switch(Coroutine *from_,
177 Coroutine *to_,
178 CoroutineAction action)
179{
180 CoroutineGThread *from = DO_UPCAST(CoroutineGThread, base, from_);
181 CoroutineGThread *to = DO_UPCAST(CoroutineGThread, base, to_);
182
183 g_static_mutex_lock(&coroutine_lock);
184 from->runnable = false;
185 from->action = action;
186 to->runnable = true;
187 to->action = action;
188 g_cond_broadcast(coroutine_cond);
189
190 if (action != COROUTINE_TERMINATE) {
191 coroutine_wait_runnable_locked(from);
192 }
193 g_static_mutex_unlock(&coroutine_lock);
194 return from->action;
195}
196
197Coroutine *qemu_coroutine_self(void)
198{
Peter Maydelld1b719e2012-03-03 04:52:56 +0000199 CoroutineGThread *co = get_coroutine_key();
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530200 if (!co) {
Anthony Liguori7267c092011-08-20 22:09:37 -0500201 co = g_malloc0(sizeof(*co));
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530202 co->runnable = true;
Peter Maydelld1b719e2012-03-03 04:52:56 +0000203 set_coroutine_key(co, true);
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530204 }
205
206 return &co->base;
207}
208
209bool qemu_in_coroutine(void)
210{
Peter Maydelld1b719e2012-03-03 04:52:56 +0000211 CoroutineGThread *co = get_coroutine_key();
Aneesh Kumar K.Vd0e2fce2011-06-09 23:11:06 +0530212
213 return co && co->base.caller;
214}