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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines