1 /* Copyright (C) 2001 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
47 #include "vm-bootstrap.h"
49 #include "instructions.h"
52 #include "lang.h" /* NULL_OR_NIL_P */
55 /* I sometimes use this for debugging. */
56 #define vm_puts(OBJ) \
58 scm_display (OBJ, scm_current_error_port ()); \
59 scm_newline (scm_current_error_port ()); \
62 /* The VM has a number of internal assertions that shouldn't normally be
63 necessary, but might be if you think you found a bug in the VM. */
64 #define VM_ENABLE_ASSERTIONS
66 /* We can add a mode that ensures that all stack items above the stack pointer
67 are NULL. This is useful for checking the internal consistency of the VM's
68 assumptions and its operators, but isn't necessary for normal operation. It
69 will ensure that assertions are enabled. Slows down the VM by about 30%. */
70 /* #define VM_ENABLE_STACK_NULLING */
72 #if defined (VM_ENABLE_STACK_NULLING) && !defined (VM_ENABLE_ASSERTIONS)
73 #define VM_ENABLE_ASSERTIONS
81 scm_t_bits scm_tc16_vm_cont
;
84 vm_mark_stack (SCM
*base
, scm_t_ptrdiff size
, SCM
*fp
, scm_t_ptrdiff reloc
)
86 SCM
*sp
, *upper
, *lower
;
89 while (sp
> base
&& fp
)
91 upper
= SCM_FRAME_UPPER_ADDRESS (fp
);
92 lower
= SCM_FRAME_LOWER_ADDRESS (fp
);
94 for (; sp
>= upper
; sp
--)
97 if (scm_in_heap_p (*sp
))
100 fprintf (stderr
, "BADNESS: crap on the stack: %p\n", *sp
);
107 /* update fp from the dynamic link */
108 fp
= (SCM
*)*sp
-- + reloc
;
110 /* mark from the el down to the lower address */
111 for (; sp
>= lower
; sp
--)
112 if (*sp
&& SCM_NIMP (*sp
))
118 vm_cont_mark (SCM obj
)
120 struct scm_vm_cont
*p
= SCM_VM_CONT_DATA (obj
);
123 vm_mark_stack (p
->stack_base
, p
->stack_size
, p
->fp
+ p
->reloc
, p
->reloc
);
129 vm_cont_free (SCM obj
)
131 struct scm_vm_cont
*p
= SCM_VM_CONT_DATA (obj
);
133 scm_gc_free (p
->stack_base
, p
->stack_size
* sizeof (SCM
), "stack-base");
134 scm_gc_free (p
, sizeof (struct scm_vm
), "vm");
140 capture_vm_cont (struct scm_vm
*vp
)
142 struct scm_vm_cont
*p
= scm_gc_malloc (sizeof (*p
), "capture_vm_cont");
143 p
->stack_size
= vp
->sp
- vp
->stack_base
+ 1;
144 p
->stack_base
= scm_gc_malloc (p
->stack_size
* sizeof (SCM
),
146 #ifdef VM_ENABLE_STACK_NULLING
147 if (vp
->sp
>= vp
->stack_base
)
148 if (!vp
->sp
[0] || vp
->sp
[1])
150 memset (p
->stack_base
, 0, p
->stack_size
* sizeof (SCM
));
155 memcpy (p
->stack_base
, vp
->stack_base
, p
->stack_size
* sizeof (SCM
));
156 p
->reloc
= p
->stack_base
- vp
->stack_base
;
157 SCM_RETURN_NEWSMOB (scm_tc16_vm_cont
, p
);
161 reinstate_vm_cont (struct scm_vm
*vp
, SCM cont
)
163 struct scm_vm_cont
*p
= SCM_VM_CONT_DATA (cont
);
164 if (vp
->stack_size
< p
->stack_size
)
166 /* puts ("FIXME: Need to expand"); */
169 #ifdef VM_ENABLE_STACK_NULLING
171 scm_t_ptrdiff nzero
= (vp
->sp
- p
->sp
);
173 memset (vp
->stack_base
+ p
->stack_size
, 0, nzero
* sizeof (SCM
));
174 /* actually nzero should always be negative, because vm_reset_stack will
175 unwind the stack to some point *below* this continuation */
181 memcpy (vp
->stack_base
, p
->stack_base
, p
->stack_size
* sizeof (SCM
));
184 /* In theory, a number of vm instances can be active in the call trace, and we
185 only want to reify the continuations of those in the current continuation
186 root. I don't see a nice way to do this -- ideally it would involve dynwinds,
187 and previous values of the *the-vm* fluid within the current continuation
188 root. But we don't have access to continuation roots in the dynwind stack.
189 So, just punt for now -- take the current value of *the-vm*.
191 While I'm on the topic, ideally we could avoid copying the C stack if the
192 continuation root is inside VM code, and call/cc was invoked within that same
193 call to vm_run; but that's currently not implemented.
196 scm_vm_capture_continuations (void)
198 SCM vm
= scm_the_vm ();
199 return scm_acons (vm
, capture_vm_cont (SCM_VM_DATA (vm
)), SCM_EOL
);
203 scm_vm_reinstate_continuations (SCM conts
)
205 for (; conts
!= SCM_EOL
; conts
= SCM_CDR (conts
))
206 reinstate_vm_cont (SCM_VM_DATA (SCM_CAAR (conts
)), SCM_CDAR (conts
));
209 struct vm_unwind_data
217 vm_reset_stack (void *data
)
219 struct vm_unwind_data
*w
= data
;
220 struct scm_vm
*vp
= w
->vp
;
224 #ifdef VM_ENABLE_STACK_NULLING
225 memset (vp
->sp
+ 1, 0, (vp
->stack_size
- (vp
->sp
+ 1 - vp
->stack_base
)) * sizeof(SCM
));
229 static void enfalsen_frame (void *p
)
231 struct scm_vm
*vp
= p
;
232 vp
->trace_frame
= SCM_BOOL_F
;
236 vm_dispatch_hook (SCM vm
, SCM hook
, SCM hook_args
)
238 struct scm_vm
*vp
= SCM_VM_DATA (vm
);
240 if (!SCM_FALSEP (vp
->trace_frame
))
243 scm_dynwind_begin (0);
244 vp
->trace_frame
= scm_c_make_vm_frame (vm
, vp
->fp
, vp
->sp
, vp
->ip
, 0);
245 scm_dynwind_unwind_handler (enfalsen_frame
, vp
, SCM_F_WIND_EXPLICITLY
);
247 scm_c_run_hook (hook
, hook_args
);
254 * VM Internal functions
257 static SCM sym_vm_run
;
258 static SCM sym_vm_error
;
259 static SCM sym_debug
;
262 vm_fetch_length (scm_byte_t
*ip
, size_t *lenp
)
264 /* NOTE: format defined in system/vm/conv.scm */
268 else if (*lenp
== 254)
272 *lenp
= (b1
<< 8) + b2
;
280 *lenp
= (b1
<< 24) + (b2
<< 16) + (b3
<< 8) + b4
;
286 vm_make_boot_program (long len
)
288 scm_byte_t bytes
[6] = {scm_op_mv_call
, 0, 0, 1, scm_op_make_int8_1
, scm_op_halt
};
289 if (SCM_UNLIKELY (len
> 255 || len
< 0))
291 bytes
[1] = (scm_byte_t
)len
;
292 return scm_c_make_program (bytes
, 6, SCM_BOOL_F
, SCM_BOOL_F
);
300 #define VM_DEFAULT_STACK_SIZE (16 * 1024)
302 #define VM_REGULAR_ENGINE 0
303 #define VM_DEBUG_ENGINE 1
306 #define VM_NAME vm_regular_engine
307 #define VM_ENGINE VM_REGULAR_ENGINE
308 #include "vm-engine.c"
313 #define VM_NAME vm_debug_engine
314 #define VM_ENGINE VM_DEBUG_ENGINE
315 #include "vm-engine.c"
319 scm_t_bits scm_tc16_vm
;
323 #define FUNC_NAME "make_vm"
326 struct scm_vm
*vp
= scm_gc_malloc (sizeof (struct scm_vm
), "vm");
328 vp
->stack_size
= VM_DEFAULT_STACK_SIZE
;
329 vp
->stack_base
= scm_gc_malloc (vp
->stack_size
* sizeof (SCM
),
331 #ifdef VM_ENABLE_STACK_NULLING
332 memset (vp
->stack_base
, 0, vp
->stack_size
* sizeof (SCM
));
334 vp
->stack_limit
= vp
->stack_base
+ vp
->stack_size
- 3;
336 vp
->sp
= vp
->stack_base
- 1;
340 vp
->options
= SCM_EOL
;
341 for (i
= 0; i
< SCM_VM_NUM_HOOKS
; i
++)
342 vp
->hooks
[i
] = SCM_BOOL_F
;
343 vp
->trace_frame
= SCM_BOOL_F
;
344 SCM_RETURN_NEWSMOB (scm_tc16_vm
, vp
);
352 struct scm_vm
*vp
= SCM_VM_DATA (obj
);
354 #ifdef VM_ENABLE_STACK_NULLING
355 if (vp
->sp
>= vp
->stack_base
)
356 if (!vp
->sp
[0] || vp
->sp
[1])
360 /* mark the stack, precisely */
361 vm_mark_stack (vp
->stack_base
, vp
->sp
+ 1 - vp
->stack_base
, vp
->fp
, 0);
363 /* mark other objects */
364 for (i
= 0; i
< SCM_VM_NUM_HOOKS
; i
++)
365 scm_gc_mark (vp
->hooks
[i
]);
367 scm_gc_mark (vp
->trace_frame
);
375 struct scm_vm
*vp
= SCM_VM_DATA (obj
);
377 scm_gc_free (vp
->stack_base
, vp
->stack_size
* sizeof (SCM
),
379 scm_gc_free (vp
, sizeof (struct scm_vm
), "vm");
385 scm_vm_apply (SCM vm
, SCM program
, SCM args
)
386 #define FUNC_NAME "scm_vm_apply"
388 SCM_VALIDATE_PROGRAM (1, program
);
389 return vm_run (vm
, program
, args
);
393 /* Scheme interface */
395 SCM_DEFINE (scm_vm_version
, "vm-version", 0, 0, 0,
398 #define FUNC_NAME s_scm_vm_version
400 return scm_from_locale_string (PACKAGE_VERSION
);
404 SCM_DEFINE (scm_the_vm
, "the-vm", 0, 0, 0,
407 #define FUNC_NAME s_scm_the_vm
409 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
411 if (SCM_UNLIKELY (SCM_FALSEP ((t
->vm
))))
419 SCM_DEFINE (scm_vm_p
, "vm?", 1, 0, 0,
422 #define FUNC_NAME s_scm_vm_p
424 return SCM_BOOL (SCM_VM_P (obj
));
428 SCM_DEFINE (scm_make_vm
, "make-vm", 0, 0, 0,
431 #define FUNC_NAME s_scm_make_vm,
437 SCM_DEFINE (scm_vm_ip
, "vm:ip", 1, 0, 0,
440 #define FUNC_NAME s_scm_vm_ip
442 SCM_VALIDATE_VM (1, vm
);
443 return scm_from_ulong ((unsigned long) SCM_VM_DATA (vm
)->ip
);
447 SCM_DEFINE (scm_vm_sp
, "vm:sp", 1, 0, 0,
450 #define FUNC_NAME s_scm_vm_sp
452 SCM_VALIDATE_VM (1, vm
);
453 return scm_from_ulong ((unsigned long) SCM_VM_DATA (vm
)->sp
);
457 SCM_DEFINE (scm_vm_fp
, "vm:fp", 1, 0, 0,
460 #define FUNC_NAME s_scm_vm_fp
462 SCM_VALIDATE_VM (1, vm
);
463 return scm_from_ulong ((unsigned long) SCM_VM_DATA (vm
)->fp
);
467 #define VM_DEFINE_HOOK(n) \
470 SCM_VALIDATE_VM (1, vm); \
471 vp = SCM_VM_DATA (vm); \
472 if (SCM_FALSEP (vp->hooks[n])) \
473 vp->hooks[n] = scm_make_hook (SCM_I_MAKINUM (1)); \
474 return vp->hooks[n]; \
477 SCM_DEFINE (scm_vm_boot_hook
, "vm-boot-hook", 1, 0, 0,
480 #define FUNC_NAME s_scm_vm_boot_hook
482 VM_DEFINE_HOOK (SCM_VM_BOOT_HOOK
);
486 SCM_DEFINE (scm_vm_halt_hook
, "vm-halt-hook", 1, 0, 0,
489 #define FUNC_NAME s_scm_vm_halt_hook
491 VM_DEFINE_HOOK (SCM_VM_HALT_HOOK
);
495 SCM_DEFINE (scm_vm_next_hook
, "vm-next-hook", 1, 0, 0,
498 #define FUNC_NAME s_scm_vm_next_hook
500 VM_DEFINE_HOOK (SCM_VM_NEXT_HOOK
);
504 SCM_DEFINE (scm_vm_break_hook
, "vm-break-hook", 1, 0, 0,
507 #define FUNC_NAME s_scm_vm_break_hook
509 VM_DEFINE_HOOK (SCM_VM_BREAK_HOOK
);
513 SCM_DEFINE (scm_vm_enter_hook
, "vm-enter-hook", 1, 0, 0,
516 #define FUNC_NAME s_scm_vm_enter_hook
518 VM_DEFINE_HOOK (SCM_VM_ENTER_HOOK
);
522 SCM_DEFINE (scm_vm_apply_hook
, "vm-apply-hook", 1, 0, 0,
525 #define FUNC_NAME s_scm_vm_apply_hook
527 VM_DEFINE_HOOK (SCM_VM_APPLY_HOOK
);
531 SCM_DEFINE (scm_vm_exit_hook
, "vm-exit-hook", 1, 0, 0,
534 #define FUNC_NAME s_scm_vm_exit_hook
536 VM_DEFINE_HOOK (SCM_VM_EXIT_HOOK
);
540 SCM_DEFINE (scm_vm_return_hook
, "vm-return-hook", 1, 0, 0,
543 #define FUNC_NAME s_scm_vm_return_hook
545 VM_DEFINE_HOOK (SCM_VM_RETURN_HOOK
);
549 SCM_DEFINE (scm_vm_option
, "vm-option", 2, 0, 0,
552 #define FUNC_NAME s_scm_vm_option
554 SCM_VALIDATE_VM (1, vm
);
555 return scm_assq_ref (SCM_VM_DATA (vm
)->options
, key
);
559 SCM_DEFINE (scm_set_vm_option_x
, "set-vm-option!", 3, 0, 0,
560 (SCM vm
, SCM key
, SCM val
),
562 #define FUNC_NAME s_scm_set_vm_option_x
564 SCM_VALIDATE_VM (1, vm
);
565 SCM_VM_DATA (vm
)->options
566 = scm_assq_set_x (SCM_VM_DATA (vm
)->options
, key
, val
);
567 return SCM_UNSPECIFIED
;
571 SCM_DEFINE (scm_vm_stats
, "vm-stats", 1, 0, 0,
574 #define FUNC_NAME s_scm_vm_stats
578 SCM_VALIDATE_VM (1, vm
);
580 stats
= scm_make_vector (SCM_I_MAKINUM (2), SCM_UNSPECIFIED
);
581 scm_vector_set_x (stats
, SCM_I_MAKINUM (0),
582 scm_from_ulong (SCM_VM_DATA (vm
)->time
));
583 scm_vector_set_x (stats
, SCM_I_MAKINUM (1),
584 scm_from_ulong (SCM_VM_DATA (vm
)->clock
));
590 SCM_DEFINE (scm_vm_trace_frame
, "vm-trace-frame", 1, 0, 0,
593 #define FUNC_NAME s_scm_vm_trace_frame
595 SCM_VALIDATE_VM (1, vm
);
596 return SCM_VM_DATA (vm
)->trace_frame
;
605 SCM
scm_load_compiled_with_vm (SCM file
)
607 SCM program
= scm_objcode_to_program (scm_load_objcode (file
), SCM_EOL
);
609 return vm_run (scm_the_vm (), program
, SCM_EOL
);
613 scm_bootstrap_vm (void)
615 static int strappage
= 0;
620 scm_bootstrap_frames ();
621 scm_bootstrap_instructions ();
622 scm_bootstrap_objcodes ();
623 scm_bootstrap_programs ();
625 scm_tc16_vm_cont
= scm_make_smob_type ("vm-cont", 0);
626 scm_set_smob_mark (scm_tc16_vm_cont
, vm_cont_mark
);
627 scm_set_smob_free (scm_tc16_vm_cont
, vm_cont_free
);
629 scm_tc16_vm
= scm_make_smob_type ("vm", 0);
630 scm_set_smob_mark (scm_tc16_vm
, vm_mark
);
631 scm_set_smob_free (scm_tc16_vm
, vm_free
);
632 scm_set_smob_apply (scm_tc16_vm
, scm_vm_apply
, 1, 0, 1);
634 scm_c_define ("load-compiled",
635 scm_c_make_gsubr ("load-compiled/vm", 1, 0, 0,
636 scm_load_compiled_with_vm
));
638 sym_vm_run
= scm_permanent_object (scm_from_locale_symbol ("vm-run"));
639 sym_vm_error
= scm_permanent_object (scm_from_locale_symbol ("vm-error"));
640 sym_debug
= scm_permanent_object (scm_from_locale_symbol ("debug"));
650 #ifndef SCM_MAGIC_SNARFER