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

Comparing libcoro/coro.h (file contents):
Revision 1.13 by root, Sun Feb 19 22:30:58 2006 UTC vs.
Revision 1.52 by root, Fri Dec 7 14:21:09 2012 UTC

1/* 1/*
2 * Copyright (c) 2001-2005 Marc Alexander Lehmann <schmorp@schmorp.de> 2 * Copyright (c) 2001-2012 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 * 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 * use .cfi_undefined rip on linux-amd64 for better backtraces.
75 * 2011-06-08 maybe properly implement weird windows amd64 calling conventions.
76 * 2011-07-03 rely on __GCC_HAVE_DWARF2_CFI_ASM for cfi detection.
77 * 2011-08-08 cygwin trashes stacks, use pthreads with double stack on cygwin.
78 * 2012-12-04 reduce misprediction penalty for x86/amd64 assembly switcher.
79 * 2012-12-05 experimental fiber backend (allocates stack twice).
80 * 2012-12-07 API version 3 - add coro_stack_alloc/coro_stack_free.
81 */
82
38#ifndef CORO_H 83#ifndef CORO_H
39#define CORO_H 84#define CORO_H
40 85
41#define CORO_VERSION 2 86#if __cplusplus
42 87extern "C" {
43/* 88#endif
44 * Changes since API version 1:
45 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
46 */
47 89
48/* 90/*
49 * This library consists of only three files 91 * This library consists of only three files
50 * coro.h, coro.c and LICENSE (and optionally README) 92 * coro.h, coro.c and LICENSE (and optionally README)
51 * 93 *
52 * It implements what is known as coroutines, in a hopefully 94 * It implements what is known as coroutines, in a hopefully
53 * portable way. At the moment you have to define which kind 95 * portable way.
54 * of implementation flavour you want: 96 *
97 * All compiletime symbols must be defined both when including coro.h
98 * (using libcoro) as well as when compiling coro.c (the implementation).
99 *
100 * You can manually specify which flavour you want. If you don't define
101 * any of these, libcoro tries to choose a safe and fast default:
55 * 102 *
56 * -DCORO_UCONTEXT 103 * -DCORO_UCONTEXT
57 * 104 *
58 * This flavour uses SUSv2's get/set/swap/makecontext functions that 105 * This flavour uses SUSv2's get/set/swap/makecontext functions that
59 * unfortunately only newer unices support. 106 * unfortunately only some unices support, and is quite slow.
60 * Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
61 * 107 *
62 * -DCORO_SJLJ 108 * -DCORO_SJLJ
63 * 109 *
64 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to 110 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
65 * do it's job. Coroutine creation is much slower than UCONTEXT, but 111 * 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 112 * context switching is a bit cheaper. It should work on almost all unices.
67 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
68 * do not work with any sane model (neither sigaltstack nor context
69 * functions are implemented)
70 * 113 *
71 * -DCORO_LINUX 114 * -DCORO_LINUX
72 * 115 *
116 * CORO_SJLJ variant.
73 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 117 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
74 * (it is very fast and therefore recommended over other methods). 118 * (it is very fast and therefore recommended over other methods, but
119 * doesn't work with anything newer).
75 * 120 *
76 * -DCORO_LOSER 121 * -DCORO_LOSER
77 * 122 *
123 * CORO_SJLJ variant.
78 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 124 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
79 * this automatically selects a suitable workaround for this platform. 125 * this selects a suitable workaround for this platform. It might not work
80 * (untested) 126 * with your compiler though - it has only been tested with MSVC 6.
127 *
128 * -DCORO_FIBER
129 *
130 * Slower, but probably more portable variant for the Microsoft operating
131 * system, using fibers. Ignores the passed stack and allocates it internally.
132 * Also, due to bugs in cygwin, this does not work with cygwin.
81 * 133 *
82 * -DCORO_IRIX 134 * -DCORO_IRIX
83 * 135 *
136 * CORO_SJLJ variant.
84 * SGI's version of Microsoft's NT ;) 137 * For SGI's version of Microsoft's NT ;)
138 *
139 * -DCORO_ASM
140 *
141 * Hand coded assembly, known to work only on a few architectures/ABI:
142 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs. Fastest choice,
143 * if it works.
144 *
145 * -DCORO_PTHREAD
146 *
147 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
148 * This is likely the slowest backend, and it also does not support fork(),
149 * so avoid it at all costs.
85 * 150 *
86 * If you define neither of these symbols, coro.h will try to autodetect 151 * 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 152 * the best/safest model. To help with the autodetection, you should check
88 * alternatives you should check (e.g. using autoconf) and define the 153 * (e.g. using autoconf) and define the following symbols: HAVE_UCONTEXT_H
89 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 154 * / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
155 */
156
157/*
158 * Changes when the API changes incompatibly.
159 * This is ONLY the API version - there is no ABI compatibility between releases.
90 */ 160 *
161 * Changes in API version 2:
162 * replaced bogus -DCORO_LOOSE with grammatically more correct -DCORO_LOSER
163 * Changes in API version 3:
164 * introduced stack management (CORO_STACKALLOC)
165 */
166#define CORO_VERSION 3
167
168#include <stddef.h>
91 169
92/* 170/*
93 * This is the type for the initialization function of a new coroutine. 171 * This is the type for the initialization function of a new coroutine.
94 */ 172 */
95typedef void (*coro_func)(void *); 173typedef void (*coro_func)(void *);
96 174
97/* 175/*
98 * A coroutine state is saved in the following structure. Treat it as a 176 * 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, 177 * opaque type. errno and sigmask might be saved, but don't rely on it,
100 * implement your own switching primitive. 178 * implement your own switching primitive if you need that.
101 */ 179 */
102typedef struct coro_context coro_context; 180typedef struct coro_context coro_context;
103 181
104/* 182/*
105 * This function creates a new coroutine. Apart from a pointer to an 183 * This function creates a new coroutine. Apart from a pointer to an
106 * uninitialised coro_context, it expects a pointer to the entry function 184 * uninitialised coro_context, it expects a pointer to the entry function
107 * and the single pointer value that is given to it as argument. 185 * and the single pointer value that is given to it as argument.
108 * 186 *
109 * Allocating/deallocating the stack is your own responsibility, so there is 187 * Allocating/deallocating the stack is your own responsibility.
110 * no coro_destroy function.
111 */ 188 *
112void coro_create (coro_context *ctx, 189 * As a special case, if coro, arg, sptr and ssze are all zero,
113 coro_func coro, void *arg, 190 * then an "empty" coro_context will be created that is suitable
114 void *sptr, long ssize); 191 * as an initial source for coro_transfer.
192 *
193 * This function is not reentrant, but putting a mutex around it
194 * will work.
195 */
196void coro_create (coro_context *ctx, /* an uninitialised coro_context */
197 coro_func coro, /* the coroutine code to be executed */
198 void *arg, /* a single pointer passed to the coro */
199 void *sptr, /* start of stack area */
200 size_t ssze); /* size of stack area in bytes */
115 201
116/* 202/*
117 * The following prototype defines the coroutine switching function. It is 203 * The following prototype defines the coroutine switching function. It is
118 * usually implemented as a macro, so watch out. 204 * sometimes implemented as a macro, so watch out.
205 *
206 * This function is thread-safe and reentrant.
119 * 207 */
208#if 0
120void coro_transfer(coro_context *prev, coro_context *next); 209void coro_transfer (coro_context *prev, coro_context *next);
210#endif
211
212/*
213 * The following prototype defines the coroutine destroy function. It
214 * is sometimes implemented as a macro, so watch out. It also serves no
215 * purpose unless you want to use the CORO_PTHREAD backend, where it is
216 * used to clean up the thread. You are responsible for freeing the stack
217 * and the context itself.
121 */ 218 *
122 219 * This function is thread-safe and reentrant.
123/*
124 * That was it. No other user-visible functions are implemented here.
125 */ 220 */
221#if 0
222void coro_destroy (coro_context *ctx);
223#endif
126 224
127/*****************************************************************************/ 225/*****************************************************************************/
226/* optional stack management */
227/*****************************************************************************/
228/*
229 * You can disable all of the stack management functions by
230 * defining CORO_STACKALLOC to 0. Otherwise, they are enabled by default.
231 *
232 * If stack management is enabled, you can influence the implementation via these
233 * symbols:
234 *
235 * -DCORO_USE_VALGRIND
236 *
237 * If defined, then libcoro will include valgrind/valgrind.h and register
238 * and unregister stacks with valgrind.
239 *
240 * -DCORO_GUARDPAGES=n
241 *
242 * libcoro will try to use the specified number of guard pages to protect against
243 * stack overflow. If n is 0, then the feature will be disabled. If it isn't
244 * defined, then libcoro will choose a suitable default. If guardpages are not
245 * supported on the platform, then the feature will be silently disabled.
246 */
247#ifndef CORO_STACKALLOC
248# define CORO_STACKALLOC 1
249#endif
128 250
251#if CORO_STACKALLOC
252
253/*
254 * The only allowed operations on these struct members is to read the
255 * "sptr" and "ssze" members to pass it to coro_create, to read the "sptr"
256 * member to see if it is false, in which case the stack isn't allocated,
257 * and to set the "sptr" member to 0, to indicate to coro_stack_free to
258 * not actually do anything.
259 */
260
261struct coro_stack
262{
263 void *sptr;
264 size_t ssze;
265#if CORO_USE_VALGRIND
266 int valgrind_id;
267#endif
268};
269
270/*
271 * Try to allocate a stack of at least the given size and return true if
272 * successful, or false otherwise.
273 *
274 * The size is *NOT* specified in bytes, but in units of sizeof (void *),
275 * i.e. the stack is typically 4(8) times larger on 32 bit(64 bit) platforms
276 * then the size passed in.
277 *
278 * If size is 0, then a "suitable" stack size is chosen (usually 1-2MB).
279 */
280int coro_stack_alloc (struct coro_stack *stack, unsigned int size);
281
282/*
283 * Free the stack allocated by coro_stack_alloc again. It is safe to
284 * call this function on the coro_stack structure even if coro_stack_alloc
285 * failed.
286 */
287void coro_stack_free (struct coro_stack *stack);
288
289#endif
290
291/*
292 * That was it. No other user-serviceable parts below here.
293 */
294
295/*****************************************************************************/
296
129#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ 297#if !defined CORO_LOSER && !defined CORO_UCONTEXT \
130 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 298 && !defined CORO_SJLJ && !defined CORO_LINUX \
131 && !defined(CORO_IRIX) 299 && !defined CORO_IRIX && !defined CORO_ASM \
132# if defined(WINDOWS) 300 && !defined CORO_PTHREAD && !defined CORO_FIBER
301# if defined WINDOWS && (defined __x86 || defined __amd64 || defined _M_IX86 || defined _M_AMD64)
302# define CORO_ASM 1
303# elif defined WINDOWS || defined _WIN32
133# define CORO_LOSER 1 /* you don't win with windoze */ 304# define CORO_LOSER 1 /* you don't win with windoze */
134# elif defined(__linux) && defined(__x86) 305# elif defined __linux && (defined __x86 || defined __amd64)
306# define CORO_ASM 1
135# elif defined(HAVE_UCONTEXT_H) 307# elif defined HAVE_UCONTEXT_H
136# define CORO_UCONTEXT 1 308# define CORO_UCONTEXT 1
137# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 309# elif defined HAVE_SETJMP_H && defined HAVE_SIGALTSTACK
138# define CORO_SJLJ 1 310# define CORO_SJLJ 1
139# else 311# else
140error unknown or unsupported architecture 312error unknown or unsupported architecture
141# endif 313# endif
142#endif 314#endif
143 315
144/*****************************************************************************/ 316/*****************************************************************************/
145 317
146#if CORO_UCONTEXT 318#if CORO_UCONTEXT
147 319
148#include <ucontext.h> 320# include <ucontext.h>
149 321
150struct coro_context { 322struct coro_context
323{
151 ucontext_t uc; 324 ucontext_t uc;
152}; 325};
153 326
154#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 327# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
328# define coro_destroy(ctx) (void *)(ctx)
155 329
156#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 330#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
157 331
158#if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 332# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
159# define _GNU_SOURCE // for linux libc 333# define _GNU_SOURCE /* for glibc */
160#endif 334# endif
161 335
336# if !CORO_LOSER
337# include <unistd.h>
338# endif
339
340/* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */
341# if __sun
342# undef _XOPEN_UNIX
343# define _XOPEN_UNIX 1
344# endif
345
162#include <setjmp.h> 346# include <setjmp.h>
163 347
348# if _XOPEN_UNIX > 0 || defined (_setjmp)
349# define coro_jmp_buf jmp_buf
350# define coro_setjmp(env) _setjmp (env)
351# define coro_longjmp(env) _longjmp ((env), 1)
352# elif CORO_LOSER
353# define coro_jmp_buf jmp_buf
354# define coro_setjmp(env) setjmp (env)
355# define coro_longjmp(env) longjmp ((env), 1)
356# else
357# define coro_jmp_buf sigjmp_buf
358# define coro_setjmp(env) sigsetjmp (env, 0)
359# define coro_longjmp(env) siglongjmp ((env), 1)
360# endif
361
164struct coro_context { 362struct coro_context
363{
165 jmp_buf env; 364 coro_jmp_buf env;
166}; 365};
167 366
168#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0) 367# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
368# define coro_destroy(ctx) (void *)(ctx)
169 369
170#endif 370#elif CORO_ASM
171 371
172#endif 372struct coro_context
373{
374 void **sp; /* must be at offset 0 */
375};
173 376
377void __attribute__ ((__noinline__, __regparm__(2)))
378coro_transfer (coro_context *prev, coro_context *next);
379
380# define coro_destroy(ctx) (void *)(ctx)
381
382#elif CORO_PTHREAD
383
384# include <pthread.h>
385
386extern pthread_mutex_t coro_mutex;
387
388struct coro_context
389{
390 pthread_cond_t cv;
391 pthread_t id;
392};
393
394void coro_transfer (coro_context *prev, coro_context *next);
395void coro_destroy (coro_context *ctx);
396
397#elif CORO_FIBER
398
399struct coro_context
400{
401 void *fiber;
402 /* only used for initialisation */
403 coro_func coro;
404 void *arg;
405};
406
407void coro_transfer (coro_context *prev, coro_context *next);
408void coro_destroy (coro_context *ctx);
409
410#endif
411
412#if __cplusplus
413}
414#endif
415
416#endif
417

Diff Legend

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