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

Comparing libcoro/coro.h (file contents):
Revision 1.32 by root, Fri Nov 7 20:12:26 2008 UTC vs.
Revision 1.60 by root, Fri Nov 18 06:22:05 2016 UTC

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

Diff Legend

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