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

Comparing libcoro/coro.h (file contents):
Revision 1.3 by root, Tue Jul 24 19:52:55 2001 UTC vs.
Revision 1.13 by root, Sun Feb 19 22:30:58 2006 UTC

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

Diff Legend

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