ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.h
Revision: 1.49
Committed: Sun Jul 3 10:51:42 2011 UTC (12 years, 11 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-6_05, rel-6_04, rel-6_03, rel-6_02, rel-6_01
Changes since 1.48: +1 -0 lines
Log Message:
6.01

File Contents

# Content
1 /*
2 * Copyright (c) 2001-2009 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 * 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 */
78
79 #ifndef CORO_H
80 #define CORO_H
81
82 #if __cplusplus
83 extern "C" {
84 #endif
85
86 #define CORO_VERSION 2
87
88 /*
89 * Changes since API version 1:
90 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
91 */
92
93 /*
94 * This library consists of only three files
95 * coro.h, coro.c and LICENSE (and optionally README)
96 *
97 * It implements what is known as coroutines, in a hopefully
98 * portable way. At the moment you have to define which kind
99 * of implementation flavour you want:
100 *
101 * -DCORO_UCONTEXT
102 *
103 * This flavour uses SUSv2's get/set/swap/makecontext functions that
104 * unfortunately only newer unices support.
105 *
106 * -DCORO_SJLJ
107 *
108 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
109 * do it's job. Coroutine creation is much slower than UCONTEXT, but
110 * context switching is often a bit cheaper. It should work on almost
111 * all unices.
112 *
113 * -DCORO_LINUX
114 *
115 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
116 * (it is very fast and therefore recommended over other methods, but
117 * doesn't work with anything newer).
118 *
119 * -DCORO_LOSER
120 *
121 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
122 * this automatically selects a suitable workaround for this platform.
123 * (untested)
124 *
125 * -DCORO_IRIX
126 *
127 * SGI's version of Microsoft's NT ;)
128 *
129 * -DCORO_ASM
130 *
131 * Handcoded assembly, known to work only on a few architectures/ABI:
132 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs.
133 *
134 * -DCORO_PTHREAD
135 *
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.
139 *
140 * If you define neither of these symbols, coro.h will try to autodetect
141 * the model. This currently works for CORO_LOSER only. For the other
142 * alternatives you should check (e.g. using autoconf) and define the
143 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
144 */
145
146 /*
147 * This is the type for the initialization function of a new coroutine.
148 */
149 typedef void (*coro_func)(void *);
150
151 /*
152 * A coroutine state is saved in the following structure. Treat it as an
153 * opaque type. errno and sigmask might be saved, but don't rely on it,
154 * implement your own switching primitive if you need that.
155 */
156 typedef struct coro_context coro_context;
157
158 /*
159 * This function creates a new coroutine. Apart from a pointer to an
160 * uninitialised coro_context, it expects a pointer to the entry function
161 * and the single pointer value that is given to it as argument.
162 *
163 * Allocating/deallocating the stack is your own responsibility.
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.
171 */
172 void coro_create (coro_context *ctx, /* an uninitialised coro_context */
173 coro_func coro, /* the coroutine code to be executed */
174 void *arg, /* a single pointer passed to the coro */
175 void *sptr, /* start of stack area */
176 long ssize); /* size of stack area */
177
178 /*
179 * The following prototype defines the coroutine switching function. It is
180 * usually implemented as a macro, so watch out.
181 *
182 * This function is thread-safe and reentrant.
183 */
184 #if 0
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.
194 *
195 * This function is thread-safe and reentrant.
196 */
197 #if 0
198 void coro_destroy (coro_context *ctx);
199 #endif
200
201 /*
202 * That was it. No other user-visible functions are implemented here.
203 */
204
205 /*****************************************************************************/
206
207 #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
208 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
209 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
210 && !defined(CORO_PTHREAD)
211 # if defined(WINDOWS) || defined(_WIN32)
212 # define CORO_LOSER 1 /* you don't win with windoze */
213 # elif defined(__linux) && (defined(__x86) || defined (__amd64))
214 # define CORO_ASM 1
215 # elif defined(HAVE_UCONTEXT_H)
216 # define CORO_UCONTEXT 1
217 # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
218 # define CORO_SJLJ 1
219 # else
220 error unknown or unsupported architecture
221 # endif
222 #endif
223
224 /*****************************************************************************/
225
226 #if CORO_UCONTEXT
227
228 # include <ucontext.h>
229
230 struct coro_context {
231 ucontext_t uc;
232 };
233
234 # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
235 # define coro_destroy(ctx) (void *)(ctx)
236
237 #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
238
239 # if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
240 # define _GNU_SOURCE /* for linux libc */
241 # endif
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
253 # include <setjmp.h>
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
269 struct coro_context {
270 coro_jmp_buf env;
271 };
272
273 # define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
274 # define coro_destroy(ctx) (void *)(ctx)
275
276 #elif CORO_ASM
277
278 struct coro_context {
279 void **sp; /* must be at offset 0 */
280 };
281
282 void __attribute__ ((__noinline__, __regparm__(2)))
283 coro_transfer (coro_context *prev, coro_context *next);
284
285 # define coro_destroy(ctx) (void *)(ctx)
286
287 #elif CORO_PTHREAD
288
289 # include <pthread.h>
290
291 extern pthread_mutex_t coro_mutex;
292
293 struct coro_context {
294 pthread_cond_t cv;
295 pthread_t id;
296 };
297
298 void coro_transfer (coro_context *prev, coro_context *next);
299 void coro_destroy (coro_context *ctx);
300
301 #endif
302
303 #if __cplusplus
304 }
305 #endif
306
307 #endif
308