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

Diff Legend

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