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