1 #ifndef RUBY_INSNHELPER_H
2 #define RUBY_INSNHELPER_H
14 MJIT_SYMBOL_EXPORT_BEGIN
17 RUBY_EXTERN rb_serial_t ruby_vm_global_constant_state;
21 MJIT_SYMBOL_EXPORT_END
23 #if VM_COLLECT_USAGE_DETAILS
24 #define COLLECT_USAGE_INSN(insn) vm_collect_usage_insn(insn)
25 #define COLLECT_USAGE_OPERAND(insn, n, op) vm_collect_usage_operand((insn), (n), ((VALUE)(op)))
27 #define COLLECT_USAGE_REGISTER(reg, s) vm_collect_usage_register((reg), (s))
30 #define COLLECT_USAGE_INSN(insn) rb_yjit_collect_vm_usage_insn(insn)
31 #define COLLECT_USAGE_OPERAND(insn, n, op)
32 #define COLLECT_USAGE_REGISTER(reg, s)
34 #define COLLECT_USAGE_INSN(insn)
35 #define COLLECT_USAGE_OPERAND(insn, n, op)
36 #define COLLECT_USAGE_REGISTER(reg, s)
43 #define PUSH(x) (SET_SV(x), INC_SP(1))
44 #define TOPN(n) (*(GET_SP()-(n)-1))
45 #define POPN(n) (DEC_SP(n))
46 #define POP() (DEC_SP(1))
47 #define STACK_ADDR_FROM_TOP(n) (GET_SP()-(n))
53 #define VM_REG_CFP (reg_cfp)
54 #define VM_REG_PC (VM_REG_CFP->pc)
55 #define VM_REG_SP (VM_REG_CFP->sp)
56 #define VM_REG_EP (VM_REG_CFP->ep)
58 #define RESTORE_REGS() do { \
59 VM_REG_CFP = ec->cfp; \
62 #if VM_COLLECT_USAGE_DETAILS
63 enum vm_regan_regtype {
71 enum vm_regan_acttype {
76 #define COLLECT_USAGE_REGISTER_HELPER(a, b, v) \
77 (COLLECT_USAGE_REGISTER((VM_REGAN_##a), (VM_REGAN_ACT_##b)), (v))
79 #define COLLECT_USAGE_REGISTER_HELPER(a, b, v) (v)
83 #define GET_PC() (COLLECT_USAGE_REGISTER_HELPER(PC, GET, VM_REG_PC))
84 #define SET_PC(x) (VM_REG_PC = (COLLECT_USAGE_REGISTER_HELPER(PC, SET, (x))))
85 #define GET_CURRENT_INSN() (*GET_PC())
86 #define GET_OPERAND(n) (GET_PC()[(n)])
87 #define ADD_PC(n) (SET_PC(VM_REG_PC + (n)))
88 #define JUMP(dst) (SET_PC(VM_REG_PC + (dst)))
91 #define GET_CFP() (COLLECT_USAGE_REGISTER_HELPER(CFP, GET, VM_REG_CFP))
92 #define GET_EP() (COLLECT_USAGE_REGISTER_HELPER(EP, GET, VM_REG_EP))
93 #define SET_EP(x) (VM_REG_EP = (COLLECT_USAGE_REGISTER_HELPER(EP, SET, (x))))
94 #define GET_LEP() (VM_EP_LEP(GET_EP()))
97 #define GET_SP() (COLLECT_USAGE_REGISTER_HELPER(SP, GET, VM_REG_SP))
98 #define SET_SP(x) (VM_REG_SP = (COLLECT_USAGE_REGISTER_HELPER(SP, SET, (x))))
99 #define INC_SP(x) (VM_REG_SP += (COLLECT_USAGE_REGISTER_HELPER(SP, SET, (x))))
100 #define DEC_SP(x) (VM_REG_SP -= (COLLECT_USAGE_REGISTER_HELPER(SP, SET, (x))))
101 #define SET_SV(x) (*GET_SP() = rb_ractor_confirm_belonging(x))
105 #define GET_ISEQ() (GET_CFP()->iseq)
111 #define GET_PREV_EP(ep) ((VALUE *)((ep)[VM_ENV_DATA_INDEX_SPECVAL] & ~0x03))
117 #define GET_SELF() (COLLECT_USAGE_REGISTER_HELPER(SELF, GET, GET_CFP()->self))
128 CC_SET_FASTPATH(
const struct rb_callcache *cc, vm_call_handler func,
bool enabled)
130 if (LIKELY(enabled)) {
131 vm_cc_call_set(cc, func);
135 #define GET_BLOCK_HANDLER() (GET_LEP()[VM_ENV_DATA_INDEX_SPECVAL])
146 #if VM_CHECK_MODE > 0
147 #define SETUP_CANARY(cond) \
151 SET_SV(vm_stack_canary); \
156 #define CHECK_CANARY(cond, insn) \
158 if (*canary == vm_stack_canary) { \
162 rb_vm_canary_is_found_dead(insn, *canary); \
166 #define SETUP_CANARY(cond) if (cond) {} else {}
167 #define CHECK_CANARY(cond, insn) if (cond) {(void)(insn);}
175 #define CALL_SIMPLE_METHOD() do { \
176 rb_snum_t x = leaf ? INSN_ATTR(width) : 0; \
177 rb_snum_t y = attr_width_opt_send_without_block(0); \
178 rb_snum_t z = x - y; \
180 DISPATCH_ORIGINAL_INSN(opt_send_without_block); \
184 #define PREV_CLASS_SERIAL() (ruby_vm_class_serial)
185 #define NEXT_CLASS_SERIAL() (++ruby_vm_class_serial)
186 #define GET_GLOBAL_CONSTANT_STATE() (ruby_vm_global_constant_state)
187 #define INC_GLOBAL_CONSTANT_STATE() (++ruby_vm_global_constant_state)
188 #define GET_GLOBAL_CVAR_STATE() (ruby_vm_global_cvar_state)
189 #define INC_GLOBAL_CVAR_STATE() (++ruby_vm_global_cvar_state)
195 obj->throw_state = st;
202 VM_ASSERT(THROW_DATA_P(obj));
203 return obj->throw_obj;
209 VM_ASSERT(THROW_DATA_P(obj));
210 return obj->catch_frame;
216 VM_ASSERT(THROW_DATA_P(obj));
217 return obj->throw_state;
223 VM_ASSERT(THROW_DATA_P(obj));
224 return obj->flags & THROW_DATA_CONSUMED;
230 VM_ASSERT(THROW_DATA_P(obj));
231 obj->catch_frame = cfp;
237 VM_ASSERT(THROW_DATA_P(obj));
238 obj->throw_state = st;
244 if (THROW_DATA_P(obj) &&
245 THROW_DATA_STATE(obj) == TAG_BREAK) {
246 obj->flags |= THROW_DATA_CONSUMED;
250 #define IS_ARGS_SPLAT(ci) (vm_ci_flag(ci) & VM_CALL_ARGS_SPLAT)
251 #define IS_ARGS_KEYWORD(ci) (vm_ci_flag(ci) & VM_CALL_KWARG)
252 #define IS_ARGS_KW_SPLAT(ci) (vm_ci_flag(ci) & VM_CALL_KW_SPLAT)
253 #define IS_ARGS_KW_OR_KW_SPLAT(ci) (vm_ci_flag(ci) & (VM_CALL_KWARG | VM_CALL_KW_SPLAT))
254 #define IS_ARGS_KW_SPLAT_MUT(ci) (vm_ci_flag(ci) & VM_CALL_KW_SPLAT_MUT)
261 return !IS_ARGS_SPLAT(ci) && !IS_ARGS_KEYWORD(ci) &&
262 METHOD_ENTRY_CACHEABLE(vm_cc_cme(cc));
#define RUBY_EXTERN
Declaration of externally visible global variables.
uintptr_t VALUE
Type that represents a Ruby object.