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