1 |
/* |
2 |
* Copyright (c) 2001-2008 Marc Alexander Lehmann <schmorp@schmorp.de> |
3 |
* |
4 |
* Redistribution and use in source and binary forms, with or without modifica- |
5 |
* tion, are permitted provided that the following conditions are met: |
6 |
* |
7 |
* 1. Redistributions of source code must retain the above copyright notice, |
8 |
* this list of conditions and the following disclaimer. |
9 |
* |
10 |
* 2. Redistributions in binary form must reproduce the above copyright |
11 |
* notice, this list of conditions and the following disclaimer in the |
12 |
* documentation and/or other materials provided with the distribution. |
13 |
* |
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- |
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- |
18 |
* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
19 |
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
20 |
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
21 |
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
22 |
* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
23 |
* OF THE POSSIBILITY OF SUCH DAMAGE. |
24 |
* |
25 |
* Alternatively, the contents of this file may be used under the terms of |
26 |
* the GNU General Public License ("GPL") version 2 or any later version, |
27 |
* in which case the provisions of the GPL are applicable instead of |
28 |
* the above. If you wish to allow the use of your version of this file |
29 |
* only under the terms of the GPL and not to allow others to use your |
30 |
* version of this file under the BSD license, indicate your decision |
31 |
* by deleting the provisions above and replace them with the notice |
32 |
* and other provisions required by the GPL. If you do not delete the |
33 |
* provisions above, a recipient may use your version of this file under |
34 |
* either the BSD or the GPL. |
35 |
* |
36 |
* This library is modelled strictly after Ralf S. Engelschalls article at |
37 |
* http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must |
38 |
* go to Ralf S. Engelschall <rse@engelschall.com>. |
39 |
* |
40 |
* This coroutine library is very much stripped down. You should either |
41 |
* build your own process abstraction using it or - better - just use GNU |
42 |
* Portable Threads, http://www.gnu.org/software/pth/. |
43 |
* |
44 |
*/ |
45 |
|
46 |
/* |
47 |
* 2006-10-26 Include stddef.h on OS X to work around one of its bugs. |
48 |
* Reported by Michael_G_Schwern. |
49 |
* 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux. |
50 |
* 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected. |
51 |
* Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600. |
52 |
* 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance |
53 |
* on SIGUSR2 and sigaltstack in Crossfire). |
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. |
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 |
*/ |
72 |
|
73 |
#ifndef CORO_H |
74 |
#define CORO_H |
75 |
|
76 |
#define CORO_VERSION 2 |
77 |
|
78 |
/* |
79 |
* Changes since API version 1: |
80 |
* replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER |
81 |
*/ |
82 |
|
83 |
/* |
84 |
* This library consists of only three files |
85 |
* coro.h, coro.c and LICENSE (and optionally README) |
86 |
* |
87 |
* It implements what is known as coroutines, in a hopefully |
88 |
* portable way. At the moment you have to define which kind |
89 |
* of implementation flavour you want: |
90 |
* |
91 |
* -DCORO_UCONTEXT |
92 |
* |
93 |
* This flavour uses SUSv2's get/set/swap/makecontext functions that |
94 |
* unfortunately only newer unices support. |
95 |
* |
96 |
* -DCORO_SJLJ |
97 |
* |
98 |
* This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to |
99 |
* do it's job. Coroutine creation is much slower than UCONTEXT, but |
100 |
* context switching is often a bit cheaper. It should work on almost |
101 |
* all unices. |
102 |
* |
103 |
* -DCORO_LINUX |
104 |
* |
105 |
* Old GNU/Linux systems (<= glibc-2.1) only work with this implementation |
106 |
* (it is very fast and therefore recommended over other methods, but |
107 |
* doesn't work with anything newer). |
108 |
* |
109 |
* -DCORO_LOSER |
110 |
* |
111 |
* Microsoft's highly proprietary platform doesn't support sigaltstack, and |
112 |
* this automatically selects a suitable workaround for this platform. |
113 |
* (untested) |
114 |
* |
115 |
* -DCORO_IRIX |
116 |
* |
117 |
* SGI's version of Microsoft's NT ;) |
118 |
* |
119 |
* -DCORO_ASM |
120 |
* |
121 |
* Handcoded assembly, known to work only on a few architectures/ABI: |
122 |
* GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs. |
123 |
* |
124 |
* -DCORO_PTHREAD |
125 |
* |
126 |
* Use the pthread API. You have to provide <pthread.h> and -lpthread. |
127 |
* This is likely the slowest backend, and it also does not support fork(), |
128 |
* so avoid it at all costs. |
129 |
* |
130 |
* If you define neither of these symbols, coro.h will try to autodetect |
131 |
* the model. This currently works for CORO_LOSER only. For the other |
132 |
* alternatives you should check (e.g. using autoconf) and define the |
133 |
* following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
134 |
*/ |
135 |
|
136 |
/* |
137 |
* This is the type for the initialization function of a new coroutine. |
138 |
*/ |
139 |
typedef void (*coro_func)(void *); |
140 |
|
141 |
/* |
142 |
* A coroutine state is saved in the following structure. Treat it as an |
143 |
* opaque type. errno and sigmask might be saved, but don't rely on it, |
144 |
* implement your own switching primitive if you need that. |
145 |
*/ |
146 |
typedef struct coro_context coro_context; |
147 |
|
148 |
/* |
149 |
* This function creates a new coroutine. Apart from a pointer to an |
150 |
* uninitialised coro_context, it expects a pointer to the entry function |
151 |
* and the single pointer value that is given to it as argument. |
152 |
* |
153 |
* Allocating/deallocating the stack is your own responsibility. |
154 |
* |
155 |
* As a special case, if coro, arg, sptr and ssize are all zero, |
156 |
* then an "empty" coro_context will be created that is suitable |
157 |
* as an initial source for coro_transfer. |
158 |
* |
159 |
* This function is not reentrant, but putting a mutex around it |
160 |
* will work. |
161 |
*/ |
162 |
void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
163 |
coro_func coro, /* the coroutine code to be executed */ |
164 |
void *arg, /* a single pointer passed to the coro */ |
165 |
void *sptr, /* start of stack area */ |
166 |
long ssize); /* size of stack area */ |
167 |
|
168 |
/* |
169 |
* The following prototype defines the coroutine switching function. It is |
170 |
* usually implemented as a macro, so watch out. |
171 |
* |
172 |
* This function is thread-safe and reentrant. |
173 |
*/ |
174 |
#if 0 |
175 |
void coro_transfer (coro_context *prev, coro_context *next); |
176 |
#endif |
177 |
|
178 |
/* |
179 |
* The following prototype defines the coroutine destroy function. It is |
180 |
* usually implemented as a macro, so watch out. It also serves |
181 |
* no purpose unless you want to use the CORO_PTHREAD backend, |
182 |
* where it is used to clean up the thread. You are responsible |
183 |
* for freeing the stack and the context itself. |
184 |
* |
185 |
* This function is thread-safe and reentrant. |
186 |
*/ |
187 |
#if 0 |
188 |
void coro_destroy (coro_context *ctx); |
189 |
#endif |
190 |
|
191 |
/* |
192 |
* That was it. No other user-visible functions are implemented here. |
193 |
*/ |
194 |
|
195 |
/*****************************************************************************/ |
196 |
|
197 |
#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
198 |
&& !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
199 |
&& !defined(CORO_IRIX) && !defined(CORO_ASM) \ |
200 |
&& !defined(CORO_PTHREAD) |
201 |
# if defined(WINDOWS) |
202 |
# define CORO_LOSER 1 /* you don't win with windoze */ |
203 |
# elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
204 |
# define CORO_ASM 1 |
205 |
# elif defined(HAVE_UCONTEXT_H) |
206 |
# define CORO_UCONTEXT 1 |
207 |
# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
208 |
# define CORO_SJLJ 1 |
209 |
# else |
210 |
error unknown or unsupported architecture |
211 |
# endif |
212 |
#endif |
213 |
|
214 |
/*****************************************************************************/ |
215 |
|
216 |
#if CORO_UCONTEXT |
217 |
|
218 |
# include <ucontext.h> |
219 |
|
220 |
struct coro_context { |
221 |
ucontext_t uc; |
222 |
}; |
223 |
|
224 |
# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
225 |
# define coro_destroy(ctx) (void *)(ctx) |
226 |
|
227 |
#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
228 |
|
229 |
# if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
230 |
# define _GNU_SOURCE /* for linux libc */ |
231 |
# endif |
232 |
|
233 |
# if !CORO_LOSER |
234 |
# include <unistd.h> |
235 |
# endif |
236 |
|
237 |
/* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */ |
238 |
# if __sun |
239 |
# undef _XOPEN_UNIX |
240 |
# define _XOPEN_UNIX 1 |
241 |
# endif |
242 |
|
243 |
# include <setjmp.h> |
244 |
|
245 |
# if _XOPEN_UNIX > 0 || defined (_setjmp) |
246 |
# define coro_jmp_buf jmp_buf |
247 |
# define coro_setjmp(env) _setjmp (env) |
248 |
# define coro_longjmp(env) _longjmp ((env), 1) |
249 |
# elif CORO_LOSER |
250 |
# define coro_jmp_buf jmp_buf |
251 |
# define coro_setjmp(env) setjmp (env) |
252 |
# define coro_longjmp(env) longjmp ((env), 1) |
253 |
# else |
254 |
# define coro_jmp_buf sigjmp_buf |
255 |
# define coro_setjmp(env) sigsetjmp (env, 0) |
256 |
# define coro_longjmp(env) siglongjmp ((env), 1) |
257 |
# endif |
258 |
|
259 |
struct coro_context { |
260 |
coro_jmp_buf env; |
261 |
}; |
262 |
|
263 |
# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0) |
264 |
# define coro_destroy(ctx) (void *)(ctx) |
265 |
|
266 |
#elif CORO_ASM |
267 |
|
268 |
struct coro_context { |
269 |
void **sp; /* must be at offset 0 */ |
270 |
}; |
271 |
|
272 |
void __attribute__ ((__noinline__, __regparm__(2))) |
273 |
coro_transfer (coro_context *prev, coro_context *next); |
274 |
|
275 |
# define coro_destroy(ctx) (void *)(ctx) |
276 |
|
277 |
#elif CORO_PTHREAD |
278 |
|
279 |
# include <pthread.h> |
280 |
|
281 |
extern pthread_mutex_t coro_mutex; |
282 |
|
283 |
struct coro_context { |
284 |
pthread_cond_t cv; |
285 |
pthread_t id; |
286 |
}; |
287 |
|
288 |
void coro_transfer (coro_context *prev, coro_context *next); |
289 |
void coro_destroy (coro_context *ctx); |
290 |
|
291 |
#endif |
292 |
|
293 |
#endif |
294 |
|