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

Comparing libcoro/coro.h (file contents):
Revision 1.4 by root, Tue Jul 24 20:18:12 2001 UTC vs.
Revision 1.18 by root, Sun Nov 26 03:19:06 2006 UTC

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

Diff Legend

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