ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.c
Revision: 1.50
Committed: Fri Apr 2 19:13:54 2010 UTC (14 years, 1 month ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.49: +28 -26 lines
Log Message:
*** empty log message ***

File Contents

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