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

Comparing libcoro/coro.h (file contents):
Revision 1.20 by root, Fri Apr 27 19:26:18 2007 UTC vs.
Revision 1.31 by root, Fri Nov 7 16:39:35 2008 UTC

1/* 1/*
2 * Copyright (c) 2001-2006 Marc Alexander Lehmann <schmorp@schmorp.de> 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 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/.
38/* 46/*
39 * 2006-10-26 Include stddef.h on OS X to work around one of its bugs. 47 * 2006-10-26 Include stddef.h on OS X to work around one of its bugs.
40 * Reported by Michael_G_Schwern. 48 * Reported by Michael_G_Schwern.
41 * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux. 49 * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux.
42 * 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected. 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.
43 */ 62 */
44 63
45#ifndef CORO_H 64#ifndef CORO_H
46#define CORO_H 65#define CORO_H
47 66
62 * 81 *
63 * -DCORO_UCONTEXT 82 * -DCORO_UCONTEXT
64 * 83 *
65 * This flavour uses SUSv2's get/set/swap/makecontext functions that 84 * This flavour uses SUSv2's get/set/swap/makecontext functions that
66 * unfortunately only newer unices support. 85 * unfortunately only newer unices support.
67 * Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
68 * 86 *
69 * -DCORO_SJLJ 87 * -DCORO_SJLJ
70 * 88 *
71 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to 89 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
72 * do it's job. Coroutine creation is much slower than UCONTEXT, but 90 * do it's job. Coroutine creation is much slower than UCONTEXT, but
73 * context switching is often a bit cheaper. It should work on almost 91 * context switching is often a bit cheaper. It should work on almost
74 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below 92 * all unices.
75 * do not work with any sane model (neither sigaltstack nor context
76 * functions are implemented)
77 * 93 *
78 * -DCORO_LINUX 94 * -DCORO_LINUX
79 * 95 *
80 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 96 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
81 * (it is very fast and therefore recommended over other methods). 97 * (it is very fast and therefore recommended over other methods, but
98 * doesn't work with anything newer).
82 * 99 *
83 * -DCORO_LOSER 100 * -DCORO_LOSER
84 * 101 *
85 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 102 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
86 * this automatically selects a suitable workaround for this platform. 103 * this automatically selects a suitable workaround for this platform.
88 * 105 *
89 * -DCORO_IRIX 106 * -DCORO_IRIX
90 * 107 *
91 * SGI's version of Microsoft's NT ;) 108 * SGI's version of Microsoft's NT ;)
92 * 109 *
110 * -DCORO_ASM
111 *
112 * Handcoded assembly, known to work only on a few architectures/ABI:
113 * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on.
114 *
115 * -DCORO_PTHREAD
116 *
117 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
118 *
93 * If you define neither of these symbols, coro.h will try to autodetect 119 * If you define neither of these symbols, coro.h will try to autodetect
94 * the model. This currently works for CORO_LOSER only. For the other 120 * the model. This currently works for CORO_LOSER only. For the other
95 * alternatives you should check (e.g. using autoconf) and define the 121 * alternatives you should check (e.g. using autoconf) and define the
96 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 122 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
97 */ 123 */
98 124
99/* 125/*
135 161
136/*****************************************************************************/ 162/*****************************************************************************/
137 163
138#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ 164#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
139 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 165 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
166 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
140 && !defined(CORO_IRIX) 167 && !defined(CORO_PTHREAD)
141# if defined(WINDOWS) 168# if defined(WINDOWS)
142# define CORO_LOSER 1 /* you don't win with windoze */ 169# define CORO_LOSER 1 /* you don't win with windoze */
143# elif defined(__linux) && defined(__x86) 170# elif defined(__linux) && (defined(__x86) || defined (__amd64))
171# define CORO_ASM 1
144# elif defined(HAVE_UCONTEXT_H) 172# elif defined(HAVE_UCONTEXT_H)
145# define CORO_UCONTEXT 1 173# define CORO_UCONTEXT 1
146# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 174# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
147# define CORO_SJLJ 1 175# define CORO_SJLJ 1
148# else 176# else
152 180
153/*****************************************************************************/ 181/*****************************************************************************/
154 182
155#if CORO_UCONTEXT 183#if CORO_UCONTEXT
156 184
157#include <ucontext.h> 185# include <ucontext.h>
158 186
159struct coro_context { 187struct coro_context {
160 ucontext_t uc; 188 ucontext_t uc;
161}; 189};
162 190
163#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 191# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
164 192
165#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 193#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
166 194
167#if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 195# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
168# define _GNU_SOURCE /* for linux libc */ 196# define _GNU_SOURCE /* for linux libc */
197# endif
198
199# include <setjmp.h>
200
201struct coro_context {
202 jmp_buf env;
203};
204
205# if CORO_LINUX || (_XOPEN_SOURCE >= 600)
206# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0)
207# else
208# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0)
209# endif
210
211#elif CORO_ASM
212
213struct coro_context {
214 volatile void **sp; /* must be at offset 0 */
215};
216
217void __attribute__ ((__noinline__, __regparm__(2)))
218coro_transfer (coro_context *prev, coro_context *next);
219
220#elif CORO_PTHREAD
221
222#include <pthread.h>
223
224extern pthread_mutex_t coro_mutex;
225
226struct coro_context {
227 pthread_cond_t c;
228};
229
230void coro_transfer (coro_context *prev, coro_context *next);
231
169#endif 232#endif
170 233
171#include <setjmp.h>
172
173struct coro_context {
174 jmp_buf env;
175};
176
177#if CORO_LINUX
178# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0)
179#else
180# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0)
181#endif 234#endif
182 235
183#endif
184
185#endif
186

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines