mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
23dc0dbc4a
hooks (old macro name is COLLECT_USAGE_ANALYSIS). This feature is only for VM developers. (I'm not sure I can use `VM developers' (the plural form) in this sentence). If VM_COLLECT_USAGE_DETAILS is not 0, VM enables the following usage collection features: (1) insntruction: collect intruction usages. (2) operand: collect operand usages. (3) register: collect register usages. The results are stored in RubyVM::USAGE_ANALYSIS_INSN for (1, 2), RubyVM::USAGE_ANALYSIS_INSN_BIGRAM for (1) and RubyVM::USAGE_ANALYSIS_REGS for (3). You can stop collecting usages with RubyVM::USAGE_ANALYSIS_INSN_STOP(), RubyVM::USAGE_ANALYSIS_OPERAND_STOP(), RubyVM::USAGE_ANALYSIS_REGISTER_STOP() for (1), (2), (3) respectively. You can also change the hook functions by setting C level global variables `ruby_vm_collect_usage_func_(insn|operand|register)' for (1), (2), (3) respectively. See codes for more details. * tool/instruction.rb: fix macro names. * iseq.c (insn_operand_intern): make it export (used in vm.c). fix to skip several processes if not needed (pointer is 0). * vm_dump.c: move codes for collection features to vm.c. * vm_exec.h: rename macro and function names. * vm_insnhelper.h: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37085 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
268 lines
7.7 KiB
C
268 lines
7.7 KiB
C
/**********************************************************************
|
|
|
|
insnhelper.h - helper macros to implement each instructions
|
|
|
|
$Author$
|
|
created at: 04/01/01 15:50:34 JST
|
|
|
|
Copyright (C) 2004-2007 Koichi Sasada
|
|
|
|
**********************************************************************/
|
|
|
|
#ifndef RUBY_INSNHELPER_H
|
|
#define RUBY_INSNHELPER_H
|
|
|
|
/**
|
|
* VM Debug Level
|
|
*
|
|
* debug level:
|
|
* 0: no debug output
|
|
* 1: show instruction name
|
|
* 2: show stack frame when control stack frame is changed
|
|
* 3: show stack status
|
|
* 4: show register
|
|
* 5:
|
|
* 10: gc check
|
|
*/
|
|
|
|
#ifndef VMDEBUG
|
|
#define VMDEBUG 0
|
|
#endif
|
|
|
|
#if 0
|
|
#undef VMDEBUG
|
|
#define VMDEBUG 3
|
|
#endif
|
|
|
|
enum {
|
|
BOP_PLUS,
|
|
BOP_MINUS,
|
|
BOP_MULT,
|
|
BOP_DIV,
|
|
BOP_MOD,
|
|
BOP_EQ,
|
|
BOP_EQQ,
|
|
BOP_LT,
|
|
BOP_LE,
|
|
BOP_LTLT,
|
|
BOP_AREF,
|
|
BOP_ASET,
|
|
BOP_LENGTH,
|
|
BOP_SIZE,
|
|
BOP_EMPTY_P,
|
|
BOP_SUCC,
|
|
BOP_GT,
|
|
BOP_GE,
|
|
BOP_NOT,
|
|
BOP_NEQ,
|
|
|
|
BOP_LAST_
|
|
};
|
|
|
|
extern char ruby_vm_redefined_flag[BOP_LAST_];
|
|
extern VALUE ruby_vm_const_missing_count;
|
|
|
|
#if VM_COLLECT_USAGE_DETAILS
|
|
#define COLLECT_USAGE_INSN(insn) vm_collect_usage_insn(insn)
|
|
#define COLLECT_USAGE_OPERAND(insn, n, op) vm_collect_usage_operand((insn), (n), ((VALUE)(op)))
|
|
#define COLLECT_USAGE_REGISTER(reg, s) vm_collect_usage_register((reg), (s))
|
|
#else
|
|
#define COLLECT_USAGE_INSN(insn) /* none */
|
|
#define COLLECT_USAGE_OPERAND(insn, n, op) /* none */
|
|
#define COLLECT_USAGE_REGISTER(reg, s) /* none */
|
|
#endif
|
|
|
|
/**********************************************************/
|
|
/* deal with stack */
|
|
/**********************************************************/
|
|
|
|
#define PUSH(x) (SET_SV(x), INC_SP(1))
|
|
#define TOPN(n) (*(GET_SP()-(n)-1))
|
|
#define POPN(n) (DEC_SP(n))
|
|
#define POP() (DEC_SP(1))
|
|
#define STACK_ADDR_FROM_TOP(n) (GET_SP()-(n))
|
|
|
|
#define GET_TOS() (tos) /* dummy */
|
|
|
|
/**********************************************************/
|
|
/* deal with registers */
|
|
/**********************************************************/
|
|
|
|
#define REG_CFP (reg_cfp)
|
|
#define REG_PC (REG_CFP->pc)
|
|
#define REG_SP (REG_CFP->sp)
|
|
#define REG_EP (REG_CFP->ep)
|
|
|
|
#define RESTORE_REGS() do { \
|
|
REG_CFP = th->cfp; \
|
|
} while (0)
|
|
|
|
#define REG_A reg_a
|
|
#define REG_B reg_b
|
|
|
|
enum vm_regan_regtype {
|
|
VM_REGAN_PC = 0,
|
|
VM_REGAN_SP = 1,
|
|
VM_REGAN_EP = 2,
|
|
VM_REGAN_CFP = 3,
|
|
VM_REGAN_SELF = 4,
|
|
VM_REGAN_ISEQ = 5,
|
|
};
|
|
enum vm_regan_acttype {
|
|
VM_REGAN_ACT_GET = 0,
|
|
VM_REGAN_ACT_SET = 1,
|
|
};
|
|
|
|
#if VM_COLLECT_USAGE_DETAILS
|
|
#define COLLECT_USAGE_REGISTER_HELPER(a, b, v) \
|
|
(COLLECT_USAGE_REGISTER((VM_REGAN_##a), (VM_REGAN_ACT_##b)), (v))
|
|
#else
|
|
#define COLLECT_USAGE_REGISTER_HELPER(a, b, v) (v)
|
|
#endif
|
|
|
|
/* PC */
|
|
#define GET_PC() (COLLECT_USAGE_REGISTER_HELPER(PC, GET, REG_PC))
|
|
#define SET_PC(x) (REG_PC = (COLLECT_USAGE_REGISTER_HELPER(PC, SET, (x))))
|
|
#define GET_CURRENT_INSN() (*GET_PC())
|
|
#define GET_OPERAND(n) (GET_PC()[(n)])
|
|
#define ADD_PC(n) (SET_PC(REG_PC + (n)))
|
|
|
|
#define GET_PC_COUNT() (REG_PC - GET_ISEQ()->iseq_encoded)
|
|
#define JUMP(dst) (REG_PC += (dst))
|
|
|
|
/* frame pointer, environment pointer */
|
|
#define GET_CFP() (COLLECT_USAGE_REGISTER_HELPER(CFP, GET, REG_CFP))
|
|
#define GET_EP() (COLLECT_USAGE_REGISTER_HELPER(EP, GET, REG_EP))
|
|
#define SET_EP(x) (REG_EP = (COLLECT_USAGE_REGISTER_HELPER(EP, SET, (x))))
|
|
#define GET_LEP() (VM_EP_LEP(GET_EP()))
|
|
|
|
/* SP */
|
|
#define GET_SP() (COLLECT_USAGE_REGISTER_HELPER(SP, GET, REG_SP))
|
|
#define SET_SP(x) (REG_SP = (COLLECT_USAGE_REGISTER_HELPER(SP, SET, (x))))
|
|
#define INC_SP(x) (REG_SP += (COLLECT_USAGE_REGISTER_HELPER(SP, SET, (x))))
|
|
#define DEC_SP(x) (REG_SP -= (COLLECT_USAGE_REGISTER_HELPER(SP, SET, (x))))
|
|
#define SET_SV(x) (*GET_SP() = (x))
|
|
/* set current stack value as x */
|
|
|
|
#define GET_SP_COUNT() (REG_SP - th->stack)
|
|
|
|
/* instruction sequence C struct */
|
|
#define GET_ISEQ() (GET_CFP()->iseq)
|
|
|
|
/**********************************************************/
|
|
/* deal with variables */
|
|
/**********************************************************/
|
|
|
|
#define GET_PREV_EP(ep) ((VALUE *)((ep)[0] & ~0x03))
|
|
|
|
#define GET_GLOBAL(entry) rb_gvar_get((struct rb_global_entry*)(entry))
|
|
#define SET_GLOBAL(entry, val) rb_gvar_set((struct rb_global_entry*)(entry), (val))
|
|
|
|
#define GET_CONST_INLINE_CACHE(dst) ((IC) * (GET_PC() + (dst) + 2))
|
|
|
|
/**********************************************************/
|
|
/* deal with values */
|
|
/**********************************************************/
|
|
|
|
#define GET_SELF() (COLLECT_USAGE_REGISTER_HELPER(SELF, GET, GET_CFP()->self))
|
|
|
|
/**********************************************************/
|
|
/* deal with control flow 2: method/iterator */
|
|
/**********************************************************/
|
|
|
|
#define COPY_CREF_OMOD(c1, c2) do { \
|
|
(c1)->nd_omod = (c2)->nd_omod; \
|
|
if (!NIL_P((c2)->nd_omod)) { \
|
|
(c1)->flags |= NODE_FL_CREF_OMOD_SHARED; \
|
|
(c2)->flags |= NODE_FL_CREF_OMOD_SHARED; \
|
|
} \
|
|
} while (0)
|
|
|
|
#define COPY_CREF(c1, c2) do { \
|
|
NODE *__tmp_c2 = (c2); \
|
|
COPY_CREF_OMOD(c1, __tmp_c2); \
|
|
(c1)->nd_clss = __tmp_c2->nd_clss; \
|
|
(c1)->nd_visi = __tmp_c2->nd_visi;\
|
|
(c1)->nd_next = __tmp_c2->nd_next; \
|
|
if (__tmp_c2->flags & NODE_FL_CREF_PUSHED_BY_EVAL) { \
|
|
(c1)->flags |= NODE_FL_CREF_PUSHED_BY_EVAL; \
|
|
} \
|
|
} while (0)
|
|
|
|
#define CALL_METHOD(num, blockptr, flag, id, me, recv, defined_class) do { \
|
|
VALUE v = vm_call_method(th, GET_CFP(), (num), (blockptr), (flag), (id), (me), (recv), (defined_class)); \
|
|
if (v == Qundef) { \
|
|
RESTORE_REGS(); \
|
|
NEXT_INSN(); \
|
|
} \
|
|
else { \
|
|
val = v; \
|
|
} \
|
|
} while (0)
|
|
|
|
#define GET_BLOCK_PTR() ((rb_block_t *)(GC_GUARDED_PTR_REF(GET_LEP()[0])))
|
|
|
|
/**********************************************************/
|
|
/* deal with control flow 3: exception */
|
|
/**********************************************************/
|
|
|
|
|
|
/**********************************************************/
|
|
/* others */
|
|
/**********************************************************/
|
|
|
|
/* optimize insn */
|
|
#define FIXNUM_REDEFINED_OP_FLAG (1 << 0)
|
|
#define FLOAT_REDEFINED_OP_FLAG (1 << 1)
|
|
#define STRING_REDEFINED_OP_FLAG (1 << 2)
|
|
#define ARRAY_REDEFINED_OP_FLAG (1 << 3)
|
|
#define HASH_REDEFINED_OP_FLAG (1 << 4)
|
|
#define BIGNUM_REDEFINED_OP_FLAG (1 << 5)
|
|
#define SYMBOL_REDEFINED_OP_FLAG (1 << 6)
|
|
#define TIME_REDEFINED_OP_FLAG (1 << 7)
|
|
|
|
#define BASIC_OP_UNREDEFINED_P(op, klass) (LIKELY((ruby_vm_redefined_flag[(op)]&(klass)) == 0))
|
|
|
|
#define FIXNUM_2_P(a, b) ((a) & (b) & 1)
|
|
#if USE_FLONUM
|
|
#define FLONUM_2_P(a, b) (((((a)^2) | ((b)^2)) & 3) == 0) /* (FLONUM_P(a) && FLONUM_P(b)) */
|
|
#else
|
|
#define FLONUM_2_P(a, b) 0
|
|
#endif
|
|
#define HEAP_CLASS_OF(obj) (RBASIC(obj)->klass)
|
|
|
|
#ifndef USE_IC_FOR_SPECIALIZED_METHOD
|
|
#define USE_IC_FOR_SPECIALIZED_METHOD 1
|
|
#endif
|
|
|
|
#if USE_IC_FOR_SPECIALIZED_METHOD
|
|
|
|
#define CALL_SIMPLE_METHOD(num, id, recv) do { \
|
|
VALUE klass = CLASS_OF(recv), defined_class; \
|
|
const rb_method_entry_t *me = vm_method_search((id), klass, ic, &defined_class); \
|
|
CALL_METHOD((num), 0, 0, (id), me, (recv), defined_class); \
|
|
} while (0)
|
|
|
|
#else
|
|
|
|
#define CALL_SIMPLE_METHOD(num, id, recv) do { \
|
|
VALUE klass = CLASS_OF(recv); \
|
|
CALL_METHOD((num), 0, 0, (id), rb_method_entry(klass, (id)), (recv)); \
|
|
} while (0)
|
|
|
|
#endif
|
|
|
|
static VALUE ruby_vm_global_state_version = 1;
|
|
|
|
#define GET_VM_STATE_VERSION() (ruby_vm_global_state_version)
|
|
#define INC_VM_STATE_VERSION() do { \
|
|
ruby_vm_global_state_version = (ruby_vm_global_state_version + 1); \
|
|
if (ruby_vm_global_state_version == 0) vm_clear_all_cache(); \
|
|
} while (0)
|
|
static void vm_clear_all_cache(void);
|
|
|
|
static VALUE make_no_method_exception(VALUE exc, const char *format,
|
|
VALUE obj, int argc, const VALUE *argv);
|
|
|
|
|
|
#endif /* RUBY_INSNHELPER_H */
|