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"
54 /* I sometimes use this for debugging. */
55 #define vm_puts(OBJ) \
57 scm_display (OBJ, scm_current_error_port ()); \
58 scm_newline (scm_current_error_port ()); \
61 /* The VM has a number of internal assertions that shouldn't normally be
62 necessary, but might be if you think you found a bug in the VM. */
63 #define VM_ENABLE_ASSERTIONS
65 /* We can add a mode that ensures that all stack items above the stack pointer
66 are NULL. This is useful for checking the internal consistency of the VM's
67 assumptions and its operators, but isn't necessary for normal operation. It
68 will ensure that assertions are enabled. */
69 #define VM_ENABLE_STACK_NULLING
71 #if defined (VM_ENABLE_STACK_NULLING) && !defined (VM_ENABLE_ASSERTIONS)
72 #define VM_ENABLE_ASSERTIONS
80 scm_t_bits scm_tc16_vm_cont
;
83 vm_mark_stack (SCM
*base
, scm_t_ptrdiff size
, SCM
*fp
, scm_t_ptrdiff reloc
)
85 SCM
*sp
, *upper
, *lower
;
88 while (sp
> base
&& fp
)
90 upper
= SCM_FRAME_UPPER_ADDRESS (fp
);
91 lower
= SCM_FRAME_LOWER_ADDRESS (fp
);
93 for (; sp
>= upper
; sp
--)
96 if (scm_in_heap_p (*sp
))
99 fprintf (stderr
, "BADNESS: crap on the stack: %p\n", *sp
);
106 /* update fp from the dynamic link */
107 fp
= (SCM
*)*sp
-- + reloc
;
109 /* mark from the el down to the lower address */
110 for (; sp
>= lower
; sp
--)
111 if (*sp
&& SCM_NIMP (*sp
))
117 vm_cont_mark (SCM obj
)
119 struct scm_vm_cont
*p
= SCM_VM_CONT_DATA (obj
);
121 vm_mark_stack (p
->stack_base
, p
->stack_size
, p
->stack_base
+ p
->fp
, p
->reloc
);
127 vm_cont_free (SCM obj
)
129 struct scm_vm_cont
*p
= SCM_VM_CONT_DATA (obj
);
131 scm_gc_free (p
->stack_base
, p
->stack_size
* sizeof (SCM
), "stack-base");
132 scm_gc_free (p
, sizeof (struct scm_vm
), "vm");
138 capture_vm_cont (struct scm_vm
*vp
)
140 struct scm_vm_cont
*p
= scm_gc_malloc (sizeof (*p
), "capture_vm_cont");
141 p
->stack_size
= vp
->sp
- vp
->stack_base
+ 1;
142 p
->stack_base
= scm_gc_malloc (p
->stack_size
* sizeof (SCM
),
144 #ifdef VM_ENABLE_STACK_NULLING
145 if (vp
->sp
>= vp
->stack_base
)
146 if (!vp
->sp
[0] || vp
->sp
[1])
148 memset (p
->stack_base
, 0, p
->stack_size
* sizeof (SCM
));
151 p
->sp
= vp
->sp
- vp
->stack_base
;
152 p
->fp
= vp
->fp
- vp
->stack_base
;
153 memcpy (p
->stack_base
, vp
->stack_base
, p
->stack_size
* sizeof (SCM
));
154 p
->reloc
= p
->stack_base
- vp
->stack_base
;
155 SCM_RETURN_NEWSMOB (scm_tc16_vm_cont
, p
);
159 reinstate_vm_cont (struct scm_vm
*vp
, SCM cont
)
161 struct scm_vm_cont
*p
= SCM_VM_CONT_DATA (cont
);
162 if (vp
->stack_size
< p
->stack_size
)
164 /* puts ("FIXME: Need to expand"); */
167 #ifdef VM_ENABLE_STACK_NULLING
169 scm_t_ptrdiff nzero
= (vp
->sp
- vp
->stack_base
) - p
->sp
;
171 memset (vp
->stack_base
+ p
->stack_size
, 0, nzero
* sizeof (SCM
));
172 /* actually nzero should always be negative, because vm_reset_stack will
173 unwind the stack to some point *below* this continuation */
177 vp
->sp
= vp
->stack_base
+ p
->sp
;
178 vp
->fp
= vp
->stack_base
+ p
->fp
;
179 memcpy (vp
->stack_base
, p
->stack_base
, p
->stack_size
* sizeof (SCM
));
182 /* In theory, a number of vm instances can be active in the call trace, and we
183 only want to reify the continuations of those in the current continuation
184 root. I don't see a nice way to do this -- ideally it would involve dynwinds,
185 and previous values of the *the-vm* fluid within the current continuation
186 root. But we don't have access to continuation roots in the dynwind stack.
187 So, just punt for now -- take the current value of *the-vm*.
189 While I'm on the topic, ideally we could avoid copying the C stack if the
190 continuation root is inside VM code, and call/cc was invoked within that same
191 call to vm_run; but that's currently not implemented.
194 scm_vm_capture_continuations (void)
196 SCM vm
= scm_the_vm ();
197 return scm_acons (vm
, capture_vm_cont (SCM_VM_DATA (vm
)), SCM_EOL
);
201 scm_vm_reinstate_continuations (SCM conts
)
203 for (; conts
!= SCM_EOL
; conts
= SCM_CDR (conts
))
204 reinstate_vm_cont (SCM_VM_DATA (SCM_CAAR (conts
)), SCM_CDAR (conts
));
207 struct vm_unwind_data
215 vm_reset_stack (void *data
)
217 struct vm_unwind_data
*w
= data
;
218 struct scm_vm
*vp
= w
->vp
;
222 #ifdef VM_ENABLE_STACK_NULLING
223 memset (vp
->sp
+ 1, 0, (vp
->stack_size
- (vp
->sp
+ 1 - vp
->stack_base
)) * sizeof(SCM
));
227 static void enfalsen_frame (void *p
)
229 struct scm_vm
*vp
= p
;
230 vp
->trace_frame
= SCM_BOOL_F
;
234 vm_dispatch_hook (SCM vm
, SCM hook
, SCM hook_args
)
236 struct scm_vm
*vp
= SCM_VM_DATA (vm
);
238 if (!SCM_FALSEP (vp
->trace_frame
))
241 scm_dynwind_begin (0);
242 vp
->trace_frame
= scm_c_make_vm_frame (vm
, vp
->fp
, vp
->sp
, vp
->ip
, 0);
243 scm_dynwind_unwind_handler (enfalsen_frame
, vp
, SCM_F_WIND_EXPLICITLY
);
245 scm_c_run_hook (hook
, hook_args
);
252 * VM Internal functions
255 static SCM sym_vm_run
;
256 static SCM sym_vm_error
;
257 static SCM sym_debug
;
260 vm_fetch_length (scm_byte_t
*ip
, size_t *lenp
)
262 /* NOTE: format defined in system/vm/conv.scm */
266 else if (*lenp
== 254)
270 *lenp
= (b1
<< 8) + b2
;
278 *lenp
= (b1
<< 24) + (b2
<< 16) + (b3
<< 8) + b4
;
288 #define VM_DEFAULT_STACK_SIZE (16 * 1024)
290 #define VM_REGULAR_ENGINE 0
291 #define VM_DEBUG_ENGINE 1
294 #define VM_NAME vm_regular_engine
295 #define VM_ENGINE VM_REGULAR_ENGINE
296 #include "vm-engine.c"
301 #define VM_NAME vm_debug_engine
302 #define VM_ENGINE VM_DEBUG_ENGINE
303 #include "vm-engine.c"
307 scm_t_bits scm_tc16_vm
;
311 #define FUNC_NAME "make_vm"
314 struct scm_vm
*vp
= scm_gc_malloc (sizeof (struct scm_vm
), "vm");
316 vp
->stack_size
= VM_DEFAULT_STACK_SIZE
;
317 vp
->stack_base
= scm_gc_malloc (vp
->stack_size
* sizeof (SCM
),
319 #ifdef VM_ENABLE_STACK_NULLING
320 memset (vp
->stack_base
, 0, vp
->stack_size
* sizeof (SCM
));
322 vp
->stack_limit
= vp
->stack_base
+ vp
->stack_size
- 3;
324 vp
->sp
= vp
->stack_base
- 1;
328 vp
->options
= SCM_EOL
;
329 for (i
= 0; i
< SCM_VM_NUM_HOOKS
; i
++)
330 vp
->hooks
[i
] = SCM_BOOL_F
;
331 vp
->trace_frame
= SCM_BOOL_F
;
332 SCM_RETURN_NEWSMOB (scm_tc16_vm
, vp
);
340 struct scm_vm
*vp
= SCM_VM_DATA (obj
);
342 #ifdef VM_ENABLE_STACK_NULLING
343 if (vp
->sp
>= vp
->stack_base
)
344 if (!vp
->sp
[0] || vp
->sp
[1])
348 /* mark the stack, precisely */
349 vm_mark_stack (vp
->stack_base
, vp
->sp
+ 1 - vp
->stack_base
, vp
->fp
, 0);
351 /* mark other objects */
352 for (i
= 0; i
< SCM_VM_NUM_HOOKS
; i
++)
353 scm_gc_mark (vp
->hooks
[i
]);
355 scm_gc_mark (vp
->trace_frame
);
363 struct scm_vm
*vp
= SCM_VM_DATA (obj
);
365 scm_gc_free (vp
->stack_base
, vp
->stack_size
* sizeof (SCM
),
367 scm_gc_free (vp
, sizeof (struct scm_vm
), "vm");
373 scm_vm_apply (SCM vm
, SCM program
, SCM args
)
374 #define FUNC_NAME "scm_vm_apply"
376 SCM_VALIDATE_PROGRAM (1, program
);
377 return vm_run (vm
, program
, args
);
381 /* Scheme interface */
383 SCM_DEFINE (scm_vm_version
, "vm-version", 0, 0, 0,
386 #define FUNC_NAME s_scm_vm_version
388 return scm_from_locale_string (PACKAGE_VERSION
);
392 SCM_DEFINE (scm_the_vm
, "the-vm", 0, 0, 0,
395 #define FUNC_NAME s_scm_the_vm
397 scm_i_thread
*t
= SCM_I_CURRENT_THREAD
;
399 if (SCM_UNLIKELY (SCM_FALSEP ((t
->vm
))))
407 SCM_DEFINE (scm_vm_p
, "vm?", 1, 0, 0,
410 #define FUNC_NAME s_scm_vm_p
412 return SCM_BOOL (SCM_VM_P (obj
));
416 SCM_DEFINE (scm_make_vm
, "make-vm", 0, 0, 0,
419 #define FUNC_NAME s_scm_make_vm,
425 SCM_DEFINE (scm_vm_ip
, "vm:ip", 1, 0, 0,
428 #define FUNC_NAME s_scm_vm_ip
430 SCM_VALIDATE_VM (1, vm
);
431 return scm_from_ulong ((unsigned long) SCM_VM_DATA (vm
)->ip
);
435 SCM_DEFINE (scm_vm_sp
, "vm:sp", 1, 0, 0,
438 #define FUNC_NAME s_scm_vm_sp
440 SCM_VALIDATE_VM (1, vm
);
441 return scm_from_ulong ((unsigned long) SCM_VM_DATA (vm
)->sp
);
445 SCM_DEFINE (scm_vm_fp
, "vm:fp", 1, 0, 0,
448 #define FUNC_NAME s_scm_vm_fp
450 SCM_VALIDATE_VM (1, vm
);
451 return scm_from_ulong ((unsigned long) SCM_VM_DATA (vm
)->fp
);
455 #define VM_DEFINE_HOOK(n) \
458 SCM_VALIDATE_VM (1, vm); \
459 vp = SCM_VM_DATA (vm); \
460 if (SCM_FALSEP (vp->hooks[n])) \
461 vp->hooks[n] = scm_make_hook (SCM_I_MAKINUM (1)); \
462 return vp->hooks[n]; \
465 SCM_DEFINE (scm_vm_boot_hook
, "vm-boot-hook", 1, 0, 0,
468 #define FUNC_NAME s_scm_vm_boot_hook
470 VM_DEFINE_HOOK (SCM_VM_BOOT_HOOK
);
474 SCM_DEFINE (scm_vm_halt_hook
, "vm-halt-hook", 1, 0, 0,
477 #define FUNC_NAME s_scm_vm_halt_hook
479 VM_DEFINE_HOOK (SCM_VM_HALT_HOOK
);
483 SCM_DEFINE (scm_vm_next_hook
, "vm-next-hook", 1, 0, 0,
486 #define FUNC_NAME s_scm_vm_next_hook
488 VM_DEFINE_HOOK (SCM_VM_NEXT_HOOK
);
492 SCM_DEFINE (scm_vm_break_hook
, "vm-break-hook", 1, 0, 0,
495 #define FUNC_NAME s_scm_vm_break_hook
497 VM_DEFINE_HOOK (SCM_VM_BREAK_HOOK
);
501 SCM_DEFINE (scm_vm_enter_hook
, "vm-enter-hook", 1, 0, 0,
504 #define FUNC_NAME s_scm_vm_enter_hook
506 VM_DEFINE_HOOK (SCM_VM_ENTER_HOOK
);
510 SCM_DEFINE (scm_vm_apply_hook
, "vm-apply-hook", 1, 0, 0,
513 #define FUNC_NAME s_scm_vm_apply_hook
515 VM_DEFINE_HOOK (SCM_VM_APPLY_HOOK
);
519 SCM_DEFINE (scm_vm_exit_hook
, "vm-exit-hook", 1, 0, 0,
522 #define FUNC_NAME s_scm_vm_exit_hook
524 VM_DEFINE_HOOK (SCM_VM_EXIT_HOOK
);
528 SCM_DEFINE (scm_vm_return_hook
, "vm-return-hook", 1, 0, 0,
531 #define FUNC_NAME s_scm_vm_return_hook
533 VM_DEFINE_HOOK (SCM_VM_RETURN_HOOK
);
537 SCM_DEFINE (scm_vm_option
, "vm-option", 2, 0, 0,
540 #define FUNC_NAME s_scm_vm_option
542 SCM_VALIDATE_VM (1, vm
);
543 return scm_assq_ref (SCM_VM_DATA (vm
)->options
, key
);
547 SCM_DEFINE (scm_set_vm_option_x
, "set-vm-option!", 3, 0, 0,
548 (SCM vm
, SCM key
, SCM val
),
550 #define FUNC_NAME s_scm_set_vm_option_x
552 SCM_VALIDATE_VM (1, vm
);
553 SCM_VM_DATA (vm
)->options
554 = scm_assq_set_x (SCM_VM_DATA (vm
)->options
, key
, val
);
555 return SCM_UNSPECIFIED
;
559 SCM_DEFINE (scm_vm_stats
, "vm-stats", 1, 0, 0,
562 #define FUNC_NAME s_scm_vm_stats
566 SCM_VALIDATE_VM (1, vm
);
568 stats
= scm_make_vector (SCM_I_MAKINUM (2), SCM_UNSPECIFIED
);
569 scm_vector_set_x (stats
, SCM_I_MAKINUM (0),
570 scm_from_ulong (SCM_VM_DATA (vm
)->time
));
571 scm_vector_set_x (stats
, SCM_I_MAKINUM (1),
572 scm_from_ulong (SCM_VM_DATA (vm
)->clock
));
578 SCM_DEFINE (scm_vm_trace_frame
, "vm-trace-frame", 1, 0, 0,
581 #define FUNC_NAME s_scm_vm_trace_frame
583 SCM_VALIDATE_VM (1, vm
);
584 return SCM_VM_DATA (vm
)->trace_frame
;
593 SCM
scm_load_compiled_with_vm (SCM file
)
595 SCM program
= scm_objcode_to_program (scm_load_objcode (file
), SCM_EOL
);
597 return vm_run (scm_the_vm (), program
, SCM_EOL
);
601 scm_bootstrap_vm (void)
603 static int strappage
= 0;
608 scm_bootstrap_frames ();
609 scm_bootstrap_instructions ();
610 scm_bootstrap_objcodes ();
611 scm_bootstrap_programs ();
613 scm_tc16_vm_cont
= scm_make_smob_type ("vm-cont", 0);
614 scm_set_smob_mark (scm_tc16_vm_cont
, vm_cont_mark
);
615 scm_set_smob_free (scm_tc16_vm_cont
, vm_cont_free
);
617 scm_tc16_vm
= scm_make_smob_type ("vm", 0);
618 scm_set_smob_mark (scm_tc16_vm
, vm_mark
);
619 scm_set_smob_free (scm_tc16_vm
, vm_free
);
620 scm_set_smob_apply (scm_tc16_vm
, scm_vm_apply
, 1, 0, 1);
622 scm_c_define ("load-compiled",
623 scm_c_make_gsubr ("load-compiled/vm", 1, 0, 0,
624 scm_load_compiled_with_vm
));
626 sym_vm_run
= scm_permanent_object (scm_from_locale_symbol ("vm-run"));
627 sym_vm_error
= scm_permanent_object (scm_from_locale_symbol ("vm-error"));
628 sym_debug
= scm_permanent_object (scm_from_locale_symbol ("debug"));
638 #ifndef SCM_MAGIC_SNARFER