ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.h
(Generate patch)

Comparing libcoro/coro.h (file contents):
Revision 1.2 by root, Mon Jul 23 18:04:59 2001 UTC vs.
Revision 1.42 by root, Sat Jul 11 14:24:13 2009 UTC

1/* 1/*
2 * Copyright (c) 2001 Marc Alexander Lehmann <pcg@goof.com> 2 * Copyright (c) 2001-2009 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.
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).
35 */ 72 */
36 73
37#ifndef CORO_H 74#ifndef CORO_H
38#define CORO_H 75#define CORO_H
39 76
77#define CORO_VERSION 2
78
79/*
80 * Changes since API version 1:
81 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
82 */
83
40/* 84/*
41 * This library consists of only three files 85 * This library consists of only three files
42 * coro.h, coro.c and LICENSE 86 * coro.h, coro.c and LICENSE (and optionally README)
43 * 87 *
44 * It implements what is known as coroutines, in a hopefully 88 * It implements what is known as coroutines, in a hopefully
45 * portable way. At the moment you have to define which kind 89 * portable way. At the moment you have to define which kind
46 * of implementation flavour you want: 90 * of implementation flavour you want:
47 * 91 *
48 * -DCORO_UCONTEXT 92 * -DCORO_UCONTEXT
49 * 93 *
50 * This flavour uses SUSv2's get/set/swap/makecontext functions that 94 * This flavour uses SUSv2's get/set/swap/makecontext functions that
51 * unfortunately only newer unices support. 95 * unfortunately only newer unices support.
52 * Use this for GNU/Linux + glibc-2.2.3.
53 * 96 *
54 * -DCORO_SJLJ 97 * -DCORO_SJLJ
55 * 98 *
56 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 99 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
57 * do it's job. Coroutine creation is much slower than UCONTEXT, but 100 * 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 101 * 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 102 * all unices.
60 * do not work with any model (neither sigaltstack nor context functions
61 * are implemented)
62 * 103 *
104 * -DCORO_LINUX
105 *
106 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
107 * (it is very fast and therefore recommended over other methods, but
108 * doesn't work with anything newer).
109 *
63 * -DCORO_LOOSE 110 * -DCORO_LOSER
64 * 111 *
65 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 112 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
66 * this automatically selects a suitable workaround for this platform. 113 * this automatically selects a suitable workaround for this platform.
67 * (untested) 114 * (untested)
68 * 115 *
116 * -DCORO_IRIX
117 *
118 * SGI's version of Microsoft's NT ;)
119 *
120 * -DCORO_ASM
121 *
122 * Handcoded assembly, known to work only on a few architectures/ABI:
123 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs.
124 *
125 * -DCORO_PTHREAD
126 *
127 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
128 * This is likely the slowest backend, and it also does not support fork(),
129 * so avoid it at all costs.
130 *
69 * If you define neither of these symbols, coro.h will try to autodetect 131 * If you define neither of these symbols, coro.h will try to autodetect
70 * the model. This currently works for CORO_LOOSE only. For the other 132 * the model. This currently works for CORO_LOSER only. For the other
71 * alternatives you should check (e.g. using autoconf) and define the 133 * alternatives you should check (e.g. using autoconf) and define the
72 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 134 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
73 */ 135 */
74 136
75/* 137/*
76 * This is the type for the top function of a new coroutine. 138 * This is the type for the initialization function of a new coroutine.
77 */ 139 */
78typedef void (*coro_func)(void *); 140typedef void (*coro_func)(void *);
79 141
80
81/* 142/*
82 * A coroutine state is saved in the following structure. Treat it as a 143 * A coroutine state is saved in the following structure. Treat it as an
83 * opaque type. errno and sigmask might be saved, but don't rely on it, 144 * opaque type. errno and sigmask might be saved, but don't rely on it,
84 * implement your own switching primitive. 145 * implement your own switching primitive if you need that.
85 */ 146 */
86typedef struct coro_context coro_context; 147typedef struct coro_context coro_context;
87 148
88/* 149/*
89 * This function creates a new coroutine. Apart from a pointer to an 150 * This function creates a new coroutine. Apart from a pointer to an
90 * uninitialized coro_context, it expects a pointer to the entry function 151 * uninitialised coro_context, it expects a pointer to the entry function
91 * and the single pointer value that is given to it as argument. 152 * and the single pointer value that is given to it as argument.
92 * 153 *
93 * Allocating/deallocating the stack is your own responsibility, so there is 154 * Allocating/deallocating the stack is your own responsibility.
94 * no coro_destroy function.
95 */ 155 *
96void coro_create(coro_context *ctx, 156 * As a special case, if coro, arg, sptr and ssize are all zero,
97 coro_func coro, void *arg, 157 * then an "empty" coro_context will be created that is suitable
98 void *sptr, long ssize); 158 * as an initial source for coro_transfer.
159 *
160 * This function is not reentrant, but putting a mutex around it
161 * will work.
162 */
163void coro_create (coro_context *ctx, /* an uninitialised coro_context */
164 coro_func coro, /* the coroutine code to be executed */
165 void *arg, /* a single pointer passed to the coro */
166 void *sptr, /* start of stack area */
167 long ssize); /* size of stack area */
99 168
100/* 169/*
101 * The following prototype defines the coroutine switching function. It is 170 * The following prototype defines the coroutine switching function. It is
102 * usually implemented as a macro, so watch out. 171 * usually implemented as a macro, so watch out.
103 * 172 *
173 * This function is thread-safe and reentrant.
174 */
175#if 0
104void coro_transfer(coro_context *prev, coro_context *next); 176void coro_transfer (coro_context *prev, coro_context *next);
177#endif
178
179/*
180 * The following prototype defines the coroutine destroy function. It is
181 * usually implemented as a macro, so watch out. It also serves
182 * no purpose unless you want to use the CORO_PTHREAD backend,
183 * where it is used to clean up the thread. You are responsible
184 * for freeing the stack and the context itself.
105 */ 185 *
186 * This function is thread-safe and reentrant.
187 */
188#if 0
189void coro_destroy (coro_context *ctx);
190#endif
106 191
107/* 192/*
108 * That was it. No other user-visible functions are implemented here. 193 * That was it. No other user-visible functions are implemented here.
109 */ 194 */
110 195
196/*****************************************************************************/
197
111#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) && !defined(CORO_SJLJ) 198#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
199 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
200 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
201 && !defined(CORO_PTHREAD)
112# if defined(WINDOWS) 202# if defined(WINDOWS)
113# define CORO_LOOSE 1 /* you don't win with windoze */ 203# define CORO_LOSER 1 /* you don't win with windoze */
204# elif defined(__linux) && (defined(__x86) || defined (__amd64))
205# define CORO_ASM 1
114# elif defined(HAVE_UCONTEXT_H) 206# elif defined(HAVE_UCONTEXT_H)
115# define CORO_UCONTEXT 1 207# define CORO_UCONTEXT 1
116# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 208# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
117# define CORO_SJLJ 1 209# define CORO_SJLJ 1
118# else 210# else
119error unknown or unsupported architecture 211error unknown or unsupported architecture
120# endif 212# endif
121#endif 213#endif
122 214
215/*****************************************************************************/
216
123#if CORO_UCONTEXT 217#if CORO_UCONTEXT
124 218
125#include <ucontext.h> 219# include <ucontext.h>
126 220
127struct coro_context { 221struct coro_context {
128 ucontext_t uc; 222 ucontext_t uc;
129}; 223};
130 224
131#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 225# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
226# define coro_destroy(ctx) (void *)(ctx)
132 227
133#elif CORO_SJLJ || CORO_LOOSE 228#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
134 229
230# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
231# define _GNU_SOURCE /* for linux libc */
232# endif
233
234# if !CORO_LOSER
235# include <unistd.h>
236# endif
237
238/* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */
239# if __sun
240# undef _XOPEN_UNIX
241# define _XOPEN_UNIX 1
242# endif
243
135#include <setjmp.h> 244# include <setjmp.h>
136 245
137struct coro_context { 246# if _XOPEN_UNIX > 0 || defined (_setjmp)
138 jmp_buf env; 247# define coro_jmp_buf jmp_buf
139}; 248# define coro_setjmp(env) _setjmp (env)
140 249# define coro_longjmp(env) _longjmp ((env), 1)
141#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) 250# elif CORO_LOSER
142 251# define coro_jmp_buf jmp_buf
252# define coro_setjmp(env) setjmp (env)
253# define coro_longjmp(env) longjmp ((env), 1)
254# else
255# define coro_jmp_buf sigjmp_buf
256# define coro_setjmp(env) sigsetjmp (env, 0)
257# define coro_longjmp(env) siglongjmp ((env), 1)
143#endif 258# endif
144 259
145#endif 260struct coro_context {
261 coro_jmp_buf env;
262};
146 263
264# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
265# define coro_destroy(ctx) (void *)(ctx)
266
267#elif CORO_ASM
268
269struct coro_context {
270 void **sp; /* must be at offset 0 */
271};
272
273void __attribute__ ((__noinline__, __regparm__(2)))
274coro_transfer (coro_context *prev, coro_context *next);
275
276# define coro_destroy(ctx) (void *)(ctx)
277
278#elif CORO_PTHREAD
279
280# include <pthread.h>
281
282extern pthread_mutex_t coro_mutex;
283
284struct coro_context {
285 pthread_cond_t cv;
286 pthread_t id;
287};
288
289void coro_transfer (coro_context *prev, coro_context *next);
290void coro_destroy (coro_context *ctx);
291
292#endif
293
294#endif
295

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines