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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines