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

Comparing libcoro/coro.h (file contents):
Revision 1.22 by root, Wed May 2 05:53:26 2007 UTC vs.
Revision 1.24 by root, Sun Mar 2 16:10:22 2008 UTC

1/* 1/*
2 * Copyright (c) 2001-2006 Marc Alexander Lehmann <schmorp@schmorp.de> 2 * Copyright (c) 2001-2008 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,
8 * this list of conditions and the following disclaimer. 8 * this list of conditions and the following disclaimer.
9 * 9 *
10 * 2. Redistributions in binary form must reproduce the above copyright 10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the 11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution. 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 * 13 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 14 * 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- 15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 16 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- 17 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
… …
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- 21 * 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 22 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE. 23 * OF THE POSSIBILITY OF SUCH DAMAGE.
27 * 24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * the GNU General Public License ("GPL") version 2 or any later version,
27 * in which case the provisions of the GPL are applicable instead of
28 * the above. If you wish to allow the use of your version of this file
29 * only under the terms of the GPL and not to allow others to use your
30 * version of this file under the BSD license, indicate your decision
31 * by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL. If you do not delete the
33 * provisions above, a recipient may use your version of this file under
34 * either the BSD or the GPL.
35 *
28 * This library is modelled strictly after Ralf S. Engelschalls article at 36 * 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 37 * http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must
30 * go to Ralf S. Engelschall <rse@engelschall.com>. 38 * go to Ralf S. Engelschall <rse@engelschall.com>.
31 * 39 *
32 * This coroutine library is very much stripped down. You should either 40 * This coroutine library is very much stripped down. You should either
33 * build your own process abstraction using it or - better - just use GNU 41 * build your own process abstraction using it or - better - just use GNU
34 * Portable Threads, http://www.gnu.org/software/pth/. 42 * Portable Threads, http://www.gnu.org/software/pth/.
… …
41 * 2006-11-26 Use _setjmp instead of setjmp on GNU/Linux. 49 * 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. 50 * 2007-04-27 Set unwind frame info if gcc 3+ and ELF is detected.
43 * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600. 51 * Use _setjmp instead of setjmp on _XOPEN_SOURCE >= 600.
44 * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance 52 * 2007-05-02 Add assembly versions for x86 and amd64 (to avoid reliance
45 * on SIGUSR2 and sigaltstack in Crossfire). 53 * on SIGUSR2 and sigaltstack in Crossfire).
54 * 2008-01-21 Disable CFI usage on anything but GNU/Linux.
55 * 2008-03-02 Switched to 2-clause BSD license with GPL exception.
46 */ 56 */
47 57
48#ifndef CORO_H 58#ifndef CORO_H
49#define CORO_H 59#define CORO_H
50 60
… …
65 * 75 *
66 * -DCORO_UCONTEXT 76 * -DCORO_UCONTEXT
67 * 77 *
68 * This flavour uses SUSv2's get/set/swap/makecontext functions that 78 * This flavour uses SUSv2's get/set/swap/makecontext functions that
69 * unfortunately only newer unices support. 79 * unfortunately only newer unices support.
70 * Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
71 * 80 *
72 * -DCORO_SJLJ 81 * -DCORO_SJLJ
73 * 82 *
74 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to 83 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
75 * do it's job. Coroutine creation is much slower than UCONTEXT, but 84 * do it's job. Coroutine creation is much slower than UCONTEXT, but
76 * context switching is often a bit cheaper. It should work on almost 85 * context switching is often a bit cheaper. It should work on almost
77 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below 86 * all unices.
78 * do not work with any sane model (neither sigaltstack nor context
79 * functions are implemented)
80 * 87 *
81 * -DCORO_LINUX 88 * -DCORO_LINUX
82 * 89 *
83 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation 90 * Old GNU/Linux systems (<= glibc-2.1) only work with this implementation
84 * (it is very fast and therefore recommended over other methods). 91 * (it is very fast and therefore recommended over other methods, but
92 * doesn't work with anything newer).
85 * 93 *
86 * -DCORO_LOSER 94 * -DCORO_LOSER
87 * 95 *
88 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 96 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
89 * this automatically selects a suitable workaround for this platform. 97 * this automatically selects a suitable workaround for this platform.
… …
97 * 105 *
98 * Handcoded assembly, known to work only on a few architectures/ABI: 106 * 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. 107 * ELF Linux x86 && amd64 when gcc is used and optimisation is turned on.
100 * 108 *
101 * If you define neither of these symbols, coro.h will try to autodetect 109 * If you define neither of these symbols, coro.h will try to autodetect
102 * the model. This currently works for CORO_LOSER only. For the other 110 * the model. This currently works for CORO_LOSER only. For the other
103 * alternatives you should check (e.g. using autoconf) and define the 111 * alternatives you should check (e.g. using autoconf) and define the
104 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 112 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
105 */ 113 */
106 114
107/* 115/*

Diff Legend

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