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.23 by root, Sun Jan 20 17:30:24 2008 UTC

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

Diff Legend

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