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

Comparing libcoro/coro.h (file contents):
Revision 1.2 by root, Mon Jul 23 18:04:59 2001 UTC vs.
Revision 1.7 by pcg, Thu Apr 1 03:11:15 2004 UTC

… …
28 * This library is modelled strictly after Ralf S. Engelschalls article at 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 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>. 30 * go to Ralf S. Engelschall <rse@engelschall.com>.
31 * 31 *
32 * This coroutine library is very much stripped down. You should either 32 * This coroutine library is very much stripped down. You should either
33 * build your own process avstraction 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 *
36 * VERSION: 0.1
35 */ 37 */
36 38
37#ifndef CORO_H 39#ifndef CORO_H
38#define CORO_H 40#define CORO_H
39 41
… …
55 * 57 *
56 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 58 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to
57 * do it's job. Coroutine creation is much slower than UCONTEXT, but 59 * do it's job. Coroutine creation is much slower than UCONTEXT, but
58 * context switching is often a bit cheaper. It should work on almost 60 * context switching is often a bit cheaper. It should work on almost
59 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below 61 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
60 * do not work with any model (neither sigaltstack nor context functions 62 * do not work with any sane model (neither sigaltstack nor context
61 * are implemented) 63 * functions are implemented)
64 *
65 * -DCORO_LINUX
66 *
67 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
68 * (very fast).
62 * 69 *
63 * -DCORO_LOOSE 70 * -DCORO_LOOSE
64 * 71 *
65 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 72 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
66 * this automatically selects a suitable workaround for this platform. 73 * this automatically selects a suitable workaround for this platform.
67 * (untested) 74 * (untested)
75 *
76 * -DCORO_IRIX
77 *
78 * SGI's version of Microsoft's NT ;)
68 * 79 *
69 * If you define neither of these symbols, coro.h will try to autodetect 80 * If you define neither of these symbols, coro.h will try to autodetect
70 * the model. This currently works for CORO_LOOSE only. For the other 81 * the model. This currently works for CORO_LOOSE only. For the other
71 * alternatives you should check (e.g. using autoconf) and define the 82 * alternatives you should check (e.g. using autoconf) and define the
72 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 83 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
73 */ 84 */
74 85
75/* 86/*
76 * This is the type for the top function of a new coroutine. 87 * This is the type for the initialization function of a new coroutine.
77 */ 88 */
78typedef void (*coro_func)(void *); 89typedef void (*coro_func)(void *);
79
80 90
81/* 91/*
82 * A coroutine state is saved in the following structure. Treat it as a 92 * A coroutine state is saved in the following structure. Treat it as a
83 * opaque type. errno and sigmask might be saved, but don't rely on it, 93 * opaque type. errno and sigmask might be saved, but don't rely on it,
84 * implement your own switching primitive. 94 * implement your own switching primitive.
… …
91 * and the single pointer value that is given to it as argument. 101 * and the single pointer value that is given to it as argument.
92 * 102 *
93 * Allocating/deallocating the stack is your own responsibility, so there is 103 * Allocating/deallocating the stack is your own responsibility, so there is
94 * no coro_destroy function. 104 * no coro_destroy function.
95 */ 105 */
96void coro_create(coro_context *ctx, 106void coro_create (coro_context *ctx,
97 coro_func coro, void *arg, 107 coro_func coro, void *arg,
98 void *sptr, long ssize); 108 void *sptr, long ssize);
99 109
100/* 110/*
101 * The following prototype defines the coroutine switching function. It is 111 * The following prototype defines the coroutine switching function. It is
102 * usually implemented as a macro, so watch out. 112 * usually implemented as a macro, so watch out.
103 * 113 *
… …
106 116
107/* 117/*
108 * That was it. No other user-visible functions are implemented here. 118 * That was it. No other user-visible functions are implemented here.
109 */ 119 */
110 120
121/*****************************************************************************/
122
111#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) && !defined(CORO_SJLJ) 123#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \
124 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
125 && !defined(CORO_IRIX)
112# if defined(WINDOWS) 126# if defined(WINDOWS)
113# define CORO_LOOSE 1 /* you don't win with windoze */ 127# define CORO_LOOSE 1 /* you don't win with windoze */
128# elif defined(__linux) && defined(__x86)
114# elif defined(HAVE_UCONTEXT_H) 129# elif defined(HAVE_UCONTEXT_H)
115# define CORO_UCONTEXT 1 130# define CORO_UCONTEXT 1
116# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 131# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
117# define CORO_SJLJ 1 132# define CORO_SJLJ 1
118# else 133# else
119error unknown or unsupported architecture 134error unknown or unsupported architecture
120# endif 135# endif
121#endif 136#endif
122 137
138/*****************************************************************************/
139
123#if CORO_UCONTEXT 140#if CORO_UCONTEXT
124 141
125#include <ucontext.h> 142#include <ucontext.h>
126 143
127struct coro_context { 144struct coro_context {
128 ucontext_t uc; 145 ucontext_t uc;
129}; 146};
130 147
131#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 148#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
132 149
133#elif CORO_SJLJ || CORO_LOOSE 150#elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX || CORO_IRIX
134 151
135#include <setjmp.h> 152#include <setjmp.h>
136 153
137struct coro_context { 154struct coro_context {
138 jmp_buf env; 155 jmp_buf env;
139}; 156};
140 157
141#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) 158#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0)
142 159
143#endif 160#endif
144 161
145#endif 162#endif
146 163

Diff Legend

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