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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines