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

Comparing libcoro/coro.h (file contents):
Revision 1.7 by pcg, Thu Apr 1 03:11:15 2004 UTC vs.
Revision 1.38 by root, Fri Nov 14 05:27:08 2008 UTC

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

Diff Legend

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