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

Comparing libcoro/coro.h (file contents):
Revision 1.32 by root, Fri Nov 7 20:12:26 2008 UTC vs.
Revision 1.45 by root, Mon May 30 02:21:54 2011 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,
… …
60 * 2008-11-05 Hopefully fix misaligned stacks with CORO_ASM/SETJMP. 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. 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. 62 * introduce coro_destroy, which is a nop except for pthreads.
63 * speed up CORO_PTHREAD. Do no longer leak threads either. 63 * speed up CORO_PTHREAD. Do no longer leak threads either.
64 * coro_create now allows one to create source coro_contexts. 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).
72 * 2010-12-03 tentative support for uclibc (which lacks all sorts of things).
73 * 2011-05-30 set initial callee-saved-registers to zero with CORO_ASM.
65 */ 74 */
66 75
67#ifndef CORO_H 76#ifndef CORO_H
68#define CORO_H 77#define CORO_H
78
79#if __cplusplus
80extern "C" {
81#endif
69 82
70#define CORO_VERSION 2 83#define CORO_VERSION 2
71 84
72/* 85/*
73 * Changes since API version 1: 86 * Changes since API version 1:
… …
111 * SGI's version of Microsoft's NT ;) 124 * SGI's version of Microsoft's NT ;)
112 * 125 *
113 * -DCORO_ASM 126 * -DCORO_ASM
114 * 127 *
115 * Handcoded assembly, known to work only on a few architectures/ABI: 128 * Handcoded assembly, known to work only on a few architectures/ABI:
116 * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on. 129 * GCC + x86/IA32 and amd64/x86_64 + GNU/Linux and a few BSDs.
117 * 130 *
118 * -DCORO_PTHREAD 131 * -DCORO_PTHREAD
119 * 132 *
120 * Use the pthread API. You have to provide <pthread.h> and -lpthread. 133 * Use the pthread API. You have to provide <pthread.h> and -lpthread.
134 * This is likely the slowest backend, and it also does not support fork(),
135 * so avoid it at all costs.
121 * 136 *
122 * If you define neither of these symbols, coro.h will try to autodetect 137 * If you define neither of these symbols, coro.h will try to autodetect
123 * the model. This currently works for CORO_LOSER only. For the other 138 * the model. This currently works for CORO_LOSER only. For the other
124 * alternatives you should check (e.g. using autoconf) and define the 139 * alternatives you should check (e.g. using autoconf) and define the
125 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 140 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
… …
143 * and the single pointer value that is given to it as argument. 158 * and the single pointer value that is given to it as argument.
144 * 159 *
145 * Allocating/deallocating the stack is your own responsibility. 160 * Allocating/deallocating the stack is your own responsibility.
146 * 161 *
147 * As a special case, if coro, arg, sptr and ssize are all zero, 162 * 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 163 * then an "empty" coro_context will be created that is suitable
149 * as an initial source for coro_transfer. 164 * as an initial source for coro_transfer.
150 * 165 *
151 * This function is not reentrant, but putting a mutex around it 166 * This function is not reentrant, but putting a mutex around it
152 * will work. 167 * will work.
153 */ 168 */
… …
168#endif 183#endif
169 184
170/* 185/*
171 * The following prototype defines the coroutine destroy function. It is 186 * The following prototype defines the coroutine destroy function. It is
172 * usually implemented as a macro, so watch out. It also serves 187 * usually implemented as a macro, so watch out. It also serves
173 * no purpose unless you want to use the CORO_PTHREAD backend. 188 * no purpose unless you want to use the CORO_PTHREAD backend,
189 * where it is used to clean up the thread. You are responsible
190 * for freeing the stack and the context itself.
174 * 191 *
175 * This function is thread-safe and reentrant. 192 * This function is thread-safe and reentrant.
176 */ 193 */
177#if 0 194#if 0
178void coro_destroy (coro_context *ctx); 195void coro_destroy (coro_context *ctx);
… …
218 235
219# if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 236# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
220# define _GNU_SOURCE /* for linux libc */ 237# define _GNU_SOURCE /* for linux libc */
221# endif 238# endif
222 239
240# if !CORO_LOSER
241# include <unistd.h>
242# endif
243
244/* solaris is hopelessly borked, it expands _XOPEN_UNIX to nothing */
245# if __sun
246# undef _XOPEN_UNIX
247# define _XOPEN_UNIX 1
248# endif
249
223# include <setjmp.h> 250# include <setjmp.h>
224 251
252# if _XOPEN_UNIX > 0 || defined (_setjmp)
253# define coro_jmp_buf jmp_buf
254# define coro_setjmp(env) _setjmp (env)
255# define coro_longjmp(env) _longjmp ((env), 1)
256# elif CORO_LOSER
257# define coro_jmp_buf jmp_buf
258# define coro_setjmp(env) setjmp (env)
259# define coro_longjmp(env) longjmp ((env), 1)
260# else
261# define coro_jmp_buf sigjmp_buf
262# define coro_setjmp(env) sigsetjmp (env, 0)
263# define coro_longjmp(env) siglongjmp ((env), 1)
264# endif
265
225struct coro_context { 266struct coro_context {
226 jmp_buf env; 267 coro_jmp_buf env;
227}; 268};
228 269
229# if CORO_LINUX || (_XOPEN_SOURCE >= 600)
230# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) 270# define coro_transfer(p,n) do { if (!coro_setjmp ((p)->env)) coro_longjmp ((n)->env); } while (0)
231# else
232# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0)
233# endif
234
235# define coro_destroy(ctx) (void *)(ctx) 271# define coro_destroy(ctx) (void *)(ctx)
236 272
237#elif CORO_ASM 273#elif CORO_ASM
238 274
239struct coro_context { 275struct coro_context {
240 volatile void **sp; /* must be at offset 0 */ 276 void **sp; /* must be at offset 0 */
241}; 277};
242 278
243void __attribute__ ((__noinline__, __regparm__(2))) 279void __attribute__ ((__noinline__, __regparm__(2)))
244coro_transfer (coro_context *prev, coro_context *next); 280coro_transfer (coro_context *prev, coro_context *next);
245 281
… …
259void coro_transfer (coro_context *prev, coro_context *next); 295void coro_transfer (coro_context *prev, coro_context *next);
260void coro_destroy (coro_context *ctx); 296void coro_destroy (coro_context *ctx);
261 297
262#endif 298#endif
263 299
300#if __cplusplus
301}
264#endif 302#endif
265 303
304#endif
305

Diff Legend

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