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

Diff Legend

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