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.25 by root, Fri Apr 4 20:07:35 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 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.
35 */ 57 */
36 58
37#ifndef CORO_H 59#ifndef CORO_H
38#define CORO_H 60#define CORO_H
39 61
62#define CORO_VERSION 2
63
64/*
65 * Changes since API version 1:
66 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
67 */
68
69/*
70 * This library consists of only three files
71 * coro.h, coro.c and LICENSE (and optionally README)
72 *
73 * It implements what is known as coroutines, in a hopefully
74 * portable way. At the moment you have to define which kind
75 * of implementation flavour you want:
76 *
77 * -DCORO_UCONTEXT
78 *
79 * This flavour uses SUSv2's get/set/swap/makecontext functions that
80 * unfortunately only newer unices support.
81 *
82 * -DCORO_SJLJ
83 *
84 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
85 * do it's job. Coroutine creation is much slower than UCONTEXT, but
86 * context switching is often a bit cheaper. It should work on almost
87 * all unices.
88 *
89 * -DCORO_LINUX
90 *
91 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
92 * (it is very fast and therefore recommended over other methods, but
93 * doesn't work with anything newer).
94 *
95 * -DCORO_LOSER
96 *
97 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
98 * this automatically selects a suitable workaround for this platform.
99 * (untested)
100 *
101 * -DCORO_IRIX
102 *
103 * SGI's version of Microsoft's NT ;)
104 *
105 * -DCORO_ASM
106 *
107 * Handcoded assembly, known to work only on a few architectures/ABI:
108 * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on.
109 *
110 * -DCORO_PTHREAD
111 *
112 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
113 *
114 * If you define neither of these symbols, coro.h will try to autodetect
115 * the model. This currently works for CORO_LOSER only. For the other
116 * alternatives you should check (e.g. using autoconf) and define the
117 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
118 */
119
120/*
121 * This is the type for the initialization function of a new coroutine.
122 */
40typedef void (*coro_func)(void *); 123typedef void (*coro_func)(void *);
41 124
125/*
126 * A coroutine state is saved in the following structure. Treat it as an
127 * opaque type. errno and sigmask might be saved, but don't rely on it,
128 * implement your own switching primitive if you need that.
129 */
130typedef struct coro_context coro_context;
131
132/*
133 * This function creates a new coroutine. Apart from a pointer to an
134 * uninitialised coro_context, it expects a pointer to the entry function
135 * and the single pointer value that is given to it as argument.
136 *
137 * Allocating/deallocating the stack is your own responsibility, so there is
138 * no coro_destroy function.
139 */
140void coro_create (coro_context *ctx, /* an uninitialised coro_context */
141 coro_func coro, /* the coroutine code to be executed */
142 void *arg, /* a single pointer passed to the coro */
143 void *sptr, /* start of stack area */
144 long ssize); /* size of stack area */
145
146/*
147 * The following prototype defines the coroutine switching function. It is
148 * usually implemented as a macro, so watch out.
149 *
150void coro_transfer(coro_context *prev, coro_context *next);
151 */
152
153/*
154 * That was it. No other user-visible functions are implemented here.
155 */
156
157/*****************************************************************************/
158
159#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
160 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
161 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
162 && !defined(CORO_PTHREAD)
42#if defined(WINDOWS) 163# if defined(WINDOWS)
43# define CORO_LOOSE 1 /* you don't win with windoze */ 164# define CORO_LOSER 1 /* you don't win with windoze */
165# elif defined(__linux) && (defined(__x86) || defined (__amd64))
166# define CORO_ASM 1
44#elif defined(HAVE_UCONTEXT_H) 167# elif defined(HAVE_UCONTEXT_H)
45# define CORO_UCONTEXT 1 168# define CORO_UCONTEXT 1
46#elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 169# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
47# define CORO_SJLJ 1 170# define CORO_SJLJ 1
48#else 171# else
49error unknown or unsupported architecture 172error unknown or unsupported architecture
173# endif
50#endif 174#endif
51 175
176/*****************************************************************************/
177
52#if CORO_UCONTEXT 178#if CORO_UCONTEXT
53 179
54#include <ucontext.h> 180# include <ucontext.h>
55 181
56typedef struct { 182struct coro_context {
57 ucontext_t uc; 183 ucontext_t uc;
58} coro_context; 184};
59 185
60#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 186# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
61 187
62#elif CORO_SJLJ || CORO_LOOSE 188#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
63 189
190# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
191# define _GNU_SOURCE /* for linux libc */
192# endif
193
64#include <setjmp.h> 194# include <setjmp.h>
65 195
66typedef struct { 196struct coro_context {
67 jmp_buf env; 197 jmp_buf env;
68} coro_context; 198};
69 199
200# if CORO_LINUX || (_XOPEN_SOURCE >= 600)
70#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) 201# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0)
202# else
203# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0)
204# endif
205
206#elif CORO_ASM
207
208struct coro_context {
209 volatile void **sp;
210};
211
212void __attribute__ ((__noinline__, __fastcall__))
213 coro_transfer (coro_context *prev, coro_context *next);
214
215#elif CORO_PTHREAD
216
217#include <pthread.h>
218
219extern pthread_mutex_t coro_mutex;
220
221struct coro_context {
222 pthread_cond_t c;
223};
224
225void coro_transfer (coro_context *prev, coro_context *next);
71 226
72#endif 227#endif
73 228
74void coro_create(coro_context *ctx,
75 coro_func coro, void *arg,
76 void *sptr, long ssize);
77
78#endif 229#endif
79 230

Diff Legend

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