11#define vm_exec rb_vm_exec
13#include "eval_intern.h"
15#include "internal/box.h"
16#include "internal/class.h"
17#include "internal/compile.h"
18#include "internal/cont.h"
19#include "internal/error.h"
20#include "internal/encoding.h"
21#include "internal/eval.h"
22#include "internal/gc.h"
23#include "internal/inits.h"
24#include "internal/missing.h"
25#include "internal/object.h"
26#include "internal/proc.h"
27#include "internal/re.h"
28#include "internal/ruby_parser.h"
29#include "internal/symbol.h"
30#include "internal/thread.h"
31#include "internal/transcode.h"
32#include "internal/vm.h"
33#include "internal/sanitizers.h"
34#include "internal/variable.h"
43#include "vm_callinfo.h"
46#include "vm_insnhelper.h"
47#include "ractor_core.h"
54#include "probes_helper.h"
56#ifdef RUBY_ASSERT_CRITICAL_SECTION
57int ruby_assert_critical_section_entered = 0;
60static void *native_main_thread_stack_top;
62bool ruby_vm_during_cleanup =
false;
64VALUE rb_str_concat_literals(
size_t,
const VALUE*);
68extern const char *
const rb_debug_counter_names[];
70PUREFUNC(
static inline const VALUE *VM_EP_LEP(
const VALUE *));
71static inline const VALUE *
72VM_EP_LEP(
const VALUE *ep)
74 while (!VM_ENV_LOCAL_P(ep)) {
75 ep = VM_ENV_PREV_EP(ep);
93 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
102#define VM_BOX_CRASHED() {ruby_box_crashed = true;}
103#define VM_BOX_ASSERT(expr, msg) \
104 if (!(expr)) { ruby_box_crashed = true; rb_bug(msg); }
106#define VM_BOX_CRASHED() {}
107#define VM_BOX_ASSERT(expr, msg) ((void)0)
114 const VALUE *ep = current_cfp->ep;
118 if (VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_IFUNC)) {
119 ep = VM_EP_LEP(current_cfp->ep);
148 VM_ASSERT(VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_CFUNC));
152 while (VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_CFUNC)) {
153 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
155 VM_BOX_ASSERT(cfp,
"CFUNC should have a valid previous control frame");
156 VM_BOX_ASSERT(cfp < eocfp,
"CFUNC should have a valid caller frame");
157 if (!cfp || cfp >= eocfp) {
161 VM_BOX_ASSERT(cfp->ep,
"CFUNC should have a valid caller frame with env");
168 while (!VM_ENV_LOCAL_P(ep)) {
169 ep = VM_ENV_PREV_EP(ep);
176rb_vm_ep_local_ep(
const VALUE *ep)
178 return VM_EP_LEP(ep);
182static inline const VALUE *
185 return VM_EP_LEP(cfp->ep);
188static inline const VALUE *
191 return VM_ENV_PREV_EP(cfp->ep);
199 if (VM_ENV_BOXED_P(cfp->ep)) {
200 VM_ASSERT(VM_ENV_LOCAL_P(cfp->ep));
204 return VM_BLOCK_HANDLER_NONE;
207 return VM_ENV_BLOCK_HANDLER(ep);
213 return VM_FRAME_CFRAME_KW_P(cfp);
219 return VM_CF_BLOCK_HANDLER(cfp);
226 const VALUE *start = ec->vm_stack;
227 const VALUE *end = (
VALUE *)ec->vm_stack + ec->vm_stack_size;
228 VM_ASSERT(start != NULL);
230 if (start <= (
VALUE *)cfp && (
VALUE *)cfp < end) {
241 const VALUE *start = ec->vm_stack;
243 VM_ASSERT(start != NULL);
245 if (start <= ep && ep < end) {
256 if (VM_EP_IN_HEAP_P(ec, ep)) {
257 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV];
259 if (!UNDEF_P(envval)) {
262 VM_ASSERT(imemo_type_p(envval, imemo_env));
263 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
264 VM_ASSERT(env->ep == ep);
274rb_vm_ep_in_heap_p(
const VALUE *ep)
277 if (ec->vm_stack == NULL)
return TRUE;
278 return vm_ep_in_heap_p_(ec, ep);
285 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
293 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
302 return VM_TAGGED_PTR_REF(block_handler, 0x03) == captured;
308 VALUE block_handler = ec->passed_block_handler;
309 ec->passed_block_handler = VM_BLOCK_HANDLER_NONE;
310 vm_block_handler_verify(block_handler);
311 return block_handler;
315vm_cref_new0(
VALUE klass, rb_method_visibility_t visi,
int module_func,
rb_cref_t *prev_cref,
int pushed_by_eval,
int use_prev_prev,
int singleton)
318 int omod_shared = FALSE;
322 scope_visi.method_visi = visi;
323 scope_visi.module_func = module_func;
326 if (prev_cref != NULL && prev_cref != (
void *)1 ) {
327 refinements = CREF_REFINEMENTS(prev_cref);
329 if (!
NIL_P(refinements)) {
331 CREF_OMOD_SHARED_SET(prev_cref);
335 VM_ASSERT(singleton || klass);
338 cref->klass_or_self = klass;
339 cref->next = use_prev_prev ? CREF_NEXT(prev_cref) : prev_cref;
342 if (pushed_by_eval) CREF_PUSHED_BY_EVAL_SET(cref);
343 if (omod_shared) CREF_OMOD_SHARED_SET(cref);
344 if (singleton) CREF_SINGLETON_SET(cref);
350vm_cref_new(
VALUE klass, rb_method_visibility_t visi,
int module_func,
rb_cref_t *prev_cref,
int pushed_by_eval,
int singleton)
352 return vm_cref_new0(klass, visi, module_func, prev_cref, pushed_by_eval, FALSE, singleton);
356vm_cref_new_use_prev(
VALUE klass, rb_method_visibility_t visi,
int module_func,
rb_cref_t *prev_cref,
int pushed_by_eval)
358 return vm_cref_new0(klass, visi, module_func, prev_cref, pushed_by_eval, TRUE, FALSE);
364 return SYMBOL_P(key) ? ST_DELETE : ST_CONTINUE;
371 rb_cref_t *next_cref = CREF_NEXT(cref), *new_cref;
372 int pushed_by_eval = CREF_PUSHED_BY_EVAL(cref);
373 int singleton = CREF_SINGLETON(cref);
375 new_cref = vm_cref_new(cref->klass_or_self, visi->method_visi, visi->module_func, next_cref, pushed_by_eval, singleton);
377 if (!
NIL_P(CREF_REFINEMENTS(cref))) {
378 VALUE ref = rb_hash_dup(CREF_REFINEMENTS(cref));
380 CREF_REFINEMENTS_SET(new_cref, ref);
381 CREF_OMOD_SHARED_UNSET(new_cref);
389rb_vm_cref_dup_without_refinements(
const rb_cref_t *cref)
392 rb_cref_t *next_cref = CREF_NEXT(cref), *new_cref;
393 int pushed_by_eval = CREF_PUSHED_BY_EVAL(cref);
394 int singleton = CREF_SINGLETON(cref);
396 new_cref = vm_cref_new(cref->klass_or_self, visi->method_visi, visi->module_func, next_cref, pushed_by_eval, singleton);
398 if (!
NIL_P(CREF_REFINEMENTS(cref))) {
399 CREF_REFINEMENTS_SET(new_cref,
Qnil);
400 CREF_OMOD_SHARED_UNSET(new_cref);
409 rb_cref_t *cref = vm_cref_new(rb_cObject, METHOD_VISI_PRIVATE , FALSE, NULL, FALSE, FALSE);
410 VALUE top_wrapper = rb_ec_thread_ptr(ec)->top_wrapper;
413 cref = vm_cref_new(top_wrapper, METHOD_VISI_PRIVATE, FALSE, cref, FALSE, FALSE);
420rb_vm_cref_new_toplevel(
void)
422 return vm_cref_new_toplevel(GET_EC());
426vm_cref_dump(
const char *mesg,
const rb_cref_t *cref)
428 ruby_debug_printf(
"vm_cref_dump: %s (%p)\n", mesg, (
void *)cref);
431 ruby_debug_printf(
"= cref| klass: %s\n", RSTRING_PTR(
rb_class_path(CREF_CLASS(cref))));
432 cref = CREF_NEXT(cref);
439 *((
const VALUE **)&dst->as.captured.ep) = ep;
447 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, env->iseq);
448 rb_vm_block_ep_update(bindval, &bind->block, env->ep);
451#if VM_COLLECT_USAGE_DETAILS
452static void vm_collect_usage_operand(
int insn,
int n,
VALUE op);
453static void vm_collect_usage_insn(
int insn);
454static void vm_collect_usage_register(
int reg,
int isset);
459 int argc,
const VALUE *argv,
int kw_splat,
VALUE block_handler,
465static uint64_t yjit_total_entry_hits = 0;
468#define YJIT_CALL_COUNT_INTERV 20u
472rb_yjit_threshold_hit(
const rb_iseq_t *iseq, uint64_t entry_calls)
474 yjit_total_entry_hits += 1;
477 if (entry_calls + YJIT_CALL_COUNT_INTERV == rb_yjit_call_threshold) {
478 iseq->body->yjit_calls_at_interv = yjit_total_entry_hits;
483 if (entry_calls == rb_yjit_call_threshold) {
485 if (rb_yjit_call_threshold < YJIT_CALL_COUNT_INTERV) {
489 uint64_t num_calls = yjit_total_entry_hits - iseq->body->yjit_calls_at_interv;
492 if (num_calls > rb_yjit_cold_threshold) {
493 rb_yjit_incr_counter(
"cold_iseq_entry");
503#define rb_yjit_threshold_hit(iseq, entry_calls) false
515static inline rb_jit_func_t
522 if (body->jit_entry == NULL) {
523 body->jit_entry_calls++;
524 if (rb_yjit_threshold_hit(iseq, body->jit_entry_calls)) {
525 rb_yjit_compile_iseq(iseq, ec,
false);
528 return body->jit_entry;
531# define yjit_compile(ec) ((rb_jit_func_t)0)
535static inline rb_jit_func_t
541 if (body->jit_entry == NULL) {
542 body->jit_entry_calls++;
546 if (body->jit_entry_calls == rb_zjit_profile_threshold) {
547 rb_zjit_profile_enable(iseq);
551 if (body->jit_entry_calls == rb_zjit_call_threshold) {
552 rb_zjit_compile_iseq(iseq,
false);
555 return body->jit_entry;
558# define zjit_compile(ec) ((rb_jit_func_t)0)
566 if (rb_yjit_enabled_p) {
567 rb_jit_func_t func = yjit_compile(ec);
569 return func(ec, ec->cfp);
576 void *zjit_entry = rb_zjit_entry;
578 rb_jit_func_t func = zjit_compile(ec);
580 return ((rb_zjit_func_t)zjit_entry)(ec, ec->cfp, func);
587#if USE_YJIT || USE_ZJIT
594static inline rb_jit_func_t
601 if (body->jit_exception == NULL && rb_zjit_enabled_p) {
602 body->jit_exception_calls++;
606 if (body->jit_exception_calls == rb_zjit_profile_threshold) {
607 rb_zjit_profile_enable(iseq);
611 if (body->jit_exception_calls == rb_zjit_call_threshold) {
612 rb_zjit_compile_iseq(iseq,
true);
619 if (body->jit_exception == NULL && rb_yjit_enabled_p) {
620 body->jit_exception_calls++;
621 if (body->jit_exception_calls == rb_yjit_call_threshold) {
622 rb_yjit_compile_iseq(iseq, ec,
true);
626 return body->jit_exception;
633 rb_jit_func_t func = jit_compile_exception(ec);
636 return func(ec, ec->cfp);
643# define jit_compile_exception(ec) ((rb_jit_func_t)0)
644# define jit_exec_exception(ec) Qundef
649#define RB_TYPE_2_P(obj, type1, type2) \
650 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2))
651#define RB_TYPE_3_P(obj, type1, type2, type3) \
652 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2) || RB_TYPE_P(obj, type3))
654#define VM_ASSERT_TYPE(obj, type) \
655 VM_ASSERT(RB_TYPE_P(obj, type), #obj ": %s", rb_obj_info(obj))
656#define VM_ASSERT_TYPE2(obj, type1, type2) \
657 VM_ASSERT(RB_TYPE_2_P(obj, type1, type2), #obj ": %s", rb_obj_info(obj))
658#define VM_ASSERT_TYPE3(obj, type1, type2, type3) \
659 VM_ASSERT(RB_TYPE_3_P(obj, type1, type2, type3), #obj ": %s", rb_obj_info(obj))
661#include "vm_insnhelper.c"
665#include "vm_method.c"
672VALUE rb_mRubyVMFrozenCore;
673VALUE rb_block_param_proxy;
675VALUE ruby_vm_const_missing_count = 0;
676rb_vm_t *ruby_current_vm_ptr = NULL;
678bool ruby_vm_keep_script_lines;
680#ifdef RB_THREAD_LOCAL_SPECIFIER
684RB_THREAD_LOCAL_SPECIFIER
rb_atomic_t ruby_nt_serial;
689rb_current_ec_noinline(
void)
691 return ruby_current_ec;
697 ruby_current_ec = ec;
701#ifdef RB_THREAD_CURRENT_EC_NOINLINE
705 return ruby_current_ec;
710native_tls_key_t ruby_current_ec_key;
714rb_current_ec_noinline(
void)
716 return native_tls_get(ruby_current_ec_key);
723unsigned int ruby_vm_c_events_enabled = 0;
724unsigned int ruby_vm_iseq_events_enabled = 0;
726rb_serial_t ruby_vm_constant_cache_invalidations = 0;
727rb_serial_t ruby_vm_constant_cache_misses = 0;
728rb_serial_t ruby_vm_global_cvar_state = 1;
731 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
734 .call_ = vm_call_general,
740static const struct rb_callcache vm_empty_cc_for_super = {
741 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
744 .call_ = vm_call_super_method,
750static void thread_free(
void *ptr);
753rb_vm_inc_const_missing_count(
void)
755 ruby_vm_const_missing_count +=1;
764 if (!ec) ec = GET_EC();
765 if (!rb_ec_frame_method_id_and_class(ec, &
id, 0, &klass) || !klass)
769 klass =
RBASIC(klass)->klass;
771 else if (RCLASS_SINGLETON_P(klass)) {
772 klass = RCLASS_ATTACHED_OBJECT(klass);
773 if (
NIL_P(klass))
return FALSE;
778 const char *classname, *filename;
779 const char *methodname = rb_id2name(
id);
780 if (methodname && (filename = rb_source_location_cstr(&args->line_no)) != 0) {
782 classname =
"<unknown>";
783 args->classname = classname;
784 args->methodname = methodname;
785 args->filename = filename;
794extern unsigned int redblack_buffer_size;
822 static VALUE sym_constant_cache_invalidations, sym_constant_cache_misses, sym_global_cvar_state, sym_next_shape_id;
823 static VALUE sym_shape_cache_size;
837 hash = rb_hash_new();
840#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
841 S(constant_cache_invalidations);
842 S(constant_cache_misses);
843 S(global_cvar_state);
848#define SET(name, attr) \
849 if (key == sym_##name) \
850 return SERIALT2NUM(attr); \
851 else if (hash != Qnil) \
852 rb_hash_aset(hash, sym_##name, SERIALT2NUM(attr));
854 SET(constant_cache_invalidations, ruby_vm_constant_cache_invalidations);
855 SET(constant_cache_misses, ruby_vm_constant_cache_misses);
856 SET(global_cvar_state, ruby_vm_global_cvar_state);
857 SET(next_shape_id, (rb_serial_t)rb_shapes_count());
858 SET(shape_cache_size, (rb_serial_t)rb_shape_tree.cache_size);
862 ruby_debug_counter_show_at_exit(FALSE);
863 for (
size_t i = 0; i < RB_DEBUG_COUNTER_MAX; i++) {
864 const VALUE name = rb_sym_intern_ascii_cstr(rb_debug_counter_names[i]);
870 else if (hash !=
Qnil) {
871 rb_hash_aset(hash, name, boxed_value);
877 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(key));
888 if (ISEQ_BODY(iseq)->
type != ISEQ_TYPE_TOP) {
889 rb_raise(
rb_eTypeError,
"Not a toplevel InstructionSequence");
893 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
894 rb_ec_thread_ptr(ec)->top_self,
896 (
VALUE)vm_cref_new_toplevel(ec),
897 ISEQ_BODY(iseq)->iseq_encoded, ec->cfp->sp,
898 ISEQ_BODY(iseq)->local_table_size, ISEQ_BODY(iseq)->stack_max);
904 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_EVAL | VM_FRAME_FLAG_FINISH,
905 vm_block_self(base_block), VM_GUARDED_PREV_EP(vm_block_ep(base_block)),
907 ISEQ_BODY(iseq)->iseq_encoded,
908 ec->cfp->sp, ISEQ_BODY(iseq)->local_table_size,
909 ISEQ_BODY(iseq)->stack_max);
915 VALUE toplevel_binding =
rb_const_get(rb_cObject, rb_intern(
"TOPLEVEL_BINDING"));
918 GetBindingPtr(toplevel_binding, bind);
921 vm_set_eval_stack(ec, iseq, 0, &bind->block);
924 if (ISEQ_BODY(iseq)->local_table_size > 0) {
925 vm_bind_update_env(toplevel_binding, bind, vm_make_env_object(ec, ec->cfp));
932 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
936 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
944 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
945 if (VM_FRAME_RUBYFRAME_P(cfp)) {
948 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
956 if (VM_FRAME_RUBYFRAME_P(cfp)) {
960 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
962 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
963 if (VM_FRAME_RUBYFRAME_P(cfp)) {
967 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_PASSED) == FALSE) {
970 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
976rb_vm_pop_cfunc_frame(
void)
983 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec, me->owner, me->def->original_id);
984 vm_pop_frame(ec, cfp, cfp->ep);
991 while (ec->cfp != cfp) {
993 printf(
"skipped frame: %s\n", vm_frametype_name(ec->cfp));
995 if (VM_FRAME_TYPE(ec->cfp) != VM_FRAME_MAGIC_CFUNC) {
999 rb_vm_pop_cfunc_frame();
1012 nl->next = vm->at_exit;
1017ruby_vm_run_at_exit_hooks(
rb_vm_t *vm)
1023 rb_vm_at_exit_func *func = l->func;
1037 fputs(
"---\n", stderr);
1038 ruby_debug_printf(
"envptr: %p\n", (
void *)&env->ep[0]);
1039 ruby_debug_printf(
"envval: %10p ", (
void *)env->ep[1]);
1041 ruby_debug_printf(
"ep: %10p\n", (
void *)env->ep);
1042 if (rb_vm_env_prev_env(env)) {
1043 fputs(
">>\n", stderr);
1044 check_env_value(rb_vm_env_prev_env(env));
1045 fputs(
"<<\n", stderr);
1051check_env_value(
const rb_env_t *env)
1053 if (check_env(env)) {
1056 rb_bug(
"invalid env");
1063 switch (vm_block_handler_type(block_handler)) {
1064 case block_handler_type_ifunc:
1065 case block_handler_type_iseq:
1066 return rb_vm_make_proc(ec, VM_BH_TO_CAPT_BLOCK(block_handler),
rb_cProc);
1068 case block_handler_type_symbol:
1069 case block_handler_type_proc:
1070 return block_handler;
1072 VM_UNREACHABLE(vm_block_handler_escape);
1079 const VALUE *
const ep = cfp->ep;
1080 VALUE *env_body, *env_ep;
1081 int local_size, env_size;
1083 if (VM_ENV_ESCAPED_P(ep)) {
1084 return VM_ENV_ENVVAL(ep);
1087 if (!VM_ENV_LOCAL_P(ep)) {
1088 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1089 if (!VM_ENV_ESCAPED_P(prev_ep)) {
1092 while (prev_cfp->ep != prev_ep) {
1093 prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(prev_cfp);
1094 VM_ASSERT(prev_cfp->ep != NULL);
1097 vm_make_env_each(ec, prev_cfp);
1098 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_SPECVAL], VM_GUARDED_PREV_EP(prev_cfp->ep));
1102 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1103 VALUE block_handler = VM_ENV_BLOCK_HANDLER(ep);
1105 if (block_handler != VM_BLOCK_HANDLER_NONE) {
1106 VALUE blockprocval = vm_block_handler_escape(ec, block_handler);
1107 VM_STACK_ENV_WRITE(ep, VM_ENV_DATA_INDEX_SPECVAL, blockprocval);
1111 if (!VM_FRAME_RUBYFRAME_P(cfp)) {
1112 local_size = VM_ENV_DATA_SIZE;
1115 local_size = ISEQ_BODY(cfp->iseq)->local_table_size;
1116 if (ISEQ_BODY(cfp->iseq)->param.flags.forwardable && VM_ENV_LOCAL_P(cfp->ep)) {
1117 int ci_offset = local_size - ISEQ_BODY(cfp->iseq)->param.size + VM_ENV_DATA_SIZE;
1120 local_size += vm_ci_argc(ci);
1122 local_size += VM_ENV_DATA_SIZE;
1128 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1129 rb_yjit_invalidate_ep_is_bp(cfp->iseq);
1130 rb_zjit_invalidate_no_ep_escape(cfp->iseq);
1145 env_size = local_size +
1153 MEMCPY(env_body, ep - (local_size - 1 ),
VALUE, local_size);
1155 env_ep = &env_body[local_size - 1 ];
1156 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1158 env->iseq = (
rb_iseq_t *)(VM_FRAME_RUBYFRAME_P(cfp) ? cfp->iseq : NULL);
1160 env->env = env_body;
1161 env->env_size = env_size;
1164 VM_ENV_FLAGS_SET(env_ep, VM_ENV_FLAG_ESCAPED | VM_ENV_FLAG_WB_REQUIRED);
1165 VM_STACK_ENV_WRITE(ep, 0, (
VALUE)env);
1168 for (i = 0; i < local_size; i++) {
1169 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1171 ep[-local_size + i] = 0;
1182 VALUE envval = vm_make_env_each(ec, cfp);
1185 check_env_value((
const rb_env_t *)envval);
1195 while ((cfp = rb_vm_get_binding_creatable_next_cfp(ec, cfp)) != 0) {
1196 vm_make_env_object(ec, cfp);
1197 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1202rb_vm_env_prev_env(
const rb_env_t *env)
1204 const VALUE *ep = env->ep;
1206 if (VM_ENV_LOCAL_P(ep)) {
1210 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1211 return VM_ENV_ENVVAL_PTR(prev_ep);
1219 if (!iseq)
return 0;
1220 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1221 local_var_list_add(vars, ISEQ_BODY(iseq)->local_table[i]);
1230 if (VM_ENV_FLAGS(env->ep, VM_ENV_FLAG_ISOLATED))
break;
1231 collect_local_variables_in_iseq(env->iseq, vars);
1232 }
while ((env = rb_vm_env_prev_env(env)) != NULL);
1238 if (VM_ENV_ESCAPED_P(ep)) {
1239 collect_local_variables_in_env(VM_ENV_ENVVAL_PTR(ep), vars);
1248rb_vm_env_local_variables(
const rb_env_t *env)
1251 local_var_list_init(&vars);
1252 collect_local_variables_in_env(env, &vars);
1253 return local_var_list_finish(&vars);
1257rb_vm_env_numbered_parameters(
const rb_env_t *env)
1260 local_var_list_init(&vars);
1264 if (!iseq)
return 0;
1265 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1266 numparam_list_add(&vars, ISEQ_BODY(iseq)->local_table[i]);
1268 return local_var_list_finish(&vars);
1272rb_iseq_local_variables(
const rb_iseq_t *iseq)
1275 local_var_list_init(&vars);
1276 while (collect_local_variables_in_iseq(iseq, &vars)) {
1277 iseq = ISEQ_BODY(iseq)->parent_iseq;
1279 return local_var_list_finish(&vars);
1285vm_proc_create_from_captured(
VALUE klass,
1287 enum rb_block_type block_type,
1288 int8_t is_from_method, int8_t is_lambda)
1290 VALUE procval = rb_proc_alloc(klass);
1293 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), captured->ep));
1296 RB_OBJ_WRITE(procval, &proc->block.as.captured.code.val, captured->code.val);
1297 RB_OBJ_WRITE(procval, &proc->block.as.captured.self, captured->self);
1298 rb_vm_block_ep_update(procval, &proc->block, captured->ep);
1300 vm_block_type_set(&proc->block, block_type);
1301 proc->is_from_method = is_from_method;
1302 proc->is_lambda = is_lambda;
1311 switch (vm_block_type(src)) {
1312 case block_type_iseq:
1313 case block_type_ifunc:
1314 RB_OBJ_WRITE(obj, &dst->as.captured.self, src->as.captured.self);
1315 RB_OBJ_WRITE(obj, &dst->as.captured.code.val, src->as.captured.code.val);
1316 rb_vm_block_ep_update(obj, dst, src->as.captured.ep);
1318 case block_type_symbol:
1321 case block_type_proc:
1328proc_create(
VALUE klass,
const struct rb_block *block, int8_t is_from_method, int8_t is_lambda)
1330 VALUE procval = rb_proc_alloc(klass);
1333 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), vm_block_ep(block)));
1334 rb_vm_block_copy(procval, &proc->block, block);
1335 vm_block_type_set(&proc->block, block->type);
1336 proc->is_from_method = is_from_method;
1337 proc->is_lambda = is_lambda;
1343rb_proc_dup(
VALUE self)
1348 GetProcPtr(self, src);
1350 switch (vm_block_type(&src->block)) {
1351 case block_type_ifunc:
1352 procval = rb_func_proc_dup(self);
1355 procval = proc_create(
rb_obj_class(self), &src->block, src->is_from_method, src->is_lambda);
1374 if (SIZEOF_VOIDP > SIZEOF_LONG)
1383 if (SIZEOF_VOIDP > SIZEOF_LONG)
1389static enum rb_id_table_iterator_result
1390collect_outer_variable_names(
ID id,
VALUE val,
void *ptr)
1394 if (
id == rb_intern(
"yield")) {
1399 if (data->isolate ||
1404 store = &data->read_only;
1409 return ID_TABLE_CONTINUE;
1413env_copy(
const VALUE *src_ep,
VALUE read_only_variables)
1416 VM_ASSERT(src_env->ep == src_ep);
1419 VALUE *ep = &env_body[src_env->env_size - 2];
1420 const rb_env_t *copied_env = vm_env_new(ep, env_body, src_env->env_size, src_env->iseq);
1423 VALUE svar_val = src_ep[VM_ENV_DATA_INDEX_ME_CREF];
1424 if (imemo_type_p(svar_val, imemo_svar)) {
1434 RB_OBJ_WRITE(copied_env, &ep[VM_ENV_DATA_INDEX_ME_CREF], svar_val);
1436 ep[VM_ENV_DATA_INDEX_FLAGS] = src_ep[VM_ENV_DATA_INDEX_FLAGS] | VM_ENV_FLAG_ISOLATED;
1437 if (!VM_ENV_LOCAL_P(src_ep)) {
1438 VM_ENV_FLAGS_SET(ep, VM_ENV_FLAG_LOCAL);
1441 if (read_only_variables) {
1442 for (
int i=
RARRAY_LENINT(read_only_variables)-1; i>=0; i--) {
1446 for (
unsigned int j=0; j<body->local_table_size; j++) {
1447 if (
id == body->local_table[j]) {
1449 if (body->lvar_states[j] == lvar_reassigned) {
1450 VALUE name = rb_id2str(
id);
1451 VALUE msg = rb_sprintf(
"cannot make a shareable Proc because "
1452 "the outer variable '%" PRIsVALUE
"' may be reassigned.", name);
1457 VALUE v = src_env->env[j];
1459 VALUE name = rb_id2str(
id);
1460 VALUE msg = rb_sprintf(
"cannot make a shareable Proc because it can refer"
1461 " unshareable object %+" PRIsVALUE
" from ", v);
1463 rb_str_catf(msg,
"variable '%" PRIsVALUE
"'", name);
1476 if (!VM_ENV_LOCAL_P(src_ep)) {
1477 const VALUE *prev_ep = VM_ENV_PREV_EP(src_env->ep);
1478 const rb_env_t *new_prev_env = env_copy(prev_ep, read_only_variables);
1479 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_GUARDED_PREV_EP(new_prev_env->ep);
1481 VM_ENV_FLAGS_UNSET(ep, VM_ENV_FLAG_LOCAL);
1484 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_BLOCK_HANDLER_NONE;
1487 RB_OBJ_SET_SHAREABLE((
VALUE)copied_env);
1495 const rb_env_t *env = env_copy(captured->ep, read_only_variables);
1496 *((
const VALUE **)&proc->block.as.captured.ep) = env->ep;
1501proc_shared_outer_variables(
struct rb_id_table *outer_variables,
bool isolate,
const char *message)
1509 rb_id_table_foreach(outer_variables, collect_outer_variable_names, (
void *)&data);
1511 if (data.ary !=
Qfalse) {
1512 VALUE str = rb_sprintf(
"can not %s because it accesses outer variables", message);
1513 VALUE ary = data.ary;
1514 const char *sep =
" (";
1517 if (!name)
continue;
1526 else if (data.yield) {
1527 rb_raise(rb_eArgError,
"can not %s because it uses 'yield'.", message);
1530 return data.read_only;
1534rb_proc_isolate_bang(
VALUE self,
VALUE replace_self)
1536 const rb_iseq_t *iseq = vm_proc_iseq(self);
1541 if (!UNDEF_P(replace_self)) {
1543 RB_OBJ_WRITE(self, &proc->block.as.captured.self, replace_self);
1546 if (proc->block.type != block_type_iseq) rb_raise(
rb_eRuntimeError,
"not supported yet");
1548 if (ISEQ_BODY(iseq)->outer_variables) {
1549 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables,
true,
"isolate a Proc");
1552 proc_isolate_env(self, proc,
Qfalse);
1553 proc->is_isolated = TRUE;
1557 RB_OBJ_SET_SHAREABLE(self);
1562rb_proc_isolate(
VALUE self)
1564 VALUE dst = rb_proc_dup(self);
1565 rb_proc_isolate_bang(dst,
Qundef);
1570rb_proc_ractor_make_shareable(
VALUE self,
VALUE replace_self)
1572 const rb_iseq_t *iseq = vm_proc_iseq(self);
1577 if (!UNDEF_P(replace_self)) {
1578 RB_OBJ_WRITE(self, &proc->block.as.captured.self, replace_self);
1581 if (proc->block.type != block_type_iseq) rb_raise(
rb_eRuntimeError,
"not supported yet");
1584 rb_raise(rb_eRactorIsolationError,
1585 "Proc's self is not shareable: %" PRIsVALUE,
1591 if (ISEQ_BODY(iseq)->outer_variables) {
1592 read_only_variables =
1593 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables,
false,
"make a Proc shareable");
1596 proc_isolate_env(self, proc, read_only_variables);
1597 proc->is_isolated = TRUE;
1600 const struct rb_block *block = vm_proc_block(self);
1601 if (block->type != block_type_symbol) rb_raise(
rb_eRuntimeError,
"not supported yet");
1603 VALUE proc_self = vm_block_self(block);
1605 rb_raise(rb_eRactorIsolationError,
1606 "Proc's self is not shareable: %" PRIsVALUE,
1611 RB_OBJ_SET_FROZEN_SHAREABLE(self);
1619 enum imemo_type code_type = imemo_type(captured->code.val);
1621 if (!VM_ENV_ESCAPED_P(captured->ep)) {
1623 vm_make_env_object(ec, cfp);
1626 VM_ASSERT(VM_EP_IN_HEAP_P(ec, captured->ep));
1627 VM_ASSERT(code_type == imemo_iseq || code_type == imemo_ifunc);
1629 procval = vm_proc_create_from_captured(klass, captured,
1630 code_type == imemo_iseq ? block_type_iseq : block_type_ifunc,
1633 if (code_type == imemo_ifunc) {
1635 if (ifunc->svar_lep) {
1636 VALUE ep0 = ifunc->svar_lep[0];
1640 ifunc->svar_lep = (
VALUE *)env->ep;
1644 if (ep0 & VM_ENV_FLAG_ESCAPED) {
1648 ifunc->svar_lep = NULL;
1664 VALUE bindval, envval;
1667 if (cfp == 0 || ruby_level_cfp == 0) {
1668 rb_raise(
rb_eRuntimeError,
"Can't create Binding Object on top of Fiber.");
1670 if (!VM_FRAME_RUBYFRAME_P(src_cfp) &&
1671 !VM_FRAME_RUBYFRAME_P(RUBY_VM_PREVIOUS_CONTROL_FRAME(src_cfp))) {
1672 rb_raise(
rb_eRuntimeError,
"Cannot create Binding object for non-Ruby caller");
1675 envval = vm_make_env_object(ec, cfp);
1677 GetBindingPtr(bindval, bind);
1678 vm_bind_update_env(bindval, bind, envval);
1679 RB_OBJ_WRITE(bindval, &bind->block.as.captured.self, cfp->self);
1680 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, cfp->iseq);
1681 RB_OBJ_WRITE(bindval, &bind->pathobj, ISEQ_BODY(ruby_level_cfp->iseq)->location.pathobj);
1682 bind->first_lineno = rb_vm_get_sourceline(ruby_level_cfp);
1688rb_binding_add_dynavars(
VALUE bindval,
rb_binding_t *bind,
int dyncount,
const ID *dynvars)
1690 VALUE envval, pathobj = bind->pathobj;
1691 VALUE path = pathobj_path(pathobj);
1692 VALUE realpath = pathobj_realpath(pathobj);
1699 if (dyncount < 0)
return 0;
1701 base_block = &bind->block;
1702 base_iseq = vm_block_iseq(base_block);
1706 dyns->size = dyncount;
1707 MEMCPY(dyns->ids, dynvars,
ID, dyncount);
1709 rb_node_init(RNODE(&tmp_node), NODE_SCOPE);
1710 tmp_node.nd_tbl = dyns;
1711 tmp_node.nd_body = 0;
1712 tmp_node.nd_parent = NULL;
1713 tmp_node.nd_args = 0;
1715 VALUE ast_value = rb_ruby_ast_new(RNODE(&tmp_node));
1718 iseq = rb_iseq_new(ast_value, ISEQ_BODY(base_iseq)->location.label, path, realpath, base_iseq, ISEQ_TYPE_EVAL);
1721 VALUE tempstr = rb_fstring_lit(
"<temp>");
1722 iseq = rb_iseq_new_top(ast_value, tempstr, tempstr, tempstr, NULL);
1724 tmp_node.nd_tbl = 0;
1727 vm_set_eval_stack(ec, iseq, 0, base_block);
1728 vm_bind_update_env(bindval, bind, envval = vm_make_env_object(ec, ec->cfp));
1729 rb_vm_pop_frame(ec);
1740 int arg_size = ISEQ_BODY(iseq)->param.size;
1742 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_FINISH, self,
1743 VM_GUARDED_PREV_EP(captured->ep),
1745 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1746 ec->cfp->sp + arg_size,
1747 ISEQ_BODY(iseq)->local_table_size - arg_size,
1748 ISEQ_BODY(iseq)->stack_max);
1755 int arg_size = ISEQ_BODY(iseq)->param.size;
1757 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
1759 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_BMETHOD, self,
1760 VM_GUARDED_PREV_EP(captured->ep),
1762 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1763 ec->cfp->sp + 1 + arg_size,
1764 ISEQ_BODY(iseq)->local_table_size - arg_size,
1765 ISEQ_BODY(iseq)->stack_max);
1767 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_FINISH);
1770ALWAYS_INLINE(
static VALUE
1772 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1777 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1780 const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq);
1782 VALUE type = VM_FRAME_MAGIC_BLOCK | (is_lambda ? VM_FRAME_FLAG_LAMBDA : 0);
1784 VALUE *sp = cfp->sp;
1785 int flags = (kw_splat ? VM_CALL_KW_SPLAT : 0);
1791 if (UNLIKELY(argc > VM_ARGC_STACK_MAX) &&
1792 (VM_ARGC_STACK_MAX >= 1 ||
1794 (argc != 1 || is_lambda))) {
1795 use_argv = vm_argv_ruby_array(av, argv, &flags, &argc, kw_splat);
1798 CHECK_VM_STACK_OVERFLOW(cfp, argc + 1);
1799 vm_check_canary(ec, sp);
1801 VALUE *stack_argv = sp;
1806 cfp->sp = stack_argv + argc;
1809 opt_pc = vm_yield_setup_args(ec, iseq, argc, stack_argv, flags, passed_block_handler,
1810 (is_lambda ? arg_setup_method : arg_setup_block));
1814 invoke_block(ec, iseq, self, captured, cref,
type, opt_pc);
1817 invoke_bmethod(ec, iseq, self, captured, me,
type, opt_pc);
1825 int argc,
const VALUE *argv,
1827 int is_lambda,
int force_blockarg)
1830 switch (vm_block_handler_type(block_handler)) {
1831 case block_handler_type_iseq:
1834 return invoke_iseq_block_from_c(ec, captured, captured->self,
1835 argc, argv, kw_splat, passed_block_handler,
1836 cref, is_lambda, NULL);
1838 case block_handler_type_ifunc:
1839 return vm_yield_with_cfunc(ec, VM_BH_TO_IFUNC_BLOCK(block_handler),
1840 VM_BH_TO_IFUNC_BLOCK(block_handler)->self,
1841 argc, argv, kw_splat, passed_block_handler, NULL);
1842 case block_handler_type_symbol:
1843 return vm_yield_with_symbol(ec, VM_BH_TO_SYMBOL(block_handler),
1844 argc, argv, kw_splat, passed_block_handler);
1845 case block_handler_type_proc:
1846 if (force_blockarg == FALSE) {
1847 is_lambda = block_proc_is_lambda(VM_BH_TO_PROC(block_handler));
1849 block_handler = vm_proc_to_block_handler(VM_BH_TO_PROC(block_handler));
1852 VM_UNREACHABLE(invoke_block_from_c_splattable);
1859 VALUE block_handler = VM_CF_BLOCK_HANDLER(ec->cfp);
1860 vm_block_handler_verify(block_handler);
1861 if (UNLIKELY(block_handler == VM_BLOCK_HANDLER_NONE)) {
1862 rb_vm_localjump_error(
"no block given",
Qnil, 0);
1865 return block_handler;
1871 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1872 argc, argv, kw_splat, VM_BLOCK_HANDLER_NONE,
1873 cref, is_lambda, FALSE);
1879 return vm_yield_with_cref(ec, argc, argv, kw_splat, NULL, FALSE);
1885 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1886 argc, argv, kw_splat, block_handler,
1887 NULL, FALSE, FALSE);
1893 return invoke_block_from_c_bh(ec, check_block_handler(ec), 1, &args,
1897ALWAYS_INLINE(
static VALUE
1900 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
1906 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
1909 const struct rb_block *block = &proc->block;
1912 switch (vm_block_type(block)) {
1913 case block_type_iseq:
1914 return invoke_iseq_block_from_c(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, NULL, is_lambda, me);
1915 case block_type_ifunc:
1916 if (kw_splat == 1) {
1917 VALUE keyword_hash = argv[argc-1];
1919 keyword_hash = rb_to_hash_type(keyword_hash);
1925 ((
VALUE *)argv)[argc-1] = rb_hash_dup(keyword_hash);
1928 return vm_yield_with_cfunc(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, me);
1929 case block_type_symbol:
1930 return vm_yield_with_symbol(ec, block->as.symbol, argc, argv, kw_splat, passed_block_handler);
1931 case block_type_proc:
1932 is_lambda = block_proc_is_lambda(block->as.proc);
1933 block = vm_proc_block(block->as.proc);
1936 VM_UNREACHABLE(invoke_block_from_c_proc);
1942 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler)
1944 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, proc->is_lambda, NULL);
1951 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, block_handler, TRUE, me);
1956 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler)
1958 VALUE self = vm_block_self(&proc->block);
1959 vm_block_handler_verify(passed_block_handler);
1961 if (proc->is_from_method) {
1962 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
1965 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler);
1971 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler)
1973 vm_block_handler_verify(passed_block_handler);
1975 if (proc->is_from_method) {
1976 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
1979 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler);
1988 while (cfp->pc == 0 || cfp->iseq == 0) {
1989 if (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_IFUNC) {
1991 return ifunc->svar_lep;
1994 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1997 if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
2002 return (
VALUE *)VM_CF_LEP(cfp);
2008 return lep_svar_get(ec, rb_vm_svar_lep(ec, cfp), key);
2014 lep_svar_set(ec, rb_vm_svar_lep(ec, cfp), key, val);
2020 return vm_cfp_svar_get(ec, ec->cfp, key);
2026 vm_cfp_svar_set(ec, ec->cfp, key, val);
2032 return vm_svar_get(GET_EC(), VM_SVAR_BACKREF);
2038 vm_svar_set(GET_EC(), VM_SVAR_BACKREF, val);
2044 return vm_svar_get(GET_EC(), VM_SVAR_LASTLINE);
2050 vm_svar_set(GET_EC(), VM_SVAR_LASTLINE, val);
2054rb_lastline_set_up(
VALUE val,
unsigned int up)
2058 for(
unsigned int i = 0; i < up; i++) {
2059 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2061 vm_cfp_svar_set(GET_EC(), cfp, VM_SVAR_LASTLINE, val);
2073 return RSTRING_PTR(rb_iseq_path(cfp->iseq));
2087 return rb_vm_get_sourceline(cfp);
2095rb_source_location(
int *pline)
2100 if (cfp && VM_FRAME_RUBYFRAME_P(cfp)) {
2101 if (pline) *pline = rb_vm_get_sourceline(cfp);
2102 return rb_iseq_path(cfp->iseq);
2105 if (pline) *pline = 0;
2111rb_source_location_cstr(
int *pline)
2113 VALUE path = rb_source_location(pline);
2114 if (
NIL_P(path))
return NULL;
2115 return RSTRING_PTR(path);
2122 return vm_ec_cref(ec);
2126rb_vm_cref_replace_with_duplicated_cref(
void)
2130 rb_cref_t *cref = vm_cref_replace_with_duplicated_cref(cfp->ep);
2136rb_vm_cref_in_context(
VALUE self,
VALUE cbase)
2141 if (!cfp || cfp->self != self)
return NULL;
2142 if (!vm_env_cref_by_cref(cfp->ep))
return NULL;
2143 cref = vm_get_cref(cfp->ep);
2144 if (CREF_CLASS(cref) != cbase)
return NULL;
2153 dp(CREF_CLASS(cref));
2154 printf(
"%ld\n", CREF_VISI(cref));
2155 cref = CREF_NEXT(cref);
2169 return vm_get_cbase(cfp->ep);
2175make_localjump_error(
const char *mesg,
VALUE value,
int reason)
2207rb_vm_localjump_error(
const char *mesg,
VALUE value,
int reason)
2209 VALUE exc = make_localjump_error(mesg, value, reason);
2214rb_vm_make_jump_tag_but_local_jump(
enum ruby_tag_type state,
VALUE val)
2220 mesg =
"unexpected return";
2223 mesg =
"unexpected break";
2226 mesg =
"unexpected next";
2229 mesg =
"unexpected redo";
2233 mesg =
"retry outside of rescue clause";
2240 val = GET_EC()->tag->retval;
2242 return make_localjump_error(mesg, val, state);
2246rb_vm_jump_tag_but_local_jump(
enum ruby_tag_type state)
2248 VALUE exc = rb_vm_make_jump_tag_but_local_jump(state,
Qundef);
2250 EC_JUMP_TAG(GET_EC(), state);
2256 while (VM_ENV_LOCAL_P(cfp->ep)) {
2257 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2268 const VALUE *ep = VM_CF_PREV_EP(cfp);
2272 rb_vm_localjump_error(
"unexpected break", val, TAG_BREAK);
2275 ec->errinfo = (
VALUE)THROW_DATA_NEW(val, target_cfp, TAG_BREAK);
2276 EC_JUMP_TAG(ec, TAG_BREAK);
2282 vm_iter_break(GET_EC(),
Qnil);
2288 vm_iter_break(GET_EC(), val);
2293short ruby_vm_redefined_flag[BOP_LAST_];
2294static st_table *vm_opt_method_def_table = 0;
2295static st_table *vm_opt_mid_table = 0;
2298rb_free_vm_opt_tables(
void)
2300 st_free_table(vm_opt_method_def_table);
2301 st_free_table(vm_opt_mid_table);
2305vm_redefinition_check_flag(
VALUE klass)
2307 if (klass ==
rb_cInteger)
return INTEGER_REDEFINED_OP_FLAG;
2308 if (klass ==
rb_cFloat)
return FLOAT_REDEFINED_OP_FLAG;
2309 if (klass ==
rb_cString)
return STRING_REDEFINED_OP_FLAG;
2310 if (klass ==
rb_cArray)
return ARRAY_REDEFINED_OP_FLAG;
2311 if (klass ==
rb_cHash)
return HASH_REDEFINED_OP_FLAG;
2312 if (klass ==
rb_cSymbol)
return SYMBOL_REDEFINED_OP_FLAG;
2314 if (klass ==
rb_cTime)
return TIME_REDEFINED_OP_FLAG;
2316 if (klass ==
rb_cRegexp)
return REGEXP_REDEFINED_OP_FLAG;
2317 if (klass ==
rb_cNilClass)
return NIL_REDEFINED_OP_FLAG;
2320 if (klass ==
rb_cProc)
return PROC_REDEFINED_OP_FLAG;
2325rb_vm_check_optimizable_mid(
VALUE mid)
2327 if (!vm_opt_mid_table) {
2331 return st_lookup(vm_opt_mid_table, mid, NULL);
2337 if (me->called_id != me->def->original_id) {
2341 if (METHOD_ENTRY_BASIC(me))
return TRUE;
2344 switch (def->type) {
2345 case VM_METHOD_TYPE_CFUNC:
2346 case VM_METHOD_TYPE_OPTIMIZED:
2361 if (vm_redefinition_check_method_type(me)) {
2362 if (st_lookup(vm_opt_method_def_table, (st_data_t)me->def, &bop)) {
2363 int flag = vm_redefinition_check_flag(klass);
2367 "Redefining '%s#%s' disables interpreter and JIT optimizations",
2369 rb_id2name(me->called_id)
2371 rb_yjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2372 rb_zjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2373 ruby_vm_redefined_flag[bop] |= flag;
2379static enum rb_id_table_iterator_result
2380check_redefined_method(
ID mid,
VALUE value,
void *data)
2386 if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner);
2388 return ID_TABLE_CONTINUE;
2392rb_vm_check_redefinition_by_prepend(
VALUE klass)
2394 if (!vm_redefinition_check_flag(klass))
return;
2395 rb_id_table_foreach(RCLASS_M_TBL(RCLASS_ORIGIN(klass)), check_redefined_method, (
void *)klass);
2399add_opt_method_entry_bop(
const rb_method_entry_t *me,
ID mid,
enum ruby_basic_operators bop)
2401 st_insert(vm_opt_method_def_table, (st_data_t)me->def, (st_data_t)bop);
2402 st_insert(vm_opt_mid_table, (st_data_t)mid, (st_data_t)
Qtrue);
2406add_opt_method(
VALUE klass,
ID mid,
enum ruby_basic_operators bop)
2410 if (me && vm_redefinition_check_method_type(me)) {
2411 add_opt_method_entry_bop(me, mid, bop);
2414 rb_bug(
"undefined optimized method: %s", rb_id2name(mid));
2418static enum ruby_basic_operators vm_redefinition_bop_for_id(
ID mid);
2423 if (me && vm_redefinition_check_method_type(me)) {
2424 ID mid = me->called_id;
2425 enum ruby_basic_operators bop = vm_redefinition_bop_for_id(mid);
2426 if ((
int)bop >= 0) {
2427 add_opt_method_entry_bop(me, mid, bop);
2433vm_init_redefined_flag(
void)
2436 enum ruby_basic_operators bop;
2438#define OP(mid_, bop_) (mid = id##mid_, bop = BOP_##bop_, ruby_vm_redefined_flag[bop] = 0)
2439#define C(k) add_opt_method(rb_c##k, mid, bop)
2440 OP(PLUS, PLUS), (C(Integer), C(Float), C(String), C(Array));
2441 OP(MINUS, MINUS), (C(Integer), C(Float));
2442 OP(MULT, MULT), (C(Integer), C(Float));
2443 OP(DIV, DIV), (C(Integer), C(Float));
2444 OP(MOD, MOD), (C(Integer), C(Float));
2445 OP(Eq, EQ), (C(Integer), C(Float), C(String), C(Symbol));
2446 OP(Eqq, EQQ), (C(Integer), C(Float), C(Symbol), C(String),
2447 C(NilClass), C(TrueClass), C(FalseClass));
2448 OP(LT, LT), (C(Integer), C(Float));
2449 OP(LE, LE), (C(Integer), C(Float));
2450 OP(GT, GT), (C(Integer), C(Float));
2451 OP(GE, GE), (C(Integer), C(Float));
2452 OP(LTLT, LTLT), (C(String), C(Array));
2453 OP(GTGT, GTGT), (C(Integer));
2454 OP(AREF, AREF), (C(Array), C(Hash), C(Integer));
2455 OP(ASET, ASET), (C(Array), C(Hash));
2456 OP(Length, LENGTH), (C(Array), C(String), C(Hash));
2457 OP(Size, SIZE), (C(Array), C(String), C(Hash));
2458 OP(EmptyP, EMPTY_P), (C(Array), C(String), C(Hash));
2459 OP(Succ, SUCC), (C(Integer), C(String));
2460 OP(EqTilde, MATCH), (C(
Regexp), C(String));
2461 OP(Freeze, FREEZE), (C(String), C(Array), C(Hash));
2462 OP(UMinus, UMINUS), (C(String));
2463 OP(Max, MAX), (C(Array));
2464 OP(Min, MIN), (C(Array));
2465 OP(Hash, HASH), (C(Array));
2466 OP(Call, CALL), (C(Proc));
2467 OP(And, AND), (C(Integer));
2468 OP(Or, OR), (C(Integer));
2469 OP(NilP,
NIL_P), (C(NilClass));
2470 OP(Cmp, CMP), (C(Integer), C(Float), C(String));
2471 OP(Default, DEFAULT), (C(Hash));
2472 OP(IncludeP, INCLUDE_P), (C(Array));
2477static enum ruby_basic_operators
2478vm_redefinition_bop_for_id(
ID mid)
2481#define OP(mid_, bop_) case id##mid_: return BOP_##bop_
2498 OP(EmptyP, EMPTY_P);
2511 OP(Default, DEFAULT);
2524 switch (VM_FRAME_TYPE(cfp)) {
2525 case VM_FRAME_MAGIC_METHOD:
return "method";
2526 case VM_FRAME_MAGIC_BLOCK:
return "block";
2527 case VM_FRAME_MAGIC_CLASS:
return "class";
2528 case VM_FRAME_MAGIC_TOP:
return "top";
2529 case VM_FRAME_MAGIC_CFUNC:
return "cfunc";
2530 case VM_FRAME_MAGIC_IFUNC:
return "ifunc";
2531 case VM_FRAME_MAGIC_EVAL:
return "eval";
2532 case VM_FRAME_MAGIC_RESCUE:
return "rescue";
2534 rb_bug(
"unknown frame");
2542 if (THROW_DATA_P(err) &&
2543 THROW_DATA_STATE(err) == TAG_BREAK &&
2544 THROW_DATA_CONSUMED_P(err) == FALSE) {
2545 return THROW_DATA_VAL(err);
2557 unsigned long type = VM_FRAME_TYPE(cfp);
2558#define C(t) if (type == VM_FRAME_MAGIC_##t) return #t
2586 unsigned int local_hooks_cnt = iseq->aux.exec.local_hooks_cnt;
2587 if (RB_UNLIKELY(local_hooks_cnt > 0)) {
2588 local_hooks = rb_iseq_local_hooks(iseq, rb_ec_ractor_ptr(ec),
false);
2591 switch (VM_FRAME_TYPE(ec->cfp)) {
2592 case VM_FRAME_MAGIC_METHOD:
2593 RUBY_DTRACE_METHOD_RETURN_HOOK(ec, 0, 0);
2594 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2598 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2601 THROW_DATA_CONSUMED_SET(err);
2603 case VM_FRAME_MAGIC_BLOCK:
2604 if (VM_FRAME_BMETHOD_P(ec->cfp)) {
2605 VALUE bmethod_return_value = frame_return_value(err);
2606 if (cfp_returning_with_value) {
2608 bmethod_return_value = THROW_DATA_VAL(err);
2612 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, bmethod_return_value);
2615 ec->cfp->self, 0, 0, 0, bmethod_return_value, TRUE);
2621 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2622 rb_vm_frame_method_entry(ec->cfp)->called_id,
2623 rb_vm_frame_method_entry(ec->cfp)->owner,
2624 bmethod_return_value);
2626 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
2627 unsigned int local_hooks_cnt = me->def->body.bmethod.local_hooks_cnt;
2628 if (UNLIKELY(local_hooks_cnt > 0)) {
2629 local_hooks = rb_method_def_local_hooks(me->def, rb_ec_ractor_ptr(ec),
false);
2632 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2633 rb_vm_frame_method_entry(ec->cfp)->called_id,
2634 rb_vm_frame_method_entry(ec->cfp)->owner,
2635 bmethod_return_value, TRUE);
2639 THROW_DATA_CONSUMED_SET(err);
2642 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2645 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2647 THROW_DATA_CONSUMED_SET(err);
2650 case VM_FRAME_MAGIC_CLASS:
2743#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2745struct rb_vm_exec_context {
2753vm_exec_bottom_main(
void *context)
2755 struct rb_vm_exec_context *ctx = context;
2758 ctx->result = vm_exec_loop(ec, TAG_NONE, ctx->tag, vm_exec_core(ec));
2762vm_exec_bottom_rescue(
void *context)
2764 struct rb_vm_exec_context *ctx = context;
2767 ctx->result = vm_exec_loop(ec, rb_ec_tag_state(ec), ctx->tag, ec->errinfo);
2780#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2781 struct rb_vm_exec_context ctx = {
2789 rb_wasm_try_catch_init(&try_catch, vm_exec_bottom_main, vm_exec_bottom_rescue, &ctx);
2791 rb_wasm_try_catch_loop_run(&try_catch, &RB_VM_TAG_JMPBUF_GET(_tag.buf));
2793 result = ctx.result;
2795 enum ruby_tag_type state;
2796 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2797 if (UNDEF_P(result = jit_exec(ec))) {
2798 result = vm_exec_core(ec);
2801 result = vm_exec_loop(ec, TAG_NONE, &_tag, result);
2804 result = vm_exec_loop(ec, state, &_tag, ec->errinfo);
2816 if (state == TAG_NONE) {
2820 rb_ec_raised_reset(ec, RAISED_STACKOVERFLOW | RAISED_NOMEMORY);
2821 while (UNDEF_P(result = vm_exec_handle_exception(ec, state, result))) {
2824 if (UNDEF_P(result = jit_exec_exception(ec))) {
2825 result = vm_exec_core(ec);
2828 VM_ASSERT(ec->tag == tag);
2830 if ((state = tag->state) == TAG_NONE)
break;
2831 tag->state = TAG_NONE;
2846 unsigned long epc, cont_pc, cont_sp;
2851 cont_pc = cont_sp = 0;
2854 while (ec->cfp->pc == 0 || ec->cfp->iseq == 0) {
2855 if (UNLIKELY(VM_FRAME_TYPE(ec->cfp) == VM_FRAME_MAGIC_CFUNC)) {
2857 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2858 rb_vm_frame_method_entry(ec->cfp)->called_id,
2859 rb_vm_frame_method_entry(ec->cfp)->owner,
Qnil);
2860 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec,
2861 rb_vm_frame_method_entry(ec->cfp)->owner,
2862 rb_vm_frame_method_entry(ec->cfp)->def->original_id);
2864 rb_vm_pop_frame(ec);
2868 epc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded;
2871 if (state == TAG_BREAK || state == TAG_RETURN) {
2872 escape_cfp = THROW_DATA_CATCH_FRAME(err);
2874 if (cfp == escape_cfp) {
2875 if (state == TAG_RETURN) {
2876 if (!VM_FRAME_FINISHED_P(cfp)) {
2877 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
2878 THROW_DATA_STATE_SET(err, state = TAG_BREAK);
2881 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2882 if (ct)
for (i = 0; i < ct->size; i++) {
2883 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2884 if (entry->start < epc && entry->end >= epc) {
2885 if (entry->type == CATCH_TYPE_ENSURE) {
2886 catch_iseq = entry->iseq;
2887 cont_pc = entry->cont;
2888 cont_sp = entry->sp;
2893 if (catch_iseq == NULL) {
2895 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
2897 hook_before_rewind(ec,
true, state, err);
2898 rb_vm_pop_frame(ec);
2899 return THROW_DATA_VAL(err);
2906 *cfp->sp++ = THROW_DATA_VAL(err);
2913 if (state == TAG_RAISE) {
2914 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2915 if (ct)
for (i = 0; i < ct->size; i++) {
2916 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2917 if (entry->start < epc && entry->end >= epc) {
2919 if (entry->type == CATCH_TYPE_RESCUE ||
2920 entry->type == CATCH_TYPE_ENSURE) {
2921 catch_iseq = entry->iseq;
2922 cont_pc = entry->cont;
2923 cont_sp = entry->sp;
2929 else if (state == TAG_RETRY) {
2930 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2931 if (ct)
for (i = 0; i < ct->size; i++) {
2932 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2933 if (entry->start < epc && entry->end >= epc) {
2935 if (entry->type == CATCH_TYPE_ENSURE) {
2936 catch_iseq = entry->iseq;
2937 cont_pc = entry->cont;
2938 cont_sp = entry->sp;
2941 else if (entry->type == CATCH_TYPE_RETRY) {
2943 escape_cfp = THROW_DATA_CATCH_FRAME(err);
2944 if (cfp == escape_cfp) {
2945 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + entry->cont;
2953 else if ((state == TAG_BREAK && !escape_cfp) ||
2954 (state == TAG_REDO) ||
2955 (state == TAG_NEXT)) {
2956 type = (
const enum rb_catch_type[TAG_MASK]) {
2957 [TAG_BREAK] = CATCH_TYPE_BREAK,
2958 [TAG_NEXT] = CATCH_TYPE_NEXT,
2959 [TAG_REDO] = CATCH_TYPE_REDO,
2963 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2964 if (ct)
for (i = 0; i < ct->size; i++) {
2965 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2967 if (entry->start < epc && entry->end >= epc) {
2968 if (entry->type == CATCH_TYPE_ENSURE) {
2969 catch_iseq = entry->iseq;
2970 cont_pc = entry->cont;
2971 cont_sp = entry->sp;
2974 else if (entry->type ==
type) {
2975 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + entry->cont;
2976 cfp->sp = vm_base_ptr(cfp) + entry->sp;
2978 if (state != TAG_REDO) {
2979 *cfp->sp++ = THROW_DATA_VAL(err);
2982 VM_ASSERT(ec->tag->state == TAG_NONE);
2989 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2990 if (ct)
for (i = 0; i < ct->size; i++) {
2991 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2992 if (entry->start < epc && entry->end >= epc) {
2994 if (entry->type == CATCH_TYPE_ENSURE) {
2995 catch_iseq = entry->iseq;
2996 cont_pc = entry->cont;
2997 cont_sp = entry->sp;
3004 if (catch_iseq != NULL) {
3006 const int arg_size = 1;
3008 rb_iseq_check(catch_iseq);
3009 cfp->sp = vm_base_ptr(cfp) + cont_sp;
3010 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + cont_pc;
3013 cfp->sp[0] = (
VALUE)err;
3014 vm_push_frame(ec, catch_iseq, VM_FRAME_MAGIC_RESCUE,
3016 VM_GUARDED_PREV_EP(cfp->ep),
3018 ISEQ_BODY(catch_iseq)->iseq_encoded,
3019 cfp->sp + arg_size ,
3020 ISEQ_BODY(catch_iseq)->local_table_size - arg_size,
3021 ISEQ_BODY(catch_iseq)->stack_max);
3024 ec->tag->state = TAG_NONE;
3030 hook_before_rewind(ec, (cfp == escape_cfp), state, err);
3032 if (VM_FRAME_FINISHED_P(ec->cfp)) {
3033 rb_vm_pop_frame(ec);
3034 ec->errinfo = (
VALUE)err;
3035 rb_vm_tag_jmpbuf_deinit(&ec->tag->buf);
3036 ec->tag = ec->tag->prev;
3037 EC_JUMP_TAG(ec, state);
3040 rb_vm_pop_frame(ec);
3053 vm_set_top_stack(ec, iseq, box);
3063 vm_set_main_stack(ec, iseq);
3074 if (idp) *idp = me->def->original_id;
3075 if (called_idp) *called_idp = me->called_id;
3076 if (klassp) *klassp = me->owner;
3087 return rb_vm_control_frame_id_and_class(ec->cfp, idp, called_idp, klassp);
3093 return rb_ec_frame_method_id_and_class(GET_EC(), idp, 0, klassp);
3102 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
3103 const rb_box_t *box = rb_current_box();
3106 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
3107 recv, GC_GUARDED_PTR(box),
3108 (
VALUE)vm_cref_new_toplevel(ec),
3109 0, reg_cfp->sp, 0, 0);
3113 rb_vm_pop_frame(ec);
3125 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
3128 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
3129 recv, GC_GUARDED_PTR(box),
3130 (
VALUE)vm_cref_new_toplevel(ec),
3131 0, reg_cfp->sp, 0, 0);
3133 val = (*func)(arg1, arg2);
3135 rb_vm_pop_frame(ec);
3142 VM_ASSERT(rb_box_available());
3143 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_BOX_REQUIRE);
3151 const VALUE *lep = VM_EP_RUBY_LEP(ec, cfp);
3152 VM_BOX_ASSERT(lep,
"lep should be valid");
3153 VM_BOX_ASSERT(rb_box_available(),
"box should be available here");
3155 if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_METHOD) || VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_CFUNC)) {
3156 cme = check_method_entry(lep[VM_ENV_DATA_INDEX_ME_CREF], TRUE);
3157 VM_BOX_ASSERT(cme,
"cme should be valid");
3158 VM_BOX_ASSERT(cme->def,
"cme->def shold be valid");
3159 return cme->def->box;
3161 else if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_TOP) || VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_CLASS)) {
3162 VM_BOX_ASSERT(VM_ENV_LOCAL_P(lep),
"lep should be local on MAGIC_TOP or MAGIC_CLASS frames");
3163 return VM_ENV_BOX(lep);
3165 else if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_DUMMY)) {
3168 box = rb_main_box();
3171 return rb_root_box();
3175 rb_bug(
"BUG: Local ep without cme/box, flags: %08lX", (
unsigned long)lep[VM_ENV_DATA_INDEX_FLAGS]);
3183 return current_box_on_cfp(ec, ec->cfp);
3189 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp)) {
3190 if (!VM_ENV_FRAME_TYPE_P(cfp->ep, VM_FRAME_MAGIC_CFUNC))
3192 if (!BOX_ROOT_P(current_box_on_cfp(ec, cfp)))
3194 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3196 VM_ASSERT(RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp));
3205 if (!rb_box_available() || !ec)
3206 return rb_root_box();
3210 end_cfp = RUBY_VM_END_CONTROL_FRAME(ec);
3212 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp)) {
3213 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BOX_REQUIRE)) {
3214 if (
RTEST(cfp->self) && BOX_OBJ_P(cfp->self)) {
3216 return rb_get_box_t(cfp->self);
3219 cfp = find_loader_control_frame(ec, cfp, end_cfp);
3220 return current_box_on_cfp(ec, cfp);
3222 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3225 return current_box_on_cfp(ec, current_cfp);
3231rb_vm_update_references(
void *ptr)
3236 vm->self = rb_gc_location(vm->self);
3237 vm->mark_object_ary = rb_gc_location(vm->mark_object_ary);
3238 vm->orig_progname = rb_gc_location(vm->orig_progname);
3241 rb_box_gc_update_references(vm->root_box);
3243 rb_box_gc_update_references(vm->main_box);
3245 rb_gc_update_values(RUBY_NSIG, vm->trap_list.cmd);
3247 if (vm->coverages) {
3248 vm->coverages = rb_gc_location(vm->coverages);
3249 vm->me2counter = rb_gc_location(vm->me2counter);
3255rb_vm_each_stack_value(
void *ptr,
void (*cb)(
VALUE,
void*),
void *ctx)
3260 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3261 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3262 rb_ractor_status_p(r, ractor_running));
3263 if (r->threads.cnt > 0) {
3265 ccan_list_for_each(&r->threads.set, th, lt_node) {
3266 VM_ASSERT(th != NULL);
3269 VALUE *p = ec->vm_stack;
3270 VALUE *sp = ec->cfp->sp;
3284static enum rb_id_table_iterator_result
3285vm_mark_negative_cme(
VALUE val,
void *dmy)
3288 return ID_TABLE_CONTINUE;
3291void rb_thread_sched_mark_zombies(
rb_vm_t *vm);
3294rb_vm_mark(
void *ptr)
3296 RUBY_MARK_ENTER(
"vm");
3297 RUBY_GC_INFO(
"-------------------------------------------------\n");
3303 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3305 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3306 rb_ractor_status_p(r, ractor_running));
3307 rb_gc_mark(rb_ractor_self(r));
3310 for (
struct global_object_list *list = vm->global_object_list; list; list = list->next) {
3311 rb_gc_mark_maybe(*list->varptr);
3314 rb_gc_mark_movable(vm->self);
3317 rb_box_entry_mark(vm->root_box);
3320 rb_box_entry_mark(vm->main_box);
3323 rb_gc_mark_movable(vm->mark_object_ary);
3324 rb_gc_mark_movable(vm->orig_progname);
3325 rb_gc_mark_movable(vm->coverages);
3326 rb_gc_mark_movable(vm->me2counter);
3328 rb_gc_mark_values(RUBY_NSIG, vm->trap_list.cmd);
3330 rb_hook_list_mark(&vm->global_hooks);
3332 rb_id_table_foreach_values(vm->negative_cme_table, vm_mark_negative_cme, NULL);
3333 rb_mark_tbl_no_pin(vm->overloaded_cme_table);
3334 for (i=0; i<VM_GLOBAL_CC_CACHE_TABLE_SIZE; i++) {
3335 const struct rb_callcache *cc = vm->global_cc_cache_table[i];
3338 if (!vm_cc_invalidated_p(cc)) {
3339 rb_gc_mark((
VALUE)cc);
3342 vm->global_cc_cache_table[i] = NULL;
3347 rb_thread_sched_mark_zombies(vm);
3350 RUBY_MARK_LEAVE(
"vm");
3353#undef rb_vm_register_special_exception
3355rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp,
VALUE cls,
VALUE mesg)
3360 ((
VALUE *)vm->special_exceptions)[sp] = exc;
3361 rb_vm_register_global_object(exc);
3364void rb_objspace_free_objects(
void *
objspace);
3369 RUBY_FREE_ENTER(
"vm");
3370 ruby_vm_during_cleanup =
true;
3375 if (rb_free_at_exit) {
3376 rb_free_encoded_insn_data();
3377 rb_free_global_enc_table();
3378 rb_free_loaded_builtin_table();
3379 rb_free_global_symbol_table();
3381 rb_free_shared_fiber_pool();
3382 rb_free_transcoder_table();
3383 rb_free_vm_opt_tables();
3385 rb_free_rb_global_tbl();
3387 rb_id_table_free(vm->negative_cme_table);
3388 st_free_table(vm->overloaded_cme_table);
3393 st_free_table(vm->static_ext_inits);
3395 rb_vm_postponed_job_free();
3397 rb_id_table_free(vm->constant_cache);
3398 set_free_table(vm->unused_block_warning_table);
3400 rb_thread_free_native_thread(th);
3402#ifndef HAVE_SETPROCTITLE
3403 ruby_free_proctitle();
3407 rb_fiber_reset_root_local_storage(th);
3413 rb_vm_living_threads_init(vm);
3414 ruby_vm_run_at_exit_hooks(vm);
3416 st_free_table(vm->ci_table);
3417 vm->ci_table = NULL;
3419 if (vm->cc_refinement_table) {
3420 rb_set_free_table(vm->cc_refinement_table);
3421 vm->cc_refinement_table = NULL;
3423 RB_ALTSTACK_FREE(vm->main_altstack);
3432 if (rb_free_at_exit) {
3433 rb_objspace_free_objects(
objspace);
3434 rb_free_generic_fields_tbl_();
3435 rb_free_default_rand_key();
3444 ruby_current_vm_ptr = NULL;
3446 if (rb_free_at_exit) {
3447 rb_shape_free_all();
3449 rb_yjit_free_at_exit();
3453 RUBY_FREE_LEAVE(
"vm");
3457size_t rb_vm_memsize_workqueue(
struct ccan_list_head *workqueue);
3461static enum rb_id_table_iterator_result
3462vm_memsize_constant_cache_i(
ID id,
VALUE ics,
void *size)
3464 *((
size_t *) size) += rb_set_memsize((
set_table *) ics);
3465 return ID_TABLE_CONTINUE;
3472vm_memsize_constant_cache(
void)
3475 size_t size = rb_id_table_memsize(vm->constant_cache);
3477 rb_id_table_foreach(vm->constant_cache, vm_memsize_constant_cache_i, &size);
3488 at_exit = at_exit->next;
3497vm_memsize_builtin_function_table(
const struct rb_builtin_function *builtin_function_table)
3505vm_memsize(
const void *ptr)
3511 rb_vm_memsize_postponed_job_queue() +
3512 rb_vm_memsize_workqueue(&vm->workqueue) +
3513 vm_memsize_at_exit_list(vm->at_exit) +
3514 rb_st_memsize(vm->ci_table) +
3515 vm_memsize_builtin_function_table(vm->builtin_function_table) +
3516 rb_id_table_memsize(vm->negative_cme_table) +
3517 rb_st_memsize(vm->overloaded_cme_table) +
3518 rb_set_memsize(vm->cc_refinement_table) +
3519 vm_memsize_constant_cache()
3530 {0, 0, vm_memsize,},
3531 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3536vm_default_params(
void)
3539 VALUE result = rb_hash_new_with_size(4);
3540#define SET(name) rb_hash_aset(result, ID2SYM(rb_intern(#name)), SIZET2NUM(vm->default_params.name));
3541 SET(thread_vm_stack_size);
3542 SET(thread_machine_stack_size);
3543 SET(fiber_vm_stack_size);
3544 SET(fiber_machine_stack_size);
3551get_param(
const char *name,
size_t default_value,
size_t min_value)
3554 size_t result = default_value;
3555 if ((envval = getenv(name)) != 0) {
3556 long val = atol(envval);
3557 if (val < (
long)min_value) {
3558 val = (long)min_value;
3560 result = (size_t)(((val -1 + RUBY_VM_SIZE_ALIGN) / RUBY_VM_SIZE_ALIGN) * RUBY_VM_SIZE_ALIGN);
3562 if (0) ruby_debug_printf(
"%s: %"PRIuSIZE
"\n", name, result);
3568check_machine_stack_size(
size_t *sizep)
3570#ifdef PTHREAD_STACK_MIN
3571 size_t size = *sizep;
3574#ifdef PTHREAD_STACK_MIN
3575 if (size < (
size_t)PTHREAD_STACK_MIN) {
3576 *sizep = (size_t)PTHREAD_STACK_MIN * 2;
3582vm_default_params_setup(
rb_vm_t *vm)
3584 vm->default_params.thread_vm_stack_size =
3585 get_param(
"RUBY_THREAD_VM_STACK_SIZE",
3586 RUBY_VM_THREAD_VM_STACK_SIZE,
3587 RUBY_VM_THREAD_VM_STACK_SIZE_MIN);
3589 vm->default_params.thread_machine_stack_size =
3590 get_param(
"RUBY_THREAD_MACHINE_STACK_SIZE",
3591 RUBY_VM_THREAD_MACHINE_STACK_SIZE,
3592 RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN);
3594 vm->default_params.fiber_vm_stack_size =
3595 get_param(
"RUBY_FIBER_VM_STACK_SIZE",
3596 RUBY_VM_FIBER_VM_STACK_SIZE,
3597 RUBY_VM_FIBER_VM_STACK_SIZE_MIN);
3599 vm->default_params.fiber_machine_stack_size =
3600 get_param(
"RUBY_FIBER_MACHINE_STACK_SIZE",
3601 RUBY_VM_FIBER_MACHINE_STACK_SIZE,
3602 RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN);
3605 check_machine_stack_size(&vm->default_params.thread_machine_stack_size);
3606 check_machine_stack_size(&vm->default_params.fiber_machine_stack_size);
3612 rb_vm_living_threads_init(vm);
3613 vm->thread_report_on_exception = 1;
3614 vm->src_encoding_index = -1;
3616 vm_default_params_setup(vm);
3626 VALUE *p = ec->vm_stack;
3627 VALUE *sp = ec->cfp->sp;
3631 for (i = 0; i < (long)(sp - p); i++) {
3633 VALUE update = rb_gc_location(ref);
3634 if (ref != update) {
3639 while (cfp != limit_cfp) {
3640 const VALUE *ep = cfp->ep;
3641 cfp->self = rb_gc_location(cfp->self);
3643 cfp->block_code = (
void *)rb_gc_location((
VALUE)cfp->block_code);
3645 if (!VM_ENV_LOCAL_P(ep)) {
3646 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3647 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3648 VM_FORCE_WRITE(&prev_ep[VM_ENV_DATA_INDEX_ENV], rb_gc_location(prev_ep[VM_ENV_DATA_INDEX_ENV]));
3651 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3652 VM_FORCE_WRITE(&ep[VM_ENV_DATA_INDEX_ENV], rb_gc_location(ep[VM_ENV_DATA_INDEX_ENV]));
3653 VM_FORCE_WRITE(&ep[VM_ENV_DATA_INDEX_ME_CREF], rb_gc_location(ep[VM_ENV_DATA_INDEX_ME_CREF]));
3657 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3661 ec->storage = rb_gc_location(ec->storage);
3663 ec->gen_fields_cache.obj = rb_gc_location(ec->gen_fields_cache.obj);
3664 ec->gen_fields_cache.fields_obj = rb_gc_location(ec->gen_fields_cache.fields_obj);
3667static enum rb_id_table_iterator_result
3668mark_local_storage_i(
VALUE local,
void *data)
3671 return ID_TABLE_CONTINUE;
3680 VALUE *p = ec->vm_stack;
3681 VALUE *sp = ec->cfp->sp;
3685 VM_ASSERT(sp == ec->cfp->sp);
3686 rb_gc_mark_vm_stack_values((
long)(sp - p), p);
3688 while (cfp != limit_cfp) {
3689 const VALUE *ep = cfp->ep;
3690 VM_ASSERT(!!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) == vm_ep_in_heap_p_(ec, ep));
3692 rb_gc_mark_movable(cfp->self);
3693 rb_gc_mark_movable((
VALUE)cfp->iseq);
3694 rb_gc_mark_movable((
VALUE)cfp->block_code);
3696 if (VM_ENV_LOCAL_P(ep) && VM_ENV_BOXED_P(ep)) {
3697 const rb_box_t *box = VM_ENV_BOX(ep);
3698 if (BOX_USER_P(box)) {
3699 rb_gc_mark_movable(box->box_object);
3703 if (!VM_ENV_LOCAL_P(ep)) {
3704 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3705 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3706 rb_gc_mark_movable(prev_ep[VM_ENV_DATA_INDEX_ENV]);
3709 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3710 rb_gc_mark_movable(ep[VM_ENV_DATA_INDEX_ENV]);
3711 rb_gc_mark(ep[VM_ENV_DATA_INDEX_ME_CREF]);
3715 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3720 if (ec->machine.stack_start && ec->machine.stack_end &&
3723 rb_gc_mark_machine_context(ec);
3726 rb_gc_mark(ec->errinfo);
3727 rb_gc_mark(ec->root_svar);
3728 if (ec->local_storage) {
3729 rb_id_table_foreach_values(ec->local_storage, mark_local_storage_i, NULL);
3731 rb_gc_mark(ec->local_storage_recursive_hash);
3732 rb_gc_mark(ec->local_storage_recursive_hash_for_trace);
3733 rb_gc_mark(ec->private_const_reference);
3735 rb_gc_mark_movable(ec->storage);
3740void rb_threadptr_root_fiber_setup(
rb_thread_t *th);
3742void rb_threadptr_root_fiber_release(
rb_thread_t *th);
3745thread_compact(
void *ptr)
3749 th->self = rb_gc_location(th->self);
3753thread_mark(
void *ptr)
3756 RUBY_MARK_ENTER(
"thread");
3760 rb_fiber_mark_self(th->ec->fiber_ptr);
3764 switch (th->invoke_type) {
3765 case thread_invoke_type_proc:
3766 case thread_invoke_type_ractor_proc:
3767 rb_gc_mark(th->invoke_arg.proc.proc);
3768 rb_gc_mark(th->invoke_arg.proc.args);
3770 case thread_invoke_type_func:
3771 rb_gc_mark_maybe((
VALUE)th->invoke_arg.func.arg);
3777 rb_gc_mark(rb_ractor_self(th->ractor));
3778 rb_gc_mark(th->thgroup);
3779 rb_gc_mark(th->value);
3780 rb_gc_mark(th->pending_interrupt_queue);
3781 rb_gc_mark(th->pending_interrupt_mask_stack);
3782 rb_gc_mark(th->top_self);
3783 rb_gc_mark(th->top_wrapper);
3784 if (th->root_fiber) rb_fiber_mark_self(th->root_fiber);
3786 RUBY_ASSERT(th->ec == rb_fiberptr_get_ec(th->ec->fiber_ptr));
3787 rb_gc_mark(th->last_status);
3788 rb_gc_mark(th->locking_mutex);
3789 rb_gc_mark(th->name);
3791 rb_gc_mark(th->scheduler);
3793 rb_threadptr_interrupt_exec_task_mark(th);
3795 RUBY_MARK_LEAVE(
"thread");
3801thread_free(
void *ptr)
3804 RUBY_FREE_ENTER(
"thread");
3806 rb_threadptr_sched_free(th);
3808 if (th->locking_mutex !=
Qfalse) {
3809 rb_bug(
"thread_free: locking_mutex must be NULL (%p:%p)", (
void *)th, (
void *)th->locking_mutex);
3811 if (th->keeping_mutexes != NULL) {
3812 rb_bug(
"thread_free: keeping_mutexes must be NULL (%p:%p)", (
void *)th, (
void *)th->keeping_mutexes);
3815 ruby_xfree(th->specific_storage);
3817 if (th->vm && th->vm->ractor.main_thread == th) {
3818 RUBY_GC_INFO(
"MRI main thread\n");
3826 RUBY_FREE_LEAVE(
"thread");
3830thread_memsize(
const void *ptr)
3835 if (!th->root_fiber) {
3836 size += th->ec->vm_stack_size *
sizeof(
VALUE);
3838 if (th->ec->local_storage) {
3839 size += rb_id_table_memsize(th->ec->local_storage);
3844#define thread_data_type ruby_threadptr_data_type
3853 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3857rb_obj_is_thread(
VALUE obj)
3863thread_alloc(
VALUE klass)
3872 ec->vm_stack = stack;
3873 ec->vm_stack_size = size;
3879 rb_ec_set_vm_stack(ec, stack, size);
3881#if VM_CHECK_MODE > 0
3885 ec->cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
3889 VM_FRAME_MAGIC_DUMMY | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH | VM_FRAME_FLAG_CFRAME ,
3890 Qnil , VM_BLOCK_HANDLER_NONE ,
3892 0 , ec->vm_stack, 0, 0
3902 rb_ec_set_vm_stack(ec, NULL, 0);
3915 const rb_box_t *box = rb_current_box();
3919 ccan_list_head_init(&th->interrupt_exec_tasks);
3921 rb_threadptr_root_fiber_setup(th);
3925 th->scheduler =
Qnil;
3928 size_t size = vm->default_params.thread_vm_stack_size /
sizeof(
VALUE);
3930 rb_ec_initialize_vm_stack(th->ec, stack, size);
3931 rb_thread_malloc_stack_set(th, stack);
3934 VM_ASSERT(th->ec->cfp == NULL);
3935 VM_ASSERT(th->ec->vm_stack == NULL);
3936 VM_ASSERT(th->ec->vm_stack_size == 0);
3939 th->status = THREAD_RUNNABLE;
3940 th->last_status =
Qnil;
3941 th->top_wrapper = 0;
3942 if (box->top_self) {
3943 th->top_self = box->top_self;
3950 th->ec->errinfo =
Qnil;
3951 th->ec->root_svar =
Qfalse;
3952 th->ec->local_storage_recursive_hash =
Qnil;
3953 th->ec->local_storage_recursive_hash_for_trace =
Qnil;
3955 th->ec->storage =
Qnil;
3956 th->ec->ractor_id = rb_ractor_id(th->ractor);
3958#if OPT_CALL_THREADED_CODE
3962 th->report_on_exception = vm->thread_report_on_exception;
3963 th->ext_config.ractor_safe =
true;
3965#if USE_RUBY_DEBUG_LOG
3969 RUBY_DEBUG_LOG(
"th:%u", th->serial);
3974rb_thread_alloc(
VALUE klass)
3976 VALUE self = thread_alloc(klass);
3978 target_th->ractor = GET_RACTOR();
3979 th_init(target_th, self, target_th->vm = GET_VM());
3980 rb_root_fiber_obj_setup(target_th);
3984#define REWIND_CFP(expr) do { \
3985 rb_execution_context_t *ec__ = GET_EC(); \
3986 VALUE *const curr_sp = (ec__->cfp++)->sp; \
3987 VALUE *const saved_sp = ec__->cfp->sp; \
3988 ec__->cfp->sp = curr_sp; \
3990 (ec__->cfp--)->sp = saved_sp; \
4017 rb_clear_method_cache(self, mid);
4023m_core_set_postexe(
VALUE self)
4032core_hash_merge(
VALUE hash,
long argc,
const VALUE *argv)
4035 VM_ASSERT(argc % 2 == 0);
4036 rb_hash_bulk_insert(argc, argv, hash);
4041m_core_hash_merge_ptr(
int argc,
VALUE *argv,
VALUE recv)
4043 VALUE hash = argv[0];
4045 REWIND_CFP(hash = core_hash_merge(hash, argc-1, argv+1));
4053 rb_hash_aset(hash, key, value);
4061 REWIND_CFP(hash = core_hash_merge_kwd(hash, kw));
4073m_core_make_shareable_copy(
VALUE recv,
VALUE obj)
4081 return rb_ractor_ensure_shareable(obj, name);
4091extern VALUE *rb_gc_stack_start;
4092extern size_t rb_gc_stack_maxsize;
4100 rb_vm_bugreport(NULL, stderr);
4109#ifdef HAVE_BACKTRACE
4110#include <execinfo.h>
4111#define MAX_NATIVE_TRACE 1024
4112 static void *trace[MAX_NATIVE_TRACE];
4113 int n = (int)backtrace(trace, MAX_NATIVE_TRACE);
4114 char **syms = backtrace_symbols(trace, n);
4121 for (i=0; i<n; i++) {
4129#if VM_COLLECT_USAGE_DETAILS
4130static VALUE usage_analysis_insn_start(
VALUE self);
4131static VALUE usage_analysis_operand_start(
VALUE self);
4132static VALUE usage_analysis_register_start(
VALUE self);
4133static VALUE usage_analysis_insn_stop(
VALUE self);
4134static VALUE usage_analysis_operand_stop(
VALUE self);
4135static VALUE usage_analysis_register_stop(
VALUE self);
4136static VALUE usage_analysis_insn_running(
VALUE self);
4137static VALUE usage_analysis_operand_running(
VALUE self);
4138static VALUE usage_analysis_register_running(
VALUE self);
4139static VALUE usage_analysis_insn_clear(
VALUE self);
4140static VALUE usage_analysis_operand_clear(
VALUE self);
4141static VALUE usage_analysis_register_clear(
VALUE self);
4147 return rb_f_raise(c, v);
4196vm_keep_script_lines(
VALUE self)
4198 return RBOOL(ruby_vm_keep_script_lines);
4213vm_keep_script_lines_set(
VALUE self,
VALUE flags)
4215 ruby_vm_keep_script_lines =
RTEST(flags);
4244#if USE_DEBUG_COUNTER
4265 rb_define_method(klass,
"make_shareable_copy", m_core_make_shareable_copy, 1);
4268 RBASIC_CLEAR_CLASS(klass);
4270 rb_vm_register_global_object(fcore);
4271 rb_mRubyVMFrozenCore = fcore;
4434#if VM_COLLECT_USAGE_DETAILS
4436#define define_usage_analysis_hash(name) \
4437 rb_define_const(rb_cRubyVM, "USAGE_ANALYSIS_" #name, rb_hash_new())
4438 define_usage_analysis_hash(
INSN);
4439 define_usage_analysis_hash(REGS);
4440 define_usage_analysis_hash(INSN_BIGRAM);
4460 rb_define_const(rb_cRubyVM,
"OPTS", opts =
rb_ary_new());
4462#if OPT_DIRECT_THREADED_CODE
4464#elif OPT_TOKEN_THREADED_CODE
4466#elif OPT_CALL_THREADED_CODE
4470#if OPT_OPERANDS_UNIFICATION
4473#if OPT_INSTRUCTIONS_UNIFICATION
4476#if OPT_INLINE_METHOD_CACHE
4484 rb_define_const(rb_cRubyVM,
"INSTRUCTION_NAMES", rb_insns_name_array());
4492 rb_define_const(rb_cRubyVM,
"DEFAULT_PARAMS", vm_default_params());
4509 rb_vm_t *vm = ruby_current_vm_ptr;
4511 VALUE filename = rb_fstring_lit(
"<main>");
4512 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
4515 rb_ractor_main_setup(vm, th->ractor, th);
4522 vm->ractor.main_thread = th;
4523 vm->ractor.main_ractor = th->ractor;
4525 th->top_wrapper = 0;
4526 th->top_self = rb_vm_top_self();
4528 rb_root_fiber_obj_setup(th);
4530 rb_vm_register_global_object((
VALUE)iseq);
4531 th->ec->cfp->iseq = iseq;
4532 th->ec->cfp->pc = ISEQ_BODY(iseq)->iseq_encoded;
4533 th->ec->cfp->self = th->top_self;
4535 VM_ENV_FLAGS_UNSET(th->ec->cfp->ep, VM_FRAME_FLAG_CFRAME);
4536 VM_STACK_ENV_WRITE(th->ec->cfp->ep, VM_ENV_DATA_INDEX_ME_CREF, (
VALUE)vm_cref_new(rb_cObject, METHOD_VISI_PRIVATE, FALSE, NULL, FALSE, FALSE));
4544 rb_objspace_gc_enable(vm->gc.objspace);
4547 vm_init_redefined_flag();
4551 OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
4553 rb_vm_register_global_object(rb_block_param_proxy);
4556 Init_vm_backtrace();
4560rb_vm_set_progname(
VALUE filename)
4567 rb_iseq_pathobj_set(cfp->iseq, filename, rb_iseq_realpath(cfp->iseq));
4576 rb_vm_t *vm = ruby_mimcalloc(1,
sizeof(*vm));
4579 fputs(
"[FATAL] failed to allocate memory\n", stderr);
4586 rb_vm_postponed_job_queue_init(vm);
4587 ruby_current_vm_ptr = vm;
4588 rb_objspace_alloc();
4589 vm->negative_cme_table = rb_id_table_create(16);
4590 vm->overloaded_cme_table = st_init_numtable();
4591 vm->constant_cache = rb_id_table_create(0);
4592 vm->unused_block_warning_table = set_init_numtable();
4593 vm->global_hooks.type = hook_list_type_global;
4598 th->ractor = vm->ractor.main_ractor = rb_ractor_main_alloc();
4599 Init_native_thread(th);
4603 rb_ractor_set_current_ec(th->ractor, th->ec);
4606 ruby_thread_init_stack(th, native_main_thread_stack_top);
4612 vm_opt_method_def_table = st_init_numtable();
4613 vm_opt_mid_table = st_init_numtable();
4615#ifdef RUBY_THREAD_WIN32_H
4624 native_main_thread_stack_top = addr;
4629#include <sys/mman.h>
4633#ifndef MARK_OBJECT_ARY_BUCKET_SIZE
4634#define MARK_OBJECT_ARY_BUCKET_SIZE 1024
4644pin_array_list_mark(
void *data)
4647 rb_gc_mark_movable(array->next);
4649 rb_gc_mark_vm_stack_values(array->len, array->array);
4653pin_array_list_free(
void *data)
4656 xfree(array->array);
4660pin_array_list_memsize(
const void *data)
4666pin_array_list_update_references(
void *data)
4669 array->next = rb_gc_location(array->next);
4675 .dmark = pin_array_list_mark,
4676 .dfree = pin_array_list_free,
4677 .dsize = pin_array_list_memsize,
4678 .dcompact = pin_array_list_update_references,
4680 .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE,
4684pin_array_list_new(
VALUE next)
4689 array_list->array =
ALLOC_N(
VALUE, MARK_OBJECT_ARY_BUCKET_SIZE);
4699 if (array_list->len >= MARK_OBJECT_ARY_BUCKET_SIZE) {
4700 obj = pin_array_list_new(obj);
4704 RB_OBJ_WRITE(obj, &array_list->array[array_list->len], item);
4710rb_vm_register_global_object(
VALUE obj)
4720 if (
FL_TEST(obj, RCLASS_IS_ROOT)) {
4723 FL_SET(obj, RCLASS_IS_ROOT);
4729 VALUE list = GET_VM()->mark_object_ary;
4730 VALUE head = pin_array_list_append(list, obj);
4732 GET_VM()->mark_object_ary = head;
4739Init_vm_objects(
void)
4744 vm->mark_object_ary = pin_array_list_new(
Qnil);
4745 vm->ci_table = st_init_table(&vm_ci_hashtype);
4746 vm->cc_refinement_table = rb_set_init_numtable();
4750#include "jit_hook.rbinc"
4751#include "jit_undef.rbinc"
4755void Init_builtin_yjit(
void) {}
4760void Init_builtin_zjit(
void) {}
4774 const rb_box_t *box = rb_current_box();
4776 VM_ASSERT(box->top_self);
4777 return box->top_self;
4784 vm->root_box = (
rb_box_t *)rb_root_box();
4794 return &cr->verbose;
4804bool rb_free_at_exit =
false;
4807ruby_free_at_exit_p(
void)
4809 return rb_free_at_exit;
4817#if VM_COLLECT_USAGE_DETAILS
4819#define HASH_ASET(h, k, v) rb_hash_aset((h), (st_data_t)(k), (st_data_t)(v))
4833vm_analysis_insn(
int insn)
4837 static int prev_insn = -1;
4843 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
4844 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
4847 ihash = rb_hash_new();
4848 HASH_ASET(uh,
INT2FIX(insn), ihash);
4856 if (prev_insn != -1) {
4866 if (
NIL_P(cv = rb_hash_aref(uh, bi))) {
4875vm_analysis_operand(
int insn,
int n,
VALUE op)
4885 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
4889 ihash = rb_hash_new();
4890 HASH_ASET(uh,
INT2FIX(insn), ihash);
4893 ophash = rb_hash_new();
4894 HASH_ASET(ihash,
INT2FIX(n), ophash);
4897 valstr = rb_insn_operand_intern(GET_EC()->cfp->iseq, insn, n, op, 0, 0, 0, 0);
4900 if (
NIL_P(cv = rb_hash_aref(ophash, valstr))) {
4907vm_analysis_register(
int reg,
int isset)
4912 static const char regstrs[][5] = {
4920 static const char getsetstr[][4] = {
4924 static VALUE syms[
sizeof(regstrs) /
sizeof(regstrs[0])][2];
4928 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
4933 for (i = 0; i < (int)(
sizeof(regstrs) /
sizeof(regstrs[0])); i++) {
4935 for (j = 0; j < 2; j++) {
4936 snprintf(buff, 0x10,
"%d %s %-4s", i, getsetstr[j], regstrs[i]);
4937 syms[i][j] =
ID2SYM(rb_intern(buff));
4941 valstr = syms[reg][isset];
4944 if (
NIL_P(cv = rb_hash_aref(uh, valstr))) {
4952static void (*ruby_vm_collect_usage_func_insn)(
int insn) = NULL;
4953static void (*ruby_vm_collect_usage_func_operand)(
int insn,
int n,
VALUE op) = NULL;
4954static void (*ruby_vm_collect_usage_func_register)(
int reg,
int isset) = NULL;
4958usage_analysis_insn_start(
VALUE self)
4960 ruby_vm_collect_usage_func_insn = vm_analysis_insn;
4966usage_analysis_operand_start(
VALUE self)
4968 ruby_vm_collect_usage_func_operand = vm_analysis_operand;
4974usage_analysis_register_start(
VALUE self)
4976 ruby_vm_collect_usage_func_register = vm_analysis_register;
4982usage_analysis_insn_stop(
VALUE self)
4984 ruby_vm_collect_usage_func_insn = 0;
4990usage_analysis_operand_stop(
VALUE self)
4992 ruby_vm_collect_usage_func_operand = 0;
4998usage_analysis_register_stop(
VALUE self)
5000 ruby_vm_collect_usage_func_register = 0;
5006usage_analysis_insn_running(
VALUE self)
5008 return RBOOL(ruby_vm_collect_usage_func_insn != 0);
5013usage_analysis_operand_running(
VALUE self)
5015 return RBOOL(ruby_vm_collect_usage_func_operand != 0);
5020usage_analysis_register_running(
VALUE self)
5022 return RBOOL(ruby_vm_collect_usage_func_register != 0);
5026usage_analysis_clear(
VALUE self,
ID usage_hash)
5038usage_analysis_insn_clear(
VALUE self)
5043 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5044 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
5045 usage_analysis_clear(rb_cRubyVM, usage_hash);
5046 return usage_analysis_clear(rb_cRubyVM, bigram_hash);
5051usage_analysis_operand_clear(
VALUE self)
5055 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5056 return usage_analysis_clear(self, usage_hash);
5061usage_analysis_register_clear(
VALUE self)
5065 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
5066 return usage_analysis_clear(self, usage_hash);
5071MAYBE_UNUSED(
static void (*ruby_vm_collect_usage_func_insn)(
int insn)) = 0;
5072MAYBE_UNUSED(
static void (*ruby_vm_collect_usage_func_operand)(
int insn,
int n,
VALUE op)) = 0;
5073MAYBE_UNUSED(
static void (*ruby_vm_collect_usage_func_register)(
int reg,
int isset)) = 0;
5077#if VM_COLLECT_USAGE_DETAILS
5080vm_collect_usage_insn(
int insn)
5082 if (RUBY_DTRACE_INSN_ENABLED()) {
5083 RUBY_DTRACE_INSN(rb_insns_name(insn));
5085 if (ruby_vm_collect_usage_func_insn)
5086 (*ruby_vm_collect_usage_func_insn)(insn);
5094vm_collect_usage_operand(
int insn,
int n,
VALUE op)
5096 if (RUBY_DTRACE_INSN_OPERAND_ENABLED()) {
5099 valstr = rb_insn_operand_intern(GET_EC()->cfp->iseq, insn, n, op, 0, 0, 0, 0);
5101 RUBY_DTRACE_INSN_OPERAND(RSTRING_PTR(valstr), rb_insns_name(insn));
5104 if (ruby_vm_collect_usage_func_operand)
5105 (*ruby_vm_collect_usage_func_operand)(insn, n, op);
5111vm_collect_usage_register(
int reg,
int isset)
5113 if (ruby_vm_collect_usage_func_register)
5114 (*ruby_vm_collect_usage_func_register)(reg, isset);
5121 return &vm_empty_cc;
5125rb_vm_empty_cc_for_super(
void)
5127 return &vm_empty_cc_for_super;
5130#include "vm_call_iseq_optimized.inc"
#define RUBY_ASSERT_MESG(expr,...)
Asserts that the expression is truthy.
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ATOMIC_FETCH_ADD(var, val)
Atomically replaces the value pointed by var with the result of addition of val to the old value of v...
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_method_id(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define RUBY_EVENT_END
Encountered an end of a class clause.
#define RUBY_EVENT_B_RETURN
Encountered a next statement.
#define RUBY_EVENT_RETURN
Encountered a return statement.
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
uint32_t rb_event_flag_t
Represents event(s).
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define NUM2ULONG
Old name of RB_NUM2ULONG.
#define ALLOCV
Old name of RB_ALLOCV.
#define ALLOC
Old name of RB_ALLOC.
#define xfree
Old name of ruby_xfree.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define T_IMEMO
Old name of RUBY_T_IMEMO.
#define ID2SYM
Old name of RB_ID2SYM.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define ULONG2NUM
Old name of RB_ULONG2NUM.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define SYM2ID
Old name of RB_SYM2ID.
#define ZALLOC
Old name of RB_ZALLOC.
#define CLASS_OF
Old name of rb_class_of.
#define rb_ary_new4
Old name of rb_ary_new_from_values.
#define SIZET2NUM
Old name of RB_SIZE2NUM.
#define rb_exc_new2
Old name of rb_exc_new_cstr.
#define FIX2INT
Old name of RB_FIX2INT.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define ZALLOC_N
Old name of RB_ZALLOC_N.
#define ASSUME
Old name of RBIMPL_ASSUME.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define FL_SET
Old name of RB_FL_SET.
#define rb_exc_new3
Old name of rb_exc_new_str.
#define ULL2NUM
Old name of RB_ULL2NUM.
#define Qtrue
Old name of RUBY_Qtrue.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define NIL_P
Old name of RB_NIL_P.
#define NUM2ULL
Old name of RB_NUM2ULL.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FL_TEST
Old name of RB_FL_TEST.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define FL_USHIFT
Old name of RUBY_FL_USHIFT.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define ALLOCV_END
Old name of RB_ALLOCV_END.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
void ruby_init_stack(void *addr)
Set stack bottom of Ruby implementation.
VALUE rb_eLocalJumpError
LocalJumpError exception.
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
int rb_typeddata_is_kind_of(VALUE obj, const rb_data_type_t *data_type)
Checks if the given object is of given kind.
void rb_iter_break(void)
Breaks from a block.
VALUE rb_eTypeError
TypeError exception.
void rb_iter_break_value(VALUE val)
Identical to rb_iter_break(), except it additionally takes the "value" of this breakage.
VALUE rb_eRuntimeError
RuntimeError exception.
VALUE * rb_ruby_verbose_ptr(void)
This is an implementation detail of ruby_verbose.
VALUE rb_exc_new_str(VALUE etype, VALUE str)
Identical to rb_exc_new_cstr(), except it takes a Ruby's string instead of C's.
VALUE * rb_ruby_debug_ptr(void)
This is an implementation detail of ruby_debug.
VALUE rb_eSysStackError
SystemStackError exception.
@ RB_WARN_CATEGORY_PERFORMANCE
Warning is for performance issues (not enabled by -w).
VALUE rb_cTime
Time class.
VALUE rb_cArray
Array class.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
VALUE rb_cInteger
Module class.
VALUE rb_cNilClass
NilClass class.
VALUE rb_cBinding
Binding class.
VALUE rb_cRegexp
Regexp class.
VALUE rb_cHash
Hash class.
VALUE rb_cFalseClass
FalseClass class.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_cSymbol
Symbol class.
VALUE rb_cBasicObject
BasicObject class.
VALUE rb_cThread
Thread class.
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
VALUE rb_cFloat
Float class.
VALUE rb_cProc
Proc class.
VALUE rb_cTrueClass
TrueClass class.
VALUE rb_cString
String class.
#define RB_OBJ_WRITTEN(old, oldv, young)
Identical to RB_OBJ_WRITE(), except it doesn't write any values, but only a WB declaration.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Defines RBIMPL_HAS_BUILTIN.
VALUE rb_ary_delete_at(VALUE ary, long pos)
Destructively removes an element which resides at the specific index of the passed array.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
void rb_undef(VALUE mod, ID mid)
Inserts a method entry that hides previous method definition of the given name.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_backref_get(void)
Queries the last match, or Regexp.last_match, or the $~.
void rb_lastline_set(VALUE str)
Updates $_.
VALUE rb_lastline_get(void)
Queries the last line, or the $_.
void rb_backref_set(VALUE md)
Updates $~.
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
VALUE rb_block_lambda(void)
Identical to rb_proc_new(), except it returns a lambda.
VALUE rb_binding_new(void)
Snapshots the current execution context and turn it into an instance of rb_cBinding.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
void rb_set_class_path(VALUE klass, VALUE space, const char *name)
Names a class.
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
void rb_alias_variable(ID dst, ID src)
Aliases a global variable.
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
const char * rb_sourcefile(void)
Resembles __FILE__.
void rb_alias(VALUE klass, ID dst, ID src)
Resembles alias.
int rb_frame_method_id_and_class(ID *idp, VALUE *klassp)
Resembles __method__.
int rb_sourceline(void)
Resembles __LINE__.
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
VALUE rb_iv_set(VALUE obj, const char *name, VALUE val)
Assigns to an instance variable.
int len
Length of the buffer.
VALUE rb_ractor_make_shareable_copy(VALUE obj)
Identical to rb_ractor_make_shareable(), except it returns a (deep) copy of the passed one instead of...
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
VALUE rb_ractor_make_shareable(VALUE obj)
Destructively transforms the passed object so that multiple Ractors can share it.
void ruby_vm_at_exit(void(*func)(ruby_vm_t *))
ruby_vm_at_exit registers a function func to be invoked when a VM passed away.
int ruby_vm_destruct(ruby_vm_t *vm)
Destructs the passed VM.
VALUE rb_f_sprintf(int argc, const VALUE *argv)
Identical to rb_str_format(), except how the arguments are arranged.
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
#define RARRAY_LEN
Just another name of rb_array_len.
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
#define RARRAY_AREF(a, i)
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RBASIC(obj)
Convenient casting macro.
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
const char * rb_class2name(VALUE klass)
Queries the name of the passed class.
#define RB_NO_KEYWORDS
Do not pass keywords.
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
Internal header for Ruby Box.
This is the struct that holds necessary info for a struct.
const char * wrap_struct_name
Name of structs of this kind.
IFUNC (Internal FUNCtion)
const VALUE cref_or_me
class reference or rb_method_entry_t
void rb_native_cond_initialize(rb_nativethread_cond_t *cond)
Fills the passed condition variable with an initial value.
void rb_native_mutex_initialize(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_initialize.
void rb_native_mutex_destroy(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_destroy.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
ruby_value_type
C-level type of an object.