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"
83 #include THREAD_IMPL_H
85 #define RUBY_VM_THREAD_MODEL 2
93 #ifndef VM_INSN_INFO_TABLE_IMPL
94 # define VM_INSN_INFO_TABLE_IMPL 2
99 # define NSIG NSIG_MAX
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
133 void *rb_allocate_sigaltstack(
void);
134 void *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
173 #if OPT_STACK_CACHING
174 #undef OPT_STACK_CACHING
178 void rb_vm_encoded_insn_data_table_init(
void);
179 typedef unsigned long rb_num_t;
180 typedef 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
206 enum ruby_vm_throw_flags {
207 VM_THROW_NO_ESCAPE_FLAG = 0x8000,
208 VM_THROW_STATE_MASK = 0xff
231 STATIC_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)
242 static 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
321 pathobj_path(
VALUE pathobj)
333 pathobj_realpath(
VALUE pathobj)
349 typedef rb_darray(rb_yjit_block_array_t) rb_yjit_block_array_array_t;
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;
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;
495 rb_yjit_block_array_array_t yjit_blocks;
525 #ifndef USE_LAZY_LOAD
526 #define USE_LAZY_LOAD 0
537 if (iseq->body == NULL) {
548 #if VM_CHECK_MODE > 0
549 if (def->type != VM_METHOD_TYPE_ISEQ)
rb_bug(
"def_iseq_ptr: not iseq (%d)", def->type);
551 return rb_iseq_check(def->body.iseq.
iseqptr);
554 enum ruby_special_exceptions {
558 ruby_error_stackfatal,
559 ruby_error_stream_closed,
560 ruby_special_error_count
563 enum ruby_basic_operators {
597 #define GetVMPtr(obj, ptr) \
598 GetCoreDataFromValue((obj), rb_vm_t, (ptr))
604 rb_vm_at_exit_func *func;
611 void rb_objspace_call_finalizer(
struct rb_objspace *);
616 unsigned int running;
629 struct list_head set;
631 unsigned int blocking_cnt;
638 rb_nativethread_lock_t lock;
640 unsigned int lock_rec;
643 bool barrier_waiting;
644 unsigned int barrier_cnt;
645 rb_nativethread_cond_t barrier_cond;
648 rb_nativethread_cond_t terminate_cond;
649 bool terminate_waiting;
653 #ifdef USE_SIGALTSTACK
657 rb_serial_t fork_gen;
658 rb_nativethread_lock_t waitpid_lock;
659 struct list_head waiting_pids;
660 struct list_head waiting_grps;
661 struct list_head waiting_fds;
664 volatile int ubf_async_safe;
666 unsigned int running: 1;
667 unsigned int thread_abort_on_exception: 1;
668 unsigned int thread_report_on_exception: 1;
669 unsigned int thread_ignore_deadlock: 1;
672 VALUE mark_object_ary;
673 const VALUE special_exceptions[ruby_special_error_count];
678 VALUE load_path_snapshot;
679 VALUE load_path_check_cache;
680 VALUE expanded_load_path;
681 VALUE loaded_features;
682 VALUE loaded_features_snapshot;
683 VALUE loaded_features_realpaths;
684 struct st_table *loaded_features_index;
694 VALUE cmd[RUBY_NSIG];
698 struct st_table *ensure_rollback_table;
704 int src_encoding_index;
707 struct list_head workqueue;
708 rb_nativethread_lock_t workqueue_lock;
710 VALUE orig_progname, progname;
711 VALUE coverages, me2counter;
723 int builtin_inline_index;
728 #ifndef VM_GLOBAL_CC_CACHE_TABLE_SIZE
729 #define VM_GLOBAL_CC_CACHE_TABLE_SIZE 1023
731 const struct rb_callcache *global_cc_cache_table[VM_GLOBAL_CC_CACHE_TABLE_SIZE];
733 #if defined(USE_VM_CLOCK) && USE_VM_CLOCK
739 size_t thread_vm_stack_size;
740 size_t thread_machine_stack_size;
741 size_t fiber_vm_stack_size;
742 size_t fiber_machine_stack_size;
745 short redefined_flag[BOP_LAST_];
750 #define RUBY_VM_SIZE_ALIGN 4096
752 #define RUBY_VM_THREAD_VM_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
753 #define RUBY_VM_THREAD_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
754 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE ( 128 * 1024 * sizeof(VALUE))
755 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
757 #define RUBY_VM_FIBER_VM_STACK_SIZE ( 16 * 1024 * sizeof(VALUE))
758 #define RUBY_VM_FIBER_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE))
759 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 64 * 1024 * sizeof(VALUE))
760 #if defined(__powerpc64__)
761 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 32 * 1024 * sizeof(VALUE))
763 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE))
766 #if __has_feature(memory_sanitizer) || __has_feature(address_sanitizer)
768 #undef RUBY_VM_THREAD_MACHINE_STACK_SIZE
769 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE (1024 * 1024 * sizeof(VALUE))
770 #undef RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN
771 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 512 * 1024 * sizeof(VALUE))
772 #undef RUBY_VM_FIBER_MACHINE_STACK_SIZE
773 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 256 * 1024 * sizeof(VALUE))
774 #undef RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN
775 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 128 * 1024 * sizeof(VALUE))
779 #define INTEGER_REDEFINED_OP_FLAG (1 << 0)
780 #define FLOAT_REDEFINED_OP_FLAG (1 << 1)
781 #define STRING_REDEFINED_OP_FLAG (1 << 2)
782 #define ARRAY_REDEFINED_OP_FLAG (1 << 3)
783 #define HASH_REDEFINED_OP_FLAG (1 << 4)
785 #define SYMBOL_REDEFINED_OP_FLAG (1 << 6)
786 #define TIME_REDEFINED_OP_FLAG (1 << 7)
787 #define REGEXP_REDEFINED_OP_FLAG (1 << 8)
788 #define NIL_REDEFINED_OP_FLAG (1 << 9)
789 #define TRUE_REDEFINED_OP_FLAG (1 << 10)
790 #define FALSE_REDEFINED_OP_FLAG (1 << 11)
791 #define PROC_REDEFINED_OP_FLAG (1 << 12)
793 #define BASIC_OP_UNREDEFINED_P(op, klass) (LIKELY((GET_VM()->redefined_flag[(op)]&(klass)) == 0))
795 #ifndef VM_DEBUG_BP_CHECK
796 #define VM_DEBUG_BP_CHECK 0
799 #ifndef VM_DEBUG_VERIFY_METHOD_CACHE
800 #define VM_DEBUG_VERIFY_METHOD_CACHE (VMDEBUG != 0)
813 enum rb_block_handler_type {
814 block_handler_type_iseq,
815 block_handler_type_ifunc,
816 block_handler_type_symbol,
817 block_handler_type_proc
833 enum rb_block_type
type;
842 const void *block_code;
845 #if VM_DEBUG_BP_CHECK
855 rb_thread_ptr(
VALUE thval)
860 enum rb_thread_status {
863 THREAD_STOPPED_FOREVER,
868 typedef RUBY_JMP_BUF rb_jmpbuf_t;
870 typedef void *rb_jmpbuf_t[5];
882 enum ruby_tag_type state;
883 unsigned int lock_rec;
886 STATIC_ASSERT(rb_vm_tag_buf_offset, offsetof(
struct rb_vm_tag, buf) > 0);
887 STATIC_ASSERT(rb_vm_tag_buf_end,
888 offsetof(
struct rb_vm_tag, buf) +
sizeof(rb_jmpbuf_t) <
909 typedef char rb_thread_id_string_t[
sizeof(rb_nativethread_id_t) * 2 + 3];
922 size_t vm_stack_size;
930 #if defined(USE_VM_CLOCK) && USE_VM_CLOCK
931 uint32_t checked_clock;
939 VALUE local_storage_recursive_hash;
940 VALUE local_storage_recursive_hash_for_trace;
943 const VALUE *root_lep;
954 VALUE passed_block_handler;
959 BITFIELD(
enum method_missing_reason, method_missing_reason, 8);
961 VALUE private_const_reference;
967 size_t stack_maxsize;
972 #ifndef rb_execution_context_t
974 #define rb_execution_context_t rb_execution_context_t
978 #define VM_CORE_H_EC_DEFINED 1
999 #if defined(__linux__) || defined(__FreeBSD__)
1000 # define RB_THREAD_T_HAS_NATIVE_ID
1004 struct list_node lt_node;
1021 rb_nativethread_id_t thread_id;
1022 #ifdef NON_SCALAR_THREAD_ID
1023 rb_thread_id_string_t thread_id_string;
1025 #ifdef RB_THREAD_T_HAS_NATIVE_ID
1028 BITFIELD(
enum rb_thread_status, status, 2);
1030 unsigned int to_kill : 1;
1031 unsigned int abort_on_exception: 1;
1032 unsigned int report_on_exception: 1;
1033 unsigned int pending_interrupt_queue_checked: 1;
1035 uint32_t running_time_us;
1038 void *blocking_region_buffer;
1044 #if OPT_CALL_THREADED_CODE
1049 VALUE pending_interrupt_queue;
1050 VALUE pending_interrupt_mask_stack;
1053 rb_nativethread_lock_t interrupt_lock;
1055 VALUE locking_mutex;
1067 VALUE (*func)(
void *);
1072 enum thread_invoke_type {
1073 thread_invoke_type_none = 0,
1074 thread_invoke_type_proc,
1075 thread_invoke_type_ractor_proc,
1076 thread_invoke_type_func
1080 VALUE stat_insn_usage;
1093 #ifdef USE_SIGALTSTACK
1099 VM_DEFINECLASS_TYPE_CLASS = 0x00,
1100 VM_DEFINECLASS_TYPE_SINGLETON_CLASS = 0x01,
1101 VM_DEFINECLASS_TYPE_MODULE = 0x02,
1103 VM_DEFINECLASS_TYPE_MASK = 0x07
1104 } rb_vm_defineclass_type_t;
1106 #define VM_DEFINECLASS_TYPE(x) ((rb_vm_defineclass_type_t)(x) & VM_DEFINECLASS_TYPE_MASK)
1107 #define VM_DEFINECLASS_FLAG_SCOPED 0x08
1108 #define VM_DEFINECLASS_FLAG_HAS_SUPERCLASS 0x10
1109 #define VM_DEFINECLASS_SCOPED_P(x) ((x) & VM_DEFINECLASS_FLAG_SCOPED)
1110 #define VM_DEFINECLASS_HAS_SUPERCLASS_P(x) \
1111 ((x) & VM_DEFINECLASS_FLAG_HAS_SUPERCLASS)
1114 RUBY_SYMBOL_EXPORT_BEGIN
1132 rb_iseq_new_with_callback_new_callback(
1151 RUBY_SYMBOL_EXPORT_END
1153 #define GetProcPtr(obj, ptr) \
1154 GetCoreDataFromValue((obj), rb_proc_t, (ptr))
1158 unsigned int is_from_method: 1;
1159 unsigned int is_lambda: 1;
1160 unsigned int is_isolated: 1;
1163 RUBY_SYMBOL_EXPORT_BEGIN
1166 VALUE rb_proc_ractor_make_shareable(
VALUE self);
1167 RUBY_SYMBOL_EXPORT_END
1174 unsigned int env_size;
1179 #define GetBindingPtr(obj, ptr) \
1180 GetCoreDataFromValue((obj), rb_binding_t, (ptr))
1184 const VALUE pathobj;
1185 unsigned short first_lineno;
1190 enum vm_check_match_type {
1191 VM_CHECKMATCH_TYPE_WHEN = 1,
1192 VM_CHECKMATCH_TYPE_CASE = 2,
1193 VM_CHECKMATCH_TYPE_RESCUE = 3
1196 #define VM_CHECKMATCH_TYPE_MASK 0x03
1197 #define VM_CHECKMATCH_ARRAY 0x04
1199 enum vm_special_object_type {
1200 VM_SPECIAL_OBJECT_VMCORE = 1,
1201 VM_SPECIAL_OBJECT_CBASE,
1202 VM_SPECIAL_OBJECT_CONST_BASE
1205 enum vm_svar_index {
1206 VM_SVAR_LASTLINE = 0,
1207 VM_SVAR_BACKREF = 1,
1209 VM_SVAR_EXTRA_START = 2,
1210 VM_SVAR_FLIPFLOP_START = 2
1222 typedef VALUE CDHASH;
1224 #ifndef FUNC_FASTCALL
1225 #define FUNC_FASTCALL(x) x
1231 #define VM_TAGGED_PTR_SET(p, tag) ((VALUE)(p) | (tag))
1232 #define VM_TAGGED_PTR_REF(v, mask) ((void *)((v) & ~mask))
1234 #define GC_GUARDED_PTR(p) VM_TAGGED_PTR_SET((p), 0x01)
1235 #define GC_GUARDED_PTR_REF(p) VM_TAGGED_PTR_REF((p), 0x03)
1236 #define GC_GUARDED_PTR_P(p) (((VALUE)(p)) & 0x01)
1249 VM_FRAME_MAGIC_METHOD = 0x11110001,
1250 VM_FRAME_MAGIC_BLOCK = 0x22220001,
1251 VM_FRAME_MAGIC_CLASS = 0x33330001,
1252 VM_FRAME_MAGIC_TOP = 0x44440001,
1253 VM_FRAME_MAGIC_CFUNC = 0x55550001,
1254 VM_FRAME_MAGIC_IFUNC = 0x66660001,
1255 VM_FRAME_MAGIC_EVAL = 0x77770001,
1256 VM_FRAME_MAGIC_RESCUE = 0x78880001,
1257 VM_FRAME_MAGIC_DUMMY = 0x79990001,
1259 VM_FRAME_MAGIC_MASK = 0x7fff0001,
1262 VM_FRAME_FLAG_FINISH = 0x0020,
1263 VM_FRAME_FLAG_BMETHOD = 0x0040,
1264 VM_FRAME_FLAG_CFRAME = 0x0080,
1265 VM_FRAME_FLAG_LAMBDA = 0x0100,
1266 VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM = 0x0200,
1267 VM_FRAME_FLAG_CFRAME_KW = 0x0400,
1268 VM_FRAME_FLAG_PASSED = 0x0800,
1271 VM_ENV_FLAG_LOCAL = 0x0002,
1272 VM_ENV_FLAG_ESCAPED = 0x0004,
1273 VM_ENV_FLAG_WB_REQUIRED = 0x0008,
1274 VM_ENV_FLAG_ISOLATED = 0x0010,
1277 #define VM_ENV_DATA_SIZE ( 3)
1279 #define VM_ENV_DATA_INDEX_ME_CREF (-2)
1280 #define VM_ENV_DATA_INDEX_SPECVAL (-1)
1281 #define VM_ENV_DATA_INDEX_FLAGS ( 0)
1282 #define VM_ENV_DATA_INDEX_ENV ( 1)
1284 #define VM_ENV_INDEX_LAST_LVAR (-VM_ENV_DATA_SIZE)
1286 static inline void VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *ptr,
VALUE special_const_value);
1289 VM_ENV_FLAGS_SET(
const VALUE *ep,
VALUE flag)
1291 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1293 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags | flag);
1297 VM_ENV_FLAGS_UNSET(
const VALUE *ep,
VALUE flag)
1299 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1301 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_FLAGS], flags & ~flag);
1304 static inline unsigned long
1305 VM_ENV_FLAGS(
const VALUE *ep,
long flag)
1307 VALUE flags = ep[VM_ENV_DATA_INDEX_FLAGS];
1309 return flags & flag;
1312 static inline unsigned long
1315 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_MAGIC_MASK);
1321 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_LAMBDA) != 0;
1327 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME_KW) != 0;
1333 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_FINISH) != 0;
1339 return VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BMETHOD) != 0;
1343 rb_obj_is_iseq(
VALUE iseq)
1345 return imemo_type_p(iseq, imemo_iseq);
1348 #if VM_CHECK_MODE > 0
1349 #define RUBY_VM_NORMAL_ISEQ_P(iseq) rb_obj_is_iseq((VALUE)iseq)
1355 int cframe_p = VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_CFRAME) != 0;
1356 VM_ASSERT(RUBY_VM_NORMAL_ISEQ_P(cfp->iseq) != cframe_p);
1363 return !VM_FRAME_CFRAME_P(cfp);
1366 #define RUBYVM_CFUNC_FRAME_P(cfp) \
1367 (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
1369 #define VM_GUARDED_PREV_EP(ep) GC_GUARDED_PTR(ep)
1370 #define VM_BLOCK_HANDLER_NONE 0
1373 VM_ENV_LOCAL_P(
const VALUE *ep)
1375 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_LOCAL) ? 1 : 0;
1378 static inline const VALUE *
1379 VM_ENV_PREV_EP(
const VALUE *ep)
1381 VM_ASSERT(VM_ENV_LOCAL_P(ep) == 0);
1382 return GC_GUARDED_PTR_REF(ep[VM_ENV_DATA_INDEX_SPECVAL]);
1386 VM_ENV_BLOCK_HANDLER(
const VALUE *ep)
1388 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1389 return ep[VM_ENV_DATA_INDEX_SPECVAL];
1392 #if VM_CHECK_MODE > 0
1393 int rb_vm_ep_in_heap_p(
const VALUE *ep);
1397 VM_ENV_ESCAPED_P(
const VALUE *ep)
1399 VM_ASSERT(rb_vm_ep_in_heap_p(ep) == !!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
1400 return VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) ? 1 : 0;
1403 #if VM_CHECK_MODE > 0
1405 vm_assert_env(
VALUE obj)
1407 VM_ASSERT(imemo_type_p(obj, imemo_env));
1414 VM_ENV_ENVVAL(const
VALUE *ep)
1416 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV];
1417 VM_ASSERT(VM_ENV_ESCAPED_P(ep));
1418 VM_ASSERT(vm_assert_env(envval));
1424 VM_ENV_ENVVAL_PTR(const
VALUE *ep)
1426 return (
const rb_env_t *)VM_ENV_ENVVAL(ep);
1433 env->env_size = env_size;
1434 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1441 *((
VALUE *)ptr) = v;
1445 VM_FORCE_WRITE_SPECIAL_CONST(
const VALUE *ptr,
VALUE special_const_value)
1448 VM_FORCE_WRITE(ptr, special_const_value);
1452 VM_STACK_ENV_WRITE(
const VALUE *ep,
int index,
VALUE v)
1454 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_WB_REQUIRED) == 0);
1455 VM_FORCE_WRITE(&ep[index], v);
1458 const VALUE *rb_vm_ep_local_ep(
const VALUE *ep);
1459 const VALUE *rb_vm_proc_local_ep(
VALUE proc);
1465 #define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) ((cfp)+1)
1466 #define RUBY_VM_NEXT_CONTROL_FRAME(cfp) ((cfp)-1)
1468 #define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
1469 ((void *)(ecfp) > (void *)(cfp))
1480 return !RUBY_VM_VALID_CONTROL_FRAME_P(cfp, RUBY_VM_END_CONTROL_FRAME(ec));
1484 VM_BH_ISEQ_BLOCK_P(
VALUE block_handler)
1486 if ((block_handler & 0x03) == 0x01) {
1487 #if VM_CHECK_MODE > 0
1489 VM_ASSERT(imemo_type_p(captured->code.val, imemo_iseq));
1501 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x01);
1502 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1503 return block_handler;
1507 VM_BH_TO_ISEQ_BLOCK(
VALUE block_handler)
1510 VM_ASSERT(VM_BH_ISEQ_BLOCK_P(block_handler));
1515 VM_BH_IFUNC_P(
VALUE block_handler)
1517 if ((block_handler & 0x03) == 0x03) {
1518 #if VM_CHECK_MODE > 0
1520 VM_ASSERT(imemo_type_p(captured->code.val, imemo_ifunc));
1532 VALUE block_handler = VM_TAGGED_PTR_SET(captured, 0x03);
1533 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1534 return block_handler;
1538 VM_BH_TO_IFUNC_BLOCK(
VALUE block_handler)
1541 VM_ASSERT(VM_BH_IFUNC_P(block_handler));
1546 VM_BH_TO_CAPT_BLOCK(
VALUE block_handler)
1549 VM_ASSERT(VM_BH_IFUNC_P(block_handler) || VM_BH_ISEQ_BLOCK_P(block_handler));
1553 static inline enum rb_block_handler_type
1554 vm_block_handler_type(
VALUE block_handler)
1556 if (VM_BH_ISEQ_BLOCK_P(block_handler)) {
1557 return block_handler_type_iseq;
1559 else if (VM_BH_IFUNC_P(block_handler)) {
1560 return block_handler_type_ifunc;
1562 else if (
SYMBOL_P(block_handler)) {
1563 return block_handler_type_symbol;
1567 return block_handler_type_proc;
1572 vm_block_handler_verify(MAYBE_UNUSED(
VALUE block_handler))
1574 VM_ASSERT(block_handler == VM_BLOCK_HANDLER_NONE ||
1575 (vm_block_handler_type(block_handler), 1));
1581 return ((
VALUE) cfp->block_code) == block_handler;
1584 static inline enum rb_block_type
1585 vm_block_type(
const struct rb_block *block)
1587 #if VM_CHECK_MODE > 0
1588 switch (block->type) {
1589 case block_type_iseq:
1590 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_iseq));
1592 case block_type_ifunc:
1593 VM_ASSERT(imemo_type_p(block->as.captured.code.val, imemo_ifunc));
1595 case block_type_symbol:
1596 VM_ASSERT(
SYMBOL_P(block->as.symbol));
1598 case block_type_proc:
1607 vm_block_type_set(
const struct rb_block *block,
enum rb_block_type
type)
1613 static inline const struct rb_block *
1614 vm_proc_block(
VALUE procval)
1621 static inline const VALUE *vm_block_ep(
const struct rb_block *block);
1624 vm_proc_iseq(
VALUE procval)
1626 return vm_block_iseq(vm_proc_block(procval));
1629 static inline const VALUE *
1630 vm_proc_ep(
VALUE procval)
1632 return vm_block_ep(vm_proc_block(procval));
1636 vm_block_iseq(
const struct rb_block *block)
1638 switch (vm_block_type(block)) {
1639 case block_type_iseq:
return rb_iseq_check(block->as.captured.code.iseq);
1640 case block_type_proc:
return vm_proc_iseq(block->as.proc);
1641 case block_type_ifunc:
1642 case block_type_symbol:
return NULL;
1644 VM_UNREACHABLE(vm_block_iseq);
1648 static inline const VALUE *
1649 vm_block_ep(
const struct rb_block *block)
1651 switch (vm_block_type(block)) {
1652 case block_type_iseq:
1653 case block_type_ifunc:
return block->as.captured.ep;
1654 case block_type_proc:
return vm_proc_ep(block->as.proc);
1655 case block_type_symbol:
return NULL;
1657 VM_UNREACHABLE(vm_block_ep);
1662 vm_block_self(
const struct rb_block *block)
1664 switch (vm_block_type(block)) {
1665 case block_type_iseq:
1666 case block_type_ifunc:
1667 return block->as.captured.self;
1668 case block_type_proc:
1669 return vm_block_self(vm_proc_block(block->as.proc));
1670 case block_type_symbol:
1673 VM_UNREACHABLE(vm_block_self);
1678 VM_BH_TO_SYMBOL(
VALUE block_handler)
1680 VM_ASSERT(
SYMBOL_P(block_handler));
1681 return block_handler;
1685 VM_BH_FROM_SYMBOL(
VALUE symbol)
1692 VM_BH_TO_PROC(
VALUE block_handler)
1695 return block_handler;
1699 VM_BH_FROM_PROC(
VALUE procval)
1715 #
if OPT_STACK_CACHING
1720 #define SDR() rb_vmdebug_stack_dump_raw(GET_EC(), GET_EC()->cfp)
1721 #define SDR2(cfp) rb_vmdebug_stack_dump_raw(GET_EC(), (cfp))
1722 void rb_vm_bugreport(
const void *);
1723 typedef void (*ruby_sighandler_t)(int);
1725 NORETURN(
void rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler,
int sig, const
void *, const
char *fmt, ...));
1728 RUBY_SYMBOL_EXPORT_BEGIN
1733 RUBY_SYMBOL_EXPORT_END
1747 return rb_vm_make_proc_lambda(ec, captured, klass, 0);
1753 return rb_vm_make_proc_lambda(ec, captured, klass, 1);
1760 void rb_vm_inc_const_missing_count(
void);
1767 void rb_thread_start_timer_thread(
void);
1768 void rb_thread_stop_timer_thread(
void);
1769 void rb_thread_reset_timer_thread(
void);
1770 void rb_thread_wakeup_timer_thread(
int);
1773 rb_vm_living_threads_init(
rb_vm_t *vm)
1775 list_head_init(&vm->waiting_fds);
1776 list_head_init(&vm->waiting_pids);
1777 list_head_init(&vm->workqueue);
1778 list_head_init(&vm->waiting_grps);
1779 list_head_init(&vm->ractor.set);
1782 typedef int rb_backtrace_iter_func(
void *,
VALUE,
int,
VALUE);
1794 void rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp,
VALUE exception_class,
VALUE mesg);
1796 #define rb_vm_register_special_exception(sp, e, m) \
1797 rb_vm_register_special_exception_str(sp, e, rb_usascii_str_new_static((m), (long)rb_strlen_lit(m)))
1805 #define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
1807 #define CHECK_VM_STACK_OVERFLOW0(cfp, sp, margin) do { \
1808 STATIC_ASSERT(sizeof_sp, sizeof(*(sp)) == sizeof(VALUE)); \
1809 STATIC_ASSERT(sizeof_cfp, sizeof(*(cfp)) == sizeof(rb_control_frame_t)); \
1810 const struct rb_control_frame_struct *bound = (void *)&(sp)[(margin)]; \
1811 if (UNLIKELY((cfp) <= &bound[1])) { \
1812 vm_stackoverflow(); \
1816 #define CHECK_VM_STACK_OVERFLOW(cfp, margin) \
1817 CHECK_VM_STACK_OVERFLOW0((cfp), (cfp)->sp, (margin))
1825 #if RUBY_VM_THREAD_MODEL == 2
1826 MJIT_SYMBOL_EXPORT_BEGIN
1834 MJIT_SYMBOL_EXPORT_END
1836 #define GET_VM() rb_current_vm()
1837 #define GET_RACTOR() rb_current_ractor()
1838 #define GET_THREAD() rb_current_thread()
1839 #define GET_EC() rb_current_execution_context(true)
1844 return ec->thread_ptr;
1852 VM_ASSERT(th->ractor != NULL);
1873 rb_current_execution_context(
bool expect_ec)
1875 #ifdef RB_THREAD_LOCAL_SPECIFIER
1884 VM_ASSERT(!expect_ec || ec != NULL);
1889 rb_current_thread(
void)
1892 return rb_ec_thread_ptr(ec);
1896 rb_current_ractor(
void)
1898 if (ruby_single_main_ractor) {
1899 return ruby_single_main_ractor;
1903 return rb_ec_ractor_ptr(ec);
1911 VM_ASSERT(ruby_current_vm_ptr == NULL ||
1912 ruby_current_execution_context_ptr == NULL ||
1913 rb_ec_thread_ptr(GET_EC()) == NULL ||
1914 rb_ec_thread_ptr(GET_EC())->status == THREAD_KILLED ||
1915 rb_ec_vm_ptr(GET_EC()) == ruby_current_vm_ptr);
1918 return ruby_current_vm_ptr;
1922 unsigned int recorded_lock_rec,
1923 unsigned int current_lock_rec);
1925 static inline unsigned int
1928 rb_vm_t *vm = rb_ec_vm_ptr(ec);
1930 if (vm->ractor.sync.lock_owner != rb_ec_ractor_ptr(ec)) {
1934 return vm->ractor.sync.lock_rec;
1939 #error "unsupported thread model"
1943 TIMER_INTERRUPT_MASK = 0x01,
1944 PENDING_INTERRUPT_MASK = 0x02,
1945 POSTPONED_JOB_INTERRUPT_MASK = 0x04,
1946 TRAP_INTERRUPT_MASK = 0x08,
1947 TERMINATE_INTERRUPT_MASK = 0x10,
1948 VM_BARRIER_INTERRUPT_MASK = 0x20,
1951 #define RUBY_VM_SET_TIMER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TIMER_INTERRUPT_MASK)
1952 #define RUBY_VM_SET_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, PENDING_INTERRUPT_MASK)
1953 #define RUBY_VM_SET_POSTPONED_JOB_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, POSTPONED_JOB_INTERRUPT_MASK)
1954 #define RUBY_VM_SET_TRAP_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TRAP_INTERRUPT_MASK)
1955 #define RUBY_VM_SET_TERMINATE_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, TERMINATE_INTERRUPT_MASK)
1956 #define RUBY_VM_SET_VM_BARRIER_INTERRUPT(ec) ATOMIC_OR((ec)->interrupt_flag, VM_BARRIER_INTERRUPT_MASK)
1957 #define RUBY_VM_INTERRUPTED(ec) ((ec)->interrupt_flag & ~(ec)->interrupt_mask & \
1958 (PENDING_INTERRUPT_MASK|TRAP_INTERRUPT_MASK))
1963 #if defined(USE_VM_CLOCK) && USE_VM_CLOCK
1964 uint32_t current_clock = rb_ec_vm_ptr(ec)->clock;
1966 if (current_clock != ec->checked_clock) {
1967 ec->checked_clock = current_clock;
1968 RUBY_VM_SET_TIMER_INTERRUPT(ec);
1971 return ec->interrupt_flag & ~(ec)->interrupt_mask;
1975 int rb_signal_buff_size(
void);
1978 void rb_threadptr_signal_raise(
rb_thread_t *th,
int sig);
1980 int rb_threadptr_execute_interrupts(
rb_thread_t *,
int);
1982 void rb_threadptr_unlock_all_locking_mutexes(
rb_thread_t *th);
1983 void rb_threadptr_pending_interrupt_clear(
rb_thread_t *th);
1994 void rb_vm_cond_wait(
rb_vm_t *vm, rb_nativethread_cond_t *cond);
1995 void rb_vm_cond_timedwait(
rb_vm_t *vm, rb_nativethread_cond_t *cond,
unsigned long msec);
1997 #define RUBY_VM_CHECK_INTS(ec) rb_vm_check_ints(ec)
2001 VM_ASSERT(ec == GET_EC());
2002 if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(ec))) {
2003 rb_threadptr_execute_interrupts(rb_ec_thread_ptr(ec), 0);
2033 #define EXEC_EVENT_HOOK_ORIG(ec_, hooks_, flag_, self_, id_, called_id_, klass_, data_, pop_p_) do { \
2034 const rb_event_flag_t flag_arg_ = (flag_); \
2035 rb_hook_list_t *hooks_arg_ = (hooks_); \
2036 if (UNLIKELY((hooks_arg_)->events & (flag_arg_))) { \
2038 rb_exec_event_hook_orig(ec_, hooks_arg_, flag_arg_, self_, id_, called_id_, klass_, data_, pop_p_); \
2048 VM_ASSERT((hooks->events & flag) != 0);
2050 trace_arg.event = flag;
2052 trace_arg.cfp = ec->cfp;
2053 trace_arg.self =
self;
2055 trace_arg.called_id = called_id;
2056 trace_arg.klass = klass;
2057 trace_arg.data = data;
2059 trace_arg.klass_solved = 0;
2061 rb_exec_event_hooks(&trace_arg, hooks, pop_p);
2074 return &cr_pub->hooks;
2077 #define EXEC_EVENT_HOOK(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2078 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_ractor_hooks(ec_), flag_, self_, id_, called_id_, klass_, data_, 0)
2080 #define EXEC_EVENT_HOOK_AND_POP_FRAME(ec_, flag_, self_, id_, called_id_, klass_, data_) \
2081 EXEC_EVENT_HOOK_ORIG(ec_, rb_ec_ractor_hooks(ec_), flag_, self_, id_, called_id_, klass_, data_, 1)
2091 void rb_vm_trap_exit(
rb_vm_t *vm);
2093 RUBY_SYMBOL_EXPORT_BEGIN
2095 int rb_thread_check_trap_pending(
void);
2098 #define RUBY_EVENT_COVERAGE_LINE 0x010000
2099 #define RUBY_EVENT_COVERAGE_BRANCH 0x020000
2101 extern VALUE rb_get_coverages(
void);
2102 extern void rb_set_coverages(
VALUE,
int,
VALUE);
2103 extern void rb_clear_coverages(
void);
2104 extern void rb_reset_coverages(
void);
2105 extern void rb_resume_coverages(
void);
2106 extern void rb_suspend_coverages(
void);
2108 void rb_postponed_job_flush(
rb_vm_t *vm);
2114 RUBY_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.
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.
struct rb_iseq_constant_body::@152 param
parameter information
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 ...
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.