| 1 | /* |
1 | /* |
| 2 | * Copyright (c) 2001 Marc Alexander Lehmann <pcg@goof.com> |
2 | * Copyright (c) 2001-2008 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 | * |
|
|
| 14 | * 3. The name of the author may not be used to endorse or promote products |
|
|
| 15 | * derived from this software without specific prior written permission. |
|
|
| 16 | * |
13 | * |
| 17 | * 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 |
| 18 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
15 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
| 19 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
16 | * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
| 20 | * 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- |
| … | |
… | |
| 23 | * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
20 | * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| 24 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
21 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
| 25 | * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
22 | * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 26 | * OF THE POSSIBILITY OF SUCH DAMAGE. |
23 | * OF THE POSSIBILITY OF SUCH DAMAGE. |
| 27 | * |
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 | * |
| 28 | * This library is modelled strictly after Ralf S. Engelschalls article at |
36 | * This library is modelled strictly after Ralf S. Engelschalls article at |
| 29 | * http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must |
37 | * http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must |
| 30 | * go to Ralf S. Engelschall <rse@engelschall.com>. |
38 | * go to Ralf S. Engelschall <rse@engelschall.com>. |
| 31 | * |
39 | * |
| 32 | * This coroutine library is very much stripped down. You should either |
40 | * This coroutine library is very much stripped down. You should either |
| 33 | * build your own process avstraction using it or - better - just use GNU |
41 | * build your own process abstraction using it or - better - just use GNU |
| 34 | * Portable Threads, http://www.gnu.org/software/pth/. |
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. |
| 35 | */ |
65 | */ |
| 36 | |
66 | |
| 37 | #ifndef CORO_H |
67 | #ifndef CORO_H |
| 38 | #define CORO_H |
68 | #define CORO_H |
| 39 | |
69 | |
|
|
70 | #define CORO_VERSION 2 |
|
|
71 | |
|
|
72 | /* |
|
|
73 | * Changes since API version 1: |
|
|
74 | * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER |
|
|
75 | */ |
|
|
76 | |
| 40 | /* |
77 | /* |
| 41 | * This library consists of only three files |
78 | * This library consists of only three files |
| 42 | * coro.h, coro.c and LICENSE |
79 | * coro.h, coro.c and LICENSE (and optionally README) |
| 43 | * |
80 | * |
| 44 | * It implements what is known as coroutines, in a hopefully |
81 | * It implements what is known as coroutines, in a hopefully |
| 45 | * portable way. At the moment you have to define which kind |
82 | * portable way. At the moment you have to define which kind |
| 46 | * of implementation flavour you want: |
83 | * of implementation flavour you want: |
| 47 | * |
84 | * |
| 48 | * -DCORO_UCONTEXT |
85 | * -DCORO_UCONTEXT |
| 49 | * |
86 | * |
| 50 | * This flavour uses SUSv2's get/set/swap/makecontext functions that |
87 | * This flavour uses SUSv2's get/set/swap/makecontext functions that |
| 51 | * unfortunately only newer unices support. |
88 | * unfortunately only newer unices support. |
| 52 | * Use this for GNU/Linux + glibc-2.2.3. |
|
|
| 53 | * |
89 | * |
| 54 | * -DCORO_SJLJ |
90 | * -DCORO_SJLJ |
| 55 | * |
91 | * |
| 56 | * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to |
92 | * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to |
| 57 | * do it's job. Coroutine creation is much slower than UCONTEXT, but |
93 | * do it's job. Coroutine creation is much slower than UCONTEXT, but |
| 58 | * context switching is often a bit cheaper. It should work on almost |
94 | * context switching is often a bit cheaper. It should work on almost |
| 59 | * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below |
95 | * all unices. |
| 60 | * do not work with any sane model (neither sigaltstack nor context |
|
|
| 61 | * functions are implemented) |
|
|
| 62 | * |
96 | * |
| 63 | * -DCORO_LINUX |
97 | * -DCORO_LINUX |
| 64 | * |
98 | * |
| 65 | * Old GNU/Linux systems (<= glibc-2.1) work with this implementation |
99 | * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation |
| 66 | * (very fast). |
100 | * (it is very fast and therefore recommended over other methods, but |
|
|
101 | * doesn't work with anything newer). |
| 67 | * |
102 | * |
| 68 | * -DCORO_LOOSE |
103 | * -DCORO_LOSER |
| 69 | * |
104 | * |
| 70 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
105 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
| 71 | * this automatically selects a suitable workaround for this platform. |
106 | * this automatically selects a suitable workaround for this platform. |
| 72 | * (untested) |
107 | * (untested) |
| 73 | * |
108 | * |
|
|
109 | * -DCORO_IRIX |
|
|
110 | * |
|
|
111 | * SGI's version of Microsoft's NT ;) |
|
|
112 | * |
|
|
113 | * -DCORO_ASM |
|
|
114 | * |
|
|
115 | * Handcoded assembly, known to work only on a few architectures/ABI: |
|
|
116 | * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on. |
|
|
117 | * |
|
|
118 | * -DCORO_PTHREAD |
|
|
119 | * |
|
|
120 | * Use the pthread API. You have to provide <pthread.h> and -lpthread. |
|
|
121 | * |
| 74 | * If you define neither of these symbols, coro.h will try to autodetect |
122 | * If you define neither of these symbols, coro.h will try to autodetect |
| 75 | * the model. This currently works for CORO_LOOSE only. For the other |
123 | * the model. This currently works for CORO_LOSER only. For the other |
| 76 | * alternatives you should check (e.g. using autoconf) and define the |
124 | * alternatives you should check (e.g. using autoconf) and define the |
| 77 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
125 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
| 78 | */ |
126 | */ |
| 79 | |
127 | |
| 80 | /* |
128 | /* |
| 81 | * This is the type for the top function of a new coroutine. |
129 | * This is the type for the initialization function of a new coroutine. |
| 82 | */ |
130 | */ |
| 83 | typedef void (*coro_func)(void *); |
131 | typedef void (*coro_func)(void *); |
| 84 | |
132 | |
| 85 | |
|
|
| 86 | /* |
133 | /* |
| 87 | * A coroutine state is saved in the following structure. Treat it as a |
134 | * A coroutine state is saved in the following structure. Treat it as an |
| 88 | * opaque type. errno and sigmask might be saved, but don't rely on it, |
135 | * opaque type. errno and sigmask might be saved, but don't rely on it, |
| 89 | * implement your own switching primitive. |
136 | * implement your own switching primitive if you need that. |
| 90 | */ |
137 | */ |
| 91 | typedef struct coro_context coro_context; |
138 | typedef struct coro_context coro_context; |
| 92 | |
139 | |
| 93 | /* |
140 | /* |
| 94 | * This function creates a new coroutine. Apart from a pointer to an |
141 | * This function creates a new coroutine. Apart from a pointer to an |
| 95 | * uninitialized coro_context, it expects a pointer to the entry function |
142 | * uninitialised coro_context, it expects a pointer to the entry function |
| 96 | * and the single pointer value that is given to it as argument. |
143 | * and the single pointer value that is given to it as argument. |
| 97 | * |
144 | * |
| 98 | * Allocating/deallocating the stack is your own responsibility, so there is |
145 | * Allocating/deallocating the stack is your own responsibility. |
| 99 | * no coro_destroy function. |
|
|
| 100 | */ |
146 | * |
| 101 | void coro_create(coro_context *ctx, |
147 | * As a special case, if coro, arg, sptr and ssize are all zero, |
| 102 | coro_func coro, void *arg, |
148 | * then an "empty" coro_contetx will be created that is suitable |
| 103 | void *sptr, long ssize); |
149 | * as an initial source for coro_transfer. |
|
|
150 | * |
|
|
151 | * This function is not reentrant, but putting a mutex around it |
|
|
152 | * will work. |
|
|
153 | */ |
|
|
154 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
|
|
155 | coro_func coro, /* the coroutine code to be executed */ |
|
|
156 | void *arg, /* a single pointer passed to the coro */ |
|
|
157 | void *sptr, /* start of stack area */ |
|
|
158 | long ssize); /* size of stack area */ |
| 104 | |
159 | |
| 105 | /* |
160 | /* |
| 106 | * The following prototype defines the coroutine switching function. It is |
161 | * The following prototype defines the coroutine switching function. It is |
| 107 | * usually implemented as a macro, so watch out. |
162 | * usually implemented as a macro, so watch out. |
| 108 | * |
163 | * |
|
|
164 | * This function is thread-safe and reentrant. |
|
|
165 | */ |
|
|
166 | #if 0 |
| 109 | void coro_transfer(coro_context *prev, coro_context *next); |
167 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
168 | #endif |
|
|
169 | |
|
|
170 | /* |
|
|
171 | * The following prototype defines the coroutine destroy function. It is |
|
|
172 | * usually implemented as a macro, so watch out. It also serves |
|
|
173 | * no purpose unless you want to use the CORO_PTHREAD backend. |
| 110 | */ |
174 | * |
|
|
175 | * This function is thread-safe and reentrant. |
|
|
176 | */ |
|
|
177 | #if 0 |
|
|
178 | void coro_destroy (coro_context *ctx); |
|
|
179 | #endif |
| 111 | |
180 | |
| 112 | /* |
181 | /* |
| 113 | * That was it. No other user-visible functions are implemented here. |
182 | * That was it. No other user-visible functions are implemented here. |
| 114 | */ |
183 | */ |
| 115 | |
184 | |
|
|
185 | /*****************************************************************************/ |
|
|
186 | |
| 116 | #if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \ |
187 | #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
| 117 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) |
188 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
|
|
189 | && !defined(CORO_IRIX) && !defined(CORO_ASM) \ |
|
|
190 | && !defined(CORO_PTHREAD) |
| 118 | # if defined(WINDOWS) |
191 | # if defined(WINDOWS) |
| 119 | # define CORO_LOOSE 1 /* you don't win with windoze */ |
192 | # define CORO_LOSER 1 /* you don't win with windoze */ |
| 120 | # elif defined(__linux) && defined(__x86) |
193 | # elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
|
|
194 | # define CORO_ASM 1 |
| 121 | # elif defined(HAVE_UCONTEXT_H) |
195 | # elif defined(HAVE_UCONTEXT_H) |
| 122 | # define CORO_UCONTEXT 1 |
196 | # define CORO_UCONTEXT 1 |
| 123 | # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
197 | # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
| 124 | # define CORO_SJLJ 1 |
198 | # define CORO_SJLJ 1 |
| 125 | # else |
199 | # else |
| 126 | error unknown or unsupported architecture |
200 | error unknown or unsupported architecture |
| 127 | # endif |
201 | # endif |
| 128 | #endif |
202 | #endif |
| 129 | |
203 | |
|
|
204 | /*****************************************************************************/ |
|
|
205 | |
| 130 | #if CORO_UCONTEXT |
206 | #if CORO_UCONTEXT |
| 131 | |
207 | |
| 132 | #include <ucontext.h> |
208 | # include <ucontext.h> |
| 133 | |
209 | |
| 134 | struct coro_context { |
210 | struct coro_context { |
| 135 | ucontext_t uc; |
211 | ucontext_t uc; |
| 136 | }; |
212 | }; |
| 137 | |
213 | |
| 138 | #define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) |
214 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
|
|
215 | # define coro_destroy(ctx) (void *)(ctx) |
| 139 | |
216 | |
| 140 | #elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX |
217 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
| 141 | |
218 | |
|
|
219 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
|
|
220 | # define _GNU_SOURCE /* for linux libc */ |
|
|
221 | # endif |
|
|
222 | |
| 142 | #include <setjmp.h> |
223 | # include <setjmp.h> |
| 143 | |
224 | |
| 144 | struct coro_context { |
225 | struct coro_context { |
| 145 | jmp_buf env; |
226 | jmp_buf env; |
| 146 | }; |
227 | }; |
| 147 | |
228 | |
|
|
229 | # if CORO_LINUX || (_XOPEN_SOURCE >= 600) |
| 148 | #define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) |
230 | # define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) |
| 149 | |
231 | # else |
|
|
232 | # define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) |
| 150 | #endif |
233 | # endif |
| 151 | |
234 | |
| 152 | #endif |
235 | # define coro_destroy(ctx) (void *)(ctx) |
| 153 | |
236 | |
|
|
237 | #elif CORO_ASM |
|
|
238 | |
|
|
239 | struct coro_context { |
|
|
240 | volatile void **sp; /* must be at offset 0 */ |
|
|
241 | }; |
|
|
242 | |
|
|
243 | void __attribute__ ((__noinline__, __regparm__(2))) |
|
|
244 | coro_transfer (coro_context *prev, coro_context *next); |
|
|
245 | |
|
|
246 | # define coro_destroy(ctx) (void *)(ctx) |
|
|
247 | |
|
|
248 | #elif CORO_PTHREAD |
|
|
249 | |
|
|
250 | # include <pthread.h> |
|
|
251 | |
|
|
252 | extern pthread_mutex_t coro_mutex; |
|
|
253 | |
|
|
254 | struct coro_context { |
|
|
255 | pthread_cond_t cv; |
|
|
256 | pthread_t id; |
|
|
257 | }; |
|
|
258 | |
|
|
259 | void coro_transfer (coro_context *prev, coro_context *next); |
|
|
260 | void coro_destroy (coro_context *ctx); |
|
|
261 | |
|
|
262 | #endif |
|
|
263 | |
|
|
264 | #endif |
|
|
265 | |
