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

Comparing libcoro/coro.h (file contents):
Revision 1.2 by root, Mon Jul 23 18:04:59 2001 UTC vs.
Revision 1.16 by root, Sat Nov 25 00:27:00 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 *
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-25 Use _setjmp instead of setjmp on GNU/Linux.
35 */ 42 */
36 43
37#ifndef CORO_H 44#ifndef CORO_H
38#define CORO_H 45#define CORO_H
39 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
40/* 54/*
41 * This library consists of only three files 55 * This library consists of only three files
42 * coro.h, coro.c and LICENSE 56 * coro.h, coro.c and LICENSE (and optionally README)
43 * 57 *
44 * It implements what is known as coroutines, in a hopefully 58 * It implements what is known as coroutines, in a hopefully
45 * portable way. At the moment you have to define which kind 59 * portable way. At the moment you have to define which kind
46 * of implementation flavour you want: 60 * of implementation flavour you want:
47 * 61 *
48 * -DCORO_UCONTEXT 62 * -DCORO_UCONTEXT
49 * 63 *
50 * This flavour uses SUSv2's get/set/swap/makecontext functions that 64 * This flavour uses SUSv2's get/set/swap/makecontext functions that
51 * unfortunately only newer unices support. 65 * unfortunately only newer unices support.
52 * Use this for GNU/Linux + glibc-2.2.3. 66 * Use this for GNU/Linux + glibc-2.2.3 and possibly higher.
53 * 67 *
54 * -DCORO_SJLJ 68 * -DCORO_SJLJ
55 * 69 *
56 * This flavour uses SUSv'2 setjmp/longjmp and sigaltstack functions to 70 * This flavour uses SUSv2's setjmp/longjmp and sigaltstack functions to
57 * 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
58 * 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
59 * 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
60 * do not work with any model (neither sigaltstack nor context functions 74 * do not work with any sane model (neither sigaltstack nor context
61 * are implemented) 75 * functions are implemented)
62 * 76 *
77 * -DCORO_LINUX
78 *
79 * Old GNU/Linux systems (<= glibc-2.1) work with this implementation
80 * (it is very fast and therefore recommended over other methods).
81 *
63 * -DCORO_LOOSE 82 * -DCORO_LOSER
64 * 83 *
65 * Microsoft's highly proprietary platform doesn't support sigaltstack, and 84 * Microsoft's highly proprietary platform doesn't support sigaltstack, and
66 * this automatically selects a suitable workaround for this platform. 85 * this automatically selects a suitable workaround for this platform.
67 * (untested) 86 * (untested)
68 * 87 *
88 * -DCORO_IRIX
89 *
90 * SGI's version of Microsoft's NT ;)
91 *
69 * 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
70 * 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
71 * alternatives you should check (e.g. using autoconf) and define the 94 * alternatives you should check (e.g. using autoconf) and define the
72 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK. 95 * following symbols: HAVE_UCONTEXT_H / HAVE_SETJMP_H / HAVE_SIGALTSTACK.
73 */ 96 */
74 97
75/* 98/*
76 * 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.
77 */ 100 */
78typedef void (*coro_func)(void *); 101typedef void (*coro_func)(void *);
79
80 102
81/* 103/*
82 * 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
83 * 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,
84 * implement your own switching primitive. 106 * implement your own switching primitive if you need it.
85 */ 107 */
86typedef struct coro_context coro_context; 108typedef struct coro_context coro_context;
87 109
88/* 110/*
89 * 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
90 * uninitialized coro_context, it expects a pointer to the entry function 112 * uninitialised coro_context, it expects a pointer to the entry function
91 * 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.
92 * 114 *
93 * Allocating/deallocating the stack is your own responsibility, so there is 115 * Allocating/deallocating the stack is your own responsibility, so there is
94 * no coro_destroy function. 116 * no coro_destroy function.
95 */ 117 */
96void coro_create(coro_context *ctx, 118void coro_create (coro_context *ctx,
97 coro_func coro, void *arg, 119 coro_func coro, void *arg,
98 void *sptr, long ssize); 120 void *sptr, long ssize);
99 121
100/* 122/*
101 * The following prototype defines the coroutine switching function. It is 123 * The following prototype defines the coroutine switching function. It is
102 * usually implemented as a macro, so watch out. 124 * usually implemented as a macro, so watch out.
103 * 125 *
… …
106 128
107/* 129/*
108 * That was it. No other user-visible functions are implemented here. 130 * That was it. No other user-visible functions are implemented here.
109 */ 131 */
110 132
133/*****************************************************************************/
134
111#if !defined(CORO_LOOSE) && !defined(CORO_UCONTEXT) && !defined(CORO_SJLJ) 135#if !defined(CORO_LOSER) && !defined(CORO_UCONTEXT) \
136 && !defined(CORO_SJLJ) && !defined(CORO_LINUX) \
137 && !defined(CORO_IRIX)
112# if defined(WINDOWS) 138# if defined(WINDOWS)
113# define CORO_LOOSE 1 /* you don't win with windoze */ 139# define CORO_LOSER 1 /* you don't win with windoze */
140# elif defined(__linux) && defined(__x86)
114# elif defined(HAVE_UCONTEXT_H) 141# elif defined(HAVE_UCONTEXT_H)
115# define CORO_UCONTEXT 1 142# define CORO_UCONTEXT 1
116# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK) 143# elif defined(HAVE_SETJMP_H) && defined(HAVE_SIGALTSTACK)
117# define CORO_SJLJ 1 144# define CORO_SJLJ 1
118# else 145# else
119error unknown or unsupported architecture 146error unknown or unsupported architecture
120# endif 147# endif
121#endif 148#endif
122 149
150/*****************************************************************************/
151
123#if CORO_UCONTEXT 152#if CORO_UCONTEXT
124 153
125#include <ucontext.h> 154#include <ucontext.h>
126 155
127struct coro_context { 156struct coro_context {
128 ucontext_t uc; 157 ucontext_t uc;
129}; 158};
130 159
131#define coro_transfer(p,n) swapcontext(&((p)->uc), &((n)->uc)) 160#define coro_transfer(p,n) swapcontext (&((p)->uc), &((n)->uc))
132 161
133#elif CORO_SJLJ || CORO_LOOSE 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
134 167
135#include <setjmp.h> 168#include <setjmp.h>
136 169
137struct coro_context { 170struct coro_context {
138 jmp_buf env; 171 jmp_buf env;
139}; 172};
140 173
141#define coro_transfer(p,n) if (!setjmp ((p)->env)) longjmp ((n)->env, 1) 174#define coro_transfer(p,n) do { if (!setjmp ((p)->env)) longjmp ((n)->env, 1); } while(0)
142 175
143#endif 176#endif
144 177
145#endif 178#endif
146 179

Diff Legend

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