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

Comparing libcoro/coro.h (file contents):
Revision 1.24 by root, Sun Mar 2 16:10:22 2008 UTC vs.
Revision 1.38 by root, Fri Nov 14 05:27:08 2008 UTC

51 * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600. 51 * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600.
52 * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance 52 * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance
53 * on SIGUSR2 and sigaltstack in Crossfire). 53 * on SIGUSR2 and sigaltstack in Crossfire).
54 * 2008-01-21 Disable CFI usage on anything but GNU/Linux. 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. 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.
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.
56 */ 69 */
57 70
58#ifndef CORO_H 71#ifndef CORO_H
59#define CORO_H 72#define CORO_H
60 73
104 * -DCORO_ASM 117 * -DCORO_ASM
105 * 118 *
106 * Handcoded assembly, known to work only on a few architectures/ABI: 119 * Handcoded assembly, known to work only on a few architectures/ABI:
107 * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on. 120 * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on.
108 * 121 *
122 * -DCORO_PTHREAD
123 *
124 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
125 *
109 * If you define neither of these symbols, coro.h will try to autodetect 126 * If you define neither of these symbols, coro.h will try to autodetect
110 * the model. This currently works for CORO_LOSER only. For the other 127 * the model. This currently works for CORO_LOSER only. For the other
111 * alternatives you should check (e.g. using autoconf) and define the 128 * alternatives you should check (e.g. using autoconf) and define the
112 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 129 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
113 */ 130 */
127/* 144/*
128 * 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
129 * uninitialised coro_context, it expects a pointer to the entry function 146 * uninitialised coro_context, it expects a pointer to the entry function
130 * 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.
131 * 148 *
132 * Allocating/deallocating the stack is your own responsibility, so there is 149 * Allocating/deallocating the stack is your own responsibility.
133 * 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.
134 */ 157 */
135void coro_create (coro_context *ctx, /* an uninitialised coro_context */ 158void coro_create (coro_context *ctx, /* an uninitialised coro_context */
136 coro_func coro, /* the coroutine code to be executed */ 159 coro_func coro, /* the coroutine code to be executed */
137 void *arg, /* a single pointer passed to the coro */ 160 void *arg, /* a single pointer passed to the coro */
138 void *sptr, /* start of stack area */ 161 void *sptr, /* start of stack area */
140 163
141/* 164/*
142 * The following prototype defines the coroutine switching function. It is 165 * The following prototype defines the coroutine switching function. It is
143 * usually implemented as a macro, so watch out. 166 * usually implemented as a macro, so watch out.
144 * 167 *
168 * This function is thread-safe and reentrant.
169 */
170#if 0
145void 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.
146 */ 180 *
181 * This function is thread-safe and reentrant.
182 */
183#if 0
184void coro_destroy (coro_context *ctx);
185#endif
147 186
148/* 187/*
149 * That was it. No other user-visible functions are implemented here. 188 * That was it. No other user-visible functions are implemented here.
150 */ 189 */
151 190
152/*****************************************************************************/ 191/*****************************************************************************/
153 192
154#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ 193#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
155 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 194 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
156 && !defined(CORO_IRIX) && !defined(CORO_ASM) 195 && !defined(CORO_IRIX) && !defined(CORO_ASM) \
196 && !defined(CORO_PTHREAD)
157# if defined(WINDOWS) 197# if defined(WINDOWS)
158# define CORO_LOSER 1 /* you don't win with windoze */ 198# define CORO_LOSER 1 /* you don't win with windoze */
159# elif defined(__linux) && (defined(__x86) || defined (__amd64)) 199# elif defined(__linux) && (defined(__x86) || defined (__amd64))
160# define CORO_ASM 1 200# define CORO_ASM 1
161# elif defined(HAVE_UCONTEXT_H) 201# elif defined(HAVE_UCONTEXT_H)
176struct coro_context { 216struct coro_context {
177 ucontext_t uc; 217 ucontext_t uc;
178}; 218};
179 219
180# 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)
181 222
182#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 223#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
183 224
184# if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 225# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
185# define _GNU_SOURCE /* for linux libc */ 226# define _GNU_SOURCE /* for linux libc */
186# endif 227# endif
187 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
188# include <setjmp.h> 239# include <setjmp.h>
189 240
190struct coro_context { 241struct coro_context {
242#if _XOPEN_UNIX > 0 || CORO_LOSER
191 jmp_buf env; 243 jmp_buf env;
244#else
245 sigjmp_buf env;
246#endif
192}; 247};
193 248
194# if CORO_LINUX || (_XOPEN_SOURCE >= 600) 249# if _XOPEN_UNIX > 0
195# 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)
196# else 253# else
197# 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)
198# endif 255# endif
256
257# define coro_destroy(ctx) (void *)(ctx)
199 258
200#elif CORO_ASM 259#elif CORO_ASM
201 260
202struct coro_context { 261struct coro_context {
203 volatile void **sp; 262 void **sp; /* must be at offset 0 */
204}; 263};
205 264
206void __attribute__ ((__noinline__, __fastcall__)) 265void __attribute__ ((__noinline__, __regparm__(2)))
207 coro_transfer(coro_context *prev, coro_context *next); 266coro_transfer (coro_context *prev, coro_context *next);
208 267
209#endif 268# define coro_destroy(ctx) (void *)(ctx)
210 269
211#endif 270#elif CORO_PTHREAD
212 271
272# include <pthread.h>
273
274extern pthread_mutex_t coro_mutex;
275
276struct coro_context {
277 pthread_cond_t cv;
278 pthread_t id;
279};
280
281void coro_transfer (coro_context *prev, coro_context *next);
282void coro_destroy (coro_context *ctx);
283
284#endif
285
286#endif
287

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines