ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.h
Revision: 1.45
Committed: Mon May 30 02:21:54 2011 UTC (13 years ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.44: +1 -0 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 /*
2 root 1.42 * Copyright (c) 2001-2009 Marc Alexander Lehmann <schmorp@schmorp.de>
3 root 1.1 *
4     * Redistribution and use in source and binary forms, with or without modifica-
5     * tion, are permitted provided that the following conditions are met:
6     *
7     * 1. Redistributions of source code must retain the above copyright notice,
8     * this list of conditions and the following disclaimer.
9     *
10     * 2. Redistributions in binary form must reproduce the above copyright
11     * notice, this list of conditions and the following disclaimer in the
12     * documentation and/or other materials provided with the distribution.
13     *
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-
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-
18     * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
22     * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
23     * OF THE POSSIBILITY OF SUCH DAMAGE.
24     *
25 root 1.24 * 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     *
36 root 1.1 * This library is modelled strictly after Ralf S. Engelschalls article at
37 root 1.24 * http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must
38 root 1.1 * go to Ralf S. Engelschall <rse@engelschall.com>.
39     *
40     * This coroutine library is very much stripped down. You should either
41 pcg 1.7 * build your own process abstraction using it or - better - just use GNU
42 root 1.1 * Portable Threads, http://www.gnu.org/software/pth/.
43 root 1.4 *
44 root 1.1 */
45    
46 root 1.14 /*
47     * 2006-10-26 Include stddef.h on OS X to work around one of its bugs.
48     * Reported by Michael_G_Schwern.
49 root 1.17 * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux.
50 root 1.20 * 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected.
51 root 1.21 * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600.
52 root 1.22 * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance
53     * on SIGUSR2 and sigaltstack in Crossfire).
54 root 1.23 * 2008-01-21 Disable CFI usage on anything but GNU/Linux.
55 root 1.24 * 2008-03-02 Switched to 2-clause BSD license with GPL exception.
56 root 1.25 * 2008-04-04 New (but highly unrecommended) pthreads backend.
57 root 1.26 * 2008-04-24 Reinstate CORO_LOSER (had wrong stack adjustments).
58 root 1.28 * 2008-10-30 Support assembly method on x86 with and without frame pointer.
59 root 1.29 * 2008-11-03 Use a global asm statement for CORO_ASM, idea by pippijn.
60 root 1.30 * 2008-11-05 Hopefully fix misaligned stacks with CORO_ASM/SETJMP.
61 root 1.31 * 2008-11-07 rbp wasn't saved in CORO_ASM on x86_64.
62 root 1.32 * 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 root 1.33 * do not rely on makecontext passing a void * correctly.
66     * try harder to get _setjmp/_longjmp.
67     * major code cleanup/restructuring.
68 root 1.37 * 2008-11-10 the .cfi hacks are no longer needed.
69 root 1.39 * 2008-11-16 work around a freebsd pthread bug.
70 root 1.40 * 2008-11-19 define coro_*jmp symbols for easier porting.
71 root 1.41 * 2009-06-23 tentative win32-backend support for mingw32 (Yasuhiro Matsumoto).
72 root 1.44 * 2010-12-03 tentative support for uclibc (which lacks all sorts of things).
73 root 1.45 * 2011-05-30 set initial callee-saved-registers to zero with CORO_ASM.
74 root 1.14 */
75    
76 root 1.1 #ifndef CORO_H
77     #define CORO_H
78    
79 root 1.43 #if __cplusplus
80     extern "C" {
81     #endif
82    
83 root 1.11 #define CORO_VERSION 2
84    
85     /*
86     * Changes since API version 1:
87 root 1.12 * replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER
88 root 1.11 */
89 root 1.9
90 root 1.2 /*
91     * This library consists of only three files
92 root 1.9 * coro.h, coro.c and LICENSE (and optionally README)
93 root 1.2 *
94     * It implements what is known as coroutines, in a hopefully
95     * portable way. At the moment you have to define which kind
96     * of implementation flavour you want:
97     *
98     * -DCORO_UCONTEXT
99     *
100     * This flavour uses SUSv2's get/set/swap/makecontext functions that
101     * unfortunately only newer unices support.
102     *
103     * -DCORO_SJLJ
104     *
105 root 1.13 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
106 root 1.2 * 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
108 root 1.24 * all unices.
109 root 1.3 *
110     * -DCORO_LINUX
111     *
112 root 1.24 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
113     * (it is very fast and therefore recommended over other methods, but
114     * doesn't work with anything newer).
115 root 1.2 *
116 root 1.11 * -DCORO_LOSER
117 root 1.2 *
118     * Microsoft's highly proprietary platform doesn't support sigaltstack, and
119     * this automatically selects a suitable workaround for this platform.
120     * (untested)
121     *
122 root 1.5 * -DCORO_IRIX
123     *
124     * SGI's version of Microsoft's NT ;)
125     *
126 root 1.22 * -DCORO_ASM
127     *
128     * Handcoded assembly, known to work only on a few architectures/ABI:
129 root 1.39 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs.
130 root 1.22 *
131 root 1.25 * -DCORO_PTHREAD
132     *
133     * Use the pthread API. You have to provide <pthread.h> and -lpthread.
134 root 1.39 * This is likely the slowest backend, and it also does not support fork(),
135     * so avoid it at all costs.
136 root 1.25 *
137 root 1.2 * If you define neither of these symbols, coro.h will try to autodetect
138 root 1.24 * the model. This currently works for CORO_LOSER only. For the other
139 root 1.2 * alternatives you should check (e.g. using autoconf) and define the
140     * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
141     */
142    
143     /*
144 root 1.6 * This is the type for the initialization function of a new coroutine.
145 root 1.2 */
146 root 1.1 typedef void (*coro_func)(void *);
147 root 1.2
148     /*
149 root 1.19 * A coroutine state is saved in the following structure. Treat it as an
150 root 1.2 * opaque type. errno and sigmask might be saved, but don't rely on it,
151 root 1.19 * implement your own switching primitive if you need that.
152 root 1.2 */
153     typedef struct coro_context coro_context;
154    
155     /*
156     * This function creates a new coroutine. Apart from a pointer to an
157 root 1.13 * uninitialised coro_context, it expects a pointer to the entry function
158 root 1.2 * and the single pointer value that is given to it as argument.
159     *
160 root 1.32 * Allocating/deallocating the stack is your own responsibility.
161     *
162     * As a special case, if coro, arg, sptr and ssize are all zero,
163 root 1.38 * then an "empty" coro_context will be created that is suitable
164 root 1.32 * as an initial source for coro_transfer.
165     *
166     * This function is not reentrant, but putting a mutex around it
167     * will work.
168 root 1.2 */
169 root 1.19 void coro_create (coro_context *ctx, /* an uninitialised coro_context */
170     coro_func coro, /* the coroutine code to be executed */
171     void *arg, /* a single pointer passed to the coro */
172     void *sptr, /* start of stack area */
173     long ssize); /* size of stack area */
174 root 1.2
175     /*
176     * The following prototype defines the coroutine switching function. It is
177     * usually implemented as a macro, so watch out.
178     *
179 root 1.32 * This function is thread-safe and reentrant.
180 root 1.2 */
181 root 1.32 #if 0
182     void coro_transfer (coro_context *prev, coro_context *next);
183     #endif
184    
185     /*
186     * The following prototype defines the coroutine destroy function. It is
187     * usually implemented as a macro, so watch out. It also serves
188 root 1.38 * no purpose unless you want to use the CORO_PTHREAD backend,
189     * where it is used to clean up the thread. You are responsible
190     * for freeing the stack and the context itself.
191 root 1.32 *
192     * This function is thread-safe and reentrant.
193     */
194     #if 0
195     void coro_destroy (coro_context *ctx);
196     #endif
197 root 1.2
198     /*
199     * That was it. No other user-visible functions are implemented here.
200     */
201    
202 root 1.5 /*****************************************************************************/
203    
204 root 1.11 #if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
205 root 1.5 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
206 root 1.25 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
207     && !defined(CORO_PTHREAD)
208 root 1.2 # if defined(WINDOWS)
209 root 1.11 # define CORO_LOSER 1 /* you don't win with windoze */
210 root 1.22 # elif defined(__linux) && (defined(__x86) || defined (__amd64))
211     # define CORO_ASM 1
212 root 1.2 # elif defined(HAVE_UCONTEXT_H)
213     # define CORO_UCONTEXT 1
214     # elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
215     # define CORO_SJLJ 1
216     # else
217 root 1.1 error unknown or unsupported architecture
218 root 1.2 # endif
219 root 1.1 #endif
220    
221 root 1.5 /*****************************************************************************/
222    
223 root 1.1 #if CORO_UCONTEXT
224    
225 root 1.22 # include <ucontext.h>
226 root 1.1
227 root 1.2 struct coro_context {
228 root 1.1 ucontext_t uc;
229 root 1.2 };
230 root 1.1
231 root 1.22 # define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
232 root 1.32 # define coro_destroy(ctx) (void *)(ctx)
233 root 1.1
234 root 1.11 #elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
235 root 1.1
236 root 1.22 # if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
237     # define _GNU_SOURCE /* for linux libc */
238     # endif
239 root 1.8
240 root 1.33 # if !CORO_LOSER
241     # include <unistd.h>
242     # endif
243    
244 root 1.36 /* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */
245     # if __sun
246     # undef _XOPEN_UNIX
247     # define _XOPEN_UNIX 1
248     # endif
249    
250 root 1.22 # include <setjmp.h>
251 root 1.1
252 root 1.40 # if _XOPEN_UNIX > 0 || defined (_setjmp)
253     # define coro_jmp_buf jmp_buf
254     # define coro_setjmp(env) _setjmp (env)
255     # define coro_longjmp(env) _longjmp ((env), 1)
256 root 1.34 # elif CORO_LOSER
257 root 1.40 # define coro_jmp_buf jmp_buf
258     # define coro_setjmp(env) setjmp (env)
259     # define coro_longjmp(env) longjmp ((env), 1)
260 root 1.22 # else
261 root 1.40 # define coro_jmp_buf sigjmp_buf
262     # define coro_setjmp(env) sigsetjmp (env, 0)
263     # define coro_longjmp(env) siglongjmp ((env), 1)
264 root 1.22 # endif
265    
266 root 1.40 struct coro_context {
267     coro_jmp_buf env;
268     };
269    
270     # define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
271 root 1.32 # define coro_destroy(ctx) (void *)(ctx)
272    
273 root 1.22 #elif CORO_ASM
274    
275     struct coro_context {
276 root 1.34 void **sp; /* must be at offset 0 */
277 root 1.22 };
278    
279 root 1.27 void __attribute__ ((__noinline__, __regparm__(2)))
280 root 1.29 coro_transfer (coro_context *prev, coro_context *next);
281 root 1.25
282 root 1.32 # define coro_destroy(ctx) (void *)(ctx)
283    
284 root 1.25 #elif CORO_PTHREAD
285    
286 root 1.32 # include <pthread.h>
287 root 1.25
288     extern pthread_mutex_t coro_mutex;
289    
290     struct coro_context {
291 root 1.32 pthread_cond_t cv;
292     pthread_t id;
293 root 1.25 };
294    
295     void coro_transfer (coro_context *prev, coro_context *next);
296 root 1.32 void coro_destroy (coro_context *ctx);
297 root 1.1
298     #endif
299    
300 root 1.43 #if __cplusplus
301     }
302     #endif
303    
304 root 1.1 #endif
305