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/namespace.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
269STATIC_ASSERT(sizeof_iseq_inline_constant_cache_entry,
271 sizeof(
const rb_cref_t *)) <= RVALUE_SIZE);
319#ifndef VM_ARGC_STACK_MAX
320#define VM_ARGC_STACK_MAX 128
323# define CALLING_ARGC(calling) ((calling)->heap_argv ? RARRAY_LENINT((calling)->heap_argv) : (calling)->argc)
328#define CoreDataFromValue(obj, type) (type*)DATA_PTR(obj)
330#define CoreDataFromValue(obj, type) (type*)rb_data_object_get(obj)
332#define GetCoreDataFromValue(obj, type, ptr) ((ptr) = CoreDataFromValue((obj), type))
343#define PATHOBJ_PATH 0
344#define PATHOBJ_REALPATH 1
347pathobj_path(
VALUE pathobj)
359pathobj_realpath(
VALUE pathobj)
371typedef uintptr_t iseq_bits_t;
373#define ISEQ_IS_SIZE(body) (body->ic_size + body->ivc_size + body->ise_size + body->icvarc_size)
376#define ISEQ_IS_IC_ENTRY(body, idx) (body->is_entries[(idx) + body->ise_size + body->icvarc_size + body->ivc_size].ic_cache);
392enum rb_builtin_attr {
394 BUILTIN_ATTR_LEAF = 0x01,
396 BUILTIN_ATTR_SINGLE_NOARG_LEAF = 0x02,
398 BUILTIN_ATTR_INLINE_BLOCK = 0x04,
400 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;
477 const struct rb_iseq_param_keyword {
483 VALUE *default_values;
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;
512 rb_snum_t flip_count;
515 VALUE pc2branchindex;
516 VALUE *original_iseq;
519 unsigned int local_table_size;
520 unsigned int ic_size;
521 unsigned int ise_size;
522 unsigned int ivc_size;
523 unsigned int icvarc_size;
524 unsigned int ci_size;
525 unsigned int stack_max;
527 unsigned int builtin_attrs;
540#if USE_YJIT || USE_ZJIT
542 rb_jit_func_t jit_entry;
544 long unsigned jit_entry_calls;
546 rb_jit_func_t jit_exception;
548 long unsigned jit_exception_calls;
555 uint64_t yjit_calls_at_interv;
587#define ISEQ_BODY(iseq) ((iseq)->body)
589#if !defined(USE_LAZY_LOAD) || !(USE_LAZY_LOAD+0)
590#define USE_LAZY_LOAD 0
601 if (USE_LAZY_LOAD && ISEQ_BODY(iseq) == NULL) {
608rb_iseq_attr_p(
const rb_iseq_t *iseq,
enum rb_builtin_attr attr)
610 return (ISEQ_BODY(iseq)->builtin_attrs & attr) == attr;
618 if (def->type != VM_METHOD_TYPE_ISEQ) rb_bug(
"def_iseq_ptr: not iseq (%d)", def->type);
620 return rb_iseq_check(def->body.iseq.
iseqptr);
623enum ruby_special_exceptions {
627 ruby_error_stackfatal,
628 ruby_error_stream_closed,
629 ruby_special_error_count
632#define GetVMPtr(obj, ptr) \
633 GetCoreDataFromValue((obj), rb_vm_t, (ptr))
639 rb_vm_at_exit_func *func;
643void *rb_objspace_alloc(
void);
644void rb_objspace_free(
void *
objspace);
645void rb_objspace_call_finalizer(
void);
650 unsigned int running;
668 struct ccan_list_head set;
670 unsigned int blocking_cnt;
677 rb_nativethread_lock_t lock;
679 unsigned int lock_rec;
682 rb_nativethread_cond_t terminate_cond;
683 bool terminate_waiting;
685#ifndef RUBY_THREAD_PTHREAD_H
687 bool barrier_waiting;
688 unsigned int barrier_cnt;
689 rb_nativethread_cond_t barrier_complete_cond;
690 rb_nativethread_cond_t barrier_release_cond;
694#ifdef RUBY_THREAD_PTHREAD_H
697 rb_nativethread_lock_t lock;
701 rb_nativethread_cond_t cond;
702 unsigned int snt_cnt;
703 unsigned int dnt_cnt;
705 unsigned int running_cnt;
707 unsigned int max_cpu;
708 struct ccan_list_head grq;
709 unsigned int grq_cnt;
712 struct ccan_list_head running_threads;
715 struct ccan_list_head timeslice_threads;
717 struct ccan_list_head zombie_threads;
720 bool timeslice_wait_inf;
723 rb_nativethread_cond_t barrier_complete_cond;
724 rb_nativethread_cond_t barrier_release_cond;
725 bool barrier_waiting;
726 unsigned int barrier_waiting_cnt;
727 unsigned int barrier_serial;
729 unsigned int barrier_lock_rec;
734#ifdef USE_SIGALTSTACK
738 rb_serial_t fork_gen;
741 volatile int ubf_async_safe;
743 unsigned int running: 1;
744 unsigned int thread_abort_on_exception: 1;
745 unsigned int thread_report_on_exception: 1;
746 unsigned int thread_ignore_deadlock: 1;
749 VALUE mark_object_ary;
751 const VALUE special_exceptions[ruby_special_error_count];
759 VALUE load_path_snapshot;
760 VALUE load_path_check_cache;
761 VALUE expanded_load_path;
762 VALUE loaded_features;
763 VALUE loaded_features_snapshot;
764 VALUE loaded_features_realpaths;
765 VALUE loaded_features_realpath_map;
766 struct st_table *loaded_features_index;
774 VALUE cmd[RUBY_NSIG];
780 int src_encoding_index;
783 struct ccan_list_head workqueue;
784 rb_nativethread_lock_t workqueue_lock;
786 VALUE orig_progname, progname;
787 VALUE coverages, me2counter;
792 struct gc_mark_func_data_struct {
794 void (*mark_func)(
VALUE v,
void *data);
813 ID inserting_constant_cache_id;
815#ifndef VM_GLOBAL_CC_CACHE_TABLE_SIZE
816#define VM_GLOBAL_CC_CACHE_TABLE_SIZE 1023
818 const struct rb_callcache *global_cc_cache_table[VM_GLOBAL_CC_CACHE_TABLE_SIZE];
820#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
826 size_t thread_vm_stack_size;
827 size_t thread_machine_stack_size;
828 size_t fiber_vm_stack_size;
829 size_t fiber_machine_stack_size;
838#define RUBY_VM_SIZE_ALIGN 4096
840#define RUBY_VM_THREAD_VM_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
841#define RUBY_VM_THREAD_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
842#define RUBY_VM_THREAD_MACHINE_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
843#define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
845#define RUBY_VM_FIBER_VM_STACK_SIZE ( 16 * 1024 * sizeof(VALUE))
846#define RUBY_VM_FIBER_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
847#define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 64 * 1024 * sizeof(VALUE))
848#if defined(__powerpc64__) || defined(__ppc64__)
849#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 32 * 1024 * sizeof(VALUE))
851#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
854#if __has_feature(memory_sanitizer) || __has_feature(address_sanitizer)
856#undef RUBY_VM_THREAD_MACHINE_STACK_SIZE
857#define RUBY_VM_THREAD_MACHINE_STACK_SIZE (1024 * 1024 * sizeof(VALUE))
858#undef RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN
859#define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 512 * 1024 * sizeof(VALUE))
860#undef RUBY_VM_FIBER_MACHINE_STACK_SIZE
861#define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 256 * 1024 * sizeof(VALUE))
862#undef RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN
863#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 128 * 1024 * sizeof(VALUE))
866#ifndef VM_DEBUG_BP_CHECK
867#define VM_DEBUG_BP_CHECK 0
870#ifndef VM_DEBUG_VERIFY_METHOD_CACHE
871#define VM_DEBUG_VERIFY_METHOD_CACHE (VMDEBUG != 0)
884enum rb_block_handler_type {
885 block_handler_type_iseq,
886 block_handler_type_ifunc,
887 block_handler_type_symbol,
888 block_handler_type_proc
904 enum rb_block_type
type;
913 const void *block_code;
923rb_thread_ptr(
VALUE thval)
928enum rb_thread_status {
931 THREAD_STOPPED_FOREVER,
936typedef RUBY_JMP_BUF rb_jmpbuf_t;
938typedef void *rb_jmpbuf_t[5];
953#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
963typedef rb_jmpbuf_t *rb_vm_tag_jmpbuf_t;
965#define RB_VM_TAG_JMPBUF_GET(buf) (*buf)
968rb_vm_tag_jmpbuf_init(rb_vm_tag_jmpbuf_t *jmpbuf)
970 *jmpbuf = ruby_xmalloc(
sizeof(rb_jmpbuf_t));
974rb_vm_tag_jmpbuf_deinit(
const rb_vm_tag_jmpbuf_t *jmpbuf)
979typedef rb_jmpbuf_t rb_vm_tag_jmpbuf_t;
981#define RB_VM_TAG_JMPBUF_GET(buf) (buf)
984rb_vm_tag_jmpbuf_init(rb_vm_tag_jmpbuf_t *jmpbuf)
990rb_vm_tag_jmpbuf_deinit(
const rb_vm_tag_jmpbuf_t *jmpbuf)
1003 rb_vm_tag_jmpbuf_t buf;
1005 enum ruby_tag_type state;
1006 unsigned int lock_rec;
1009STATIC_ASSERT(rb_vm_tag_buf_offset, offsetof(
struct rb_vm_tag, buf) > 0);
1010STATIC_ASSERT(rb_vm_tag_buf_end,
1011 offsetof(
struct rb_vm_tag, buf) +
sizeof(rb_vm_tag_jmpbuf_t) <
1032 size_t vm_stack_size;
1040#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
1041 uint32_t checked_clock;
1049 VALUE local_storage_recursive_hash;
1050 VALUE local_storage_recursive_hash_for_trace;
1056 const VALUE *root_lep;
1064 VALUE passed_block_handler;
1066 uint8_t raised_flag;
1069 BITFIELD(
enum method_missing_reason, method_missing_reason, 8);
1071 VALUE private_const_reference;
1077 size_t stack_maxsize;
1080#ifdef RUBY_ASAN_ENABLED
1081 void *asan_fake_stack_handle;
1086#ifndef rb_execution_context_t
1088#define rb_execution_context_t rb_execution_context_t
1092#define VM_CORE_H_EC_DEFINED 1
1116 struct ccan_list_node lt_node;
1124 bool mn_schedulable;
1141 BITFIELD(
enum rb_thread_status, status, 2);
1143 unsigned int has_dedicated_nt : 1;
1144 unsigned int to_kill : 1;
1145 unsigned int abort_on_exception: 1;
1146 unsigned int report_on_exception: 1;
1147 unsigned int pending_interrupt_queue_checked: 1;
1149 uint32_t running_time_us;
1151 void *blocking_region_buffer;
1157#if OPT_CALL_THREADED_CODE
1162 VALUE pending_interrupt_queue;
1163 VALUE pending_interrupt_mask_stack;
1166 rb_nativethread_lock_t interrupt_lock;
1168 VALUE locking_mutex;
1170 struct ccan_list_head interrupt_exec_tasks;
1181 VALUE (*func)(
void *);
1186 enum thread_invoke_type {
1187 thread_invoke_type_none = 0,
1188 thread_invoke_type_proc,
1189 thread_invoke_type_ractor_proc,
1190 thread_invoke_type_func
1197 unsigned int blocking;
1201 void **specific_storage;
1206static inline unsigned int
1209 return th ? (
unsigned int)th->serial : 0;
1213 VM_DEFINECLASS_TYPE_CLASS = 0x00,
1214 VM_DEFINECLASS_TYPE_SINGLETON_CLASS = 0x01,
1215 VM_DEFINECLASS_TYPE_MODULE = 0x02,
1217 VM_DEFINECLASS_TYPE_MASK = 0x07
1218} rb_vm_defineclass_type_t;
1220#define VM_DEFINECLASS_TYPE(x) ((rb_vm_defineclass_type_t)(x) & VM_DEFINECLASS_TYPE_MASK)
1221#define VM_DEFINECLASS_FLAG_SCOPED 0x08
1222#define VM_DEFINECLASS_FLAG_HAS_SUPERCLASS 0x10
1223#define VM_DEFINECLASS_SCOPED_P(x) ((x) & VM_DEFINECLASS_FLAG_SCOPED)
1224#define VM_DEFINECLASS_HAS_SUPERCLASS_P(x) \
1225 ((x) & VM_DEFINECLASS_FLAG_HAS_SUPERCLASS)
1228RUBY_SYMBOL_EXPORT_BEGIN
1237 VALUE script_lines);
1247rb_iseq_new_with_callback_new_callback(
1270RUBY_SYMBOL_EXPORT_END
1272#define GetProcPtr(obj, ptr) \
1273 GetCoreDataFromValue((obj), rb_proc_t, (ptr))
1278 unsigned int is_from_method: 1;
1279 unsigned int is_lambda: 1;
1280 unsigned int is_isolated: 1;
1283RUBY_SYMBOL_EXPORT_BEGIN
1286VALUE rb_proc_ractor_make_shareable(
VALUE self);
1287RUBY_SYMBOL_EXPORT_END
1294 unsigned int env_size;
1299#define GetBindingPtr(obj, ptr) \
1300 GetCoreDataFromValue((obj), rb_binding_t, (ptr))
1304 const VALUE pathobj;
1310enum vm_check_match_type {
1311 VM_CHECKMATCH_TYPE_WHEN = 1,
1312 VM_CHECKMATCH_TYPE_CASE = 2,
1313 VM_CHECKMATCH_TYPE_RESCUE = 3
1316#define VM_CHECKMATCH_TYPE_MASK 0x03
1317#define VM_CHECKMATCH_ARRAY 0x04
1319enum vm_opt_newarray_send_type {
1320 VM_OPT_NEWARRAY_SEND_MAX = 1,
1321 VM_OPT_NEWARRAY_SEND_MIN = 2,
1322 VM_OPT_NEWARRAY_SEND_HASH = 3,
1323 VM_OPT_NEWARRAY_SEND_PACK = 4,
1324 VM_OPT_NEWARRAY_SEND_PACK_BUFFER = 5,
1325 VM_OPT_NEWARRAY_SEND_INCLUDE_P = 6,
1328enum vm_special_object_type {
1329 VM_SPECIAL_OBJECT_VMCORE = 1,
1330 VM_SPECIAL_OBJECT_CBASE,
1331 VM_SPECIAL_OBJECT_CONST_BASE
1335 VM_SVAR_LASTLINE = 0,
1336 VM_SVAR_BACKREF = 1,
1338 VM_SVAR_EXTRA_START = 2,
1339 VM_SVAR_FLIPFLOP_START = 2
1351typedef VALUE CDHASH;
1353#ifndef FUNC_FASTCALL
1354#define FUNC_FASTCALL(x) x
1360#define VM_TAGGED_PTR_SET(p, tag) ((VALUE)(p) | (tag))
1361#define VM_TAGGED_PTR_REF(v, mask) ((void *)((v) & ~mask))
1363#define GC_GUARDED_PTR(p) VM_TAGGED_PTR_SET((p), 0x01)
1364#define GC_GUARDED_PTR_REF(p) VM_TAGGED_PTR_REF((p), 0x03)
1365#define GC_GUARDED_PTR_P(p) (((VALUE)(p)) & 0x01)
1367enum vm_frame_env_flags {
1378 VM_FRAME_MAGIC_METHOD = 0x11110001,
1379 VM_FRAME_MAGIC_BLOCK = 0x22220001,
1380 VM_FRAME_MAGIC_CLASS = 0x33330001,
1381 VM_FRAME_MAGIC_TOP = 0x44440001,
1382 VM_FRAME_MAGIC_CFUNC = 0x55550001,
1383 VM_FRAME_MAGIC_IFUNC = 0x66660001,
1384 VM_FRAME_MAGIC_EVAL = 0x77770001,
1385 VM_FRAME_MAGIC_RESCUE = 0x78880001,
1386 VM_FRAME_MAGIC_DUMMY = 0x79990001,
1388 VM_FRAME_MAGIC_MASK = 0x7fff0001,
1391 VM_FRAME_FLAG_FINISH = 0x0020,
1392 VM_FRAME_FLAG_BMETHOD = 0x0040,
1393 VM_FRAME_FLAG_CFRAME = 0x0080,
1394 VM_FRAME_FLAG_LAMBDA = 0x0100,
1395 VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM = 0x0200,
1396 VM_FRAME_FLAG_CFRAME_KW = 0x0400,
1397 VM_FRAME_FLAG_PASSED = 0x0800,
1398 VM_FRAME_FLAG_NS_SWITCH = 0x1000,
1399 VM_FRAME_FLAG_LOAD_ISEQ = 0x2000,
1402 VM_ENV_FLAG_LOCAL = 0x0002,
1403 VM_ENV_FLAG_ESCAPED = 0x0004,
1404 VM_ENV_FLAG_WB_REQUIRED = 0x0008,
1405 VM_ENV_FLAG_ISOLATED = 0x0010,
1408#define VM_ENV_DATA_SIZE ( 3)
1410#define VM_ENV_DATA_INDEX_ME_CREF (-2)
1411#define VM_ENV_DATA_INDEX_SPECVAL (-1)
1412#define VM_ENV_DATA_INDEX_FLAGS ( 0)
1413#define VM_ENV_DATA_INDEX_ENV ( 1)
1415#define VM_ENV_INDEX_LAST_LVAR (-VM_ENV_DATA_SIZE)
1417static inline void VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *ptr,
VALUE special_const_value);
1422 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1424 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags | flag);
1428VM_ENV_FLAGS_UNSET(
const VALUE *ep,
VALUE flag)
1430 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1432 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags & ~flag);
1435static inline unsigned long
1436VM_ENV_FLAGS(
const VALUE *ep,
long flag)
1438 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1440 return flags & flag;
1443static inline unsigned long
1446 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_MAGIC_MASK);
1452 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_LAMBDA) != 0;
1458 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME_KW) != 0;
1464 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_FINISH) != 0;
1470 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BMETHOD) != 0;
1474rb_obj_is_iseq(
VALUE iseq)
1476 return imemo_type_p(iseq, imemo_iseq);
1479#if VM_CHECK_MODE > 0
1480#define RUBY_VM_NORMAL_ISEQ_P(iseq) rb_obj_is_iseq((VALUE)iseq)
1486 int cframe_p = VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME) != 0;
1487 VM_ASSERT(RUBY_VM_NORMAL_ISEQ_P(cfp->iseq) != cframe_p ||
1488 (VM_FRAME_TYPE(cfp) & VM_FRAME_MAGIC_MASK) == VM_FRAME_MAGIC_DUMMY);
1495 return !VM_FRAME_CFRAME_P(cfp);
1501 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_NS_SWITCH) != 0;
1504#define RUBYVM_CFUNC_FRAME_P(cfp) \
1505 (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
1507#define VM_GUARDED_PREV_EP(ep) GC_GUARDED_PTR(ep)
1508#define VM_BLOCK_HANDLER_NONE 0
1511VM_ENV_LOCAL_P(
const VALUE *ep)
1513 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_LOCAL) ? 1 : 0;
1516static inline const VALUE *
1517VM_ENV_PREV_EP(
const VALUE *ep)
1519 VM_ASSERT(VM_ENV_LOCAL_P(ep) == 0);
1520 return GC_GUARDED_PTR_REF(ep[VM_ENV_DATA_INDEX_SPECVAL]);
1524VM_ENV_BLOCK_HANDLER(
const VALUE *ep)
1526 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1527 return ep[VM_ENV_DATA_INDEX_SPECVAL];
1530#if VM_CHECK_MODE > 0
1531int rb_vm_ep_in_heap_p(
const VALUE *ep);
1535VM_ENV_ESCAPED_P(
const VALUE *ep)
1537 VM_ASSERT(rb_vm_ep_in_heap_p(ep) == !!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
1538 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) ? 1 : 0;
1543VM_ENV_ENVVAL(const
VALUE *ep)
1545 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV];
1546 VM_ASSERT(VM_ENV_ESCAPED_P(ep));
1547 VM_ASSERT(envval ==
Qundef || imemo_type_p(envval, imemo_env));
1553VM_ENV_ENVVAL_PTR(const
VALUE *ep)
1555 return (
const rb_env_t *)VM_ENV_ENVVAL(ep);
1563 env->env = env_body;
1564 env->env_size = env_size;
1565 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1572 *((
VALUE *)ptr) = v;
1576VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *ptr,
VALUE special_const_value)
1579 VM_FORCE_WRITE(ptr, special_const_value);
1583VM_STACK_ENV_WRITE(
const VALUE *ep,
int index,
VALUE v)
1585 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_WB_REQUIRED) == 0);
1586 VM_FORCE_WRITE(&ep[index], v);
1589const VALUE *rb_vm_ep_local_ep(
const VALUE *ep);
1596#define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) ((cfp)+1)
1597#define RUBY_VM_NEXT_CONTROL_FRAME(cfp) ((cfp)-1)
1599#define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
1600 ((void *)(ecfp) > (void *)(cfp))
1611 return !RUBY_VM_VALID_CONTROL_FRAME_P(cfp, RUBY_VM_END_CONTROL_FRAME(ec));
1615VM_BH_ISEQ_BLOCK_P(
VALUE block_handler)
1617 if ((block_handler & 0x03) == 0x01) {
1618#if VM_CHECK_MODE > 0
1620 VM_ASSERT(imemo_type_p(captured->code.val, imemo_iseq));
1632 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x01);
1633 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1634 return block_handler;
1638VM_BH_TO_ISEQ_BLOCK(
VALUE block_handler)
1641 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1646VM_BH_IFUNC_P(
VALUE block_handler)
1648 if ((block_handler & 0x03) == 0x03) {
1649#if VM_CHECK_MODE > 0
1651 VM_ASSERT(imemo_type_p(captured->code.val, imemo_ifunc));
1663 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x03);
1664 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1665 return block_handler;
1669VM_BH_TO_IFUNC_BLOCK(
VALUE block_handler)
1672 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1677VM_BH_TO_CAPT_BLOCK(
VALUE block_handler)
1680 VM_ASSERT(VM_BH_IFUNC_P(block_handler) || VM_BH_ISEQ_BLOCK_P(block_handler));
1684static inline enum rb_block_handler_type
1685vm_block_handler_type(
VALUE block_handler)
1687 if (VM_BH_ISEQ_BLOCK_P(block_handler)) {
1688 return block_handler_type_iseq;
1690 else if (VM_BH_IFUNC_P(block_handler)) {
1691 return block_handler_type_ifunc;
1693 else if (
SYMBOL_P(block_handler)) {
1694 return block_handler_type_symbol;
1698 return block_handler_type_proc;
1703vm_block_handler_verify(MAYBE_UNUSED(
VALUE block_handler))
1705 VM_ASSERT(block_handler == VM_BLOCK_HANDLER_NONE ||
1706 (vm_block_handler_type(block_handler), 1));
1709static inline enum rb_block_type
1710vm_block_type(
const struct rb_block *block)
1712#if VM_CHECK_MODE > 0
1713 switch (block->type) {
1714 case block_type_iseq:
1715 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_iseq));
1717 case block_type_ifunc:
1718 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_ifunc));
1720 case block_type_symbol:
1721 VM_ASSERT(
SYMBOL_P(block->as.symbol));
1723 case block_type_proc:
1732vm_block_type_set(
const struct rb_block *block,
enum rb_block_type
type)
1738static inline const struct rb_block *
1739vm_proc_block(
VALUE procval)
1746static inline const VALUE *vm_block_ep(
const struct rb_block *block);
1749vm_proc_iseq(
VALUE procval)
1751 return vm_block_iseq(vm_proc_block(procval));
1754static inline const VALUE *
1755vm_proc_ep(
VALUE procval)
1757 return vm_block_ep(vm_proc_block(procval));
1761vm_block_iseq(
const struct rb_block *block)
1763 switch (vm_block_type(block)) {
1764 case block_type_iseq:
return rb_iseq_check(block->as.captured.code.iseq);
1765 case block_type_proc:
return vm_proc_iseq(block->as.proc);
1766 case block_type_ifunc:
1767 case block_type_symbol:
return NULL;
1769 VM_UNREACHABLE(vm_block_iseq);
1773static inline const VALUE *
1774vm_block_ep(
const struct rb_block *block)
1776 switch (vm_block_type(block)) {
1777 case block_type_iseq:
1778 case block_type_ifunc:
return block->as.captured.ep;
1779 case block_type_proc:
return vm_proc_ep(block->as.proc);
1780 case block_type_symbol:
return NULL;
1782 VM_UNREACHABLE(vm_block_ep);
1787vm_block_self(
const struct rb_block *block)
1789 switch (vm_block_type(block)) {
1790 case block_type_iseq:
1791 case block_type_ifunc:
1792 return block->as.captured.self;
1793 case block_type_proc:
1794 return vm_block_self(vm_proc_block(block->as.proc));
1795 case block_type_symbol:
1798 VM_UNREACHABLE(vm_block_self);
1803VM_BH_TO_SYMBOL(
VALUE block_handler)
1805 VM_ASSERT(
SYMBOL_P(block_handler));
1806 return block_handler;
1810VM_BH_FROM_SYMBOL(
VALUE symbol)
1817VM_BH_TO_PROC(
VALUE block_handler)
1820 return block_handler;
1824VM_BH_FROM_PROC(
VALUE procval)
1841#define SDR() rb_vmdebug_stack_dump_raw(GET_EC(), GET_EC()->cfp, stderr)
1842#define SDR2(cfp) rb_vmdebug_stack_dump_raw(GET_EC(), (cfp), stderr)
1843bool rb_vm_bugreport(
const void *,
FILE *);
1844typedef void (*ruby_sighandler_t)(int);
1846NORETURN(
void rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler,
int sig, const
void *, const
char *fmt, ...));
1849RUBY_SYMBOL_EXPORT_BEGIN
1855RUBY_SYMBOL_EXPORT_END
1869 return rb_vm_make_proc_lambda(ec, captured, klass, 0);
1875 return rb_vm_make_proc_lambda(ec, captured, klass, 1);
1883void rb_vm_inc_const_missing_count(
void);
1889void rb_thread_start_timer_thread(
void);
1890void rb_thread_stop_timer_thread(
void);
1891void rb_thread_reset_timer_thread(
void);
1892void rb_thread_wakeup_timer_thread(
int);
1895rb_vm_living_threads_init(
rb_vm_t *vm)
1897 ccan_list_head_init(&vm->workqueue);
1898 ccan_list_head_init(&vm->ractor.set);
1899#ifdef RUBY_THREAD_PTHREAD_H
1900 ccan_list_head_init(&vm->ractor.sched.zombie_threads);
1904typedef int rb_backtrace_iter_func(
void *,
VALUE,
int,
VALUE);
1910void ruby_thread_init_stack(
rb_thread_t *th,
void *local_in_parent_frame);
1915void rb_vm_env_write(
const VALUE *ep,
int index,
VALUE v);
1918void rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp,
VALUE exception_class,
VALUE mesg);
1920#define rb_vm_register_special_exception(sp, e, m) \
1921 rb_vm_register_special_exception_str(sp, e, rb_usascii_str_new_static((m), (long)rb_strlen_lit(m)))
1929#define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
1931#define CHECK_VM_STACK_OVERFLOW0(cfp, sp, margin) do { \
1932 STATIC_ASSERT(sizeof_sp, sizeof(*(sp)) == sizeof(VALUE)); \
1933 STATIC_ASSERT(sizeof_cfp, sizeof(*(cfp)) == sizeof(rb_control_frame_t)); \
1934 const struct rb_control_frame_struct *bound = (void *)&(sp)[(margin)]; \
1935 if (UNLIKELY((cfp) <= &bound[1])) { \
1936 vm_stackoverflow(); \
1940#define CHECK_VM_STACK_OVERFLOW(cfp, margin) \
1941 CHECK_VM_STACK_OVERFLOW0((cfp), (cfp)->sp, (margin))
1949#if RUBY_VM_THREAD_MODEL == 2
1957#define GET_VM() rb_current_vm()
1958#define GET_RACTOR() rb_current_ractor()
1959#define GET_THREAD() rb_current_thread()
1960#define GET_EC() rb_current_execution_context(true)
1965 return ec->thread_ptr;
1973 VM_ASSERT(th->ractor != NULL);
1996rb_current_execution_context(
bool expect_ec)
1998#ifdef RB_THREAD_LOCAL_SPECIFIER
1999 #if defined(__arm64__) || defined(__aarch64__)
2017 VM_ASSERT(ec == rb_current_ec_noinline());
2021 VM_ASSERT(!expect_ec || ec != NULL);
2026rb_current_thread(
void)
2029 return rb_ec_thread_ptr(ec);
2033rb_current_ractor_raw(
bool expect)
2035 if (ruby_single_main_ractor) {
2036 return ruby_single_main_ractor;
2040 return (expect || ec) ? rb_ec_ractor_ptr(ec) : NULL;
2045rb_current_ractor(
void)
2047 return rb_current_ractor_raw(
true);
2054 VM_ASSERT(ruby_current_vm_ptr == NULL ||
2055 ruby_current_execution_context_ptr == NULL ||
2056 rb_ec_thread_ptr(GET_EC()) == NULL ||
2057 rb_ec_thread_ptr(GET_EC())->status == THREAD_KILLED ||
2058 rb_ec_vm_ptr(GET_EC()) == ruby_current_vm_ptr);
2061 return ruby_current_vm_ptr;
2065 unsigned int recorded_lock_rec,
2066 unsigned int current_lock_rec);
2068static inline unsigned int
2071 rb_vm_t *vm = rb_ec_vm_ptr(ec);
2073 if (vm->ractor.sync.lock_owner != rb_ec_ractor_ptr(ec)) {
2077 return vm->ractor.sync.lock_rec;
2082#error "unsupported thread model"
2086 TIMER_INTERRUPT_MASK = 0x01,
2087 PENDING_INTERRUPT_MASK = 0x02,
2088 POSTPONED_JOB_INTERRUPT_MASK = 0x04,
2089 TRAP_INTERRUPT_MASK = 0x08,
2090 TERMINATE_INTERRUPT_MASK = 0x10,
2091 VM_BARRIER_INTERRUPT_MASK = 0x20,
2094#define RUBY_VM_SET_TIMER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TIMER_INTERRUPT_MASK)
2095#define RUBY_VM_SET_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, PENDING_INTERRUPT_MASK)
2096#define RUBY_VM_SET_POSTPONED_JOB_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, POSTPONED_JOB_INTERRUPT_MASK)
2097#define RUBY_VM_SET_TRAP_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TRAP_INTERRUPT_MASK)
2098#define RUBY_VM_SET_TERMINATE_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TERMINATE_INTERRUPT_MASK)
2099#define RUBY_VM_SET_VM_BARRIER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, VM_BARRIER_INTERRUPT_MASK)
2104 return (ATOMIC_LOAD_RELAXED(ec->interrupt_flag) & ~(ec->interrupt_mask) & (PENDING_INTERRUPT_MASK|TRAP_INTERRUPT_MASK));
2110#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
2111 uint32_t current_clock = rb_ec_vm_ptr(ec)->clock;
2113 if (current_clock != ec->checked_clock) {
2114 ec->checked_clock = current_clock;
2115 RUBY_VM_SET_TIMER_INTERRUPT(ec);
2118 return ATOMIC_LOAD_RELAXED(ec->interrupt_flag) & ~(ec)->interrupt_mask;
2122int rb_signal_buff_size(
void);
2125void rb_threadptr_signal_raise(
rb_thread_t *th,
int sig);
2127int rb_threadptr_execute_interrupts(
rb_thread_t *,
int);
2129void rb_threadptr_unlock_all_locking_mutexes(
rb_thread_t *th);
2130void rb_threadptr_pending_interrupt_clear(
rb_thread_t *th);
2141void rb_vm_cond_wait(
rb_vm_t *vm, rb_nativethread_cond_t *cond);
2142void rb_vm_cond_timedwait(
rb_vm_t *vm, rb_nativethread_cond_t *cond,
unsigned long msec);
2144#define RUBY_VM_CHECK_INTS(ec) rb_vm_check_ints(ec)
2148#ifdef RUBY_ASSERT_CRITICAL_SECTION
2149 VM_ASSERT(ruby_assert_critical_section_entered == 0);
2152 VM_ASSERT(ec == rb_current_ec_noinline());
2154 if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(ec))) {
2155 rb_threadptr_execute_interrupts(rb_ec_thread_ptr(ec), 0);
2186#define EXEC_EVENT_HOOK_ORIG(ec_, hooks_, flag_, self_, id_, called_id_, klass_, data_, pop_p_) do { \
2187 const rb_event_flag_t flag_arg_ = (flag_); \
2188 rb_hook_list_t *hooks_arg_ = (hooks_); \
2189 if (UNLIKELY((hooks_arg_)->events & (flag_arg_))) { \
2191 rb_exec_event_hook_orig(ec_, hooks_arg_, flag_arg_, self_, id_, called_id_, klass_, data_, pop_p_); \
2201 VM_ASSERT((hooks->events & flag) != 0);
2203 trace_arg.event = flag;
2205 trace_arg.cfp = ec->cfp;
2206 trace_arg.self = self;
2208 trace_arg.called_id = called_id;
2209 trace_arg.klass = klass;
2210 trace_arg.data = data;
2212 trace_arg.klass_solved = 0;
2214 rb_exec_event_hooks(&trace_arg, hooks, pop_p);
2227 return &cr_pub->hooks;
2230#define EXEC_EVENT_HOOK(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2231 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_ractor_hooks(ec_), flag_, self_, id_, called_id_, klass_, data_, 0)
2233#define EXEC_EVENT_HOOK_AND_POP_FRAME(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2234 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_ractor_hooks(ec_), flag_, self_, id_, called_id_, klass_, data_, 1)
2241 rb_ary_new_from_args(2, eval_script, (
VALUE)iseq));
2244void rb_vm_trap_exit(
rb_vm_t *vm);
2245void rb_vm_postponed_job_atfork(
void);
2246void rb_vm_postponed_job_free(
void);
2247size_t rb_vm_memsize_postponed_job_queue(
void);
2248void rb_vm_postponed_job_queue_init(
rb_vm_t *vm);
2250RUBY_SYMBOL_EXPORT_BEGIN
2252int rb_thread_check_trap_pending(
void);
2255#define RUBY_EVENT_COVERAGE_LINE 0x010000
2256#define RUBY_EVENT_COVERAGE_BRANCH 0x020000
2258extern VALUE rb_get_coverages(
void);
2259extern void rb_set_coverages(
VALUE,
int,
VALUE);
2260extern void rb_clear_coverages(
void);
2261extern void rb_reset_coverages(
void);
2262extern void rb_resume_coverages(
void);
2263extern void rb_suspend_coverages(
void);
2265void rb_postponed_job_flush(
rb_vm_t *vm);
2271RUBY_SYMBOL_EXPORT_END
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.
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.
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.
Functions related to nodes in the AST.
#define RARRAY_AREF(a, i)
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
const ID * segments
A null-terminated list of ids, used to represent a constant's path idNULL is used to represent the ::...
This is the struct that holds necessary info for a struct.
struct rb_iseq_constant_body::@154 param
parameter information
const rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
Internal header for Namespace.
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.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.