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
95 #ifdef __native_client__
96 #undef OPT_DIRECT_THREADED_CODE
100 #if OPT_CALL_THREADED_CODE
101 #if OPT_DIRECT_THREADED_CODE
102 #undef OPT_DIRECT_THREADED_CODE
104 #if OPT_STACK_CACHING
105 #undef OPT_STACK_CACHING
111 #define LIKELY(x) (__builtin_expect((x), 1))
112 #define UNLIKELY(x) (__builtin_expect((x), 0))
114 #define LIKELY(x) (x)
115 #define UNLIKELY(x) (x)
119 #define UNINITIALIZED_VAR(x) x = x
121 #define UNINITIALIZED_VAR(x) x
176 #define GetCoreDataFromValue(obj, type, ptr) do { \
177 (ptr) = (type*)DATA_PTR(obj); \
180 #define GetCoreDataFromValue(obj, type, ptr) Data_Get_Struct((obj), type, (ptr))
183 #define GetISeqPtr(obj, ptr) \
184 GetCoreDataFromValue((obj), rb_iseq_t, (ptr))
323 #define GetVMPtr(obj, ptr) \
324 GetCoreDataFromValue((obj), rb_vm_t, (ptr))
326 #if defined(ENABLE_VM_OBJSPACE) && ENABLE_VM_OBJSPACE
386 #if defined(ENABLE_VM_OBJSPACE) && ENABLE_VM_OBJSPACE
409 #define RUBY_VM_SIZE_ALIGN 4096
411 #define RUBY_VM_THREAD_VM_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
412 #define RUBY_VM_THREAD_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
413 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
414 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
416 #define RUBY_VM_FIBER_VM_STACK_SIZE ( 16 * 1024 * sizeof(VALUE))
417 #define RUBY_VM_FIBER_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
418 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 64 * 1024 * sizeof(VALUE))
419 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
421 #ifndef VM_DEBUG_BP_CHECK
422 #define VM_DEBUG_BP_CHECK 0
437 #if VM_DEBUG_BP_CHECK
452 #define GetThreadPtr(obj, ptr) \
453 TypedData_Get_Struct((obj), rb_thread_t, &ruby_threadptr_data_type, (ptr))
545 #if OPT_CALL_THREADED_CODE
592 VALUE *machine_register_stack_start;
593 VALUE *machine_register_stack_end;
594 size_t machine_register_stack_maxsize;
614 #ifdef USE_SIGALTSTACK
628 #define VM_DEFINECLASS_TYPE(x) ((rb_vm_defineclass_type_t)(x) & VM_DEFINECLASS_TYPE_MASK)
629 #define VM_DEFINECLASS_FLAG_SCOPED 0x08
630 #define VM_DEFINECLASS_FLAG_HAS_SUPERCLASS 0x10
631 #define VM_DEFINECLASS_SCOPED_P(x) ((x) & VM_DEFINECLASS_FLAG_SCOPED)
632 #define VM_DEFINECLASS_HAS_SUPERCLASS_P(x) \
633 ((x) & VM_DEFINECLASS_FLAG_HAS_SUPERCLASS)
636 #if defined __GNUC__ && __GNUC__ >= 4
637 #pragma GCC visibility push(default)
661 #if defined __GNUC__ && __GNUC__ >= 4
662 #pragma GCC visibility pop
665 #define GetProcPtr(obj, ptr) \
666 GetCoreDataFromValue((obj), rb_proc_t, (ptr))
678 #define GetEnvPtr(obj, ptr) \
679 GetCoreDataFromValue((obj), rb_env_t, (ptr))
689 #define GetBindingPtr(obj, ptr) \
690 GetCoreDataFromValue((obj), rb_binding_t, (ptr))
706 #define VM_CHECKMATCH_TYPE_MASK 0x03
707 #define VM_CHECKMATCH_ARRAY 0x04
709 #define VM_CALL_ARGS_SPLAT (0x01 << 1)
710 #define VM_CALL_ARGS_BLOCKARG (0x01 << 2)
711 #define VM_CALL_FCALL (0x01 << 3)
712 #define VM_CALL_VCALL (0x01 << 4)
713 #define VM_CALL_TAILCALL (0x01 << 5)
714 #define VM_CALL_SUPER (0x01 << 6)
715 #define VM_CALL_OPT_SEND (0x01 << 7)
716 #define VM_CALL_ARGS_SKIP_SETUP (0x01 << 8)
724 #define VM_FRAME_MAGIC_METHOD 0x11
725 #define VM_FRAME_MAGIC_BLOCK 0x21
726 #define VM_FRAME_MAGIC_CLASS 0x31
727 #define VM_FRAME_MAGIC_TOP 0x41
728 #define VM_FRAME_MAGIC_CFUNC 0x61
729 #define VM_FRAME_MAGIC_PROC 0x71
730 #define VM_FRAME_MAGIC_IFUNC 0x81
731 #define VM_FRAME_MAGIC_EVAL 0x91
732 #define VM_FRAME_MAGIC_LAMBDA 0xa1
733 #define VM_FRAME_MAGIC_MASK_BITS 8
734 #define VM_FRAME_MAGIC_MASK (~(~0<<VM_FRAME_MAGIC_MASK_BITS))
736 #define VM_FRAME_TYPE(cfp) ((cfp)->flag & VM_FRAME_MAGIC_MASK)
739 #define VM_FRAME_FLAG_PASSED 0x0100
740 #define VM_FRAME_FLAG_FINISH 0x0200
741 #define VM_FRAME_TYPE_FINISH_P(cfp) (((cfp)->flag & VM_FRAME_FLAG_FINISH) != 0)
743 #define RUBYVM_CFUNC_FRAME_P(cfp) \
744 (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
754 #ifndef FUNC_FASTCALL
755 #define FUNC_FASTCALL(x) x
761 #define GC_GUARDED_PTR(p) ((VALUE)((VALUE)(p) | 0x01))
762 #define GC_GUARDED_PTR_REF(p) ((void *)(((VALUE)(p)) & ~0x03))
763 #define GC_GUARDED_PTR_P(p) (((VALUE)(p)) & 0x01)
774 #define VM_ENVVAL_BLOCK_PTR_FLAG 0x02
775 #define VM_ENVVAL_BLOCK_PTR(v) (GC_GUARDED_PTR(v) | VM_ENVVAL_BLOCK_PTR_FLAG)
776 #define VM_ENVVAL_BLOCK_PTR_P(v) ((v) & VM_ENVVAL_BLOCK_PTR_FLAG)
777 #define VM_ENVVAL_PREV_EP_PTR(v) ((VALUE)GC_GUARDED_PTR(v))
778 #define VM_ENVVAL_PREV_EP_PTR_P(v) (!(VM_ENVVAL_BLOCK_PTR_P(v)))
780 #define VM_EP_PREV_EP(ep) ((VALUE *)GC_GUARDED_PTR_REF((ep)[0]))
781 #define VM_EP_BLOCK_PTR(ep) ((rb_block_t *)GC_GUARDED_PTR_REF((ep)[0]))
782 #define VM_EP_LEP_P(ep) VM_ENVVAL_BLOCK_PTR_P((ep)[0])
787 #define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) ((cfp)+1)
788 #define RUBY_VM_NEXT_CONTROL_FRAME(cfp) ((cfp)-1)
789 #define RUBY_VM_END_CONTROL_FRAME(th) \
790 ((rb_control_frame_t *)((th)->stack + (th)->stack_size))
791 #define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
792 ((void *)(ecfp) > (void *)(cfp))
793 #define RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(th, cfp) \
794 (!RUBY_VM_VALID_CONTROL_FRAME_P((cfp), RUBY_VM_END_CONTROL_FRAME(th)))
796 #define RUBY_VM_IFUNC_P(ptr) (BUILTIN_TYPE(ptr) == T_NODE)
797 #define RUBY_VM_NORMAL_ISEQ_P(ptr) \
798 ((ptr) && !RUBY_VM_IFUNC_P(ptr))
800 #define RUBY_VM_GET_BLOCK_PTR_IN_CFP(cfp) ((rb_block_t *)(&(cfp)->self))
801 #define RUBY_VM_GET_CFP_FROM_BLOCK_PTR(b) \
802 ((rb_control_frame_t *)((VALUE *)(b) - 4))
814 #define SDR() rb_vmdebug_stack_dump_raw(GET_THREAD(), GET_THREAD()->cfp)
815 #define SDR2(cfp) rb_vmdebug_stack_dump_raw(GET_THREAD(), (cfp))
819 #if defined __GNUC__ && __GNUC__ >= 4
820 #pragma GCC visibility push(default)
824 #if defined __GNUC__ && __GNUC__ >= 4
825 #pragma GCC visibility pop
838 VALUE defined_class);
861 #define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
863 #define CHECK_VM_STACK_OVERFLOW(cfp, margin) do \
864 if ((VALUE *)((char *)(((VALUE *)(cfp)->sp) + (margin)) + sizeof(rb_control_frame_t)) >= ((VALUE *)(cfp))) { \
865 vm_stackoverflow(); \
871 #if RUBY_VM_THREAD_MODEL == 2
876 #define GET_VM() ruby_current_vm
878 #ifndef OPT_CALL_CFUNC_WITHOUT_FRAME
879 #define OPT_CALL_CFUNC_WITHOUT_FRAME 0
886 #if OPT_CALL_CFUNC_WITHOUT_FRAME
889 vm_call_cfunc_push_frame(th);
895 #define rb_thread_set_current_raw(th) (void)(ruby_current_thread = (th))
896 #define rb_thread_set_current(th) do { \
897 if ((th)->vm->running_thread != (th)) { \
898 (th)->running_time_us = 0; \
900 rb_thread_set_current_raw(th); \
901 (th)->vm->running_thread = (th); \
905 #error "unsupported thread model"
915 #define RUBY_VM_SET_TIMER_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, TIMER_INTERRUPT_MASK)
916 #define RUBY_VM_SET_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, PENDING_INTERRUPT_MASK)
917 #define RUBY_VM_SET_FINALIZER_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, FINALIZER_INTERRUPT_MASK)
918 #define RUBY_VM_SET_TRAP_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, TRAP_INTERRUPT_MASK)
919 #define RUBY_VM_INTERRUPTED(th) ((th)->interrupt_flag & ~(th)->interrupt_mask & (PENDING_INTERRUPT_MASK|TRAP_INTERRUPT_MASK))
920 #define RUBY_VM_INTERRUPTED_ANY(th) ((th)->interrupt_flag & ~(th)->interrupt_mask)
937 #define RUBY_VM_CHECK_INTS_BLOCKING(th) do { \
938 if (UNLIKELY(!rb_threadptr_pending_interrupt_empty_p(th))) { \
939 th->pending_interrupt_queue_checked = 0; \
940 RUBY_VM_SET_INTERRUPT(th); \
941 rb_threadptr_execute_interrupts(th, 1); \
943 else if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(th))) { \
944 rb_threadptr_execute_interrupts(th, 1); \
948 #define RUBY_VM_CHECK_INTS(th) do { \
949 if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(th))) { \
950 rb_threadptr_execute_interrupts(th, 0); \
974 #define EXEC_EVENT_HOOK_ORIG(th_, flag_, self_, id_, klass_, data_, pop_p_) do { \
975 if (UNLIKELY(ruby_vm_event_flags & (flag_))) { \
976 if (((th)->event_hooks.events | (th)->vm->event_hooks.events) & (flag_)) { \
977 struct rb_trace_arg_struct trace_arg; \
978 trace_arg.event = (flag_); \
979 trace_arg.th = (th_); \
980 trace_arg.cfp = (trace_arg.th)->cfp; \
981 trace_arg.self = (self_); \
982 trace_arg.id = (id_); \
983 trace_arg.klass = (klass_); \
984 trace_arg.data = (data_); \
985 trace_arg.path = Qundef; \
986 trace_arg.klass_solved = 0; \
987 if (pop_p_) rb_threadptr_exec_event_hooks_and_pop_frame(&trace_arg); \
988 else rb_threadptr_exec_event_hooks(&trace_arg); \
993 #define EXEC_EVENT_HOOK(th_, flag_, self_, id_, klass_, data_) \
994 EXEC_EVENT_HOOK_ORIG(th_, flag_, self_, id_, klass_, data_, 0)
996 #define EXEC_EVENT_HOOK_AND_POP_FRAME(th_, flag_, self_, id_, klass_, data_) \
997 EXEC_EVENT_HOOK_ORIG(th_, flag_, self_, id_, klass_, data_, 1)
999 #if defined __GNUC__ && __GNUC__ >= 4
1000 #pragma GCC visibility push(default)
1009 #if defined __GNUC__ && __GNUC__ >= 4
1010 #pragma GCC visibility pop
const rb_block_t * passed_block
void rb_objspace_free(struct rb_objspace *)
rb_thread_list_t * join_list
struct rb_block_struct * blockptr
void rb_vm_bugreport(void)
unsigned long running_time_us
VALUE rb_get_coverages(void)
void rb_threadptr_pending_interrupt_clear(rb_thread_t *th)
void rb_threadptr_signal_raise(rb_thread_t *th, int sig)
rb_block_t * rb_vm_control_frame_block_ptr(rb_control_frame_t *cfp)
VALUE rb_iseq_new_with_bopt(NODE *, VALUE, VALUE, VALUE, VALUE, VALUE, enum iseq_type, VALUE)
struct rb_vm_protect_tag * protect_tag
struct rb_thread_struct * running_thread
void rb_threadptr_unlock_all_locking_mutexes(rb_thread_t *th)
int pending_interrupt_queue_checked
VALUE rb_proc_alloc(VALUE klass)
const rb_method_entry_t * passed_me
rb_thread_lock_t interrupt_lock
pthread_mutex_t rb_thread_lock_t
rb_thread_lock_t thread_destruct_lock
struct rb_thread_struct * th
void rb_thread_start_timer_thread(void)
rb_unblock_function_t * func
struct iseq_compile_data * compile_data
struct st_table * loaded_features_index
VALUE pending_interrupt_mask_stack
VALUE rb_iseq_new_top(NODE *node, VALUE name, VALUE path, VALUE absolute_path, VALUE parent)
RUBY_EXTERN VALUE rb_cRubyVM
VALUE rb_binding_new_with_cfp(rb_thread_t *th, const rb_control_frame_t *src_cfp)
VALUE rb_thread_alloc(VALUE klass)
rb_call_info_t * callinfo_entries
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_autoloading_value(VALUE mod, ID id, VALUE *value)
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
size_t fiber_machine_stack_size
VALUE(* call)(struct rb_thread_struct *th, struct rb_control_frame_struct *cfp, struct rb_call_info_struct *ci)
rb_vm_t * ruby_current_vm
void ruby_thread_init_stack(rb_thread_t *th)
struct rb_hook_list_struct rb_hook_list_t
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
struct rb_control_frame_struct rb_control_frame_t
void rb_thread_lock_destroy(rb_thread_lock_t *)
RUBY_EXTERN VALUE rb_cEnv
struct rb_thread_list_struct rb_thread_list_t
void rb_vmdebug_stack_dump_raw(rb_thread_t *, rb_control_frame_t *)
int rb_threadptr_pending_interrupt_active_p(rb_thread_t *th)
void rb_vm_stack_to_heap(rb_thread_t *th)
unsigned long rb_event_flag_t
void rb_thread_stop_timer_thread(int)
int rb_thread_method_id_and_class(rb_thread_t *th, ID *idp, VALUE *klassp)
VALUE rb_vm_call(rb_thread_t *th, VALUE recv, VALUE id, int argc, const VALUE *argv, const rb_method_entry_t *me, VALUE defined_class)
VALUE(* first_func)(ANYARGS)
enum rb_iseq_struct::iseq_type type
void rb_thread_reset_timer_thread(void)
unsigned short first_lineno
int rb_iseq_first_lineno(const rb_iseq_t *iseq)
void rb_thread_wakeup_timer_thread(void)
void rb_gc_mark_machine_stack(rb_thread_t *th)
int rb_vm_control_frame_id_and_class(const rb_control_frame_t *cfp, ID *idp, VALUE *klassp)
void rb_signal_exec(rb_thread_t *th, int sig)
size_t fiber_vm_stack_size
struct rb_vm_struct rb_vm_t
void * blocking_region_buffer
int rb_thread_check_trap_pending(void)
int argc
argument information
VALUE load_path_check_cache
void rb_threadptr_exec_event_hooks_and_pop_frame(struct rb_trace_arg_struct *trace_arg)
VALUE rb_iseq_new_main(NODE *node, VALUE path, VALUE absolute_path)
VALUE * rb_vm_ep_local_ep(VALUE *ep)
int thread_abort_on_exception
struct unlinked_method_entry_list_entry * unlinked_method_entry_list
struct st_table * loading_table
struct rb_iseq_location_struct rb_iseq_location_t
void rb_vmdebug_debug_print_pre(rb_thread_t *th, rb_control_frame_t *cfp)
void rb_threadptr_signal_exit(rb_thread_t *th)
void rb_unblock_function_t(void *)
VALUE * machine_stack_start
struct rb_vm_struct::@153 default_params
struct rb_event_hook_struct * hooks
int rb_signal_buff_size(void)
const char * ruby_node_name(int node)
rb_hook_list_t event_hooks
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
rb_event_flag_t ruby_vm_event_flags
void rb_threadptr_pending_interrupt_enque(rb_thread_t *th, VALUE v)
struct rb_iseq_struct * parent_iseq
size_t thread_vm_stack_size
rb_thread_t * ruby_current_thread
rb_call_info_t * CALL_INFO
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_iseq_location_t location
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, int argc, const VALUE *argv, const rb_block_t *blockptr)
struct rb_block_struct rb_block_t
void rb_vm_change_state(void)
VALUE * machine_stack_end
VALUE rb_iseq_compile_on_base(VALUE src, VALUE file, VALUE line, rb_block_t *base_block)
void rb_vm_gvl_destroy(rb_vm_t *vm)
struct rb_objspace * objspace
int mild_compile_error
Thread-local state of compiling context.
unsigned long interrupt_mask
void rb_threadptr_interrupt(rb_thread_t *th)
const rb_method_entry_t * me
struct rb_unblock_callback unblock
rb_hook_list_t event_hooks
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
size_t thread_machine_stack_size
VALUE rb_iseq_compile_with_option(VALUE src, VALUE file, VALUE absolute_path, VALUE line, rb_block_t *base_block, VALUE opt)
struct iseq_line_info_entry * line_info_table
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 loaded_features_snapshot
VALUE rb_iseq_new_with_opt(NODE *, VALUE, VALUE, VALUE, VALUE, VALUE, enum iseq_type, const rb_compile_option_t *)
union iseq_inline_cache_entry::@150 ic_value
rb_call_info_t * passed_ci
void rb_vmdebug_debug_print_post(rb_thread_t *th, rb_control_frame_t *cfp)
struct rb_thread_list_struct * next
struct rb_thread_struct rb_thread_t
struct rb_call_info_struct rb_call_info_t
void rb_threadptr_check_signal(rb_thread_t *mth)
void rb_threadptr_exec_event_hooks(struct rb_trace_arg_struct *trace_arg)
VALUE pending_interrupt_queue
RUBY_EXTERN VALUE rb_mRubyVMFrozenCore
void rb_threadptr_execute_interrupts(rb_thread_t *, int)
rb_control_frame_t * rb_vm_get_binding_creatable_next_cfp(rb_thread_t *th, const rb_control_frame_t *cfp)
size_t machine_stack_maxsize
rb_control_frame_t * rb_vm_get_ruby_level_next_cfp(rb_thread_t *th, const rb_control_frame_t *cfp)
int method_missing_reason
union rb_call_info_struct::@151 aux
static rb_thread_t * GET_THREAD(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
struct rb_vm_struct::@152 trap_list[RUBY_NSIG]
struct rb_trace_arg_struct * trace_arg
int ruby_thread_has_gvl_p(void)
const rb_method_entry_t * me
int parse_in_eval
Thread-local state of evaluation context.