ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.c
Revision: 1.60
Committed: Mon Jun 13 09:00:15 2011 UTC (12 years, 11 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-6_0
Changes since 1.59: +17 -5 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 /*
2 * Copyright (c) 2001-2011 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 #if __linux && __amd64
92 /* we blindly assume on any __linux with __amd64 we have a new enough gas with .cfi_undefined support */
93 asm (".cfi_undefined rip");
94 #endif
95
96 func ((void *)arg);
97
98 /* the new coro returned. bad. just abort() for now */
99 abort ();
100 }
101
102 # if CORO_SJLJ
103
104 static volatile int trampoline_done;
105
106 /* trampoline signal handler */
107 static void
108 trampoline (int sig)
109 {
110 if (coro_setjmp (new_coro->env))
111 coro_init (); /* start it */
112 else
113 trampoline_done = 1;
114 }
115
116 # endif
117
118 # if CORO_ASM
119
120 #if _WIN32
121 #define CORO_WIN_TIB 1
122 #endif
123
124 asm (
125 "\t.text\n"
126 "\t.globl coro_transfer\n"
127 "coro_transfer:\n"
128 /* windows, of course, gives a shit on the amd64 ABI and uses different registers */
129 /* http://blogs.msdn.com/freik/archive/2005/03/17/398200.aspx */
130 #if __amd64
131 #ifdef WIN32
132 /* TODO: xmm6..15 also would need to be saved. sigh. */
133 #define NUM_SAVED 8
134 "\tpushq %rsi\n"
135 "\tpushq %rdi\n"
136 "\tpushq %rbp\n"
137 "\tpushq %rbx\n"
138 "\tpushq %r12\n"
139 "\tpushq %r13\n"
140 "\tpushq %r14\n"
141 "\tpushq %r15\n"
142 #if CORO_WIN_TIB
143 "\tpushq %fs:0x0\n"
144 "\tpushq %fs:0x8\n"
145 "\tpushq %fs:0xc\n"
146 #endif
147 "\tmovq %rsp, (%rcx)\n"
148 "\tmovq (%rdx), %rsp\n"
149 #if CORO_WIN_TIB
150 "\tpopq %fs:0xc\n"
151 "\tpopq %fs:0x8\n"
152 "\tpopq %fs:0x0\n"
153 #endif
154 "\tpopq %r15\n"
155 "\tpopq %r14\n"
156 "\tpopq %r13\n"
157 "\tpopq %r12\n"
158 "\tpopq %rbx\n"
159 "\tpopq %rbp\n"
160 "\tpopq %rdi\n"
161 "\tpopq %rsi\n"
162 #else
163 #define NUM_SAVED 6
164 "\tpushq %rbp\n"
165 "\tpushq %rbx\n"
166 "\tpushq %r12\n"
167 "\tpushq %r13\n"
168 "\tpushq %r14\n"
169 "\tpushq %r15\n"
170 "\tmovq %rsp, (%rdi)\n"
171 "\tmovq (%rsi), %rsp\n"
172 "\tpopq %r15\n"
173 "\tpopq %r14\n"
174 "\tpopq %r13\n"
175 "\tpopq %r12\n"
176 "\tpopq %rbx\n"
177 "\tpopq %rbp\n"
178 #endif
179 #elif __i386
180 #define NUM_SAVED 4
181 "\tpushl %ebp\n"
182 "\tpushl %ebx\n"
183 "\tpushl %esi\n"
184 "\tpushl %edi\n"
185 #if CORO_WIN_TIB
186 "\tpushl %fs:0\n"
187 "\tpushl %fs:4\n"
188 "\tpushl %fs:8\n"
189 #endif
190 "\tmovl %esp, (%eax)\n"
191 "\tmovl (%edx), %esp\n"
192 #if CORO_WIN_TIB
193 "\tpopl %fs:8\n"
194 "\tpopl %fs:4\n"
195 "\tpopl %fs:0\n"
196 #endif
197 "\tpopl %edi\n"
198 "\tpopl %esi\n"
199 "\tpopl %ebx\n"
200 "\tpopl %ebp\n"
201 #else
202 #error unsupported architecture
203 #endif
204 "\tret\n"
205 );
206
207 # endif
208
209 void
210 coro_create (coro_context *ctx, coro_func coro, void *arg, void *sptr, long ssize)
211 {
212 coro_context nctx;
213 # if CORO_SJLJ
214 stack_t ostk, nstk;
215 struct sigaction osa, nsa;
216 sigset_t nsig, osig;
217 # endif
218
219 if (!coro)
220 return;
221
222 coro_init_func = coro;
223 coro_init_arg = arg;
224
225 new_coro = ctx;
226 create_coro = &nctx;
227
228 # if CORO_SJLJ
229 /* we use SIGUSR2. first block it, then fiddle with it. */
230
231 sigemptyset (&nsig);
232 sigaddset (&nsig, SIGUSR2);
233 sigprocmask (SIG_BLOCK, &nsig, &osig);
234
235 nsa.sa_handler = trampoline;
236 sigemptyset (&nsa.sa_mask);
237 nsa.sa_flags = SA_ONSTACK;
238
239 if (sigaction (SIGUSR2, &nsa, &osa))
240 {
241 perror ("sigaction");
242 abort ();
243 }
244
245 /* set the new stack */
246 nstk.ss_sp = STACK_ADJUST_PTR (sptr, ssize); /* yes, some platforms (IRIX) get this wrong. */
247 nstk.ss_size = STACK_ADJUST_SIZE (sptr, ssize);
248 nstk.ss_flags = 0;
249
250 if (sigaltstack (&nstk, &ostk) < 0)
251 {
252 perror ("sigaltstack");
253 abort ();
254 }
255
256 trampoline_done = 0;
257 kill (getpid (), SIGUSR2);
258 sigfillset (&nsig); sigdelset (&nsig, SIGUSR2);
259
260 while (!trampoline_done)
261 sigsuspend (&nsig);
262
263 sigaltstack (0, &nstk);
264 nstk.ss_flags = SS_DISABLE;
265 if (sigaltstack (&nstk, 0) < 0)
266 perror ("sigaltstack");
267
268 sigaltstack (0, &nstk);
269 if (~nstk.ss_flags & SS_DISABLE)
270 abort ();
271
272 if (~ostk.ss_flags & SS_DISABLE)
273 sigaltstack (&ostk, 0);
274
275 sigaction (SIGUSR2, &osa, 0);
276 sigprocmask (SIG_SETMASK, &osig, 0);
277
278 # elif CORO_LOSER
279
280 coro_setjmp (ctx->env);
281 #if __CYGWIN__ && __i386
282 ctx->env[8] = (long) coro_init;
283 ctx->env[7] = (long) ((char *)sptr + ssize) - sizeof (long);
284 #elif __CYGWIN__ && __x86_64
285 ctx->env[7] = (long) coro_init;
286 ctx->env[6] = (long) ((char *)sptr + ssize) - sizeof (long);
287 #elif defined(__MINGW32__)
288 ctx->env[5] = (long) coro_init;
289 ctx->env[4] = (long) ((char *)sptr + ssize) - sizeof (long);
290 #elif defined(_M_IX86)
291 ((_JUMP_BUFFER *)&ctx->env)->Eip = (long) coro_init;
292 ((_JUMP_BUFFER *)&ctx->env)->Esp = (long) STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
293 #elif defined(_M_AMD64)
294 ((_JUMP_BUFFER *)&ctx->env)->Rip = (__int64) coro_init;
295 ((_JUMP_BUFFER *)&ctx->env)->Rsp = (__int64) STACK_ADJUST_PTR (sptr, ssize) - sizeof (__int64);
296 #elif defined(_M_IA64)
297 ((_JUMP_BUFFER *)&ctx->env)->StIIP = (__int64) coro_init;
298 ((_JUMP_BUFFER *)&ctx->env)->IntSp = (__int64) STACK_ADJUST_PTR (sptr, ssize) - sizeof (__int64);
299 #else
300 #error "microsoft libc or architecture not supported"
301 #endif
302
303 # elif CORO_LINUX
304
305 coro_setjmp (ctx->env);
306 #if __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 0 && defined (JB_PC) && defined (JB_SP)
307 ctx->env[0].__jmpbuf[JB_PC] = (long) coro_init;
308 ctx->env[0].__jmpbuf[JB_SP] = (long) STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
309 #elif __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 0 && defined (__mc68000__)
310 ctx->env[0].__jmpbuf[0].__aregs[0] = (long int)coro_init;
311 ctx->env[0].__jmpbuf[0].__sp = (int *) ((char *)sptr + ssize) - sizeof (long);
312 #elif defined (__GNU_LIBRARY__) && defined (__i386__)
313 ctx->env[0].__jmpbuf[0].__pc = (char *) coro_init;
314 ctx->env[0].__jmpbuf[0].__sp = (void *) ((char *)sptr + ssize) - sizeof (long);
315 #elif defined (__GNU_LIBRARY__) && defined (__amd64__)
316 ctx->env[0].__jmpbuf[JB_PC] = (long) coro_init;
317 ctx->env[0].__jmpbuf[0].__sp = (void *) ((char *)sptr + ssize) - sizeof (long);
318 #else
319 #error "linux libc or architecture not supported"
320 #endif
321
322 # elif CORO_IRIX
323
324 coro_setjmp (ctx->env, 0);
325 ctx->env[JB_PC] = (__uint64_t)coro_init;
326 ctx->env[JB_SP] = (__uint64_t)STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
327
328 # elif CORO_ASM
329
330 ctx->sp = (void **)(ssize + (char *)sptr);
331 *--ctx->sp = (void *)abort; /* needed for alignment only */
332 *--ctx->sp = (void *)coro_init;
333
334 #if CORO_WIN_TIB
335 *--ctx->sp = 0; /* ExceptionList */
336 *--ctx->sp = (char *)sptr + ssize; /* StackBase */
337 *--ctx->sp = sptr; /* StackLimit */
338 #endif
339
340 ctx->sp -= NUM_SAVED;
341 memset (ctx->sp, 0, sizeof (*ctx->sp) * NUM_SAVED);
342
343 # elif CORO_UCONTEXT
344
345 getcontext (&(ctx->uc));
346
347 ctx->uc.uc_link = 0;
348 ctx->uc.uc_stack.ss_sp = sptr;
349 ctx->uc.uc_stack.ss_size = (size_t)ssize;
350 ctx->uc.uc_stack.ss_flags = 0;
351
352 makecontext (&(ctx->uc), (void (*)())coro_init, 0);
353
354 # endif
355
356 coro_transfer (create_coro, new_coro);
357 }
358
359 /*****************************************************************************/
360 /* pthread backend */
361 /*****************************************************************************/
362 #elif CORO_PTHREAD
363
364 /* this mutex will be locked by the running coroutine */
365 pthread_mutex_t coro_mutex = PTHREAD_MUTEX_INITIALIZER;
366
367 struct coro_init_args
368 {
369 coro_func func;
370 void *arg;
371 coro_context *self, *main;
372 };
373
374 static pthread_t null_tid;
375
376 /* I'd so love to cast pthread_mutex_unlock to void (*)(void *)... */
377 static void
378 mutex_unlock_wrapper (void *arg)
379 {
380 pthread_mutex_unlock ((pthread_mutex_t *)arg);
381 }
382
383 static void *
384 coro_init (void *args_)
385 {
386 struct coro_init_args *args = (struct coro_init_args *)args_;
387 coro_func func = args->func;
388 void *arg = args->arg;
389
390 pthread_mutex_lock (&coro_mutex);
391
392 /* we try to be good citizens and use deferred cancellation and cleanup handlers */
393 pthread_cleanup_push (mutex_unlock_wrapper, &coro_mutex);
394 coro_transfer (args->self, args->main);
395 func (arg);
396 pthread_cleanup_pop (1);
397
398 return 0;
399 }
400
401 void
402 coro_transfer (coro_context *prev, coro_context *next)
403 {
404 pthread_cond_signal (&next->cv);
405 pthread_cond_wait (&prev->cv, &coro_mutex);
406 #if __FreeBSD__ /* freebsd is of course broken and needs manual testcancel calls... yay... */
407 pthread_testcancel ();
408 #endif
409 }
410
411 void
412 coro_create (coro_context *ctx, coro_func coro, void *arg, void *sptr, long ssize)
413 {
414 static coro_context nctx;
415 static int once;
416
417 if (!once)
418 {
419 once = 1;
420
421 pthread_mutex_lock (&coro_mutex);
422 pthread_cond_init (&nctx.cv, 0);
423 null_tid = pthread_self ();
424 }
425
426 pthread_cond_init (&ctx->cv, 0);
427
428 if (coro)
429 {
430 pthread_attr_t attr;
431 struct coro_init_args args;
432
433 args.func = coro;
434 args.arg = arg;
435 args.self = ctx;
436 args.main = &nctx;
437
438 pthread_attr_init (&attr);
439 #if __UCLIBC__
440 /* exists, but is borked */
441 /*pthread_attr_setstacksize (&attr, (size_t)ssize);*/
442 #else
443 pthread_attr_setstack (&attr, sptr, (size_t)ssize);
444 #endif
445 pthread_attr_setscope (&attr, PTHREAD_SCOPE_PROCESS);
446 pthread_create (&ctx->id, &attr, coro_init, &args);
447
448 coro_transfer (args.main, args.self);
449 }
450 else
451 ctx->id = null_tid;
452 }
453
454 void
455 coro_destroy (coro_context *ctx)
456 {
457 if (!pthread_equal (ctx->id, null_tid))
458 {
459 pthread_cancel (ctx->id);
460 pthread_mutex_unlock (&coro_mutex);
461 pthread_join (ctx->id, 0);
462 pthread_mutex_lock (&coro_mutex);
463 }
464
465 pthread_cond_destroy (&ctx->cv);
466 }
467
468 #else
469 # error unsupported backend
470 #endif
471