libguile/vm.h

   1 /* Copyright (C) 2001 Free Software Foundation, Inc.
   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
  42 #ifndef _SCM_VM_H_
  43 #define _SCM_VM_H_
  44
  45 #include <libguile.h>
  46 #include <libguile/programs.h>
  47
  48 #define SCM_VM_BOOT_HOOK        0
  49 #define SCM_VM_HALT_HOOK        1
  50 #define SCM_VM_NEXT_HOOK        2
  51 #define SCM_VM_BREAK_HOOK       3
  52 #define SCM_VM_ENTER_HOOK       4
  53 #define SCM_VM_APPLY_HOOK       5
  54 #define SCM_VM_EXIT_HOOK        6
  55 #define SCM_VM_RETURN_HOOK      7
  56 #define SCM_VM_NUM_HOOKS        8
  57
  58 struct scm_vm;
  59
  60 typedef SCM (*scm_t_vm_engine) (struct scm_vm *vp, SCM program, SCM *argv, int nargs);
  61
  62 #define SCM_VM_REGULAR_ENGINE 0
  63 #define SCM_VM_DEBUG_ENGINE 1
  64 #define SCM_VM_NUM_ENGINES 2
  65
  66 struct scm_vm {
  67   scm_byte_t *ip;               /* instruction pointer */
  68   SCM *sp;                      /* stack pointer */
  69   SCM *fp;                      /* frame pointer */
  70   size_t stack_size;            /* stack size */
  71   SCM *stack_base;              /* stack base address */
  72   SCM *stack_limit;             /* stack limit address */
  73   int engine;                   /* which vm engine we're using */
  74   SCM hooks[SCM_VM_NUM_HOOKS];  /* hooks */
  75   SCM options;                  /* options */
  76   unsigned long time;           /* time spent */
  77   unsigned long clock;          /* bogos clock */
  78   SCM trace_frame;              /* a frame being traced */
  79 };
  80
  81 extern SCM scm_the_vm_fluid;
  82
  83 #define SCM_VM_P(x)             SCM_SMOB_PREDICATE (scm_tc16_vm, x)
  84 #define SCM_VM_DATA(vm)         ((struct scm_vm *) SCM_SMOB_DATA (vm))
  85 #define SCM_VALIDATE_VM(pos,x)  SCM_MAKE_VALIDATE (pos, x, VM_P)
  86
  87 extern SCM scm_the_vm ();
  88 extern SCM scm_make_vm (void);
  89 extern SCM scm_vm_apply (SCM vm, SCM program, SCM args);
  90 extern SCM scm_c_vm_run (SCM vm, SCM program, SCM *argv, int nargs);
  91 extern SCM scm_vm_option_ref (SCM vm, SCM key);
  92 extern SCM scm_vm_option_set_x (SCM vm, SCM key, SCM val);
  93
  94 extern SCM scm_vm_version (void);
  95 extern SCM scm_the_vm (void);
  96 extern SCM scm_vm_p (SCM obj);
  97 extern SCM scm_vm_ip (SCM vm);
  98 extern SCM scm_vm_sp (SCM vm);
  99 extern SCM scm_vm_fp (SCM vm);
 100 extern SCM scm_vm_boot_hook (SCM vm);
 101 extern SCM scm_vm_halt_hook (SCM vm);
 102 extern SCM scm_vm_next_hook (SCM vm);
 103 extern SCM scm_vm_break_hook (SCM vm);
 104 extern SCM scm_vm_enter_hook (SCM vm);
 105 extern SCM scm_vm_apply_hook (SCM vm);
 106 extern SCM scm_vm_exit_hook (SCM vm);
 107 extern SCM scm_vm_return_hook (SCM vm);
 108 extern SCM scm_vm_option (SCM vm, SCM key);
 109 extern SCM scm_set_vm_option_x (SCM vm, SCM key, SCM val);
 110 extern SCM scm_vm_stats (SCM vm);
 111 extern SCM scm_vm_trace_frame (SCM vm);
 112
 113 struct scm_vm_cont {
 114   scm_byte_t *ip;
 115   SCM *sp;
 116   SCM *fp;
 117   scm_t_ptrdiff stack_size;
 118   SCM *stack_base;
 119   scm_t_ptrdiff reloc;
 120 };
 121
 122 extern scm_t_bits scm_tc16_vm_cont;
 123 #define SCM_VM_CONT_P(OBJ)      SCM_SMOB_PREDICATE (scm_tc16_vm_cont, OBJ)
 124 #define SCM_VM_CONT_DATA(CONT)  ((struct scm_vm_cont *) SCM_CELL_WORD_1 (CONT))
 125
 126 extern SCM scm_vm_capture_continuations (void);
 127 extern void scm_vm_reinstate_continuations (SCM conts);
 128
 129 extern SCM scm_load_compiled_with_vm (SCM file);
 130
 131 extern void scm_init_vm (void);
 132
 133 #endif /* _SCM_VM_H_ */
 134
 135 /*
 136   Local Variables:
 137   c-file-style: "gnu"
 138   End:
 139 */