1 | /* |
1 | /* |
2 | * Copyright (c) 2001-2008 Marc Alexander Lehmann <schmorp@schmorp.de> |
2 | * Copyright (c) 2001-2012 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, |
8 | * this list of conditions and the following disclaimer. |
8 | * this list of conditions and the following disclaimer. |
9 | * |
9 | * |
10 | * 2. Redistributions in binary form must reproduce the above copyright |
10 | * 2. Redistributions in binary form must reproduce the above copyright |
11 | * notice, this list of conditions and the following disclaimer in the |
11 | * notice, this list of conditions and the following disclaimer in the |
12 | * documentation and/or other materials provided with the distribution. |
12 | * documentation and/or other materials provided with the distribution. |
13 | * |
13 | * |
14 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
14 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
15 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
15 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
16 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
16 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
17 | * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- |
17 | * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- |
18 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
18 | * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
… | |
… | |
51 | * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600. |
51 | * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600. |
52 | * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance |
52 | * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance |
53 | * on SIGUSR2 and sigaltstack in Crossfire). |
53 | * on SIGUSR2 and sigaltstack in Crossfire). |
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. |
|
|
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. |
|
|
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. |
|
|
77 | * 2011-08-08 cygwin trashes stacks, use pthreads with double stack on cygwin. |
|
|
78 | * 2012-12-04 reduce misprediction penalty for x86/amd64 assembly switcher. |
|
|
79 | * 2012-12-05 experimental fiber backend (allocates stack twice). |
56 | */ |
80 | */ |
57 | |
81 | |
58 | #ifndef CORO_H |
82 | #ifndef CORO_H |
59 | #define CORO_H |
83 | #define CORO_H |
|
|
84 | |
|
|
85 | #if __cplusplus |
|
|
86 | extern "C" { |
|
|
87 | #endif |
60 | |
88 | |
61 | #define CORO_VERSION 2 |
89 | #define CORO_VERSION 2 |
62 | |
90 | |
63 | /* |
91 | /* |
64 | * Changes since API version 1: |
92 | * Changes since API version 1: |
… | |
… | |
95 | * |
123 | * |
96 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
124 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
97 | * this automatically selects a suitable workaround for this platform. |
125 | * this automatically selects a suitable workaround for this platform. |
98 | * (untested) |
126 | * (untested) |
99 | * |
127 | * |
|
|
128 | * -DCORO_FIBER |
|
|
129 | * |
|
|
130 | * slower, but probably more portable variant for the Microsoft operating |
|
|
131 | * system, using fibers. ignores your stack. |
|
|
132 | * |
100 | * -DCORO_IRIX |
133 | * -DCORO_IRIX |
101 | * |
134 | * |
102 | * SGI's version of Microsoft's NT ;) |
135 | * SGI's version of Microsoft's NT ;) |
103 | * |
136 | * |
104 | * -DCORO_ASM |
137 | * -DCORO_ASM |
105 | * |
138 | * |
106 | * Handcoded assembly, known to work only on a few architectures/ABI: |
139 | * Handcoded assembly, known to work only on a few architectures/ABI: |
107 | * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on. |
140 | * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs. |
|
|
141 | * |
|
|
142 | * -DCORO_PTHREAD |
|
|
143 | * |
|
|
144 | * Use the pthread API. You have to provide <pthread.h> and -lpthread. |
|
|
145 | * This is likely the slowest backend, and it also does not support fork(), |
|
|
146 | * so avoid it at all costs. |
108 | * |
147 | * |
109 | * If you define neither of these symbols, coro.h will try to autodetect |
148 | * If you define neither of these symbols, coro.h will try to autodetect |
110 | * the model. This currently works for CORO_LOSER only. For the other |
149 | * the model. This currently works for CORO_LOSER only. For the other |
111 | * alternatives you should check (e.g. using autoconf) and define the |
150 | * alternatives you should check (e.g. using autoconf) and define the |
112 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
151 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
… | |
… | |
127 | /* |
166 | /* |
128 | * This function creates a new coroutine. Apart from a pointer to an |
167 | * This function creates a new coroutine. Apart from a pointer to an |
129 | * uninitialised coro_context, it expects a pointer to the entry function |
168 | * uninitialised coro_context, it expects a pointer to the entry function |
130 | * and the single pointer value that is given to it as argument. |
169 | * and the single pointer value that is given to it as argument. |
131 | * |
170 | * |
132 | * Allocating/deallocating the stack is your own responsibility, so there is |
171 | * Allocating/deallocating the stack is your own responsibility. |
133 | * no coro_destroy function. |
172 | * |
|
|
173 | * As a special case, if coro, arg, sptr and ssize are all zero, |
|
|
174 | * then an "empty" coro_context will be created that is suitable |
|
|
175 | * as an initial source for coro_transfer. |
|
|
176 | * |
|
|
177 | * This function is not reentrant, but putting a mutex around it |
|
|
178 | * will work. |
134 | */ |
179 | */ |
135 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
180 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
136 | coro_func coro, /* the coroutine code to be executed */ |
181 | coro_func coro, /* the coroutine code to be executed */ |
137 | void *arg, /* a single pointer passed to the coro */ |
182 | void *arg, /* a single pointer passed to the coro */ |
138 | void *sptr, /* start of stack area */ |
183 | void *sptr, /* start of stack area */ |
… | |
… | |
140 | |
185 | |
141 | /* |
186 | /* |
142 | * The following prototype defines the coroutine switching function. It is |
187 | * The following prototype defines the coroutine switching function. It is |
143 | * usually implemented as a macro, so watch out. |
188 | * usually implemented as a macro, so watch out. |
144 | * |
189 | * |
|
|
190 | * This function is thread-safe and reentrant. |
|
|
191 | */ |
|
|
192 | #if 0 |
145 | void coro_transfer(coro_context *prev, coro_context *next); |
193 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
194 | #endif |
|
|
195 | |
|
|
196 | /* |
|
|
197 | * The following prototype defines the coroutine destroy function. It is |
|
|
198 | * usually implemented as a macro, so watch out. It also serves |
|
|
199 | * no purpose unless you want to use the CORO_PTHREAD backend, |
|
|
200 | * where it is used to clean up the thread. You are responsible |
|
|
201 | * for freeing the stack and the context itself. |
146 | */ |
202 | * |
|
|
203 | * This function is thread-safe and reentrant. |
|
|
204 | */ |
|
|
205 | #if 0 |
|
|
206 | void coro_destroy (coro_context *ctx); |
|
|
207 | #endif |
147 | |
208 | |
148 | /* |
209 | /* |
149 | * That was it. No other user-visible functions are implemented here. |
210 | * That was it. No other user-visible functions are implemented here. |
150 | */ |
211 | */ |
151 | |
212 | |
152 | /*****************************************************************************/ |
213 | /*****************************************************************************/ |
153 | |
214 | |
154 | #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
215 | #if !defined CORO_LOSER && !defined CORO_UCONTEXT \ |
155 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
216 | && !defined CORO_SJLJ && !defined CORO_LINUX \ |
156 | && !defined(CORO_IRIX) && !defined(CORO_ASM) |
217 | && !defined CORO_IRIX && !defined CORO_ASM \ |
157 | # if defined(WINDOWS) |
218 | && !defined CORO_PTHREAD && !defined CORO_FIBER |
|
|
219 | # if defined WINDOWS && (defined __x86 || defined __amd64 || defined _M_IX86 || defined _M_AMD64) |
|
|
220 | # define CORO_ASM 1 |
|
|
221 | # elif defined WINDOWS || defined _WIN32 |
158 | # define CORO_LOSER 1 /* you don't win with windoze */ |
222 | # define CORO_LOSER 1 /* you don't win with windoze */ |
159 | # elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
223 | # elif defined __linux && (defined __x86 || defined __amd64) |
160 | # define CORO_ASM 1 |
224 | # define CORO_ASM 1 |
161 | # elif defined(HAVE_UCONTEXT_H) |
225 | # elif defined HAVE_UCONTEXT_H |
162 | # define CORO_UCONTEXT 1 |
226 | # define CORO_UCONTEXT 1 |
163 | # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
227 | # elif defined HAVE_SETJMP_H && defined HAVE_SIGALTSTACK |
164 | # define CORO_SJLJ 1 |
228 | # define CORO_SJLJ 1 |
165 | # else |
229 | # else |
166 | error unknown or unsupported architecture |
230 | error unknown or unsupported architecture |
167 | # endif |
231 | # endif |
168 | #endif |
232 | #endif |
… | |
… | |
176 | struct coro_context { |
240 | struct coro_context { |
177 | ucontext_t uc; |
241 | ucontext_t uc; |
178 | }; |
242 | }; |
179 | |
243 | |
180 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
244 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
|
|
245 | # define coro_destroy(ctx) (void *)(ctx) |
181 | |
246 | |
182 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
247 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
183 | |
248 | |
184 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
249 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
185 | # define _GNU_SOURCE /* for linux libc */ |
250 | # define _GNU_SOURCE /* for linux libc */ |
186 | # endif |
251 | # endif |
187 | |
252 | |
|
|
253 | # if !CORO_LOSER |
|
|
254 | # include <unistd.h> |
|
|
255 | # endif |
|
|
256 | |
|
|
257 | /* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */ |
|
|
258 | # if __sun |
|
|
259 | # undef _XOPEN_UNIX |
|
|
260 | # define _XOPEN_UNIX 1 |
|
|
261 | # endif |
|
|
262 | |
188 | # include <setjmp.h> |
263 | # include <setjmp.h> |
189 | |
264 | |
190 | struct coro_context { |
265 | # if _XOPEN_UNIX > 0 || defined (_setjmp) |
191 | jmp_buf env; |
266 | # define coro_jmp_buf jmp_buf |
192 | }; |
267 | # define coro_setjmp(env) _setjmp (env) |
193 | |
268 | # define coro_longjmp(env) _longjmp ((env), 1) |
194 | # if CORO_LINUX || (_XOPEN_SOURCE >= 600) |
269 | # elif CORO_LOSER |
195 | # define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) |
270 | # define coro_jmp_buf jmp_buf |
|
|
271 | # define coro_setjmp(env) setjmp (env) |
|
|
272 | # define coro_longjmp(env) longjmp ((env), 1) |
196 | # else |
273 | # else |
|
|
274 | # define coro_jmp_buf sigjmp_buf |
|
|
275 | # define coro_setjmp(env) sigsetjmp (env, 0) |
|
|
276 | # define coro_longjmp(env) siglongjmp ((env), 1) |
|
|
277 | # endif |
|
|
278 | |
|
|
279 | struct coro_context { |
|
|
280 | coro_jmp_buf env; |
|
|
281 | }; |
|
|
282 | |
197 | # define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) |
283 | # define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0) |
198 | # endif |
284 | # define coro_destroy(ctx) (void *)(ctx) |
199 | |
285 | |
200 | #elif CORO_ASM |
286 | #elif CORO_ASM |
201 | |
287 | |
202 | struct coro_context { |
288 | struct coro_context { |
203 | volatile void **sp; |
289 | void **sp; /* must be at offset 0 */ |
204 | }; |
290 | }; |
205 | |
291 | |
206 | void __attribute__ ((__noinline__, __fastcall__)) |
292 | void __attribute__ ((__noinline__, __regparm__(2))) |
207 | coro_transfer(coro_context *prev, coro_context *next); |
293 | coro_transfer (coro_context *prev, coro_context *next); |
208 | |
294 | |
209 | #endif |
295 | # define coro_destroy(ctx) (void *)(ctx) |
210 | |
296 | |
211 | #endif |
297 | #elif CORO_PTHREAD |
212 | |
298 | |
|
|
299 | # include <pthread.h> |
|
|
300 | |
|
|
301 | extern pthread_mutex_t coro_mutex; |
|
|
302 | |
|
|
303 | struct coro_context { |
|
|
304 | pthread_cond_t cv; |
|
|
305 | pthread_t id; |
|
|
306 | }; |
|
|
307 | |
|
|
308 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
309 | void coro_destroy (coro_context *ctx); |
|
|
310 | |
|
|
311 | #elif CORO_FIBER |
|
|
312 | |
|
|
313 | struct coro_context { |
|
|
314 | void *fiber; |
|
|
315 | /* only used for initialisation */ |
|
|
316 | coro_func coro; |
|
|
317 | void *arg; |
|
|
318 | }; |
|
|
319 | |
|
|
320 | #endif |
|
|
321 | |
|
|
322 | #if __cplusplus |
|
|
323 | } |
|
|
324 | #endif |
|
|
325 | |
|
|
326 | #endif |
|
|
327 | |