ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.c
Revision: 1.62
Committed: Mon Aug 8 22:00:18 2011 UTC (12 years, 9 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-6_10, rel-6_09, rel-6_08, rel-6_07, rel-6_06
Changes since 1.61: +3 -0 lines
Log Message:
*** empty log message ***

File Contents

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