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

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

Diff Legend

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