[bpt/guile.git] / src / vm.c

/* Copyright (C) 2001 Free Software Foundation, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this software; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA
 *
 * As a special exception, the Free Software Foundation gives permission
 * for additional uses of the text contained in its release of GUILE.
 *
 * The exception is that, if you link the GUILE library with other files
 * to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * Your use of that executable is in no way restricted on account of
 * linking the GUILE library code into it.
 *
 * This exception does not however invalidate any other reasons why
 * the executable file might be covered by the GNU General Public License.
 *
 * This exception applies only to the code released by the
 * Free Software Foundation under the name GUILE.  If you copy
 * code from other Free Software Foundation releases into a copy of
 * GUILE, as the General Public License permits, the exception does
 * not apply to the code that you add in this way.  To avoid misleading
 * anyone as to the status of such modified files, you must delete
 * this exception notice from them.
 *
 * If you write modifications of your own for GUILE, it is your choice
 * whether to permit this exception to apply to your modifications.
 * If you do not wish that, delete this exception notice.  */

#include <string.h>
#include "envs.h"
#include "frames.h"
#include "instructions.h"
#include "objcodes.h"
#include "programs.h"
#include "vm.h"

/* I sometimes use this for debugging. */
#define vm_puts(OBJ)				\
{						\
  scm_display (OBJ, scm_def_errp);		\
  scm_newline (scm_def_errp);			\
}

\f
/*
 * VM Continuation
 */

scm_t_bits scm_tc16_vm_cont;


#define SCM_VM_CONT_P(OBJ)	SCM_SMOB_PREDICATE (scm_tc16_vm_cont, OBJ)
#define SCM_VM_CONT_VP(CONT)	((struct scm_vm *) SCM_CELL_WORD_1 (CONT))

static SCM
capture_vm_cont (struct scm_vm *vp)
{
  struct scm_vm *p = scm_gc_malloc (sizeof (*p), "capture_vm_cont");
  p->stack_size = vp->stack_limit - vp->sp;
  p->stack_base = scm_gc_malloc (p->stack_size * sizeof (SCM),
				 "capture_vm_cont");
  p->stack_limit = p->stack_base + p->stack_size - 2;
  p->ip = vp->ip;
  p->sp = (SCM *) (vp->stack_limit - vp->sp);
  p->fp = (SCM *) (vp->stack_limit - vp->fp);
  memcpy (p->stack_base, vp->sp + 1, vp->stack_size * sizeof (SCM));
  SCM_RETURN_NEWSMOB (scm_tc16_vm_cont, p);
}

static void
reinstate_vm_cont (struct scm_vm *vp, SCM cont)
{
  struct scm_vm *p = SCM_VM_CONT_VP (cont);
  if (vp->stack_size < p->stack_size)
    {
      /* puts ("FIXME: Need to expand"); */
      abort ();
    }
  vp->ip = p->ip;
  vp->sp = vp->stack_limit - (int) p->sp;
  vp->fp = vp->stack_limit - (int) p->fp;
  memcpy (vp->sp + 1, p->stack_base, p->stack_size * sizeof (SCM));
}

static SCM
vm_cont_mark (SCM obj)
{
  SCM *p;
  struct scm_vm *vp = SCM_VM_CONT_VP (obj);
  for (p = vp->stack_base; p <= vp->stack_limit; p++)
    if (SCM_NIMP (*p))
      scm_gc_mark (*p);
  return SCM_BOOL_F;
}

static scm_sizet
vm_cont_free (SCM obj)
{
  struct scm_vm *p = SCM_VM_CONT_VP (obj);

  scm_gc_free (p->stack_base, p->stack_size * sizeof (SCM), "stack-base");
  scm_gc_free (p, sizeof (struct scm_vm), "vm");

  return 0;
}

\f
/*
 * VM Internal functions
 */

SCM_SYMBOL (sym_vm_run, "vm-run");
SCM_SYMBOL (sym_vm_error, "vm-error");

static scm_byte_t *
vm_fetch_length (scm_byte_t *ip, size_t *lenp)
{
  /* NOTE: format defined in system/vm/conv.scm */
  *lenp = *ip++;
  if (*lenp < 254)
    return ip;
  else if (*lenp == 254)
    {
      int b1 = *ip++;
      int b2 = *ip++;
      *lenp = (b1 << 8) + b2;
    }
  else
    {
      int b1 = *ip++;
      int b2 = *ip++;
      int b3 = *ip++;
      int b4 = *ip++;
      *lenp = (b1 << 24) + (b2 << 16) + (b3 << 8) + b4;
    }
  return ip;
}

static SCM
vm_heapify_frames_1 (struct scm_vm *vp, SCM *fp, SCM *sp, SCM **destp)
{
  SCM frame;
  SCM *dl = SCM_FRAME_DYNAMIC_LINK (fp);
  SCM *src = SCM_FRAME_UPPER_ADDRESS (fp);
  SCM *dest = SCM_FRAME_LOWER_ADDRESS (fp);

  if (!dl)
    {
      /* The top frame */
      frame = scm_c_make_heap_frame (fp);
      fp = SCM_HEAP_FRAME_POINTER (frame);
      SCM_FRAME_HEAP_LINK (fp) = SCM_BOOL_T;
    }
  else
    {
      /* Child frames */
      SCM link = SCM_FRAME_HEAP_LINK (dl);
      if (!SCM_FALSEP (link))
	link = SCM_FRAME_LOWER_ADDRESS (dl)[-1]; /* self link */
      else
	link = vm_heapify_frames_1 (vp, dl, dest - 1, &dest);
      frame = scm_c_make_heap_frame (fp);
      fp = SCM_HEAP_FRAME_POINTER (frame);
      SCM_FRAME_HEAP_LINK (fp)    = link;
      SCM_FRAME_DYNAMIC_LINK (fp) = SCM_HEAP_FRAME_POINTER (link);
    }

  /* Move stack data */
  for (; src <= sp; src++, dest++)
    *dest = *src;
  *destp = dest;

  return frame;
}

static SCM
vm_heapify_frames (SCM vm)
{
  struct scm_vm *vp = SCM_VM_DATA (vm);
  if (SCM_FALSEP (SCM_FRAME_HEAP_LINK (vp->fp)))
    {
      SCM *dest;
      vp->this_frame = vm_heapify_frames_1 (vp, vp->fp, vp->sp, &dest);
      vp->fp = SCM_HEAP_FRAME_POINTER (vp->this_frame);
      vp->sp = dest - 1;
    }
  return vp->this_frame;
}

\f
/*
 * VM
 */

#define VM_DEFAULT_STACK_SIZE	(16 * 1024)

#define VM_REGULAR_ENGINE	0
#define VM_DEBUG_ENGINE		1

#if 0
#define VM_NAME   vm_regular_engine
#define VM_ENGINE VM_REGULAR_ENGINE
#include "vm_engine.c"
#undef VM_NAME
#undef VM_ENGINE
#endif

#define VM_NAME	  vm_debug_engine
#define VM_ENGINE VM_DEBUG_ENGINE
#include "vm_engine.c"
#undef VM_NAME
#undef VM_ENGINE

scm_t_bits scm_tc16_vm;

static SCM the_vm;

static SCM
make_vm (void)
#define FUNC_NAME "make_vm"
{
  int i;
  struct scm_vm *vp = scm_gc_malloc (sizeof (struct scm_vm), "vm");

  vp->stack_size  = VM_DEFAULT_STACK_SIZE;
  vp->stack_base  = scm_gc_malloc (vp->stack_size * sizeof (SCM),
				   "stack-base");
  vp->stack_limit = vp->stack_base + vp->stack_size - 3;
  vp->ip    	  = NULL;
  vp->sp    	  = vp->stack_base - 1;
  vp->fp    	  = NULL;
  vp->time        = 0;
  vp->clock       = 0;
  vp->options     = SCM_EOL;
  vp->this_frame  = SCM_BOOL_F;
  vp->last_frame  = SCM_BOOL_F;
  for (i = 0; i < SCM_VM_NUM_HOOKS; i++)
    vp->hooks[i] = SCM_BOOL_F;
  SCM_RETURN_NEWSMOB (scm_tc16_vm, vp);
}
#undef FUNC_NAME

static SCM
vm_mark (SCM obj)
{
  int i;
  struct scm_vm *vp = SCM_VM_DATA (obj);

  /* mark the stack conservatively */
  scm_mark_locations ((SCM_STACKITEM *) vp->stack_base,
		      sizeof (SCM) * (vp->sp - vp->stack_base + 1));

  /* mark other objects  */
  for (i = 0; i < SCM_VM_NUM_HOOKS; i++)
    scm_gc_mark (vp->hooks[i]);
  scm_gc_mark (vp->this_frame);
  scm_gc_mark (vp->last_frame);
  return vp->options;
}

static scm_sizet
vm_free (SCM obj)
{
  struct scm_vm *vp = SCM_VM_DATA (obj);

  scm_gc_free (vp->stack_base, vp->stack_size * sizeof (SCM),
	       "stack-base");
  scm_gc_free (vp, sizeof (struct scm_vm), "vm");

  return 0;
}

SCM_SYMBOL (sym_debug, "debug");

SCM
scm_vm_apply (SCM vm, SCM program, SCM args)
#define FUNC_NAME "scm_vm_apply"
{
  SCM_VALIDATE_PROGRAM (1, program);
  return vm_run (vm, program, args);
}
#undef FUNC_NAME

/* Scheme interface */

SCM_DEFINE (scm_vm_version, "vm-version", 0, 0, 0,
	    (void),
	    "")
#define FUNC_NAME s_scm_vm_version
{
  return scm_from_locale_string (VERSION);
}
#undef FUNC_NAME

SCM_DEFINE (scm_the_vm, "the-vm", 0, 0, 0,
	    (),
	    "")
#define FUNC_NAME s_scm_the_vm
{
  return the_vm;
}
#undef FUNC_NAME


SCM_DEFINE (scm_vm_p, "vm?", 1, 0, 0,
	    (SCM obj),
	    "")
#define FUNC_NAME s_scm_vm_p
{
  return SCM_BOOL (SCM_VM_P (obj));
}
#undef FUNC_NAME

SCM_DEFINE (scm_make_vm, "make-vm", 0, 0, 0,
	    (void),
	    "")
#define FUNC_NAME s_scm_make_vm,
{
  return make_vm ();
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_ip, "vm:ip", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_ip
{
  SCM_VALIDATE_VM (1, vm);
  return scm_ulong2num ((unsigned long) SCM_VM_DATA (vm)->ip);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_sp, "vm:sp", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_sp
{
  SCM_VALIDATE_VM (1, vm);
  return scm_ulong2num ((unsigned long) SCM_VM_DATA (vm)->sp);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_fp, "vm:fp", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_fp
{
  SCM_VALIDATE_VM (1, vm);
  return scm_ulong2num ((unsigned long) SCM_VM_DATA (vm)->fp);
}
#undef FUNC_NAME

#define VM_DEFINE_HOOK(n)				\
{							\
  struct scm_vm *vp;					\
  SCM_VALIDATE_VM (1, vm);				\
  vp = SCM_VM_DATA (vm);				\
  if (SCM_FALSEP (vp->hooks[n]))			\
    vp->hooks[n] = scm_make_hook (SCM_MAKINUM (1));	\
  return vp->hooks[n];					\
}

SCM_DEFINE (scm_vm_boot_hook, "vm-boot-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_boot_hook
{
  VM_DEFINE_HOOK (SCM_VM_BOOT_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_halt_hook, "vm-halt-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_halt_hook
{
  VM_DEFINE_HOOK (SCM_VM_HALT_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_next_hook, "vm-next-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_next_hook
{
  VM_DEFINE_HOOK (SCM_VM_NEXT_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_break_hook, "vm-break-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_break_hook
{
  VM_DEFINE_HOOK (SCM_VM_BREAK_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_enter_hook, "vm-enter-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_enter_hook
{
  VM_DEFINE_HOOK (SCM_VM_ENTER_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_apply_hook, "vm-apply-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_apply_hook
{
  VM_DEFINE_HOOK (SCM_VM_APPLY_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_exit_hook, "vm-exit-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_exit_hook
{
  VM_DEFINE_HOOK (SCM_VM_EXIT_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_return_hook, "vm-return-hook", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_return_hook
{
  VM_DEFINE_HOOK (SCM_VM_RETURN_HOOK);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_option, "vm-option", 2, 0, 0,
	    (SCM vm, SCM key),
	    "")
#define FUNC_NAME s_scm_vm_option
{
  SCM_VALIDATE_VM (1, vm);
  return scm_assq_ref (SCM_VM_DATA (vm)->options, key);
}
#undef FUNC_NAME

SCM_DEFINE (scm_set_vm_option_x, "set-vm-option!", 3, 0, 0,
	    (SCM vm, SCM key, SCM val),
	    "")
#define FUNC_NAME s_scm_set_vm_option_x
{
  SCM_VALIDATE_VM (1, vm);
  SCM_VM_DATA (vm)->options
    = scm_assq_set_x (SCM_VM_DATA (vm)->options, key, val);
  return SCM_UNSPECIFIED;
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_stats, "vm-stats", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_stats
{
  SCM stats;

  SCM_VALIDATE_VM (1, vm);

  stats = scm_make_vector (scm_from_int (2), SCM_UNSPECIFIED);
  scm_vector_set_x (stats, scm_from_int (0),
		    scm_from_ulong (SCM_VM_DATA (vm)->time));
  scm_vector_set_x (stats, scm_from_int (1),
		    scm_from_ulong (SCM_VM_DATA (vm)->clock));

  return stats;
}
#undef FUNC_NAME

#define VM_CHECK_RUNNING(vm) 				\
  if (!SCM_VM_DATA (vm)->ip)				\
    SCM_MISC_ERROR ("Not running", SCM_LIST1 (vm))

SCM_DEFINE (scm_vm_this_frame, "vm-this-frame", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_this_frame
{
  SCM_VALIDATE_VM (1, vm);
  return SCM_VM_DATA (vm)->this_frame;
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_last_frame, "vm-last-frame", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_last_frame
{
  SCM_VALIDATE_VM (1, vm);
  return SCM_VM_DATA (vm)->last_frame;
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_fetch_code, "vm-fetch-code", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_fetch_code
{
  int i;
  SCM list;
  scm_byte_t *ip;
  struct scm_instruction *p;

  SCM_VALIDATE_VM (1, vm);
  VM_CHECK_RUNNING (vm);

  ip = SCM_VM_DATA (vm)->ip;
  p = SCM_INSTRUCTION (*ip);

  list = SCM_LIST1 (scm_str2symbol (p->name));
  for (i = 1; i <= p->len; i++)
    list = scm_cons (SCM_MAKINUM (ip[i]), list);
  return scm_reverse_x (list, SCM_EOL);
}
#undef FUNC_NAME

SCM_DEFINE (scm_vm_fetch_stack, "vm-fetch-stack", 1, 0, 0,
	    (SCM vm),
	    "")
#define FUNC_NAME s_scm_vm_fetch_stack
{
  SCM *sp;
  SCM ls = SCM_EOL;
  struct scm_vm *vp;

  SCM_VALIDATE_VM (1, vm);
  VM_CHECK_RUNNING (vm);

  vp = SCM_VM_DATA (vm);
  for (sp = vp->stack_base; sp <= vp->sp; sp++)
    ls = scm_cons (*sp, ls);
  return ls;
}
#undef FUNC_NAME

\f
/*
 * Initialize
 */

void
scm_init_vm (void)
{
  scm_init_frames ();
  scm_init_instructions ();
  scm_init_objcodes ();
  scm_init_programs ();

  scm_tc16_vm_cont = scm_make_smob_type ("vm-cont", 0);
  scm_set_smob_mark (scm_tc16_vm_cont, vm_cont_mark);
  scm_set_smob_free (scm_tc16_vm_cont, vm_cont_free);

  scm_tc16_vm = scm_make_smob_type ("vm", 0);
  scm_set_smob_mark (scm_tc16_vm, vm_mark);
  scm_set_smob_free (scm_tc16_vm, vm_free);
  scm_set_smob_apply (scm_tc16_vm, scm_vm_apply, 1, 0, 1);

  the_vm = scm_permanent_object (make_vm ());

#ifndef SCM_MAGIC_SNARFER
#include "vm.x"
#endif
}

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
8f5cfc81	1	/* Copyright (C) 2001 Free Software Foundation, Inc.
a98cef7e KN	2	*
	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)
	6	* any later version.
	7	*
	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.
	12	*
	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
	17	*
	18	* As a special exception, the Free Software Foundation gives permission
	19	* for additional uses of the text contained in its release of GUILE.
	20	*
	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.
	26	*
	27	* This exception does not however invalidate any other reasons why
	28	* the executable file might be covered by the GNU General Public License.
	29	*
	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.
	37	*
	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. */
	41
17e90c5e	42	#include <string.h>
ac99cb0c KN	43	#include "envs.h"
ac99cb0c KN	44	#include "frames.h"
17e90c5e	45	#include "instructions.h"
8f5cfc81	46	#include "objcodes.h"
ac99cb0c	47	#include "programs.h"
a98cef7e KN	48	#include "vm.h"
a98cef7e KN	49
a98cef7e KN	50	/* I sometimes use this for debugging. */
	51	#define vm_puts(OBJ) \
	52	{ \
	53	scm_display (OBJ, scm_def_errp); \
	54	scm_newline (scm_def_errp); \
	55	}
	56
	57	\f
a98cef7e KN	58	/*
	59	* VM Continuation
	60	*/
	61
f9e8c09d	62	scm_t_bits scm_tc16_vm_cont;
17e90c5e KN	63
	64
	65	#define SCM_VM_CONT_P(OBJ) SCM_SMOB_PREDICATE (scm_tc16_vm_cont, OBJ)
3d5ee0cd	66	#define SCM_VM_CONT_VP(CONT) ((struct scm_vm *) SCM_CELL_WORD_1 (CONT))
a98cef7e KN	67
a98cef7e KN	68	static SCM
3d5ee0cd	69	capture_vm_cont (struct scm_vm *vp)
a98cef7e	70	{
d8eeb67c	71	struct scm_vm p = scm_gc_malloc (sizeof (p), "capture_vm_cont");
3d5ee0cd	72	p->stack_size = vp->stack_limit - vp->sp;
d8eeb67c LC	73	p->stack_base = scm_gc_malloc (p->stack_size * sizeof (SCM),
d8eeb67c LC	74	"capture_vm_cont");
17e90c5e	75	p->stack_limit = p->stack_base + p->stack_size - 2;
3d5ee0cd KN	76	p->ip = vp->ip;
	77	p->sp = (SCM *) (vp->stack_limit - vp->sp);
	78	p->fp = (SCM *) (vp->stack_limit - vp->fp);
	79	memcpy (p->stack_base, vp->sp + 1, vp->stack_size * sizeof (SCM));
17e90c5e	80	SCM_RETURN_NEWSMOB (scm_tc16_vm_cont, p);
a98cef7e KN	81	}
	82
	83	static void
3d5ee0cd	84	reinstate_vm_cont (struct scm_vm *vp, SCM cont)
a98cef7e	85	{
3d5ee0cd KN	86	struct scm_vm *p = SCM_VM_CONT_VP (cont);
3d5ee0cd KN	87	if (vp->stack_size < p->stack_size)
a98cef7e	88	{
17e90c5e	89	/* puts ("FIXME: Need to expand"); */
a98cef7e KN	90	abort ();
a98cef7e KN	91	}
3d5ee0cd KN	92	vp->ip = p->ip;
	93	vp->sp = vp->stack_limit - (int) p->sp;
	94	vp->fp = vp->stack_limit - (int) p->fp;
	95	memcpy (vp->sp + 1, p->stack_base, p->stack_size * sizeof (SCM));
a98cef7e KN	96	}
	97
	98	static SCM
17e90c5e	99	vm_cont_mark (SCM obj)
a98cef7e KN	100	{
a98cef7e KN	101	SCM *p;
3d5ee0cd KN	102	struct scm_vm *vp = SCM_VM_CONT_VP (obj);
3d5ee0cd KN	103	for (p = vp->stack_base; p <= vp->stack_limit; p++)
a98cef7e KN	104	if (SCM_NIMP (*p))
	105	scm_gc_mark (*p);
	106	return SCM_BOOL_F;
	107	}
	108
	109	static scm_sizet
17e90c5e	110	vm_cont_free (SCM obj)
a98cef7e	111	{
3d5ee0cd	112	struct scm_vm *p = SCM_VM_CONT_VP (obj);
d8eeb67c LC	113
	114	scm_gc_free (p->stack_base, p->stack_size * sizeof (SCM), "stack-base");
	115	scm_gc_free (p, sizeof (struct scm_vm), "vm");
	116
	117	return 0;
a98cef7e KN	118	}
a98cef7e KN	119
17e90c5e KN	120	\f
	121	/*
	122	* VM Internal functions
	123	*/
	124
41f248a8	125	SCM_SYMBOL (sym_vm_run, "vm-run");
17e90c5e KN	126	SCM_SYMBOL (sym_vm_error, "vm-error");
	127
	128	static scm_byte_t *
	129	vm_fetch_length (scm_byte_t ip, size_t lenp)
a98cef7e	130	{
4bfb26f5	131	/* NOTE: format defined in system/vm/conv.scm */
17e90c5e KN	132	lenp = ip++;
	133	if (*lenp < 254)
	134	return ip;
	135	else if (*lenp == 254)
46cd9a34 KN	136	{
	137	int b1 = *ip++;
	138	int b2 = *ip++;
	139	*lenp = (b1 << 8) + b2;
	140	}
17e90c5e	141	else
46cd9a34 KN	142	{
	143	int b1 = *ip++;
	144	int b2 = *ip++;
	145	int b3 = *ip++;
	146	int b4 = *ip++;
	147	*lenp = (b1 << 24) + (b2 << 16) + (b3 << 8) + b4;
	148	}
17e90c5e	149	return ip;
a98cef7e KN	150	}
a98cef7e KN	151
af988bbf	152	static SCM
a6df585a	153	vm_heapify_frames_1 (struct scm_vm vp, SCM fp, SCM sp, SCM *destp)
af988bbf	154	{
a6df585a	155	SCM frame;
af988bbf	156	SCM *dl = SCM_FRAME_DYNAMIC_LINK (fp);
a6df585a KN	157	SCM *src = SCM_FRAME_UPPER_ADDRESS (fp);
a6df585a KN	158	SCM *dest = SCM_FRAME_LOWER_ADDRESS (fp);
af988bbf KN	159
	160	if (!dl)
	161	{
	162	/* The top frame */
af988bbf KN	163	frame = scm_c_make_heap_frame (fp);
	164	fp = SCM_HEAP_FRAME_POINTER (frame);
	165	SCM_FRAME_HEAP_LINK (fp) = SCM_BOOL_T;
	166	}
	167	else
	168	{
a6df585a	169	/* Child frames */
af988bbf KN	170	SCM link = SCM_FRAME_HEAP_LINK (dl);
af988bbf KN	171	if (!SCM_FALSEP (link))
a6df585a	172	link = SCM_FRAME_LOWER_ADDRESS (dl)[-1]; /* self link */
af988bbf	173	else
a6df585a	174	link = vm_heapify_frames_1 (vp, dl, dest - 1, &dest);
af988bbf KN	175	frame = scm_c_make_heap_frame (fp);
	176	fp = SCM_HEAP_FRAME_POINTER (frame);
	177	SCM_FRAME_HEAP_LINK (fp) = link;
	178	SCM_FRAME_DYNAMIC_LINK (fp) = SCM_HEAP_FRAME_POINTER (link);
	179	}
	180
	181	/* Move stack data */
a6df585a KN	182	for (; src <= sp; src++, dest++)
	183	dest = src;
	184	*destp = dest;
af988bbf KN	185
	186	return frame;
	187	}
	188
	189	static SCM
	190	vm_heapify_frames (SCM vm)
	191	{
	192	struct scm_vm *vp = SCM_VM_DATA (vm);
	193	if (SCM_FALSEP (SCM_FRAME_HEAP_LINK (vp->fp)))
	194	{
a6df585a KN	195	SCM *dest;
a6df585a KN	196	vp->this_frame = vm_heapify_frames_1 (vp, vp->fp, vp->sp, &dest);
af988bbf	197	vp->fp = SCM_HEAP_FRAME_POINTER (vp->this_frame);
a6df585a	198	vp->sp = dest - 1;
af988bbf KN	199	}
	200	return vp->this_frame;
	201	}
	202
a98cef7e KN	203	\f
	204	/*
	205	* VM
	206	*/
	207
c0a25ecc	208	#define VM_DEFAULT_STACK_SIZE (16 * 1024)
17e90c5e KN	209
	210	#define VM_REGULAR_ENGINE 0
	211	#define VM_DEBUG_ENGINE 1
	212
	213	#if 0
	214	#define VM_NAME vm_regular_engine
	215	#define VM_ENGINE VM_REGULAR_ENGINE
	216	#include "vm_engine.c"
	217	#undef VM_NAME
	218	#undef VM_ENGINE
	219	#endif
	220
	221	#define VM_NAME vm_debug_engine
	222	#define VM_ENGINE VM_DEBUG_ENGINE
	223	#include "vm_engine.c"
	224	#undef VM_NAME
	225	#undef VM_ENGINE
	226
f9e8c09d	227	scm_t_bits scm_tc16_vm;
a98cef7e	228
499a4c07 KN	229	static SCM the_vm;
499a4c07 KN	230
a98cef7e	231	static SCM
17e90c5e KN	232	make_vm (void)
17e90c5e KN	233	#define FUNC_NAME "make_vm"
a98cef7e	234	{
17e90c5e	235	int i;
d8eeb67c LC	236	struct scm_vm *vp = scm_gc_malloc (sizeof (struct scm_vm), "vm");
d8eeb67c LC	237
3d5ee0cd	238	vp->stack_size = VM_DEFAULT_STACK_SIZE;
d8eeb67c LC	239	vp->stack_base = scm_gc_malloc (vp->stack_size * sizeof (SCM),
d8eeb67c LC	240	"stack-base");
3616e9e9 KN	241	vp->stack_limit = vp->stack_base + vp->stack_size - 3;
	242	vp->ip = NULL;
	243	vp->sp = vp->stack_base - 1;
	244	vp->fp = NULL;
3d5ee0cd KN	245	vp->time = 0;
	246	vp->clock = 0;
	247	vp->options = SCM_EOL;
af988bbf	248	vp->this_frame = SCM_BOOL_F;
ac99cb0c	249	vp->last_frame = SCM_BOOL_F;
17e90c5e	250	for (i = 0; i < SCM_VM_NUM_HOOKS; i++)
3d5ee0cd KN	251	vp->hooks[i] = SCM_BOOL_F;
3d5ee0cd KN	252	SCM_RETURN_NEWSMOB (scm_tc16_vm, vp);
a98cef7e	253	}
17e90c5e	254	#undef FUNC_NAME
a98cef7e KN	255
a98cef7e KN	256	static SCM
17e90c5e	257	vm_mark (SCM obj)
a98cef7e	258	{
17e90c5e	259	int i;
3d5ee0cd	260	struct scm_vm *vp = SCM_VM_DATA (obj);
17e90c5e	261
af988bbf KN	262	/* mark the stack conservatively */
	263	scm_mark_locations ((SCM_STACKITEM *) vp->stack_base,
	264	sizeof (SCM) * (vp->sp - vp->stack_base + 1));
a98cef7e	265
af988bbf	266	/* mark other objects */
17e90c5e	267	for (i = 0; i < SCM_VM_NUM_HOOKS; i++)
3d5ee0cd	268	scm_gc_mark (vp->hooks[i]);
af988bbf	269	scm_gc_mark (vp->this_frame);
ac99cb0c	270	scm_gc_mark (vp->last_frame);
3d5ee0cd	271	return vp->options;
a98cef7e KN	272	}
a98cef7e KN	273
17e90c5e KN	274	static scm_sizet
	275	vm_free (SCM obj)
	276	{
3d5ee0cd	277	struct scm_vm *vp = SCM_VM_DATA (obj);
d8eeb67c LC	278
	279	scm_gc_free (vp->stack_base, vp->stack_size * sizeof (SCM),
	280	"stack-base");
	281	scm_gc_free (vp, sizeof (struct scm_vm), "vm");
	282
	283	return 0;
17e90c5e KN	284	}
	285
	286	SCM_SYMBOL (sym_debug, "debug");
	287
	288	SCM
	289	scm_vm_apply (SCM vm, SCM program, SCM args)
	290	#define FUNC_NAME "scm_vm_apply"
a98cef7e	291	{
17e90c5e	292	SCM_VALIDATE_PROGRAM (1, program);
41f248a8	293	return vm_run (vm, program, args);
a98cef7e	294	}
17e90c5e	295	#undef FUNC_NAME
a98cef7e KN	296
	297	/* Scheme interface */
	298
	299	SCM_DEFINE (scm_vm_version, "vm-version", 0, 0, 0,
17e90c5e KN	300	(void),
17e90c5e KN	301	"")
a98cef7e KN	302	#define FUNC_NAME s_scm_vm_version
a98cef7e KN	303	{
fa19602c	304	return scm_from_locale_string (VERSION);
a98cef7e KN	305	}
	306	#undef FUNC_NAME
	307
499a4c07 KN	308	SCM_DEFINE (scm_the_vm, "the-vm", 0, 0, 0,
	309	(),
	310	"")
	311	#define FUNC_NAME s_scm_the_vm
	312	{
	313	return the_vm;
	314	}
	315	#undef FUNC_NAME
	316
	317
a98cef7e KN	318	SCM_DEFINE (scm_vm_p, "vm?", 1, 0, 0,
a98cef7e KN	319	(SCM obj),
17e90c5e	320	"")
a98cef7e KN	321	#define FUNC_NAME s_scm_vm_p
	322	{
	323	return SCM_BOOL (SCM_VM_P (obj));
	324	}
	325	#undef FUNC_NAME
	326
	327	SCM_DEFINE (scm_make_vm, "make-vm", 0, 0, 0,
17e90c5e KN	328	(void),
	329	"")
	330	#define FUNC_NAME s_scm_make_vm,
a98cef7e	331	{
17e90c5e	332	return make_vm ();
a98cef7e KN	333	}
	334	#undef FUNC_NAME
	335
17e90c5e	336	SCM_DEFINE (scm_vm_ip, "vm:ip", 1, 0, 0,
a98cef7e	337	(SCM vm),
17e90c5e KN	338	"")
17e90c5e KN	339	#define FUNC_NAME s_scm_vm_ip
a98cef7e KN	340	{
a98cef7e KN	341	SCM_VALIDATE_VM (1, vm);
17e90c5e	342	return scm_ulong2num ((unsigned long) SCM_VM_DATA (vm)->ip);
a98cef7e KN	343	}
	344	#undef FUNC_NAME
	345
	346	SCM_DEFINE (scm_vm_sp, "vm:sp", 1, 0, 0,
	347	(SCM vm),
17e90c5e	348	"")
a98cef7e KN	349	#define FUNC_NAME s_scm_vm_sp
	350	{
	351	SCM_VALIDATE_VM (1, vm);
17e90c5e	352	return scm_ulong2num ((unsigned long) SCM_VM_DATA (vm)->sp);
a98cef7e KN	353	}
	354	#undef FUNC_NAME
	355
	356	SCM_DEFINE (scm_vm_fp, "vm:fp", 1, 0, 0,
	357	(SCM vm),
17e90c5e	358	"")
a98cef7e KN	359	#define FUNC_NAME s_scm_vm_fp
	360	{
	361	SCM_VALIDATE_VM (1, vm);
17e90c5e	362	return scm_ulong2num ((unsigned long) SCM_VM_DATA (vm)->fp);
a98cef7e KN	363	}
	364	#undef FUNC_NAME
	365
17e90c5e KN	366	#define VM_DEFINE_HOOK(n) \
17e90c5e KN	367	{ \
3d5ee0cd	368	struct scm_vm *vp; \
17e90c5e	369	SCM_VALIDATE_VM (1, vm); \
3d5ee0cd KN	370	vp = SCM_VM_DATA (vm); \
	371	if (SCM_FALSEP (vp->hooks[n])) \
	372	vp->hooks[n] = scm_make_hook (SCM_MAKINUM (1)); \
	373	return vp->hooks[n]; \
17e90c5e KN	374	}
	375
	376	SCM_DEFINE (scm_vm_boot_hook, "vm-boot-hook", 1, 0, 0,
a98cef7e	377	(SCM vm),
17e90c5e KN	378	"")
17e90c5e KN	379	#define FUNC_NAME s_scm_vm_boot_hook
a98cef7e	380	{
17e90c5e	381	VM_DEFINE_HOOK (SCM_VM_BOOT_HOOK);
a98cef7e KN	382	}
	383	#undef FUNC_NAME
	384
17e90c5e KN	385	SCM_DEFINE (scm_vm_halt_hook, "vm-halt-hook", 1, 0, 0,
	386	(SCM vm),
	387	"")
	388	#define FUNC_NAME s_scm_vm_halt_hook
a98cef7e	389	{
17e90c5e	390	VM_DEFINE_HOOK (SCM_VM_HALT_HOOK);
a98cef7e KN	391	}
	392	#undef FUNC_NAME
	393
17e90c5e	394	SCM_DEFINE (scm_vm_next_hook, "vm-next-hook", 1, 0, 0,
a98cef7e	395	(SCM vm),
17e90c5e KN	396	"")
17e90c5e KN	397	#define FUNC_NAME s_scm_vm_next_hook
a98cef7e	398	{
17e90c5e	399	VM_DEFINE_HOOK (SCM_VM_NEXT_HOOK);
a98cef7e KN	400	}
	401	#undef FUNC_NAME
	402
7a0d0cee KN	403	SCM_DEFINE (scm_vm_break_hook, "vm-break-hook", 1, 0, 0,
	404	(SCM vm),
	405	"")
	406	#define FUNC_NAME s_scm_vm_break_hook
	407	{
	408	VM_DEFINE_HOOK (SCM_VM_BREAK_HOOK);
	409	}
	410	#undef FUNC_NAME
	411
17e90c5e KN	412	SCM_DEFINE (scm_vm_enter_hook, "vm-enter-hook", 1, 0, 0,
	413	(SCM vm),
	414	"")
	415	#define FUNC_NAME s_scm_vm_enter_hook
a98cef7e	416	{
17e90c5e	417	VM_DEFINE_HOOK (SCM_VM_ENTER_HOOK);
a98cef7e KN	418	}
	419	#undef FUNC_NAME
	420
17e90c5e KN	421	SCM_DEFINE (scm_vm_apply_hook, "vm-apply-hook", 1, 0, 0,
	422	(SCM vm),
	423	"")
	424	#define FUNC_NAME s_scm_vm_apply_hook
a98cef7e	425	{
17e90c5e	426	VM_DEFINE_HOOK (SCM_VM_APPLY_HOOK);
a98cef7e KN	427	}
	428	#undef FUNC_NAME
	429
17e90c5e	430	SCM_DEFINE (scm_vm_exit_hook, "vm-exit-hook", 1, 0, 0,
a98cef7e	431	(SCM vm),
17e90c5e KN	432	"")
17e90c5e KN	433	#define FUNC_NAME s_scm_vm_exit_hook
a98cef7e	434	{
17e90c5e	435	VM_DEFINE_HOOK (SCM_VM_EXIT_HOOK);
a98cef7e KN	436	}
	437	#undef FUNC_NAME
	438
17e90c5e	439	SCM_DEFINE (scm_vm_return_hook, "vm-return-hook", 1, 0, 0,
a98cef7e	440	(SCM vm),
17e90c5e KN	441	"")
17e90c5e KN	442	#define FUNC_NAME s_scm_vm_return_hook
a98cef7e	443	{
17e90c5e	444	VM_DEFINE_HOOK (SCM_VM_RETURN_HOOK);
a98cef7e KN	445	}
	446	#undef FUNC_NAME
	447
17e90c5e KN	448	SCM_DEFINE (scm_vm_option, "vm-option", 2, 0, 0,
	449	(SCM vm, SCM key),
	450	"")
	451	#define FUNC_NAME s_scm_vm_option
a98cef7e KN	452	{
a98cef7e KN	453	SCM_VALIDATE_VM (1, vm);
17e90c5e	454	return scm_assq_ref (SCM_VM_DATA (vm)->options, key);
a98cef7e KN	455	}
	456	#undef FUNC_NAME
	457
17e90c5e KN	458	SCM_DEFINE (scm_set_vm_option_x, "set-vm-option!", 3, 0, 0,
	459	(SCM vm, SCM key, SCM val),
	460	"")
	461	#define FUNC_NAME s_scm_set_vm_option_x
a98cef7e KN	462	{
a98cef7e KN	463	SCM_VALIDATE_VM (1, vm);
17e90c5e KN	464	SCM_VM_DATA (vm)->options
	465	= scm_assq_set_x (SCM_VM_DATA (vm)->options, key, val);
	466	return SCM_UNSPECIFIED;
a98cef7e KN	467	}
	468	#undef FUNC_NAME
	469
17e90c5e	470	SCM_DEFINE (scm_vm_stats, "vm-stats", 1, 0, 0,
a98cef7e	471	(SCM vm),
17e90c5e KN	472	"")
17e90c5e KN	473	#define FUNC_NAME s_scm_vm_stats
a98cef7e	474	{
17e90c5e KN	475	SCM stats;
17e90c5e KN	476
a98cef7e	477	SCM_VALIDATE_VM (1, vm);
17e90c5e	478
f9e8c09d LC	479	stats = scm_make_vector (scm_from_int (2), SCM_UNSPECIFIED);
	480	scm_vector_set_x (stats, scm_from_int (0),
	481	scm_from_ulong (SCM_VM_DATA (vm)->time));
	482	scm_vector_set_x (stats, scm_from_int (1),
	483	scm_from_ulong (SCM_VM_DATA (vm)->clock));
17e90c5e KN	484
17e90c5e KN	485	return stats;
a98cef7e KN	486	}
	487	#undef FUNC_NAME
	488
17e90c5e KN	489	#define VM_CHECK_RUNNING(vm) \
	490	if (!SCM_VM_DATA (vm)->ip) \
	491	SCM_MISC_ERROR ("Not running", SCM_LIST1 (vm))
	492
af988bbf	493	SCM_DEFINE (scm_vm_this_frame, "vm-this-frame", 1, 0, 0,
a98cef7e	494	(SCM vm),
17e90c5e	495	"")
af988bbf	496	#define FUNC_NAME s_scm_vm_this_frame
a98cef7e KN	497	{
a98cef7e KN	498	SCM_VALIDATE_VM (1, vm);
af988bbf	499	return SCM_VM_DATA (vm)->this_frame;
ac99cb0c KN	500	}
	501	#undef FUNC_NAME
	502
	503	SCM_DEFINE (scm_vm_last_frame, "vm-last-frame", 1, 0, 0,
	504	(SCM vm),
	505	"")
	506	#define FUNC_NAME s_scm_vm_last_frame
	507	{
	508	SCM_VALIDATE_VM (1, vm);
	509	return SCM_VM_DATA (vm)->last_frame;
a98cef7e KN	510	}
	511	#undef FUNC_NAME
	512
17e90c5e KN	513	SCM_DEFINE (scm_vm_fetch_code, "vm-fetch-code", 1, 0, 0,
	514	(SCM vm),
	515	"")
	516	#define FUNC_NAME s_scm_vm_fetch_code
	517	{
	518	int i;
	519	SCM list;
	520	scm_byte_t *ip;
	521	struct scm_instruction *p;
a98cef7e	522
17e90c5e KN	523	SCM_VALIDATE_VM (1, vm);
17e90c5e KN	524	VM_CHECK_RUNNING (vm);
a98cef7e	525
17e90c5e KN	526	ip = SCM_VM_DATA (vm)->ip;
17e90c5e KN	527	p = SCM_INSTRUCTION (*ip);
a98cef7e	528
17e90c5e KN	529	list = SCM_LIST1 (scm_str2symbol (p->name));
	530	for (i = 1; i <= p->len; i++)
	531	list = scm_cons (SCM_MAKINUM (ip[i]), list);
	532	return scm_reverse_x (list, SCM_EOL);
	533	}
	534	#undef FUNC_NAME
	535
	536	SCM_DEFINE (scm_vm_fetch_stack, "vm-fetch-stack", 1, 0, 0,
	537	(SCM vm),
	538	"")
	539	#define FUNC_NAME s_scm_vm_fetch_stack
a98cef7e	540	{
3616e9e9 KN	541	SCM *sp;
	542	SCM ls = SCM_EOL;
	543	struct scm_vm *vp;
a98cef7e KN	544
a98cef7e KN	545	SCM_VALIDATE_VM (1, vm);
17e90c5e	546	VM_CHECK_RUNNING (vm);
a98cef7e	547
3616e9e9	548	vp = SCM_VM_DATA (vm);
af988bbf	549	for (sp = vp->stack_base; sp <= vp->sp; sp++)
3616e9e9 KN	550	ls = scm_cons (*sp, ls);
3616e9e9 KN	551	return ls;
a98cef7e KN	552	}
	553	#undef FUNC_NAME
	554
	555	\f
	556	/*
17e90c5e	557	* Initialize
a98cef7e KN	558	*/
a98cef7e KN	559
17e90c5e KN	560	void
	561	scm_init_vm (void)
	562	{
ac99cb0c	563	scm_init_frames ();
17e90c5e	564	scm_init_instructions ();
8f5cfc81	565	scm_init_objcodes ();
ac99cb0c	566	scm_init_programs ();
a98cef7e	567
17e90c5e KN	568	scm_tc16_vm_cont = scm_make_smob_type ("vm-cont", 0);
	569	scm_set_smob_mark (scm_tc16_vm_cont, vm_cont_mark);
	570	scm_set_smob_free (scm_tc16_vm_cont, vm_cont_free);
a98cef7e	571
17e90c5e KN	572	scm_tc16_vm = scm_make_smob_type ("vm", 0);
	573	scm_set_smob_mark (scm_tc16_vm, vm_mark);
	574	scm_set_smob_free (scm_tc16_vm, vm_free);
	575	scm_set_smob_apply (scm_tc16_vm, scm_vm_apply, 1, 0, 1);
a98cef7e	576
499a4c07 KN	577	the_vm = scm_permanent_object (make_vm ());
499a4c07 KN	578
17e90c5e	579	#ifndef SCM_MAGIC_SNARFER
a98cef7e	580	#include "vm.x"
17e90c5e	581	#endif
a98cef7e	582	}
17e90c5e KN	583
	584	/*
	585	Local Variables:
	586	c-file-style: "gnu"
	587	End:
	588	*/