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

Comparing libcoro/coro.h (file contents):
Revision 1.1 by root, Mon Jul 23 17:13:08 2001 UTC vs.
Revision 1.8 by root, Wed Jan 12 20:35:35 2005 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
42/*
43 * This library consists of only three files
44 * coro.h, coro.c and LICENSE
45 *
46 * It implements what is known as coroutines, in a hopefully
47 * portable way. At the moment you have to define which kind
48 * of implementation flavour you want:
49 *
50 * -DCORO_UCONTEXT
51 *
52 * This flavour uses SUSv2's get/set/swap/makecontext functions that
53 * unfortunately only newer unices support.
54 * Use this for GNU/Linux + glibc-2.2.3.
55 *
56 * -DCORO_SJLJ
57 *
58 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to
59 * do it's job. Coroutine creation is much slower than UCONTEXT, but
60 * context switching is often a bit cheaper. It should work on almost
61 * all unices. Use this for GNU/Linux + glibc-2.2. glibc-2.1 and below
62 * do not work with any sane model (neither sigaltstack nor context
63 * functions are implemented)
64 *
65 * -DCORO_LINUX
66 *
67 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
68 * (very fast).
69 *
70 * -DCORO_LOOSE
71 *
72 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
73 * this automatically selects a suitable workaround for this platform.
74 * (untested)
75 *
76 * -DCORO_IRIX
77 *
78 * SGI's version of Microsoft's NT ;)
79 *
80 * If you define neither of these symbols, coro.h will try to autodetect
81 * the model. This currently works for CORO_LOOSE only. For the other
82 * alternatives you should check (e.g. using autoconf) and define the
83 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
84 */
85
86/*
87 * This is the type for the initialization function of a new coroutine.
88 */
40typedef void (*coro_func)(void *); 89typedef void (*coro_func)(void *);
41 90
91/*
92 * A coroutine state is saved in the following structure. Treat it as a
93 * opaque type. errno and sigmask might be saved, but don't rely on it,
94 * implement your own switching primitive.
95 */
96typedef struct coro_context coro_context;
97
98/*
99 * This function creates a new coroutine. Apart from a pointer to an
100 * uninitialized coro_context, it expects a pointer to the entry function
101 * and the single pointer value that is given to it as argument.
102 *
103 * Allocating/deallocating the stack is your own responsibility, so there is
104 * no coro_destroy function.
105 */
106void coro_create (coro_context *ctx,
107 coro_func coro, void *arg,
108 void *sptr, long ssize);
109
110/*
111 * The following prototype defines the coroutine switching function. It is
112 * usually implemented as a macro, so watch out.
113 *
114void coro_transfer(coro_context *prev, coro_context *next);
115 */
116
117/*
118 * That was it. No other user-visible functions are implemented here.
119 */
120
121/*****************************************************************************/
122
123#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \
124 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
125 && !defined(CORO_IRIX)
42#if defined(WINDOWS) 126# if defined(WINDOWS)
43# 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)
44#elif defined(HAVE_UCONTEXT_H) 129# elif defined(HAVE_UCONTEXT_H)
45# define CORO_UCONTEXT 1 130# define CORO_UCONTEXT 1
46#elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 131# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
47# define CORO_SJLJ 1 132# define CORO_SJLJ 1
48#else 133# else
49error unknown or unsupported architecture 134error unknown or unsupported architecture
135# endif
50#endif 136#endif
137
138/*****************************************************************************/
51 139
52#if CORO_UCONTEXT 140#if CORO_UCONTEXT
53 141
54#include <ucontext.h> 142#include <ucontext.h>
55 143
56typedef struct { 144struct coro_context {
57 ucontext_t uc; 145 ucontext_t uc;
58} coro_context; 146};
59 147
60#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 148#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
61 149
62#elif CORO_SJLJ || CORO_LOOSE 150#elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX || CORO_IRIX
151
152#ifdef CORO_LINUX
153# define _GNU_SOURCE // for linux libc
154#endif
63 155
64#include <setjmp.h> 156#include <setjmp.h>
65 157
66typedef struct { 158struct coro_context {
67 jmp_buf env; 159 jmp_buf env;
68} coro_context; 160};
69 161
70#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) 162#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0)
71 163
72#endif 164#endif
73 165
74void coro_create(coro_context *ctx,
75 coro_func coro, void *arg,
76 void *sptr, long ssize);
77
78#endif 166#endif
79 167

Diff Legend

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