ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.c
Revision: 1.43
Committed: Sun Nov 16 00:55:41 2008 UTC (15 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.42: +3 -0 lines
Log Message:
*** empty log message ***

File Contents

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