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.42 by root, Sat Jul 11 14:24:13 2009 UTC

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

Diff Legend

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