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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines