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

Diff Legend

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