vm.h

Go to the documentation of this file.

 
#ifndef MRBC_SRC_VM_H_
#define MRBC_SRC_VM_H_
 
/***** Feature test switches ************************************************/
/***** System headers *******************************************************/
//@cond
#include "vm_config.h"
#include <stdint.h>
//@endcond
 
 
/***** Local headers ********************************************************/
#include "value.h"
#include "symbol.h"
#include "c_proc.h"
 
#ifdef __cplusplus
extern "C" {
#endif
/***** Constat values *******************************************************/
/***** Macros ***************************************************************/
/***** Typedefs *************************************************************/
//================================================================
typedef struct IREP {
#if defined(MRBC_DEBUG)
  uint8_t obj_mark_[2];         
#endif
 
  uint16_t ref_count;           
#if defined(MRBC_DEBUG)
  uint16_t nlocals;             
#endif
  uint16_t nregs;               
  uint16_t rlen;                
  uint16_t clen;                
  uint16_t ilen;                
#if defined(MRBC_DEBUG)
  uint16_t plen;                
  uint16_t slen;                
#endif
  uint16_t ofs_pools;           
  uint16_t ofs_ireps;           
 
  const uint8_t *inst;          
  const uint8_t *pool;          
 
  uint8_t data[];               
} mrbc_irep;
//@cond
typedef struct IREP mrb_irep;
//@endcond
 
// mrbc_irep manipulate macro.
#define mrbc_irep_tbl_syms(irep)        ((mrbc_sym *)(irep)->data)

#define mrbc_irep_symbol_id(irep, n)    mrbc_irep_tbl_syms(irep)[(n)]

#define mrbc_irep_symbol_cstr(irep, n)  mrbc_symid_to_str( mrbc_irep_symbol_id(irep, n) )
 

#define mrbc_irep_tbl_pools(irep) \
  ( (uint16_t *)((irep)->data + (irep)->ofs_pools) )

#define mrbc_irep_pool_ptr(irep, n) \
  ( (irep)->pool + mrbc_irep_tbl_pools(irep)[(n)] )
 

#define mrbc_irep_tbl_ireps(irep) \
  ( (mrbc_irep **)((irep)->data + (irep)->ofs_ireps) )

#define mrbc_irep_child_irep(irep, n) \
  ( mrbc_irep_tbl_ireps(irep)[(n)] )
 
 
 
//================================================================
typedef struct IREP_CATCH_HANDLER {
  uint8_t type;         
  uint8_t begin[4];     
  uint8_t end[4];       
  uint8_t target[4];    
} mrbc_irep_catch_handler;
 
 
//================================================================
typedef struct CALLINFO {
#if defined(MRBC_DEBUG)
  uint8_t obj_mark_[2];         
#endif
 
  const mrbc_irep *cur_irep;    
  const uint8_t   *inst;        
  mrbc_value      *cur_regs;    
  struct RClass *target_class;  
  struct CALLINFO *prev;        
 
  struct RClass *own_class;     
  struct RHash *karg_keep;      
  mrbc_sym method_id;           
  uint8_t reg_offset;           
  uint8_t n_args;               
  uint8_t is_called_super;      
  uint8_t is_called_block;      
 
} mrbc_callinfo;
//@cond
typedef struct CALLINFO mrb_callinfo;
//@endcond
 
 
//================================================================
typedef struct VM {
#if defined(MRBC_DEBUG)
  uint8_t obj_mark_[2];                 // set "VM" for debug
#endif
  uint8_t vm_id;                        
  volatile int8_t flag_preemption;
  unsigned int flag_need_memfree : 1;
  unsigned int flag_stop : 1;
  unsigned int flag_permanence : 1;
 
  mrbc_irep       *top_irep;            
 
  const mrbc_irep *cur_irep;            
  const uint8_t   *inst;                
  mrbc_value      *cur_regs;            
  struct RClass   *target_class;        
  mrbc_callinfo   *callinfo_tail;       
 
  struct RProc    *ret_blk;             
  mrbc_value      exception;            
  mrbc_sym        callee_sym_id;        
  uint16_t        regs_size;            
  mrbc_value      regs[];
 
} mrbc_vm;
//@cond
typedef struct VM mrb_vm;
//@endcond
 
 
/***** Global variables *****************************************************/
/***** Function prototypes **************************************************/
//@cond
void mrbc_cleanup_vm(void);
mrbc_callinfo *mrbc_push_callinfo(mrbc_vm *vm, mrbc_sym method_id, int reg_offset, int n_args);
void mrbc_pop_callinfo(mrbc_vm *vm);
mrbc_vm *mrbc_vm_new(int regs_size);
mrbc_vm *mrbc_vm_open(mrbc_vm *vm);
void mrbc_vm_begin(mrbc_vm *vm);
void mrbc_vm_end(mrbc_vm *vm);
void mrbc_vm_close(mrbc_vm *vm);
int mrbc_vm_run(mrbc_vm *vm);
//@endcond
 
 
/***** Inline functions *****************************************************/
//================================================================
static inline mrbc_value * mrbc_get_self( mrbc_vm *vm, mrbc_value *regs )
{
  return mrbc_type(regs[0]) == MRBC_TT_PROC ? &(regs[0].proc->self) : &regs[0];
}
 
 
//================================================================
static inline mrbc_sym mrbc_get_callee_symid( const mrbc_vm *vm )
{
  return vm->callee_sym_id;
}
 
 
//================================================================
static inline const char *mrbc_get_callee_name( const mrbc_vm *vm )
{
  return mrbc_symid_to_str( vm->callee_sym_id );
}
 
 
//================================================================
static inline int mrbc_c_block_given( mrbc_vm *vm, mrbc_value v[], int argc )
{
  int ofs = 1 + (mrbc_type(v[argc+1]) == MRBC_TT_HASH);
 
  return mrbc_type(v[argc + ofs]) == MRBC_TT_PROC;
}
 
#ifdef __cplusplus
}
#endif
#endif