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

Comparing libcoro/coro.h (file contents):
Revision 1.12 by root, Sat Aug 20 01:07:45 2005 UTC vs.
Revision 1.22 by root, Wed May 2 05:53:26 2007 UTC

1/* 1/*
2 * Copyright (c) 2001-2005 Marc Alexander Lehmann <schmorp@schmorp.de> 2 * Copyright (c) 2001-2006 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,
33 * build your own process abstraction using it or - better - just use GNU 33 * build your own process abstraction using it or - better - just use GNU
34 * Portable Threads, http://www.gnu.org/software/pth/. 34 * Portable Threads, http://www.gnu.org/software/pth/.
35 * 35 *
36 */ 36 */
37 37
38/*
39 * 2006-10-26 Include stddef.h on OS X to work around one of its bugs.
40 * Reported by Michael_G_Schwern.
41 * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux.
42 * 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected.
43 * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600.
44 * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance
45 * on SIGUSR2 and sigaltstack in Crossfire).
46 */
47
38#ifndef CORO_H 48#ifndef CORO_H
39#define CORO_H 49#define CORO_H
40 50
41#define CORO_VERSION 2 51#define CORO_VERSION 2
42 52
55 * 65 *
56 * -DCORO_UCONTEXT 66 * -DCORO_UCONTEXT
57 * 67 *
58 * This flavour uses SUSv2's get/set/swap/makecontext functions that 68 * This flavour uses SUSv2's get/set/swap/makecontext functions that
59 * unfortunately only newer unices support. 69 * unfortunately only newer unices support.
60 * Use this for GNU/Linux + glibc-2.2.3. 70 * Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
61 * 71 *
62 * -DCORO_SJLJ 72 * -DCORO_SJLJ
63 * 73 *
64 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 74 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
65 * do it's job. Coroutine creation is much slower than UCONTEXT, but 75 * do it's job. Coroutine creation is much slower than UCONTEXT, but
66 * context switching is often a bit cheaper. It should work on almost 76 * context switching is often a bit cheaper. It should work on almost
67 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below 77 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
68 * do not work with any sane model (neither sigaltstack nor context 78 * do not work with any sane model (neither sigaltstack nor context
69 * functions are implemented) 79 * functions are implemented)
70 * 80 *
71 * -DCORO_LINUX 81 * -DCORO_LINUX
72 * 82 *
73 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 83 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
74 * (very fast). 84 * (it is very fast and therefore recommended over other methods).
75 * 85 *
76 * -DCORO_LOSER 86 * -DCORO_LOSER
77 * 87 *
78 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 88 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
79 * this automatically selects a suitable workaround for this platform. 89 * this automatically selects a suitable workaround for this platform.
80 * (untested) 90 * (untested)
81 * 91 *
82 * -DCORO_IRIX 92 * -DCORO_IRIX
83 * 93 *
84 * SGI's version of Microsoft's NT ;) 94 * SGI's version of Microsoft's NT ;)
95 *
96 * -DCORO_ASM
97 *
98 * Handcoded assembly, known to work only on a few architectures/ABI:
99 * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on.
85 * 100 *
86 * If you define neither of these symbols, coro.h will try to autodetect 101 * If you define neither of these symbols, coro.h will try to autodetect
87 * the model. This currently works for CORO_LOSER only. For the other 102 * the model. This currently works for CORO_LOSER only. For the other
88 * alternatives you should check (e.g. using autoconf) and define the 103 * alternatives you should check (e.g. using autoconf) and define the
89 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 104 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
93 * This is the type for the initialization function of a new coroutine. 108 * This is the type for the initialization function of a new coroutine.
94 */ 109 */
95typedef void (*coro_func)(void *); 110typedef void (*coro_func)(void *);
96 111
97/* 112/*
98 * A coroutine state is saved in the following structure. Treat it as a 113 * A coroutine state is saved in the following structure. Treat it as an
99 * opaque type. errno and sigmask might be saved, but don't rely on it, 114 * opaque type. errno and sigmask might be saved, but don't rely on it,
100 * implement your own switching primitive. 115 * implement your own switching primitive if you need that.
101 */ 116 */
102typedef struct coro_context coro_context; 117typedef struct coro_context coro_context;
103 118
104/* 119/*
105 * This function creates a new coroutine. Apart from a pointer to an 120 * This function creates a new coroutine. Apart from a pointer to an
106 * uninitialized coro_context, it expects a pointer to the entry function 121 * uninitialised coro_context, it expects a pointer to the entry function
107 * and the single pointer value that is given to it as argument. 122 * and the single pointer value that is given to it as argument.
108 * 123 *
109 * Allocating/deallocating the stack is your own responsibility, so there is 124 * Allocating/deallocating the stack is your own responsibility, so there is
110 * no coro_destroy function. 125 * no coro_destroy function.
111 */ 126 */
112void coro_create (coro_context *ctx, 127void coro_create (coro_context *ctx, /* an uninitialised coro_context */
113 coro_func coro, void *arg, 128 coro_func coro, /* the coroutine code to be executed */
114 void *sptr, long ssize); 129 void *arg, /* a single pointer passed to the coro */
130 void *sptr, /* start of stack area */
131 long ssize); /* size of stack area */
115 132
116/* 133/*
117 * The following prototype defines the coroutine switching function. It is 134 * The following prototype defines the coroutine switching function. It is
118 * usually implemented as a macro, so watch out. 135 * usually implemented as a macro, so watch out.
119 * 136 *
126 143
127/*****************************************************************************/ 144/*****************************************************************************/
128 145
129#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ 146#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
130 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ 147 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
131 && !defined(CORO_IRIX) 148 && !defined(CORO_IRIX) && !defined(CORO_ASM)
132# if defined(WINDOWS) 149# if defined(WINDOWS)
133# define CORO_LOSER 1 /* you don't win with windoze */ 150# define CORO_LOSER 1 /* you don't win with windoze */
134# elif defined(__linux) && defined(__x86) 151# elif defined(__linux) && (defined(__x86) || defined (__amd64))
152# define CORO_ASM 1
135# elif defined(HAVE_UCONTEXT_H) 153# elif defined(HAVE_UCONTEXT_H)
136# define CORO_UCONTEXT 1 154# define CORO_UCONTEXT 1
137# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 155# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
138# define CORO_SJLJ 1 156# define CORO_SJLJ 1
139# else 157# else
143 161
144/*****************************************************************************/ 162/*****************************************************************************/
145 163
146#if CORO_UCONTEXT 164#if CORO_UCONTEXT
147 165
148#include <ucontext.h> 166# include <ucontext.h>
149 167
150struct coro_context { 168struct coro_context {
151 ucontext_t uc; 169 ucontext_t uc;
152}; 170};
153 171
154#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) 172# define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
155 173
156#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX 174#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX
157 175
158#if defined(CORO_LINUX) && !defined(_GNU_SOURCE) 176# if defined(CORO_LINUX) && !defined(_GNU_SOURCE)
159# define _GNU_SOURCE // for linux libc 177# define _GNU_SOURCE /* for linux libc */
160#endif 178# endif
161 179
162#include <setjmp.h> 180# include <setjmp.h>
163 181
164struct coro_context { 182struct coro_context {
165 jmp_buf env; 183 jmp_buf env;
166}; 184};
167 185
186# if CORO_LINUX || (_XOPEN_SOURCE >= 600)
168#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0) 187# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0)
188# else
189# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0)
190# endif
191
192#elif CORO_ASM
193
194struct coro_context {
195 volatile void **sp;
196};
197
198void __attribute__ ((__noinline__, __fastcall__))
199 coro_transfer(coro_context *prev, coro_context *next);
169 200
170#endif 201#endif
171 202
172#endif 203#endif
173 204

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines