| 1 |
/* |
| 2 |
* Copyright (c) 2001-2006 Marc Alexander Lehmann <schmorp@schmorp.de> |
| 3 |
* |
| 4 |
* Redistribution and use in source and binary forms, with or without modifica- |
| 5 |
* tion, are permitted provided that the following conditions are met: |
| 6 |
* |
| 7 |
* 1. Redistributions of source code must retain the above copyright notice, |
| 8 |
* this list of conditions and the following disclaimer. |
| 9 |
* |
| 10 |
* 2. Redistributions in binary form must reproduce the above copyright |
| 11 |
* notice, this list of conditions and the following disclaimer in the |
| 12 |
* documentation and/or other materials provided with the distribution. |
| 13 |
* |
| 14 |
* 3. The name of the author may not be used to endorse or promote products |
| 15 |
* derived from this software without specific prior written permission. |
| 16 |
* |
| 17 |
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| 18 |
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- |
| 19 |
* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO |
| 20 |
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- |
| 21 |
* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| 22 |
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
| 23 |
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| 24 |
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- |
| 25 |
* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 26 |
* OF THE POSSIBILITY OF SUCH DAMAGE. |
| 27 |
* |
| 28 |
* This library is modelled strictly after Ralf S. Engelschalls article at |
| 29 |
* http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must |
| 30 |
* go to Ralf S. Engelschall <rse@engelschall.com>. |
| 31 |
* |
| 32 |
* This coroutine library is very much stripped down. You should either |
| 33 |
* build your own process abstraction using it or - better - just use GNU |
| 34 |
* Portable Threads, http://www.gnu.org/software/pth/. |
| 35 |
* |
| 36 |
*/ |
| 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 |
*/ |
| 45 |
|
| 46 |
#ifndef CORO_H |
| 47 |
#define CORO_H |
| 48 |
|
| 49 |
#define CORO_VERSION 2 |
| 50 |
|
| 51 |
/* |
| 52 |
* Changes since API version 1: |
| 53 |
* replaced bogus -DCORO_LOOSE with gramatically more correct -DCORO_LOSER |
| 54 |
*/ |
| 55 |
|
| 56 |
/* |
| 57 |
* This library consists of only three files |
| 58 |
* coro.h, coro.c and LICENSE (and optionally README) |
| 59 |
* |
| 60 |
* It implements what is known as coroutines, in a hopefully |
| 61 |
* portable way. At the moment you have to define which kind |
| 62 |
* of implementation flavour you want: |
| 63 |
* |
| 64 |
* -DCORO_UCONTEXT |
| 65 |
* |
| 66 |
* This flavour uses SUSv2's get/set/swap/makecontext functions that |
| 67 |
* unfortunately only newer unices support. |
| 68 |
* Use this for GNU/Linux + glibc-2.2.3 and possibly higher. |
| 69 |
* |
| 70 |
* -DCORO_SJLJ |
| 71 |
* |
| 72 |
* This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to |
| 73 |
* do it's job. Coroutine creation is much slower than UCONTEXT, but |
| 74 |
* context switching is often a bit cheaper. It should work on almost |
| 75 |
* all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below |
| 76 |
* do not work with any sane model (neither sigaltstack nor context |
| 77 |
* functions are implemented) |
| 78 |
* |
| 79 |
* -DCORO_LINUX |
| 80 |
* |
| 81 |
* Old GNU/Linux systems (<= glibc-2.1) work with this implementation |
| 82 |
* (it is very fast and therefore recommended over other methods). |
| 83 |
* |
| 84 |
* -DCORO_LOSER |
| 85 |
* |
| 86 |
* Microsoft's highly proprietary platform doesn't support sigaltstack, and |
| 87 |
* this automatically selects a suitable workaround for this platform. |
| 88 |
* (untested) |
| 89 |
* |
| 90 |
* -DCORO_IRIX |
| 91 |
* |
| 92 |
* SGI's version of Microsoft's NT ;) |
| 93 |
* |
| 94 |
* If you define neither of these symbols, coro.h will try to autodetect |
| 95 |
* the model. This currently works for CORO_LOSER only. For the other |
| 96 |
* alternatives you should check (e.g. using autoconf) and define the |
| 97 |
* following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. |
| 98 |
*/ |
| 99 |
|
| 100 |
/* |
| 101 |
* This is the type for the initialization function of a new coroutine. |
| 102 |
*/ |
| 103 |
typedef void (*coro_func)(void *); |
| 104 |
|
| 105 |
/* |
| 106 |
* A coroutine state is saved in the following structure. Treat it as an |
| 107 |
* opaque type. errno and sigmask might be saved, but don't rely on it, |
| 108 |
* implement your own switching primitive if you need that. |
| 109 |
*/ |
| 110 |
typedef struct coro_context coro_context; |
| 111 |
|
| 112 |
/* |
| 113 |
* This function creates a new coroutine. Apart from a pointer to an |
| 114 |
* uninitialised coro_context, it expects a pointer to the entry function |
| 115 |
* and the single pointer value that is given to it as argument. |
| 116 |
* |
| 117 |
* Allocating/deallocating the stack is your own responsibility, so there is |
| 118 |
* no coro_destroy function. |
| 119 |
*/ |
| 120 |
void coro_create (coro_context *ctx, /* an uninitialised coro_context */ |
| 121 |
coro_func coro, /* the coroutine code to be executed */ |
| 122 |
void *arg, /* a single pointer passed to the coro */ |
| 123 |
void *sptr, /* start of stack area */ |
| 124 |
long ssize); /* size of stack area */ |
| 125 |
|
| 126 |
/* |
| 127 |
* The following prototype defines the coroutine switching function. It is |
| 128 |
* usually implemented as a macro, so watch out. |
| 129 |
* |
| 130 |
void coro_transfer(coro_context *prev, coro_context *next); |
| 131 |
*/ |
| 132 |
|
| 133 |
/* |
| 134 |
* That was it. No other user-visible functions are implemented here. |
| 135 |
*/ |
| 136 |
|
| 137 |
/*****************************************************************************/ |
| 138 |
|
| 139 |
#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \ |
| 140 |
&& !defined(CORO_SJLJ) && !defined(CORO_LINUX) \ |
| 141 |
&& !defined(CORO_IRIX) |
| 142 |
# if defined(WINDOWS) |
| 143 |
# define CORO_LOSER 1 /* you don't win with windoze */ |
| 144 |
# elif defined(__linux) && defined(__x86) |
| 145 |
# elif defined(HAVE_UCONTEXT_H) |
| 146 |
# define CORO_UCONTEXT 1 |
| 147 |
# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) |
| 148 |
# define CORO_SJLJ 1 |
| 149 |
# else |
| 150 |
error unknown or unsupported architecture |
| 151 |
# endif |
| 152 |
#endif |
| 153 |
|
| 154 |
/*****************************************************************************/ |
| 155 |
|
| 156 |
#if CORO_UCONTEXT |
| 157 |
|
| 158 |
#include <ucontext.h> |
| 159 |
|
| 160 |
struct coro_context { |
| 161 |
ucontext_t uc; |
| 162 |
}; |
| 163 |
|
| 164 |
#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc)) |
| 165 |
|
| 166 |
#elif CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX |
| 167 |
|
| 168 |
#if defined(CORO_LINUX) && !defined(_GNU_SOURCE) |
| 169 |
# define _GNU_SOURCE /* for linux libc */ |
| 170 |
#endif |
| 171 |
|
| 172 |
#include <setjmp.h> |
| 173 |
|
| 174 |
struct coro_context { |
| 175 |
jmp_buf env; |
| 176 |
}; |
| 177 |
|
| 178 |
#if CORO_LINUX || (_XOPEN_SOURCE >= 600) |
| 179 |
# define coro_transfer(p,n) do { if (!_setjmp ((p)->env)) _longjmp ((n)->env, 1); } while (0) |
| 180 |
#else |
| 181 |
# define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while (0) |
| 182 |
#endif |
| 183 |
|
| 184 |
#endif |
| 185 |
|
| 186 |
#endif |
| 187 |
|
