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

Comparing libcoro/coro.h (file contents):
Revision 1.45 by root, Mon May 30 02:21:54 2011 UTC vs.
Revision 1.57 by root, Sat Aug 27 12:50:11 2016 UTC

1/* 1/*
2 * Copyright (c) 2001-2009 Marc Alexander Lehmann <schmorp@schmorp.de> 2 * Copyright (c) 2001-2012,2015 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 * 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
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- 15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
16 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 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- 17 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
18 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 18 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
… …
69 * 2008-11-16 work around a freebsd pthread bug. 69 * 2008-11-16 work around a freebsd pthread bug.
70 * 2008-11-19 define coro_*jmp symbols for easier porting. 70 * 2008-11-19 define coro_*jmp symbols for easier porting.
71 * 2009-06-23 tentative win32-backend support for mingw32 (Yasuhiro Matsumoto). 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). 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. 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 * 2012-12-21 valgrind stack registering was broken.
82 * 2015-12-05 experimental asm be for arm7, based on a patch by Nick Zavaritsky.
83 * use __name__ for predefined symbols, as in libecb.
84 * enable guard pages on arm, aarch64 and mips.
85 * 2016-08-27 try to disable _FORTIFY_SOURCE with CORO_SJLJ, as it
86 * breaks setjmp/longjmp.
74 */ 87 */
75 88
76#ifndef CORO_H 89#ifndef CORO_H
77#define CORO_H 90#define CORO_H
78 91
79#if __cplusplus 92#if __cplusplus
80extern "C" { 93extern "C" {
81#endif 94#endif
82 95
83#define CORO_VERSION 2
84
85/*
86 * Changes since API version 1:
87 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
88 */
89
90/* 96/*
91 * This library consists of only three files 97 * This library consists of only three files
92 * coro.h, coro.c and LICENSE (and optionally README) 98 * coro.h, coro.c and LICENSE (and optionally README)
93 * 99 *
94 * It implements what is known as coroutines, in a hopefully 100 * It implements what is known as coroutines, in a hopefully
95 * portable way. At the moment you have to define which kind 101 * portable way.
96 * of implementation flavour you want: 102 *
103 * All compiletime symbols must be defined both when including coro.h
104 * (using libcoro) as well as when compiling coro.c (the implementation).
105 *
106 * You can manually specify which flavour you want. If you don't define
107 * any of these, libcoro tries to choose a safe and fast default:
97 * 108 *
98 * -DCORO_UCONTEXT 109 * -DCORO_UCONTEXT
99 * 110 *
100 * This flavour uses SUSv2's get/set/swap/makecontext functions that 111 * This flavour uses SUSv2's get/set/swap/makecontext functions that
101 * unfortunately only newer unices support. 112 * unfortunately only some unices support, and is quite slow.
102 * 113 *
103 * -DCORO_SJLJ 114 * -DCORO_SJLJ
104 * 115 *
105 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to 116 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
106 * do it's job. Coroutine creation is much slower than UCONTEXT, but 117 * do it's job. Coroutine creation is much slower than UCONTEXT, but
107 * context switching is often a bit cheaper. It should work on almost 118 * context switching is a bit cheaper. It should work on almost all unices.
108 * all unices.
109 * 119 *
110 * -DCORO_LINUX 120 * -DCORO_LINUX
111 * 121 *
122 * CORO_SJLJ variant.
112 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation 123 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
113 * (it is very fast and therefore recommended over other methods, but 124 * (it is very fast and therefore recommended over other methods, but
114 * doesn't work with anything newer). 125 * doesn't work with anything newer).
115 * 126 *
116 * -DCORO_LOSER 127 * -DCORO_LOSER
117 * 128 *
129 * CORO_SJLJ variant.
118 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 130 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
119 * this automatically selects a suitable workaround for this platform. 131 * this selects a suitable workaround for this platform. It might not work
120 * (untested) 132 * with your compiler though - it has only been tested with MSVC 6.
133 *
134 * -DCORO_FIBER
135 *
136 * Slower, but probably more portable variant for the Microsoft operating
137 * system, using fibers. Ignores the passed stack and allocates it internally.
138 * Also, due to bugs in cygwin, this does not work with cygwin.
121 * 139 *
122 * -DCORO_IRIX 140 * -DCORO_IRIX
123 * 141 *
142 * CORO_SJLJ variant.
124 * SGI's version of Microsoft's NT ;) 143 * For SGI's version of Microsoft's NT ;)
125 * 144 *
126 * -DCORO_ASM 145 * -DCORO_ASM
127 * 146 *
128 * Handcoded assembly, known to work only on a few architectures/ABI: 147 * Hand coded assembly, known to work only on a few architectures/ABI:
129 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs. 148 * GCC + arm7/x86/IA32/amd64/x86_64 + GNU/Linux and a few BSDs. Fastest
149 * choice, if it works.
130 * 150 *
131 * -DCORO_PTHREAD 151 * -DCORO_PTHREAD
132 * 152 *
133 * Use the pthread API. You have to provide <pthread.h> and -lpthread. 153 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
134 * This is likely the slowest backend, and it also does not support fork(), 154 * This is likely the slowest backend, and it also does not support fork(),
135 * so avoid it at all costs. 155 * so avoid it at all costs.
136 * 156 *
137 * If you define neither of these symbols, coro.h will try to autodetect 157 * If you define neither of these symbols, coro.h will try to autodetect
138 * the model. This currently works for CORO_LOSER only. For the other 158 * the best/safest model. To help with the autodetection, you should check
139 * alternatives you should check (e.g. using autoconf) and define the 159 * (e.g. using autoconf) and define the following symbols: HAVE_UCONTEXT_H
140 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 160 * / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
161 */
162
163/*
164 * Changes when the API changes incompatibly.
165 * This is ONLY the API version - there is no ABI compatibility between releases.
141 */ 166 *
167 * Changes in API version 2:
168 * replaced bogus -DCORO_LOOSE with grammatically more correct -DCORO_LOSER
169 * Changes in API version 3:
170 * introduced stack management (CORO_STACKALLOC)
171 */
172#define CORO_VERSION 3
173
174#include <stddef.h>
142 175
143/* 176/*
144 * This is the type for the initialization function of a new coroutine. 177 * This is the type for the initialization function of a new coroutine.
145 */ 178 */
146typedef void (*coro_func)(void *); 179typedef void (*coro_func)(void *);
… …
157 * uninitialised coro_context, it expects a pointer to the entry function 190 * uninitialised coro_context, it expects a pointer to the entry function
158 * and the single pointer value that is given to it as argument. 191 * and the single pointer value that is given to it as argument.
159 * 192 *
160 * Allocating/deallocating the stack is your own responsibility. 193 * Allocating/deallocating the stack is your own responsibility.
161 * 194 *
162 * As a special case, if coro, arg, sptr and ssize are all zero, 195 * As a special case, if coro, arg, sptr and ssze are all zero,
163 * then an "empty" coro_context will be created that is suitable 196 * then an "empty" coro_context will be created that is suitable
164 * as an initial source for coro_transfer. 197 * as an initial source for coro_transfer.
165 * 198 *
166 * This function is not reentrant, but putting a mutex around it 199 * This function is not reentrant, but putting a mutex around it
167 * will work. 200 * will work.
168 */ 201 */
169void coro_create (coro_context *ctx, /* an uninitialised coro_context */ 202void coro_create (coro_context *ctx, /* an uninitialised coro_context */
170 coro_func coro, /* the coroutine code to be executed */ 203 coro_func coro, /* the coroutine code to be executed */
171 void *arg, /* a single pointer passed to the coro */ 204 void *arg, /* a single pointer passed to the coro */
172 void *sptr, /* start of stack area */ 205 void *sptr, /* start of stack area */
173 long ssize); /* size of stack area */ 206 size_t ssze); /* size of stack area in bytes */
174 207
175/* 208/*
176 * The following prototype defines the coroutine switching function. It is 209 * The following prototype defines the coroutine switching function. It is
177 * usually implemented as a macro, so watch out. 210 * sometimes implemented as a macro, so watch out.
178 * 211 *
179 * This function is thread-safe and reentrant. 212 * This function is thread-safe and reentrant.
180 */ 213 */
181#if 0 214#if 0
182void coro_transfer (coro_context *prev, coro_context *next); 215void coro_transfer (coro_context *prev, coro_context *next);
183#endif 216#endif
184 217
185/* 218/*
186 * The following prototype defines the coroutine destroy function. It is 219 * The following prototype defines the coroutine destroy function. It
187 * usually implemented as a macro, so watch out. It also serves 220 * is sometimes implemented as a macro, so watch out. It also serves no
188 * no purpose unless you want to use the CORO_PTHREAD backend, 221 * purpose unless you want to use the CORO_PTHREAD backend, where it is
189 * where it is used to clean up the thread. You are responsible 222 * used to clean up the thread. You are responsible for freeing the stack
190 * for freeing the stack and the context itself. 223 * and the context itself.
191 * 224 *
192 * This function is thread-safe and reentrant. 225 * This function is thread-safe and reentrant.
193 */ 226 */
194#if 0 227#if 0
195void coro_destroy (coro_context *ctx); 228void coro_destroy (coro_context *ctx);
196#endif 229#endif
197 230
198/*
199 * That was it. No other user-visible functions are implemented here.
200 */
201
202/*****************************************************************************/ 231/*****************************************************************************/
232/* optional stack management */
233/*****************************************************************************/
234/*
235 * You can disable all of the stack management functions by
236 * defining CORO_STACKALLOC to 0. Otherwise, they are enabled by default.
237 *
238 * If stack management is enabled, you can influence the implementation via these
239 * symbols:
240 *
241 * -DCORO_USE_VALGRIND
242 *
243 * If defined, then libcoro will include valgrind/valgrind.h and register
244 * and unregister stacks with valgrind.
245 *
246 * -DCORO_GUARDPAGES=n
247 *
248 * libcoro will try to use the specified number of guard pages to protect against
249 * stack overflow. If n is 0, then the feature will be disabled. If it isn't
250 * defined, then libcoro will choose a suitable default. If guardpages are not
251 * supported on the platform, then the feature will be silently disabled.
252 */
253#ifndef CORO_STACKALLOC
254# define CORO_STACKALLOC 1
255#endif
203 256
257#if CORO_STACKALLOC
258
259/*
260 * The only allowed operations on these struct members is to read the
261 * "sptr" and "ssze" members to pass it to coro_create, to read the "sptr"
262 * member to see if it is false, in which case the stack isn't allocated,
263 * and to set the "sptr" member to 0, to indicate to coro_stack_free to
264 * not actually do anything.
265 */
266
267struct coro_stack
268{
269 void *sptr;
270 size_t ssze;
271#if CORO_USE_VALGRIND
272 int valgrind_id;
273#endif
274};
275
276/*
277 * Try to allocate a stack of at least the given size and return true if
278 * successful, or false otherwise.
279 *
280 * The size is *NOT* specified in bytes, but in units of sizeof (void *),
281 * i.e. the stack is typically 4(8) times larger on 32 bit(64 bit) platforms
282 * then the size passed in.
283 *
284 * If size is 0, then a "suitable" stack size is chosen (usually 1-2MB).
285 */
286int coro_stack_alloc (struct coro_stack *stack, unsigned int size);
287
288/*
289 * Free the stack allocated by coro_stack_alloc again. It is safe to
290 * call this function on the coro_stack structure even if coro_stack_alloc
291 * failed.
292 */
293void coro_stack_free (struct coro_stack *stack);
294
295#endif
296
297/*
298 * That was it. No other user-serviceable parts below here.
299 */
300
301/*****************************************************************************/
302
204#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ 303#if !defined CORO_LOSER && !defined CORO_UCONTEXT \
205 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 304 && !defined CORO_SJLJ && !defined CORO_LINUX \
206 && !defined(CORO_IRIX) && !defined(CORO_ASM) \ 305 && !defined CORO_IRIX && !defined CORO_ASM \
207 && !defined(CORO_PTHREAD) 306 && !defined CORO_PTHREAD && !defined CORO_FIBER
208# if defined(WINDOWS) 307# if defined WINDOWS && (defined __i386__ || (__x86_64__ || defined _M_IX86 || defined _M_AMD64)
308# define CORO_ASM 1
309# elif defined WINDOWS || defined _WIN32
209# define CORO_LOSER 1 /* you don't win with windoze */ 310# define CORO_LOSER 1 /* you don't win with windoze */
210# elif defined(__linux) && (defined(__x86) || defined (__amd64)) 311# elif __linux && (__i386__ || (__x86_64__ && !__ILP32__) || (__arm__ && __ARM_ARCH == 7))
211# define CORO_ASM 1 312# define CORO_ASM 1
212# elif defined(HAVE_UCONTEXT_H) 313# elif defined HAVE_UCONTEXT_H
213# define CORO_UCONTEXT 1 314# define CORO_UCONTEXT 1
214# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 315# elif defined HAVE_SETJMP_H && defined HAVE_SIGALTSTACK
215# define CORO_SJLJ 1 316# define CORO_SJLJ 1
216# else 317# else
217error unknown or unsupported architecture 318error unknown or unsupported architecture
218# endif 319# endif
219#endif 320#endif
… …
222 323
223#if CORO_UCONTEXT 324#if CORO_UCONTEXT
224 325
225# include <ucontext.h> 326# include <ucontext.h>
226 327
227struct coro_context { 328struct coro_context
329{
228 ucontext_t uc; 330 ucontext_t uc;
229}; 331};
230 332
231# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 333# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
232# define coro_destroy(ctx) (void *)(ctx) 334# define coro_destroy(ctx) (void *)(ctx)
233 335
234#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 336#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
235 337
236# if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 338# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
237# define _GNU_SOURCE /* for linux libc */ 339# define _GNU_SOURCE /* for glibc */
340# endif
341
342/* try to disable well-meant but buggy checks in some libcs */
343# ifdef _FORTIFY_SOURCE
344# undef _FORTIFY_SOURCE
345# undef __USE_FORTIFY_LEVEL /* helps some more when too much has been included already */
238# endif 346# endif
239 347
240# if !CORO_LOSER 348# if !CORO_LOSER
241# include <unistd.h> 349# include <unistd.h>
242# endif 350# endif
… …
261# define coro_jmp_buf sigjmp_buf 369# define coro_jmp_buf sigjmp_buf
262# define coro_setjmp(env) sigsetjmp (env, 0) 370# define coro_setjmp(env) sigsetjmp (env, 0)
263# define coro_longjmp(env) siglongjmp ((env), 1) 371# define coro_longjmp(env) siglongjmp ((env), 1)
264# endif 372# endif
265 373
266struct coro_context { 374struct coro_context
375{
267 coro_jmp_buf env; 376 coro_jmp_buf env;
268}; 377};
269 378
270# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0) 379# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
271# define coro_destroy(ctx) (void *)(ctx) 380# define coro_destroy(ctx) (void *)(ctx)
272 381
273#elif CORO_ASM 382#elif CORO_ASM
274 383
275struct coro_context { 384struct coro_context
385{
276 void **sp; /* must be at offset 0 */ 386 void **sp; /* must be at offset 0 */
277}; 387};
278 388
389#if __i386__ || __x86_64__
279void __attribute__ ((__noinline__, __regparm__(2))) 390void __attribute__ ((__noinline__, __regparm__(2)))
391#else
392void __attribute__ ((__noinline__))
393#endif
280coro_transfer (coro_context *prev, coro_context *next); 394coro_transfer (coro_context *prev, coro_context *next);
281 395
282# define coro_destroy(ctx) (void *)(ctx) 396# define coro_destroy(ctx) (void *)(ctx)
283 397
284#elif CORO_PTHREAD 398#elif CORO_PTHREAD
285 399
286# include <pthread.h> 400# include <pthread.h>
287 401
288extern pthread_mutex_t coro_mutex; 402extern pthread_mutex_t coro_mutex;
289 403
290struct coro_context { 404struct coro_context
405{
291 pthread_cond_t cv; 406 pthread_cond_t cv;
292 pthread_t id; 407 pthread_t id;
293}; 408};
294 409
295void coro_transfer (coro_context *prev, coro_context *next); 410void coro_transfer (coro_context *prev, coro_context *next);
296void coro_destroy (coro_context *ctx); 411void coro_destroy (coro_context *ctx);
297 412
413#elif CORO_FIBER
414
415struct coro_context
416{
417 void *fiber;
418 /* only used for initialisation */
419 coro_func coro;
420 void *arg;
421};
422
423void coro_transfer (coro_context *prev, coro_context *next);
424void coro_destroy (coro_context *ctx);
425
298#endif 426#endif
299 427
300#if __cplusplus 428#if __cplusplus
301} 429}
302#endif 430#endif

Diff Legend

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