ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.c
Revision: 1.46
Committed: Sat Jul 11 14:24:13 2009 UTC (14 years, 10 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.45: +1 -1 lines
Log Message:
license change

File Contents

# Content
1 /*
2 * Copyright (c) 2001-2009 Marc Alexander Lehmann <schmorp@schmorp.de>
3 *
4 * Redistribution and use in source and binary forms, with or without modifica-
5 * tion, are permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
16 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
17 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
18 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
22 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
23 * OF THE POSSIBILITY OF SUCH DAMAGE.
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * the GNU General Public License ("GPL") version 2 or any later version,
27 * in which case the provisions of the GPL are applicable instead of
28 * the above. If you wish to allow the use of your version of this file
29 * only under the terms of the GPL and not to allow others to use your
30 * version of this file under the BSD license, indicate your decision
31 * by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL. If you do not delete the
33 * provisions above, a recipient may use your version of this file under
34 * either the BSD or the GPL.
35 *
36 * This library is modelled strictly after Ralf S. Engelschalls article at
37 * http://www.gnu.org/software/pth/rse-pmt.ps. So most of the credit must
38 * go to Ralf S. Engelschall <rse@engelschall.com>.
39 */
40
41 #include "coro.h"
42
43 #include <string.h>
44
45 /*****************************************************************************/
46 /* ucontext/setjmp/asm backends */
47 /*****************************************************************************/
48 #if CORO_UCONTEXT || CORO_SJLJ || CORO_LOSER || CORO_LINUX || CORO_IRIX || CORO_ASM
49
50 # if CORO_UCONTEXT
51 # include <stddef.h>
52 # endif
53
54 # if !defined(STACK_ADJUST_PTR)
55 # if __sgi
56 /* IRIX is decidedly NON-unix */
57 # define STACK_ADJUST_PTR(sp,ss) ((char *)(sp) + (ss) - 8)
58 # define STACK_ADJUST_SIZE(sp,ss) ((ss) - 8)
59 # elif (__i386__ && CORO_LINUX) || (_M_IX86 && CORO_LOSER)
60 # define STACK_ADJUST_PTR(sp,ss) ((char *)(sp) + (ss))
61 # define STACK_ADJUST_SIZE(sp,ss) (ss)
62 # elif (__amd64__ && CORO_LINUX) || ((_M_AMD64 || _M_IA64) && CORO_LOSER)
63 # define STACK_ADJUST_PTR(sp,ss) ((char *)(sp) + (ss) - 8)
64 # define STACK_ADJUST_SIZE(sp,ss) (ss)
65 # else
66 # define STACK_ADJUST_PTR(sp,ss) (sp)
67 # define STACK_ADJUST_SIZE(sp,ss) (ss)
68 # endif
69 # endif
70
71 # include <stdlib.h>
72
73 # if CORO_SJLJ
74 # include <stdio.h>
75 # include <signal.h>
76 # include <unistd.h>
77 # endif
78
79 static coro_func coro_init_func;
80 static void *coro_init_arg;
81 static coro_context *new_coro, *create_coro;
82
83 static void
84 coro_init (void)
85 {
86 volatile coro_func func = coro_init_func;
87 volatile void *arg = coro_init_arg;
88
89 coro_transfer (new_coro, create_coro);
90
91 func ((void *)arg);
92
93 /* the new coro returned. bad. just abort() for now */
94 abort ();
95 }
96
97 # if CORO_SJLJ
98
99 static volatile int trampoline_done;
100
101 /* trampoline signal handler */
102 static void
103 trampoline (int sig)
104 {
105 if (coro_setjmp (new_coro->env))
106 coro_init (); /* start it */
107 else
108 trampoline_done = 1;
109 }
110
111 # endif
112
113 # if CORO_ASM
114
115 asm (
116 ".text\n"
117 ".globl coro_transfer\n"
118 ".type coro_transfer, @function\n"
119 "coro_transfer:\n"
120 #if __amd64
121 #define NUM_SAVED 6
122 "\tpush %rbp\n"
123 "\tpush %rbx\n"
124 "\tpush %r12\n"
125 "\tpush %r13\n"
126 "\tpush %r14\n"
127 "\tpush %r15\n"
128 "\tmov %rsp, (%rdi)\n"
129 "\tmov (%rsi), %rsp\n"
130 "\tpop %r15\n"
131 "\tpop %r14\n"
132 "\tpop %r13\n"
133 "\tpop %r12\n"
134 "\tpop %rbx\n"
135 "\tpop %rbp\n"
136 #elif __i386
137 #define NUM_SAVED 4
138 "\tpush %ebp\n"
139 "\tpush %ebx\n"
140 "\tpush %esi\n"
141 "\tpush %edi\n"
142 "\tmov %esp, (%eax)\n"
143 "\tmov (%edx), %esp\n"
144 "\tpop %edi\n"
145 "\tpop %esi\n"
146 "\tpop %ebx\n"
147 "\tpop %ebp\n"
148 #else
149 #error unsupported architecture
150 #endif
151 "\tret\n"
152 );
153
154 # endif
155
156 void
157 coro_create (coro_context *ctx, coro_func coro, void *arg, void *sptr, long ssize)
158 {
159 coro_context nctx;
160 # if CORO_SJLJ
161 stack_t ostk, nstk;
162 struct sigaction osa, nsa;
163 sigset_t nsig, osig;
164 # endif
165
166 if (!coro)
167 return;
168
169 coro_init_func = coro;
170 coro_init_arg = arg;
171
172 new_coro = ctx;
173 create_coro = &nctx;
174
175 # if CORO_SJLJ
176 /* we use SIGUSR2. first block it, then fiddle with it. */
177
178 sigemptyset (&nsig);
179 sigaddset (&nsig, SIGUSR2);
180 sigprocmask (SIG_BLOCK, &nsig, &osig);
181
182 nsa.sa_handler = trampoline;
183 sigemptyset (&nsa.sa_mask);
184 nsa.sa_flags = SA_ONSTACK;
185
186 if (sigaction (SIGUSR2, &nsa, &osa))
187 {
188 perror ("sigaction");
189 abort ();
190 }
191
192 /* set the new stack */
193 nstk.ss_sp = STACK_ADJUST_PTR (sptr,ssize); /* yes, some platforms (IRIX) get this wrong. */
194 nstk.ss_size = STACK_ADJUST_SIZE (sptr,ssize);
195 nstk.ss_flags = 0;
196
197 if (sigaltstack (&nstk, &ostk) < 0)
198 {
199 perror ("sigaltstack");
200 abort ();
201 }
202
203 trampoline_done = 0;
204 kill (getpid (), SIGUSR2);
205 sigfillset (&nsig); sigdelset (&nsig, SIGUSR2);
206
207 while (!trampoline_done)
208 sigsuspend (&nsig);
209
210 sigaltstack (0, &nstk);
211 nstk.ss_flags = SS_DISABLE;
212 if (sigaltstack (&nstk, 0) < 0)
213 perror ("sigaltstack");
214
215 sigaltstack (0, &nstk);
216 if (~nstk.ss_flags & SS_DISABLE)
217 abort ();
218
219 if (~ostk.ss_flags & SS_DISABLE)
220 sigaltstack (&ostk, 0);
221
222 sigaction (SIGUSR2, &osa, 0);
223 sigprocmask (SIG_SETMASK, &osig, 0);
224
225 # elif CORO_LOSER
226
227 coro_setjmp (ctx->env);
228 #if __CYGWIN__
229 ctx->env[7] = (long)((char *)sptr + ssize) - sizeof (long);
230 ctx->env[8] = (long)coro_init;
231 #elif defined(__MINGW32__)
232 ctx->env[4] = (long)((char *)sptr + ssize) - sizeof (long);
233 ctx->env[5] = (long)coro_init;
234 #elif defined(_M_IX86)
235 ((_JUMP_BUFFER *)&ctx->env)->Eip = (long)coro_init;
236 ((_JUMP_BUFFER *)&ctx->env)->Esp = (long)STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
237 #elif defined(_M_AMD64)
238 ((_JUMP_BUFFER *)&ctx->env)->Rip = (__int64)coro_init;
239 ((_JUMP_BUFFER *)&ctx->env)->Rsp = (__int64)STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
240 #elif defined(_M_IA64)
241 ((_JUMP_BUFFER *)&ctx->env)->StIIP = (__int64)coro_init;
242 ((_JUMP_BUFFER *)&ctx->env)->IntSp = (__int64)STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
243 #else
244 #error "microsoft libc or architecture not supported"
245 #endif
246
247 # elif CORO_LINUX
248
249 coro_setjmp (ctx->env);
250 #if __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 0 && defined (JB_PC) && defined (JB_SP)
251 ctx->env[0].__jmpbuf[JB_PC] = (long)coro_init;
252 ctx->env[0].__jmpbuf[JB_SP] = (long)STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
253 #elif __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 0 && defined (__mc68000__)
254 ctx->env[0].__jmpbuf[0].__aregs[0] = (long int)coro_init;
255 ctx->env[0].__jmpbuf[0].__sp = (int *)((char *)sptr + ssize) - sizeof (long);
256 #elif defined (__GNU_LIBRARY__) && defined (__i386__)
257 ctx->env[0].__jmpbuf[0].__pc = (char *)coro_init;
258 ctx->env[0].__jmpbuf[0].__sp = (void *)((char *)sptr + ssize) - sizeof (long);
259 #elif defined (__GNU_LIBRARY__) && defined (__amd64__)
260 ctx->env[0].__jmpbuf[JB_PC] = (long)coro_init;
261 ctx->env[0].__jmpbuf[0].__sp = (void *)((char *)sptr + ssize) - sizeof (long);
262 #else
263 #error "linux libc or architecture not supported"
264 #endif
265
266 # elif CORO_IRIX
267
268 coro_setjmp (ctx->env, 0);
269 ctx->env[JB_PC] = (__uint64_t)coro_init;
270 ctx->env[JB_SP] = (__uint64_t)STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
271
272 # elif CORO_ASM
273
274 ctx->sp = (void **)(ssize + (char *)sptr);
275 *--ctx->sp = (void *)abort; /* needed for alignment only */
276 *--ctx->sp = (void *)coro_init;
277 ctx->sp -= NUM_SAVED;
278
279 # elif CORO_UCONTEXT
280
281 getcontext (&(ctx->uc));
282
283 ctx->uc.uc_link = 0;
284 ctx->uc.uc_stack.ss_sp = sptr;
285 ctx->uc.uc_stack.ss_size = (size_t)ssize;
286 ctx->uc.uc_stack.ss_flags = 0;
287
288 makecontext (&(ctx->uc), (void (*)())coro_init, 0);
289
290 # endif
291
292 coro_transfer (create_coro, new_coro);
293 }
294
295 /*****************************************************************************/
296 /* pthread backend */
297 /*****************************************************************************/
298 #elif CORO_PTHREAD
299
300 /* this mutex will be locked by the running coroutine */
301 pthread_mutex_t coro_mutex = PTHREAD_MUTEX_INITIALIZER;
302
303 struct coro_init_args
304 {
305 coro_func func;
306 void *arg;
307 coro_context *self, *main;
308 };
309
310 static pthread_t null_tid;
311
312 /* I'd so love to cast pthread_mutex_unlock to void (*)(void *)... */
313 static void
314 mutex_unlock_wrapper (void *arg)
315 {
316 pthread_mutex_unlock ((pthread_mutex_t *)arg);
317 }
318
319 static void *
320 coro_init (void *args_)
321 {
322 struct coro_init_args *args = (struct coro_init_args *)args_;
323 coro_func func = args->func;
324 void *arg = args->arg;
325
326 pthread_mutex_lock (&coro_mutex);
327
328 /* we try to be good citizens and use deferred cancellation and cleanup handlers */
329 pthread_cleanup_push (mutex_unlock_wrapper, &coro_mutex);
330 coro_transfer (args->self, args->main);
331 func (arg);
332 pthread_cleanup_pop (1);
333
334 return 0;
335 }
336
337 void
338 coro_transfer (coro_context *prev, coro_context *next)
339 {
340 pthread_cond_signal (&next->cv);
341 pthread_cond_wait (&prev->cv, &coro_mutex);
342 #if __FreeBSD__ /* freebsd is of course broken and needs manual testcancel calls... yay... */
343 pthread_testcancel ();
344 #endif
345 }
346
347 void
348 coro_create (coro_context *ctx, coro_func coro, void *arg, void *sptr, long ssize)
349 {
350 static coro_context nctx;
351 static int once;
352
353 if (!once)
354 {
355 once = 1;
356
357 pthread_mutex_lock (&coro_mutex);
358 pthread_cond_init (&nctx.cv, 0);
359 null_tid = pthread_self ();
360 }
361
362 pthread_cond_init (&ctx->cv, 0);
363
364 if (coro)
365 {
366 pthread_attr_t attr;
367 struct coro_init_args args;
368
369 args.func = coro;
370 args.arg = arg;
371 args.self = ctx;
372 args.main = &nctx;
373
374 pthread_attr_init (&attr);
375 pthread_attr_setstack (&attr, sptr, (size_t)ssize);
376 pthread_attr_setscope (&attr, PTHREAD_SCOPE_PROCESS);
377 pthread_create (&ctx->id, &attr, coro_init, &args);
378
379 coro_transfer (args.main, args.self);
380 }
381 else
382 ctx->id = null_tid;
383 }
384
385 void
386 coro_destroy (coro_context *ctx)
387 {
388 if (!pthread_equal (ctx->id, null_tid))
389 {
390 pthread_cancel (ctx->id);
391 pthread_mutex_unlock (&coro_mutex);
392 pthread_join (ctx->id, 0);
393 pthread_mutex_lock (&coro_mutex);
394 }
395
396 pthread_cond_destroy (&ctx->cv);
397 }
398
399 #else
400 # error unsupported backend
401 #endif
402