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.38 by root, Fri Nov 14 05:27:08 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.
60 */ 69 */
61 70
62#ifndef CORO_H 71#ifndef CORO_H
63#define CORO_H 72#define CORO_H
64 73
135/* 144/*
136 * This function creates a new coroutine. Apart from a pointer to an 145 * This function creates a new coroutine. Apart from a pointer to an
137 * uninitialised coro_context, it expects a pointer to the entry function 146 * uninitialised coro_context, it expects a pointer to the entry function
138 * and the single pointer value that is given to it as argument. 147 * and the single pointer value that is given to it as argument.
139 * 148 *
140 * Allocating/deallocating the stack is your own responsibility, so there is 149 * Allocating/deallocating the stack is your own responsibility.
141 * no coro_destroy function. 150 *
151 * As a special case, if coro, arg, sptr and ssize are all zero,
152 * then an "empty" coro_context will be created that is suitable
153 * as an initial source for coro_transfer.
154 *
155 * This function is not reentrant, but putting a mutex around it
156 * will work.
142 */ 157 */
143void coro_create (coro_context *ctx, /* an uninitialised coro_context */ 158void coro_create (coro_context *ctx, /* an uninitialised coro_context */
144 coro_func coro, /* the coroutine code to be executed */ 159 coro_func coro, /* the coroutine code to be executed */
145 void *arg, /* a single pointer passed to the coro */ 160 void *arg, /* a single pointer passed to the coro */
146 void *sptr, /* start of stack area */ 161 void *sptr, /* start of stack area */
148 163
149/* 164/*
150 * The following prototype defines the coroutine switching function. It is 165 * The following prototype defines the coroutine switching function. It is
151 * usually implemented as a macro, so watch out. 166 * usually implemented as a macro, so watch out.
152 * 167 *
168 * This function is thread-safe and reentrant.
169 */
170#if 0
153void coro_transfer(coro_context *prev, coro_context *next); 171void coro_transfer (coro_context *prev, coro_context *next);
172#endif
173
174/*
175 * The following prototype defines the coroutine destroy function. It is
176 * usually implemented as a macro, so watch out. It also serves
177 * no purpose unless you want to use the CORO_PTHREAD backend,
178 * where it is used to clean up the thread. You are responsible
179 * for freeing the stack and the context itself.
154 */ 180 *
181 * This function is thread-safe and reentrant.
182 */
183#if 0
184void coro_destroy (coro_context *ctx);
185#endif
155 186
156/* 187/*
157 * That was it. No other user-visible functions are implemented here. 188 * That was it. No other user-visible functions are implemented here.
158 */ 189 */
159 190
185struct coro_context { 216struct coro_context {
186 ucontext_t uc; 217 ucontext_t uc;
187}; 218};
188 219
189# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 220# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
221# define coro_destroy(ctx) (void *)(ctx)
190 222
191#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 223#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
192 224
193# if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 225# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
194# define _GNU_SOURCE /* for linux libc */ 226# define _GNU_SOURCE /* for linux libc */
195# endif 227# endif
196 228
229# if !CORO_LOSER
230# include <unistd.h>
231# endif
232
233/* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */
234# if __sun
235# undef _XOPEN_UNIX
236# define _XOPEN_UNIX 1
237# endif
238
197# include <setjmp.h> 239# include <setjmp.h>
198 240
199struct coro_context { 241struct coro_context {
242#if _XOPEN_UNIX > 0 || CORO_LOSER
200 jmp_buf env; 243 jmp_buf env;
244#else
245 sigjmp_buf env;
246#endif
201}; 247};
202 248
203# if CORO_LINUX || (_XOPEN_SOURCE >= 600) 249# if _XOPEN_UNIX > 0
204# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) 250# define coro_transfer(p,n) do { if (! _setjmp ((p)->env )) _longjmp ((n)->env, 1); } while (0)
251# elif CORO_LOSER
252# define coro_transfer(p,n) do { if (! setjmp ((p)->env )) longjmp ((n)->env, 1); } while (0)
205# else 253# else
206# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) 254# define coro_transfer(p,n) do { if (!sigsetjmp ((p)->env, 0)) siglongjmp ((n)->env, 1); } while (0)
207# endif 255# endif
256
257# define coro_destroy(ctx) (void *)(ctx)
208 258
209#elif CORO_ASM 259#elif CORO_ASM
210 260
211struct coro_context { 261struct coro_context {
212 volatile void **sp; /* must be at offset 0 */ 262 void **sp; /* must be at offset 0 */
213}; 263};
214 264
215void __attribute__ ((__noinline__, __regparm__(2))) 265void __attribute__ ((__noinline__, __regparm__(2)))
216coro_transfer (coro_context *prev, coro_context *next); 266coro_transfer (coro_context *prev, coro_context *next);
217 267
268# define coro_destroy(ctx) (void *)(ctx)
269
218#elif CORO_PTHREAD 270#elif CORO_PTHREAD
219 271
220#include <pthread.h> 272# include <pthread.h>
221 273
222extern pthread_mutex_t coro_mutex; 274extern pthread_mutex_t coro_mutex;
223 275
224struct coro_context { 276struct coro_context {
225 pthread_cond_t c; 277 pthread_cond_t cv;
278 pthread_t id;
226}; 279};
227 280
228void coro_transfer (coro_context *prev, coro_context *next); 281void coro_transfer (coro_context *prev, coro_context *next);
282void coro_destroy (coro_context *ctx);
229 283
230#endif 284#endif
231 285
232#endif 286#endif
233 287

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines