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"
57#define VM_ASSERT(expr) RUBY_ASSERT_MESG_WHEN(VM_CHECK_MODE > 0, expr, #expr)
58#define VM_UNREACHABLE(func) rb_bug(#func ": unreachable")
61#define VM_ASSERT(expr) ((void)0)
62#define VM_UNREACHABLE(func) UNREACHABLE
68#include "ccan/list/list.h"
71#include "internal/array.h"
72#include "internal/serial.h"
73#include "internal/vm.h"
78#include "ruby_atomic.h"
85#define RUBY_VM_THREAD_MODEL 2
93#ifndef VM_INSN_INFO_TABLE_IMPL
94# define VM_INSN_INFO_TABLE_IMPL 2
100#elif defined(_SIG_MAXSIG)
102# define NSIG _SIG_MAXSIG
103#elif defined(_SIGMAX)
104# define NSIG (_SIGMAX + 1)
108# define NSIG (sizeof(sigset_t) * CHAR_BIT + 1)
111#define RUBY_NSIG NSIG
114# define RUBY_SIGCHLD (SIGCLD)
115#elif defined(SIGCHLD)
116# define RUBY_SIGCHLD (SIGCHLD)
118# define RUBY_SIGCHLD (0)
122#if defined(__APPLE__)
123# define SIGCHLD_LOSSY (1)
125# define SIGCHLD_LOSSY (0)
129#define WAITPID_USE_SIGCHLD (RUBY_SIGCHLD || SIGCHLD_LOSSY)
131#if defined(SIGSEGV) && defined(HAVE_SIGALTSTACK) && defined(SA_SIGINFO) && !defined(__NetBSD__)
132# define USE_SIGALTSTACK
133void *rb_allocate_sigaltstack(
void);
134void *rb_register_sigaltstack(
void *);
135# define RB_ALTSTACK_INIT(var, altstack) var = rb_register_sigaltstack(altstack)
136# define RB_ALTSTACK_FREE(var) free(var)
137# define RB_ALTSTACK(var) var
139# define RB_ALTSTACK_INIT(var, altstack)
140# define RB_ALTSTACK_FREE(var)
141# define RB_ALTSTACK(var) (0)
149#if defined(__GNUC__) && __GNUC__ >= 2
151#if OPT_TOKEN_THREADED_CODE
152#if OPT_DIRECT_THREADED_CODE
153#undef OPT_DIRECT_THREADED_CODE
160#if OPT_DIRECT_THREADED_CODE
161#undef OPT_DIRECT_THREADED_CODE
163#if OPT_TOKEN_THREADED_CODE
164#undef OPT_TOKEN_THREADED_CODE
169#if OPT_CALL_THREADED_CODE
170#if OPT_DIRECT_THREADED_CODE
171#undef OPT_DIRECT_THREADED_CODE
174#undef OPT_STACK_CACHING
178void rb_vm_encoded_insn_data_table_init(
void);
179typedef unsigned long rb_num_t;
180typedef signed long rb_snum_t;
184 RUBY_TAG_RETURN = 0x1,
185 RUBY_TAG_BREAK = 0x2,
187 RUBY_TAG_RETRY = 0x4,
189 RUBY_TAG_RAISE = 0x6,
190 RUBY_TAG_THROW = 0x7,
191 RUBY_TAG_FATAL = 0x8,
195#define TAG_NONE RUBY_TAG_NONE
196#define TAG_RETURN RUBY_TAG_RETURN
197#define TAG_BREAK RUBY_TAG_BREAK
198#define TAG_NEXT RUBY_TAG_NEXT
199#define TAG_RETRY RUBY_TAG_RETRY
200#define TAG_REDO RUBY_TAG_REDO
201#define TAG_RAISE RUBY_TAG_RAISE
202#define TAG_THROW RUBY_TAG_THROW
203#define TAG_FATAL RUBY_TAG_FATAL
204#define TAG_MASK RUBY_TAG_MASK
206enum ruby_vm_throw_flags {
207 VM_THROW_NO_ESCAPE_FLAG = 0x8000,
208 VM_THROW_STATE_MASK = 0xff
231STATIC_ASSERT(sizeof_iseq_inline_constant_cache_entry,
235#if SIZEOF_SERIAL_T <= SIZEOF_VALUE
237#define GET_IC_SERIAL(ice) (ice)->ic_serial.raw
238#define SET_IC_SERIAL(ice, v) (ice)->ic_serial.raw = (v)
242static inline rb_serial_t
246 tmp.data[0] = ice->ic_serial.data[0];
247 tmp.data[1] = ice->ic_serial.data[1];
251#define GET_IC_SERIAL(ice) get_ic_serial(ice)
258 ice->ic_serial.data[0] = tmp.data[0];
259 ice->ic_serial.data[1] = tmp.data[1];
262#define SET_IC_SERIAL(ice, v) set_ic_serial((ice), (v))
270 unsigned get_insn_idx;
302#define CoreDataFromValue(obj, type) (type*)DATA_PTR(obj)
304#define CoreDataFromValue(obj, type) (type*)rb_data_object_get(obj)
306#define GetCoreDataFromValue(obj, type, ptr) ((ptr) = CoreDataFromValue((obj), type))
317#define PATHOBJ_PATH 0
318#define PATHOBJ_REALPATH 1
321pathobj_path(VALUE pathobj)
333pathobj_realpath(VALUE pathobj)
364 unsigned int iseq_size;
392 unsigned int has_lead : 1;
393 unsigned int has_opt : 1;
394 unsigned int has_rest : 1;
395 unsigned int has_post : 1;
396 unsigned int has_kw : 1;
397 unsigned int has_kwrest : 1;
398 unsigned int has_block : 1;
400 unsigned int ambiguous_param0 : 1;
401 unsigned int accepts_no_kwarg : 1;
402 unsigned int ruby2_keywords: 1;
414 const VALUE *opt_table;
429 const struct rb_iseq_param_keyword {
435 VALUE *default_values;
442 struct iseq_insn_info {
444 unsigned int *positions;
446#if VM_INSN_INFO_TABLE_IMPL == 2
451 const ID *local_table;
464 rb_snum_t flip_count;
467 VALUE pc2branchindex;
468 VALUE *original_iseq;
471 unsigned int local_table_size;
472 unsigned int is_size;
473 unsigned int ci_size;
474 unsigned int stack_max;
482 bool builtin_inline_p;
491 long unsigned total_calls;
516 rb_event_flag_t global_trace_events;
522#define USE_LAZY_LOAD 0
533 if (iseq->body == NULL) {
545 if (def->type != VM_METHOD_TYPE_ISEQ)
rb_bug(
"def_iseq_ptr: not iseq (%d)", def->type);
547 return rb_iseq_check(def->body.iseq.
iseqptr);
550enum ruby_special_exceptions {
554 ruby_error_stackfatal,
555 ruby_error_stream_closed,
556 ruby_special_error_count
559enum ruby_basic_operators {
593#define GetVMPtr(obj, ptr) \
594 GetCoreDataFromValue((obj), rb_vm_t, (ptr))
600 rb_vm_at_exit_func *func;
607void rb_objspace_call_finalizer(
struct rb_objspace *);
611 rb_event_flag_t events;
612 unsigned int running;
627 unsigned int blocking_cnt;
636 unsigned int lock_rec;
639 bool barrier_waiting;
640 unsigned int barrier_cnt;
645 bool terminate_waiting;
649#ifdef USE_SIGALTSTACK
653 rb_serial_t fork_gen;
660 volatile int ubf_async_safe;
662 unsigned int running: 1;
663 unsigned int thread_abort_on_exception: 1;
664 unsigned int thread_report_on_exception: 1;
665 unsigned int thread_ignore_deadlock: 1;
668 VALUE mark_object_ary;
669 const VALUE special_exceptions[ruby_special_error_count];
674 VALUE load_path_snapshot;
675 VALUE load_path_check_cache;
676 VALUE expanded_load_path;
677 VALUE loaded_features;
678 VALUE loaded_features_snapshot;
679 VALUE loaded_features_realpaths;
680 struct st_table *loaded_features_index;
685 VALUE cmd[RUBY_NSIG];
689 struct st_table *ensure_rollback_table;
693 rb_atomic_t postponed_job_index;
695 int src_encoding_index;
701 VALUE orig_progname, progname;
702 VALUE coverages, me2counter;
714 int builtin_inline_index;
719#ifndef VM_GLOBAL_CC_CACHE_TABLE_SIZE
720#define VM_GLOBAL_CC_CACHE_TABLE_SIZE 1023
722 const struct rb_callcache *global_cc_cache_table[VM_GLOBAL_CC_CACHE_TABLE_SIZE];
724#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
730 size_t thread_vm_stack_size;
731 size_t thread_machine_stack_size;
732 size_t fiber_vm_stack_size;
733 size_t fiber_machine_stack_size;
736 short redefined_flag[BOP_LAST_];
741#define RUBY_VM_SIZE_ALIGN 4096
743#define RUBY_VM_THREAD_VM_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
744#define RUBY_VM_THREAD_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
745#define RUBY_VM_THREAD_MACHINE_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
746#define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
748#define RUBY_VM_FIBER_VM_STACK_SIZE ( 16 * 1024 * sizeof(VALUE))
749#define RUBY_VM_FIBER_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
750#define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 64 * 1024 * sizeof(VALUE))
751#if defined(__powerpc64__)
752#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 32 * 1024 * sizeof(VALUE))
754#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
757#if __has_feature(memory_sanitizer) || __has_feature(address_sanitizer)
759#undef RUBY_VM_THREAD_MACHINE_STACK_SIZE
760#define RUBY_VM_THREAD_MACHINE_STACK_SIZE (1024 * 1024 * sizeof(VALUE))
761#undef RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN
762#define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 512 * 1024 * sizeof(VALUE))
763#undef RUBY_VM_FIBER_MACHINE_STACK_SIZE
764#define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 256 * 1024 * sizeof(VALUE))
765#undef RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN
766#define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 128 * 1024 * sizeof(VALUE))
770#define INTEGER_REDEFINED_OP_FLAG (1 << 0)
771#define FLOAT_REDEFINED_OP_FLAG (1 << 1)
772#define STRING_REDEFINED_OP_FLAG (1 << 2)
773#define ARRAY_REDEFINED_OP_FLAG (1 << 3)
774#define HASH_REDEFINED_OP_FLAG (1 << 4)
776#define SYMBOL_REDEFINED_OP_FLAG (1 << 6)
777#define TIME_REDEFINED_OP_FLAG (1 << 7)
778#define REGEXP_REDEFINED_OP_FLAG (1 << 8)
779#define NIL_REDEFINED_OP_FLAG (1 << 9)
780#define TRUE_REDEFINED_OP_FLAG (1 << 10)
781#define FALSE_REDEFINED_OP_FLAG (1 << 11)
782#define PROC_REDEFINED_OP_FLAG (1 << 12)
784#define BASIC_OP_UNREDEFINED_P(op, klass) (LIKELY((GET_VM()->redefined_flag[(op)]&(klass)) == 0))
786#ifndef VM_DEBUG_BP_CHECK
787#define VM_DEBUG_BP_CHECK 0
790#ifndef VM_DEBUG_VERIFY_METHOD_CACHE
791#define VM_DEBUG_VERIFY_METHOD_CACHE (VMDEBUG != 0)
804enum rb_block_handler_type {
805 block_handler_type_iseq,
806 block_handler_type_ifunc,
807 block_handler_type_symbol,
808 block_handler_type_proc
824 enum rb_block_type
type;
833 const void *block_code;
846rb_thread_ptr(VALUE thval)
848 return (
struct rb_thread_struct *)rb_check_typeddata(thval, &ruby_threadptr_data_type);
851enum rb_thread_status {
854 THREAD_STOPPED_FOREVER,
859typedef RUBY_JMP_BUF rb_jmpbuf_t;
861typedef void *rb_jmpbuf_t[5];
873 enum ruby_tag_type state;
874 unsigned int lock_rec;
877STATIC_ASSERT(rb_vm_tag_buf_offset, offsetof(
struct rb_vm_tag, buf) > 0);
878STATIC_ASSERT(rb_vm_tag_buf_end,
879 offsetof(
struct rb_vm_tag, buf) +
sizeof(rb_jmpbuf_t) <
913 size_t vm_stack_size;
919 rb_atomic_t interrupt_flag;
920 rb_atomic_t interrupt_mask;
921#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
922 uint32_t checked_clock;
930 VALUE local_storage_recursive_hash;
931 VALUE local_storage_recursive_hash_for_trace;
934 const VALUE *root_lep;
945 VALUE passed_block_handler;
950 BITFIELD(
enum method_missing_reason, method_missing_reason, 8);
952 VALUE private_const_reference;
958 size_t stack_maxsize;
963#ifndef rb_execution_context_t
965#define rb_execution_context_t rb_execution_context_t
969#define VM_CORE_H_EC_DEFINED 1
990#if defined(__linux__) || defined(__FreeBSD__)
991# define RB_THREAD_T_HAS_NATIVE_ID
1013#ifdef NON_SCALAR_THREAD_ID
1014 rb_thread_id_string_t thread_id_string;
1016#ifdef RB_THREAD_T_HAS_NATIVE_ID
1019 BITFIELD(
enum rb_thread_status, status, 2);
1021 unsigned int to_kill : 1;
1022 unsigned int abort_on_exception: 1;
1023 unsigned int report_on_exception: 1;
1024 unsigned int pending_interrupt_queue_checked: 1;
1026 uint32_t running_time_us;
1029 void *blocking_region_buffer;
1035#if OPT_CALL_THREADED_CODE
1040 VALUE pending_interrupt_queue;
1041 VALUE pending_interrupt_mask_stack;
1046 VALUE locking_mutex;
1058 VALUE (*func)(
void *);
1063 enum thread_invoke_type {
1064 thread_invoke_type_none = 0,
1065 thread_invoke_type_proc,
1066 thread_invoke_type_ractor_proc,
1067 thread_invoke_type_func
1071 VALUE stat_insn_usage;
1084#ifdef USE_SIGALTSTACK
1090 VM_DEFINECLASS_TYPE_CLASS = 0x00,
1091 VM_DEFINECLASS_TYPE_SINGLETON_CLASS = 0x01,
1092 VM_DEFINECLASS_TYPE_MODULE = 0x02,
1094 VM_DEFINECLASS_TYPE_MASK = 0x07
1095} rb_vm_defineclass_type_t;
1097#define VM_DEFINECLASS_TYPE(x) ((rb_vm_defineclass_type_t)(x) & VM_DEFINECLASS_TYPE_MASK)
1098#define VM_DEFINECLASS_FLAG_SCOPED 0x08
1099#define VM_DEFINECLASS_FLAG_HAS_SUPERCLASS 0x10
1100#define VM_DEFINECLASS_SCOPED_P(x) ((x) & VM_DEFINECLASS_FLAG_SCOPED)
1101#define VM_DEFINECLASS_HAS_SUPERCLASS_P(x) \
1102 ((x) & VM_DEFINECLASS_FLAG_HAS_SUPERCLASS)
1105RUBY_SYMBOL_EXPORT_BEGIN
1111rb_iseq_t *rb_iseq_new_eval (
const rb_ast_body_t *ast, VALUE name, VALUE path, VALUE realpath, VALUE first_lineno,
const rb_iseq_t *parent,
int isolated_depth);
1112rb_iseq_t *rb_iseq_new_with_opt(
const rb_ast_body_t *ast, VALUE name, VALUE path, VALUE realpath, VALUE first_lineno,
const rb_iseq_t *parent,
int isolated_depth,
1123rb_iseq_new_with_callback_new_callback(
1126 VALUE memo = rb_imemo_new(imemo_ifunc, (VALUE)func, (VALUE)ptr,
Qundef,
Qfalse);
1130 VALUE name, VALUE path, VALUE realpath, VALUE first_lineno,
1133VALUE rb_iseq_disasm(
const rb_iseq_t *iseq);
1134int rb_iseq_disasm_insn(VALUE str,
const VALUE *iseqval,
size_t pos,
const rb_iseq_t *iseq, VALUE child);
1136VALUE rb_iseq_coverage(
const rb_iseq_t *iseq);
1142RUBY_SYMBOL_EXPORT_END
1144#define GetProcPtr(obj, ptr) \
1145 GetCoreDataFromValue((obj), rb_proc_t, (ptr))
1149 unsigned int is_from_method: 1;
1150 unsigned int is_lambda: 1;
1151 unsigned int is_isolated: 1;
1154RUBY_SYMBOL_EXPORT_BEGIN
1155VALUE rb_proc_isolate(VALUE
self);
1156VALUE rb_proc_isolate_bang(VALUE
self);
1157VALUE rb_proc_ractor_make_shareable(VALUE
self);
1158RUBY_SYMBOL_EXPORT_END
1165 unsigned int env_size;
1170#define GetBindingPtr(obj, ptr) \
1171 GetCoreDataFromValue((obj), rb_binding_t, (ptr))
1175 const VALUE pathobj;
1176 unsigned short first_lineno;
1181enum vm_check_match_type {
1182 VM_CHECKMATCH_TYPE_WHEN = 1,
1183 VM_CHECKMATCH_TYPE_CASE = 2,
1184 VM_CHECKMATCH_TYPE_RESCUE = 3
1187#define VM_CHECKMATCH_TYPE_MASK 0x03
1188#define VM_CHECKMATCH_ARRAY 0x04
1190enum vm_special_object_type {
1191 VM_SPECIAL_OBJECT_VMCORE = 1,
1192 VM_SPECIAL_OBJECT_CBASE,
1193 VM_SPECIAL_OBJECT_CONST_BASE
1197 VM_SVAR_LASTLINE = 0,
1198 VM_SVAR_BACKREF = 1,
1200 VM_SVAR_EXTRA_START = 2,
1201 VM_SVAR_FLIPFLOP_START = 2
1213typedef VALUE CDHASH;
1215#ifndef FUNC_FASTCALL
1216#define FUNC_FASTCALL(x) x
1222#define VM_TAGGED_PTR_SET(p, tag) ((VALUE)(p) | (tag))
1223#define VM_TAGGED_PTR_REF(v, mask) ((void *)((v) & ~mask))
1225#define GC_GUARDED_PTR(p) VM_TAGGED_PTR_SET((p), 0x01)
1226#define GC_GUARDED_PTR_REF(p) VM_TAGGED_PTR_REF((p), 0x03)
1227#define GC_GUARDED_PTR_P(p) (((VALUE)(p)) & 0x01)
1240 VM_FRAME_MAGIC_METHOD = 0x11110001,
1241 VM_FRAME_MAGIC_BLOCK = 0x22220001,
1242 VM_FRAME_MAGIC_CLASS = 0x33330001,
1243 VM_FRAME_MAGIC_TOP = 0x44440001,
1244 VM_FRAME_MAGIC_CFUNC = 0x55550001,
1245 VM_FRAME_MAGIC_IFUNC = 0x66660001,
1246 VM_FRAME_MAGIC_EVAL = 0x77770001,
1247 VM_FRAME_MAGIC_RESCUE = 0x78880001,
1248 VM_FRAME_MAGIC_DUMMY = 0x79990001,
1250 VM_FRAME_MAGIC_MASK = 0x7fff0001,
1253 VM_FRAME_FLAG_FINISH = 0x0020,
1254 VM_FRAME_FLAG_BMETHOD = 0x0040,
1255 VM_FRAME_FLAG_CFRAME = 0x0080,
1256 VM_FRAME_FLAG_LAMBDA = 0x0100,
1257 VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM = 0x0200,
1258 VM_FRAME_FLAG_CFRAME_KW = 0x0400,
1259 VM_FRAME_FLAG_PASSED = 0x0800,
1262 VM_ENV_FLAG_LOCAL = 0x0002,
1263 VM_ENV_FLAG_ESCAPED = 0x0004,
1264 VM_ENV_FLAG_WB_REQUIRED = 0x0008,
1265 VM_ENV_FLAG_ISOLATED = 0x0010,
1268#define VM_ENV_DATA_SIZE ( 3)
1270#define VM_ENV_DATA_INDEX_ME_CREF (-2)
1271#define VM_ENV_DATA_INDEX_SPECVAL (-1)
1272#define VM_ENV_DATA_INDEX_FLAGS ( 0)
1273#define VM_ENV_DATA_INDEX_ENV ( 1)
1275#define VM_ENV_INDEX_LAST_LVAR (-VM_ENV_DATA_SIZE)
1277static inline void VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *ptr, VALUE special_const_value);
1280VM_ENV_FLAGS_SET(
const VALUE *ep, VALUE flag)
1282 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1284 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags | flag);
1288VM_ENV_FLAGS_UNSET(
const VALUE *ep, VALUE flag)
1290 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1292 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags & ~flag);
1295static inline unsigned long
1296VM_ENV_FLAGS(
const VALUE *ep,
long flag)
1298 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1300 return flags & flag;
1303static inline unsigned long
1306 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_MAGIC_MASK);
1312 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_LAMBDA) != 0;
1318 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME_KW) != 0;
1324 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_FINISH) != 0;
1330 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BMETHOD) != 0;
1334rb_obj_is_iseq(VALUE iseq)
1336 return imemo_type_p(iseq, imemo_iseq);
1339#if VM_CHECK_MODE > 0
1340#define RUBY_VM_NORMAL_ISEQ_P(iseq) rb_obj_is_iseq((VALUE)iseq)
1346 int cframe_p = VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME) != 0;
1347 VM_ASSERT(RUBY_VM_NORMAL_ISEQ_P(cfp->iseq) != cframe_p);
1354 return !VM_FRAME_CFRAME_P(cfp);
1357#define RUBYVM_CFUNC_FRAME_P(cfp) \
1358 (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
1360#define VM_GUARDED_PREV_EP(ep) GC_GUARDED_PTR(ep)
1361#define VM_BLOCK_HANDLER_NONE 0
1364VM_ENV_LOCAL_P(
const VALUE *ep)
1366 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_LOCAL) ? 1 : 0;
1369static inline const VALUE *
1370VM_ENV_PREV_EP(
const VALUE *ep)
1372 VM_ASSERT(VM_ENV_LOCAL_P(ep) == 0);
1373 return GC_GUARDED_PTR_REF(ep[VM_ENV_DATA_INDEX_SPECVAL]);
1377VM_ENV_BLOCK_HANDLER(
const VALUE *ep)
1379 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1380 return ep[VM_ENV_DATA_INDEX_SPECVAL];
1383#if VM_CHECK_MODE > 0
1384int rb_vm_ep_in_heap_p(
const VALUE *ep);
1388VM_ENV_ESCAPED_P(
const VALUE *ep)
1390 VM_ASSERT(rb_vm_ep_in_heap_p(ep) == !!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
1391 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) ? 1 : 0;
1394#if VM_CHECK_MODE > 0
1396vm_assert_env(VALUE obj)
1398 VM_ASSERT(imemo_type_p(obj, imemo_env));
1405VM_ENV_ENVVAL(const VALUE *ep)
1407 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV];
1408 VM_ASSERT(VM_ENV_ESCAPED_P(ep));
1409 VM_ASSERT(vm_assert_env(envval));
1415VM_ENV_ENVVAL_PTR(const VALUE *ep)
1417 return (
const rb_env_t *)VM_ENV_ENVVAL(ep);
1421vm_env_new(VALUE *env_ep, VALUE *env_body,
unsigned int env_size,
const rb_iseq_t *iseq)
1423 rb_env_t *env = (
rb_env_t *)rb_imemo_new(imemo_env, (VALUE)env_ep, (
VALUE)env_body, 0, (VALUE)iseq);
1424 env->env_size = env_size;
1425 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1430VM_FORCE_WRITE(
const VALUE *ptr, VALUE v)
1432 *((VALUE *)ptr) = v;
1436VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *ptr, VALUE special_const_value)
1439 VM_FORCE_WRITE(ptr, special_const_value);
1443VM_STACK_ENV_WRITE(
const VALUE *ep,
int index, VALUE v)
1445 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_WB_REQUIRED) == 0);
1446 VM_FORCE_WRITE(&ep[index], v);
1449const VALUE *rb_vm_ep_local_ep(
const VALUE *ep);
1450const VALUE *rb_vm_proc_local_ep(VALUE proc);
1451void rb_vm_block_ep_update(VALUE obj,
const struct rb_block *dst,
const VALUE *ep);
1452void rb_vm_block_copy(VALUE obj,
const struct rb_block *dst,
const struct rb_block *src);
1456#define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) ((cfp)+1)
1457#define RUBY_VM_NEXT_CONTROL_FRAME(cfp) ((cfp)-1)
1459#define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
1460 ((void *)(ecfp) > (void *)(cfp))
1471 return !RUBY_VM_VALID_CONTROL_FRAME_P(cfp, RUBY_VM_END_CONTROL_FRAME(ec));
1475VM_BH_ISEQ_BLOCK_P(VALUE block_handler)
1477 if ((block_handler & 0x03) == 0x01) {
1478#if VM_CHECK_MODE > 0
1480 VM_ASSERT(imemo_type_p(captured->code.val, imemo_iseq));
1492 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x01);
1493 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1494 return block_handler;
1498VM_BH_TO_ISEQ_BLOCK(VALUE block_handler)
1501 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1506VM_BH_IFUNC_P(VALUE block_handler)
1508 if ((block_handler & 0x03) == 0x03) {
1509#if VM_CHECK_MODE > 0
1511 VM_ASSERT(imemo_type_p(captured->code.val, imemo_ifunc));
1523 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x03);
1524 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1525 return block_handler;
1529VM_BH_TO_IFUNC_BLOCK(VALUE block_handler)
1532 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1537VM_BH_TO_CAPT_BLOCK(VALUE block_handler)
1540 VM_ASSERT(VM_BH_IFUNC_P(block_handler) || VM_BH_ISEQ_BLOCK_P(block_handler));
1544static inline enum rb_block_handler_type
1545vm_block_handler_type(VALUE block_handler)
1547 if (VM_BH_ISEQ_BLOCK_P(block_handler)) {
1548 return block_handler_type_iseq;
1550 else if (VM_BH_IFUNC_P(block_handler)) {
1551 return block_handler_type_ifunc;
1553 else if (
SYMBOL_P(block_handler)) {
1554 return block_handler_type_symbol;
1558 return block_handler_type_proc;
1563vm_block_handler_verify(MAYBE_UNUSED(VALUE block_handler))
1565 VM_ASSERT(block_handler == VM_BLOCK_HANDLER_NONE ||
1566 (vm_block_handler_type(block_handler), 1));
1572 return ((VALUE) cfp->block_code) == block_handler;
1575static inline enum rb_block_type
1576vm_block_type(
const struct rb_block *block)
1578#if VM_CHECK_MODE > 0
1579 switch (block->type) {
1580 case block_type_iseq:
1581 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_iseq));
1583 case block_type_ifunc:
1584 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_ifunc));
1586 case block_type_symbol:
1587 VM_ASSERT(
SYMBOL_P(block->as.symbol));
1589 case block_type_proc:
1598vm_block_type_set(
const struct rb_block *block,
enum rb_block_type
type)
1604static inline const struct rb_block *
1605vm_proc_block(VALUE procval)
1612static inline const VALUE *vm_block_ep(
const struct rb_block *block);
1615vm_proc_iseq(VALUE procval)
1617 return vm_block_iseq(vm_proc_block(procval));
1620static inline const VALUE *
1621vm_proc_ep(VALUE procval)
1623 return vm_block_ep(vm_proc_block(procval));
1627vm_block_iseq(
const struct rb_block *block)
1629 switch (vm_block_type(block)) {
1630 case block_type_iseq:
return rb_iseq_check(block->as.captured.code.iseq);
1631 case block_type_proc:
return vm_proc_iseq(block->as.proc);
1632 case block_type_ifunc:
1633 case block_type_symbol:
return NULL;
1635 VM_UNREACHABLE(vm_block_iseq);
1639static inline const VALUE *
1640vm_block_ep(
const struct rb_block *block)
1642 switch (vm_block_type(block)) {
1643 case block_type_iseq:
1644 case block_type_ifunc:
return block->as.captured.ep;
1645 case block_type_proc:
return vm_proc_ep(block->as.proc);
1646 case block_type_symbol:
return NULL;
1648 VM_UNREACHABLE(vm_block_ep);
1653vm_block_self(
const struct rb_block *block)
1655 switch (vm_block_type(block)) {
1656 case block_type_iseq:
1657 case block_type_ifunc:
1658 return block->as.captured.self;
1659 case block_type_proc:
1660 return vm_block_self(vm_proc_block(block->as.proc));
1661 case block_type_symbol:
1664 VM_UNREACHABLE(vm_block_self);
1669VM_BH_TO_SYMBOL(VALUE block_handler)
1671 VM_ASSERT(
SYMBOL_P(block_handler));
1672 return block_handler;
1676VM_BH_FROM_SYMBOL(VALUE symbol)
1683VM_BH_TO_PROC(VALUE block_handler)
1686 return block_handler;
1690VM_BH_FROM_PROC(VALUE procval)
1697VALUE rb_thread_alloc(VALUE klass);
1698VALUE rb_binding_alloc(VALUE klass);
1699VALUE rb_proc_alloc(VALUE klass);
1700VALUE rb_proc_dup(VALUE
self);
1706#
if OPT_STACK_CACHING
1707 , VALUE reg_a, VALUE reg_b
1711#define SDR() rb_vmdebug_stack_dump_raw(GET_EC(), GET_EC()->cfp)
1712#define SDR2(cfp) rb_vmdebug_stack_dump_raw(GET_EC(), (cfp))
1713void rb_vm_bugreport(
const void *);
1714typedef void (*ruby_sighandler_t)(int);
1716NORETURN(
void rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler,
int sig, const
void *, const
char *fmt, ...));
1719RUBY_SYMBOL_EXPORT_BEGIN
1720VALUE rb_iseq_eval(const
rb_iseq_t *iseq);
1721VALUE rb_iseq_eval_main(const
rb_iseq_t *iseq);
1722VALUE rb_iseq_path(const
rb_iseq_t *iseq);
1723VALUE rb_iseq_realpath(const
rb_iseq_t *iseq);
1724RUBY_SYMBOL_EXPORT_END
1726VALUE rb_iseq_pathobj_new(VALUE path, VALUE realpath);
1727void rb_iseq_pathobj_set(const
rb_iseq_t *iseq, VALUE path, VALUE realpath);
1729int rb_ec_frame_method_id_and_class(const
rb_execution_context_t *ec, ID *idp, ID *called_idp, VALUE *klassp);
1738 return rb_vm_make_proc_lambda(ec, captured, klass, 0);
1744 return rb_vm_make_proc_lambda(ec, captured, klass, 1);
1748VALUE rb_vm_env_local_variables(
const rb_env_t *env);
1750const VALUE *rb_binding_add_dynavars(VALUE bindval,
rb_binding_t *bind,
int dyncount,
const ID *dynvars);
1751void rb_vm_inc_const_missing_count(
void);
1758void rb_thread_start_timer_thread(
void);
1759void rb_thread_stop_timer_thread(
void);
1760void rb_thread_reset_timer_thread(
void);
1761void rb_thread_wakeup_timer_thread(
int);
1764rb_vm_living_threads_init(
rb_vm_t *vm)
1766 list_head_init(&vm->waiting_fds);
1767 list_head_init(&vm->waiting_pids);
1768 list_head_init(&vm->workqueue);
1769 list_head_init(&vm->waiting_grps);
1770 list_head_init(&vm->ractor.set);
1773typedef int rb_backtrace_iter_func(
void *, VALUE,
int, VALUE);
1781int rb_vm_control_frame_id_and_class(
const rb_control_frame_t *cfp, ID *idp, ID *called_idp, VALUE *klassp);
1785void rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp, VALUE exception_class, VALUE mesg);
1787#define rb_vm_register_special_exception(sp, e, m) \
1788 rb_vm_register_special_exception_str(sp, e, rb_usascii_str_new_static((m), (long)rb_strlen_lit(m)))
1792void rb_vm_rewrite_cref(
rb_cref_t *node, VALUE old_klass, VALUE new_klass,
rb_cref_t **new_cref_ptr);
1796#define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
1798#define CHECK_VM_STACK_OVERFLOW0(cfp, sp, margin) do { \
1799 STATIC_ASSERT(sizeof_sp, sizeof(*(sp)) == sizeof(VALUE)); \
1800 STATIC_ASSERT(sizeof_cfp, sizeof(*(cfp)) == sizeof(rb_control_frame_t)); \
1801 const struct rb_control_frame_struct *bound = (void *)&(sp)[(margin)]; \
1802 if (UNLIKELY((cfp) <= &bound[1])) { \
1803 vm_stackoverflow(); \
1807#define CHECK_VM_STACK_OVERFLOW(cfp, margin) \
1808 CHECK_VM_STACK_OVERFLOW0((cfp), (cfp)->sp, (margin))
1810VALUE rb_catch_protect(VALUE t,
rb_block_call_func *func, VALUE data,
enum ruby_tag_type *stateptr);
1816#if RUBY_VM_THREAD_MODEL == 2
1817MJIT_SYMBOL_EXPORT_BEGIN
1822RUBY_EXTERN rb_event_flag_t ruby_vm_event_enabled_global_flags;
1825MJIT_SYMBOL_EXPORT_END
1827#define GET_VM() rb_current_vm()
1828#define GET_RACTOR() rb_current_ractor()
1829#define GET_THREAD() rb_current_thread()
1830#define GET_EC() rb_current_execution_context(true)
1835 return ec->thread_ptr;
1843 VM_ASSERT(th->ractor != NULL);
1864rb_current_execution_context(
bool expect_ec)
1866#ifdef RB_THREAD_LOCAL_SPECIFIER
1875 VM_ASSERT(!expect_ec || ec != NULL);
1880rb_current_thread(
void)
1883 return rb_ec_thread_ptr(ec);
1887rb_current_ractor(
void)
1889 if (ruby_single_main_ractor) {
1890 return ruby_single_main_ractor;
1894 return rb_ec_ractor_ptr(ec);
1902 VM_ASSERT(ruby_current_vm_ptr == NULL ||
1903 ruby_current_execution_context_ptr == NULL ||
1904 rb_ec_thread_ptr(GET_EC()) == NULL ||
1905 rb_ec_thread_ptr(GET_EC())->status == THREAD_KILLED ||
1906 rb_ec_vm_ptr(GET_EC()) == ruby_current_vm_ptr);
1909 return ruby_current_vm_ptr;
1913 unsigned int recorded_lock_rec,
1914 unsigned int current_lock_rec);
1916static inline unsigned int
1919 rb_vm_t *vm = rb_ec_vm_ptr(ec);
1921 if (vm->ractor.sync.lock_owner != rb_ec_ractor_ptr(ec)) {
1925 return vm->ractor.sync.lock_rec;
1930#error "unsupported thread model"
1934 TIMER_INTERRUPT_MASK = 0x01,
1935 PENDING_INTERRUPT_MASK = 0x02,
1936 POSTPONED_JOB_INTERRUPT_MASK = 0x04,
1937 TRAP_INTERRUPT_MASK = 0x08,
1938 TERMINATE_INTERRUPT_MASK = 0x10,
1939 VM_BARRIER_INTERRUPT_MASK = 0x20,
1942#define RUBY_VM_SET_TIMER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TIMER_INTERRUPT_MASK)
1943#define RUBY_VM_SET_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, PENDING_INTERRUPT_MASK)
1944#define RUBY_VM_SET_POSTPONED_JOB_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, POSTPONED_JOB_INTERRUPT_MASK)
1945#define RUBY_VM_SET_TRAP_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TRAP_INTERRUPT_MASK)
1946#define RUBY_VM_SET_TERMINATE_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TERMINATE_INTERRUPT_MASK)
1947#define RUBY_VM_SET_VM_BARRIER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, VM_BARRIER_INTERRUPT_MASK)
1948#define RUBY_VM_INTERRUPTED(ec) ((ec)->interrupt_flag & ~(ec)->interrupt_mask & \
1949 (PENDING_INTERRUPT_MASK|TRAP_INTERRUPT_MASK))
1954#if defined(USE_VM_CLOCK) && USE_VM_CLOCK
1955 uint32_t current_clock = rb_ec_vm_ptr(ec)->clock;
1957 if (current_clock != ec->checked_clock) {
1958 ec->checked_clock = current_clock;
1959 RUBY_VM_SET_TIMER_INTERRUPT(ec);
1962 return ec->interrupt_flag & ~(ec)->interrupt_mask;
1965VALUE rb_exc_set_backtrace(VALUE exc, VALUE bt);
1966int rb_signal_buff_size(
void);
1969void rb_threadptr_signal_raise(
rb_thread_t *th,
int sig);
1971int rb_threadptr_execute_interrupts(
rb_thread_t *,
int);
1973void rb_threadptr_unlock_all_locking_mutexes(
rb_thread_t *th);
1974void rb_threadptr_pending_interrupt_clear(
rb_thread_t *th);
1975void rb_threadptr_pending_interrupt_enque(
rb_thread_t *th, VALUE v);
1988#define RUBY_VM_CHECK_INTS(ec) rb_vm_check_ints(ec)
1992 VM_ASSERT(ec == GET_EC());
1993 if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(ec))) {
1994 rb_threadptr_execute_interrupts(rb_ec_thread_ptr(ec), 0);
2001 rb_event_flag_t event;
2019void rb_hook_list_connect_tracepoint(VALUE target,
rb_hook_list_t *list, VALUE tpval,
unsigned int target_line);
2020void rb_hook_list_remove_tracepoint(
rb_hook_list_t *list, VALUE tpval);
2024#define EXEC_EVENT_HOOK_ORIG(ec_, hooks_, flag_, self_, id_, called_id_, klass_, data_, pop_p_) do { \
2025 const rb_event_flag_t flag_arg_ = (flag_); \
2026 rb_hook_list_t *hooks_arg_ = (hooks_); \
2027 if (UNLIKELY((hooks_arg_)->events & (flag_arg_))) { \
2029 rb_exec_event_hook_orig(ec_, hooks_arg_, flag_arg_, self_, id_, called_id_, klass_, data_, pop_p_); \
2035 VALUE
self, ID
id, ID called_id, VALUE klass, VALUE data,
int pop_p)
2039 VM_ASSERT((hooks->events & flag) != 0);
2041 trace_arg.event = flag;
2043 trace_arg.cfp = ec->cfp;
2044 trace_arg.self =
self;
2046 trace_arg.called_id = called_id;
2047 trace_arg.klass = klass;
2048 trace_arg.data = data;
2050 trace_arg.klass_solved = 0;
2052 rb_exec_event_hooks(&trace_arg, hooks, pop_p);
2065 return &cr_pub->hooks;
2068#define EXEC_EVENT_HOOK(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2069 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_ractor_hooks(ec_), flag_, self_, id_, called_id_, klass_, data_, 0)
2071#define EXEC_EVENT_HOOK_AND_POP_FRAME(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2072 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_ractor_hooks(ec_), flag_, self_, id_, called_id_, klass_, data_, 1)
2078 NIL_P(eval_script) ? (VALUE)iseq :
2082void rb_vm_trap_exit(
rb_vm_t *vm);
2084RUBY_SYMBOL_EXPORT_BEGIN
2086int rb_thread_check_trap_pending(
void);
2089#define RUBY_EVENT_COVERAGE_LINE 0x010000
2090#define RUBY_EVENT_COVERAGE_BRANCH 0x020000
2092extern VALUE rb_get_coverages(
void);
2093extern void rb_set_coverages(VALUE,
int, VALUE);
2094extern void rb_clear_coverages(
void);
2095extern void rb_reset_coverages(
void);
2096extern void rb_resume_coverages(
void);
2097extern void rb_suspend_coverages(
void);
2099void rb_postponed_job_flush(
rb_vm_t *vm);
2105RUBY_SYMBOL_EXPORT_END
#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 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_bug(const char *fmt,...)
Interpreter panic switch.
VALUE rb_ary_new_from_args(long n,...)
Constructs an array from the passed objects.
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 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.
This is the struct that holds necessary info for a struct.
const rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
IFUNC (Internal FUNCtion)
Basic block version Represents a portion of an iseq compiled with a given context Note: care must be ...
#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.