ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.h
Revision: 1.48
Committed: Fri Jun 10 12:27:02 2011 UTC (12 years, 11 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-6_0
Changes since 1.47: +2 -1 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 /*
2 * Copyright (c) 2001-2009 Marc Alexander Lehmann <schmorp@schmorp.de>
3 *
4 * Redistribution and use in source and binary forms, with or without modifica-
5 * tion, are permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
16 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
17 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
18 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
22 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
23 * OF THE POSSIBILITY OF SUCH DAMAGE.
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 *
36 * This library is modelled strictly after Ralf S. Engelschalls article at
37 * http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must
38 * go to Ralf S. Engelschall <rse@engelschall.com>.
39 *
40 * This coroutine library is very much stripped down. You should either
41 * build your own process abstraction using it or - better - just use GNU
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.
74 * use .cfi_undefined rip on linux-amd64 for better backtraces.
75 * 2011-06-08 maybe properly implement weird windows amd64 calling conventions.
76 */
77
78 #ifndef CORO_H
79 #define CORO_H
80
81 #if __cplusplus
82 extern "C" {
83 #endif
84
85 #define CORO_VERSION 2
86
87 /*
88 * Changes since API version 1:
89 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
90 */
91
92 /*
93 * This library consists of only three files
94 * coro.h, coro.c and LICENSE (and optionally README)
95 *
96 * It implements what is known as coroutines, in a hopefully
97 * portable way. At the moment you have to define which kind
98 * of implementation flavour you want:
99 *
100 * -DCORO_UCONTEXT
101 *
102 * This flavour uses SUSv2's get/set/swap/makecontext functions that
103 * unfortunately only newer unices support.
104 *
105 * -DCORO_SJLJ
106 *
107 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
108 * do it's job. Coroutine creation is much slower than UCONTEXT, but
109 * context switching is often a bit cheaper. It should work on almost
110 * all unices.
111 *
112 * -DCORO_LINUX
113 *
114 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
115 * (it is very fast and therefore recommended over other methods, but
116 * doesn't work with anything newer).
117 *
118 * -DCORO_LOSER
119 *
120 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
121 * this automatically selects a suitable workaround for this platform.
122 * (untested)
123 *
124 * -DCORO_IRIX
125 *
126 * SGI's version of Microsoft's NT ;)
127 *
128 * -DCORO_ASM
129 *
130 * Handcoded assembly, known to work only on a few architectures/ABI:
131 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs.
132 *
133 * -DCORO_PTHREAD
134 *
135 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
136 * This is likely the slowest backend, and it also does not support fork(),
137 * so avoid it at all costs.
138 *
139 * If you define neither of these symbols, coro.h will try to autodetect
140 * the model. This currently works for CORO_LOSER only. For the other
141 * alternatives you should check (e.g. using autoconf) and define the
142 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
143 */
144
145 /*
146 * This is the type for the initialization function of a new coroutine.
147 */
148 typedef void (*coro_func)(void *);
149
150 /*
151 * A coroutine state is saved in the following structure. Treat it as an
152 * opaque type. errno and sigmask might be saved, but don't rely on it,
153 * implement your own switching primitive if you need that.
154 */
155 typedef struct coro_context coro_context;
156
157 /*
158 * This function creates a new coroutine. Apart from a pointer to an
159 * uninitialised coro_context, it expects a pointer to the entry function
160 * and the single pointer value that is given to it as argument.
161 *
162 * Allocating/deallocating the stack is your own responsibility.
163 *
164 * As a special case, if coro, arg, sptr and ssize are all zero,
165 * then an "empty" coro_context will be created that is suitable
166 * as an initial source for coro_transfer.
167 *
168 * This function is not reentrant, but putting a mutex around it
169 * will work.
170 */
171 void coro_create (coro_context *ctx, /* an uninitialised coro_context */
172 coro_func coro, /* the coroutine code to be executed */
173 void *arg, /* a single pointer passed to the coro */
174 void *sptr, /* start of stack area */
175 long ssize); /* size of stack area */
176
177 /*
178 * The following prototype defines the coroutine switching function. It is
179 * usually implemented as a macro, so watch out.
180 *
181 * This function is thread-safe and reentrant.
182 */
183 #if 0
184 void coro_transfer (coro_context *prev, coro_context *next);
185 #endif
186
187 /*
188 * The following prototype defines the coroutine destroy function. It is
189 * usually implemented as a macro, so watch out. It also serves
190 * no purpose unless you want to use the CORO_PTHREAD backend,
191 * where it is used to clean up the thread. You are responsible
192 * for freeing the stack and the context itself.
193 *
194 * This function is thread-safe and reentrant.
195 */
196 #if 0
197 void coro_destroy (coro_context *ctx);
198 #endif
199
200 /*
201 * That was it. No other user-visible functions are implemented here.
202 */
203
204 /*****************************************************************************/
205
206 #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
207 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
208 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
209 && !defined(CORO_PTHREAD)
210 # if defined(WINDOWS) || defined(_WIN32)
211 # define CORO_LOSER 1 /* you don't win with windoze */
212 # elif defined(__linux) && (defined(__x86) || defined (__amd64))
213 # define CORO_ASM 1
214 # elif defined(HAVE_UCONTEXT_H)
215 # define CORO_UCONTEXT 1
216 # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
217 # define CORO_SJLJ 1
218 # else
219 error unknown or unsupported architecture
220 # endif
221 #endif
222
223 /*****************************************************************************/
224
225 #if CORO_UCONTEXT
226
227 # include <ucontext.h>
228
229 struct coro_context {
230 ucontext_t uc;
231 };
232
233 # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
234 # define coro_destroy(ctx) (void *)(ctx)
235
236 #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
237
238 # if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
239 # define _GNU_SOURCE /* for linux libc */
240 # endif
241
242 # if !CORO_LOSER
243 # include <unistd.h>
244 # endif
245
246 /* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */
247 # if __sun
248 # undef _XOPEN_UNIX
249 # define _XOPEN_UNIX 1
250 # endif
251
252 # include <setjmp.h>
253
254 # if _XOPEN_UNIX > 0 || defined (_setjmp)
255 # define coro_jmp_buf jmp_buf
256 # define coro_setjmp(env) _setjmp (env)
257 # define coro_longjmp(env) _longjmp ((env), 1)
258 # elif CORO_LOSER
259 # define coro_jmp_buf jmp_buf
260 # define coro_setjmp(env) setjmp (env)
261 # define coro_longjmp(env) longjmp ((env), 1)
262 # else
263 # define coro_jmp_buf sigjmp_buf
264 # define coro_setjmp(env) sigsetjmp (env, 0)
265 # define coro_longjmp(env) siglongjmp ((env), 1)
266 # endif
267
268 struct coro_context {
269 coro_jmp_buf env;
270 };
271
272 # define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
273 # define coro_destroy(ctx) (void *)(ctx)
274
275 #elif CORO_ASM
276
277 struct coro_context {
278 void **sp; /* must be at offset 0 */
279 };
280
281 void __attribute__ ((__noinline__, __regparm__(2)))
282 coro_transfer (coro_context *prev, coro_context *next);
283
284 # define coro_destroy(ctx) (void *)(ctx)
285
286 #elif CORO_PTHREAD
287
288 # include <pthread.h>
289
290 extern pthread_mutex_t coro_mutex;
291
292 struct coro_context {
293 pthread_cond_t cv;
294 pthread_t id;
295 };
296
297 void coro_transfer (coro_context *prev, coro_context *next);
298 void coro_destroy (coro_context *ctx);
299
300 #endif
301
302 #if __cplusplus
303 }
304 #endif
305
306 #endif
307