12 #ifndef RUBY_VM_CORE_H
13 #define RUBY_VM_CORE_H
15 #define RUBY_VM_THREAD_MODEL 2
29 #elif defined(HAVE_PTHREAD_H)
32 #error "unsupported thread type"
35 #ifndef ENABLE_VM_OBJSPACE
44 #define ENABLE_VM_OBJSPACE 0
46 #define ENABLE_VM_OBJSPACE 1
54 # define NSIG (_SIGMAX + 1)
57 #define RUBY_NSIG NSIG
59 #ifdef HAVE_STDARG_PROTOTYPES
61 #define va_init_list(a,b) va_start((a),(b))
64 #define va_init_list(a,b) va_start((a))
67 #if defined(SIGSEGV) && defined(HAVE_SIGALTSTACK) && defined(SA_SIGINFO) && !defined(__NetBSD__)
68 #define USE_SIGALTSTACK
76 #if defined(__GNUC__) && __GNUC__ >= 2
78 #if OPT_TOKEN_THREADED_CODE
79 #if OPT_DIRECT_THREADED_CODE
80 #undef OPT_DIRECT_THREADED_CODE
87 #if OPT_DIRECT_THREADED_CODE
88 #undef OPT_DIRECT_THREADED_CODE
90 #if OPT_TOKEN_THREADED_CODE
91 #undef OPT_TOKEN_THREADED_CODE
96 #if OPT_CALL_THREADED_CODE
97 #if OPT_DIRECT_THREADED_CODE
98 #undef OPT_DIRECT_THREADED_CODE
100 #if OPT_STACK_CACHING
101 #undef OPT_STACK_CACHING
107 #define LIKELY(x) (__builtin_expect((x), 1))
108 #define UNLIKELY(x) (__builtin_expect((x), 0))
110 #define LIKELY(x) (x)
111 #define UNLIKELY(x) (x)
115 #define UNINITIALIZED_VAR(x) x = x
117 #define UNINITIALIZED_VAR(x) x
139 #define GetCoreDataFromValue(obj, type, ptr) do { \
140 (ptr) = (type*)DATA_PTR(obj); \
143 #define GetCoreDataFromValue(obj, type, ptr) Data_Get_Struct((obj), type, (ptr))
146 #define GetISeqPtr(obj, ptr) \
147 GetCoreDataFromValue((obj), rb_iseq_t, (ptr))
269 #define GetVMPtr(obj, ptr) \
270 GetCoreDataFromValue((obj), rb_vm_t, (ptr))
272 #if defined(ENABLE_VM_OBJSPACE) && ENABLE_VM_OBJSPACE
321 #if defined(ENABLE_VM_OBJSPACE) && ENABLE_VM_OBJSPACE
356 #define GetThreadPtr(obj, ptr) \
357 TypedData_Get_Struct((obj), rb_thread_t, &ruby_threadptr_data_type, (ptr))
388 #define ALT_STACK_SIZE (SIGSTKSZ*2)
390 #define ALT_STACK_SIZE (4*1024)
467 VALUE *machine_register_stack_start;
468 VALUE *machine_register_stack_end;
469 size_t machine_register_stack_maxsize;
490 #ifdef USE_SIGALTSTACK
497 #if defined __GNUC__ && __GNUC__ >= 4
498 #pragma GCC visibility push(default)
516 #if defined __GNUC__ && __GNUC__ >= 4
517 #pragma GCC visibility pop
521 #define RUBY_VM_THREAD_STACK_SIZE (128 * 1024)
523 #define GetProcPtr(obj, ptr) \
524 GetCoreDataFromValue((obj), rb_proc_t, (ptr))
536 #define GetEnvPtr(obj, ptr) \
537 GetCoreDataFromValue((obj), rb_env_t, (ptr))
547 #define GetBindingPtr(obj, ptr) \
548 GetCoreDataFromValue((obj), rb_binding_t, (ptr))
557 #define VM_CALL_ARGS_SPLAT_BIT (0x01 << 1)
558 #define VM_CALL_ARGS_BLOCKARG_BIT (0x01 << 2)
559 #define VM_CALL_FCALL_BIT (0x01 << 3)
560 #define VM_CALL_VCALL_BIT (0x01 << 4)
561 #define VM_CALL_TAILCALL_BIT (0x01 << 5)
562 #define VM_CALL_TAILRECURSION_BIT (0x01 << 6)
563 #define VM_CALL_SUPER_BIT (0x01 << 7)
564 #define VM_CALL_OPT_SEND_BIT (0x01 << 8)
572 #define VM_FRAME_MAGIC_METHOD 0x11
573 #define VM_FRAME_MAGIC_BLOCK 0x21
574 #define VM_FRAME_MAGIC_CLASS 0x31
575 #define VM_FRAME_MAGIC_TOP 0x41
576 #define VM_FRAME_MAGIC_FINISH 0x51
577 #define VM_FRAME_MAGIC_CFUNC 0x61
578 #define VM_FRAME_MAGIC_PROC 0x71
579 #define VM_FRAME_MAGIC_IFUNC 0x81
580 #define VM_FRAME_MAGIC_EVAL 0x91
581 #define VM_FRAME_MAGIC_LAMBDA 0xa1
582 #define VM_FRAME_MAGIC_MASK_BITS 8
583 #define VM_FRAME_MAGIC_MASK (~(~0<<VM_FRAME_MAGIC_MASK_BITS))
585 #define VM_FRAME_TYPE(cfp) ((cfp)->flag & VM_FRAME_MAGIC_MASK)
588 #define VM_FRAME_FLAG_PASSED 0x0100
590 #define RUBYVM_CFUNC_FRAME_P(cfp) \
591 (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
600 #ifndef FUNC_FASTCALL
601 #define FUNC_FASTCALL(x) x
607 #define GC_GUARDED_PTR(p) ((VALUE)((VALUE)(p) | 0x01))
608 #define GC_GUARDED_PTR_REF(p) ((void *)(((VALUE)(p)) & ~0x03))
609 #define GC_GUARDED_PTR_P(p) (((VALUE)(p)) & 0x01)
611 #define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) ((cfp)+1)
612 #define RUBY_VM_NEXT_CONTROL_FRAME(cfp) ((cfp)-1)
613 #define RUBY_VM_END_CONTROL_FRAME(th) \
614 ((rb_control_frame_t *)((th)->stack + (th)->stack_size))
615 #define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
616 ((void *)(ecfp) > (void *)(cfp))
617 #define RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(th, cfp) \
618 (!RUBY_VM_VALID_CONTROL_FRAME_P((cfp), RUBY_VM_END_CONTROL_FRAME(th)))
620 #define RUBY_VM_IFUNC_P(ptr) (BUILTIN_TYPE(ptr) == T_NODE)
621 #define RUBY_VM_NORMAL_ISEQ_P(ptr) \
622 ((ptr) && !RUBY_VM_IFUNC_P(ptr))
624 #define RUBY_VM_GET_BLOCK_PTR_IN_CFP(cfp) ((rb_block_t *)(&(cfp)->self))
625 #define RUBY_VM_GET_CFP_FROM_BLOCK_PTR(b) \
626 ((rb_control_frame_t *)((VALUE *)(b) - 5))
634 #define SDR() rb_vmdebug_stack_dump_raw(GET_THREAD(), GET_THREAD()->cfp)
635 #define SDR2(cfp) rb_vmdebug_stack_dump_raw(GET_THREAD(), (cfp))
639 #if defined __GNUC__ && __GNUC__ >= 4
640 #pragma GCC visibility push(default)
646 #if defined __GNUC__ && __GNUC__ >= 4
647 #pragma GCC visibility pop
681 #define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
685 #if RUBY_VM_THREAD_MODEL == 2
689 #define GET_VM() ruby_current_vm
690 #define GET_THREAD() ruby_current_thread
691 #define rb_thread_set_current_raw(th) (void)(ruby_current_thread = (th))
692 #define rb_thread_set_current(th) do { \
693 if ((th)->vm->running_thread != (th)) { \
694 (th)->vm->running_thread->running_time_us = 0; \
696 rb_thread_set_current_raw(th); \
697 (th)->vm->running_thread = (th); \
701 #error "unsupported thread model"
704 #define RUBY_VM_SET_TIMER_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, 0x01)
705 #define RUBY_VM_SET_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, 0x02)
706 #define RUBY_VM_SET_FINALIZER_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, 0x04)
707 #define RUBY_VM_INTERRUPTED(th) ((th)->interrupt_flag & 0x02)
721 #define RUBY_VM_CHECK_INTS_TH(th) do { \
722 if (UNLIKELY((th)->interrupt_flag)) { \
723 rb_threadptr_execute_interrupts(th); \
727 #define RUBY_VM_CHECK_INTS() \
728 RUBY_VM_CHECK_INTS_TH(GET_THREAD())
734 #define EXEC_EVENT_HOOK_ORIG(th, flag, self, id, klass, pop_p) do { \
735 rb_event_flag_t wait_event__ = (th)->event_flags; \
736 if (UNLIKELY(wait_event__)) { \
737 if (wait_event__ & ((flag) | RUBY_EVENT_VM)) { \
738 rb_threadptr_exec_event_hooks((th), (flag), (self), (id), (klass), (pop_p)); \
743 #define EXEC_EVENT_HOOK(th, flag, self, id, klass) \
744 EXEC_EVENT_HOOK_ORIG(th, flag, self, id, klass, 0)
746 #define EXEC_EVENT_HOOK_AND_POP_FRAME(th, flag, self, id, klass) \
747 EXEC_EVENT_HOOK_ORIG(th, flag, self, id, klass, 1)
749 #if defined __GNUC__ && __GNUC__ >= 4
750 #pragma GCC visibility push(default)
759 #if defined __GNUC__ && __GNUC__ >= 4
760 #pragma GCC visibility pop
const rb_block_t * passed_block
void rb_objspace_free(struct rb_objspace *)
void rb_vm_bugreport(void)
unsigned long running_time_us
VALUE rb_get_coverages(void)
void rb_threadptr_signal_raise(rb_thread_t *th, int sig)
VALUE rb_iseq_new_with_bopt(NODE *, VALUE, VALUE, VALUE, VALUE, VALUE, enum iseq_type, VALUE)
rb_control_frame_t * rb_vm_get_ruby_level_next_cfp(rb_thread_t *th, rb_control_frame_t *cfp)
struct rb_vm_protect_tag * protect_tag
struct rb_thread_struct * running_thread
void rb_vm_rewrite_dfp_in_errinfo(rb_thread_t *th)
void rb_threadptr_unlock_all_locking_mutexes(rb_thread_t *th)
VALUE rb_proc_alloc(VALUE klass)
NOINLINE(void rb_gc_save_machine_context(rb_thread_t *))
const rb_method_entry_t * passed_me
rb_thread_lock_t interrupt_lock
pthread_mutex_t rb_thread_lock_t
void rb_unblock_function_t(void *)
void rb_thread_start_timer_thread(void)
rb_unblock_function_t * func
struct iseq_compile_data * compile_data
void rb_threadptr_execute_interrupts(rb_thread_t *)
RUBY_EXTERN VALUE rb_cRubyVM
VALUE rb_thread_alloc(VALUE klass)
void rb_unlink_method_entry(rb_method_entry_t *me)
VALUE rb_vm_make_env_object(rb_thread_t *th, rb_control_frame_t *cfp)
int rb_iseq_disasm_insn(VALUE str, VALUE *iseqval, size_t pos, rb_iseq_t *iseq, VALUE child)
Disassemble a instruction Iseq -> Iseq inspect object.
st_table * living_threads
void rb_gc_save_machine_context(rb_thread_t *th)
rb_vm_t * ruby_current_vm
struct rb_thread_struct * join_list_head
void ruby_thread_init_stack(rb_thread_t *th)
struct rb_iseq_struct * local_iseq
struct rb_vm_protect_tag * prev
VALUE rb_iseq_eval(VALUE iseqval)
struct iseq_inline_cache_entry * ic_entries
void rb_thread_lock_destroy(rb_thread_lock_t *)
RUBY_EXTERN VALUE rb_cEnv
rb_event_flag_t event_flags
RUBY_EXTERN rb_thread_t * ruby_current_thread
void rb_vmdebug_stack_dump_raw(rb_thread_t *, rb_control_frame_t *)
void rb_vm_stack_to_heap(rb_thread_t *th)
const rb_method_entry_t * me
void rb_thread_stop_timer_thread(int)
int rb_thread_method_id_and_class(rb_thread_t *th, ID *idp, VALUE *klassp)
struct rb_vm_struct::@75 trap_list[RUBY_NSIG]
VALUE(* first_func)(ANYARGS)
enum rb_iseq_struct::iseq_type type
void rb_thread_reset_timer_thread(void)
void rb_thread_wakeup_timer_thread(void)
VALUE rb_make_backtrace(void)
void rb_gc_mark_machine_stack(rb_thread_t *th)
void rb_signal_exec(rb_thread_t *th, int sig)
struct rb_vm_struct rb_vm_t
void * blocking_region_buffer
int rb_thread_check_trap_pending(void)
int argc
argument information
rb_event_hook_t * event_hooks
rb_event_hook_t * event_hooks
int thread_abort_on_exception
struct unlinked_method_entry_list_entry * unlinked_method_entry_list
struct st_table * loading_table
void rb_threadptr_signal_exit(rb_thread_t *th)
unsigned int rb_event_flag_t
VALUE * machine_stack_start
union iseq_inline_cache_entry::@74 ic_value
int rb_signal_buff_size(void)
const char * ruby_node_name(int node)
rb_method_entry_t * method
void rb_thread_lock_unlock(rb_thread_lock_t *)
VALUE special_exceptions[ruby_special_error_count]
VALUE rb_vm_make_proc(rb_thread_t *th, const rb_block_t *block, VALUE klass)
struct rb_mutex_struct * keeping_mutexes
VALUE rb_iseq_compile_with_option(VALUE src, VALUE file, VALUE filepath, VALUE line, VALUE opt)
void rb_disable_interrupt(void)
struct rb_iseq_struct * parent_iseq
VALUE rb_iseq_compile(VALUE src, VALUE file, VALUE line)
const rb_data_type_t ruby_threadptr_data_type
struct rb_thread_struct * main_thread
VALUE rb_iseq_new(NODE *, VALUE, VALUE, VALUE, VALUE, enum iseq_type)
rb_atomic_t interrupt_flag
int rb_backtrace_iter_func(void *, VALUE, int, VALUE)
enum rb_thread_status status
VALUE rb_vm_invoke_proc(rb_thread_t *th, rb_proc_t *proc, VALUE self, int argc, const VALUE *argv, const rb_block_t *blockptr)
struct rb_block_struct rb_block_t
void rb_vm_change_state(void)
int inhibit_thread_creation
VALUE * machine_stack_end
int rb_backtrace_each(rb_backtrace_iter_func *iter, void *arg)
void rb_vm_gvl_destroy(rb_vm_t *vm)
struct rb_objspace * objspace
struct rb_thread_struct * join_list_next
void rb_threadptr_interrupt(rb_thread_t *th)
struct rb_unblock_callback unblock
void rb_threadptr_exec_event_hooks(rb_thread_t *th, rb_event_flag_t flag, VALUE self, ID id, VALUE klass, int pop_p)
struct iseq_catch_table_entry * catch_table
rb_control_frame_t *FUNC_FASTCALL rb_insn_func_t(rb_thread_t *, rb_control_frame_t *)
void rb_set_coverages(VALUE)
struct iseq_inline_cache_entry * IC
void rb_gc_mark_unlinked_live_method_entries(void *pvm)
native_thread_data_t native_thread_data
VALUE rb_iseq_new_top(NODE *node, VALUE name, VALUE filename, VALUE filepath, VALUE parent)
VALUE rb_iseq_new_main(NODE *node, VALUE filename, VALUE filepath)
VALUE rb_iseq_disasm(VALUE self)
void rb_reset_coverages(void)
int rb_vm_get_sourceline(const rb_control_frame_t *)
void rb_vm_inc_const_missing_count(void)
VALUE rb_iseq_new_with_opt(NODE *, VALUE, VALUE, VALUE, VALUE, VALUE, enum iseq_type, const rb_compile_option_t *)
struct rb_thread_struct rb_thread_t
int rb_iseq_first_lineno(rb_iseq_t *iseq)
struct iseq_insn_info_entry * insn_info_table
void rb_threadptr_check_signal(rb_thread_t *mth)
RUBY_EXTERN VALUE rb_mRubyVMFrozenCore
size_t machine_stack_maxsize
int method_missing_reason
void rb_enable_interrupt(void)
VALUE rb_iseq_eval_main(VALUE iseqval)
VALUE rb_name_err_mesg_new(VALUE obj, VALUE mesg, VALUE recv, VALUE method)
RUBY_EXTERN VALUE rb_cISeq
int ruby_thread_has_gvl_p(void)
VALUE rb_vm_call(rb_thread_t *th, VALUE recv, VALUE id, int argc, const VALUE *argv, const rb_method_entry_t *me)