src/vm.h

   1 /* Copyright (C) 2000 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 _VM_H_
  43 #define _VM_H_
  44
  45 #include <libguile.h>
  46 #include "config.h"
  47 #include "programs.h"
  48
  49 /*
  50  * VM Address
  51  */
  52
  53 #define SCM_VM_MAKE_FRAME_ADDRESS(ptr)  SCM_PACK (ptr)
  54 #define SCM_VM_FRAME_ADDRESS(addr)      ((SCM *) SCM_UNPACK (addr))
  55
  56 #define SCM_VM_MAKE_BYTE_ADDRESS(ptr)   SCM_PACK (ptr)
  57 #define SCM_VM_BYTE_ADDRESS(addr)       ((scm_byte_t *) SCM_UNPACK (addr))
  58
  59 /*
  60  * VM Frame
  61  */
  62
  63 /*
  64    |                  | <- fp + bp->nargs + bp->nlocs
  65    +------------------+
  66    | Argument 1       |
  67    | Argument 2       |
  68    | Local variable 1 |
  69    | Local varialbe 2 | <- fp
  70    | Program          |
  71    | Dynamic link     |
  72    | Return address   | <- fp - SCM_VM_FRAME_DATA_SIZE
  73    +------------------+
  74    |                  |
  75 */
  76
  77 /* Frames are allocated on the stack */
  78 #define SCM_VM_FRAME_DATA_SIZE          3
  79 #define SCM_VM_FRAME_VARIABLE(fp,i)     fp[i]
  80 #define SCM_VM_FRAME_PROGRAM(fp)        fp[-1]
  81 #define SCM_VM_FRAME_DYNAMIC_LINK(fp)   fp[-2]
  82 #define SCM_VM_FRAME_RETURN_ADDRESS(fp) fp[-3]
  83
  84 #define SCM_VM_FRAME_UPPER_ADDRESS(fp)                  \
  85   (fp + SCM_PROGRAM_NARGS (SCM_VM_FRAME_PROGRAM (fp))   \
  86       + SCM_PROGRAM_NLOCS (SCM_VM_FRAME_PROGRAM (fp)))
  87 #define SCM_VM_FRAME_LOWER_ADDRESS(fp) \
  88   (fp - SCM_VM_FRAME_DATA_SIZE)
  89
  90 /*
  91  * VM Debug frame
  92  */
  93
  94 struct scm_vm_debug_frame {
  95   SCM program;
  96   SCM variables;
  97   SCM dynamic_link;
  98 };
  99
 100 extern scm_bits_t scm_tc16_vm_debug_frame;
 101
 102 #define SCM_VM_DEBUG_FRAME_P(x)         SCM_SMOB_PREDICATE (scm_tc16_vm_debug_frame, x)
 103 #define SCM_VM_DEBUG_FRAME_DATA(f)      ((struct scm_vm_debug_frame *) SCM_SMOB_DATA (f))
 104 #define SCM_VALIDATE_VM_DEBUG_FRAME(p,x)        SCM_MAKE_VALIDATE (p, x, VM_DEBUG_FRAME_P)
 105
 106 #define SCM_VM_DEBUG_FRAME_PROGRAM(f)           SCM_VM_DEBUG_FRAME_DATA (f)->program
 107 #define SCM_VM_DEBUG_FRAME_VARIABLES(f)         SCM_VM_DEBUG_FRAME_DATA (f)->variables
 108 #define SCM_VM_DEBUG_FRAME_DYNAMIC_LINK(f)      SCM_VM_DEBUG_FRAME_DATA (f)->dynamic_link
 109
 110 /*
 111  * VM
 112  */
 113
 114 #define SCM_VM_BOOT_HOOK        0
 115 #define SCM_VM_HALT_HOOK        1
 116 #define SCM_VM_NEXT_HOOK        2
 117 #define SCM_VM_ENTER_HOOK       3
 118 #define SCM_VM_APPLY_HOOK       4
 119 #define SCM_VM_EXIT_HOOK        5
 120 #define SCM_VM_RETURN_HOOK      6
 121 #define SCM_VM_NUM_HOOKS        7
 122
 123 struct scm_vm {
 124   scm_byte_t *ip;               /* instruction pointer */
 125   SCM *sp;                      /* stack pointer */
 126   SCM *fp;                      /* frame pointer */
 127   size_t stack_size;            /* stack size */
 128   SCM *stack_base;              /* stack base address */
 129   SCM *stack_limit;             /* stack limit address */
 130   SCM hooks[SCM_VM_NUM_HOOKS];  /* hooks */
 131   SCM options;                  /* options */
 132   unsigned long cons;           /* cons count */
 133   unsigned long time;           /* time spent */
 134   unsigned long clock;          /* bogos clock */
 135 };
 136
 137 #define SCM_VM_P(x)             SCM_SMOB_PREDICATE (scm_tc16_vm, x)
 138 #define SCM_VM_DATA(vm)         ((struct scm_vm *) SCM_SMOB_DATA (vm))
 139 #define SCM_VALIDATE_VM(pos,x)  SCM_MAKE_VALIDATE (pos, x, VM_P)
 140
 141 extern SCM scm_make_vm (void);
 142 extern SCM scm_vm_apply (SCM vm, SCM program, SCM args);
 143 extern SCM scm_vm_option_ref (SCM vm, SCM key);
 144 extern SCM scm_vm_option_set_x (SCM vm, SCM key, SCM val);
 145
 146 extern SCM scm_vm_current_frame (SCM vm);
 147
 148 extern void scm_init_vm (void);
 149
 150 #endif /* _VM_H_ */
 151
 152 /*
 153   Local Variables:
 154   c-file-style: "gnu"
 155   End:
 156 */