1 | /* |
1 | /* |
2 | * Copyright (c) 2001-2008 Marc Alexander Lehmann <schmorp@schmorp.de> |
2 | * Copyright (c) 2001-2011 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, |
… | |
… | |
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. |
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. |
|
|
76 | * 2011-07-03 rely on __GCC_HAVE_DWARF2_CFI_ASM for cfi detection. |
|
|
77 | * 2011-08-08 cygwin trashes stacks, use pthreads with double stack on cygwin. |
62 | */ |
78 | */ |
63 | |
79 | |
64 | #ifndef CORO_H |
80 | #ifndef CORO_H |
65 | #define CORO_H |
81 | #define CORO_H |
|
|
82 | |
|
|
83 | #if __cplusplus |
|
|
84 | extern "C" { |
|
|
85 | #endif |
66 | |
86 | |
67 | #define CORO_VERSION 2 |
87 | #define CORO_VERSION 2 |
68 | |
88 | |
69 | /* |
89 | /* |
70 | * Changes since API version 1: |
90 | * Changes since API version 1: |
… | |
… | |
108 | * SGI's version of Microsoft's NT ;) |
128 | * SGI's version of Microsoft's NT ;) |
109 | * |
129 | * |
110 | * -DCORO_ASM |
130 | * -DCORO_ASM |
111 | * |
131 | * |
112 | * Handcoded assembly, known to work only on a few architectures/ABI: |
132 | * Handcoded assembly, known to work only on a few architectures/ABI: |
113 | * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on. |
133 | * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs. |
114 | * |
134 | * |
115 | * -DCORO_PTHREAD |
135 | * -DCORO_PTHREAD |
116 | * |
136 | * |
117 | * Use the pthread API. You have to provide <pthread.h> and -lpthread. |
137 | * Use the pthread API. You have to provide <pthread.h> and -lpthread. |
|
|
138 | * This is likely the slowest backend, and it also does not support fork(), |
|
|
139 | * so avoid it at all costs. |
118 | * |
140 | * |
119 | * If you define neither of these symbols, coro.h will try to autodetect |
141 | * If you define neither of these symbols, coro.h will try to autodetect |
120 | * the model. This currently works for CORO_LOSER only. For the other |
142 | * the model. This currently works for CORO_LOSER only. For the other |
121 | * alternatives you should check (e.g. using autoconf) and define the |
143 | * alternatives you should check (e.g. using autoconf) and define the |
122 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
144 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
… | |
… | |
137 | /* |
159 | /* |
138 | * This function creates a new coroutine. Apart from a pointer to an |
160 | * This function creates a new coroutine. Apart from a pointer to an |
139 | * uninitialised coro_context, it expects a pointer to the entry function |
161 | * uninitialised coro_context, it expects a pointer to the entry function |
140 | * and the single pointer value that is given to it as argument. |
162 | * and the single pointer value that is given to it as argument. |
141 | * |
163 | * |
142 | * Allocating/deallocating the stack is your own responsibility, so there is |
164 | * Allocating/deallocating the stack is your own responsibility. |
143 | * no coro_destroy function. |
165 | * |
|
|
166 | * As a special case, if coro, arg, sptr and ssize are all zero, |
|
|
167 | * then an "empty" coro_context will be created that is suitable |
|
|
168 | * as an initial source for coro_transfer. |
|
|
169 | * |
|
|
170 | * This function is not reentrant, but putting a mutex around it |
|
|
171 | * will work. |
144 | */ |
172 | */ |
145 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
173 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
146 | coro_func coro, /* the coroutine code to be executed */ |
174 | coro_func coro, /* the coroutine code to be executed */ |
147 | void *arg, /* a single pointer passed to the coro */ |
175 | void *arg, /* a single pointer passed to the coro */ |
148 | void *sptr, /* start of stack area */ |
176 | void *sptr, /* start of stack area */ |
… | |
… | |
150 | |
178 | |
151 | /* |
179 | /* |
152 | * The following prototype defines the coroutine switching function. It is |
180 | * The following prototype defines the coroutine switching function. It is |
153 | * usually implemented as a macro, so watch out. |
181 | * usually implemented as a macro, so watch out. |
154 | * |
182 | * |
|
|
183 | * This function is thread-safe and reentrant. |
|
|
184 | */ |
|
|
185 | #if 0 |
155 | void coro_transfer(coro_context *prev, coro_context *next); |
186 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
187 | #endif |
|
|
188 | |
|
|
189 | /* |
|
|
190 | * The following prototype defines the coroutine destroy function. It is |
|
|
191 | * usually implemented as a macro, so watch out. It also serves |
|
|
192 | * no purpose unless you want to use the CORO_PTHREAD backend, |
|
|
193 | * where it is used to clean up the thread. You are responsible |
|
|
194 | * for freeing the stack and the context itself. |
156 | */ |
195 | * |
|
|
196 | * This function is thread-safe and reentrant. |
|
|
197 | */ |
|
|
198 | #if 0 |
|
|
199 | void coro_destroy (coro_context *ctx); |
|
|
200 | #endif |
157 | |
201 | |
158 | /* |
202 | /* |
159 | * That was it. No other user-visible functions are implemented here. |
203 | * That was it. No other user-visible functions are implemented here. |
160 | */ |
204 | */ |
161 | |
205 | |
… | |
… | |
163 | |
207 | |
164 | #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
208 | #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
165 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
209 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
166 | && !defined(CORO_IRIX) && !defined(CORO_ASM) \ |
210 | && !defined(CORO_IRIX) && !defined(CORO_ASM) \ |
167 | && !defined(CORO_PTHREAD) |
211 | && !defined(CORO_PTHREAD) |
168 | # if defined(WINDOWS) |
212 | # if defined(WINDOWS) || defined(_WIN32) |
169 | # define CORO_LOSER 1 /* you don't win with windoze */ |
213 | # define CORO_LOSER 1 /* you don't win with windoze */ |
170 | # elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
214 | # elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
171 | # define CORO_ASM 1 |
215 | # define CORO_ASM 1 |
172 | # elif defined(HAVE_UCONTEXT_H) |
216 | # elif defined(HAVE_UCONTEXT_H) |
173 | # define CORO_UCONTEXT 1 |
217 | # define CORO_UCONTEXT 1 |
… | |
… | |
187 | struct coro_context { |
231 | struct coro_context { |
188 | ucontext_t uc; |
232 | ucontext_t uc; |
189 | }; |
233 | }; |
190 | |
234 | |
191 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
235 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
|
|
236 | # define coro_destroy(ctx) (void *)(ctx) |
192 | |
237 | |
193 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
238 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
194 | |
239 | |
195 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
240 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
196 | # define _GNU_SOURCE /* for linux libc */ |
241 | # define _GNU_SOURCE /* for linux libc */ |
197 | # endif |
242 | # endif |
198 | |
243 | |
|
|
244 | # if !CORO_LOSER |
|
|
245 | # include <unistd.h> |
|
|
246 | # endif |
|
|
247 | |
|
|
248 | /* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */ |
|
|
249 | # if __sun |
|
|
250 | # undef _XOPEN_UNIX |
|
|
251 | # define _XOPEN_UNIX 1 |
|
|
252 | # endif |
|
|
253 | |
199 | # include <setjmp.h> |
254 | # include <setjmp.h> |
200 | |
255 | |
|
|
256 | # if _XOPEN_UNIX > 0 || defined (_setjmp) |
|
|
257 | # define coro_jmp_buf jmp_buf |
|
|
258 | # define coro_setjmp(env) _setjmp (env) |
|
|
259 | # define coro_longjmp(env) _longjmp ((env), 1) |
|
|
260 | # elif CORO_LOSER |
|
|
261 | # define coro_jmp_buf jmp_buf |
|
|
262 | # define coro_setjmp(env) setjmp (env) |
|
|
263 | # define coro_longjmp(env) longjmp ((env), 1) |
|
|
264 | # else |
|
|
265 | # define coro_jmp_buf sigjmp_buf |
|
|
266 | # define coro_setjmp(env) sigsetjmp (env, 0) |
|
|
267 | # define coro_longjmp(env) siglongjmp ((env), 1) |
|
|
268 | # endif |
|
|
269 | |
201 | struct coro_context { |
270 | struct coro_context { |
202 | jmp_buf env; |
271 | coro_jmp_buf env; |
203 | }; |
272 | }; |
204 | |
273 | |
205 | # if CORO_LINUX || (_XOPEN_SOURCE >= 600) |
|
|
206 | # define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) |
274 | # define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0) |
207 | # else |
275 | # define coro_destroy(ctx) (void *)(ctx) |
208 | # define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) |
|
|
209 | # endif |
|
|
210 | |
276 | |
211 | #elif CORO_ASM |
277 | #elif CORO_ASM |
212 | |
278 | |
213 | struct coro_context { |
279 | struct coro_context { |
214 | volatile void **sp; /* must be at offset 0 */ |
280 | void **sp; /* must be at offset 0 */ |
215 | }; |
281 | }; |
216 | |
282 | |
217 | void __attribute__ ((__noinline__, __regparm__(2))) |
283 | void __attribute__ ((__noinline__, __regparm__(2))) |
218 | coro_transfer (coro_context *prev, coro_context *next); |
284 | coro_transfer (coro_context *prev, coro_context *next); |
219 | |
285 | |
|
|
286 | # define coro_destroy(ctx) (void *)(ctx) |
|
|
287 | |
220 | #elif CORO_PTHREAD |
288 | #elif CORO_PTHREAD |
221 | |
289 | |
222 | #include <pthread.h> |
290 | # include <pthread.h> |
223 | |
291 | |
224 | extern pthread_mutex_t coro_mutex; |
292 | extern pthread_mutex_t coro_mutex; |
225 | |
293 | |
226 | struct coro_context { |
294 | struct coro_context { |
227 | pthread_cond_t c; |
295 | pthread_cond_t cv; |
|
|
296 | pthread_t id; |
228 | }; |
297 | }; |
229 | |
298 | |
230 | void coro_transfer (coro_context *prev, coro_context *next); |
299 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
300 | void coro_destroy (coro_context *ctx); |
231 | |
301 | |
232 | #endif |
302 | #endif |
233 | |
303 | |
|
|
304 | #if __cplusplus |
|
|
305 | } |
234 | #endif |
306 | #endif |
235 | |
307 | |
|
|
308 | #endif |
|
|
309 | |