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

Comparing libcoro/coro.h (file contents):
Revision 1.12 by root, Sat Aug 20 01:07:45 2005 UTC vs.
Revision 1.45 by root, Mon May 30 02:21:54 2011 UTC

1/* 1/*
2 * Copyright (c) 2001-2005 Marc Alexander Lehmann <schmorp@schmorp.de> 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 abstraction 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 */ 44 */
37 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 */
75
38#ifndef CORO_H 76#ifndef CORO_H
39#define CORO_H 77#define CORO_H
78
79#if __cplusplus
80extern "C" {
81#endif
40 82
41#define CORO_VERSION 2 83#define CORO_VERSION 2
42 84
43/* 85/*
44 * Changes since API version 1: 86 * Changes since API version 1:
… …
55 * 97 *
56 * -DCORO_UCONTEXT 98 * -DCORO_UCONTEXT
57 * 99 *
58 * This flavour uses SUSv2's get/set/swap/makecontext functions that 100 * This flavour uses SUSv2's get/set/swap/makecontext functions that
59 * unfortunately only newer unices support. 101 * unfortunately only newer unices support.
60 * Use this for GNU/Linux + glibc-2.2.3.
61 * 102 *
62 * -DCORO_SJLJ 103 * -DCORO_SJLJ
63 * 104 *
64 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 105 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
65 * do it's job. Coroutine creation is much slower than UCONTEXT, but 106 * do it's job. Coroutine creation is much slower than UCONTEXT, but
66 * context switching is often a bit cheaper. It should work on almost 107 * context switching is often a bit cheaper. It should work on almost
67 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below 108 * all unices.
68 * do not work with any sane model (neither sigaltstack nor context
69 * functions are implemented)
70 * 109 *
71 * -DCORO_LINUX 110 * -DCORO_LINUX
72 * 111 *
73 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 112 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
74 * (very fast). 113 * (it is very fast and therefore recommended over other methods, but
114 * doesn't work with anything newer).
75 * 115 *
76 * -DCORO_LOSER 116 * -DCORO_LOSER
77 * 117 *
78 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 118 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
79 * this automatically selects a suitable workaround for this platform. 119 * this automatically selects a suitable workaround for this platform.
… …
81 * 121 *
82 * -DCORO_IRIX 122 * -DCORO_IRIX
83 * 123 *
84 * SGI's version of Microsoft's NT ;) 124 * SGI's version of Microsoft's NT ;)
85 * 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 *
86 * If you define neither of these symbols, coro.h will try to autodetect 137 * If you define neither of these symbols, coro.h will try to autodetect
87 * the model. This currently works for CORO_LOSER only. For the other 138 * the model. This currently works for CORO_LOSER only. For the other
88 * alternatives you should check (e.g. using autoconf) and define the 139 * alternatives you should check (e.g. using autoconf) and define the
89 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 140 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
90 */ 141 */
91 142
92/* 143/*
93 * This is the type for the initialization function of a new coroutine. 144 * This is the type for the initialization function of a new coroutine.
94 */ 145 */
95typedef void (*coro_func)(void *); 146typedef void (*coro_func)(void *);
96 147
97/* 148/*
98 * A coroutine state is saved in the following structure. Treat it as a 149 * A coroutine state is saved in the following structure. Treat it as an
99 * opaque type. errno and sigmask might be saved, but don't rely on it, 150 * opaque type. errno and sigmask might be saved, but don't rely on it,
100 * implement your own switching primitive. 151 * implement your own switching primitive if you need that.
101 */ 152 */
102typedef struct coro_context coro_context; 153typedef struct coro_context coro_context;
103 154
104/* 155/*
105 * This function creates a new coroutine. Apart from a pointer to an 156 * This function creates a new coroutine. Apart from a pointer to an
106 * uninitialized coro_context, it expects a pointer to the entry function 157 * uninitialised coro_context, it expects a pointer to the entry function
107 * and the single pointer value that is given to it as argument. 158 * and the single pointer value that is given to it as argument.
108 * 159 *
109 * Allocating/deallocating the stack is your own responsibility, so there is 160 * Allocating/deallocating the stack is your own responsibility.
110 * no coro_destroy function.
111 */ 161 *
112void coro_create (coro_context *ctx, 162 * As a special case, if coro, arg, sptr and ssize are all zero,
113 coro_func coro, void *arg, 163 * then an "empty" coro_context will be created that is suitable
114 void *sptr, long ssize); 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 */
115 174
116/* 175/*
117 * The following prototype defines the coroutine switching function. It is 176 * The following prototype defines the coroutine switching function. It is
118 * usually implemented as a macro, so watch out. 177 * usually implemented as a macro, so watch out.
119 * 178 *
179 * This function is thread-safe and reentrant.
180 */
181#if 0
120void coro_transfer(coro_context *prev, coro_context *next); 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.
121 */ 191 *
192 * This function is thread-safe and reentrant.
193 */
194#if 0
195void coro_destroy (coro_context *ctx);
196#endif
122 197
123/* 198/*
124 * That was it. No other user-visible functions are implemented here. 199 * That was it. No other user-visible functions are implemented here.
125 */ 200 */
126 201
127/*****************************************************************************/ 202/*****************************************************************************/
128 203
129#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ 204#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
130 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 205 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
206 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
131 && !defined(CORO_IRIX) 207 && !defined(CORO_PTHREAD)
132# if defined(WINDOWS) 208# if defined(WINDOWS)
133# define CORO_LOSER 1 /* you don't win with windoze */ 209# define CORO_LOSER 1 /* you don't win with windoze */
134# elif defined(__linux) && defined(__x86) 210# elif defined(__linux) && (defined(__x86) || defined (__amd64))
211# define CORO_ASM 1
135# elif defined(HAVE_UCONTEXT_H) 212# elif defined(HAVE_UCONTEXT_H)
136# define CORO_UCONTEXT 1 213# define CORO_UCONTEXT 1
137# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 214# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
138# define CORO_SJLJ 1 215# define CORO_SJLJ 1
139# else 216# else
… …
143 220
144/*****************************************************************************/ 221/*****************************************************************************/
145 222
146#if CORO_UCONTEXT 223#if CORO_UCONTEXT
147 224
148#include <ucontext.h> 225# include <ucontext.h>
149 226
150struct coro_context { 227struct coro_context {
151 ucontext_t uc; 228 ucontext_t uc;
152}; 229};
153 230
154#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)
155 233
156#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 234#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
157 235
158#if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 236# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
159# define _GNU_SOURCE // for linux libc 237# define _GNU_SOURCE /* for linux libc */
160#endif 238# endif
161 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
162#include <setjmp.h> 250# include <setjmp.h>
251
252# if _XOPEN_UNIX > 0 || defined (_setjmp)
253# define coro_jmp_buf jmp_buf
254# define coro_setjmp(env) _setjmp (env)
255# define coro_longjmp(env) _longjmp ((env), 1)
256# elif CORO_LOSER
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)
264# endif
163 265
164struct coro_context { 266struct coro_context {
165 jmp_buf env; 267 coro_jmp_buf env;
166}; 268};
167 269
168#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0) 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)
169 272
170#endif 273#elif CORO_ASM
171 274
172#endif 275struct coro_context {
276 void **sp; /* must be at offset 0 */
277};
173 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);
296void coro_destroy (coro_context *ctx);
297
298#endif
299
300#if __cplusplus
301}
302#endif
303
304#endif
305

Diff Legend

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