21#define N_OR_RUBY_DEBUG(n) (((n) > 0) ? (n) : RUBY_DEBUG)
23#define VM_CHECK_MODE N_OR_RUBY_DEBUG(0)
48#include "ruby/internal/config.h"
54#include "ruby_assert.h"
56#define RVALUE_SIZE (sizeof(struct RBasic) + sizeof(VALUE[RBIMPL_RVALUE_EMBED_LEN_MAX]))
59#define VM_ASSERT(expr, ...) \
60 RUBY_ASSERT_MESG_WHEN(VM_CHECK_MODE > 0, expr, #expr RBIMPL_VA_OPT_ARGS(__VA_ARGS__))
61#define VM_UNREACHABLE(func) rb_bug(#func ": unreachable")
62#define RUBY_ASSERT_CRITICAL_SECTION
63#define RUBY_DEBUG_THREAD_SCHEDULE() rb_thread_schedule()
65#define VM_ASSERT(...) ((void)0)
66#define VM_UNREACHABLE(func) UNREACHABLE
67#define RUBY_DEBUG_THREAD_SCHEDULE()
70#define RUBY_ASSERT_MUTEX_OWNED(mutex) VM_ASSERT(rb_mutex_owned_p(mutex))
72#if defined(RUBY_ASSERT_CRITICAL_SECTION)
97extern int ruby_assert_critical_section_entered;
98#define RUBY_ASSERT_CRITICAL_SECTION_ENTER() do{ruby_assert_critical_section_entered += 1;}while(false)
99#define RUBY_ASSERT_CRITICAL_SECTION_LEAVE() do{VM_ASSERT(ruby_assert_critical_section_entered > 0);ruby_assert_critical_section_entered -= 1;}while(false)
101#define RUBY_ASSERT_CRITICAL_SECTION_ENTER()
102#define RUBY_ASSERT_CRITICAL_SECTION_LEAVE()
105#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
106# include "wasm/setjmp.h"
111#if defined(__linux__) || defined(__FreeBSD__)
112# define RB_THREAD_T_HAS_NATIVE_ID
116#include "ccan/list/list.h"
119#include "internal/array.h"
120#include "internal/basic_operators.h"
121#include "internal/box.h"
122#include "internal/sanitizers.h"
123#include "internal/serial.h"
124#include "internal/set_table.h"
125#include "internal/vm.h"
130#include "ruby_atomic.h"
140#ifndef VM_INSN_INFO_TABLE_IMPL
141# define VM_INSN_INFO_TABLE_IMPL 2
146# define NSIG NSIG_MAX
147#elif defined(_SIG_MAXSIG)
149# define NSIG _SIG_MAXSIG
150#elif defined(_SIGMAX)
151# define NSIG (_SIGMAX + 1)
155# define NSIG (sizeof(sigset_t) * CHAR_BIT + 1)
158#define RUBY_NSIG NSIG
161# define RUBY_SIGCHLD (SIGCLD)
162#elif defined(SIGCHLD)
163# define RUBY_SIGCHLD (SIGCHLD)
166#if defined(SIGSEGV) && defined(HAVE_SIGALTSTACK) && defined(SA_SIGINFO) && !defined(__NetBSD__)
167# define USE_SIGALTSTACK
168void *rb_allocate_sigaltstack(
void);
169void *rb_register_sigaltstack(
void *);
170# define RB_ALTSTACK_INIT(var, altstack) var = rb_register_sigaltstack(altstack)
171# define RB_ALTSTACK_FREE(var) free(var)
172# define RB_ALTSTACK(var) var
174# define RB_ALTSTACK_INIT(var, altstack)
175# define RB_ALTSTACK_FREE(var)
176# define RB_ALTSTACK(var) (0)
179#include THREAD_IMPL_H
180#define RUBY_VM_THREAD_MODEL 2
187#if defined(__GNUC__) && __GNUC__ >= 2
189#if OPT_TOKEN_THREADED_CODE
190#if OPT_DIRECT_THREADED_CODE
191#undef OPT_DIRECT_THREADED_CODE
198#if OPT_DIRECT_THREADED_CODE
199#undef OPT_DIRECT_THREADED_CODE
201#if OPT_TOKEN_THREADED_CODE
202#undef OPT_TOKEN_THREADED_CODE
207#if OPT_CALL_THREADED_CODE
208#if OPT_DIRECT_THREADED_CODE
209#undef OPT_DIRECT_THREADED_CODE
213void rb_vm_encoded_insn_data_table_init(
void);
214typedef unsigned long rb_num_t;
215typedef signed long rb_snum_t;
219 RUBY_TAG_RETURN = 0x1,
220 RUBY_TAG_BREAK = 0x2,
222 RUBY_TAG_RETRY = 0x4,
224 RUBY_TAG_RAISE = 0x6,
225 RUBY_TAG_THROW = 0x7,
226 RUBY_TAG_FATAL = 0x8,
230#define TAG_NONE RUBY_TAG_NONE
231#define TAG_RETURN RUBY_TAG_RETURN
232#define TAG_BREAK RUBY_TAG_BREAK
233#define TAG_NEXT RUBY_TAG_NEXT
234#define TAG_RETRY RUBY_TAG_RETRY
235#define TAG_REDO RUBY_TAG_REDO
236#define TAG_RAISE RUBY_TAG_RAISE
237#define TAG_THROW RUBY_TAG_THROW
238#define TAG_FATAL RUBY_TAG_FATAL
239#define TAG_MASK RUBY_TAG_MASK
241enum ruby_vm_throw_flags {
242 VM_THROW_NO_ESCAPE_FLAG = 0x8000,
243 VM_THROW_STATE_MASK = 0xff
258#define IMEMO_CONST_CACHE_SHAREABLE IMEMO_FL_USER0
265 const rb_cref_t *ic_cref;
267STATIC_ASSERT(sizeof_iseq_inline_constant_cache_entry,
269 sizeof(
const rb_cref_t *)) <= RVALUE_SIZE);
316#ifndef VM_ARGC_STACK_MAX
317#define VM_ARGC_STACK_MAX 128
320#define VM_KW_SPECIFIED_BITS_MAX (32-1)
322# define CALLING_ARGC(calling) ((calling)->heap_argv ? RARRAY_LENINT((calling)->heap_argv) : (calling)->argc)
327#define CoreDataFromValue(obj, type) (type*)DATA_PTR(obj)
329#define CoreDataFromValue(obj, type) (type*)rb_data_object_get(obj)
331#define GetCoreDataFromValue(obj, type, ptr) ((ptr) = CoreDataFromValue((obj), type))
339 rb_code_location_t code_location;
342#define PATHOBJ_PATH 0
343#define PATHOBJ_REALPATH 1
346pathobj_path(
VALUE pathobj)
352 VM_ASSERT(RB_TYPE_P(pathobj,
T_ARRAY));
358pathobj_realpath(
VALUE pathobj)
364 VM_ASSERT(RB_TYPE_P(pathobj,
T_ARRAY));
370typedef uintptr_t iseq_bits_t;
372#define ISEQ_IS_SIZE(body) (body->ic_size + body->ivc_size + body->ise_size + body->icvarc_size)
375#define ISEQ_IS_IC_ENTRY(body, idx) (body->is_entries[(idx) + body->ise_size + body->icvarc_size + body->ivc_size].ic_cache);
391enum rb_builtin_attr {
393 BUILTIN_ATTR_LEAF = 0x01,
395 BUILTIN_ATTR_SINGLE_NOARG_LEAF = 0x02,
397 BUILTIN_ATTR_INLINE_BLOCK = 0x04,
399 BUILTIN_ATTR_C_TRACE = 0x08,
406 enum rb_iseq_type type;
408 unsigned int iseq_size;
436 unsigned int has_lead : 1;
437 unsigned int has_opt : 1;
438 unsigned int has_rest : 1;
439 unsigned int has_post : 1;
440 unsigned int has_kw : 1;
441 unsigned int has_kwrest : 1;
442 unsigned int has_block : 1;
444 unsigned int ambiguous_param0 : 1;
445 unsigned int accepts_no_kwarg : 1;
446 unsigned int ruby2_keywords: 1;
447 unsigned int anon_rest: 1;
448 unsigned int anon_kwrest: 1;
449 unsigned int use_block: 1;
450 unsigned int forwardable: 1;
462 const VALUE *opt_table;
483 VALUE *default_values;
487 rb_iseq_location_t location;
492 unsigned int *positions;
494#if VM_INSN_INFO_TABLE_IMPL == 2
495 struct succ_index_table *succ_index_table;
499 const ID *local_table;
518 rb_snum_t flip_count;
521 VALUE pc2branchindex;
522 VALUE *original_iseq;
525 unsigned int local_table_size;
526 unsigned int ic_size;
527 unsigned int ise_size;
528 unsigned int ivc_size;
529 unsigned int icvarc_size;
530 unsigned int ci_size;
531 unsigned int stack_max;
533 unsigned int builtin_attrs;
547 const rb_iseq_t *mandatory_only_iseq;
549#if USE_YJIT || USE_ZJIT
551 rb_jit_func_t jit_entry;
553 long unsigned jit_entry_calls;
555 rb_jit_func_t jit_exception;
557 long unsigned jit_exception_calls;
564 uint64_t yjit_calls_at_interv;
590 unsigned int local_hooks_cnt;
596#define ISEQ_BODY(iseq) ((iseq)->body)
598#if !defined(USE_LAZY_LOAD) || !(USE_LAZY_LOAD+0)
599#define USE_LAZY_LOAD 0
603static inline const rb_iseq_t *rb_iseq_complete(
const rb_iseq_t *iseq) {
return 0;}
605const rb_iseq_t *rb_iseq_complete(
const rb_iseq_t *iseq);
607static inline const rb_iseq_t *
608rb_iseq_check(
const rb_iseq_t *iseq)
610 if (USE_LAZY_LOAD && ISEQ_BODY(iseq) == NULL) {
611 rb_iseq_complete((rb_iseq_t *)iseq);
617rb_iseq_attr_p(
const rb_iseq_t *iseq,
enum rb_builtin_attr attr)
619 return (ISEQ_BODY(iseq)->builtin_attrs & attr) == attr;
622static inline const rb_iseq_t *
623def_iseq_ptr(rb_method_definition_t *def)
627 if (def->type != VM_METHOD_TYPE_ISEQ) rb_bug(
"def_iseq_ptr: not iseq (%d)", def->type);
629 return rb_iseq_check(def->body.iseq.iseqptr);
632enum ruby_special_exceptions {
636 ruby_error_stackfatal,
637 ruby_error_stream_closed,
638 ruby_special_error_count
641#define GetVMPtr(obj, ptr) \
642 GetCoreDataFromValue((obj), rb_vm_t, (ptr))
648 rb_vm_at_exit_func *func;
652void *rb_objspace_alloc(
void);
653void rb_objspace_free(
void *
objspace);
654void rb_objspace_call_finalizer(
void);
656enum rb_hook_list_type {
657 hook_list_type_ractor_local,
658 hook_list_type_targeted_iseq,
659 hook_list_type_targeted_def,
660 hook_list_type_global
666 unsigned int running;
667 enum rb_hook_list_type type;
683 struct ccan_list_head set;
685 unsigned int blocking_cnt;
692 rb_nativethread_lock_t lock;
694 unsigned int lock_rec;
697 rb_nativethread_cond_t terminate_cond;
698 bool terminate_waiting;
700#ifndef RUBY_THREAD_PTHREAD_H
702 bool barrier_waiting;
703 unsigned int barrier_cnt;
704 rb_nativethread_cond_t barrier_complete_cond;
705 rb_nativethread_cond_t barrier_release_cond;
709#ifdef RUBY_THREAD_PTHREAD_H
712 rb_nativethread_lock_t lock;
716 rb_nativethread_cond_t cond;
717 unsigned int snt_cnt;
718 unsigned int dnt_cnt;
720 unsigned int running_cnt;
722 unsigned int max_cpu;
723 struct ccan_list_head grq;
724 unsigned int grq_cnt;
727 struct ccan_list_head running_threads;
730 struct ccan_list_head timeslice_threads;
732 struct ccan_list_head zombie_threads;
735 bool timeslice_wait_inf;
738 rb_nativethread_cond_t barrier_complete_cond;
739 rb_nativethread_cond_t barrier_release_cond;
740 bool barrier_waiting;
741 unsigned int barrier_waiting_cnt;
742 unsigned int barrier_serial;
744 unsigned int barrier_lock_rec;
749#ifdef USE_SIGALTSTACK
753 rb_serial_t fork_gen;
756 volatile int ubf_async_safe;
758 unsigned int running: 1;
759 unsigned int thread_abort_on_exception: 1;
760 unsigned int thread_report_on_exception: 1;
761 unsigned int thread_ignore_deadlock: 1;
764 VALUE mark_object_ary;
766 const VALUE special_exceptions[ruby_special_error_count];
769 rb_box_t *master_box;
776 struct st_table *static_ext_inits;
780 VALUE cmd[RUBY_NSIG];
784 rb_hook_list_t global_hooks;
789 int src_encoding_index;
792 struct ccan_list_head workqueue;
793 rb_nativethread_lock_t workqueue_lock;
795 VALUE orig_progname, progname;
796 VALUE coverages, me2counter;
801 struct gc_mark_func_data_struct {
803 void (*mark_func)(
VALUE v,
void *data);
822 ID inserting_constant_cache_id;
824#ifndef VM_GLOBAL_CC_CACHE_TABLE_SIZE
825#define VM_GLOBAL_CC_CACHE_TABLE_SIZE 1023
827 const struct rb_callcache *global_cc_cache_table[VM_GLOBAL_CC_CACHE_TABLE_SIZE];
828 bool global_cc_cache_table_used;
830#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
836 size_t thread_vm_stack_size;
837 size_t thread_machine_stack_size;
838 size_t fiber_vm_stack_size;
839 size_t fiber_machine_stack_size;
843extern bool ruby_vm_during_cleanup;
847#define RUBY_VM_SIZE_ALIGN 4096
849#define RUBY_VM_THREAD_VM_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
850#define RUBY_VM_THREAD_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
851#define RUBY_VM_THREAD_MACHINE_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
852#define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
854#define RUBY_VM_FIBER_VM_STACK_SIZE ( 16 * 1024 * sizeof(VALUE))
855#define RUBY_VM_FIBER_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
856#define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 64 * 1024 * sizeof(VALUE))
857#if defined(__powerpc64__) || defined(__ppc64__)
858#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 32 * 1024 * sizeof(VALUE))
860#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
863#if __has_feature(memory_sanitizer) || __has_feature(address_sanitizer) || __has_feature(leak_sanitizer)
865#undef RUBY_VM_THREAD_MACHINE_STACK_SIZE
866#define RUBY_VM_THREAD_MACHINE_STACK_SIZE (1024 * 1024 * sizeof(VALUE))
867#undef RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN
868#define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 512 * 1024 * sizeof(VALUE))
869#undef RUBY_VM_FIBER_MACHINE_STACK_SIZE
870#define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 256 * 1024 * sizeof(VALUE))
871#undef RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN
872#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 128 * 1024 * sizeof(VALUE))
875#ifndef VM_DEBUG_BP_CHECK
876#define VM_DEBUG_BP_CHECK 0
879#ifndef VM_DEBUG_VERIFY_METHOD_CACHE
880#define VM_DEBUG_VERIFY_METHOD_CACHE (VMDEBUG != 0)
887 const rb_iseq_t *iseq;
893enum rb_block_handler_type {
894 block_handler_type_iseq,
895 block_handler_type_ifunc,
896 block_handler_type_symbol,
897 block_handler_type_proc
913 enum rb_block_type type;
919 const rb_iseq_t *iseq;
922 const void *block_code;
932rb_thread_ptr(
VALUE thval)
937enum rb_thread_status {
940 THREAD_STOPPED_FOREVER,
945typedef RUBY_JMP_BUF rb_jmpbuf_t;
947typedef void *rb_jmpbuf_t[5];
962#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
972typedef rb_jmpbuf_t *rb_vm_tag_jmpbuf_t;
974#define RB_VM_TAG_JMPBUF_GET(buf) (*buf)
977rb_vm_tag_jmpbuf_init(rb_vm_tag_jmpbuf_t *jmpbuf)
979 *jmpbuf = ruby_xmalloc(
sizeof(rb_jmpbuf_t));
983rb_vm_tag_jmpbuf_deinit(
const rb_vm_tag_jmpbuf_t *jmpbuf)
988typedef rb_jmpbuf_t rb_vm_tag_jmpbuf_t;
990#define RB_VM_TAG_JMPBUF_GET(buf) (buf)
993rb_vm_tag_jmpbuf_init(rb_vm_tag_jmpbuf_t *jmpbuf)
999rb_vm_tag_jmpbuf_deinit(
const rb_vm_tag_jmpbuf_t *jmpbuf)
1012 rb_vm_tag_jmpbuf_t buf;
1014 enum ruby_tag_type state;
1015 unsigned int lock_rec;
1018STATIC_ASSERT(rb_vm_tag_buf_offset, offsetof(
struct rb_vm_tag, buf) > 0);
1019STATIC_ASSERT(rb_vm_tag_buf_end,
1020 offsetof(
struct rb_vm_tag, buf) +
sizeof(rb_vm_tag_jmpbuf_t) <
1041 size_t vm_stack_size;
1042 rb_control_frame_t *cfp;
1049#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
1050 uint32_t checked_clock;
1053 rb_fiber_t *fiber_ptr;
1056 rb_serial_t ractor_id;
1060 VALUE local_storage_recursive_hash;
1061 VALUE local_storage_recursive_hash_for_trace;
1067 const VALUE *root_lep;
1075 VALUE passed_block_handler;
1077 uint8_t raised_flag;
1080 BITFIELD(
enum method_missing_reason, method_missing_reason, 8);
1082 VALUE private_const_reference;
1093 size_t stack_maxsize;
1096#ifdef RUBY_ASAN_ENABLED
1097 void *asan_fake_stack_handle;
1102#ifndef rb_execution_context_t
1104#define rb_execution_context_t rb_execution_context_t
1108#define VM_CORE_H_EC_DEFINED 1
1111void rb_ec_set_vm_stack(rb_execution_context_t *ec,
VALUE *stack,
size_t size);
1117void rb_ec_initialize_vm_stack(rb_execution_context_t *ec,
VALUE *stack,
size_t size);
1121void rb_ec_clear_vm_stack(rb_execution_context_t *ec);
1125void rb_ec_close(rb_execution_context_t *ec);
1136 struct ccan_list_node lt_node;
1138 rb_ractor_t *ractor;
1141 rb_execution_context_t *ec;
1144 bool mn_schedulable;
1158 BITFIELD(
enum rb_thread_status, status, 2);
1160 unsigned int has_dedicated_nt : 1;
1161 unsigned int to_kill : 1;
1162 unsigned int abort_on_exception: 1;
1163 unsigned int report_on_exception: 1;
1164 unsigned int pending_interrupt_queue_checked: 1;
1166 uint32_t running_time_us;
1168 void *blocking_region_buffer;
1174#if OPT_CALL_THREADED_CODE
1179 VALUE pending_interrupt_queue;
1180 VALUE pending_interrupt_mask_stack;
1183 rb_nativethread_lock_t interrupt_lock;
1185 VALUE locking_mutex;
1187 struct ccan_list_head interrupt_exec_tasks;
1198 VALUE (*func)(
void *);
1203 enum thread_invoke_type {
1204 thread_invoke_type_none = 0,
1205 thread_invoke_type_proc,
1206 thread_invoke_type_ractor_proc,
1207 thread_invoke_type_func
1211 rb_fiber_t *root_fiber;
1214 unsigned int blocking;
1218 void **specific_storage;
1223static inline unsigned int
1224rb_th_serial(
const rb_thread_t *th)
1226 return th ? (
unsigned int)th->serial : 0;
1230 VM_DEFINECLASS_TYPE_CLASS = 0x00,
1231 VM_DEFINECLASS_TYPE_SINGLETON_CLASS = 0x01,
1232 VM_DEFINECLASS_TYPE_MODULE = 0x02,
1234 VM_DEFINECLASS_TYPE_MASK = 0x07
1235} rb_vm_defineclass_type_t;
1237#define VM_DEFINECLASS_TYPE(x) ((rb_vm_defineclass_type_t)(x) & VM_DEFINECLASS_TYPE_MASK)
1238#define VM_DEFINECLASS_FLAG_SCOPED 0x08
1239#define VM_DEFINECLASS_FLAG_HAS_SUPERCLASS 0x10
1240#define VM_DEFINECLASS_SCOPED_P(x) ((x) & VM_DEFINECLASS_FLAG_SCOPED)
1241#define VM_DEFINECLASS_HAS_SUPERCLASS_P(x) \
1242 ((x) & VM_DEFINECLASS_FLAG_HAS_SUPERCLASS)
1245RUBY_SYMBOL_EXPORT_BEGIN
1248rb_iseq_t *rb_iseq_new (
const VALUE ast_value,
VALUE name,
VALUE path,
VALUE realpath,
const rb_iseq_t *parent,
enum rb_iseq_type);
1249rb_iseq_t *rb_iseq_new_top (
const VALUE ast_value,
VALUE name,
VALUE path,
VALUE realpath,
const rb_iseq_t *parent);
1250rb_iseq_t *rb_iseq_new_main (
const VALUE ast_value,
VALUE path,
VALUE realpath,
const rb_iseq_t *parent,
int opt);
1251rb_iseq_t *rb_iseq_new_eval (
const VALUE ast_value,
VALUE name,
VALUE path,
VALUE realpath,
int first_lineno,
const rb_iseq_t *parent,
int isolated_depth);
1252rb_iseq_t *rb_iseq_new_with_opt(
VALUE ast_value,
VALUE name,
VALUE path,
VALUE realpath,
int first_lineno,
const rb_iseq_t *parent,
int isolated_depth,
1253 enum rb_iseq_type,
const rb_compile_option_t*,
1254 VALUE script_lines);
1264rb_iseq_new_with_callback_new_callback(
1276 const rb_iseq_t *parent,
enum rb_iseq_type,
const rb_compile_option_t*);
1278VALUE rb_iseq_disasm(
const rb_iseq_t *iseq);
1279int rb_iseq_disasm_insn(
VALUE str,
const VALUE *iseqval,
size_t pos,
const rb_iseq_t *iseq,
VALUE child);
1281VALUE rb_iseq_coverage(
const rb_iseq_t *iseq);
1287RUBY_SYMBOL_EXPORT_END
1289#define GetProcPtr(obj, ptr) \
1290 GetCoreDataFromValue((obj), rb_proc_t, (ptr))
1294 unsigned int is_from_method: 1;
1295 unsigned int is_lambda: 1;
1296 unsigned int is_isolated: 1;
1299RUBY_SYMBOL_EXPORT_BEGIN
1303RUBY_SYMBOL_EXPORT_END
1310 unsigned int env_size;
1315#define GetBindingPtr(obj, ptr) \
1316 GetCoreDataFromValue((obj), rb_binding_t, (ptr))
1320 const VALUE pathobj;
1326enum vm_check_match_type {
1327 VM_CHECKMATCH_TYPE_WHEN = 1,
1328 VM_CHECKMATCH_TYPE_CASE = 2,
1329 VM_CHECKMATCH_TYPE_RESCUE = 3
1332#define VM_CHECKMATCH_TYPE_MASK 0x03
1333#define VM_CHECKMATCH_ARRAY 0x04
1335enum vm_opt_newarray_send_type {
1336 VM_OPT_NEWARRAY_SEND_MAX = 1,
1337 VM_OPT_NEWARRAY_SEND_MIN = 2,
1338 VM_OPT_NEWARRAY_SEND_HASH = 3,
1339 VM_OPT_NEWARRAY_SEND_PACK = 4,
1340 VM_OPT_NEWARRAY_SEND_PACK_BUFFER = 5,
1341 VM_OPT_NEWARRAY_SEND_INCLUDE_P = 6,
1344enum vm_special_object_type {
1345 VM_SPECIAL_OBJECT_VMCORE = 1,
1346 VM_SPECIAL_OBJECT_CBASE,
1347 VM_SPECIAL_OBJECT_CONST_BASE
1351 VM_SVAR_LASTLINE = 0,
1352 VM_SVAR_BACKREF = 1,
1354 VM_SVAR_EXTRA_START = 2,
1355 VM_SVAR_FLIPFLOP_START = 2
1367typedef VALUE CDHASH;
1369#ifndef FUNC_FASTCALL
1370#define FUNC_FASTCALL(x) x
1373typedef rb_control_frame_t *
1374 (FUNC_FASTCALL(*rb_insn_func_t))(rb_execution_context_t *, rb_control_frame_t *);
1376#define VM_TAGGED_PTR_SET(p, tag) ((VALUE)(p) | (tag))
1377#define VM_TAGGED_PTR_REF(v, mask) ((void *)((v) & ~mask))
1379#define GC_GUARDED_PTR(p) VM_TAGGED_PTR_SET((p), 0x01)
1380#define GC_GUARDED_PTR_REF(p) VM_TAGGED_PTR_REF((p), 0x03)
1381#define GC_GUARDED_PTR_P(p) (((VALUE)(p)) & 0x01)
1383enum vm_frame_env_flags {
1394 VM_FRAME_MAGIC_METHOD = 0x11110001,
1395 VM_FRAME_MAGIC_BLOCK = 0x22220001,
1396 VM_FRAME_MAGIC_CLASS = 0x33330001,
1397 VM_FRAME_MAGIC_TOP = 0x44440001,
1398 VM_FRAME_MAGIC_CFUNC = 0x55550001,
1399 VM_FRAME_MAGIC_IFUNC = 0x66660001,
1400 VM_FRAME_MAGIC_EVAL = 0x77770001,
1401 VM_FRAME_MAGIC_RESCUE = 0x78880001,
1402 VM_FRAME_MAGIC_DUMMY = 0x79990001,
1404 VM_FRAME_MAGIC_MASK = 0x7fff0001,
1407 VM_FRAME_FLAG_FINISH = 0x0020,
1408 VM_FRAME_FLAG_BMETHOD = 0x0040,
1409 VM_FRAME_FLAG_CFRAME = 0x0080,
1410 VM_FRAME_FLAG_LAMBDA = 0x0100,
1411 VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM = 0x0200,
1412 VM_FRAME_FLAG_CFRAME_KW = 0x0400,
1413 VM_FRAME_FLAG_PASSED = 0x0800,
1414 VM_FRAME_FLAG_BOX_REQUIRE = 0x1000,
1417 VM_ENV_FLAG_LOCAL = 0x0002,
1418 VM_ENV_FLAG_ESCAPED = 0x0004,
1419 VM_ENV_FLAG_WB_REQUIRED = 0x0008,
1420 VM_ENV_FLAG_ISOLATED = 0x0010,
1423#define VM_ENV_DATA_SIZE ( 3)
1425#define VM_ENV_DATA_INDEX_ME_CREF (-2)
1426#define VM_ENV_DATA_INDEX_SPECVAL (-1)
1427#define VM_ENV_DATA_INDEX_FLAGS ( 0)
1428#define VM_ENV_DATA_INDEX_ENV ( 1)
1430#define VM_ENV_INDEX_LAST_LVAR (-VM_ENV_DATA_SIZE)
1432static inline void VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *
ptr,
VALUE special_const_value);
1437 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1439 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags | flag);
1443VM_ENV_FLAGS_UNSET(
const VALUE *ep,
VALUE flag)
1445 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1447 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags & ~flag);
1450static inline unsigned long
1451VM_ENV_FLAGS(
const VALUE *ep,
long flag)
1453 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1455 return flags & flag;
1458static inline unsigned long
1459VM_ENV_FLAGS_UNCHECKED(
const VALUE *ep,
long flag)
1461 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1462 return flags & flag;
1465static inline unsigned long
1466VM_ENV_FRAME_TYPE_P(
const VALUE *ep,
unsigned long frame_type)
1468 return VM_ENV_FLAGS(ep, VM_FRAME_MAGIC_MASK) == frame_type;
1471static inline unsigned long
1472VM_FRAME_TYPE(
const rb_control_frame_t *cfp)
1474 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_MAGIC_MASK);
1477static inline unsigned long
1478VM_FRAME_TYPE_UNCHECKED(
const rb_control_frame_t *cfp)
1480 return VM_ENV_FLAGS_UNCHECKED(cfp->ep, VM_FRAME_MAGIC_MASK);
1484VM_FRAME_LAMBDA_P(
const rb_control_frame_t *cfp)
1486 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_LAMBDA) != 0;
1490VM_FRAME_CFRAME_KW_P(
const rb_control_frame_t *cfp)
1492 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME_KW) != 0;
1496VM_FRAME_FINISHED_P(
const rb_control_frame_t *cfp)
1498 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_FINISH) != 0;
1502VM_FRAME_FINISHED_P_UNCHECKED(
const rb_control_frame_t *cfp)
1504 return VM_ENV_FLAGS_UNCHECKED(cfp->ep, VM_FRAME_FLAG_FINISH) != 0;
1508VM_FRAME_BMETHOD_P(
const rb_control_frame_t *cfp)
1510 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BMETHOD) != 0;
1514rb_obj_is_iseq(
VALUE iseq)
1516 return imemo_type_p(iseq, imemo_iseq);
1519#if VM_CHECK_MODE > 0
1520#define RUBY_VM_NORMAL_ISEQ_P(iseq) rb_obj_is_iseq((VALUE)iseq)
1524VM_FRAME_CFRAME_P(
const rb_control_frame_t *cfp)
1526 int cframe_p = VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME) != 0;
1527 VM_ASSERT(RUBY_VM_NORMAL_ISEQ_P(cfp->iseq) != cframe_p ||
1528 (VM_FRAME_TYPE(cfp) & VM_FRAME_MAGIC_MASK) == VM_FRAME_MAGIC_DUMMY);
1533VM_FRAME_CFRAME_P_UNCHECKED(
const rb_control_frame_t *cfp)
1535 return VM_ENV_FLAGS_UNCHECKED(cfp->ep, VM_FRAME_FLAG_CFRAME) != 0;
1539VM_FRAME_RUBYFRAME_P(
const rb_control_frame_t *cfp)
1541 return !VM_FRAME_CFRAME_P(cfp);
1545VM_FRAME_RUBYFRAME_P_UNCHECKED(
const rb_control_frame_t *cfp)
1547 return !VM_FRAME_CFRAME_P_UNCHECKED(cfp);
1551VM_FRAME_NS_REQUIRE_P(
const rb_control_frame_t *cfp)
1553 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BOX_REQUIRE) != 0;
1556#define RUBYVM_CFUNC_FRAME_P(cfp) \
1557 (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
1559#define VM_GUARDED_PREV_EP(ep) GC_GUARDED_PTR(ep)
1560#define VM_BLOCK_HANDLER_NONE 0
1563VM_ENV_LOCAL_P(
const VALUE *ep)
1565 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_LOCAL) ? 1 : 0;
1569VM_ENV_LOCAL_P_UNCHECKED(
const VALUE *ep)
1571 return VM_ENV_FLAGS_UNCHECKED(ep, VM_ENV_FLAG_LOCAL) ? 1 : 0;
1574static inline const VALUE *
1575VM_ENV_PREV_EP_UNCHECKED(
const VALUE *ep)
1577 return GC_GUARDED_PTR_REF(ep[VM_ENV_DATA_INDEX_SPECVAL]);
1580static inline const VALUE *
1581VM_ENV_PREV_EP(
const VALUE *ep)
1583 VM_ASSERT(VM_ENV_LOCAL_P(ep) == 0);
1584 return VM_ENV_PREV_EP_UNCHECKED(ep);
1588VM_ENV_BOXED_P(
const VALUE *ep)
1590 return VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_CLASS) || VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_TOP);
1594VM_ENV_BLOCK_HANDLER(
const VALUE *ep)
1596 if (VM_ENV_BOXED_P(ep)) {
1597 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1598 return VM_BLOCK_HANDLER_NONE;
1601 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1602 return ep[VM_ENV_DATA_INDEX_SPECVAL];
1605static inline const rb_box_t *
1606VM_ENV_BOX(
const VALUE *ep)
1608 VM_ASSERT(VM_ENV_BOXED_P(ep));
1609 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1610 return (
const rb_box_t *)GC_GUARDED_PTR_REF(ep[VM_ENV_DATA_INDEX_SPECVAL]);
1613static inline const rb_box_t *
1614VM_ENV_BOX_UNCHECKED(
const VALUE *ep)
1616 return (
const rb_box_t *)GC_GUARDED_PTR_REF(ep[VM_ENV_DATA_INDEX_SPECVAL]);
1619#if VM_CHECK_MODE > 0
1620int rb_vm_ep_in_heap_p(
const VALUE *ep);
1624VM_ENV_ESCAPED_P(
const VALUE *ep)
1626 VM_ASSERT(rb_vm_ep_in_heap_p(ep) == !!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
1627 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) ? 1 : 0;
1632VM_ENV_ENVVAL(const
VALUE *ep)
1634 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV];
1635 VM_ASSERT(VM_ENV_ESCAPED_P(ep));
1636 VM_ASSERT(envval ==
Qundef || imemo_type_p(envval, imemo_env));
1642VM_ENV_ENVVAL_PTR(const
VALUE *ep)
1644 return (
const rb_env_t *)VM_ENV_ENVVAL(ep);
1648vm_env_new(
VALUE *env_ep,
VALUE *env_body,
unsigned int env_size,
const rb_iseq_t *iseq)
1652 env->env = env_body;
1653 env->env_size = env_size;
1654 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1665VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *
ptr,
VALUE special_const_value)
1667 VM_ASSERT(RB_SPECIAL_CONST_P(special_const_value));
1668 VM_FORCE_WRITE(
ptr, special_const_value);
1672VM_STACK_ENV_WRITE(
const VALUE *ep,
int index,
VALUE v)
1674 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_WB_REQUIRED) == 0);
1675 VM_FORCE_WRITE(&ep[index], v);
1678const VALUE *rb_vm_ep_local_ep(
const VALUE *ep);
1683VALUE rb_vm_frame_block_handler(
const rb_control_frame_t *cfp);
1685#define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) ((cfp)+1)
1686#define RUBY_VM_NEXT_CONTROL_FRAME(cfp) ((cfp)-1)
1688#define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
1689 ((void *)(ecfp) > (void *)(cfp))
1691static inline const rb_control_frame_t *
1692RUBY_VM_END_CONTROL_FRAME(
const rb_execution_context_t *ec)
1694 return (rb_control_frame_t *)(ec->vm_stack + ec->vm_stack_size);
1698RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
1700 return !RUBY_VM_VALID_CONTROL_FRAME_P(cfp, RUBY_VM_END_CONTROL_FRAME(ec));
1704VM_BH_ISEQ_BLOCK_P(
VALUE block_handler)
1706 if ((block_handler & 0x03) == 0x01) {
1707#if VM_CHECK_MODE > 0
1709 VM_ASSERT(imemo_type_p(captured->code.val, imemo_iseq));
1721 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x01);
1722 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1723 return block_handler;
1727VM_BH_TO_ISEQ_BLOCK(
VALUE block_handler)
1730 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1735VM_BH_IFUNC_P(
VALUE block_handler)
1737 if ((block_handler & 0x03) == 0x03) {
1738#if VM_CHECK_MODE > 0
1740 VM_ASSERT(imemo_type_p(captured->code.val, imemo_ifunc));
1752 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x03);
1753 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1754 return block_handler;
1758VM_BH_TO_IFUNC_BLOCK(
VALUE block_handler)
1761 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1766VM_BH_TO_CAPT_BLOCK(
VALUE block_handler)
1769 VM_ASSERT(VM_BH_IFUNC_P(block_handler) || VM_BH_ISEQ_BLOCK_P(block_handler));
1773static inline enum rb_block_handler_type
1774vm_block_handler_type(
VALUE block_handler)
1776 if (VM_BH_ISEQ_BLOCK_P(block_handler)) {
1777 return block_handler_type_iseq;
1779 else if (VM_BH_IFUNC_P(block_handler)) {
1780 return block_handler_type_ifunc;
1782 else if (
SYMBOL_P(block_handler)) {
1783 return block_handler_type_symbol;
1787 return block_handler_type_proc;
1792vm_block_handler_verify(MAYBE_UNUSED(
VALUE block_handler))
1794 VM_ASSERT(block_handler == VM_BLOCK_HANDLER_NONE ||
1795 (vm_block_handler_type(block_handler), 1));
1798static inline enum rb_block_type
1799vm_block_type(
const struct rb_block *block)
1801#if VM_CHECK_MODE > 0
1802 switch (block->type) {
1803 case block_type_iseq:
1804 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_iseq));
1806 case block_type_ifunc:
1807 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_ifunc));
1809 case block_type_symbol:
1810 VM_ASSERT(
SYMBOL_P(block->as.symbol));
1812 case block_type_proc:
1821vm_block_type_set(
const struct rb_block *block,
enum rb_block_type
type)
1827static inline const struct rb_block *
1828vm_proc_block(
VALUE procval)
1834static inline const rb_iseq_t *vm_block_iseq(
const struct rb_block *block);
1835static inline const VALUE *vm_block_ep(
const struct rb_block *block);
1837static inline const rb_iseq_t *
1838vm_proc_iseq(
VALUE procval)
1840 return vm_block_iseq(vm_proc_block(procval));
1843static inline const VALUE *
1844vm_proc_ep(
VALUE procval)
1846 return vm_block_ep(vm_proc_block(procval));
1849static inline const rb_iseq_t *
1850vm_block_iseq(
const struct rb_block *block)
1852 switch (vm_block_type(block)) {
1853 case block_type_iseq:
return rb_iseq_check(block->as.captured.code.iseq);
1854 case block_type_proc:
return vm_proc_iseq(block->as.proc);
1855 case block_type_ifunc:
1856 case block_type_symbol:
return NULL;
1858 VM_UNREACHABLE(vm_block_iseq);
1862static inline const VALUE *
1863vm_block_ep(
const struct rb_block *block)
1865 switch (vm_block_type(block)) {
1866 case block_type_iseq:
1867 case block_type_ifunc:
return block->as.captured.ep;
1868 case block_type_proc:
return vm_proc_ep(block->as.proc);
1869 case block_type_symbol:
return NULL;
1871 VM_UNREACHABLE(vm_block_ep);
1876vm_block_self(
const struct rb_block *block)
1878 switch (vm_block_type(block)) {
1879 case block_type_iseq:
1880 case block_type_ifunc:
1881 return block->as.captured.self;
1882 case block_type_proc:
1883 return vm_block_self(vm_proc_block(block->as.proc));
1884 case block_type_symbol:
1887 VM_UNREACHABLE(vm_block_self);
1892VM_BH_TO_SYMBOL(
VALUE block_handler)
1894 VM_ASSERT(
SYMBOL_P(block_handler));
1895 return block_handler;
1899VM_BH_FROM_SYMBOL(
VALUE symbol)
1906VM_BH_TO_PROC(
VALUE block_handler)
1909 return block_handler;
1913VM_BH_FROM_PROC(
VALUE procval)
1926extern bool rb_vmdebug_stack_dump_raw(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp, FILE *);
1927extern bool rb_vmdebug_debug_print_pre(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp,
const VALUE *_pc, FILE *);
1928extern bool rb_vmdebug_debug_print_post(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp, FILE *);
1930#define SDR() rb_vmdebug_stack_dump_raw(GET_EC(), GET_EC()->cfp, stderr)
1931#define SDR2(cfp) rb_vmdebug_stack_dump_raw(GET_EC(), (cfp), stderr)
1932bool rb_vm_bugreport(
const void *, FILE *);
1933typedef void (*ruby_sighandler_t)(int);
1935NORETURN(
void rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler,
int sig, const
void *, const
char *fmt, ...));
1938RUBY_SYMBOL_EXPORT_BEGIN
1939VALUE rb_iseq_eval(const rb_iseq_t *iseq, const rb_box_t *box);
1940VALUE rb_iseq_eval_main(const rb_iseq_t *iseq);
1941VALUE rb_iseq_path(const rb_iseq_t *iseq);
1942VALUE rb_iseq_realpath(const rb_iseq_t *iseq);
1943RUBY_SYMBOL_EXPORT_END
1946void rb_iseq_pathobj_set(const rb_iseq_t *iseq,
VALUE path,
VALUE realpath);
1948int rb_ec_frame_method_id_and_class(const rb_execution_context_t *ec,
ID *idp,
ID *called_idp,
VALUE *klassp);
1949void rb_ec_setup_exception(const rb_execution_context_t *ec,
VALUE mesg,
VALUE cause);
1951VALUE rb_vm_invoke_proc(rb_execution_context_t *ec,
rb_proc_t *proc,
int argc, const
VALUE *argv,
int kw_splat,
VALUE block_handler);
1953VALUE rb_vm_make_proc_lambda(const rb_execution_context_t *ec, const struct
rb_captured_block *captured,
VALUE klass, int8_t is_lambda);
1957 return rb_vm_make_proc_lambda(ec, captured, klass, 0);
1961rb_vm_make_lambda(
const rb_execution_context_t *ec,
const struct rb_captured_block *captured,
VALUE klass)
1963 return rb_vm_make_proc_lambda(ec, captured, klass, 1);
1966VALUE rb_vm_make_binding(
const rb_execution_context_t *ec,
const rb_control_frame_t *src_cfp);
1971void rb_vm_inc_const_missing_count(
void);
1972VALUE rb_vm_call_kw(rb_execution_context_t *ec,
VALUE recv,
VALUE id,
int argc,
1973 const VALUE *argv,
const rb_callable_method_entry_t *me,
int kw_splat);
1974void rb_vm_pop_frame_no_int(rb_execution_context_t *ec);
1975void rb_vm_pop_frame(rb_execution_context_t *ec);
1977void rb_thread_start_timer_thread(
void);
1978void rb_thread_stop_timer_thread(
void);
1979void rb_thread_reset_timer_thread(
void);
1980void rb_thread_wakeup_timer_thread(
int);
1983rb_vm_living_threads_init(rb_vm_t *vm)
1985 ccan_list_head_init(&vm->workqueue);
1986 ccan_list_head_init(&vm->ractor.set);
1987#ifdef RUBY_THREAD_PTHREAD_H
1988 ccan_list_head_init(&vm->ractor.sched.zombie_threads);
1992typedef int rb_backtrace_iter_func(
void *,
VALUE,
int,
VALUE);
1993rb_control_frame_t *rb_vm_get_ruby_level_next_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp);
1994rb_control_frame_t *rb_vm_get_binding_creatable_next_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp);
1995VALUE *rb_vm_svar_lep(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp);
1996int rb_vm_get_sourceline(
const rb_control_frame_t *);
1997void rb_vm_stack_to_heap(rb_execution_context_t *ec);
1998void ruby_thread_init_stack(rb_thread_t *th,
void *local_in_parent_frame);
1999void rb_thread_malloc_stack_set(rb_thread_t *th,
void *stack);
2000rb_thread_t * ruby_thread_from_native(
void);
2001int ruby_thread_set_native(rb_thread_t *th);
2002int rb_vm_control_frame_id_and_class(
const rb_control_frame_t *cfp,
ID *idp,
ID *called_idp,
VALUE *klassp);
2003void rb_vm_rewind_cfp(rb_execution_context_t *ec, rb_control_frame_t *cfp);
2004void rb_vm_env_write(
const VALUE *ep,
int index,
VALUE v);
2005VALUE rb_vm_bh_to_procval(
const rb_execution_context_t *ec,
VALUE block_handler);
2007void rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp,
VALUE exception_class,
VALUE mesg);
2009#define rb_vm_register_special_exception(sp, e, m) \
2010 rb_vm_register_special_exception_str(sp, e, rb_usascii_str_new_static((m), (long)rb_strlen_lit(m)))
2012void rb_gc_mark_machine_context(
const rb_execution_context_t *ec);
2014rb_cref_t *rb_vm_rewrite_cref(rb_cref_t *node,
VALUE old_klass,
VALUE new_klass);
2016const rb_callable_method_entry_t *rb_vm_frame_method_entry(
const rb_control_frame_t *cfp);
2017const rb_callable_method_entry_t *rb_vm_frame_method_entry_unchecked(
const rb_control_frame_t *cfp);
2019#define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
2021#define CHECK_VM_STACK_OVERFLOW0(cfp, sp, margin) do { \
2022 STATIC_ASSERT(sizeof_sp, sizeof(*(sp)) == sizeof(VALUE)); \
2023 STATIC_ASSERT(sizeof_cfp, sizeof(*(cfp)) == sizeof(rb_control_frame_t)); \
2024 const struct rb_control_frame_struct *bound = (void *)&(sp)[(margin)]; \
2025 if (UNLIKELY((cfp) <= &bound[1])) { \
2026 vm_stackoverflow(); \
2030#define CHECK_VM_STACK_OVERFLOW(cfp, margin) \
2031 CHECK_VM_STACK_OVERFLOW0((cfp), (cfp)->sp, (margin))
2035rb_execution_context_t *rb_vm_main_ractor_ec(rb_vm_t *vm);
2039#if RUBY_VM_THREAD_MODEL == 2
2045RUBY_EXTERN unsigned int ruby_vm_iseq_events_enabled;
2048#define GET_VM() rb_current_vm()
2049#define GET_RACTOR() rb_current_ractor()
2050#define GET_THREAD() rb_current_thread()
2051#define GET_EC() rb_current_execution_context(true)
2053static inline rb_serial_t
2056 VM_ASSERT(ec->serial >= 1);
2060static inline rb_thread_t *
2061rb_ec_thread_ptr(
const rb_execution_context_t *ec)
2063 return ec->thread_ptr;
2066static inline rb_ractor_t *
2067rb_ec_ractor_ptr(
const rb_execution_context_t *ec)
2069 const rb_thread_t *th = rb_ec_thread_ptr(ec);
2071 VM_ASSERT(th->ractor != NULL);
2079static inline rb_serial_t
2080rb_ec_ractor_id(
const rb_execution_context_t *ec)
2082 rb_serial_t ractor_id = ec->ractor_id;
2087static inline rb_vm_t *
2088rb_ec_vm_ptr(
const rb_execution_context_t *ec)
2090 const rb_thread_t *th = rb_ec_thread_ptr(ec);
2101static inline rb_execution_context_t *
2102rb_current_execution_context(
bool expect_ec)
2104#ifdef RB_THREAD_LOCAL_SPECIFIER
2105 #ifdef RB_THREAD_CURRENT_EC_NOINLINE
2106 rb_execution_context_t *
volatile ec = rb_current_ec();
2108 rb_execution_context_t *
volatile ec = ruby_current_ec;
2123 VM_ASSERT(ec == rb_current_ec_noinline());
2125 rb_execution_context_t *
volatile ec = native_tls_get(ruby_current_ec_key);
2127 VM_ASSERT(!expect_ec || ec != NULL);
2131static inline rb_thread_t *
2132rb_current_thread(
void)
2134 const rb_execution_context_t *ec = GET_EC();
2135 return rb_ec_thread_ptr(ec);
2138static inline rb_ractor_t *
2139rb_current_ractor_raw(
bool expect)
2141 if (ruby_single_main_ractor) {
2142 return ruby_single_main_ractor;
2145 const rb_execution_context_t *ec = rb_current_execution_context(expect);
2146 return (expect || ec) ? rb_ec_ractor_ptr(ec) : NULL;
2150static inline rb_ractor_t *
2151rb_current_ractor(
void)
2153 return rb_current_ractor_raw(
true);
2156static inline rb_vm_t *
2160 VM_ASSERT(ruby_current_vm_ptr == NULL ||
2161 ruby_current_execution_context_ptr == NULL ||
2162 rb_ec_thread_ptr(GET_EC()) == NULL ||
2163 rb_ec_thread_ptr(GET_EC())->status == THREAD_KILLED ||
2164 rb_ec_vm_ptr(GET_EC()) == ruby_current_vm_ptr);
2167 return ruby_current_vm_ptr;
2170void rb_ec_vm_lock_rec_release(
const rb_execution_context_t *ec,
2171 unsigned int recorded_lock_rec,
2172 unsigned int current_lock_rec);
2176NO_SANITIZE(
"thread",
static inline bool
2177vm_locked_by_ractor_p(rb_vm_t *vm, rb_ractor_t *cr))
2179 VM_ASSERT(cr == GET_RACTOR());
2180 return vm->ractor.sync.lock_owner == cr;
2183static inline unsigned int
2184rb_ec_vm_lock_rec(
const rb_execution_context_t *ec)
2186 rb_vm_t *vm = rb_ec_vm_ptr(ec);
2188 if (!vm_locked_by_ractor_p(vm, rb_ec_ractor_ptr(ec))) {
2192 return vm->ractor.sync.lock_rec;
2197#error "unsupported thread model"
2201 TIMER_INTERRUPT_MASK = 0x01,
2202 PENDING_INTERRUPT_MASK = 0x02,
2203 POSTPONED_JOB_INTERRUPT_MASK = 0x04,
2204 TRAP_INTERRUPT_MASK = 0x08,
2205 TERMINATE_INTERRUPT_MASK = 0x10,
2206 VM_BARRIER_INTERRUPT_MASK = 0x20,
2209#define RUBY_VM_SET_TIMER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TIMER_INTERRUPT_MASK)
2210#define RUBY_VM_SET_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, PENDING_INTERRUPT_MASK)
2211#define RUBY_VM_SET_POSTPONED_JOB_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, POSTPONED_JOB_INTERRUPT_MASK)
2212#define RUBY_VM_SET_TRAP_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TRAP_INTERRUPT_MASK)
2213#define RUBY_VM_SET_TERMINATE_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TERMINATE_INTERRUPT_MASK)
2214#define RUBY_VM_SET_VM_BARRIER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, VM_BARRIER_INTERRUPT_MASK)
2217RUBY_VM_INTERRUPTED(rb_execution_context_t *ec)
2219 return (ATOMIC_LOAD_RELAXED(ec->interrupt_flag) & ~(ec->interrupt_mask) & (PENDING_INTERRUPT_MASK|TRAP_INTERRUPT_MASK));
2223RUBY_VM_INTERRUPTED_ANY(rb_execution_context_t *ec)
2225#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
2226 uint32_t current_clock = rb_ec_vm_ptr(ec)->clock;
2228 if (current_clock != ec->checked_clock) {
2229 ec->checked_clock = current_clock;
2230 RUBY_VM_SET_TIMER_INTERRUPT(ec);
2233 return ATOMIC_LOAD_RELAXED(ec->interrupt_flag) & ~(ec)->interrupt_mask;
2237int rb_signal_buff_size(
void);
2238int rb_signal_exec(rb_thread_t *th,
int sig);
2239void rb_threadptr_check_signal(rb_thread_t *mth);
2240void rb_threadptr_signal_raise(rb_thread_t *th,
int sig);
2241void rb_threadptr_interrupt_raise(rb_thread_t *th);
2242void rb_threadptr_signal_exit(rb_thread_t *th);
2243int rb_threadptr_execute_interrupts(rb_thread_t *,
int);
2244void rb_threadptr_interrupt(rb_thread_t *th);
2245void rb_threadptr_unlock_all_locking_mutexes(rb_thread_t *th);
2246void rb_threadptr_pending_interrupt_clear(rb_thread_t *th);
2247void rb_threadptr_pending_interrupt_enque(rb_thread_t *th,
VALUE v);
2248VALUE rb_ec_get_errinfo(
const rb_execution_context_t *ec);
2249void rb_ec_error_print(rb_execution_context_t *
volatile ec,
volatile VALUE errinfo);
2250void rb_execution_context_update(rb_execution_context_t *ec);
2251void rb_execution_context_mark(
const rb_execution_context_t *ec);
2252void rb_fiber_close(rb_fiber_t *fib);
2253void Init_native_thread(rb_thread_t *th);
2254int rb_vm_check_ints_blocking(rb_execution_context_t *ec);
2257void rb_vm_cond_wait(rb_vm_t *vm, rb_nativethread_cond_t *cond);
2258void rb_vm_cond_timedwait(rb_vm_t *vm, rb_nativethread_cond_t *cond,
unsigned long msec);
2260#define RUBY_VM_CHECK_INTS(ec) rb_vm_check_ints(ec)
2262rb_vm_check_ints(rb_execution_context_t *ec)
2264#ifdef RUBY_ASSERT_CRITICAL_SECTION
2265 VM_ASSERT(ruby_assert_critical_section_entered == 0);
2268 VM_ASSERT(ec == rb_current_ec_noinline());
2270 if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(ec))) {
2271 rb_threadptr_execute_interrupts(rb_ec_thread_ptr(ec), 0);
2279 rb_execution_context_t *ec;
2280 const rb_control_frame_t *cfp;
2294void rb_hook_list_mark(rb_hook_list_t *hooks);
2295void rb_hook_list_mark_and_move(rb_hook_list_t *hooks);
2296void rb_hook_list_free(rb_hook_list_t *hooks);
2297void rb_hook_list_connect_local_tracepoint(rb_hook_list_t *list,
VALUE tpval,
unsigned int target_line);
2298bool rb_hook_list_remove_local_tracepoint(rb_hook_list_t *list,
VALUE tpval);
2299unsigned int rb_hook_list_count(rb_hook_list_t *list);
2301void rb_exec_event_hooks(
struct rb_trace_arg_struct *trace_arg, rb_hook_list_t *hooks,
int pop_p);
2303#define EXEC_EVENT_HOOK_ORIG(ec_, hooks_, flag_, self_, id_, called_id_, klass_, data_, pop_p_) do { \
2304 const rb_event_flag_t flag_arg_ = (flag_); \
2305 rb_hook_list_t *hooks_arg_ = (hooks_); \
2306 if (UNLIKELY((hooks_arg_)->events & (flag_arg_))) { \
2308 rb_exec_event_hook_orig(ec_, hooks_arg_, flag_arg_, self_, id_, called_id_, klass_, data_, pop_p_); \
2313rb_exec_event_hook_orig(rb_execution_context_t *ec, rb_hook_list_t *hooks,
rb_event_flag_t flag,
2318 VM_ASSERT((hooks->events & flag) != 0);
2320 trace_arg.event = flag;
2322 trace_arg.cfp = ec->cfp;
2323 trace_arg.self = self;
2325 trace_arg.called_id = called_id;
2326 trace_arg.klass = klass;
2327 trace_arg.data = data;
2329 trace_arg.klass_solved = 0;
2331 rb_exec_event_hooks(&trace_arg, hooks, pop_p);
2337 rb_hook_list_t hooks;
2339 unsigned int targeted_hooks_cnt;
2342static inline rb_hook_list_t *
2343rb_ec_ractor_hooks(
const rb_execution_context_t *ec)
2346 return &cr_pub->hooks;
2349static inline rb_hook_list_t *
2350rb_vm_global_hooks(
const rb_execution_context_t *ec)
2352 return &rb_ec_vm_ptr(ec)->global_hooks;
2355static inline rb_hook_list_t *
2359 VM_ASSERT(event != 0 && ((event - 1) & event) == 0);
2362 return rb_vm_global_hooks(ec);
2365 return rb_ec_ractor_hooks(ec);
2369#define EXEC_EVENT_HOOK(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2370 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_hooks(ec_, flag_), flag_, self_, id_, called_id_, klass_, data_, 0)
2372#define EXEC_EVENT_HOOK_AND_POP_FRAME(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2373 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_hooks(ec_, flag_), flag_, self_, id_, called_id_, klass_, data_, 1)
2376rb_exec_event_hook_script_compiled(rb_execution_context_t *ec,
const rb_iseq_t *iseq,
VALUE eval_script)
2380 rb_ary_new_from_args(2, eval_script, (
VALUE)iseq));
2383void rb_vm_trap_exit(rb_vm_t *vm);
2384void rb_vm_postponed_job_atfork(
void);
2385void rb_vm_postponed_job_free(
void);
2386size_t rb_vm_memsize_postponed_job_queue(
void);
2387void rb_vm_postponed_job_queue_init(rb_vm_t *vm);
2389RUBY_SYMBOL_EXPORT_BEGIN
2391int rb_thread_check_trap_pending(
void);
2394#define RUBY_EVENT_COVERAGE_LINE 0x010000
2395#define RUBY_EVENT_COVERAGE_BRANCH 0x020000
2397extern VALUE rb_get_coverages(
void);
2398extern void rb_set_coverages(
VALUE,
int,
VALUE);
2399extern void rb_clear_coverages(
void);
2400extern void rb_reset_coverages(
void);
2401extern void rb_resume_coverages(
void);
2402extern void rb_suspend_coverages(
void);
2404void rb_postponed_job_flush(rb_vm_t *vm);
2410RUBY_SYMBOL_EXPORT_END
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ALIGNAS
Wraps (or simulates) alignas.
#define RUBY_EXTERN
Declaration of externally visible global variables.
#define RUBY_EVENT_SCRIPT_COMPILED
Encountered an eval.
#define RUBY_INTERNAL_EVENT_OBJSPACE_MASK
Bitmask of GC events.
uint32_t rb_event_flag_t
Represents event(s).
#define T_STRING
Old name of RUBY_T_STRING.
#define Qundef
Old name of RUBY_Qundef.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define NIL_P
Old name of RB_NIL_P.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
void * rb_check_typeddata(VALUE obj, const rb_data_type_t *data_type)
Identical to rb_typeddata_is_kind_of(), except it raises exceptions instead of returning false.
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
void rb_unblock_function_t(void *)
This is the type of UBFs.
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
VALUE rb_block_call_func(RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg))
This is the type of a function that the interpreter expect for C-backended blocks.
VALUE type(ANYARGS)
ANYARGS-ed function type.
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull)).
#define inline
Old Visual Studio versions do not support the inline keyword, so we need to define it to be __inline.
#define RARRAY_AREF(a, i)
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
C99 shim for <stdbool.h>.
const ID * segments
A null-terminated list of ids, used to represent a constant's path idNULL is used to represent the ::...
IFUNC (Internal FUNCtion).
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
#define SIZEOF_VALUE
Identical to sizeof(VALUE), except it is a macro that can also be used inside of preprocessor directi...
uintptr_t VALUE
Type that represents a Ruby object.