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

Diff Legend

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