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