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.4 by root, Tue Jul 24 20:18:12 2001 UTC

… …
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 avstraction 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 * If you define neither of these symbols, coro.h will try to autodetect
77 * the model. This currently works for CORO_LOOSE only. For the other
78 * alternatives you should check (e.g. using autoconf) and define the
79 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
80 */
81
82/*
83 * This is the type for the top function of a new coroutine.
84 */
40typedef void (*coro_func)(void *); 85typedef void (*coro_func)(void *);
41 86
87
88/*
89 * A coroutine state is saved in the following structure. Treat it as a
90 * opaque type. errno and sigmask might be saved, but don't rely on it,
91 * implement your own switching primitive.
92 */
93typedef struct coro_context coro_context;
94
95/*
96 * This function creates a new coroutine. Apart from a pointer to an
97 * uninitialized coro_context, it expects a pointer to the entry function
98 * and the single pointer value that is given to it as argument.
99 *
100 * Allocating/deallocating the stack is your own responsibility, so there is
101 * no coro_destroy function.
102 */
103void coro_create(coro_context *ctx,
104 coro_func coro, void *arg,
105 void *sptr, long ssize);
106
107/*
108 * The following prototype defines the coroutine switching function. It is
109 * usually implemented as a macro, so watch out.
110 *
111void coro_transfer(coro_context *prev, coro_context *next);
112 */
113
114/*
115 * That was it. No other user-visible functions are implemented here.
116 */
117
118#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) \
119 && !defined(CORO_SJLJ) && !defined(CORO_LINUX)
42#if defined(WINDOWS) 120# if defined(WINDOWS)
43# define CORO_LOOSE 1 /* you don't win with windoze */ 121# define CORO_LOOSE 1 /* you don't win with windoze */
122# elif defined(__linux) && defined(__x86)
44#elif defined(HAVE_UCONTEXT_H) 123# elif defined(HAVE_UCONTEXT_H)
45# define CORO_UCONTEXT 1 124# define CORO_UCONTEXT 1
46#elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 125# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
47# define CORO_SJLJ 1 126# define CORO_SJLJ 1
48#else 127# else
49error unknown or unsupported architecture 128error unknown or unsupported architecture
129# endif
50#endif 130#endif
51 131
52#if CORO_UCONTEXT 132#if CORO_UCONTEXT
53 133
54#include <ucontext.h> 134#include <ucontext.h>
55 135
56typedef struct { 136struct coro_context {
57 ucontext_t uc; 137 ucontext_t uc;
58} coro_context; 138};
59 139
60#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 140#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc))
61 141
62#elif CORO_SJLJ || CORO_LOOSE 142#elif CORO_SJLJ || CORO_LOOSE || CORO_LINUX
63 143
64#include <setjmp.h> 144#include <setjmp.h>
65 145
66typedef struct { 146struct coro_context {
67 jmp_buf env; 147 jmp_buf env;
68} coro_context; 148};
69 149
70#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) 150#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1)
71 151
72#endif 152#endif
73 153
74void coro_create(coro_context *ctx,
75 coro_func coro, void *arg,
76 void *sptr, long ssize);
77
78#endif 154#endif
79 155

Diff Legend

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