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/jit.h"
25#include "internal/missing.h"
26#include "internal/object.h"
27#include "internal/proc.h"
28#include "internal/ractor.h"
29#include "internal/re.h"
30#include "internal/ruby_parser.h"
31#include "internal/st.h"
32#include "internal/symbol.h"
33#include "internal/thread.h"
34#include "internal/transcode.h"
35#include "internal/vm.h"
36#include "internal/sanitizers.h"
37#include "internal/variable.h"
46#include "vm_callinfo.h"
50#include "vm_insnhelper.h"
51#include "ractor_core.h"
58#include "probes_helper.h"
60#if defined(_MSC_VER) && !defined(__clang__)
65#pragma optimize("t", on)
68static void *native_main_thread_stack_top;
70bool ruby_vm_during_cleanup =
false;
72VALUE rb_str_concat_literals(
size_t,
const VALUE*);
76extern const char *
const rb_debug_counter_names[];
78PUREFUNC(
static inline const VALUE *VM_EP_LEP(
const VALUE *));
79static inline const VALUE *
80VM_EP_LEP(
const VALUE *ep)
82 while (!VM_ENV_LOCAL_P(ep)) {
83 ep = VM_ENV_PREV_EP(ep);
101 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
110#define VM_BOX_CRASHED() {ruby_box_crashed = true;}
111#define VM_BOX_ASSERT(expr, msg) \
112 if (!(expr)) { ruby_box_crashed = true; rb_bug(msg); }
114#define VM_BOX_CRASHED() {}
115#define VM_BOX_ASSERT(expr, msg) ((void)0)
122 const VALUE *ep = current_cfp->ep;
164 while (VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_IFUNC) ||
165 VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_CFUNC)) {
166 bool from_ifunc = VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_IFUNC);
168 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
169 VM_BOX_ASSERT(RUBY_VM_VALID_CONTROL_FRAME_P(cfp, eocfp),
"Valid caller control frame expected");
170 if (!RUBY_VM_VALID_CONTROL_FRAME_P(cfp, eocfp)) {
174 VM_BOX_ASSERT(cfp->ep,
"Caller control frame should have a valid env");
180 if (from_ifunc && VM_ENV_FRAME_TYPE_P(ep, VM_FRAME_MAGIC_CFUNC)) {
185 while (!VM_ENV_LOCAL_P(ep)) {
186 ep = VM_ENV_PREV_EP(ep);
193rb_vm_ep_local_ep(
const VALUE *ep)
195 return VM_EP_LEP(ep);
199static inline const VALUE *
202 return VM_EP_LEP(cfp->ep);
205static inline const VALUE *
208 return VM_ENV_PREV_EP(cfp->ep);
216 if (VM_ENV_BOXED_P(cfp->ep)) {
217 VM_ASSERT(VM_ENV_LOCAL_P(cfp->ep));
221 return VM_BLOCK_HANDLER_NONE;
224 return VM_ENV_BLOCK_HANDLER(ep);
230 return VM_FRAME_CFRAME_KW_P(cfp);
236 return VM_CF_BLOCK_HANDLER(cfp);
243 const VALUE *start = ec->vm_stack;
244 const VALUE *end = (
VALUE *)ec->vm_stack + ec->vm_stack_size;
245 VM_ASSERT(start != NULL);
247 if (start <= (
VALUE *)cfp && (
VALUE *)cfp < end) {
258 const VALUE *start = ec->vm_stack;
260 VM_ASSERT(start != NULL);
262 if (start <= ep && ep < end) {
273 if (VM_EP_IN_HEAP_P(ec, ep)) {
274 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV];
276 if (!UNDEF_P(envval)) {
279 VM_ASSERT(imemo_type_p(envval, imemo_env));
280 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
281 VM_ASSERT(env->ep == ep);
291rb_vm_ep_in_heap_p(
const VALUE *ep)
294 if (ec == NULL || ec->vm_stack == NULL)
return TRUE;
295 return vm_ep_in_heap_p_(ec, ep);
302 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
310 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
319 return VM_TAGGED_PTR_REF(block_handler, 0x03) == captured;
325 VALUE block_handler = ec->passed_block_handler;
326 ec->passed_block_handler = VM_BLOCK_HANDLER_NONE;
327 vm_block_handler_verify(block_handler);
328 return block_handler;
332vm_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)
335 int omod_shared = FALSE;
339 scope_visi.method_visi = visi;
340 scope_visi.module_func = module_func;
343 if (prev_cref != NULL && prev_cref != (
void *)1 ) {
344 refinements = CREF_REFINEMENTS(prev_cref);
346 if (!
NIL_P(refinements)) {
348 CREF_OMOD_SHARED_SET(prev_cref);
352 VM_ASSERT(singleton || klass);
364 cref->klass_or_self = 0;
366 cref->next = use_prev_prev ? CREF_NEXT(prev_cref) : prev_cref;
369 if (pushed_by_eval) CREF_PUSHED_BY_EVAL_SET(cref);
370 if (omod_shared) CREF_OMOD_SHARED_SET(cref);
371 if (singleton) CREF_SINGLETON_SET(cref);
377vm_cref_new(
VALUE klass, rb_method_visibility_t visi,
int module_func,
rb_cref_t *prev_cref,
int pushed_by_eval,
int singleton)
379 return vm_cref_new0(klass, visi, module_func, prev_cref, pushed_by_eval, FALSE, singleton);
385 return SYMBOL_P(key) ? ST_DELETE : ST_CONTINUE;
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 VALUE ref = rb_hash_dup(CREF_REFINEMENTS(cref));
401 CREF_REFINEMENTS_SET(new_cref, ref);
402 CREF_OMOD_SHARED_UNSET(new_cref);
409rb_vm_cref_dup_without_refinements(
const rb_cref_t *cref)
412 rb_cref_t *next_cref = CREF_NEXT(cref), *new_cref;
413 int pushed_by_eval = CREF_PUSHED_BY_EVAL(cref);
414 int singleton = CREF_SINGLETON(cref);
416 new_cref = vm_cref_new(cref->klass_or_self, visi->method_visi, visi->module_func, next_cref, pushed_by_eval, singleton);
418 if (!
NIL_P(CREF_REFINEMENTS(cref))) {
419 CREF_REFINEMENTS_SET(new_cref,
Qnil);
420 CREF_OMOD_SHARED_UNSET(new_cref);
429 rb_cref_t *cref = vm_cref_new(
rb_cObject, METHOD_VISI_PRIVATE , FALSE, NULL, FALSE, FALSE);
430 VALUE top_wrapper = rb_ec_thread_ptr(ec)->top_wrapper;
433 cref = vm_cref_new(top_wrapper, METHOD_VISI_PRIVATE, FALSE, cref, FALSE, FALSE);
440rb_vm_cref_new_toplevel(
void)
442 return vm_cref_new_toplevel(GET_EC());
446vm_cref_dump(
const char *mesg,
const rb_cref_t *cref)
448 ruby_debug_printf(
"vm_cref_dump: %s (%p)\n", mesg, (
void *)cref);
452 ruby_debug_printf(
"= cref| klass: %.*s\n",
454 cref = CREF_NEXT(cref);
461 *((
const VALUE **)&dst->as.captured.ep) = ep;
469 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, env->iseq);
470 rb_vm_block_ep_update(bindval, &bind->block, env->ep);
473#if VM_COLLECT_USAGE_DETAILS
474static void vm_collect_usage_operand(
int insn,
int n,
VALUE op);
475static void vm_collect_usage_insn(
int insn);
476static void vm_collect_usage_register(
int reg,
int isset);
481 int argc,
const VALUE *argv,
int kw_splat,
VALUE block_handler,
487static unsigned int yjit_total_entry_hits = 0;
490#define YJIT_CALL_COUNT_INTERV 20u
494rb_yjit_threshold_hit(
const rb_iseq_t *iseq,
unsigned int entry_calls)
496 yjit_total_entry_hits += 1;
499 if (entry_calls + YJIT_CALL_COUNT_INTERV == rb_yjit_call_threshold) {
500 ISEQ_BODY(iseq)->yjit_calls_at_interv = yjit_total_entry_hits;
505 if (entry_calls == rb_yjit_call_threshold) {
507 if (rb_yjit_call_threshold < YJIT_CALL_COUNT_INTERV) {
511 unsigned int num_calls = yjit_total_entry_hits - ISEQ_BODY(iseq)->yjit_calls_at_interv;
514 if (num_calls > rb_yjit_cold_threshold) {
515 rb_yjit_incr_counter(
"cold_iseq_entry");
525#define rb_yjit_threshold_hit(iseq, entry_calls) false
537static inline rb_jit_func_t
540 const rb_iseq_t *iseq = CFP_ISEQ(ec->cfp);
546 if (body->jit_entry == NULL && rb_yjit_compiling_p) {
547 body->jit_entry_calls++;
548 if (rb_yjit_threshold_hit(iseq, body->jit_entry_calls)) {
549 rb_yjit_compile_iseq(iseq, ec,
false);
552 return body->jit_entry;
555# define yjit_compile(ec) ((rb_jit_func_t)0)
559static inline rb_jit_func_t
562 const rb_iseq_t *iseq = CFP_ISEQ(ec->cfp);
565 if (body->jit_entry == NULL && rb_zjit_compiling_p) {
566 body->jit_entry_calls++;
570 if (body->jit_entry_calls == rb_zjit_profile_threshold) {
571 rb_zjit_profile_enable(iseq);
575 if (body->jit_entry_calls == rb_zjit_call_threshold) {
576 rb_zjit_compile_iseq(iseq, ec,
false);
579 return body->jit_entry;
582# define zjit_compile(ec) ((rb_jit_func_t)0)
585#if USE_YJIT || USE_ZJIT
591 if (rb_yjit_enabled_p) {
592 rb_jit_func_t func = yjit_compile(ec);
594 return func(ec, ec->cfp);
601 void *zjit_entry = rb_zjit_entry;
603 rb_jit_func_t func = zjit_compile(ec);
605 VALUE result = ((rb_zjit_func_t)zjit_entry)(ec, ec->cfp, func);
619static inline rb_jit_func_t
622 const rb_iseq_t *iseq = CFP_ISEQ(ec->cfp);
628 if (body->jit_exception == NULL && rb_zjit_compiling_p) {
629 body->jit_exception_calls++;
633 if (body->jit_exception_calls == rb_zjit_profile_threshold) {
634 rb_zjit_profile_enable(iseq);
638 if (body->jit_exception_calls == rb_zjit_call_threshold) {
639 rb_zjit_compile_iseq(iseq, ec,
true);
647 if (body->jit_exception == NULL && rb_yjit_compiling_p) {
648 body->jit_exception_calls++;
649 if (body->jit_exception_calls == rb_yjit_call_threshold) {
650 rb_yjit_compile_iseq(iseq, ec,
true);
654 return body->jit_exception;
661 rb_jit_func_t func = jit_compile_exception(ec);
664 return func(ec, ec->cfp);
671# define jit_compile_exception(ec) ((rb_jit_func_t)0)
672# define jit_exec(ec) Qundef
673# define jit_exec_exception(ec) Qundef
678#define RB_TYPE_2_P(obj, type1, type2) \
679 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2))
680#define RB_TYPE_3_P(obj, type1, type2, type3) \
681 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2) || RB_TYPE_P(obj, type3))
683#define VM_ASSERT_TYPE(obj, type) \
684 VM_ASSERT(RB_TYPE_P(obj, type), #obj ": %s", rb_obj_info(obj))
685#define VM_ASSERT_TYPE2(obj, type1, type2) \
686 VM_ASSERT(RB_TYPE_2_P(obj, type1, type2), #obj ": %s", rb_obj_info(obj))
687#define VM_ASSERT_TYPE3(obj, type1, type2, type3) \
688 VM_ASSERT(RB_TYPE_3_P(obj, type1, type2, type3), #obj ": %s", rb_obj_info(obj))
692#include "vm_insnhelper.c"
696#include "vm_method.c"
703VALUE rb_mRubyVMFrozenCore;
704VALUE rb_block_param_proxy;
706VALUE ruby_vm_const_missing_count = 0;
707rb_vm_t *ruby_current_vm_ptr = NULL;
709bool ruby_vm_keep_script_lines;
711#ifdef RB_THREAD_LOCAL_SPECIFIER
715RB_THREAD_LOCAL_SPECIFIER
rb_atomic_t ruby_nt_serial;
720rb_current_ec_noinline(
void)
722 return ruby_current_ec;
728 ruby_current_ec = ec;
732#ifdef RB_THREAD_CURRENT_EC_NOINLINE
736 return ruby_current_ec;
741native_tls_key_t ruby_current_ec_key;
745rb_current_ec_noinline(
void)
747 return native_tls_get(ruby_current_ec_key);
754unsigned int ruby_vm_c_events_enabled = 0;
755unsigned int ruby_vm_iseq_events_enabled = 0;
757rb_serial_t ruby_vm_constant_cache_invalidations = 0;
758rb_serial_t ruby_vm_constant_cache_misses = 0;
759rb_serial_t ruby_vm_global_cvar_state = 1;
762 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
765 .call_ = vm_call_general,
771static const struct rb_callcache vm_empty_cc_for_super = {
772 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
775 .call_ = vm_call_super_method,
781static void thread_free(
void *ptr);
784rb_vm_inc_const_missing_count(
void)
786 ruby_vm_const_missing_count +=1;
795 if (!ec) ec = GET_EC();
796 if (!rb_ec_frame_method_id_and_class(ec, &
id, 0, &klass) || !klass)
800 klass =
RBASIC(klass)->klass;
802 else if (RCLASS_SINGLETON_P(klass)) {
803 klass = RCLASS_ATTACHED_OBJECT(klass);
804 if (
NIL_P(klass))
return FALSE;
809 const char *classname, *filename;
810 const char *methodname = rb_id2name(
id);
811 if (methodname && (filename = rb_source_location_cstr(&args->line_no)) != 0) {
813 classname =
"<unknown>";
814 args->classname = classname;
815 args->methodname = methodname;
816 args->filename = filename;
825extern unsigned int redblack_buffer_size;
853 static VALUE sym_constant_cache_invalidations, sym_constant_cache_misses, sym_global_cvar_state, sym_next_shape_id;
854 static VALUE sym_shape_cache_size;
868 hash = rb_hash_new();
871#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
872 S(constant_cache_invalidations);
873 S(constant_cache_misses);
874 S(global_cvar_state);
879#define SET(name, attr) \
880 if (key == sym_##name) \
881 return SERIALT2NUM(attr); \
882 else if (hash != Qnil) \
883 rb_hash_aset(hash, sym_##name, SERIALT2NUM(attr));
885 SET(constant_cache_invalidations, ruby_vm_constant_cache_invalidations);
886 SET(constant_cache_misses, ruby_vm_constant_cache_misses);
887 SET(global_cvar_state, ruby_vm_global_cvar_state);
888 SET(next_shape_id, (rb_serial_t)rb_shapes_count());
889 SET(shape_cache_size, (rb_serial_t)rb_shapes_cache_size());
893 ruby_debug_counter_show_at_exit(FALSE);
894 for (
size_t i = 0; i < RB_DEBUG_COUNTER_MAX; i++) {
895 const VALUE name = rb_sym_intern_ascii_cstr(rb_debug_counter_names[i]);
901 else if (hash !=
Qnil) {
902 rb_hash_aset(hash, name, boxed_value);
908 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(key));
919 if (ISEQ_BODY(iseq)->
type != ISEQ_TYPE_TOP) {
920 rb_raise(
rb_eTypeError,
"Not a toplevel InstructionSequence");
924 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
925 rb_ec_thread_ptr(ec)->top_self,
927 (
VALUE)vm_cref_new_toplevel(ec),
928 ISEQ_BODY(iseq)->iseq_encoded, ec->cfp->sp,
929 ISEQ_BODY(iseq)->local_table_size, ISEQ_BODY(iseq)->stack_max);
935 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_EVAL | VM_FRAME_FLAG_FINISH,
936 vm_block_self(base_block), VM_GUARDED_PREV_EP(vm_block_ep(base_block)),
938 ISEQ_BODY(iseq)->iseq_encoded,
939 ec->cfp->sp, ISEQ_BODY(iseq)->local_table_size,
940 ISEQ_BODY(iseq)->stack_max);
949 GetBindingPtr(toplevel_binding, bind);
952 vm_set_eval_stack(ec, iseq, 0, &bind->block);
955 if (ISEQ_BODY(iseq)->local_table_size > 0) {
956 vm_bind_update_env(toplevel_binding, bind, vm_make_env_object(ec, ec->cfp));
963 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
967 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
975 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
976 if (VM_FRAME_RUBYFRAME_P(cfp)) {
979 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
987 if (VM_FRAME_RUBYFRAME_P(cfp)) {
991 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
993 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
994 if (VM_FRAME_RUBYFRAME_P(cfp)) {
998 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_PASSED) == FALSE) {
1001 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1007rb_vm_pop_cfunc_frame(
void)
1014 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec, me->owner, me->def->original_id);
1015 vm_pop_frame(ec, cfp, cfp->ep);
1022 while (ec->cfp != cfp) {
1024 printf(
"skipped frame: %s\n", vm_frametype_name(ec->cfp));
1026 if (VM_FRAME_TYPE(ec->cfp) != VM_FRAME_MAGIC_CFUNC) {
1027 rb_vm_pop_frame(ec);
1030 rb_vm_pop_cfunc_frame();
1043 nl->next = vm->at_exit;
1048ruby_vm_run_at_exit_hooks(
rb_vm_t *vm)
1054 rb_vm_at_exit_func *func = l->func;
1068 fputs(
"---\n", stderr);
1069 ruby_debug_printf(
"envptr: %p\n", (
void *)&env->ep[0]);
1070 ruby_debug_printf(
"envval: %10p ", (
void *)env->ep[1]);
1072 ruby_debug_printf(
"ep: %10p\n", (
void *)env->ep);
1073 if (rb_vm_env_prev_env(env)) {
1074 fputs(
">>\n", stderr);
1075 check_env_value(rb_vm_env_prev_env(env));
1076 fputs(
"<<\n", stderr);
1082check_env_value(
const rb_env_t *env)
1084 if (check_env(env)) {
1087 rb_bug(
"invalid env");
1094 switch (vm_block_handler_type(block_handler)) {
1095 case block_handler_type_ifunc:
1096 case block_handler_type_iseq:
1097 return rb_vm_make_proc(ec, VM_BH_TO_CAPT_BLOCK(block_handler),
rb_cProc);
1099 case block_handler_type_symbol:
1100 case block_handler_type_proc:
1101 return block_handler;
1103 VM_UNREACHABLE(vm_block_handler_escape);
1110 const VALUE *
const ep = cfp->ep;
1111 VALUE *env_body, *env_ep;
1112 int local_size, env_size;
1114 if (VM_ENV_ESCAPED_P(ep)) {
1115 return VM_ENV_ENVVAL(ep);
1118 if (!VM_ENV_LOCAL_P(ep)) {
1119 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1120 if (!VM_ENV_ESCAPED_P(prev_ep)) {
1123 while (prev_cfp->ep != prev_ep) {
1124 prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(prev_cfp);
1125 VM_ASSERT(prev_cfp->ep != NULL);
1128 vm_make_env_each(ec, prev_cfp);
1129 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_SPECVAL], VM_GUARDED_PREV_EP(prev_cfp->ep));
1133 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1134 VALUE block_handler = VM_ENV_BLOCK_HANDLER(ep);
1136 if (block_handler != VM_BLOCK_HANDLER_NONE) {
1137 VALUE blockprocval = vm_block_handler_escape(ec, block_handler);
1138 VM_STACK_ENV_WRITE(ep, VM_ENV_DATA_INDEX_SPECVAL, blockprocval);
1143 if (!VM_FRAME_RUBYFRAME_P(cfp)) {
1144 local_size = VM_ENV_DATA_SIZE;
1147 local_size = ISEQ_BODY(iseq)->local_table_size;
1148 if (ISEQ_BODY(iseq)->param.flags.forwardable && VM_ENV_LOCAL_P(cfp->ep)) {
1149 int ci_offset = local_size - ISEQ_BODY(iseq)->param.size + VM_ENV_DATA_SIZE;
1152 local_size += vm_ci_argc(ci);
1154 local_size += VM_ENV_DATA_SIZE;
1162 if (VM_FRAME_RUBYFRAME_P(cfp) &&
1163 !rbimpl_atomic_load(&ISEQ_BODY(iseq)->jit_ep_escape_recorded, RBIMPL_ATOMIC_RELAXED)) {
1164 if (rb_yjit_enabled_p) rb_yjit_invalidate_ep_is_bp(iseq);
1165 if (rb_zjit_enabled_p) rb_zjit_invalidate_no_ep_escape(iseq);
1180 env_size = local_size +
1188 MEMCPY(env_body, ep - (local_size - 1 ),
VALUE, local_size);
1190 env_ep = &env_body[local_size - 1 ];
1191 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1193 env->iseq = (
rb_iseq_t *)(VM_FRAME_RUBYFRAME_P(cfp) ? iseq : NULL);
1195 env->env = env_body;
1196 env->env_size = env_size;
1199 VM_ENV_FLAGS_SET(env_ep, VM_ENV_FLAG_ESCAPED | VM_ENV_FLAG_WB_REQUIRED);
1200 VM_STACK_ENV_WRITE(ep, 0, (
VALUE)env);
1203 for (i = 0; i < local_size; i++) {
1204 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1206 ep[-local_size + i] = 0;
1217 VALUE envval = vm_make_env_each(ec, cfp);
1220 check_env_value((
const rb_env_t *)envval);
1230 while ((cfp = rb_vm_get_binding_creatable_next_cfp(ec, cfp)) != 0) {
1231 vm_make_env_object(ec, cfp);
1232 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1237rb_vm_env_prev_env(
const rb_env_t *env)
1239 const VALUE *ep = env->ep;
1241 if (VM_ENV_LOCAL_P(ep)) {
1245 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1246 return VM_ENV_ENVVAL_PTR(prev_ep);
1254 if (!iseq)
return 0;
1255 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1256 local_var_list_add(vars, ISEQ_BODY(iseq)->local_table[i]);
1265 if (VM_ENV_FLAGS(env->ep, VM_ENV_FLAG_ISOLATED))
break;
1266 collect_local_variables_in_iseq(env->iseq, vars);
1267 }
while ((env = rb_vm_env_prev_env(env)) != NULL);
1273 if (VM_ENV_ESCAPED_P(ep)) {
1274 collect_local_variables_in_env(VM_ENV_ENVVAL_PTR(ep), vars);
1283rb_vm_env_local_variables(
const rb_env_t *env)
1286 local_var_list_init(&vars);
1287 collect_local_variables_in_env(env, &vars);
1288 return local_var_list_finish(&vars);
1292rb_vm_env_numbered_parameters(
const rb_env_t *env)
1295 local_var_list_init(&vars);
1299 if (!iseq)
return 0;
1300 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1301 numparam_list_add(&vars, ISEQ_BODY(iseq)->local_table[i]);
1303 return local_var_list_finish(&vars);
1307rb_iseq_local_variables(
const rb_iseq_t *iseq)
1310 local_var_list_init(&vars);
1311 while (collect_local_variables_in_iseq(iseq, &vars)) {
1312 iseq = ISEQ_BODY(iseq)->parent_iseq;
1314 return local_var_list_finish(&vars);
1320vm_proc_create_from_captured(
VALUE klass,
1322 enum rb_block_type block_type,
1323 int8_t is_from_method, int8_t is_lambda)
1325 VALUE procval = rb_proc_alloc(klass, block_type);
1328 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), captured->ep));
1331 RB_OBJ_WRITE(procval, &proc->block.as.captured.code.val, captured->code.val);
1332 RB_OBJ_WRITE(procval, &proc->block.as.captured.self, captured->self);
1333 rb_vm_block_ep_update(procval, &proc->block, captured->ep);
1335 vm_block_type_set(&proc->block, block_type);
1336 proc->header.is_from_method = is_from_method;
1337 proc->header.is_lambda = is_lambda;
1346 switch (vm_block_type(src)) {
1347 case block_type_iseq:
1348 case block_type_ifunc:
1349 RB_OBJ_WRITE(obj, &dst->as.captured.self, src->as.captured.self);
1350 RB_OBJ_WRITE(obj, &dst->as.captured.code.val, src->as.captured.code.val);
1351 rb_vm_block_ep_update(obj, dst, src->as.captured.ep);
1353 case block_type_symbol:
1356 case block_type_proc:
1363proc_create(
VALUE klass,
const struct rb_block *block, int8_t is_from_method, int8_t is_lambda)
1365 VALUE procval = rb_proc_alloc(klass, block->type);
1368 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), vm_block_ep(block)));
1369 rb_vm_block_copy(procval, &proc->block, block);
1370 vm_block_type_set(&proc->block, block->type);
1371 proc->header.is_from_method = is_from_method;
1372 proc->header.is_lambda = is_lambda;
1378rb_proc_dup_0(
VALUE self)
1383 GetProcPtr(self, src);
1385 switch (vm_block_type(&src->block)) {
1386 case block_type_ifunc:
1387 procval = rb_func_proc_dup(self);
1390 procval = proc_create(
rb_obj_class(self), &src->block, src->header.is_from_method, src->header.is_lambda);
1394 if (src->header.is_refined) {
1396 GetProcPtr(procval, dst);
1397 dst->header.is_refined = 1;
1406rb_proc_dup(
VALUE self)
1408 VALUE procval = rb_proc_dup_0(self);
1409 VALUE recipe = rb_proc_refinements_recipe(self);
1410 if (!
NIL_P(recipe)) rb_proc_set_refinements_recipe(procval, recipe);
1421 GetProcPtr(self, src);
1422 VM_ASSERT(vm_block_type(&src->block) == block_type_iseq);
1424 struct rb_block block = src->block;
1425 block.as.captured.code.iseq = iseq;
1427 VALUE procval = proc_create(
rb_obj_class(self), &block, src->header.is_from_method, src->header.is_lambda);
1428 rb_proc_set_refinements_recipe(procval, recipe);
1444 if (SIZEOF_VOIDP > SIZEOF_LONG)
1453 if (SIZEOF_VOIDP > SIZEOF_LONG)
1459static enum rb_id_table_iterator_result
1460collect_outer_variable_names(
ID id,
VALUE val,
void *ptr)
1464 if (
id == rb_intern(
"yield")) {
1469 if (data->isolate ||
1474 store = &data->read_only;
1479 return ID_TABLE_CONTINUE;
1483env_copy(
const VALUE *src_ep,
VALUE read_only_variables)
1486 VM_ASSERT(src_env->ep == src_ep);
1489 VALUE *ep = &env_body[src_env->env_size - 2];
1490 const rb_env_t *copied_env = vm_env_new(ep, env_body, src_env->env_size, src_env->iseq);
1493 VALUE svar_val = src_ep[VM_ENV_DATA_INDEX_ME_CREF];
1494 if (imemo_type_p(svar_val, imemo_svar)) {
1504 RB_OBJ_WRITE(copied_env, &ep[VM_ENV_DATA_INDEX_ME_CREF], svar_val);
1506 ep[VM_ENV_DATA_INDEX_FLAGS] = src_ep[VM_ENV_DATA_INDEX_FLAGS] | VM_ENV_FLAG_ISOLATED;
1507 if (!VM_ENV_LOCAL_P(src_ep)) {
1508 VM_ENV_FLAGS_SET(ep, VM_ENV_FLAG_LOCAL);
1511 if (read_only_variables) {
1512 for (
int i=
RARRAY_LENINT(read_only_variables)-1; i>=0; i--) {
1516 for (
unsigned int j=0; j<body->local_table_size; j++) {
1517 if (
id == body->local_table[j]) {
1519 if (iseq_lvar_state_get(iseq_lvar_states(body), j) == lvar_reassigned) {
1520 VALUE name = rb_id2str(
id);
1521 VALUE msg = rb_sprintf(
"cannot make a shareable Proc because "
1522 "the outer variable '%" PRIsVALUE
"' may be reassigned.", name);
1527 VALUE v = src_env->env[j];
1529 VALUE name = rb_id2str(
id);
1530 VALUE msg = rb_sprintf(
"cannot make a shareable Proc because it can refer"
1531 " unshareable object %+" PRIsVALUE
" from ", v);
1533 rb_str_catf(msg,
"variable '%" PRIsVALUE
"'", name);
1546 if (!VM_ENV_LOCAL_P(src_ep)) {
1547 const VALUE *prev_ep = VM_ENV_PREV_EP(src_env->ep);
1548 const rb_env_t *new_prev_env = env_copy(prev_ep, read_only_variables);
1549 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_GUARDED_PREV_EP(new_prev_env->ep);
1551 VM_ENV_FLAGS_UNSET(ep, VM_ENV_FLAG_LOCAL);
1553 else if (VM_ENV_BOXED_P(src_ep)) {
1558 ep[VM_ENV_DATA_INDEX_SPECVAL] = src_ep[VM_ENV_DATA_INDEX_SPECVAL];
1561 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_BLOCK_HANDLER_NONE;
1572 const rb_env_t *env = env_copy(captured->ep, read_only_variables);
1573 *((
const VALUE **)&proc->block.as.captured.ep) = env->ep;
1578proc_has_ivar_i(
ID name,
VALUE val, st_data_t arg)
1581 *(
bool *)arg =
true;
1588proc_shared_outer_variables(
struct rb_id_table *outer_variables,
bool isolate,
const char *message)
1596 rb_id_table_foreach(outer_variables, collect_outer_variable_names, (
void *)&data);
1598 if (data.ary !=
Qfalse) {
1599 VALUE str = rb_sprintf(
"can not %s because it accesses outer variables", message);
1600 VALUE ary = data.ary;
1601 const char *sep =
" (";
1604 if (!name)
continue;
1613 else if (data.yield) {
1614 rb_raise(rb_eRactorIsolationError,
"can not %s because it uses 'yield'.", message);
1617 return data.read_only;
1621rb_proc_isolate_bang(
VALUE self,
VALUE replace_self)
1623 const rb_iseq_t *iseq = vm_proc_iseq(self);
1628 if (proc->block.type != block_type_iseq) rb_raise(
rb_eRuntimeError,
"not supported yet");
1630 if (!UNDEF_P(replace_self)) {
1632 RB_OBJ_WRITE(self, &proc->block.as.captured.self, replace_self);
1635 if (ISEQ_BODY(iseq)->outer_variables) {
1636 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables,
true,
"isolate a Proc");
1639 proc_isolate_env(self, proc,
Qfalse);
1640 proc->header.is_isolated = TRUE;
1645 if (UNLIKELY(rb_obj_shape_has_ivars(self))) {
1646 bool has_ivar =
false;
1650 rb_raise(rb_eRactorIsolationError,
"can not isolate a Proc because it has instance variables");
1659rb_proc_isolate(
VALUE self)
1661 VALUE dst = rb_proc_dup(self);
1662 rb_proc_isolate_bang(dst,
Qundef);
1667rb_proc_ractor_make_shareable(
VALUE self,
VALUE replace_self)
1669 const rb_iseq_t *iseq = vm_proc_iseq(self);
1674 if (proc->block.type != block_type_iseq) rb_raise(
rb_eRuntimeError,
"not supported yet");
1676 if (!UNDEF_P(replace_self)) {
1677 RB_OBJ_WRITE(self, &proc->block.as.captured.self, replace_self);
1681 rb_raise(rb_eRactorIsolationError,
1682 "Proc's self is not shareable: %" PRIsVALUE,
1688 if (ISEQ_BODY(iseq)->outer_variables) {
1689 read_only_variables =
1690 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables,
false,
"make a Proc shareable");
1693 proc_isolate_env(self, proc, read_only_variables);
1694 proc->header.is_isolated = TRUE;
1697 const struct rb_block *block = vm_proc_block(self);
1698 if (block->type != block_type_symbol) rb_raise(
rb_eRuntimeError,
"not supported yet");
1700 VALUE proc_self = vm_block_self(block);
1702 rb_raise(rb_eRactorIsolationError,
1703 "Proc's self is not shareable: %" PRIsVALUE,
1716 enum imemo_type code_type = imemo_type(captured->code.val);
1718 if (!VM_ENV_ESCAPED_P(captured->ep)) {
1720 vm_make_env_object(ec, cfp);
1723 VM_ASSERT(VM_EP_IN_HEAP_P(ec, captured->ep));
1724 VM_ASSERT(code_type == imemo_iseq || code_type == imemo_ifunc);
1726 procval = vm_proc_create_from_captured(klass, captured,
1727 code_type == imemo_iseq ? block_type_iseq : block_type_ifunc,
1730 if (code_type == imemo_ifunc) {
1732 if (ifunc->svar_lep) {
1733 VALUE ep0 = ifunc->svar_lep[0];
1737 ifunc->svar_lep = (
VALUE *)env->ep;
1741 if (ep0 & VM_ENV_FLAG_ESCAPED) {
1745 ifunc->svar_lep = NULL;
1761 VALUE bindval, envval;
1764 if (cfp == 0 || ruby_level_cfp == 0) {
1765 rb_raise(
rb_eRuntimeError,
"Can't create Binding Object on top of Fiber.");
1767 if (!VM_FRAME_RUBYFRAME_P(src_cfp) &&
1768 !VM_FRAME_RUBYFRAME_P(RUBY_VM_PREVIOUS_CONTROL_FRAME(src_cfp))) {
1769 rb_raise(
rb_eRuntimeError,
"Cannot create Binding object for non-Ruby caller");
1772 envval = vm_make_env_object(ec, cfp);
1774 GetBindingPtr(bindval, bind);
1775 vm_bind_update_env(bindval, bind, envval);
1776 RB_OBJ_WRITE(bindval, &bind->block.as.captured.self, cfp->self);
1777 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, CFP_ISEQ(cfp));
1778 RB_OBJ_WRITE(bindval, &bind->pathobj, ISEQ_BODY(CFP_ISEQ(ruby_level_cfp))->location.pathobj);
1779 bind->first_lineno = rb_vm_get_sourceline(ruby_level_cfp);
1785rb_binding_add_dynavars(
VALUE bindval,
rb_binding_t *bind,
int dyncount,
const ID *dynvars)
1787 VALUE envval, pathobj = bind->pathobj;
1788 VALUE path = pathobj_path(pathobj);
1789 VALUE realpath = pathobj_realpath(pathobj);
1796 if (dyncount < 0)
return 0;
1798 base_block = &bind->block;
1799 base_iseq = vm_block_iseq(base_block);
1803 dyns->size = dyncount;
1804 MEMCPY(dyns->ids, dynvars,
ID, dyncount);
1806 rb_node_init(RNODE(&tmp_node), NODE_SCOPE);
1807 tmp_node.nd_tbl = dyns;
1808 tmp_node.nd_body = 0;
1809 tmp_node.nd_parent = NULL;
1810 tmp_node.nd_args = 0;
1812 VALUE ast_value = rb_ruby_ast_new(RNODE(&tmp_node));
1815 iseq = rb_iseq_new(ast_value, ISEQ_BODY(base_iseq)->location.label, path, realpath, base_iseq, ISEQ_TYPE_EVAL);
1818 VALUE tempstr = rb_fstring_lit(
"<temp>");
1819 iseq = rb_iseq_new_top(ast_value, tempstr, tempstr, tempstr, NULL);
1821 tmp_node.nd_tbl = 0;
1824 vm_set_eval_stack(ec, iseq, 0, base_block);
1825 vm_bind_update_env(bindval, bind, envval = vm_make_env_object(ec, ec->cfp));
1826 rb_vm_pop_frame(ec);
1837 int arg_size = ISEQ_BODY(iseq)->param.size;
1839 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_FINISH, self,
1840 VM_GUARDED_PREV_EP(captured->ep),
1842 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1843 ec->cfp->sp + arg_size,
1844 ISEQ_BODY(iseq)->local_table_size - arg_size,
1845 ISEQ_BODY(iseq)->stack_max);
1852 int arg_size = ISEQ_BODY(iseq)->param.size;
1854 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
1856 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_BMETHOD, self,
1857 VM_GUARDED_PREV_EP(captured->ep),
1859 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1860 ec->cfp->sp + 1 + arg_size,
1861 ISEQ_BODY(iseq)->local_table_size - arg_size,
1862 ISEQ_BODY(iseq)->stack_max);
1864 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_FINISH);
1867ALWAYS_INLINE(
static VALUE
1869 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1874 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1877 const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq);
1879 VALUE type = VM_FRAME_MAGIC_BLOCK | (is_lambda ? VM_FRAME_FLAG_LAMBDA : 0);
1881 VALUE *sp = cfp->sp;
1882 int flags = (kw_splat ? VM_CALL_KW_SPLAT : 0);
1888 if (UNLIKELY(argc > VM_ARGC_STACK_MAX) &&
1889 (VM_ARGC_STACK_MAX >= 1 ||
1891 (argc != 1 || is_lambda))) {
1892 use_argv = vm_argv_ruby_array(av, argv, &flags, &argc, kw_splat);
1895 CHECK_VM_STACK_OVERFLOW(cfp, argc + 1);
1896 vm_check_canary(ec, sp);
1898 VALUE *stack_argv = sp;
1903 cfp->sp = stack_argv + argc;
1906 opt_pc = vm_yield_setup_args(ec, iseq, argc, stack_argv, flags, passed_block_handler,
1907 (is_lambda ? arg_setup_method : arg_setup_block));
1911 invoke_block(ec, iseq, self, captured, cref,
type, opt_pc);
1914 invoke_bmethod(ec, iseq, self, captured, me,
type, opt_pc);
1922 int argc,
const VALUE *argv,
1924 int is_lambda,
int force_blockarg)
1927 switch (vm_block_handler_type(block_handler)) {
1928 case block_handler_type_iseq:
1931 return invoke_iseq_block_from_c(ec, captured, captured->self,
1932 argc, argv, kw_splat, passed_block_handler,
1933 cref, is_lambda, NULL);
1935 case block_handler_type_ifunc:
1936 return vm_yield_with_cfunc(ec, VM_BH_TO_IFUNC_BLOCK(block_handler),
1937 VM_BH_TO_IFUNC_BLOCK(block_handler)->self,
1938 argc, argv, kw_splat, passed_block_handler, NULL);
1939 case block_handler_type_symbol:
1940 return vm_yield_with_symbol(ec, VM_BH_TO_SYMBOL(block_handler),
1941 argc, argv, kw_splat, passed_block_handler);
1942 case block_handler_type_proc:
1944 VALUE procval = VM_BH_TO_PROC(block_handler);
1946 GetProcPtr(procval, po);
1947 if (po->header.is_refined) cref = rb_proc_refinements_cref_for_call(procval);
1948 if (force_blockarg == FALSE) {
1949 is_lambda = po->header.is_lambda;
1951 block_handler = vm_block_to_block_handler(&po->block);
1955 VM_UNREACHABLE(invoke_block_from_c_splattable);
1962 VALUE block_handler = VM_CF_BLOCK_HANDLER(ec->cfp);
1963 vm_block_handler_verify(block_handler);
1964 if (UNLIKELY(block_handler == VM_BLOCK_HANDLER_NONE)) {
1965 rb_vm_localjump_error(
"no block given",
Qnil, 0);
1968 return block_handler;
1974 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1975 argc, argv, kw_splat, VM_BLOCK_HANDLER_NONE,
1976 cref, is_lambda, FALSE);
1982 return vm_yield_with_cref(ec, argc, argv, kw_splat, NULL, FALSE);
1988 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1989 argc, argv, kw_splat, block_handler,
1990 NULL, FALSE, FALSE);
1996 return invoke_block_from_c_bh(ec, check_block_handler(ec), 1, &args,
2000ALWAYS_INLINE(
static VALUE
2003 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
2010 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
2014 const struct rb_block *block = &proc->block;
2017 switch (vm_block_type(block)) {
2018 case block_type_iseq:
2019 return invoke_iseq_block_from_c(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, cref, is_lambda, me);
2020 case block_type_ifunc:
2021 if (kw_splat == 1) {
2022 VALUE keyword_hash = argv[argc-1];
2024 keyword_hash = rb_to_hash_type(keyword_hash);
2030 ((
VALUE *)argv)[argc-1] = rb_hash_dup(keyword_hash);
2033 return vm_yield_with_cfunc(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, me);
2034 case block_type_symbol:
2035 return vm_yield_with_symbol(ec, block->as.symbol, argc, argv, kw_splat, passed_block_handler);
2036 case block_type_proc:
2037 is_lambda = block_proc_is_lambda(block->as.proc);
2038 block = vm_proc_block(block->as.proc);
2041 VM_UNREACHABLE(invoke_block_from_c_proc);
2047 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
2050 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, proc->header.is_lambda, cref, NULL);
2058 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, block_handler, TRUE, NULL, me);
2063 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
2066 VALUE self = vm_block_self(&proc->block);
2067 vm_block_handler_verify(passed_block_handler);
2069 if (proc->header.is_from_method) {
2070 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
2073 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, cref);
2079 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
2082 vm_block_handler_verify(passed_block_handler);
2084 if (proc->header.is_from_method) {
2085 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
2088 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, cref);
2097 while (!CFP_PC(cfp) || !CFP_ISEQ(cfp)) {
2098 if (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_IFUNC) {
2100 return ifunc->svar_lep;
2103 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2106 if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
2111 return (
VALUE *)VM_CF_LEP(cfp);
2117 return lep_svar_get(ec, rb_vm_svar_lep(ec, cfp), key);
2123 lep_svar_set(ec, rb_vm_svar_lep(ec, cfp), key, val);
2129 return vm_cfp_svar_get(ec, ec->cfp, key);
2135 vm_cfp_svar_set(ec, ec->cfp, key, val);
2141 return vm_svar_get(GET_EC(), VM_SVAR_BACKREF);
2147 vm_svar_set(GET_EC(), VM_SVAR_BACKREF, val);
2153 return vm_svar_get(GET_EC(), VM_SVAR_LASTLINE);
2159 vm_svar_set(GET_EC(), VM_SVAR_LASTLINE, val);
2163rb_lastline_set_up(
VALUE val,
unsigned int up)
2167 for(
unsigned int i = 0; i < up; i++) {
2168 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2170 vm_cfp_svar_set(GET_EC(), cfp, VM_SVAR_LASTLINE, val);
2182 return RSTRING_PTR(rb_iseq_path(CFP_ISEQ(cfp)));
2196 return rb_vm_get_sourceline(cfp);
2204rb_source_location(
int *pline)
2209 if (cfp && VM_FRAME_RUBYFRAME_P(cfp)) {
2210 if (pline) *pline = rb_vm_get_sourceline(cfp);
2211 return rb_iseq_path(CFP_ISEQ(cfp));
2214 if (pline) *pline = 0;
2220rb_source_location_cstr(
int *pline)
2222 VALUE path = rb_source_location(pline);
2223 if (
NIL_P(path))
return NULL;
2224 return RSTRING_PTR(path);
2231 return vm_ec_cref(ec);
2235rb_vm_cref_replace_with_duplicated_cref(
void)
2239 rb_cref_t *cref = vm_cref_replace_with_duplicated_cref(cfp->ep);
2245rb_vm_cref_in_context(
VALUE self,
VALUE cbase)
2250 if (!cfp || cfp->self != self)
return NULL;
2251 if (!vm_env_cref_by_cref(cfp->ep))
return NULL;
2252 cref = vm_get_cref(cfp->ep);
2253 if (CREF_CLASS(cref) != cbase)
return NULL;
2262 dp(CREF_CLASS(cref));
2263 printf(
"%ld\n", CREF_VISI(cref));
2264 cref = CREF_NEXT(cref);
2278 return vm_get_cbase(cfp->ep);
2284make_localjump_error(
const char *mesg,
VALUE value,
int reason)
2316rb_vm_localjump_error(
const char *mesg,
VALUE value,
int reason)
2318 VALUE exc = make_localjump_error(mesg, value, reason);
2323rb_vm_make_jump_tag_but_local_jump(
enum ruby_tag_type state,
VALUE val)
2329 mesg =
"unexpected return";
2332 mesg =
"unexpected break";
2335 mesg =
"unexpected next";
2338 mesg =
"unexpected redo";
2342 mesg =
"retry outside of rescue clause";
2349 val = GET_EC()->tag->retval;
2351 return make_localjump_error(mesg, val, state);
2355rb_vm_jump_tag_but_local_jump(
enum ruby_tag_type state)
2357 VALUE exc = rb_vm_make_jump_tag_but_local_jump(state,
Qundef);
2359 EC_JUMP_TAG(GET_EC(), state);
2365 while (VM_ENV_LOCAL_P(cfp->ep)) {
2366 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2377 const VALUE *ep = VM_CF_PREV_EP(cfp);
2381 rb_vm_localjump_error(
"unexpected break", val, TAG_BREAK);
2384 ec->errinfo = (
VALUE)THROW_DATA_NEW(val, target_cfp, TAG_BREAK);
2385 EC_JUMP_TAG(ec, TAG_BREAK);
2391 vm_iter_break(GET_EC(),
Qnil);
2397 vm_iter_break(GET_EC(), val);
2402short ruby_vm_redefined_flag[BOP_LAST_];
2403static st_table *vm_opt_method_def_table = 0;
2404static st_table *vm_opt_mid_table = 0;
2407rb_free_vm_opt_tables(
void)
2409 st_free_table(vm_opt_method_def_table);
2410 st_free_table(vm_opt_mid_table);
2414vm_redefinition_check_flag(
VALUE klass)
2416 if (klass ==
rb_cInteger)
return INTEGER_REDEFINED_OP_FLAG;
2417 if (klass ==
rb_cFloat)
return FLOAT_REDEFINED_OP_FLAG;
2418 if (klass ==
rb_cString)
return STRING_REDEFINED_OP_FLAG;
2419 if (klass ==
rb_cArray)
return ARRAY_REDEFINED_OP_FLAG;
2420 if (klass ==
rb_cHash)
return HASH_REDEFINED_OP_FLAG;
2421 if (klass ==
rb_cSymbol)
return SYMBOL_REDEFINED_OP_FLAG;
2423 if (klass ==
rb_cTime)
return TIME_REDEFINED_OP_FLAG;
2425 if (klass ==
rb_cRegexp)
return REGEXP_REDEFINED_OP_FLAG;
2426 if (klass ==
rb_cNilClass)
return NIL_REDEFINED_OP_FLAG;
2429 if (klass ==
rb_cProc)
return PROC_REDEFINED_OP_FLAG;
2434rb_vm_check_optimizable_mid(
VALUE mid)
2436 if (!vm_opt_mid_table) {
2440 return st_lookup(vm_opt_mid_table, mid, NULL);
2446 if (me->called_id != me->def->original_id) {
2450 if (METHOD_ENTRY_BASIC(me))
return TRUE;
2453 switch (def->type) {
2454 case VM_METHOD_TYPE_CFUNC:
2455 case VM_METHOD_TYPE_OPTIMIZED:
2470 if (vm_redefinition_check_method_type(me)) {
2471 if (st_lookup(vm_opt_method_def_table, (st_data_t)me->def, &bop)) {
2472 int flag = vm_redefinition_check_flag(klass);
2476 "Redefining '%s#%s' disables interpreter and JIT optimizations",
2478 rb_id2name(me->called_id)
2480 rb_yjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2481 rb_zjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2482 ruby_vm_redefined_flag[bop] |= flag;
2488static enum rb_id_table_iterator_result
2489check_redefined_method(
ID mid,
VALUE value,
void *data)
2495 if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner);
2497 return ID_TABLE_CONTINUE;
2501rb_vm_check_redefinition_by_prepend(
VALUE klass)
2503 if (!vm_redefinition_check_flag(klass))
return;
2504 rb_id_table_foreach(RCLASS_M_TBL(RCLASS_ORIGIN(klass)), check_redefined_method, (
void *)klass);
2508add_opt_method_entry_bop(
const rb_method_entry_t *me,
ID mid,
enum ruby_basic_operators bop)
2510 st_insert(vm_opt_method_def_table, (st_data_t)me->def, (st_data_t)bop);
2511 st_insert(vm_opt_mid_table, (st_data_t)mid, (st_data_t)
Qtrue);
2515add_opt_method(
VALUE klass,
ID mid,
enum ruby_basic_operators bop)
2519 if (me && vm_redefinition_check_method_type(me)) {
2520 add_opt_method_entry_bop(me, mid, bop);
2523 rb_bug(
"undefined optimized method: %s", rb_id2name(mid));
2527static enum ruby_basic_operators vm_redefinition_bop_for_id(
ID mid);
2532 if (me && vm_redefinition_check_method_type(me)) {
2533 ID mid = me->called_id;
2534 enum ruby_basic_operators bop = vm_redefinition_bop_for_id(mid);
2535 if ((
int)bop >= 0) {
2536 add_opt_method_entry_bop(me, mid, bop);
2542vm_init_redefined_flag(
void)
2545 enum ruby_basic_operators bop;
2547#define OP(mid_, bop_) (mid = id##mid_, bop = BOP_##bop_, ruby_vm_redefined_flag[bop] = 0)
2548#define C(k) add_opt_method(rb_c##k, mid, bop)
2549 OP(PLUS, PLUS), (C(Integer), C(Float), C(String), C(Array));
2550 OP(MINUS, MINUS), (C(Integer), C(Float));
2551 OP(MULT, MULT), (C(Integer), C(Float));
2552 OP(DIV, DIV), (C(Integer), C(Float));
2553 OP(MOD, MOD), (C(Integer), C(Float));
2554 OP(Eq, EQ), (C(Integer), C(Float), C(String), C(Symbol));
2555 OP(Eqq, EQQ), (C(Integer), C(Float), C(Symbol), C(String),
2556 C(NilClass), C(TrueClass), C(FalseClass));
2557 OP(LT, LT), (C(Integer), C(Float));
2558 OP(LE, LE), (C(Integer), C(Float));
2559 OP(GT, GT), (C(Integer), C(Float));
2560 OP(GE, GE), (C(Integer), C(Float));
2561 OP(LTLT, LTLT), (C(String), C(Array));
2562 OP(GTGT, GTGT), (C(Integer));
2563 OP(AREF, AREF), (C(Array), C(Hash), C(Integer));
2564 OP(ASET, ASET), (C(Array), C(Hash));
2565 OP(Length, LENGTH), (C(Array), C(String), C(Hash));
2566 OP(Size, SIZE), (C(Array), C(String), C(Hash));
2567 OP(EmptyP, EMPTY_P), (C(Array), C(String), C(Hash));
2568 OP(Succ, SUCC), (C(Integer), C(String));
2569 OP(EqTilde, MATCH), (C(
Regexp), C(String));
2570 OP(Freeze, FREEZE), (C(String), C(Array), C(Hash));
2571 OP(UMinus, UMINUS), (C(String));
2572 OP(Max, MAX), (C(Array));
2573 OP(Min, MIN), (C(Array));
2574 OP(Hash, HASH), (C(Array));
2575 OP(Call, CALL), (C(Proc));
2576 OP(Yield, YIELD), (C(Proc));
2577 OP(And, AND), (C(Integer));
2578 OP(Or, OR), (C(Integer));
2579 OP(NilP,
NIL_P), (C(NilClass));
2580 OP(Cmp, CMP), (C(Integer), C(Float), C(String));
2581 OP(Default, DEFAULT), (C(Hash));
2582 OP(IncludeP, INCLUDE_P), (C(Array));
2587static enum ruby_basic_operators
2588vm_redefinition_bop_for_id(
ID mid)
2591#define OP(mid_, bop_) case id##mid_: return BOP_##bop_
2608 OP(EmptyP, EMPTY_P);
2622 OP(Default, DEFAULT);
2635 switch (VM_FRAME_TYPE(cfp)) {
2636 case VM_FRAME_MAGIC_METHOD:
return "method";
2637 case VM_FRAME_MAGIC_BLOCK:
return "block";
2638 case VM_FRAME_MAGIC_CLASS:
return "class";
2639 case VM_FRAME_MAGIC_TOP:
return "top";
2640 case VM_FRAME_MAGIC_CFUNC:
return "cfunc";
2641 case VM_FRAME_MAGIC_IFUNC:
return "ifunc";
2642 case VM_FRAME_MAGIC_EVAL:
return "eval";
2643 case VM_FRAME_MAGIC_RESCUE:
return "rescue";
2645 rb_bug(
"unknown frame");
2653 if (THROW_DATA_P(err) &&
2654 THROW_DATA_STATE(err) == TAG_BREAK &&
2655 THROW_DATA_CONSUMED_P(err) == FALSE) {
2656 return THROW_DATA_VAL(err);
2668 unsigned long type = VM_FRAME_TYPE(cfp);
2669#define C(t) if (type == VM_FRAME_MAGIC_##t) return #t
2695 const rb_iseq_t *iseq = CFP_ISEQ(ec->cfp);
2697 unsigned int local_hooks_cnt = iseq->aux.exec.local_hooks_cnt;
2698 if (RB_UNLIKELY(local_hooks_cnt > 0)) {
2699 local_hooks = rb_iseq_local_hooks(iseq, rb_ec_ractor_ptr(ec),
false);
2702 switch (VM_FRAME_TYPE(ec->cfp)) {
2703 case VM_FRAME_MAGIC_METHOD:
2704 RUBY_DTRACE_METHOD_RETURN_HOOK(ec, 0, 0);
2705 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2709 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2712 THROW_DATA_CONSUMED_SET(err);
2714 case VM_FRAME_MAGIC_BLOCK:
2715 if (VM_FRAME_BMETHOD_P(ec->cfp)) {
2716 VALUE bmethod_return_value = frame_return_value(err);
2717 if (cfp_returning_with_value) {
2719 bmethod_return_value = THROW_DATA_VAL(err);
2723 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, bmethod_return_value);
2726 ec->cfp->self, 0, 0, 0, bmethod_return_value, TRUE);
2732 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2733 rb_vm_frame_method_entry(ec->cfp)->called_id,
2734 rb_vm_frame_method_entry(ec->cfp)->owner,
2735 bmethod_return_value);
2737 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
2738 unsigned int local_hooks_cnt = me->def->body.bmethod.local_hooks_cnt;
2739 if (UNLIKELY(local_hooks_cnt > 0)) {
2740 local_hooks = rb_method_def_local_hooks(me->def, rb_ec_ractor_ptr(ec),
false);
2743 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2744 rb_vm_frame_method_entry(ec->cfp)->called_id,
2745 rb_vm_frame_method_entry(ec->cfp)->owner,
2746 bmethod_return_value, TRUE);
2750 THROW_DATA_CONSUMED_SET(err);
2753 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2756 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2758 THROW_DATA_CONSUMED_SET(err);
2761 case VM_FRAME_MAGIC_CLASS:
2854#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2856struct rb_vm_exec_context {
2864vm_exec_bottom_main(
void *context)
2866 struct rb_vm_exec_context *ctx = context;
2869 ctx->result = vm_exec_loop(ec, TAG_NONE, ctx->tag, vm_exec_core(ec));
2873vm_exec_bottom_rescue(
void *context)
2875 struct rb_vm_exec_context *ctx = context;
2878 ctx->result = vm_exec_loop(ec, rb_ec_tag_state(ec), ctx->tag, ec->errinfo);
2891#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2892 struct rb_vm_exec_context ctx = {
2900 rb_wasm_try_catch_init(&try_catch, vm_exec_bottom_main, vm_exec_bottom_rescue, &ctx);
2902 rb_wasm_try_catch_loop_run(&try_catch, &RB_VM_TAG_JMPBUF_GET(_tag.buf));
2904 result = ctx.result;
2906 enum ruby_tag_type state;
2907 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2908 if (UNDEF_P(result = jit_exec(ec))) {
2909 result = vm_exec_core(ec);
2912 result = vm_exec_loop(ec, TAG_NONE, &_tag, result);
2915 result = vm_exec_loop(ec, state, &_tag, ec->errinfo);
2927 if (state == TAG_NONE) {
2931 rb_ec_raised_reset(ec, RAISED_STACKOVERFLOW | RAISED_NOMEMORY);
2932 while (UNDEF_P(result = vm_exec_handle_exception(ec, state, result))) {
2935 if (UNDEF_P(result = jit_exec_exception(ec))) {
2936 result = vm_exec_core(ec);
2939 VM_ASSERT(ec->tag == tag);
2941 if ((state = tag->state) == TAG_NONE)
break;
2942 tag->state = TAG_NONE;
2953 if (!rb_zjit_enabled_p)
return;
2955 VM_ASSERT(cfp <= end_cfp);
2968 if (cfp == end_cfp && !materialize_target)
break;
2970 if (CFP_ZJIT_FRAME_P(cfp)) {
2972 cfp->pc = jit_frame->pc;
2973 cfp->_iseq = (
rb_iseq_t *)jit_frame->iseq;
2974 if (jit_frame->materialize_block_code) {
2975 cfp->block_code = NULL;
2982 int32_t stack_size = (int32_t)jit_frame->stack_size;
2983 if (stack_size > 0) {
2984 VALUE *stack = cfp->sp;
2985 for (int32_t i = 0; i < stack_size; i++) {
2986 VALUE entry = jit_frame->stack[i];
2987 if (ZJIT_STACK_MAP_VREG_P(entry)) {
2992 *stack = ((
VALUE *)cfp->jit_return)[-(ssize_t)ZJIT_STACK_MAP_VREG_INDEX(entry)];
2994 else if (ZJIT_STACK_MAP_SKIP_P(entry)) {
2995 stack -= ZJIT_STACK_MAP_SKIP_SIZE(entry);
2997 else if (ZJIT_STACK_MAP_BASE_PTR_P(entry)) {
3000 VALUE *base_ptr = (
VALUE *)((
VALUE *)cfp->jit_return)[-(ssize_t)ZJIT_STACK_MAP_BASE_PTR_SLOT_INDEX(entry)];
3001 stack = base_ptr + ZJIT_STACK_MAP_BASE_PTR_STACK_SIZE(entry);
3009 cfp->jit_return = 0;
3011 if (end_cfp == cfp)
break;
3012 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3019 zjit_materialize_frames(ec, cfp,
true);
3027 zjit_materialize_frames(ec, cfp, !ec->tag->zjit_frame_active);
3040 unsigned long epc, cont_pc, cont_sp;
3045 cont_pc = cont_sp = 0;
3048 while (CFP_PC(ec->cfp) == 0 || CFP_ISEQ(ec->cfp) == 0) {
3049 if (UNLIKELY(VM_FRAME_TYPE(ec->cfp) == VM_FRAME_MAGIC_CFUNC)) {
3051 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
3052 rb_vm_frame_method_entry(ec->cfp)->called_id,
3053 rb_vm_frame_method_entry(ec->cfp)->owner,
Qnil);
3054 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec,
3055 rb_vm_frame_method_entry(ec->cfp)->owner,
3056 rb_vm_frame_method_entry(ec->cfp)->def->original_id);
3058 rb_vm_pop_frame(ec);
3062 epc = CFP_PC(cfp) - ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded;
3065 if (state == TAG_BREAK || state == TAG_RETURN) {
3066 escape_cfp = THROW_DATA_CATCH_FRAME(err);
3068 if (cfp == escape_cfp) {
3069 if (state == TAG_RETURN) {
3070 if (!VM_FRAME_FINISHED_P(cfp)) {
3071 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
3072 THROW_DATA_STATE_SET(err, state = TAG_BREAK);
3075 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3076 if (ct)
for (i = 0; i < ct->size; i++) {
3077 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3078 if (entry->start < epc && entry->end >= epc) {
3079 if (entry->type == CATCH_TYPE_ENSURE) {
3080 catch_iseq = entry->iseq;
3081 cont_pc = entry->cont;
3082 cont_sp = entry->sp;
3087 if (catch_iseq == NULL) {
3089 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
3091 hook_before_rewind(ec,
true, state, err);
3092 rb_vm_pop_frame(ec);
3093 return THROW_DATA_VAL(err);
3100 *cfp->sp++ = THROW_DATA_VAL(err);
3102 rb_zjit_materialize_frames(ec, cfp);
3108 if (state == TAG_RAISE) {
3109 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3110 if (ct)
for (i = 0; i < ct->size; i++) {
3111 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3112 if (entry->start < epc && entry->end >= epc) {
3114 if (entry->type == CATCH_TYPE_RESCUE ||
3115 entry->type == CATCH_TYPE_ENSURE) {
3116 catch_iseq = entry->iseq;
3117 cont_pc = entry->cont;
3118 cont_sp = entry->sp;
3124 else if (state == TAG_RETRY) {
3125 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3126 if (ct)
for (i = 0; i < ct->size; i++) {
3127 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3128 if (entry->start < epc && entry->end >= epc) {
3130 if (entry->type == CATCH_TYPE_ENSURE) {
3131 catch_iseq = entry->iseq;
3132 cont_pc = entry->cont;
3133 cont_sp = entry->sp;
3136 else if (entry->type == CATCH_TYPE_RETRY) {
3138 escape_cfp = THROW_DATA_CATCH_FRAME(err);
3139 if (cfp == escape_cfp) {
3140 rb_zjit_materialize_frames(ec, cfp);
3141 cfp->pc = ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded + entry->cont;
3149 else if ((state == TAG_BREAK && !escape_cfp) ||
3150 (state == TAG_REDO) ||
3151 (state == TAG_NEXT)) {
3152 type = (
const enum rb_catch_type[TAG_MASK]) {
3153 [TAG_BREAK] = CATCH_TYPE_BREAK,
3154 [TAG_NEXT] = CATCH_TYPE_NEXT,
3155 [TAG_REDO] = CATCH_TYPE_REDO,
3159 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3160 if (ct)
for (i = 0; i < ct->size; i++) {
3161 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3163 if (entry->start < epc && entry->end >= epc) {
3164 if (entry->type == CATCH_TYPE_ENSURE) {
3165 catch_iseq = entry->iseq;
3166 cont_pc = entry->cont;
3167 cont_sp = entry->sp;
3170 else if (entry->type ==
type) {
3171 rb_zjit_materialize_frames(ec, cfp);
3172 cfp->pc = ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded + entry->cont;
3173 cfp->sp = vm_base_ptr(cfp) + entry->sp;
3175 if (state != TAG_REDO) {
3176 *cfp->sp++ = THROW_DATA_VAL(err);
3179 VM_ASSERT(ec->tag->state == TAG_NONE);
3186 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3187 if (ct)
for (i = 0; i < ct->size; i++) {
3188 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3189 if (entry->start < epc && entry->end >= epc) {
3191 if (entry->type == CATCH_TYPE_ENSURE) {
3192 catch_iseq = entry->iseq;
3193 cont_pc = entry->cont;
3194 cont_sp = entry->sp;
3201 if (catch_iseq != NULL) {
3203 const int arg_size = 1;
3205 rb_iseq_check(catch_iseq);
3206 rb_zjit_materialize_frames(ec, cfp);
3207 cfp->sp = vm_base_ptr(cfp) + cont_sp;
3208 cfp->pc = ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded + cont_pc;
3211 cfp->sp[0] = (
VALUE)err;
3212 vm_push_frame(ec, catch_iseq, VM_FRAME_MAGIC_RESCUE,
3214 VM_GUARDED_PREV_EP(cfp->ep),
3216 ISEQ_BODY(catch_iseq)->iseq_encoded,
3217 cfp->sp + arg_size ,
3218 ISEQ_BODY(catch_iseq)->local_table_size - arg_size,
3219 ISEQ_BODY(catch_iseq)->stack_max);
3222 ec->tag->state = TAG_NONE;
3228 hook_before_rewind(ec, (cfp == escape_cfp), state, err);
3230 if (VM_FRAME_FINISHED_P(ec->cfp)) {
3231 rb_vm_pop_frame(ec);
3232 ec->errinfo = (
VALUE)err;
3233 rb_vm_tag_jmpbuf_deinit(&ec->tag->buf);
3234 ec->tag = ec->tag->prev;
3235 EC_JUMP_TAG(ec, state);
3238 rb_vm_pop_frame(ec);
3251 vm_set_top_stack(ec, iseq, box);
3261 vm_set_main_stack(ec, iseq);
3272 if (idp) *idp = me->def->original_id;
3273 if (called_idp) *called_idp = me->called_id;
3274 if (klassp) *klassp = me->owner;
3285 return rb_vm_control_frame_id_and_class(ec->cfp, idp, called_idp, klassp);
3291 return rb_ec_frame_method_id_and_class(GET_EC(), idp, 0, klassp);
3300 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
3301 const rb_box_t *box = rb_current_box();
3304 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
3305 recv, GC_GUARDED_PTR(box),
3306 (
VALUE)vm_cref_new_toplevel(ec),
3307 0, reg_cfp->sp, 0, 0);
3311 rb_vm_pop_frame(ec);
3323 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
3326 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
3327 recv, GC_GUARDED_PTR(box),
3328 (
VALUE)vm_cref_new_toplevel(ec),
3329 0, reg_cfp->sp, 0, 0);
3331 val = (*func)(arg1, arg2);
3333 rb_vm_pop_frame(ec);
3340 VM_ASSERT(rb_box_available());
3341 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_BOX_REQUIRE);
3360 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, eocfp)) {
3361 const rb_box_t *box = current_box_on_cfp(ec, cfp);
3362 if (BOX_USER_P(box))
3364 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3374 const VALUE *lep = VM_EP_RUBY_LEP(ec, cfp);
3375 VM_BOX_ASSERT(lep,
"lep should be valid");
3376 VM_BOX_ASSERT(rb_box_available(),
"box should be available here");
3378 if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_METHOD) || VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_CFUNC)) {
3379 cme = check_method_entry(lep[VM_ENV_DATA_INDEX_ME_CREF], TRUE);
3380 VM_BOX_ASSERT(cme,
"cme should be valid");
3381 VM_BOX_ASSERT(cme->def,
"cme->def shold be valid");
3382 if (cme->def->type == VM_METHOD_TYPE_ISEQ &&
3383 (ISEQ_BODY(cme->def->body.iseq.
iseqptr)->builtin_attrs & BUILTIN_ATTR_CALLER_USER_BOX)) {
3386 box = caller_user_box_on_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(owner_cfp));
3391 return cme->def->box;
3393 else if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_TOP) || VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_CLASS)) {
3394 VM_BOX_ASSERT(VM_ENV_LOCAL_P(lep),
"lep should be local on MAGIC_TOP or MAGIC_CLASS frames");
3395 return VM_ENV_BOX(lep);
3397 else if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_DUMMY)) {
3400 box = rb_main_box();
3403 return rb_root_box();
3407 rb_bug(
"BUG: Local ep without cme/box, flags: %08lX", (
unsigned long)lep[VM_ENV_DATA_INDEX_FLAGS]);
3415 return current_box_on_cfp(ec, ec->cfp);
3421 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp)) {
3422 if (!VM_ENV_FRAME_TYPE_P(cfp->ep, VM_FRAME_MAGIC_CFUNC))
3424 if (!BOX_MASTER_P(current_box_on_cfp(ec, cfp)))
3426 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3428 VM_ASSERT(RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp));
3437 if (!rb_box_available() || !ec)
3438 return rb_root_box();
3442 end_cfp = RUBY_VM_END_CONTROL_FRAME(ec);
3444 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp)) {
3445 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BOX_REQUIRE)) {
3446 if (
RTEST(cfp->self) && BOX_OBJ_P(cfp->self)) {
3448 return rb_get_box_t(cfp->self);
3451 cfp = find_loader_control_frame(ec, cfp, end_cfp);
3452 return current_box_on_cfp(ec, cfp);
3454 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3457 return current_box_on_cfp(ec, current_cfp);
3463rb_vm_update_references(
void *ptr)
3468 rb_gc_update_moved(&vm->self);
3469 rb_gc_update_moved(&vm->orig_progname);
3470 rb_gc_update_moved(&vm->cc_refinement_set);
3473 rb_box_gc_update_references(vm->root_box);
3475 rb_box_gc_update_references(vm->main_box);
3477 rb_gc_update_values(RUBY_NSIG, vm->trap_list.cmd);
3479 if (vm->coverages) {
3480 rb_gc_update_moved(&vm->coverages);
3481 rb_gc_update_moved(&vm->cme2counter);
3482 rb_gc_update_moved(&vm->me_set);
3488rb_vm_each_stack_value(
void *ptr,
void (*cb)(
VALUE,
void*),
void *ctx)
3493 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3494 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3495 rb_ractor_status_p(r, ractor_running));
3496 if (r->threads.cnt > 0) {
3498 ccan_list_for_each(&r->threads.set, th, lt_node) {
3499 VM_ASSERT(th != NULL);
3502 VALUE *p = ec->vm_stack;
3503 VALUE *sp = ec->cfp->sp;
3517static enum rb_id_table_iterator_result
3518vm_mark_negative_cme(
VALUE val,
void *dmy)
3521 return ID_TABLE_CONTINUE;
3526rb_vm_mark(
void *ptr)
3528 RUBY_MARK_ENTER(
"vm");
3529 RUBY_GC_INFO(
"-------------------------------------------------\n");
3535 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3537 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3538 rb_ractor_status_p(r, ractor_running));
3539 rb_gc_mark(rb_ractor_self(r));
3542 rb_gc_mark_movable(vm->self);
3545 rb_box_entry_mark(vm->root_box);
3548 rb_box_entry_mark(vm->main_box);
3551 rb_gc_mark_movable(vm->orig_progname);
3552 rb_gc_mark_movable(vm->coverages);
3553 rb_gc_mark_movable(vm->cme2counter);
3554 rb_gc_mark_movable(vm->me_set);
3555 rb_gc_mark_movable(vm->cc_refinement_set);
3557 rb_hook_list_mark(&vm->global_hooks);
3559 rb_id_table_foreach_values(&vm->negative_cme_table, vm_mark_negative_cme, NULL);
3560 rb_mark_tbl_no_pin(&vm->overloaded_cme_table);
3561 for (i=0; i<VM_GLOBAL_CC_CACHE_TABLE_SIZE; i++) {
3562 const struct rb_callcache *cc = vm->global_cc_cache_table[i];
3565 if (!vm_cc_invalidated_p(cc)) {
3566 rb_gc_mark((
VALUE)cc);
3569 vm->global_cc_cache_table[i] = NULL;
3575 RUBY_MARK_LEAVE(
"vm");
3578#undef rb_vm_register_special_exception
3580rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp,
VALUE cls,
VALUE mesg)
3585 ((
VALUE *)vm->special_exceptions)[sp] = exc;
3586 rb_vm_register_global_object(exc);
3589void rb_objspace_free_objects(
void *
objspace);
3598 void rb_thread_sched_wait_winding(
rb_vm_t *vm);
3599 rb_thread_sched_wait_winding(vm);
3602 RUBY_FREE_ENTER(
"vm");
3603 ruby_vm_during_cleanup =
true;
3604 rb_gc_stash_cleanup_objspace();
3609 if (rb_free_at_exit) {
3610 rb_free_encoded_insn_data();
3611 rb_free_global_enc_table();
3612 rb_free_loaded_builtin_table();
3613 rb_free_global_symbol_table();
3615 rb_free_shared_fiber_pool();
3616 rb_free_transcoder_table();
3617 rb_free_vm_opt_tables();
3619 rb_free_rb_global_tbl();
3621 rb_id_table_free_items(&vm->negative_cme_table);
3622 st_free_embedded_table(&vm->overloaded_cme_table);
3627 st_free_embedded_table(&vm->static_ext_inits);
3629 rb_id_table_free_items(&vm->constant_cache);
3630 set_free_embedded_table(&vm->unused_block_warning_table);
3632 rb_thread_free_native_thread(th);
3634#ifndef HAVE_SETPROCTITLE
3635 ruby_free_proctitle();
3639 rb_fiber_reset_root_local_storage(th);
3643 void *
objspace = vm->ractor.main_ractor ? vm->ractor.main_ractor->objspace : NULL;
3645 rb_vm_living_threads_init(vm);
3646 ruby_vm_run_at_exit_hooks(vm);
3647 st_free_embedded_table(&vm->ci_table);
3648 RB_ALTSTACK_FREE(vm->main_altstack);
3651 if (rb_free_at_exit) {
3652 rb_objspace_free_objects(
objspace);
3653 rb_free_generic_fields_tbl_();
3654 rb_free_default_rand_key();
3659 if (rb_free_at_exit) {
3660 free(vm->gc.registered_addrs.registry);
3665 ruby_current_vm_ptr = NULL;
3667 if (rb_free_at_exit) {
3669 rb_yjit_free_at_exit();
3673 rb_box_unload_local_extensions();
3675 RUBY_FREE_LEAVE(
"vm");
3682static enum rb_id_table_iterator_result
3683vm_memsize_constant_cache_i(
ID id,
VALUE ics,
void *size)
3685 *((
size_t *) size) += rb_set_memsize((
set_table *) ics);
3686 return ID_TABLE_CONTINUE;
3693vm_memsize_constant_cache(
void)
3696 size_t size = rb_id_table_memsize(&vm->constant_cache) -
sizeof(
struct rb_id_table);
3698 rb_id_table_foreach(&vm->constant_cache, vm_memsize_constant_cache_i, &size);
3709 at_exit = at_exit->next;
3718vm_memsize_builtin_function_table(
const struct rb_builtin_function *builtin_function_table)
3726vm_memsize(
const void *ptr)
3732 rb_vm_memsize_postponed_job_queue() +
3733 vm_memsize_at_exit_list(vm->at_exit) +
3734 (rb_st_memsize(&vm->ci_table) -
sizeof(
struct st_table)) +
3735 vm_memsize_builtin_function_table(vm->builtin_function_table) +
3736 (rb_id_table_memsize(&vm->negative_cme_table) -
sizeof(
struct rb_id_table)) +
3737 (rb_st_memsize(&vm->overloaded_cme_table) -
sizeof(
struct st_table)) +
3738 vm_memsize_constant_cache()
3749 {0, 0, vm_memsize,},
3750 0, 0, RUBY_TYPED_THREAD_SAFE_FREE
3753#define vm_data_type ruby_vm_data_type
3756vm_default_params(
void)
3759 VALUE result = rb_hash_new_capa(4);
3760#define SET(name) rb_hash_aset(result, ID2SYM(rb_intern(#name)), SIZET2NUM(vm->default_params.name));
3761 SET(thread_vm_stack_size);
3762 SET(thread_machine_stack_size);
3763 SET(fiber_vm_stack_size);
3764 SET(fiber_machine_stack_size);
3771get_param(
const char *name,
size_t default_value,
size_t min_value)
3774 size_t result = default_value;
3775 if ((envval = getenv(name)) != 0) {
3776 long val = atol(envval);
3777 if (val < (
long)min_value) {
3778 val = (long)min_value;
3780 result = (size_t)(((val -1 + RUBY_VM_SIZE_ALIGN) / RUBY_VM_SIZE_ALIGN) * RUBY_VM_SIZE_ALIGN);
3782 if (0) ruby_debug_printf(
"%s: %"PRIuSIZE
"\n", name, result);
3788check_machine_stack_size(
size_t *sizep)
3790#ifdef PTHREAD_STACK_MIN
3791 size_t size = *sizep;
3794#ifdef PTHREAD_STACK_MIN
3795 if (size < (
size_t)PTHREAD_STACK_MIN) {
3796 *sizep = (size_t)PTHREAD_STACK_MIN * 2;
3802vm_default_params_setup(
rb_vm_t *vm)
3804 vm->default_params.thread_vm_stack_size =
3805 get_param(
"RUBY_THREAD_VM_STACK_SIZE",
3806 RUBY_VM_THREAD_VM_STACK_SIZE,
3807 RUBY_VM_THREAD_VM_STACK_SIZE_MIN);
3809 vm->default_params.thread_machine_stack_size =
3810 get_param(
"RUBY_THREAD_MACHINE_STACK_SIZE",
3811 RUBY_VM_THREAD_MACHINE_STACK_SIZE,
3812 RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN);
3814 vm->default_params.fiber_vm_stack_size =
3815 get_param(
"RUBY_FIBER_VM_STACK_SIZE",
3816 RUBY_VM_FIBER_VM_STACK_SIZE,
3817 RUBY_VM_FIBER_VM_STACK_SIZE_MIN);
3819 vm->default_params.fiber_machine_stack_size =
3820 get_param(
"RUBY_FIBER_MACHINE_STACK_SIZE",
3821 RUBY_VM_FIBER_MACHINE_STACK_SIZE,
3822 RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN);
3825 check_machine_stack_size(&vm->default_params.thread_machine_stack_size);
3826 check_machine_stack_size(&vm->default_params.fiber_machine_stack_size);
3832 rb_vm_living_threads_init(vm);
3833 vm->thread_report_on_exception = 1;
3834 vm->src_encoding_index = -1;
3836 vm_default_params_setup(vm);
3846 VALUE *p = ec->vm_stack;
3847 VALUE *sp = ec->cfp->sp;
3853 if (!rb_zjit_enabled_p) {
3854 for (i = 0; i < (long)(sp - p); i++) {
3855 rb_gc_update_moved(&p[i]);
3859 while (cfp != limit_cfp) {
3860 const VALUE *ep = cfp->ep;
3861 rb_gc_update_moved(&cfp->self);
3862 if (CFP_ZJIT_FRAME_P(cfp)) {
3869 if (!jit_frame->materialize_block_code) {
3870 rb_gc_update_moved_ptr(&cfp->block_code);
3874 rb_gc_update_moved_ptr(&cfp->_iseq);
3875 rb_gc_update_moved_ptr(&cfp->block_code);
3878 if (!VM_ENV_LOCAL_P(ep)) {
3879 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3880 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3881 rb_gc_update_moved((
VALUE *)&prev_ep[VM_ENV_DATA_INDEX_ENV]);
3884 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3885 rb_gc_update_moved((
VALUE *)&ep[VM_ENV_DATA_INDEX_ENV]);
3886 rb_gc_update_moved((
VALUE *)&ep[VM_ENV_DATA_INDEX_ME_CREF]);
3890 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3894 rb_gc_update_moved(&ec->storage);
3896 rb_gc_update_moved(&ec->gen_fields_cache.obj);
3897 rb_gc_update_moved(&ec->gen_fields_cache.fields_obj);
3900static enum rb_id_table_iterator_result
3901mark_local_storage_i(
VALUE local,
void *data)
3904 return ID_TABLE_CONTINUE;
3913 VALUE *p = ec->vm_stack;
3914 VALUE *sp = ec->cfp->sp;
3918 for (
long i = 0; i < (long)(sp - p); i++) {
3919 if (rb_zjit_enabled_p) {
3922 rb_gc_mark_maybe(p[i]);
3925 rb_gc_mark_movable(p[i]);
3929 while (cfp != limit_cfp) {
3930 const VALUE *ep = cfp->ep;
3931 VM_ASSERT(!!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) == vm_ep_in_heap_p_(ec, ep));
3933 rb_gc_mark_movable(cfp->self);
3934 if (CFP_ZJIT_FRAME_P(cfp)) {
3936 rb_gc_mark_movable((
VALUE)jit_frame->iseq);
3941 if (!jit_frame->materialize_block_code) {
3942 rb_gc_mark_movable((
VALUE)cfp->block_code);
3946 rb_gc_mark_movable((
VALUE)cfp->_iseq);
3947 rb_gc_mark_movable((
VALUE)cfp->block_code);
3950 if (VM_ENV_LOCAL_P(ep) && VM_ENV_BOXED_P(ep)) {
3951 const rb_box_t *box = VM_ENV_BOX(ep);
3952 if (BOX_USER_P(box)) {
3953 rb_gc_mark_movable(box->box_object);
3957 if (!VM_ENV_LOCAL_P(ep)) {
3958 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3959 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3960 rb_gc_mark_movable(prev_ep[VM_ENV_DATA_INDEX_ENV]);
3963 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3964 rb_gc_mark_movable(ep[VM_ENV_DATA_INDEX_ENV]);
3965 rb_gc_mark(ep[VM_ENV_DATA_INDEX_ME_CREF]);
3969 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3974 if (ec->machine.stack_start && ec->machine.stack_end &&
3976 ec != rb_gc_get_ec()) {
3977 rb_gc_mark_machine_context(ec);
3980 rb_gc_mark(ec->errinfo);
3981 rb_gc_mark(ec->root_svar);
3982 if (ec->local_storage) {
3983 rb_id_table_foreach_values(ec->local_storage, mark_local_storage_i, NULL);
3985 rb_gc_mark(ec->local_storage_recursive_hash);
3986 rb_gc_mark(ec->local_storage_recursive_hash_for_trace);
3987 rb_gc_mark(ec->private_const_reference);
3989 rb_gc_mark_movable(ec->storage);
3994void rb_threadptr_root_fiber_setup(
rb_thread_t *th);
3996void rb_threadptr_root_fiber_release(
rb_thread_t *th);
3999thread_compact(
void *ptr)
4003 rb_gc_update_moved(&th->self);
4013 switch (th->invoke_type) {
4014 case thread_invoke_type_proc:
4015 case thread_invoke_type_ractor_proc:
4016 rb_gc_mark(th->invoke_arg.proc.proc);
4017 rb_gc_mark(th->invoke_arg.proc.args);
4019 case thread_invoke_type_func:
4020 rb_gc_mark_maybe((
VALUE)th->invoke_arg.func.arg);
4026 rb_gc_mark(th->thgroup);
4027 rb_gc_mark(th->value);
4028 rb_gc_mark(th->pending_interrupt_queue);
4029 rb_gc_mark(th->pending_interrupt_mask_stack);
4030 rb_gc_mark(th->top_self);
4031 rb_gc_mark(th->top_wrapper);
4032 rb_gc_mark(th->last_status);
4033 rb_gc_mark(th->locking_mutex);
4034 rb_gc_mark(th->name);
4035 rb_gc_mark(th->scheduler);
4037 rb_threadptr_interrupt_exec_task_mark(th);
4041thread_mark(
void *ptr)
4044 RUBY_MARK_ENTER(
"thread");
4048 rb_fiber_mark_self(th->ec->fiber_ptr);
4054 if (th->ractor) rb_gc_mark(rb_ractor_self(th->ractor));
4055 if (th->root_fiber) rb_fiber_mark_self(th->root_fiber);
4057 RUBY_ASSERT(th->ec == NULL || th->ec == rb_fiberptr_get_ec(th->ec->fiber_ptr));
4059 rb_thread_mark_owned_roots(th);
4061 RUBY_MARK_LEAVE(
"thread");
4067thread_free(
void *ptr)
4074 if (th->ec != NULL && th->ec == rb_current_execution_context(
false)) {
4078 rb_thread_free_body(ptr);
4082rb_thread_free_body(
void *ptr)
4085 RUBY_FREE_ENTER(
"thread");
4087 rb_threadptr_sched_free(th);
4092 if (th->locking_mutex !=
Qfalse) {
4093 rb_bug(
"thread_free: locking_mutex must be NULL (%p:%p)", (
void *)th, (
void *)th->locking_mutex);
4095 if (th->keeping_mutexes != NULL) {
4096 rb_bug(
"thread_free: keeping_mutexes must be NULL (%p:%p)", (
void *)th, (
void *)th->keeping_mutexes);
4099 ruby_xfree(th->specific_storage);
4101 if (th->vm && th->vm->ractor.main_thread == th) {
4102 RUBY_GC_INFO(
"MRI main thread\n");
4107 if (!th->main_thread) {
4112 RUBY_FREE_LEAVE(
"thread");
4116thread_memsize(
const void *ptr)
4121 if (!th->root_fiber) {
4122 size += th->ec->vm_stack_size *
sizeof(
VALUE);
4124 if (th->ec->local_storage) {
4125 size += rb_id_table_memsize(th->ec->local_storage);
4130#define thread_data_type ruby_threadptr_data_type
4139 0, 0, RUBY_TYPED_THREAD_SAFE_FREE
4143rb_obj_is_thread(
VALUE obj)
4145 return RBOOL(rb_typeddata_is_kind_of(obj, &thread_data_type));
4151 return rb_data_typed_object_zalloc_in_objspace(
objspace, klass,
sizeof(
rb_thread_t), &thread_data_type);
4157 ec->vm_stack = stack;
4158 ec->vm_stack_size = size;
4164 rb_ec_set_vm_stack(ec, stack, size);
4166#if VM_CHECK_MODE > 0
4170 ec->cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
4174 VM_FRAME_MAGIC_DUMMY | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH | VM_FRAME_FLAG_CFRAME ,
4175 Qnil , VM_BLOCK_HANDLER_NONE ,
4177 0 , ec->vm_stack, 0, 0
4187 rb_ec_set_vm_stack(ec, NULL, 0);
4200 const rb_box_t *box = rb_current_box();
4204 ccan_list_head_init(&th->interrupt_exec_tasks);
4210 rb_threadptr_root_fiber_setup(th);
4214 th->scheduler =
Qnil;
4217 size_t size = vm->default_params.thread_vm_stack_size /
sizeof(
VALUE);
4219 rb_ec_initialize_vm_stack(th->ec, stack, size);
4220 rb_thread_malloc_stack_set(th, stack, size);
4223 VM_ASSERT(th->ec->cfp == NULL);
4224 VM_ASSERT(th->ec->vm_stack == NULL);
4225 VM_ASSERT(th->ec->vm_stack_size == 0);
4228 th->status = THREAD_RUNNABLE;
4229 th->last_status =
Qnil;
4230 th->top_wrapper = 0;
4231 if (box->top_self) {
4232 th->top_self = box->top_self;
4239 th->ec->errinfo =
Qnil;
4240 th->ec->root_svar =
Qfalse;
4241 th->ec->local_storage_recursive_hash =
Qnil;
4242 th->ec->local_storage_recursive_hash_for_trace =
Qnil;
4244 th->ec->storage =
Qnil;
4245 th->ec->ractor_id = rb_ractor_id(th->ractor);
4247#if OPT_CALL_THREADED_CODE
4251 th->report_on_exception = vm->thread_report_on_exception;
4252 th->ext_config.ractor_safe =
true;
4254#if USE_RUBY_DEBUG_LOG
4258 RUBY_DEBUG_LOG(
"th:%u", th->serial);
4267 target_th->ractor = GET_RACTOR();
4268 th_init(target_th, self, target_th->vm = GET_VM());
4269 rb_root_fiber_obj_setup(target_th,
objspace);
4274rb_thread_alloc(
VALUE klass)
4276 return rb_thread_alloc_in_objspace(klass, GET_RACTOR()->
objspace);
4279#define REWIND_CFP(expr) do { \
4280 rb_execution_context_t *ec__ = GET_EC(); \
4281 VALUE *const curr_sp = (ec__->cfp++)->sp; \
4282 VALUE *const saved_sp = ec__->cfp->sp; \
4283 ec__->cfp->sp = curr_sp; \
4285 (ec__->cfp--)->sp = saved_sp; \
4312 rb_clear_method_cache(self, mid);
4318m_core_set_postexe(
VALUE self)
4320 rb_ractor_ensure_main_ractor(
"can not use END{} in non-main Ractors");
4326core_hash_merge(
VALUE hash,
long argc,
const VALUE *argv,
bool dup)
4329 hash = rb_cHash_empty_frozen;
4332 hash = rb_to_hash_type(hash);
4336 return rb_hash_merge2_bulk(hash, argc, argv, dup);
4340m_core_hash_merge_ptr(
int argc,
VALUE *argv,
VALUE recv)
4342 VALUE hash = argv[0];
4343 VM_ASSERT(argc % 2 == 1);
4345 REWIND_CFP(hash = core_hash_merge(hash, argc - 1, argv + 1,
true));
4351m_core_hash_merge_bang_ptr(
int argc,
VALUE *argv,
VALUE recv)
4353 VALUE hash = argv[0];
4354 VM_ASSERT(argc % 2 == 1);
4356 REWIND_CFP(hash = core_hash_merge(hash, argc - 1, argv + 1,
false));
4362core_hash_merge_kwd(
VALUE hash,
VALUE kw,
bool dup)
4364 kw = rb_to_hash_type(kw);
4366 return dup ? rb_hash_resurrect(kw) : kw;
4369 hash = rb_to_hash_type(hash);
4371 return rb_hash_merge2(hash, kw, dup);
4383 return rb_hash_new();
4386 hash = rb_hash_resurrect(hash);
4389 REWIND_CFP(hash = core_hash_merge_kwd(hash, kw,
true));
4401 hash = rb_hash_new();
4404 hash = rb_hash_resurrect(hash);
4408 REWIND_CFP(hash = core_hash_merge_kwd(hash, kw,
false));
4415core_hash_coerce(
VALUE hash)
4418 return rb_hash_new();
4420 VALUE new_hash = rb_to_hash_type(hash);
4421 if (new_hash == hash) {
4422 new_hash = rb_hash_dup(new_hash);
4430 REWIND_CFP(hash = core_hash_coerce(hash));
4442m_core_make_shareable_copy(
VALUE recv,
VALUE obj)
4450 return rb_ractor_ensure_shareable(obj, name);
4453extern VALUE *rb_gc_stack_start;
4454extern size_t rb_gc_stack_maxsize;
4462 rb_vm_bugreport(NULL, stderr);
4471#ifdef HAVE_BACKTRACE
4472#include <execinfo.h>
4473#define MAX_NATIVE_TRACE 1024
4474 static void *trace[MAX_NATIVE_TRACE];
4475 int n = (int)backtrace(trace, MAX_NATIVE_TRACE);
4476 char **syms = backtrace_symbols(trace, n);
4483 for (i=0; i<n; i++) {
4491#if VM_COLLECT_USAGE_DETAILS
4492static VALUE usage_analysis_insn_start(
VALUE self);
4493static VALUE usage_analysis_operand_start(
VALUE self);
4494static VALUE usage_analysis_register_start(
VALUE self);
4495static VALUE usage_analysis_insn_stop(
VALUE self);
4496static VALUE usage_analysis_operand_stop(
VALUE self);
4497static VALUE usage_analysis_register_stop(
VALUE self);
4498static VALUE usage_analysis_insn_running(
VALUE self);
4499static VALUE usage_analysis_operand_running(
VALUE self);
4500static VALUE usage_analysis_register_running(
VALUE self);
4501static VALUE usage_analysis_insn_clear(
VALUE self);
4502static VALUE usage_analysis_operand_clear(
VALUE self);
4503static VALUE usage_analysis_register_clear(
VALUE self);
4509 return rb_f_raise(c, v);
4558vm_keep_script_lines(
VALUE self)
4560 return RBOOL(ruby_vm_keep_script_lines);
4575vm_keep_script_lines_set(
VALUE self,
VALUE flags)
4577 ruby_vm_keep_script_lines =
RTEST(flags);
4599 rb_cRubyVM = rb_define_class(
"RubyVM",
rb_cObject);
4606#if USE_DEBUG_COUNTER
4630 rb_define_method(klass,
"make_shareable_copy", m_core_make_shareable_copy, 1);
4633 RBASIC_CLEAR_CLASS(klass);
4635 rb_vm_register_global_object(fcore);
4636 rb_mRubyVMFrozenCore = fcore;
4799#if VM_COLLECT_USAGE_DETAILS
4801#define define_usage_analysis_hash(name) \
4802 rb_define_const(rb_cRubyVM, "USAGE_ANALYSIS_" #name, rb_hash_new())
4803 define_usage_analysis_hash(
INSN);
4804 define_usage_analysis_hash(REGS);
4805 define_usage_analysis_hash(INSN_BIGRAM);
4825 rb_define_const(rb_cRubyVM,
"OPTS", opts =
rb_ary_new());
4827#if OPT_DIRECT_THREADED_CODE
4829#elif OPT_TOKEN_THREADED_CODE
4831#elif OPT_CALL_THREADED_CODE
4835#if OPT_OPERANDS_UNIFICATION
4838#if OPT_INSTRUCTIONS_UNIFICATION
4841#if OPT_INLINE_METHOD_CACHE
4849 rb_define_const(rb_cRubyVM,
"INSTRUCTION_NAMES", rb_insns_name_array());
4857 rb_define_const(rb_cRubyVM,
"DEFAULT_PARAMS", vm_default_params());
4874 rb_vm_t *vm = ruby_current_vm_ptr;
4876 VALUE filename = rb_fstring_lit(
"<main>");
4877 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
4880 rb_ractor_main_setup(vm, th->ractor, th);
4887 vm->ractor.main_thread = th;
4888 vm->ractor.main_ractor = th->ractor;
4890 th->top_wrapper = 0;
4891 th->top_self = rb_vm_top_self();
4893 rb_root_fiber_obj_setup(th, th->ractor->objspace);
4895 rb_vm_register_global_object((
VALUE)iseq);
4896 th->ec->cfp->_iseq = iseq;
4897 th->ec->cfp->pc = ISEQ_BODY(iseq)->iseq_encoded;
4898 th->ec->cfp->self = th->top_self;
4900 VM_ENV_FLAGS_UNSET(th->ec->cfp->ep, VM_FRAME_FLAG_CFRAME);
4901 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));
4909 rb_objspace_gc_enable(vm->ractor.main_ractor->objspace);
4912 vm_init_redefined_flag();
4916 rb_add_method_optimized(proxy_singleton, idCall, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
4917 rb_add_method_optimized(proxy_singleton, idAREF, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
4918 rb_add_method_optimized(proxy_singleton, idYield, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
4919 rb_add_method_optimized(proxy_singleton, idEqq, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
4921 rb_vm_register_global_object(rb_block_param_proxy);
4924 Init_vm_backtrace();
4928rb_vm_set_progname(
VALUE filename)
4935 rb_iseq_pathobj_set(CFP_ISEQ(cfp), filename, rb_iseq_realpath(CFP_ISEQ(cfp)));
4956 ruby_current_vm_ptr = vm;
4959 vm->ractor.main_ractor = rb_ractor_main_alloc();
4961 rb_gc_init_objspaces();
4962 vm->ractor.main_ractor->newobj_cache = rb_gc_ractor_cache_alloc(vm->ractor.main_ractor);
4963 rb_id_table_init(&vm->negative_cme_table, 16);
4964 st_init_existing_numtable_with_size(&vm->overloaded_cme_table, 0);
4965 st_init_existing_strtable_with_size(&vm->static_ext_inits, 0);
4966 set_init_embedded_numtable_with_size(&vm->unused_block_warning_table, 0);
4967 vm->global_hooks.type = hook_list_type_global;
4971 th->ractor = vm->ractor.main_ractor;
4972 Init_native_thread(th);
4976 rb_ractor_set_current_ec(th->ractor, th->ec);
4979 ruby_thread_init_stack(th, native_main_thread_stack_top);
4985 vm->gc.orphan_merge_pjob = POSTPONED_JOB_HANDLE_INVALID;
4987 vm_opt_method_def_table = st_init_numtable();
4988 vm_opt_mid_table = st_init_numtable();
4995 native_main_thread_stack_top = addr;
5000#include <sys/mman.h>
5005rb_vm_register_global_object(
VALUE obj)
5015 if (
FL_TEST(obj, RCLASS_IS_ROOT)) {
5018 FL_SET(obj, RCLASS_IS_ROOT);
5027 if (cr->registered_marks_cnt == cr->registered_marks_capa) {
5028 size_t nc = cr->registered_marks_capa ? cr->registered_marks_capa * 2 : 64;
5029 VALUE *p = realloc(cr->registered_marks, nc *
sizeof(
VALUE));
5030 if (!p) rb_bug(
"rb_vm_register_global_object: out of memory");
5031 cr->registered_marks = p;
5032 cr->registered_marks_capa = nc;
5034 cr->registered_marks[cr->registered_marks_cnt++] = obj;
5038VALUE rb_cc_refinement_set_create(
void);
5041Init_vm_objects(
void)
5044 st_init_existing_table_with_size(&vm->ci_table, &vm_ci_hashtype, 0);
5045 vm->cc_refinement_set = rb_cc_refinement_set_create();
5049#include "jit_hook.rbinc"
5050#include "jit_undef.rbinc"
5054void Init_builtin_yjit(
void) {}
5059void Init_builtin_zjit(
void) {}
5073 const rb_box_t *box = rb_current_box();
5075 VM_ASSERT(box->top_self);
5076 return box->top_self;
5083 vm->root_box = (
rb_box_t *)rb_root_box();
5093 return &cr->verbose;
5103bool rb_free_at_exit =
false;
5106ruby_free_at_exit_p(
void)
5108 return rb_free_at_exit;
5116#if VM_COLLECT_USAGE_DETAILS
5118#define HASH_ASET(h, k, v) rb_hash_aset((h), (st_data_t)(k), (st_data_t)(v))
5132vm_analysis_insn(
int insn)
5136 static int prev_insn = -1;
5142 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5143 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
5146 ihash = rb_hash_new();
5147 HASH_ASET(uh,
INT2FIX(insn), ihash);
5155 if (prev_insn != -1) {
5165 if (
NIL_P(cv = rb_hash_aref(uh, bi))) {
5174vm_analysis_operand(
int insn,
int n,
VALUE op)
5184 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5188 ihash = rb_hash_new();
5189 HASH_ASET(uh,
INT2FIX(insn), ihash);
5192 ophash = rb_hash_new();
5193 HASH_ASET(ihash,
INT2FIX(n), ophash);
5196 valstr = rb_insn_operand_intern(CFP_ISEQ(GET_EC()->cfp), insn, n, op, 0, 0, 0, 0);
5199 if (
NIL_P(cv = rb_hash_aref(ophash, valstr))) {
5206vm_analysis_register(
int reg,
int isset)
5211 static const char regstrs[][5] = {
5219 static const char getsetstr[][4] = {
5223 static VALUE syms[
sizeof(regstrs) /
sizeof(regstrs[0])][2];
5227 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
5232 for (i = 0; i < (int)(
sizeof(regstrs) /
sizeof(regstrs[0])); i++) {
5234 for (j = 0; j < 2; j++) {
5235 snprintf(buff, 0x10,
"%d %s %-4s", i, getsetstr[j], regstrs[i]);
5236 syms[i][j] =
ID2SYM(rb_intern(buff));
5240 valstr = syms[reg][isset];
5243 if (
NIL_P(cv = rb_hash_aref(uh, valstr))) {
5251static void (*ruby_vm_collect_usage_func_insn)(
int insn) = NULL;
5252static void (*ruby_vm_collect_usage_func_operand)(
int insn,
int n,
VALUE op) = NULL;
5253static void (*ruby_vm_collect_usage_func_register)(
int reg,
int isset) = NULL;
5257usage_analysis_insn_start(
VALUE self)
5259 ruby_vm_collect_usage_func_insn = vm_analysis_insn;
5265usage_analysis_operand_start(
VALUE self)
5267 ruby_vm_collect_usage_func_operand = vm_analysis_operand;
5273usage_analysis_register_start(
VALUE self)
5275 ruby_vm_collect_usage_func_register = vm_analysis_register;
5281usage_analysis_insn_stop(
VALUE self)
5283 ruby_vm_collect_usage_func_insn = 0;
5289usage_analysis_operand_stop(
VALUE self)
5291 ruby_vm_collect_usage_func_operand = 0;
5297usage_analysis_register_stop(
VALUE self)
5299 ruby_vm_collect_usage_func_register = 0;
5305usage_analysis_insn_running(
VALUE self)
5307 return RBOOL(ruby_vm_collect_usage_func_insn != 0);
5312usage_analysis_operand_running(
VALUE self)
5314 return RBOOL(ruby_vm_collect_usage_func_operand != 0);
5319usage_analysis_register_running(
VALUE self)
5321 return RBOOL(ruby_vm_collect_usage_func_register != 0);
5325usage_analysis_clear(
VALUE self,
ID usage_hash)
5337usage_analysis_insn_clear(
VALUE self)
5342 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5343 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
5344 usage_analysis_clear(rb_cRubyVM, usage_hash);
5345 return usage_analysis_clear(rb_cRubyVM, bigram_hash);
5350usage_analysis_operand_clear(
VALUE self)
5354 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5355 return usage_analysis_clear(self, usage_hash);
5360usage_analysis_register_clear(
VALUE self)
5364 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
5365 return usage_analysis_clear(self, usage_hash);
5370vm_collect_usage_insn(
int insn)
5372 if (RUBY_DTRACE_INSN_ENABLED()) {
5373 RUBY_DTRACE_INSN(rb_insns_name(insn));
5375 if (ruby_vm_collect_usage_func_insn)
5376 (*ruby_vm_collect_usage_func_insn)(insn);
5384vm_collect_usage_operand(
int insn,
int n,
VALUE op)
5386 if (RUBY_DTRACE_INSN_OPERAND_ENABLED()) {
5389 valstr = rb_insn_operand_intern(CFP_ISEQ(GET_EC()->cfp), insn, n, op, 0, 0, 0, 0);
5391 RUBY_DTRACE_INSN_OPERAND(RSTRING_PTR(valstr), rb_insns_name(insn));
5394 if (ruby_vm_collect_usage_func_operand)
5395 (*ruby_vm_collect_usage_func_operand)(insn, n, op);
5401vm_collect_usage_register(
int reg,
int isset)
5403 if (ruby_vm_collect_usage_func_register)
5404 (*ruby_vm_collect_usage_func_register)(reg, isset);
5411 return &vm_empty_cc;
5415rb_vm_empty_cc_for_super(
void)
5417 return &vm_empty_cc_for_super;
5420#include "vm_call_iseq_optimized.inc"
#define RUBY_ASSERT_ALWAYS(expr,...)
A variant of RUBY_ASSERT that does not interface with RUBY_DEBUG.
#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_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 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 SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#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.
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_cObject
Object 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)
Same as RB_OBJ_FREEZE(), but returns the given object.
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 $_.
int rb_is_instance_id(ID id)
Classifies the given ID, then sees if it is an instance variable.
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_mod_name(VALUE mod)
Queries the name of a module.
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...
#define RB_OBJ_SET_SHAREABLE(obj)
Wrapper of rb_obj_set_shareable().
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.
static VALUE RB_OBJ_SET_FROZEN_SHAREABLE(VALUE obj)
Freezes and marks the object as shareable.
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.
void rb_ivar_foreach(VALUE q, int_type *w, VALUE e)
Iteration over each instance variable of the object.
#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*.
static int RSTRING_LENINT(VALUE str)
Identical to RSTRING_LEN(), except it differs for the return type.
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
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 rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
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.
void rb_native_cond_destroy(rb_nativethread_cond_t *cond)
Destroys the passed condition variable.
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.