ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libcoro/coro.c
Revision: 1.51
Committed: Fri Apr 2 19:18:01 2010 UTC (14 years, 2 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.50: +12 -11 lines
Log Message:
*** empty log message ***

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 #if CORO_WIN_TIB
129 "\tpush %fs:0x0\n"
130 "\tpush %fs:0x8\n"
131 "\tpush %fs:0xc\n"
132 #endif
133 "\tmov %rsp, (%rdi)\n"
134 "\tmov (%rsi), %rsp\n"
135 #if CORO_WIN_TIB
136 "\tpop %fs:0xc\n"
137 "\tpop %fs:0x8\n"
138 "\tpop %fs:0x0\n"
139 #endif
140 "\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 #define NUM_SAVED 4
148 "\tpush %ebp\n"
149 "\tpush %ebx\n"
150 "\tpush %esi\n"
151 "\tpush %edi\n"
152 #if CORO_WIN_TIB
153 "\tpush %fs:0\n"
154 "\tpush %fs:4\n"
155 "\tpush %fs:8\n"
156 #endif
157 "\tmov %esp, (%eax)\n"
158 "\tmov (%edx), %esp\n"
159 #if CORO_WIN_TIB
160 "\tpop %fs:8\n"
161 "\tpop %fs:4\n"
162 "\tpop %fs:0\n"
163 #endif
164 "\tpop %edi\n"
165 "\tpop %esi\n"
166 "\tpop %ebx\n"
167 "\tpop %ebp\n"
168 #else
169 #error unsupported architecture
170 #endif
171 "\tret\n"
172 );
173
174 # endif
175
176 void
177 coro_create (coro_context *ctx, coro_func coro, void *arg, void *sptr, long ssize)
178 {
179 coro_context nctx;
180 # if CORO_SJLJ
181 stack_t ostk, nstk;
182 struct sigaction osa, nsa;
183 sigset_t nsig, osig;
184 # endif
185
186 if (!coro)
187 return;
188
189 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 {
208 perror ("sigaction");
209 abort ();
210 }
211
212 /* set the new stack */
213 nstk.ss_sp = STACK_ADJUST_PTR (sptr,ssize); /* yes, some platforms (IRIX) get this wrong. */
214 nstk.ss_size = STACK_ADJUST_SIZE (sptr,ssize);
215 nstk.ss_flags = 0;
216
217 if (sigaltstack (&nstk, &ostk) < 0)
218 {
219 perror ("sigaltstack");
220 abort ();
221 }
222
223 trampoline_done = 0;
224 kill (getpid (), SIGUSR2);
225 sigfillset (&nsig); sigdelset (&nsig, SIGUSR2);
226
227 while (!trampoline_done)
228 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 sigaction (SIGUSR2, &osa, 0);
243 sigprocmask (SIG_SETMASK, &osig, 0);
244
245 # elif CORO_LOSER
246
247 coro_setjmp (ctx->env);
248 #if __CYGWIN__ && __i386
249 ctx->env[8] = (long) coro_init;
250 ctx->env[7] = (long) ((char *)sptr + ssize) - sizeof (long);
251 #elif __CYGWIN__ && __x86_64
252 ctx->env[7] = (long) coro_init;
253 ctx->env[6] = (long) ((char *)sptr + ssize) - sizeof (long);
254 #elif defined(__MINGW32__)
255 ctx->env[5] = (long) coro_init;
256 ctx->env[4] = (long) ((char *)sptr + ssize) - sizeof (long);
257 #elif defined(_M_IX86)
258 ((_JUMP_BUFFER *)&ctx->env)->Eip = (long) coro_init;
259 ((_JUMP_BUFFER *)&ctx->env)->Esp = (long) STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
260 #elif defined(_M_AMD64)
261 ((_JUMP_BUFFER *)&ctx->env)->Rip = (__int64) coro_init;
262 ((_JUMP_BUFFER *)&ctx->env)->Rsp = (__int64) STACK_ADJUST_PTR (sptr, ssize) - sizeof (__int64);
263 #elif defined(_M_IA64)
264 ((_JUMP_BUFFER *)&ctx->env)->StIIP = (__int64) coro_init;
265 ((_JUMP_BUFFER *)&ctx->env)->IntSp = (__int64) STACK_ADJUST_PTR (sptr, ssize) - sizeof (__int64);
266 #else
267 #error "microsoft libc or architecture not supported"
268 #endif
269
270 # elif CORO_LINUX
271
272 coro_setjmp (ctx->env);
273 #if __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 0 && defined (JB_PC) && defined (JB_SP)
274 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 #elif __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 0 && defined (__mc68000__)
277 ctx->env[0].__jmpbuf[0].__aregs[0] = (long int)coro_init;
278 ctx->env[0].__jmpbuf[0].__sp = (int *) ((char *)sptr + ssize) - sizeof (long);
279 #elif defined (__GNU_LIBRARY__) && defined (__i386__)
280 ctx->env[0].__jmpbuf[0].__pc = (char *) coro_init;
281 ctx->env[0].__jmpbuf[0].__sp = (void *) ((char *)sptr + ssize) - sizeof (long);
282 #elif defined (__GNU_LIBRARY__) && defined (__amd64__)
283 ctx->env[0].__jmpbuf[JB_PC] = (long) coro_init;
284 ctx->env[0].__jmpbuf[0].__sp = (void *) ((char *)sptr + ssize) - sizeof (long);
285 #else
286 #error "linux libc or architecture not supported"
287 #endif
288
289 # elif CORO_IRIX
290
291 coro_setjmp (ctx->env, 0);
292 ctx->env[JB_PC] = (__uint64_t)coro_init;
293 ctx->env[JB_SP] = (__uint64_t)STACK_ADJUST_PTR (sptr, ssize) - sizeof (long);
294
295 # elif CORO_ASM
296
297 ctx->sp = (void **)(ssize + (char *)sptr);
298 *--ctx->sp = (void *)abort; /* needed for alignment only */
299 *--ctx->sp = (void *)coro_init;
300
301 #if CORO_WIN_TIB
302 *--ctx->sp = 0; /* ExceptionList */
303 *--ctx->sp = (char *)sptr + ssize; /* StackBase */
304 *--ctx->sp = sptr; /* StackLimit */
305 #endif
306
307 ctx->sp -= NUM_SAVED;
308
309 # elif CORO_UCONTEXT
310
311 getcontext (&(ctx->uc));
312
313 ctx->uc.uc_link = 0;
314 ctx->uc.uc_stack.ss_sp = sptr;
315 ctx->uc.uc_stack.ss_size = (size_t)ssize;
316 ctx->uc.uc_stack.ss_flags = 0;
317
318 makecontext (&(ctx->uc), (void (*)())coro_init, 0);
319
320 # endif
321
322 coro_transfer (create_coro, new_coro);
323 }
324
325 /*****************************************************************************/
326 /* pthread backend */
327 /*****************************************************************************/
328 #elif CORO_PTHREAD
329
330 /* this mutex will be locked by the running coroutine */
331 pthread_mutex_t coro_mutex = PTHREAD_MUTEX_INITIALIZER;
332
333 struct coro_init_args
334 {
335 coro_func func;
336 void *arg;
337 coro_context *self, *main;
338 };
339
340 static pthread_t null_tid;
341
342 /* I'd so love to cast pthread_mutex_unlock to void (*)(void *)... */
343 static void
344 mutex_unlock_wrapper (void *arg)
345 {
346 pthread_mutex_unlock ((pthread_mutex_t *)arg);
347 }
348
349 static void *
350 coro_init (void *args_)
351 {
352 struct coro_init_args *args = (struct coro_init_args *)args_;
353 coro_func func = args->func;
354 void *arg = args->arg;
355
356 pthread_mutex_lock (&coro_mutex);
357
358 /* we try to be good citizens and use deferred cancellation and cleanup handlers */
359 pthread_cleanup_push (mutex_unlock_wrapper, &coro_mutex);
360 coro_transfer (args->self, args->main);
361 func (arg);
362 pthread_cleanup_pop (1);
363
364 return 0;
365 }
366
367 void
368 coro_transfer (coro_context *prev, coro_context *next)
369 {
370 pthread_cond_signal (&next->cv);
371 pthread_cond_wait (&prev->cv, &coro_mutex);
372 #if __FreeBSD__ /* freebsd is of course broken and needs manual testcancel calls... yay... */
373 pthread_testcancel ();
374 #endif
375 }
376
377 void
378 coro_create (coro_context *ctx, coro_func coro, void *arg, void *sptr, long ssize)
379 {
380 static coro_context nctx;
381 static int once;
382
383 if (!once)
384 {
385 once = 1;
386
387 pthread_mutex_lock (&coro_mutex);
388 pthread_cond_init (&nctx.cv, 0);
389 null_tid = pthread_self ();
390 }
391
392 pthread_cond_init (&ctx->cv, 0);
393
394 if (coro)
395 {
396 pthread_attr_t attr;
397 struct coro_init_args args;
398
399 args.func = coro;
400 args.arg = arg;
401 args.self = ctx;
402 args.main = &nctx;
403
404 pthread_attr_init (&attr);
405 pthread_attr_setstack (&attr, sptr, (size_t)ssize);
406 pthread_attr_setscope (&attr, PTHREAD_SCOPE_PROCESS);
407 pthread_create (&ctx->id, &attr, coro_init, &args);
408
409 coro_transfer (args.main, args.self);
410 }
411 else
412 ctx->id = null_tid;
413 }
414
415 void
416 coro_destroy (coro_context *ctx)
417 {
418 if (!pthread_equal (ctx->id, null_tid))
419 {
420 pthread_cancel (ctx->id);
421 pthread_mutex_unlock (&coro_mutex);
422 pthread_join (ctx->id, 0);
423 pthread_mutex_lock (&coro_mutex);
424 }
425
426 pthread_cond_destroy (&ctx->cv);
427 }
428
429 #else
430 # error unsupported backend
431 #endif
432