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

Comparing libcoro/coro.h (file contents):
Revision 1.29 by root, Mon Nov 3 16:05:38 2008 UTC vs.
Revision 1.39 by root, Sun Nov 16 00:55:41 2008 UTC

55 * 2008-03-02 Switched to 2-clause BSD license with GPL exception. 55 * 2008-03-02 Switched to 2-clause BSD license with GPL exception.
56 * 2008-04-04 New (but highly unrecommended) pthreads backend. 56 * 2008-04-04 New (but highly unrecommended) pthreads backend.
57 * 2008-04-24 Reinstate CORO_LOSER (had wrong stack adjustments). 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. 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. 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.
62 * 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 * 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.
60 */ 70 */
61 71
62#ifndef CORO_H 72#ifndef CORO_H
63#define CORO_H 73#define CORO_H
64 74
106 * SGI's version of Microsoft's NT ;) 116 * SGI's version of Microsoft's NT ;)
107 * 117 *
108 * -DCORO_ASM 118 * -DCORO_ASM
109 * 119 *
110 * Handcoded assembly, known to work only on a few architectures/ABI: 120 * 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. 121 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs.
112 * 122 *
113 * -DCORO_PTHREAD 123 * -DCORO_PTHREAD
114 * 124 *
115 * Use the pthread API. You have to provide <pthread.h> and -lpthread. 125 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
126 * This is likely the slowest backend, and it also does not support fork(),
127 * so avoid it at all costs.
116 * 128 *
117 * If you define neither of these symbols, coro.h will try to autodetect 129 * If you define neither of these symbols, coro.h will try to autodetect
118 * the model. This currently works for CORO_LOSER only. For the other 130 * the model. This currently works for CORO_LOSER only. For the other
119 * alternatives you should check (e.g. using autoconf) and define the 131 * alternatives you should check (e.g. using autoconf) and define the
120 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 132 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
135/* 147/*
136 * This function creates a new coroutine. Apart from a pointer to an 148 * This function creates a new coroutine. Apart from a pointer to an
137 * uninitialised coro_context, it expects a pointer to the entry function 149 * uninitialised coro_context, it expects a pointer to the entry function
138 * and the single pointer value that is given to it as argument. 150 * and the single pointer value that is given to it as argument.
139 * 151 *
140 * Allocating/deallocating the stack is your own responsibility, so there is 152 * Allocating/deallocating the stack is your own responsibility.
141 * no coro_destroy function. 153 *
154 * As a special case, if coro, arg, sptr and ssize are all zero,
155 * then an "empty" coro_context will be created that is suitable
156 * as an initial source for coro_transfer.
157 *
158 * This function is not reentrant, but putting a mutex around it
159 * will work.
142 */ 160 */
143void coro_create (coro_context *ctx, /* an uninitialised coro_context */ 161void coro_create (coro_context *ctx, /* an uninitialised coro_context */
144 coro_func coro, /* the coroutine code to be executed */ 162 coro_func coro, /* the coroutine code to be executed */
145 void *arg, /* a single pointer passed to the coro */ 163 void *arg, /* a single pointer passed to the coro */
146 void *sptr, /* start of stack area */ 164 void *sptr, /* start of stack area */
148 166
149/* 167/*
150 * The following prototype defines the coroutine switching function. It is 168 * The following prototype defines the coroutine switching function. It is
151 * usually implemented as a macro, so watch out. 169 * usually implemented as a macro, so watch out.
152 * 170 *
171 * This function is thread-safe and reentrant.
172 */
173#if 0
153void coro_transfer(coro_context *prev, coro_context *next); 174void coro_transfer (coro_context *prev, coro_context *next);
175#endif
176
177/*
178 * The following prototype defines the coroutine destroy function. It is
179 * usually implemented as a macro, so watch out. It also serves
180 * no purpose unless you want to use the CORO_PTHREAD backend,
181 * where it is used to clean up the thread. You are responsible
182 * for freeing the stack and the context itself.
154 */ 183 *
184 * This function is thread-safe and reentrant.
185 */
186#if 0
187void coro_destroy (coro_context *ctx);
188#endif
155 189
156/* 190/*
157 * That was it. No other user-visible functions are implemented here. 191 * That was it. No other user-visible functions are implemented here.
158 */ 192 */
159 193
185struct coro_context { 219struct coro_context {
186 ucontext_t uc; 220 ucontext_t uc;
187}; 221};
188 222
189# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 223# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
224# define coro_destroy(ctx) (void *)(ctx)
190 225
191#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 226#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
192 227
193# if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 228# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
194# define _GNU_SOURCE /* for linux libc */ 229# define _GNU_SOURCE /* for linux libc */
195# endif 230# endif
196 231
232# if !CORO_LOSER
233# include <unistd.h>
234# endif
235
236/* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */
237# if __sun
238# undef _XOPEN_UNIX
239# define _XOPEN_UNIX 1
240# endif
241
197# include <setjmp.h> 242# include <setjmp.h>
198 243
199struct coro_context { 244struct coro_context {
245#if _XOPEN_UNIX > 0 || CORO_LOSER
200 jmp_buf env; 246 jmp_buf env;
247#else
248 sigjmp_buf env;
249#endif
201}; 250};
202 251
203# if CORO_LINUX || (_XOPEN_SOURCE >= 600) 252# if _XOPEN_UNIX > 0
204# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) 253# define coro_transfer(p,n) do { if (! _setjmp ((p)->env )) _longjmp ((n)->env, 1); } while (0)
254# elif CORO_LOSER
255# define coro_transfer(p,n) do { if (! setjmp ((p)->env )) longjmp ((n)->env, 1); } while (0)
205# else 256# else
206# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) 257# define coro_transfer(p,n) do { if (!sigsetjmp ((p)->env, 0)) siglongjmp ((n)->env, 1); } while (0)
207# endif 258# endif
259
260# define coro_destroy(ctx) (void *)(ctx)
208 261
209#elif CORO_ASM 262#elif CORO_ASM
210 263
211struct coro_context { 264struct coro_context {
212 volatile void **sp; /* must be at offset 0 */ 265 void **sp; /* must be at offset 0 */
213}; 266};
214 267
215void __attribute__ ((__noinline__, __regparm__(2))) 268void __attribute__ ((__noinline__, __regparm__(2)))
216coro_transfer (coro_context *prev, coro_context *next); 269coro_transfer (coro_context *prev, coro_context *next);
217 270
271# define coro_destroy(ctx) (void *)(ctx)
272
218#elif CORO_PTHREAD 273#elif CORO_PTHREAD
219 274
220#include <pthread.h> 275# include <pthread.h>
221 276
222extern pthread_mutex_t coro_mutex; 277extern pthread_mutex_t coro_mutex;
223 278
224struct coro_context { 279struct coro_context {
225 pthread_cond_t c; 280 pthread_cond_t cv;
281 pthread_t id;
226}; 282};
227 283
228void coro_transfer (coro_context *prev, coro_context *next); 284void coro_transfer (coro_context *prev, coro_context *next);
285void coro_destroy (coro_context *ctx);
229 286
230#endif 287#endif
231 288
232#endif 289#endif
233 290

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines