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