1 | /* |
1 | /* |
2 | * Copyright (c) 2001-2008 Marc Alexander Lehmann <schmorp@schmorp.de> |
2 | * Copyright (c) 2001-2009 Marc Alexander Lehmann <schmorp@schmorp.de> |
3 | * |
3 | * |
4 | * Redistribution and use in source and binary forms, with or without modifica- |
4 | * Redistribution and use in source and binary forms, with or without modifica- |
5 | * tion, are permitted provided that the following conditions are met: |
5 | * tion, are permitted provided that the following conditions are met: |
6 | * |
6 | * |
7 | * 1. Redistributions of source code must retain the above copyright notice, |
7 | * 1. Redistributions of source code must retain the above copyright notice, |
… | |
… | |
56 | * 2008-04-04 New (but highly unrecommended) pthreads backend. |
56 | * 2008-04-04 New (but highly unrecommended) pthreads backend. |
57 | * 2008-04-24 Reinstate CORO_LOSER (had wrong stack adjustments). |
57 | * 2008-04-24 Reinstate CORO_LOSER (had wrong stack adjustments). |
58 | * 2008-10-30 Support assembly method on x86 with and without frame pointer. |
58 | * 2008-10-30 Support assembly method on x86 with and without frame pointer. |
59 | * 2008-11-03 Use a global asm statement for CORO_ASM, idea by pippijn. |
59 | * 2008-11-03 Use a global asm statement for CORO_ASM, idea by pippijn. |
60 | * 2008-11-05 Hopefully fix misaligned stacks with CORO_ASM/SETJMP. |
60 | * 2008-11-05 Hopefully fix misaligned stacks with CORO_ASM/SETJMP. |
|
|
61 | * 2008-11-07 rbp wasn't saved in CORO_ASM on x86_64. |
|
|
62 | * introduce coro_destroy, which is a nop except for pthreads. |
|
|
63 | * speed up CORO_PTHREAD. Do no longer leak threads either. |
|
|
64 | * coro_create now allows one to create source coro_contexts. |
|
|
65 | * do not rely on makecontext passing a void * correctly. |
|
|
66 | * try harder to get _setjmp/_longjmp. |
|
|
67 | * major code cleanup/restructuring. |
|
|
68 | * 2008-11-10 the .cfi hacks are no longer needed. |
|
|
69 | * 2008-11-16 work around a freebsd pthread bug. |
|
|
70 | * 2008-11-19 define coro_*jmp symbols for easier porting. |
|
|
71 | * 2009-06-23 tentative win32-backend support for mingw32 (Yasuhiro Matsumoto). |
|
|
72 | * 2010-12-03 tentative support for uclibc (which lacks all sorts of things). |
|
|
73 | * 2011-05-30 set initial callee-saved-registers to zero with CORO_ASM. |
|
|
74 | * use .cfi_undefined rip on linux-amd64 for better backtraces. |
|
|
75 | * 2011-06-08 maybe properly implement weird windows amd64 calling conventions. |
61 | */ |
76 | */ |
62 | |
77 | |
63 | #ifndef CORO_H |
78 | #ifndef CORO_H |
64 | #define CORO_H |
79 | #define CORO_H |
|
|
80 | |
|
|
81 | #if __cplusplus |
|
|
82 | extern "C" { |
|
|
83 | #endif |
65 | |
84 | |
66 | #define CORO_VERSION 2 |
85 | #define CORO_VERSION 2 |
67 | |
86 | |
68 | /* |
87 | /* |
69 | * Changes since API version 1: |
88 | * Changes since API version 1: |
… | |
… | |
107 | * SGI's version of Microsoft's NT ;) |
126 | * SGI's version of Microsoft's NT ;) |
108 | * |
127 | * |
109 | * -DCORO_ASM |
128 | * -DCORO_ASM |
110 | * |
129 | * |
111 | * Handcoded assembly, known to work only on a few architectures/ABI: |
130 | * Handcoded assembly, known to work only on a few architectures/ABI: |
112 | * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on. |
131 | * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs. |
113 | * |
132 | * |
114 | * -DCORO_PTHREAD |
133 | * -DCORO_PTHREAD |
115 | * |
134 | * |
116 | * Use the pthread API. You have to provide <pthread.h> and -lpthread. |
135 | * Use the pthread API. You have to provide <pthread.h> and -lpthread. |
|
|
136 | * This is likely the slowest backend, and it also does not support fork(), |
|
|
137 | * so avoid it at all costs. |
117 | * |
138 | * |
118 | * If you define neither of these symbols, coro.h will try to autodetect |
139 | * If you define neither of these symbols, coro.h will try to autodetect |
119 | * the model. This currently works for CORO_LOSER only. For the other |
140 | * the model. This currently works for CORO_LOSER only. For the other |
120 | * alternatives you should check (e.g. using autoconf) and define the |
141 | * alternatives you should check (e.g. using autoconf) and define the |
121 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
142 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
… | |
… | |
136 | /* |
157 | /* |
137 | * This function creates a new coroutine. Apart from a pointer to an |
158 | * This function creates a new coroutine. Apart from a pointer to an |
138 | * uninitialised coro_context, it expects a pointer to the entry function |
159 | * uninitialised coro_context, it expects a pointer to the entry function |
139 | * and the single pointer value that is given to it as argument. |
160 | * and the single pointer value that is given to it as argument. |
140 | * |
161 | * |
141 | * Allocating/deallocating the stack is your own responsibility, so there is |
162 | * Allocating/deallocating the stack is your own responsibility. |
142 | * no coro_destroy function. |
163 | * |
|
|
164 | * As a special case, if coro, arg, sptr and ssize are all zero, |
|
|
165 | * then an "empty" coro_context will be created that is suitable |
|
|
166 | * as an initial source for coro_transfer. |
|
|
167 | * |
|
|
168 | * This function is not reentrant, but putting a mutex around it |
|
|
169 | * will work. |
143 | */ |
170 | */ |
144 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
171 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
145 | coro_func coro, /* the coroutine code to be executed */ |
172 | coro_func coro, /* the coroutine code to be executed */ |
146 | void *arg, /* a single pointer passed to the coro */ |
173 | void *arg, /* a single pointer passed to the coro */ |
147 | void *sptr, /* start of stack area */ |
174 | void *sptr, /* start of stack area */ |
… | |
… | |
149 | |
176 | |
150 | /* |
177 | /* |
151 | * The following prototype defines the coroutine switching function. It is |
178 | * The following prototype defines the coroutine switching function. It is |
152 | * usually implemented as a macro, so watch out. |
179 | * usually implemented as a macro, so watch out. |
153 | * |
180 | * |
|
|
181 | * This function is thread-safe and reentrant. |
|
|
182 | */ |
|
|
183 | #if 0 |
154 | void coro_transfer(coro_context *prev, coro_context *next); |
184 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
185 | #endif |
|
|
186 | |
|
|
187 | /* |
|
|
188 | * The following prototype defines the coroutine destroy function. It is |
|
|
189 | * usually implemented as a macro, so watch out. It also serves |
|
|
190 | * no purpose unless you want to use the CORO_PTHREAD backend, |
|
|
191 | * where it is used to clean up the thread. You are responsible |
|
|
192 | * for freeing the stack and the context itself. |
155 | */ |
193 | * |
|
|
194 | * This function is thread-safe and reentrant. |
|
|
195 | */ |
|
|
196 | #if 0 |
|
|
197 | void coro_destroy (coro_context *ctx); |
|
|
198 | #endif |
156 | |
199 | |
157 | /* |
200 | /* |
158 | * That was it. No other user-visible functions are implemented here. |
201 | * That was it. No other user-visible functions are implemented here. |
159 | */ |
202 | */ |
160 | |
203 | |
… | |
… | |
162 | |
205 | |
163 | #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
206 | #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
164 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
207 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
165 | && !defined(CORO_IRIX) && !defined(CORO_ASM) \ |
208 | && !defined(CORO_IRIX) && !defined(CORO_ASM) \ |
166 | && !defined(CORO_PTHREAD) |
209 | && !defined(CORO_PTHREAD) |
167 | # if defined(WINDOWS) |
210 | # if defined(WINDOWS) || defined(_WIN32) |
168 | # define CORO_LOSER 1 /* you don't win with windoze */ |
211 | # define CORO_LOSER 1 /* you don't win with windoze */ |
169 | # elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
212 | # elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
170 | # define CORO_ASM 1 |
213 | # define CORO_ASM 1 |
171 | # elif defined(HAVE_UCONTEXT_H) |
214 | # elif defined(HAVE_UCONTEXT_H) |
172 | # define CORO_UCONTEXT 1 |
215 | # define CORO_UCONTEXT 1 |
… | |
… | |
186 | struct coro_context { |
229 | struct coro_context { |
187 | ucontext_t uc; |
230 | ucontext_t uc; |
188 | }; |
231 | }; |
189 | |
232 | |
190 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
233 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
|
|
234 | # define coro_destroy(ctx) (void *)(ctx) |
191 | |
235 | |
192 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
236 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
193 | |
237 | |
194 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
238 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
195 | # define _GNU_SOURCE /* for linux libc */ |
239 | # define _GNU_SOURCE /* for linux libc */ |
196 | # endif |
240 | # endif |
197 | |
241 | |
|
|
242 | # if !CORO_LOSER |
|
|
243 | # include <unistd.h> |
|
|
244 | # endif |
|
|
245 | |
|
|
246 | /* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */ |
|
|
247 | # if __sun |
|
|
248 | # undef _XOPEN_UNIX |
|
|
249 | # define _XOPEN_UNIX 1 |
|
|
250 | # endif |
|
|
251 | |
198 | # include <setjmp.h> |
252 | # include <setjmp.h> |
199 | |
253 | |
|
|
254 | # if _XOPEN_UNIX > 0 || defined (_setjmp) |
|
|
255 | # define coro_jmp_buf jmp_buf |
|
|
256 | # define coro_setjmp(env) _setjmp (env) |
|
|
257 | # define coro_longjmp(env) _longjmp ((env), 1) |
|
|
258 | # elif CORO_LOSER |
|
|
259 | # define coro_jmp_buf jmp_buf |
|
|
260 | # define coro_setjmp(env) setjmp (env) |
|
|
261 | # define coro_longjmp(env) longjmp ((env), 1) |
|
|
262 | # else |
|
|
263 | # define coro_jmp_buf sigjmp_buf |
|
|
264 | # define coro_setjmp(env) sigsetjmp (env, 0) |
|
|
265 | # define coro_longjmp(env) siglongjmp ((env), 1) |
|
|
266 | # endif |
|
|
267 | |
200 | struct coro_context { |
268 | struct coro_context { |
201 | jmp_buf env; |
269 | coro_jmp_buf env; |
202 | }; |
270 | }; |
203 | |
271 | |
204 | # if CORO_LINUX || (_XOPEN_SOURCE >= 600) |
|
|
205 | # define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) |
272 | # define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0) |
206 | # else |
273 | # define coro_destroy(ctx) (void *)(ctx) |
207 | # define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) |
|
|
208 | # endif |
|
|
209 | |
274 | |
210 | #elif CORO_ASM |
275 | #elif CORO_ASM |
211 | |
276 | |
212 | struct coro_context { |
277 | struct coro_context { |
213 | volatile void **sp; /* must be at offset 0 */ |
278 | void **sp; /* must be at offset 0 */ |
214 | }; |
279 | }; |
215 | |
280 | |
216 | void __attribute__ ((__noinline__, __regparm__(2))) |
281 | void __attribute__ ((__noinline__, __regparm__(2))) |
217 | coro_transfer (coro_context *prev, coro_context *next); |
282 | coro_transfer (coro_context *prev, coro_context *next); |
218 | |
283 | |
|
|
284 | # define coro_destroy(ctx) (void *)(ctx) |
|
|
285 | |
219 | #elif CORO_PTHREAD |
286 | #elif CORO_PTHREAD |
220 | |
287 | |
221 | #include <pthread.h> |
288 | # include <pthread.h> |
222 | |
289 | |
223 | extern pthread_mutex_t coro_mutex; |
290 | extern pthread_mutex_t coro_mutex; |
224 | |
291 | |
225 | struct coro_context { |
292 | struct coro_context { |
226 | pthread_cond_t c; |
293 | pthread_cond_t cv; |
|
|
294 | pthread_t id; |
227 | }; |
295 | }; |
228 | |
296 | |
229 | void coro_transfer (coro_context *prev, coro_context *next); |
297 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
298 | void coro_destroy (coro_context *ctx); |
230 | |
299 | |
231 | #endif |
300 | #endif |
232 | |
301 | |
|
|
302 | #if __cplusplus |
|
|
303 | } |
233 | #endif |
304 | #endif |
234 | |
305 | |
|
|
306 | #endif |
|
|
307 | |