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