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

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

Diff Legend

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