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

Comparing libcoro/coro.h (file contents):
Revision 1.11 by root, Sat Aug 20 01:03:31 2005 UTC vs.
Revision 1.23 by root, Sun Jan 20 17:30:24 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines