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

Diff Legend

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