Avoid signed overflow and use size_t in bytevectors.c.
[bpt/guile.git] / libguile / continuations.c
1 /* Copyright (C) 1995,1996,1998,2000,2001,2004, 2006, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
2 *
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
7 *
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16 * 02110-1301 USA
17 */
18
19
20 \f
21 #ifdef HAVE_CONFIG_H
22 # include <config.h>
23 #endif
24
25 #include "libguile/_scm.h"
26
27 #include <string.h>
28 #include <stdio.h>
29
30 #include "libguile/async.h"
31 #include "libguile/debug.h"
32 #include "libguile/root.h"
33 #include "libguile/stackchk.h"
34 #include "libguile/smob.h"
35 #include "libguile/ports.h"
36 #include "libguile/dynwind.h"
37 #include "libguile/eval.h"
38 #include "libguile/vm.h"
39 #include "libguile/instructions.h"
40
41 #include "libguile/validate.h"
42 #include "libguile/continuations.h"
43
44 \f
45
46 static scm_t_bits tc16_continuation;
47 #define SCM_CONTREGSP(x) SCM_TYP16_PREDICATE (tc16_continuation, x)
48
49 #define SCM_CONTREGS(x) ((scm_t_contregs *) SCM_SMOB_DATA_1 (x))
50
51 #define SCM_CONTINUATION_LENGTH(x) (SCM_CONTREGS (x)->num_stack_items)
52 #define SCM_SET_CONTINUATION_LENGTH(x, n)\
53 (SCM_CONTREGS (x)->num_stack_items = (n))
54 #define SCM_JMPBUF(x) ((SCM_CONTREGS (x))->jmpbuf)
55 #define SCM_DYNENV(x) ((SCM_CONTREGS (x))->dynenv)
56 #define SCM_CONTINUATION_ROOT(x) ((SCM_CONTREGS (x))->root)
57 #define SCM_DFRAME(x) ((SCM_CONTREGS (x))->dframe)
58
59 \f
60
61 /* scm_i_make_continuation will return a procedure whose objcode contains an
62 instruction to reinstate the continuation. Here, as in gsubr.c and smob.c, we
63 define the form of that trampoline function.
64 */
65
66 #ifdef WORDS_BIGENDIAN
67 #define OBJCODE_HEADER(main,meta) 0, 0, 0, main, 0, 0, 0, meta+8
68 #define META_HEADER(meta) 0, 0, 0, meta, 0, 0, 0, 0
69 #else
70 #define OBJCODE_HEADER(main,meta) main, 0, 0, 0, meta+8, 0, 0, 0
71 #define META_HEADER(meta) meta, 0, 0, 0, 0, 0, 0, 0
72 #endif
73
74 #define OBJCODE_TAG SCM_MAKE_OBJCODE_TAG (SCM_OBJCODE_TYPE_STATIC, 0)
75
76 #if defined (SCM_ALIGNED) && 0
77 #define SCM_DECLARE_STATIC_ALIGNED_ARRAY(type, sym) \
78 static const type sym[]
79 #define SCM_STATIC_ALIGNED_ARRAY(alignment, type, sym) \
80 static SCM_ALIGNED (alignment) const type sym[]
81 #define SCM_STATIC_OBJCODE(sym) \
82 SCM_DECLARE_STATIC_ALIGNED_ARRAY (scm_t_uint8, sym##__bytecode); \
83 SCM_STATIC_ALIGNED_ARRAY (8, scm_t_cell, sym##__cells) = { \
84 { SCM_PACK (OBJCODE_TAG), SCM_PACK (sym##__bytecode) }, \
85 { SCM_BOOL_F, SCM_PACK (0) } \
86 }; \
87 static const SCM sym = SCM_PACK (sym##__cells); \
88 SCM_STATIC_ALIGNED_ARRAY (8, scm_t_uint8, sym##__bytecode)
89 #else
90 #define SCM_STATIC_OBJCODE(sym) \
91 static SCM sym; \
92 static scm_t_uint8 *sym##_bytecode; \
93 SCM_SNARF_INIT(sym##_bytecode = scm_gc_malloc_pointerless (sizeof(sym##_bytecode__unaligned), "partial continuation stub"); \
94 memcpy (sym##_bytecode, sym##_bytecode__unaligned, sizeof(sym##_bytecode__unaligned));) \
95 SCM_SNARF_INIT(sym = scm_double_cell (OBJCODE_TAG, \
96 (scm_t_bits)sym##_bytecode, \
97 SCM_UNPACK (SCM_BOOL_F), \
98 0);) \
99 static const scm_t_uint8 sym##_bytecode__unaligned[]
100 #endif
101
102
103 SCM_STATIC_OBJCODE (cont_objcode) = {
104 /* This code is the same as in gsubr.c, except we use continuation_call
105 instead of subr_call. */
106 OBJCODE_HEADER (8, 19),
107 /* leave args on the stack */
108 /* 0 */ scm_op_object_ref, 0, /* push scm_t_contregs smob */
109 /* 2 */ scm_op_continuation_call, /* and longjmp (whee) */
110 /* 3 */ scm_op_nop, /* pad to 8 bytes */
111 /* 4 */ scm_op_nop, scm_op_nop, scm_op_nop, scm_op_nop,
112 /* 8 */
113
114 /* We could put some meta-info to say that this proc is a continuation. Not sure
115 how to do that, though. */
116 META_HEADER (19),
117 /* 0 */ scm_op_make_eol, /* bindings */
118 /* 1 */ scm_op_make_eol, /* sources */
119 /* 2 */ scm_op_make_int8, 0, scm_op_make_int8, 3, /* arity: from ip 0 to ip 3 */
120 /* 6 */ scm_op_make_int8_0, /* the arity is 0 required args */
121 /* 7 */ scm_op_make_int8_0, /* 0 optionals */
122 /* 8 */ scm_op_make_true, /* and a rest arg */
123 /* 9 */ scm_op_list, 0, 5, /* make a list of those 5 vals */
124 /* 12 */ scm_op_list, 0, 1, /* and the arities will be a list of that one list */
125 /* 15 */ scm_op_list, 0, 3, /* pack bindings, sources, and arities into list */
126 /* 18 */ scm_op_return /* and return */
127 /* 19 */
128 };
129
130
131 SCM_STATIC_OBJCODE (call_cc_objcode) = {
132 /* Before Scheme's call/cc is compiled, eval.c will use this hand-coded
133 call/cc. */
134 OBJCODE_HEADER (8, 17),
135 /* 0 */ scm_op_assert_nargs_ee, 0, 1, /* assert that nargs==1 */
136 /* 3 */ scm_op_local_ref, 0, /* push the proc */
137 /* 5 */ scm_op_tail_call_cc, /* and call/cc */
138 /* 6 */ scm_op_nop, scm_op_nop, /* pad to 8 bytes */
139 /* 8 */
140
141 META_HEADER (17),
142 /* 0 */ scm_op_make_eol, /* bindings */
143 /* 1 */ scm_op_make_eol, /* sources */
144 /* 2 */ scm_op_make_int8, 3, scm_op_make_int8, 6, /* arity: from ip 0 to ip 6 */
145 /* 6 */ scm_op_make_int8_1, /* the arity is 0 required args */
146 /* 7 */ scm_op_list, 0, 3, /* make a list of those 5 vals */
147 /* 10 */ scm_op_list, 0, 1, /* and the arities will be a list of that one list */
148 /* 13 */ scm_op_list, 0, 3, /* pack bindings, sources, and arities into list */
149 /* 16 */ scm_op_return /* and return */
150 /* 17 */
151 };
152
153
154 static SCM
155 make_continuation_trampoline (SCM contregs)
156 {
157 SCM ret = scm_make_program (cont_objcode,
158 scm_c_make_vector (1, contregs),
159 SCM_BOOL_F);
160 SCM_SET_CELL_WORD_0 (ret,
161 SCM_CELL_WORD_0 (ret) | SCM_F_PROGRAM_IS_CONTINUATION);
162
163 return ret;
164 }
165
166
167 /* {Continuations}
168 */
169
170
171 static int
172 continuation_print (SCM obj, SCM port, scm_print_state *state SCM_UNUSED)
173 {
174 scm_t_contregs *continuation = SCM_CONTREGS (obj);
175
176 scm_puts ("#<continuation ", port);
177 scm_intprint (continuation->num_stack_items, 10, port);
178 scm_puts (" @ ", port);
179 scm_uintprint (SCM_SMOB_DATA_1 (obj), 16, port);
180 scm_putc ('>', port);
181 return 1;
182 }
183
184 /* this may return more than once: the first time with the escape
185 procedure, then subsequently with SCM_UNDEFINED (the vals already having been
186 placed on the VM stack). */
187 #define FUNC_NAME "scm_i_make_continuation"
188 SCM
189 scm_i_make_continuation (int *first, SCM vm, SCM vm_cont)
190 {
191 scm_i_thread *thread = SCM_I_CURRENT_THREAD;
192 SCM cont;
193 scm_t_contregs *continuation;
194 long stack_size;
195 SCM_STACKITEM * src;
196
197 SCM_FLUSH_REGISTER_WINDOWS;
198 stack_size = scm_stack_size (thread->continuation_base);
199 continuation = scm_gc_malloc (sizeof (scm_t_contregs)
200 + (stack_size - 1) * sizeof (SCM_STACKITEM),
201 "continuation");
202 continuation->num_stack_items = stack_size;
203 continuation->dynenv = scm_i_dynwinds ();
204 continuation->root = thread->continuation_root;
205 src = thread->continuation_base;
206 #if ! SCM_STACK_GROWS_UP
207 src -= stack_size;
208 #endif
209 continuation->offset = continuation->stack - src;
210 memcpy (continuation->stack, src, sizeof (SCM_STACKITEM) * stack_size);
211 continuation->vm = vm;
212 continuation->vm_cont = vm_cont;
213
214 SCM_NEWSMOB (cont, tc16_continuation, continuation);
215
216 *first = !SCM_I_SETJMP (continuation->jmpbuf);
217 if (*first)
218 {
219 #ifdef __ia64__
220 continuation->backing_store_size =
221 (char *) scm_ia64_ar_bsp(&continuation->jmpbuf.ctx)
222 -
223 (char *) thread->register_backing_store_base;
224 continuation->backing_store = NULL;
225 continuation->backing_store =
226 scm_gc_malloc (continuation->backing_store_size,
227 "continuation backing store");
228 memcpy (continuation->backing_store,
229 (void *) thread->register_backing_store_base,
230 continuation->backing_store_size);
231 #endif /* __ia64__ */
232 return make_continuation_trampoline (cont);
233 }
234 else
235 return SCM_UNDEFINED;
236 }
237 #undef FUNC_NAME
238
239 static SCM call_cc;
240
241 static void
242 init_call_cc (void)
243 {
244 call_cc = scm_make_program (call_cc_objcode, SCM_BOOL_F, SCM_BOOL_F);
245 }
246
247 SCM
248 scm_i_call_with_current_continuation (SCM proc)
249 {
250 static scm_i_pthread_once_t once = SCM_I_PTHREAD_ONCE_INIT;
251 scm_i_pthread_once (&once, init_call_cc);
252
253 return scm_call_1 (call_cc, proc);
254 }
255
256 SCM
257 scm_i_continuation_to_frame (SCM continuation)
258 {
259 SCM contregs;
260 scm_t_contregs *cont;
261
262 contregs = scm_c_vector_ref (scm_program_objects (continuation), 0);
263 cont = SCM_CONTREGS (contregs);
264
265 if (scm_is_true (cont->vm_cont))
266 {
267 struct scm_vm_cont *data = SCM_VM_CONT_DATA (cont->vm_cont);
268 return scm_c_make_frame (cont->vm_cont,
269 data->fp + data->reloc,
270 data->sp + data->reloc,
271 data->ra,
272 data->reloc);
273 }
274 else
275 return SCM_BOOL_F;
276 }
277
278 SCM
279 scm_i_contregs_vm (SCM contregs)
280 {
281 return SCM_CONTREGS (contregs)->vm;
282 }
283
284 SCM
285 scm_i_contregs_vm_cont (SCM contregs)
286 {
287 return SCM_CONTREGS (contregs)->vm_cont;
288 }
289
290
291 /* {Apply}
292 */
293
294 /* Invoking a continuation proceeds as follows:
295 *
296 * - the stack is made large enough for the called continuation
297 * - the old windchain is unwound down to the branching point
298 * - the continuation stack is copied into place
299 * - the windchain is rewound up to the continuation's context
300 * - the continuation is invoked via longjmp (or setcontext)
301 *
302 * This order is important so that unwind and rewind handlers are run
303 * with their correct stack.
304 */
305
306 static void scm_dynthrow (SCM);
307
308 /* Grow the stack by a fixed amount to provide space to copy in the
309 * continuation. Possibly this function has to be called several times
310 * recursively before enough space is available. Make sure the compiler does
311 * not optimize the growth array away by storing it's address into a global
312 * variable.
313 */
314
315 static scm_t_bits scm_i_dummy;
316
317 static void
318 grow_stack (SCM cont)
319 {
320 scm_t_bits growth[100];
321
322 scm_i_dummy = (scm_t_bits) growth;
323 scm_dynthrow (cont);
324 }
325
326
327 /* Copy the continuation stack into the current stack. Calling functions from
328 * within this function is safe, since only stack frames below this function's
329 * own frame are overwritten. Thus, memcpy can be used for best performance.
330 */
331
332 typedef struct {
333 scm_t_contregs *continuation;
334 SCM_STACKITEM *dst;
335 } copy_stack_data;
336
337 static void
338 copy_stack (void *data)
339 {
340 copy_stack_data *d = (copy_stack_data *)data;
341 memcpy (d->dst, d->continuation->stack,
342 sizeof (SCM_STACKITEM) * d->continuation->num_stack_items);
343 #ifdef __ia64__
344 SCM_I_CURRENT_THREAD->pending_rbs_continuation = d->continuation;
345 #endif
346 }
347
348 static void
349 copy_stack_and_call (scm_t_contregs *continuation,
350 SCM_STACKITEM * dst)
351 {
352 long delta;
353 copy_stack_data data;
354
355 delta = scm_ilength (scm_i_dynwinds ()) - scm_ilength (continuation->dynenv);
356 data.continuation = continuation;
357 data.dst = dst;
358 scm_i_dowinds (continuation->dynenv, delta, copy_stack, &data);
359
360 SCM_I_LONGJMP (continuation->jmpbuf, 1);
361 }
362
363 #ifdef __ia64__
364 void
365 scm_ia64_longjmp (scm_i_jmp_buf *JB, int VAL)
366 {
367 scm_i_thread *t = SCM_I_CURRENT_THREAD;
368
369 if (t->pending_rbs_continuation)
370 {
371 memcpy (t->register_backing_store_base,
372 t->pending_rbs_continuation->backing_store,
373 t->pending_rbs_continuation->backing_store_size);
374 t->pending_rbs_continuation = NULL;
375 }
376 setcontext (&JB->ctx);
377 }
378 #endif
379
380 /* Call grow_stack until the stack space is large enough, then, as the current
381 * stack frame might get overwritten, let copy_stack_and_call perform the
382 * actual copying and continuation calling.
383 */
384 static void
385 scm_dynthrow (SCM cont)
386 {
387 scm_i_thread *thread = SCM_I_CURRENT_THREAD;
388 scm_t_contregs *continuation = SCM_CONTREGS (cont);
389 SCM_STACKITEM *dst = thread->continuation_base;
390 SCM_STACKITEM stack_top_element;
391
392 if (thread->critical_section_level)
393 {
394 fprintf (stderr, "continuation invoked from within critical section.\n");
395 abort ();
396 }
397
398 #if SCM_STACK_GROWS_UP
399 if (dst + continuation->num_stack_items >= &stack_top_element)
400 grow_stack (cont);
401 #else
402 dst -= continuation->num_stack_items;
403 if (dst <= &stack_top_element)
404 grow_stack (cont);
405 #endif /* def SCM_STACK_GROWS_UP */
406
407 SCM_FLUSH_REGISTER_WINDOWS;
408 copy_stack_and_call (continuation, dst);
409 }
410
411
412 void
413 scm_i_check_continuation (SCM cont)
414 {
415 scm_i_thread *thread = SCM_I_CURRENT_THREAD;
416 scm_t_contregs *continuation = SCM_CONTREGS (cont);
417
418 if (!scm_is_eq (continuation->root, thread->continuation_root))
419 scm_misc_error
420 ("%continuation-call",
421 "invoking continuation would cross continuation barrier: ~A",
422 scm_list_1 (cont));
423 }
424
425 void
426 scm_i_reinstate_continuation (SCM cont)
427 {
428 scm_dynthrow (cont);
429 }
430
431 SCM
432 scm_i_with_continuation_barrier (scm_t_catch_body body,
433 void *body_data,
434 scm_t_catch_handler handler,
435 void *handler_data,
436 scm_t_catch_handler pre_unwind_handler,
437 void *pre_unwind_handler_data)
438 {
439 SCM_STACKITEM stack_item;
440 scm_i_thread *thread = SCM_I_CURRENT_THREAD;
441 SCM old_controot;
442 SCM_STACKITEM *old_contbase;
443 SCM result;
444
445 /* Establish a fresh continuation root.
446 */
447 old_controot = thread->continuation_root;
448 old_contbase = thread->continuation_base;
449 thread->continuation_root = scm_cons (thread->handle, old_controot);
450 thread->continuation_base = &stack_item;
451
452 /* Call FUNC inside a catch all. This is now guaranteed to return
453 directly and exactly once.
454 */
455 result = scm_c_catch (SCM_BOOL_T,
456 body, body_data,
457 handler, handler_data,
458 pre_unwind_handler, pre_unwind_handler_data);
459
460 /* Return to old continuation root.
461 */
462 thread->continuation_base = old_contbase;
463 thread->continuation_root = old_controot;
464
465 return result;
466 }
467
468 \f
469
470 static int
471 should_print_backtrace (SCM tag, SCM stack)
472 {
473 return SCM_BACKTRACE_P
474 && scm_is_true (stack)
475 && scm_initialized_p
476 /* It's generally not useful to print backtraces for errors reading
477 or expanding code in these fallback catch statements. */
478 && !scm_is_eq (tag, scm_from_latin1_symbol ("read-error"))
479 && !scm_is_eq (tag, scm_from_latin1_symbol ("syntax-error"));
480 }
481
482 static void
483 print_exception_and_backtrace (SCM port, SCM tag, SCM args)
484 {
485 SCM stack, frame;
486
487 /* We get here via a throw to a catch-all. In that case there is the
488 throw frame active, and this catch closure, so narrow by two
489 frames. */
490 stack = scm_make_stack (SCM_BOOL_T, scm_list_1 (scm_from_int (2)));
491 frame = scm_is_true (stack) ? scm_stack_ref (stack, SCM_INUM0) : SCM_BOOL_F;
492
493 if (should_print_backtrace (tag, stack))
494 {
495 scm_puts ("Backtrace:\n", port);
496 scm_display_backtrace_with_highlights (stack, port,
497 SCM_BOOL_F, SCM_BOOL_F,
498 SCM_EOL);
499 scm_newline (port);
500 }
501
502 scm_print_exception (port, frame, tag, args);
503 }
504
505 \f
506
507 struct c_data {
508 void *(*func) (void *);
509 void *data;
510 void *result;
511 };
512
513 static SCM
514 c_body (void *d)
515 {
516 struct c_data *data = (struct c_data *)d;
517 data->result = data->func (data->data);
518 return SCM_UNSPECIFIED;
519 }
520
521 static SCM
522 c_handler (void *d, SCM tag, SCM args)
523 {
524 struct c_data *data;
525
526 /* If TAG is `quit', exit() the process. */
527 if (scm_is_eq (tag, scm_from_latin1_symbol ("quit")))
528 exit (scm_exit_status (args));
529
530 data = (struct c_data *)d;
531 data->result = NULL;
532 return SCM_UNSPECIFIED;
533 }
534
535 static SCM
536 pre_unwind_handler (void *error_port, SCM tag, SCM args)
537 {
538 /* Print the exception unless TAG is `quit'. */
539 if (!scm_is_eq (tag, scm_from_latin1_symbol ("quit")))
540 print_exception_and_backtrace (PTR2SCM (error_port), tag, args);
541
542 return SCM_UNSPECIFIED;
543 }
544
545 void *
546 scm_c_with_continuation_barrier (void *(*func) (void *), void *data)
547 {
548 struct c_data c_data;
549 c_data.func = func;
550 c_data.data = data;
551 scm_i_with_continuation_barrier (c_body, &c_data,
552 c_handler, &c_data,
553 pre_unwind_handler,
554 SCM2PTR (scm_current_error_port ()));
555 return c_data.result;
556 }
557
558 struct scm_data {
559 SCM proc;
560 };
561
562 static SCM
563 scm_body (void *d)
564 {
565 struct scm_data *data = (struct scm_data *)d;
566 return scm_call_0 (data->proc);
567 }
568
569 static SCM
570 scm_handler (void *d, SCM tag, SCM args)
571 {
572 /* Print a message. Note that if TAG is `quit', this will exit() the
573 process. */
574 scm_handle_by_message_noexit (NULL, tag, args);
575
576 return SCM_BOOL_F;
577 }
578
579 SCM_DEFINE (scm_with_continuation_barrier, "with-continuation-barrier", 1,0,0,
580 (SCM proc),
581 "Call @var{proc} and return its result. Do not allow the invocation of\n"
582 "continuations that would leave or enter the dynamic extent of the call\n"
583 "to @code{with-continuation-barrier}. Such an attempt causes an error\n"
584 "to be signaled.\n"
585 "\n"
586 "Throws (such as errors) that are not caught from within @var{proc} are\n"
587 "caught by @code{with-continuation-barrier}. In that case, a short\n"
588 "message is printed to the current error port and @code{#f} is returned.\n"
589 "\n"
590 "Thus, @code{with-continuation-barrier} returns exactly once.\n")
591 #define FUNC_NAME s_scm_with_continuation_barrier
592 {
593 struct scm_data scm_data;
594 scm_data.proc = proc;
595 return scm_i_with_continuation_barrier (scm_body, &scm_data,
596 scm_handler, &scm_data,
597 pre_unwind_handler,
598 SCM2PTR (scm_current_error_port ()));
599 }
600 #undef FUNC_NAME
601
602 void
603 scm_init_continuations ()
604 {
605 tc16_continuation = scm_make_smob_type ("continuation", 0);
606 scm_set_smob_print (tc16_continuation, continuation_print);
607 #include "libguile/continuations.x"
608 }
609
610 /*
611 Local Variables:
612 c-file-style: "gnu"
613 End:
614 */