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/. |
35 | * |
43 | * |
36 | * VERSION: 0.1 |
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). |
37 | */ |
58 | */ |
38 | |
59 | |
39 | #ifndef CORO_H |
60 | #ifndef CORO_H |
40 | #define CORO_H |
61 | #define CORO_H |
41 | |
62 | |
|
|
63 | #define CORO_VERSION 2 |
|
|
64 | |
|
|
65 | /* |
|
|
66 | * Changes since API version 1: |
|
|
67 | * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER |
|
|
68 | */ |
|
|
69 | |
42 | /* |
70 | /* |
43 | * This library consists of only three files |
71 | * This library consists of only three files |
44 | * coro.h, coro.c and LICENSE |
72 | * coro.h, coro.c and LICENSE (and optionally README) |
45 | * |
73 | * |
46 | * It implements what is known as coroutines, in a hopefully |
74 | * It implements what is known as coroutines, in a hopefully |
47 | * portable way. At the moment you have to define which kind |
75 | * portable way. At the moment you have to define which kind |
48 | * of implementation flavour you want: |
76 | * of implementation flavour you want: |
49 | * |
77 | * |
50 | * -DCORO_UCONTEXT |
78 | * -DCORO_UCONTEXT |
51 | * |
79 | * |
52 | * This flavour uses SUSv2's get/set/swap/makecontext functions that |
80 | * This flavour uses SUSv2's get/set/swap/makecontext functions that |
53 | * unfortunately only newer unices support. |
81 | * unfortunately only newer unices support. |
54 | * Use this for GNU/Linux + glibc-2.2.3. |
|
|
55 | * |
82 | * |
56 | * -DCORO_SJLJ |
83 | * -DCORO_SJLJ |
57 | * |
84 | * |
58 | * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to |
85 | * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to |
59 | * do it's job. Coroutine creation is much slower than UCONTEXT, but |
86 | * do it's job. Coroutine creation is much slower than UCONTEXT, but |
60 | * context switching is often a bit cheaper. It should work on almost |
87 | * context switching is often a bit cheaper. It should work on almost |
61 | * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below |
88 | * all unices. |
62 | * do not work with any sane model (neither sigaltstack nor context |
|
|
63 | * functions are implemented) |
|
|
64 | * |
89 | * |
65 | * -DCORO_LINUX |
90 | * -DCORO_LINUX |
66 | * |
91 | * |
67 | * Old GNU/Linux systems (<= glibc-2.1) work with this implementation |
92 | * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation |
68 | * (very fast). |
93 | * (it is very fast and therefore recommended over other methods, but |
|
|
94 | * doesn't work with anything newer). |
69 | * |
95 | * |
70 | * -DCORO_LOOSE |
96 | * -DCORO_LOSER |
71 | * |
97 | * |
72 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
98 | * Microsoft's highly proprietary platform doesn't support sigaltstack, and |
73 | * this automatically selects a suitable workaround for this platform. |
99 | * this automatically selects a suitable workaround for this platform. |
74 | * (untested) |
100 | * (untested) |
75 | * |
101 | * |
76 | * -DCORO_IRIX |
102 | * -DCORO_IRIX |
77 | * |
103 | * |
78 | * SGI's version of Microsoft's NT ;) |
104 | * SGI's version of Microsoft's NT ;) |
79 | * |
105 | * |
|
|
106 | * -DCORO_ASM |
|
|
107 | * |
|
|
108 | * Handcoded assembly, known to work only on a few architectures/ABI: |
|
|
109 | * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on. |
|
|
110 | * |
|
|
111 | * -DCORO_PTHREAD |
|
|
112 | * |
|
|
113 | * Use the pthread API. You have to provide <pthread.h> and -lpthread. |
|
|
114 | * |
80 | * If you define neither of these symbols, coro.h will try to autodetect |
115 | * If you define neither of these symbols, coro.h will try to autodetect |
81 | * the model. This currently works for CORO_LOOSE only. For the other |
116 | * the model. This currently works for CORO_LOSER only. For the other |
82 | * alternatives you should check (e.g. using autoconf) and define the |
117 | * alternatives you should check (e.g. using autoconf) and define the |
83 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
118 | * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
84 | */ |
119 | */ |
85 | |
120 | |
86 | /* |
121 | /* |
87 | * This is the type for the initialization function of a new coroutine. |
122 | * This is the type for the initialization function of a new coroutine. |
88 | */ |
123 | */ |
89 | typedef void (*coro_func)(void *); |
124 | typedef void (*coro_func)(void *); |
90 | |
125 | |
91 | /* |
126 | /* |
92 | * A coroutine state is saved in the following structure. Treat it as a |
127 | * A coroutine state is saved in the following structure. Treat it as an |
93 | * opaque type. errno and sigmask might be saved, but don't rely on it, |
128 | * opaque type. errno and sigmask might be saved, but don't rely on it, |
94 | * implement your own switching primitive. |
129 | * implement your own switching primitive if you need that. |
95 | */ |
130 | */ |
96 | typedef struct coro_context coro_context; |
131 | typedef struct coro_context coro_context; |
97 | |
132 | |
98 | /* |
133 | /* |
99 | * This function creates a new coroutine. Apart from a pointer to an |
134 | * This function creates a new coroutine. Apart from a pointer to an |
100 | * uninitialized coro_context, it expects a pointer to the entry function |
135 | * uninitialised coro_context, it expects a pointer to the entry function |
101 | * and the single pointer value that is given to it as argument. |
136 | * and the single pointer value that is given to it as argument. |
102 | * |
137 | * |
103 | * Allocating/deallocating the stack is your own responsibility, so there is |
138 | * Allocating/deallocating the stack is your own responsibility, so there is |
104 | * no coro_destroy function. |
139 | * no coro_destroy function. |
105 | */ |
140 | */ |
106 | void coro_create(coro_context *ctx, |
141 | void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
107 | coro_func coro, void *arg, |
142 | coro_func coro, /* the coroutine code to be executed */ |
108 | void *sptr, long ssize); |
143 | void *arg, /* a single pointer passed to the coro */ |
|
|
144 | void *sptr, /* start of stack area */ |
|
|
145 | long ssize); /* size of stack area */ |
109 | |
146 | |
110 | /* |
147 | /* |
111 | * The following prototype defines the coroutine switching function. It is |
148 | * The following prototype defines the coroutine switching function. It is |
112 | * usually implemented as a macro, so watch out. |
149 | * usually implemented as a macro, so watch out. |
113 | * |
150 | * |
… | |
… | |
118 | * That was it. No other user-visible functions are implemented here. |
155 | * That was it. No other user-visible functions are implemented here. |
119 | */ |
156 | */ |
120 | |
157 | |
121 | /*****************************************************************************/ |
158 | /*****************************************************************************/ |
122 | |
159 | |
123 | #if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \ |
160 | #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
124 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
161 | && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
|
|
162 | && !defined(CORO_IRIX) && !defined(CORO_ASM) \ |
125 | && !defined(CORO_IRIX) |
163 | && !defined(CORO_PTHREAD) |
126 | # if defined(WINDOWS) |
164 | # if defined(WINDOWS) |
127 | # define CORO_LOOSE 1 /* you don't win with windoze */ |
165 | # define CORO_LOSER 1 /* you don't win with windoze */ |
128 | # elif defined(__linux) && defined(__x86) |
166 | # elif defined(__linux) && (defined(__x86) || defined (__amd64)) |
|
|
167 | # define CORO_ASM 1 |
129 | # elif defined(HAVE_UCONTEXT_H) |
168 | # elif defined(HAVE_UCONTEXT_H) |
130 | # define CORO_UCONTEXT 1 |
169 | # define CORO_UCONTEXT 1 |
131 | # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
170 | # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
132 | # define CORO_SJLJ 1 |
171 | # define CORO_SJLJ 1 |
133 | # else |
172 | # else |
… | |
… | |
137 | |
176 | |
138 | /*****************************************************************************/ |
177 | /*****************************************************************************/ |
139 | |
178 | |
140 | #if CORO_UCONTEXT |
179 | #if CORO_UCONTEXT |
141 | |
180 | |
142 | #include <ucontext.h> |
181 | # include <ucontext.h> |
143 | |
182 | |
144 | struct coro_context { |
183 | struct coro_context { |
145 | ucontext_t uc; |
184 | ucontext_t uc; |
146 | }; |
185 | }; |
147 | |
186 | |
148 | #define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) |
187 | # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
149 | |
188 | |
150 | #elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX || CORO_IRIX |
189 | #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
151 | |
190 | |
|
|
191 | # if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
|
|
192 | # define _GNU_SOURCE /* for linux libc */ |
|
|
193 | # endif |
|
|
194 | |
152 | #include <setjmp.h> |
195 | # include <setjmp.h> |
153 | |
196 | |
154 | struct coro_context { |
197 | struct coro_context { |
155 | jmp_buf env; |
198 | jmp_buf env; |
156 | }; |
199 | }; |
157 | |
200 | |
|
|
201 | # if CORO_LINUX || (_XOPEN_SOURCE >= 600) |
158 | #define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) |
202 | # define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) |
|
|
203 | # else |
|
|
204 | # define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) |
|
|
205 | # endif |
|
|
206 | |
|
|
207 | #elif CORO_ASM |
|
|
208 | |
|
|
209 | struct coro_context { |
|
|
210 | volatile void **sp; |
|
|
211 | }; |
|
|
212 | |
|
|
213 | void __attribute__ ((__noinline__, __fastcall__)) |
|
|
214 | coro_transfer (coro_context *prev, coro_context *next); |
|
|
215 | |
|
|
216 | #elif CORO_PTHREAD |
|
|
217 | |
|
|
218 | #include <pthread.h> |
|
|
219 | |
|
|
220 | extern pthread_mutex_t coro_mutex; |
|
|
221 | |
|
|
222 | struct coro_context { |
|
|
223 | pthread_cond_t c; |
|
|
224 | }; |
|
|
225 | |
|
|
226 | void coro_transfer (coro_context *prev, coro_context *next); |
159 | |
227 | |
160 | #endif |
228 | #endif |
161 | |
229 | |
162 | #endif |
230 | #endif |
163 | |
231 | |