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*);
74VALUE vm_exec(rb_execution_context_t *);
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);
88static inline const rb_control_frame_t *
89rb_vm_search_cf_from_ep(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp,
const VALUE *
const ep)
95 const rb_control_frame_t *
const eocfp = RUBY_VM_END_CONTROL_FRAME(ec);
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)
119VM_EP_RUBY_LEP(
const rb_execution_context_t *ec,
const rb_control_frame_t *current_cfp)
122 const VALUE *ep = current_cfp->ep;
123 const rb_control_frame_t *
const eocfp = RUBY_VM_END_CONTROL_FRAME(ec);
124 const rb_control_frame_t *cfp = current_cfp;
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);
198PUREFUNC(
static inline const VALUE *VM_CF_LEP(
const rb_control_frame_t *
const cfp));
199static inline const VALUE *
200VM_CF_LEP(
const rb_control_frame_t *
const cfp)
202 return VM_EP_LEP(cfp->ep);
205static inline const VALUE *
206VM_CF_PREV_EP(
const rb_control_frame_t *
const cfp)
208 return VM_ENV_PREV_EP(cfp->ep);
211PUREFUNC(
static inline VALUE VM_CF_BLOCK_HANDLER(
const rb_control_frame_t *
const cfp));
213VM_CF_BLOCK_HANDLER(
const rb_control_frame_t *
const cfp)
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);
228rb_vm_cframe_keyword_p(
const rb_control_frame_t *cfp)
230 return VM_FRAME_CFRAME_KW_P(cfp);
234rb_vm_frame_block_handler(
const rb_control_frame_t *cfp)
236 return VM_CF_BLOCK_HANDLER(cfp);
241VM_CFP_IN_HEAP_P(
const rb_execution_context_t *ec,
const rb_control_frame_t *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) {
256VM_EP_IN_HEAP_P(
const rb_execution_context_t *ec,
const VALUE *ep)
258 const VALUE *start = ec->vm_stack;
260 VM_ASSERT(start != NULL);
262 if (start <= ep && ep < end) {
271vm_ep_in_heap_p_(
const rb_execution_context_t *ec,
const VALUE *ep)
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)
293 const rb_execution_context_t *ec = rb_current_execution_context(
false);
294 if (ec == NULL || ec->vm_stack == NULL)
return TRUE;
295 return vm_ep_in_heap_p_(ec, ep);
300VM_CFP_TO_CAPTURED_BLOCK(
const rb_control_frame_t *cfp)
302 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
306static rb_control_frame_t *
309 rb_control_frame_t *cfp = ((rb_control_frame_t *)((
VALUE *)(captured) - 3));
310 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
311 VM_ASSERT(
sizeof(rb_control_frame_t)/
sizeof(
VALUE) == 7 + VM_DEBUG_BP_CHECK ? 1 : 0);
316VM_BH_FROM_CFP_P(
VALUE block_handler,
const rb_control_frame_t *cfp)
319 return VM_TAGGED_PTR_REF(block_handler, 0x03) == captured;
323vm_passed_block_handler(rb_execution_context_t *ec)
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;
338 rb_scope_visibility_t scope_visi;
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);
354 rb_cref_t *cref = SHAREABLE_IMEMO_NEW(rb_cref_t, imemo_cref, refinements);
364 cref->klass_or_self = 0;
366 cref->next = use_prev_prev ? CREF_NEXT(prev_cref) : prev_cref;
367 *((rb_scope_visibility_t *)&cref->scope_visi) = scope_visi;
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;
389rb_vm_cref_dup(
const rb_cref_t *cref)
391 const rb_scope_visibility_t *visi = CREF_SCOPE_VISI(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 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)
411 const rb_scope_visibility_t *visi = CREF_SCOPE_VISI(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);
427vm_cref_new_toplevel(rb_execution_context_t *ec)
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);
479static VALUE vm_make_env_object(
const rb_execution_context_t *ec, rb_control_frame_t *cfp);
481 int argc,
const VALUE *argv,
int kw_splat,
VALUE block_handler,
482 const rb_callable_method_entry_t *me);
483static VALUE vm_invoke_proc(rb_execution_context_t *ec,
rb_proc_t *proc,
VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE block_handler,
const rb_cref_t *cref);
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
538yjit_compile(rb_execution_context_t *ec)
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
560zjit_compile(rb_execution_context_t *ec)
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)
587rb_jit_call_threshold(
void)
590 if (rb_yjit_enabled_p) {
591 return rb_yjit_call_threshold;
595 if (rb_zjit_enabled_p) {
596 return rb_zjit_call_threshold;
602#if USE_YJIT || USE_ZJIT
605jit_exec(rb_execution_context_t *ec)
608 if (rb_yjit_enabled_p) {
609 rb_jit_func_t func = yjit_compile(ec);
611 return func(ec, ec->cfp);
618 void *zjit_entry = rb_zjit_entry;
620 rb_jit_func_t func = zjit_compile(ec);
622 VALUE result = ((rb_zjit_func_t)zjit_entry)(ec, ec->cfp, func);
636static inline rb_jit_func_t
637jit_compile_exception(rb_execution_context_t *ec)
639 const rb_iseq_t *iseq = CFP_ISEQ(ec->cfp);
645 if (body->jit_exception == NULL && rb_zjit_compiling_p) {
646 body->jit_exception_calls++;
650 if (body->jit_exception_calls == rb_zjit_profile_threshold) {
651 rb_zjit_profile_enable(iseq);
655 if (body->jit_exception_calls == rb_zjit_call_threshold) {
656 rb_zjit_compile_iseq(iseq, ec,
true);
664 if (body->jit_exception == NULL && rb_yjit_compiling_p) {
665 body->jit_exception_calls++;
666 if (body->jit_exception_calls == rb_yjit_call_threshold) {
667 rb_yjit_compile_iseq(iseq, ec,
true);
671 return body->jit_exception;
676jit_exec_exception(rb_execution_context_t *ec)
678 rb_jit_func_t func = jit_compile_exception(ec);
681 return func(ec, ec->cfp);
688# define jit_compile_exception(ec) ((rb_jit_func_t)0)
689# define jit_exec(ec) Qundef
690# define jit_exec_exception(ec) Qundef
693static void add_opt_method_entry(
const rb_method_entry_t *me);
695#define RB_TYPE_2_P(obj, type1, type2) \
696 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2))
697#define RB_TYPE_3_P(obj, type1, type2, type3) \
698 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2) || RB_TYPE_P(obj, type3))
700#define VM_ASSERT_TYPE(obj, type) \
701 VM_ASSERT(RB_TYPE_P(obj, type), #obj ": %s", rb_obj_info(obj))
702#define VM_ASSERT_TYPE2(obj, type1, type2) \
703 VM_ASSERT(RB_TYPE_2_P(obj, type1, type2), #obj ": %s", rb_obj_info(obj))
704#define VM_ASSERT_TYPE3(obj, type1, type2, type3) \
705 VM_ASSERT(RB_TYPE_3_P(obj, type1, type2, type3), #obj ": %s", rb_obj_info(obj))
707static const rb_box_t * current_box_on_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp);
709#include "vm_insnhelper.c"
713#include "vm_method.c"
720VALUE rb_mRubyVMFrozenCore;
721VALUE rb_block_param_proxy;
723VALUE ruby_vm_const_missing_count = 0;
724rb_vm_t *ruby_current_vm_ptr = NULL;
725rb_ractor_t *ruby_single_main_ractor;
726bool ruby_vm_keep_script_lines;
728#ifdef RB_THREAD_LOCAL_SPECIFIER
729RB_THREAD_LOCAL_SPECIFIER rb_execution_context_t *ruby_current_ec;
732RB_THREAD_LOCAL_SPECIFIER
rb_atomic_t ruby_nt_serial;
736rb_execution_context_t *
737rb_current_ec_noinline(
void)
739 return ruby_current_ec;
743rb_current_ec_set(rb_execution_context_t *ec)
745 ruby_current_ec = ec;
748rb_execution_context_t *
751 return ruby_current_ec;
754native_tls_key_t ruby_current_ec_key;
757rb_execution_context_t *
758rb_current_ec_noinline(
void)
760 return native_tls_get(ruby_current_ec_key);
767unsigned int ruby_vm_c_events_enabled = 0;
768unsigned int ruby_vm_iseq_events_enabled = 0;
770rb_serial_t ruby_vm_constant_cache_invalidations = 0;
771rb_serial_t ruby_vm_constant_cache_misses = 0;
772rb_serial_t ruby_vm_global_cvar_state = 1;
775 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
778 .call_ = vm_call_general,
788 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
791 .call_ = vm_call_uncached,
798 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
801 .call_ = vm_call_super_method,
807static void thread_free(
void *ptr);
810rb_vm_inc_const_missing_count(
void)
812 ruby_vm_const_missing_count +=1;
816rb_dtrace_setup(rb_execution_context_t *ec,
VALUE klass,
ID id,
821 if (!ec) ec = GET_EC();
822 if (!rb_ec_frame_method_id_and_class(ec, &
id, 0, &klass) || !klass)
826 klass =
RBASIC(klass)->klass;
828 else if (RCLASS_SINGLETON_P(klass)) {
829 klass = RCLASS_ATTACHED_OBJECT(klass);
830 if (
NIL_P(klass))
return FALSE;
835 const char *classname, *filename;
836 const char *methodname = rb_id2name(
id);
837 if (methodname && (filename = rb_source_location_cstr(&args->line_no)) != 0) {
839 classname =
"<unknown>";
840 args->classname = classname;
841 args->methodname = methodname;
842 args->filename = filename;
851extern unsigned int redblack_buffer_size;
879 static VALUE sym_constant_cache_invalidations, sym_constant_cache_misses, sym_global_cvar_state, sym_next_shape_id;
880 static VALUE sym_shape_cache_size;
897#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
898 S(constant_cache_invalidations);
899 S(constant_cache_misses);
900 S(global_cvar_state);
905#define SET(name, attr) \
906 if (key == sym_##name) \
907 return SERIALT2NUM(attr); \
908 else if (hash != Qnil) \
909 rb_hash_aset(hash, sym_##name, SERIALT2NUM(attr));
911 SET(constant_cache_invalidations, ruby_vm_constant_cache_invalidations);
912 SET(constant_cache_misses, ruby_vm_constant_cache_misses);
913 SET(global_cvar_state, ruby_vm_global_cvar_state);
914 SET(next_shape_id, (rb_serial_t)rb_shapes_count());
915 SET(shape_cache_size, (rb_serial_t)rb_shapes_cache_size());
919 ruby_debug_counter_show_at_exit(FALSE);
920 for (
size_t i = 0; i < RB_DEBUG_COUNTER_MAX; i++) {
921 const VALUE name = rb_sym_intern_ascii_cstr(rb_debug_counter_names[i]);
927 else if (hash !=
Qnil) {
928 rb_hash_aset(hash, name, boxed_value);
934 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(key));
943vm_set_top_stack(rb_execution_context_t *ec,
const rb_iseq_t *iseq,
const rb_box_t *box)
945 if (ISEQ_BODY(iseq)->
type != ISEQ_TYPE_TOP) {
946 rb_raise(
rb_eTypeError,
"Not a toplevel InstructionSequence");
950 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
951 rb_ec_thread_ptr(ec)->top_self,
953 (
VALUE)vm_cref_new_toplevel(ec),
954 ISEQ_BODY(iseq)->iseq_encoded, ec->cfp->sp,
955 ISEQ_BODY(iseq)->local_table_size, ISEQ_BODY(iseq)->stack_max);
959vm_set_eval_stack(rb_execution_context_t *ec,
const rb_iseq_t *iseq,
const rb_cref_t *cref,
const struct rb_block *base_block)
961 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_EVAL | VM_FRAME_FLAG_FINISH,
962 vm_block_self(base_block), VM_GUARDED_PREV_EP(vm_block_ep(base_block)),
964 ISEQ_BODY(iseq)->iseq_encoded,
965 ec->cfp->sp, ISEQ_BODY(iseq)->local_table_size,
966 ISEQ_BODY(iseq)->stack_max);
970vm_set_main_stack(rb_execution_context_t *ec,
const rb_iseq_t *iseq)
975 GetBindingPtr(toplevel_binding, bind);
978 vm_set_eval_stack(ec, iseq, 0, &bind->block);
981 if (ISEQ_BODY(iseq)->local_table_size > 0) {
982 vm_bind_update_env(toplevel_binding, bind, vm_make_env_object(ec, ec->cfp));
987rb_vm_get_binding_creatable_next_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
989 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
991 return (rb_control_frame_t *)cfp;
993 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
999rb_vm_get_ruby_level_next_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
1001 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
1002 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1003 return (rb_control_frame_t *)cfp;
1005 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1010static rb_control_frame_t *
1011vm_get_ruby_level_caller_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
1013 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1014 return (rb_control_frame_t *)cfp;
1017 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1019 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
1020 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1021 return (rb_control_frame_t *)cfp;
1024 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_PASSED) == FALSE) {
1027 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1033rb_vm_pop_cfunc_frame(
void)
1035 rb_execution_context_t *ec = GET_EC();
1036 rb_control_frame_t *cfp = ec->cfp;
1037 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
1040 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec, me->owner, me->def->original_id);
1041 vm_pop_frame(ec, cfp, cfp->ep);
1045rb_vm_rewind_cfp(rb_execution_context_t *ec, rb_control_frame_t *cfp)
1048 while (ec->cfp != cfp) {
1050 printf(
"skipped frame: %s\n", vm_frametype_name(ec->cfp));
1052 if (VM_FRAME_TYPE(ec->cfp) != VM_FRAME_MAGIC_CFUNC) {
1053 rb_vm_pop_frame(ec);
1056 rb_vm_pop_cfunc_frame();
1066 rb_vm_t *vm = GET_VM();
1069 nl->next = vm->at_exit;
1074ruby_vm_run_at_exit_hooks(rb_vm_t *vm)
1080 rb_vm_at_exit_func *func = l->func;
1094 fputs(
"---\n", stderr);
1095 ruby_debug_printf(
"envptr: %p\n", (
void *)&env->ep[0]);
1096 ruby_debug_printf(
"envval: %10p ", (
void *)env->ep[1]);
1098 ruby_debug_printf(
"ep: %10p\n", (
void *)env->ep);
1099 if (rb_vm_env_prev_env(env)) {
1100 fputs(
">>\n", stderr);
1101 check_env_value(rb_vm_env_prev_env(env));
1102 fputs(
"<<\n", stderr);
1108check_env_value(
const rb_env_t *env)
1110 if (check_env(env)) {
1113 rb_bug(
"invalid env");
1118vm_block_handler_escape(
const rb_execution_context_t *ec,
VALUE block_handler)
1120 switch (vm_block_handler_type(block_handler)) {
1121 case block_handler_type_ifunc:
1122 case block_handler_type_iseq:
1123 return rb_vm_make_proc(ec, VM_BH_TO_CAPT_BLOCK(block_handler),
rb_cProc);
1125 case block_handler_type_symbol:
1126 case block_handler_type_proc:
1127 return block_handler;
1129 VM_UNREACHABLE(vm_block_handler_escape);
1134static void rb_zjit_extract_values_from_stack_map(
const rb_execution_context_t *ec, rb_control_frame_t *cfp);
1136#define rb_zjit_extract_values_from_stack_map(ec, cfp) ((void)0)
1141vm_make_env_each(
const rb_execution_context_t *
const ec, rb_control_frame_t *
const cfp,
const VALUE *
const child_ep)
1143 const VALUE *
const ep = cfp->ep;
1144 VALUE *env_body, *env_ep;
1145 int local_size, env_size;
1147 if (VM_ENV_ESCAPED_P(ep)) {
1148 return VM_ENV_ENVVAL(ep);
1151 if (!VM_ENV_LOCAL_P(ep)) {
1152 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1153 if (!VM_ENV_ESCAPED_P(prev_ep)) {
1154 rb_control_frame_t *prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1156 while (prev_cfp->ep != prev_ep) {
1157 prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(prev_cfp);
1158 VM_ASSERT(prev_cfp->ep != NULL);
1162 vm_make_env_each(ec, prev_cfp, ep);
1163 VM_ASSERT(VM_ENV_PREV_EP(ep) == prev_cfp->ep);
1167 VM_ASSERT(VM_ENV_LOCAL_P(ep));
1168 VALUE block_handler = VM_ENV_BLOCK_HANDLER(ep);
1170 if (block_handler != VM_BLOCK_HANDLER_NONE) {
1171 VALUE blockprocval = vm_block_handler_escape(ec, block_handler);
1172 VM_STACK_ENV_WRITE(ep, VM_ENV_DATA_INDEX_SPECVAL, blockprocval);
1176 const rb_iseq_t *iseq = CFP_ISEQ(cfp);
1177 if (!VM_FRAME_RUBYFRAME_P(cfp)) {
1178 local_size = VM_ENV_DATA_SIZE;
1181 local_size = ISEQ_BODY(iseq)->local_table_size;
1182 if (ISEQ_BODY(iseq)->param.flags.forwardable && VM_ENV_LOCAL_P(cfp->ep)) {
1183 int ci_offset = local_size - ISEQ_BODY(iseq)->param.size + VM_ENV_DATA_SIZE;
1185 CALL_INFO ci = (CALL_INFO)VM_CF_LEP(cfp)[-ci_offset];
1186 local_size += vm_ci_argc(ci);
1188 local_size += VM_ENV_DATA_SIZE;
1196 if (VM_FRAME_RUBYFRAME_P(cfp) &&
1197 !rbimpl_atomic_load(&ISEQ_BODY(iseq)->jit_ep_escape_recorded, RBIMPL_ATOMIC_RELAXED)) {
1198 if (rb_yjit_enabled_p) rb_yjit_invalidate_ep_is_bp(iseq);
1199 if (rb_zjit_enabled_p) rb_zjit_invalidate_no_ep_escape(iseq);
1203 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1206 rb_zjit_extract_values_from_stack_map(ec, cfp);
1221 env_size = local_size +
1229 MEMCPY(env_body, ep - (local_size - 1 ),
VALUE, local_size);
1231 env_ep = &env_body[local_size - 1 ];
1232 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1234 env->iseq = (rb_iseq_t *)(VM_FRAME_RUBYFRAME_P(cfp) ? iseq : NULL);
1236 env->env = env_body;
1237 env->env_size = env_size;
1238 VM_ENV_FLAGS_SET(env_ep, VM_ENV_FLAG_ESCAPED | VM_ENV_FLAG_WB_REQUIRED);
1242#if defined HAVE_DECL_ATOMIC_SIGNAL_FENCE && HAVE_DECL_ATOMIC_SIGNAL_FENCE
1243 atomic_signal_fence(memory_order_seq_cst);
1252 VM_FORCE_WRITE_SPECIAL_CONST(&child_ep[VM_ENV_DATA_INDEX_SPECVAL], VM_GUARDED_PREV_EP(env_ep));
1257#if defined HAVE_DECL_ATOMIC_SIGNAL_FENCE && HAVE_DECL_ATOMIC_SIGNAL_FENCE
1258 atomic_signal_fence(memory_order_seq_cst);
1261 VM_STACK_ENV_WRITE(ep, 0, (
VALUE)env);
1264 for (i = 0; i < local_size; i++) {
1265 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1267 ep[-local_size + i] = 0;
1276vm_make_env_object(
const rb_execution_context_t *ec, rb_control_frame_t *cfp)
1278 VALUE envval = vm_make_env_each(ec, cfp, NULL);
1281 check_env_value((
const rb_env_t *)envval);
1288rb_vm_stack_to_heap(rb_execution_context_t *ec)
1290 rb_control_frame_t *cfp = ec->cfp;
1291 while ((cfp = rb_vm_get_binding_creatable_next_cfp(ec, cfp)) != 0) {
1292 vm_make_env_object(ec, cfp);
1293 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1298rb_vm_env_prev_env(
const rb_env_t *env)
1300 const VALUE *ep = env->ep;
1302 if (VM_ENV_LOCAL_P(ep)) {
1306 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1307 return VM_ENV_ENVVAL_PTR(prev_ep);
1312collect_local_variables_in_iseq(
const rb_iseq_t *iseq,
const struct local_var_list *vars)
1315 if (!iseq)
return 0;
1316 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1317 local_var_list_add(vars, ISEQ_BODY(iseq)->local_table[i]);
1326 if (VM_ENV_FLAGS(env->ep, VM_ENV_FLAG_ISOLATED))
break;
1327 collect_local_variables_in_iseq(env->iseq, vars);
1328 }
while ((env = rb_vm_env_prev_env(env)) != NULL);
1334 if (VM_ENV_ESCAPED_P(ep)) {
1335 collect_local_variables_in_env(VM_ENV_ENVVAL_PTR(ep), vars);
1344rb_vm_env_local_variables(
const rb_env_t *env)
1347 local_var_list_init(&vars);
1348 collect_local_variables_in_env(env, &vars);
1349 return local_var_list_finish(&vars);
1353rb_vm_env_numbered_parameters(
const rb_env_t *env)
1356 local_var_list_init(&vars);
1358 const rb_iseq_t *iseq = env->iseq;
1360 if (!iseq)
return 0;
1361 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1362 numparam_list_add(&vars, ISEQ_BODY(iseq)->local_table[i]);
1364 return local_var_list_finish(&vars);
1368rb_iseq_local_variables(
const rb_iseq_t *iseq)
1371 local_var_list_init(&vars);
1372 while (collect_local_variables_in_iseq(iseq, &vars)) {
1373 iseq = ISEQ_BODY(iseq)->parent_iseq;
1375 return local_var_list_finish(&vars);
1381vm_proc_create_from_captured(
VALUE klass,
1383 enum rb_block_type block_type,
1384 int8_t is_from_method, int8_t is_lambda)
1386 VALUE procval = rb_proc_alloc(klass, block_type);
1389 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), captured->ep));
1392 RB_OBJ_WRITE(procval, &proc->block.as.captured.code.val, captured->code.val);
1393 RB_OBJ_WRITE(procval, &proc->block.as.captured.self, captured->self);
1394 rb_vm_block_ep_update(procval, &proc->block, captured->ep);
1396 vm_block_type_set(&proc->block, block_type);
1397 proc->header.is_from_method = is_from_method;
1398 proc->header.is_lambda = is_lambda;
1407 switch (vm_block_type(src)) {
1408 case block_type_iseq:
1409 case block_type_ifunc:
1410 RB_OBJ_WRITE(obj, &dst->as.captured.self, src->as.captured.self);
1411 RB_OBJ_WRITE(obj, &dst->as.captured.code.val, src->as.captured.code.val);
1412 rb_vm_block_ep_update(obj, dst, src->as.captured.ep);
1414 case block_type_symbol:
1417 case block_type_proc:
1424proc_create(
VALUE klass,
const struct rb_block *block, int8_t is_from_method, int8_t is_lambda)
1426 VALUE procval = rb_proc_alloc(klass, block->type);
1429 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), vm_block_ep(block)));
1430 rb_vm_block_copy(procval, &proc->block, block);
1431 vm_block_type_set(&proc->block, block->type);
1432 proc->header.is_from_method = is_from_method;
1433 proc->header.is_lambda = is_lambda;
1439rb_proc_dup_0(
VALUE self)
1444 GetProcPtr(self, src);
1446 switch (vm_block_type(&src->block)) {
1447 case block_type_ifunc:
1448 procval = rb_func_proc_dup(self);
1451 procval = proc_create(
rb_obj_class(self), &src->block, src->header.is_from_method, src->header.is_lambda);
1455 if (src->header.is_refined) {
1457 GetProcPtr(procval, dst);
1458 dst->header.is_refined = 1;
1467rb_proc_dup(
VALUE self)
1469 VALUE procval = rb_proc_dup_0(self);
1470 VALUE recipe = rb_proc_refinements_recipe(self);
1471 if (!
NIL_P(recipe)) rb_proc_set_refinements_recipe(procval, recipe);
1479rb_proc_dup_with_iseq_and_recipe(
VALUE self,
const rb_iseq_t *iseq,
VALUE recipe)
1482 GetProcPtr(self, src);
1483 VM_ASSERT(vm_block_type(&src->block) == block_type_iseq);
1485 struct rb_block block = src->block;
1486 block.as.captured.code.iseq = iseq;
1488 VALUE procval = proc_create(
rb_obj_class(self), &block, src->header.is_from_method, src->header.is_lambda);
1489 rb_proc_set_refinements_recipe(procval, recipe);
1504 if (SIZEOF_VOIDP > SIZEOF_LONG)
1513 if (SIZEOF_VOIDP > SIZEOF_LONG)
1519static enum rb_id_table_iterator_result
1520collect_outer_variable_names(
ID id,
VALUE val,
void *ptr)
1524 if (
id == rb_intern(
"yield")) {
1529 if (val ==
Qtrue ) {
1533 store = &data->read_only;
1538 return ID_TABLE_CONTINUE;
1542env_copy(
const VALUE *src_ep,
VALUE read_only_variables)
1545 VM_ASSERT(src_env->ep == src_ep);
1548 VALUE *ep = &env_body[src_env->env_size - 2];
1549 const rb_env_t *copied_env = vm_env_new(ep, env_body, src_env->env_size, src_env->iseq);
1552 VALUE svar_val = src_ep[VM_ENV_DATA_INDEX_ME_CREF];
1553 if (imemo_type_p(svar_val, imemo_svar)) {
1563 RB_OBJ_WRITE(copied_env, &ep[VM_ENV_DATA_INDEX_ME_CREF], svar_val);
1565 ep[VM_ENV_DATA_INDEX_FLAGS] = src_ep[VM_ENV_DATA_INDEX_FLAGS] | VM_ENV_FLAG_ISOLATED;
1566 if (!VM_ENV_LOCAL_P(src_ep)) {
1567 VM_ENV_FLAGS_SET(ep, VM_ENV_FLAG_LOCAL);
1570 if (read_only_variables) {
1571 for (
int i=
RARRAY_LENINT(read_only_variables)-1; i>=0; i--) {
1575 for (
unsigned int j=0; j<body->local_table_size; j++) {
1576 if (
id == body->local_table[j]) {
1578 if (iseq_lvar_state_get(iseq_lvar_states(body), j) == lvar_reassigned) {
1579 VALUE name = rb_id2str(
id);
1580 VALUE msg = rb_sprintf(
"cannot make a shareable Proc because "
1581 "the outer variable '%" PRIsVALUE
"' may be reassigned.", name);
1586 VALUE v = src_env->env[j];
1588 VALUE name = rb_id2str(
id);
1589 VALUE msg = rb_sprintf(
"cannot make a shareable Proc because it can refer"
1590 " unshareable object %+" PRIsVALUE
" from ", v);
1592 rb_str_catf(msg,
"variable '%" PRIsVALUE
"'", name);
1605 if (!VM_ENV_LOCAL_P(src_ep)) {
1606 const VALUE *prev_ep = VM_ENV_PREV_EP(src_env->ep);
1607 const rb_env_t *new_prev_env = env_copy(prev_ep, read_only_variables);
1608 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_GUARDED_PREV_EP(new_prev_env->ep);
1610 VM_ENV_FLAGS_UNSET(ep, VM_ENV_FLAG_LOCAL);
1612 else if (VM_ENV_BOXED_P(src_ep)) {
1617 ep[VM_ENV_DATA_INDEX_SPECVAL] = src_ep[VM_ENV_DATA_INDEX_SPECVAL];
1620 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_BLOCK_HANDLER_NONE;
1631 const rb_env_t *env = env_copy(captured->ep, read_only_variables);
1632 *((
const VALUE **)&proc->block.as.captured.ep) = env->ep;
1637proc_shared_outer_variables(
struct rb_id_table *outer_variables,
const char *message)
1644 rb_id_table_foreach(outer_variables, collect_outer_variable_names, (
void *)&data);
1646 if (data.ary !=
Qfalse) {
1647 VALUE str = rb_sprintf(
"can not %s because it accesses outer variables", message);
1648 VALUE ary = data.ary;
1649 const char *sep =
" (";
1652 if (!name)
continue;
1661 else if (data.yield) {
1662 rb_raise(rb_eRactorIsolationError,
"can not %s because it uses 'yield'.", message);
1665 return data.read_only;
1669rb_proc_ractor_make_shareable(
VALUE self,
VALUE replace_self)
1671 const rb_iseq_t *iseq = vm_proc_iseq(self);
1676 if (proc->block.type != block_type_iseq) rb_raise(
rb_eRuntimeError,
"not supported yet");
1678 if (!UNDEF_P(replace_self)) {
1679 RB_OBJ_WRITE(self, &proc->block.as.captured.self, replace_self);
1683 rb_raise(rb_eRactorIsolationError,
1684 "Proc's self is not shareable: %" PRIsVALUE,
1690 if (ISEQ_BODY(iseq)->outer_variables) {
1691 read_only_variables =
1692 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables,
"make a Proc shareable");
1695 proc_isolate_env(self, proc, read_only_variables);
1696 proc->header.is_isolated = TRUE;
1699 const struct rb_block *block = vm_proc_block(self);
1700 if (block->type != block_type_symbol) rb_raise(
rb_eRuntimeError,
"not supported yet");
1702 VALUE proc_self = vm_block_self(block);
1704 rb_raise(rb_eRactorIsolationError,
1705 "Proc's self is not shareable: %" PRIsVALUE,
1715rb_vm_make_proc_lambda(
const rb_execution_context_t *ec,
const struct rb_captured_block *captured,
VALUE klass, int8_t is_lambda)
1718 enum imemo_type code_type = imemo_type(captured->code.val);
1720 if (!VM_ENV_ESCAPED_P(captured->ep)) {
1721 rb_control_frame_t *cfp = VM_CAPTURED_BLOCK_TO_CFP(captured);
1722 vm_make_env_object(ec, cfp);
1725 VM_ASSERT(VM_EP_IN_HEAP_P(ec, captured->ep));
1726 VM_ASSERT(code_type == imemo_iseq || code_type == imemo_ifunc);
1728 procval = vm_proc_create_from_captured(klass, captured,
1729 code_type == imemo_iseq ? block_type_iseq : block_type_ifunc,
1732 if (code_type == imemo_ifunc) {
1734 if (ifunc->svar_lep) {
1735 VALUE ep0 = ifunc->svar_lep[0];
1739 ifunc->svar_lep = (
VALUE *)env->ep;
1743 if (ep0 & VM_ENV_FLAG_ESCAPED) {
1747 ifunc->svar_lep = NULL;
1759rb_vm_make_binding(
const rb_execution_context_t *ec,
const rb_control_frame_t *src_cfp)
1761 rb_control_frame_t *cfp = rb_vm_get_binding_creatable_next_cfp(ec, src_cfp);
1762 rb_control_frame_t *ruby_level_cfp = rb_vm_get_ruby_level_next_cfp(ec, src_cfp);
1763 VALUE bindval, envval;
1766 if (cfp == 0 || ruby_level_cfp == 0) {
1767 rb_raise(
rb_eRuntimeError,
"Can't create Binding Object on top of Fiber.");
1769 if (!VM_FRAME_RUBYFRAME_P(src_cfp) &&
1770 !VM_FRAME_RUBYFRAME_P(RUBY_VM_PREVIOUS_CONTROL_FRAME(src_cfp))) {
1771 rb_raise(
rb_eRuntimeError,
"Cannot create Binding object for non-Ruby caller");
1774 envval = vm_make_env_object(ec, cfp);
1776 GetBindingPtr(bindval, bind);
1777 vm_bind_update_env(bindval, bind, envval);
1778 RB_OBJ_WRITE(bindval, &bind->block.as.captured.self, cfp->self);
1779 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, CFP_ISEQ(cfp));
1780 RB_OBJ_WRITE(bindval, &bind->pathobj, ISEQ_BODY(CFP_ISEQ(ruby_level_cfp))->location.pathobj);
1781 bind->no_realpath = ISEQ_BODY(CFP_ISEQ(ruby_level_cfp))->no_realpath;
1782 bind->first_lineno = rb_vm_get_sourceline(ruby_level_cfp);
1788rb_binding_add_dynavars(
VALUE bindval,
rb_binding_t *bind,
int dyncount,
const ID *dynvars)
1790 VALUE envval, pathobj = bind->pathobj;
1791 VALUE path = pathobj_path(pathobj);
1792 VALUE realpath = pathobj_realpath(pathobj, bind->no_realpath);
1795 rb_execution_context_t *ec = GET_EC();
1796 const rb_iseq_t *base_iseq, *iseq;
1797 rb_node_scope_t tmp_node;
1799 if (dyncount < 0)
return 0;
1801 base_block = &bind->block;
1802 base_iseq = vm_block_iseq(base_block);
1805 rb_ast_id_table_t *dyns =
ALLOCV(idtmp,
sizeof(rb_ast_id_table_t) + dyncount *
sizeof(
ID));
1806 dyns->size = dyncount;
1807 MEMCPY(dyns->ids, dynvars,
ID, dyncount);
1809 rb_node_init(RNODE(&tmp_node), NODE_SCOPE);
1810 tmp_node.nd_tbl = dyns;
1811 tmp_node.nd_body = 0;
1812 tmp_node.nd_parent = NULL;
1813 tmp_node.nd_args = 0;
1815 VALUE ast_value = rb_ruby_ast_new(RNODE(&tmp_node));
1818 iseq = rb_iseq_new(ast_value, ISEQ_BODY(base_iseq)->location.label, path, realpath, base_iseq, ISEQ_TYPE_EVAL);
1821 VALUE tempstr = rb_fstring_lit(
"<temp>");
1822 iseq = rb_iseq_new_top(ast_value, tempstr, tempstr, tempstr, NULL);
1824 tmp_node.nd_tbl = 0;
1827 vm_set_eval_stack(ec, iseq, 0, base_block);
1828 vm_bind_update_env(bindval, bind, envval = vm_make_env_object(ec, ec->cfp));
1829 rb_vm_pop_frame(ec);
1838invoke_block(rb_execution_context_t *ec,
const rb_iseq_t *iseq,
VALUE self,
const struct rb_captured_block *captured,
const rb_cref_t *cref,
VALUE type,
int opt_pc)
1840 int arg_size = ISEQ_BODY(iseq)->param.size;
1842 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_FINISH, self,
1843 VM_GUARDED_PREV_EP(captured->ep),
1845 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1846 ec->cfp->sp + arg_size,
1847 ISEQ_BODY(iseq)->local_table_size - arg_size,
1848 ISEQ_BODY(iseq)->stack_max);
1852invoke_bmethod(rb_execution_context_t *ec,
const rb_iseq_t *iseq,
VALUE self,
const struct rb_captured_block *captured,
const rb_callable_method_entry_t *me,
VALUE type,
int opt_pc)
1855 int arg_size = ISEQ_BODY(iseq)->param.size;
1857 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
1859 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_BMETHOD, self,
1860 VM_GUARDED_PREV_EP(captured->ep),
1862 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1863 ec->cfp->sp + 1 + arg_size,
1864 ISEQ_BODY(iseq)->local_table_size - arg_size,
1865 ISEQ_BODY(iseq)->stack_max);
1867 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_FINISH);
1870ALWAYS_INLINE(
static VALUE
1871 invoke_iseq_block_from_c(rb_execution_context_t *ec,
const struct rb_captured_block *captured,
1872 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1873 const rb_cref_t *cref,
int is_lambda,
const rb_callable_method_entry_t *me));
1876invoke_iseq_block_from_c(rb_execution_context_t *ec,
const struct rb_captured_block *captured,
1877 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1878 const rb_cref_t *cref,
int is_lambda,
const rb_callable_method_entry_t *me)
1880 const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq);
1882 VALUE type = VM_FRAME_MAGIC_BLOCK | (is_lambda ? VM_FRAME_FLAG_LAMBDA : 0);
1883 rb_control_frame_t *cfp = ec->cfp;
1884 VALUE *sp = cfp->sp;
1885 int flags = (kw_splat ? VM_CALL_KW_SPLAT : 0);
1891 if (UNLIKELY(argc > VM_ARGC_STACK_MAX) &&
1892 (VM_ARGC_STACK_MAX >= 1 ||
1894 (argc != 1 || is_lambda))) {
1895 use_argv = vm_argv_ruby_array(av, argv, &flags, &argc, kw_splat);
1898 CHECK_VM_STACK_OVERFLOW(cfp, argc + 1);
1899 vm_check_canary(ec, sp);
1901 VALUE *stack_argv = sp;
1906 cfp->sp = stack_argv + argc;
1909 opt_pc = vm_yield_setup_args(ec, iseq, argc, stack_argv, flags, passed_block_handler,
1910 (is_lambda ? arg_setup_method : arg_setup_block));
1914 invoke_block(ec, iseq, self, captured, cref,
type, opt_pc);
1917 invoke_bmethod(ec, iseq, self, captured, me,
type, opt_pc);
1924invoke_block_from_c_bh(rb_execution_context_t *ec,
VALUE block_handler,
1925 int argc,
const VALUE *argv,
1926 int kw_splat,
VALUE passed_block_handler,
const rb_cref_t *cref,
1927 int is_lambda,
int force_blockarg)
1930 switch (vm_block_handler_type(block_handler)) {
1931 case block_handler_type_iseq:
1934 return invoke_iseq_block_from_c(ec, captured, captured->self,
1935 argc, argv, kw_splat, passed_block_handler,
1936 cref, is_lambda, NULL);
1938 case block_handler_type_ifunc:
1939 return vm_yield_with_cfunc(ec, VM_BH_TO_IFUNC_BLOCK(block_handler),
1940 VM_BH_TO_IFUNC_BLOCK(block_handler)->self,
1941 argc, argv, kw_splat, passed_block_handler, NULL);
1942 case block_handler_type_symbol:
1943 return vm_yield_with_symbol(ec, VM_BH_TO_SYMBOL(block_handler),
1944 argc, argv, kw_splat, passed_block_handler);
1945 case block_handler_type_proc:
1947 VALUE procval = VM_BH_TO_PROC(block_handler);
1949 GetProcPtr(procval, po);
1950 if (po->header.is_refined) cref = rb_proc_refinements_cref_for_call(procval);
1951 if (force_blockarg == FALSE) {
1952 is_lambda = po->header.is_lambda;
1954 block_handler = vm_block_to_block_handler(&po->block);
1958 VM_UNREACHABLE(invoke_block_from_c_splattable);
1963check_block_handler(rb_execution_context_t *ec)
1965 VALUE block_handler = VM_CF_BLOCK_HANDLER(ec->cfp);
1966 vm_block_handler_verify(block_handler);
1967 if (UNLIKELY(block_handler == VM_BLOCK_HANDLER_NONE)) {
1968 rb_vm_localjump_error(
"no block given",
Qnil, 0);
1971 return block_handler;
1975vm_yield_with_cref(rb_execution_context_t *ec,
int argc,
const VALUE *argv,
int kw_splat,
const rb_cref_t *cref,
int is_lambda)
1977 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1978 argc, argv, kw_splat, VM_BLOCK_HANDLER_NONE,
1979 cref, is_lambda, FALSE);
1983vm_yield(rb_execution_context_t *ec,
int argc,
const VALUE *argv,
int kw_splat)
1985 return vm_yield_with_cref(ec, argc, argv, kw_splat, NULL, FALSE);
1989vm_yield_with_block(rb_execution_context_t *ec,
int argc,
const VALUE *argv,
VALUE block_handler,
int kw_splat)
1991 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1992 argc, argv, kw_splat, block_handler,
1993 NULL, FALSE, FALSE);
1997vm_yield_force_blockarg(rb_execution_context_t *ec,
VALUE args)
1999 return invoke_block_from_c_bh(ec, check_block_handler(ec), 1, &args,
2003ALWAYS_INLINE(
static VALUE
2004 invoke_block_from_c_proc(rb_execution_context_t *ec,
const rb_proc_t *proc,
2006 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
2007 const rb_cref_t *cref,
2008 const rb_callable_method_entry_t *me));
2011invoke_block_from_c_proc(rb_execution_context_t *ec,
const rb_proc_t *proc,
2013 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
2014 const rb_cref_t *cref,
2015 const rb_callable_method_entry_t *me)
2017 const struct rb_block *block = &proc->block;
2020 switch (vm_block_type(block)) {
2021 case block_type_iseq:
2022 return invoke_iseq_block_from_c(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, cref, is_lambda, me);
2023 case block_type_ifunc:
2024 if (kw_splat == 1) {
2025 VALUE keyword_hash = argv[argc-1];
2027 keyword_hash = rb_to_hash_type(keyword_hash);
2034 ((
VALUE *)argv)[argc-1] = rb_hash_dup(keyword_hash);
2037 return vm_yield_with_cfunc(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, me);
2038 case block_type_symbol:
2039 return vm_yield_with_symbol(ec, block->as.symbol, argc, argv, kw_splat, passed_block_handler);
2040 case block_type_proc:
2041 is_lambda = block_proc_is_lambda(block->as.proc);
2042 block = vm_proc_block(block->as.proc);
2045 VM_UNREACHABLE(invoke_block_from_c_proc);
2050vm_invoke_proc(rb_execution_context_t *ec,
rb_proc_t *proc,
VALUE self,
2051 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
2052 const rb_cref_t *cref)
2054 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, proc->header.is_lambda, cref, NULL);
2058vm_invoke_bmethod(rb_execution_context_t *ec,
rb_proc_t *proc,
VALUE self,
2059 int argc,
const VALUE *argv,
int kw_splat,
VALUE block_handler,
const rb_callable_method_entry_t *me)
2062 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, block_handler, TRUE, NULL, me);
2066rb_vm_invoke_proc(rb_execution_context_t *ec,
rb_proc_t *proc,
2067 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
2068 const rb_cref_t *cref)
2070 VALUE self = vm_block_self(&proc->block);
2071 vm_block_handler_verify(passed_block_handler);
2073 if (proc->header.is_from_method) {
2074 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
2077 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, cref);
2082rb_vm_invoke_proc_with_self(rb_execution_context_t *ec,
rb_proc_t *proc,
VALUE self,
2083 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
2084 const rb_cref_t *cref)
2086 vm_block_handler_verify(passed_block_handler);
2088 if (proc->header.is_from_method) {
2089 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
2092 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, cref);
2099rb_vm_svar_lep(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
2101 while (!CFP_PC(cfp) || !CFP_ISEQ(cfp)) {
2102 if (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_IFUNC) {
2104 return ifunc->svar_lep;
2107 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2110 if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
2115 return (
VALUE *)VM_CF_LEP(cfp);
2119vm_cfp_svar_get(
const rb_execution_context_t *ec, rb_control_frame_t *cfp,
VALUE key)
2121 return lep_svar_get(ec, rb_vm_svar_lep(ec, cfp), key);
2125vm_cfp_svar_set(
const rb_execution_context_t *ec, rb_control_frame_t *cfp,
VALUE key,
const VALUE val)
2127 lep_svar_set(ec, rb_vm_svar_lep(ec, cfp), key, val);
2131vm_svar_get(
const rb_execution_context_t *ec,
VALUE key)
2133 return vm_cfp_svar_get(ec, ec->cfp, key);
2137vm_svar_set(
const rb_execution_context_t *ec,
VALUE key,
VALUE val)
2139 vm_cfp_svar_set(ec, ec->cfp, key, val);
2145 return vm_svar_get(GET_EC(), VM_SVAR_BACKREF);
2151 vm_svar_set(GET_EC(), VM_SVAR_BACKREF, val);
2157 return vm_svar_get(GET_EC(), VM_SVAR_LASTLINE);
2163 vm_svar_set(GET_EC(), VM_SVAR_LASTLINE, val);
2167rb_lastline_set_up(
VALUE val,
unsigned int up)
2169 rb_control_frame_t * cfp = GET_EC()->cfp;
2171 for(
unsigned int i = 0; i < up; i++) {
2172 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2174 vm_cfp_svar_set(GET_EC(), cfp, VM_SVAR_LASTLINE, val);
2182 const rb_execution_context_t *ec = GET_EC();
2183 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
2186 return RSTRING_PTR(rb_iseq_path(CFP_ISEQ(cfp)));
2196 const rb_execution_context_t *ec = GET_EC();
2197 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
2200 return rb_vm_get_sourceline(cfp);
2208rb_source_location(
int *pline)
2210 const rb_execution_context_t *ec = GET_EC();
2211 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
2213 if (cfp && VM_FRAME_RUBYFRAME_P(cfp)) {
2214 if (pline) *pline = rb_vm_get_sourceline(cfp);
2215 return rb_iseq_path(CFP_ISEQ(cfp));
2218 if (pline) *pline = 0;
2224rb_source_location_cstr(
int *pline)
2226 VALUE path = rb_source_location(pline);
2227 if (
NIL_P(path))
return NULL;
2228 return RSTRING_PTR(path);
2234 const rb_execution_context_t *ec = GET_EC();
2235 return vm_ec_cref(ec);
2239rb_vm_cref_replace_with_duplicated_cref(
void)
2241 const rb_execution_context_t *ec = GET_EC();
2242 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
2243 rb_cref_t *cref = vm_cref_replace_with_duplicated_cref(cfp->ep);
2249rb_vm_cref_in_context(
VALUE self,
VALUE cbase)
2251 const rb_execution_context_t *ec = GET_EC();
2252 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
2253 const rb_cref_t *cref;
2254 if (!cfp || cfp->self != self)
return NULL;
2255 if (!vm_env_cref_by_cref(cfp->ep))
return NULL;
2256 cref = vm_get_cref(cfp->ep);
2257 if (CREF_CLASS(cref) != cbase)
return NULL;
2263debug_cref(rb_cref_t *cref)
2266 dp(CREF_CLASS(cref));
2267 printf(
"%ld\n", CREF_VISI(cref));
2268 cref = CREF_NEXT(cref);
2276 const rb_execution_context_t *ec = GET_EC();
2277 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
2282 return vm_get_cbase(cfp->ep);
2288make_localjump_error(
const char *mesg,
VALUE value,
int reason)
2320rb_vm_localjump_error(
const char *mesg,
VALUE value,
int reason)
2322 VALUE exc = make_localjump_error(mesg, value, reason);
2327rb_vm_make_jump_tag_but_local_jump(
enum ruby_tag_type state,
VALUE val)
2333 mesg =
"unexpected return";
2336 mesg =
"unexpected break";
2339 mesg =
"unexpected next";
2342 mesg =
"unexpected redo";
2346 mesg =
"retry outside of rescue clause";
2353 val = GET_EC()->tag->retval;
2355 return make_localjump_error(mesg, val, state);
2359rb_vm_jump_tag_but_local_jump(
enum ruby_tag_type state)
2361 VALUE exc = rb_vm_make_jump_tag_but_local_jump(state,
Qundef);
2363 EC_JUMP_TAG(GET_EC(), state);
2366static rb_control_frame_t *
2367next_not_local_frame(rb_control_frame_t *cfp)
2369 while (VM_ENV_LOCAL_P(cfp->ep)) {
2370 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2375NORETURN(
static void vm_iter_break(rb_execution_context_t *ec,
VALUE val));
2378vm_iter_break(rb_execution_context_t *ec,
VALUE val)
2380 rb_control_frame_t *cfp = next_not_local_frame(ec->cfp);
2381 const VALUE *ep = VM_CF_PREV_EP(cfp);
2382 const rb_control_frame_t *target_cfp = rb_vm_search_cf_from_ep(ec, cfp, ep);
2385 rb_vm_localjump_error(
"unexpected break", val, TAG_BREAK);
2388 ec->errinfo = (
VALUE)THROW_DATA_NEW(val, target_cfp, TAG_BREAK);
2389 EC_JUMP_TAG(ec, TAG_BREAK);
2395 vm_iter_break(GET_EC(),
Qnil);
2401 vm_iter_break(GET_EC(), val);
2406short ruby_vm_redefined_flag[BOP_LAST_];
2407static st_table *vm_opt_method_def_table = 0;
2408static st_table *vm_opt_mid_table = 0;
2411rb_free_vm_opt_tables(
void)
2413 st_free_table(vm_opt_method_def_table);
2414 st_free_table(vm_opt_mid_table);
2418vm_redefinition_check_flag(
VALUE klass)
2420 if (klass ==
rb_cInteger)
return INTEGER_REDEFINED_OP_FLAG;
2421 if (klass ==
rb_cFloat)
return FLOAT_REDEFINED_OP_FLAG;
2422 if (klass ==
rb_cString)
return STRING_REDEFINED_OP_FLAG;
2423 if (klass ==
rb_cArray)
return ARRAY_REDEFINED_OP_FLAG;
2424 if (klass ==
rb_cHash)
return HASH_REDEFINED_OP_FLAG;
2425 if (klass ==
rb_cSymbol)
return SYMBOL_REDEFINED_OP_FLAG;
2427 if (klass ==
rb_cTime)
return TIME_REDEFINED_OP_FLAG;
2429 if (klass ==
rb_cRegexp)
return REGEXP_REDEFINED_OP_FLAG;
2430 if (klass ==
rb_cNilClass)
return NIL_REDEFINED_OP_FLAG;
2433 if (klass ==
rb_cProc)
return PROC_REDEFINED_OP_FLAG;
2438rb_vm_check_optimizable_mid(
VALUE mid)
2440 if (!vm_opt_mid_table) {
2444 return st_lookup(vm_opt_mid_table, mid, NULL);
2448vm_redefinition_check_method_type(
const rb_method_entry_t *me)
2450 if (me->called_id != me->def->original_id) {
2454 if (METHOD_ENTRY_BASIC(me))
return TRUE;
2456 const rb_method_definition_t *def = me->def;
2457 switch (def->type) {
2458 case VM_METHOD_TYPE_CFUNC:
2459 case VM_METHOD_TYPE_OPTIMIZED:
2467vm_warn_redefinition_opt_method(
const rb_method_entry_t *me)
2470 "Redefining '%s#%s' disables interpreter and JIT optimizations",
2472 rb_id2name(me->called_id));
2480rb_vm_check_redefinition_opt_method(
const rb_method_entry_t *me,
VALUE klass,
VALUE *perf_warnings)
2488 if (vm_redefinition_check_method_type(me)) {
2489 if (st_lookup(vm_opt_method_def_table, (st_data_t)me->def, &bop)) {
2490 int flag = vm_redefinition_check_flag(klass);
2493 if (perf_warnings) {
2498 vm_warn_redefinition_opt_method(me);
2501 rb_yjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2502 rb_zjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2503 ruby_vm_redefined_flag[bop] |= (flag | ANY_REDEFINED_OP_FLAG);
2509static enum rb_id_table_iterator_result
2510check_redefined_method(
ID mid,
VALUE value,
void *data)
2513 const rb_method_entry_t *me = (rb_method_entry_t *)value;
2514 const rb_method_entry_t *newme = rb_method_entry(klass, mid);
2516 if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner, NULL);
2518 return ID_TABLE_CONTINUE;
2522rb_vm_check_redefinition_by_prepend(
VALUE klass)
2524 if (!vm_redefinition_check_flag(klass))
return;
2525 rb_id_table_foreach(RCLASS_M_TBL(RCLASS_ORIGIN(klass)), check_redefined_method, (
void *)klass);
2529add_opt_method_entry_bop(
const rb_method_entry_t *me,
ID mid,
enum ruby_basic_operators bop)
2531 st_insert(vm_opt_method_def_table, (st_data_t)me->def, (st_data_t)bop);
2532 st_insert(vm_opt_mid_table, (st_data_t)mid, (st_data_t)
Qtrue);
2536add_opt_method(
VALUE klass,
ID mid,
enum ruby_basic_operators bop)
2538 const rb_method_entry_t *me = rb_method_entry_at(klass, mid);
2540 if (me && vm_redefinition_check_method_type(me)) {
2541 add_opt_method_entry_bop(me, mid, bop);
2544 rb_bug(
"undefined optimized method: %s", rb_id2name(mid));
2548static enum ruby_basic_operators vm_redefinition_bop_for_id(
ID mid);
2551add_opt_method_entry(
const rb_method_entry_t *me)
2553 if (me && vm_redefinition_check_method_type(me)) {
2554 ID mid = me->called_id;
2555 enum ruby_basic_operators bop = vm_redefinition_bop_for_id(mid);
2556 if ((
int)bop >= 0) {
2557 add_opt_method_entry_bop(me, mid, bop);
2563rb_vm_init_redefined_flag(
void)
2566 enum ruby_basic_operators bop;
2568#define OP(mid_, bop_) (mid = id##mid_, bop = BOP_##bop_, ruby_vm_redefined_flag[bop] = 0)
2569#define C(k) add_opt_method(rb_c##k, mid, bop)
2570 OP(PLUS, PLUS), (C(Integer), C(Float), C(String), C(Array));
2571 OP(MINUS, MINUS), (C(Integer), C(Float));
2572 OP(MULT, MULT), (C(Integer), C(Float));
2573 OP(DIV, DIV), (C(Integer), C(Float));
2574 OP(MOD, MOD), (C(Integer), C(Float));
2575 OP(Eq, EQ), (C(Integer), C(Float), C(String), C(Symbol), C(NilClass), C(FalseClass), C(TrueClass));
2576 OP(Eqq, EQQ), (C(Integer), C(Float), C(Symbol), C(String),
2577 C(NilClass), C(TrueClass), C(FalseClass));
2578 OP(LT, LT), (C(Integer), C(Float));
2579 OP(LE, LE), (C(Integer), C(Float));
2580 OP(GT, GT), (C(Integer), C(Float));
2581 OP(GE, GE), (C(Integer), C(Float));
2582 OP(LTLT, LTLT), (C(String), C(Array));
2583 OP(GTGT, GTGT), (C(Integer));
2584 OP(AREF, AREF), (C(Array), C(Hash), C(Integer));
2585 OP(ASET, ASET), (C(Array), C(Hash));
2586 OP(Length, LENGTH), (C(Array), C(String), C(Hash));
2587 OP(Size, SIZE), (C(Array), C(String), C(Hash));
2588 OP(EmptyP, EMPTY_P), (C(Array), C(String), C(Hash));
2589 OP(Succ, SUCC), (C(Integer), C(String));
2590 OP(EqTilde, MATCH), (C(
Regexp), C(String));
2591 OP(Freeze, FREEZE), (C(String), C(Array), C(Hash));
2592 OP(UMinus, UMINUS), (C(String));
2593 OP(Max, MAX), (C(Array));
2594 OP(Min, MIN), (C(Array));
2595 OP(Hash, HASH), (C(Array));
2596 OP(Call, CALL), (C(Proc));
2597 OP(Yield, YIELD), (C(Proc));
2598 OP(And, AND), (C(Integer));
2599 OP(Or, OR), (C(Integer));
2600 OP(NilP,
NIL_P), (C(NilClass));
2601 OP(Cmp, CMP), (C(Integer), C(Float), C(String));
2602 OP(Default, DEFAULT), (C(Hash));
2603 OP(IncludeP, INCLUDE_P), (C(Array));
2608static enum ruby_basic_operators
2609vm_redefinition_bop_for_id(
ID mid)
2612#define OP(mid_, bop_) case id##mid_: return BOP_##bop_
2629 OP(EmptyP, EMPTY_P);
2643 OP(Default, DEFAULT);
2654vm_frametype_name(
const rb_control_frame_t *cfp)
2656 switch (VM_FRAME_TYPE(cfp)) {
2657 case VM_FRAME_MAGIC_METHOD:
return "method";
2658 case VM_FRAME_MAGIC_BLOCK:
return "block";
2659 case VM_FRAME_MAGIC_CLASS:
return "class";
2660 case VM_FRAME_MAGIC_TOP:
return "top";
2661 case VM_FRAME_MAGIC_CFUNC:
return "cfunc";
2662 case VM_FRAME_MAGIC_IFUNC:
return "ifunc";
2663 case VM_FRAME_MAGIC_EVAL:
return "eval";
2664 case VM_FRAME_MAGIC_RESCUE:
return "rescue";
2666 rb_bug(
"unknown frame");
2674 if (THROW_DATA_P(err) &&
2675 THROW_DATA_STATE(err) == TAG_BREAK &&
2676 THROW_DATA_CONSUMED_P(err) == FALSE) {
2677 return THROW_DATA_VAL(err);
2687frame_name(
const rb_control_frame_t *cfp)
2689 unsigned long type = VM_FRAME_TYPE(cfp);
2690#define C(t) if (type == VM_FRAME_MAGIC_##t) return #t
2710hook_before_rewind(rb_execution_context_t *ec,
bool cfp_returning_with_value,
int state,
struct vm_throw_data *err)
2716 const rb_iseq_t *iseq = CFP_ISEQ(ec->cfp);
2717 rb_hook_list_t *local_hooks = NULL;
2718 unsigned int local_hooks_cnt = iseq->aux.exec.local_hooks_cnt;
2719 if (RB_UNLIKELY(local_hooks_cnt > 0)) {
2720 local_hooks = rb_iseq_local_hooks(iseq, rb_ec_ractor_ptr(ec),
false);
2723 switch (VM_FRAME_TYPE(ec->cfp)) {
2724 case VM_FRAME_MAGIC_METHOD:
2725 RUBY_DTRACE_METHOD_RETURN_HOOK(ec, 0, 0);
2726 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2730 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2733 THROW_DATA_CONSUMED_SET(err);
2735 case VM_FRAME_MAGIC_BLOCK:
2736 if (VM_FRAME_BMETHOD_P(ec->cfp)) {
2737 VALUE bmethod_return_value = frame_return_value(err);
2738 if (cfp_returning_with_value) {
2740 bmethod_return_value = THROW_DATA_VAL(err);
2744 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, bmethod_return_value);
2747 ec->cfp->self, 0, 0, 0, bmethod_return_value, TRUE);
2750 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(ec->cfp);
2753 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2754 rb_vm_frame_method_entry(ec->cfp)->called_id,
2755 rb_vm_frame_method_entry(ec->cfp)->owner,
2756 bmethod_return_value);
2758 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
2759 unsigned int local_hooks_cnt = me->def->body.bmethod.local_hooks_cnt;
2760 if (UNLIKELY(local_hooks_cnt > 0)) {
2761 local_hooks = rb_method_def_local_hooks(me->def, rb_ec_ractor_ptr(ec),
false);
2764 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2765 rb_vm_frame_method_entry(ec->cfp)->called_id,
2766 rb_vm_frame_method_entry(ec->cfp)->owner,
2767 bmethod_return_value, TRUE);
2771 THROW_DATA_CONSUMED_SET(err);
2774 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2777 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2779 THROW_DATA_CONSUMED_SET(err);
2782 case VM_FRAME_MAGIC_CLASS:
2870vm_exec_handle_exception(rb_execution_context_t *ec,
enum ruby_tag_type state,
VALUE errinfo);
2872vm_exec_loop(rb_execution_context_t *ec,
enum ruby_tag_type state,
struct rb_vm_tag *tag,
VALUE result);
2875#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2877struct rb_vm_exec_context {
2878 rb_execution_context_t *
const ec;
2879 struct rb_vm_tag *
const tag;
2885vm_exec_bottom_main(
void *context)
2887 struct rb_vm_exec_context *ctx = context;
2888 rb_execution_context_t *ec = ctx->ec;
2890 ctx->result = vm_exec_loop(ec, TAG_NONE, ctx->tag, vm_exec_core(ec));
2894vm_exec_bottom_rescue(
void *context)
2896 struct rb_vm_exec_context *ctx = context;
2897 rb_execution_context_t *ec = ctx->ec;
2899 ctx->result = vm_exec_loop(ec, rb_ec_tag_state(ec), ctx->tag, ec->errinfo);
2904vm_exec(rb_execution_context_t *ec)
2912#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2913 struct rb_vm_exec_context ctx = {
2921 rb_wasm_try_catch_init(&try_catch, vm_exec_bottom_main, vm_exec_bottom_rescue, &ctx);
2923 rb_wasm_try_catch_loop_run(&try_catch, &RB_VM_TAG_JMPBUF_GET(_tag.buf));
2925 result = ctx.result;
2927 enum ruby_tag_type state;
2928 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2929 if (UNDEF_P(result = jit_exec(ec))) {
2930 result = vm_exec_core(ec);
2933 result = vm_exec_loop(ec, TAG_NONE, &_tag, result);
2936 result = vm_exec_loop(ec, state, &_tag, ec->errinfo);
2945vm_exec_loop(rb_execution_context_t *ec,
enum ruby_tag_type state,
2948 if (state == TAG_NONE) {
2952 rb_ec_raised_reset(ec, RAISED_STACKOVERFLOW | RAISED_NOMEMORY);
2953 while (UNDEF_P(result = vm_exec_handle_exception(ec, state, result))) {
2956 if (UNDEF_P(result = jit_exec_exception(ec))) {
2957 result = vm_exec_core(ec);
2960 VM_ASSERT(ec->tag == tag);
2962 if ((state = tag->state) == TAG_NONE)
break;
2963 tag->state = TAG_NONE;
2971 const uint8_t *bytes;
2973} zjit_stack_map_reader_t;
2976static inline unsigned int
2977zjit_stack_map_read_bits(zjit_stack_map_reader_t *r,
int n)
2979 size_t byte = r->pos / 8;
2980 int shift = r->pos % 8;
2981 unsigned int bits = r->bytes[byte] >> shift;
2982 if (shift + n > 8) bits |= (
unsigned int)r->bytes[
byte + 1] << (8 - shift);
2984 return bits & ((1u << n) - 1);
2987static inline int64_t
2988zjit_stack_map_read_varint(zjit_stack_map_reader_t *r)
2990 const int chunk_bits = ZJIT_STACK_MAP_VARINT_BITS + 1;
2991 const unsigned int payload_mask = (1u << ZJIT_STACK_MAP_VARINT_BITS) - 1;
2996 chunk = zjit_stack_map_read_bits(r, chunk_bits);
2997 value |= (uint64_t)(chunk & payload_mask) << shift;
2998 shift += ZJIT_STACK_MAP_VARINT_BITS;
2999 }
while (chunk >> ZJIT_STACK_MAP_VARINT_BITS);
3000 return (int64_t)value;
3005zjit_check_owned_slot(
const rb_control_frame_t *cfp,
const zjit_jit_frame_t *jit_frame,
3006 const VALUE *slot, int32_t i)
3008 if (LIKELY(slot < cfp->sp))
return;
3010 const rb_iseq_t *iseq = jit_frame->iseq;
3011 const char *label =
"(no iseq)";
3012 unsigned int line = 0;
3013 if (iseq && jit_frame->pc) {
3014 label = RSTRING_PTR(ISEQ_BODY(iseq)->location.label);
3015 line = rb_iseq_line_no(iseq, jit_frame->pc - ISEQ_BODY(iseq)->iseq_encoded);
3017 rb_bug(
"ZJIT: stack map opcode %d writes %p, at or above cfp->sp %p (ep=%p, %s:%u). "
3018 "That slot belongs to a frame pushed over this frame's operand stack.",
3019 i, (
const void *)slot, (
const void *)cfp->sp,
3020 (
const void *)cfp->ep, label, line);
3023#define zjit_check_owned_slot(cfp, jit_frame, slot, i) ((void)0)
3030zjit_frame_write_stack(
const rb_execution_context_t *ec, rb_control_frame_t *cfp,
const zjit_jit_frame_t *jit_frame)
3033 if (jit_frame->stack_map) {
3036 const rb_control_frame_t *env_cfp = cfp;
3037 bool env_escaped = VM_ENV_ESCAPED_P(env_cfp->ep);
3045 bool locals_area =
false;
3046 VALUE *stack = cfp->sp;
3047 zjit_stack_map_reader_t reader = { jit_frame->stack_map, 1 };
3048#define EAT_ONE(value) do { \
3050 if (!(locals_area && env_escaped)) { \
3051 zjit_check_owned_slot(cfp, jit_frame, stack, i); \
3055 for (int32_t i = 0;; i++) {
3056 unsigned int op = zjit_stack_map_read_bits(&reader, ZJIT_STACK_MAP_OP_BITS);
3057 if (op == ZJIT_STACK_MAP_OP_END)
break;
3059 case ZJIT_STACK_MAP_OP_VREG: {
3063 int64_t slot_index = zjit_stack_map_read_varint(&reader);
3064 EAT_ONE(((
VALUE *)cfp->jit_return)[-slot_index]);
3067 case ZJIT_STACK_MAP_OP_IMM: {
3068 VALUE value = (
VALUE)zjit_stack_map_read_varint(&reader);
3073 case ZJIT_STACK_MAP_OP_NIL:
3076 case ZJIT_STACK_MAP_OP_SKIP:
3077 stack -= zjit_stack_map_read_varint(&reader);
3079 case ZJIT_STACK_MAP_OP_BASE_PTR: {
3082 int64_t slot_index = zjit_stack_map_read_varint(&reader);
3083 int64_t stack_size = zjit_stack_map_read_varint(&reader);
3085 stack = base_ptr + stack_size;
3088 case ZJIT_STACK_MAP_OP_SKIP_VM_ENV_DATA:
3091 stack -= VM_ENV_DATA_SIZE;
3094 case ZJIT_STACK_MAP_OP_PREV_FRAME:
3098 locals_area =
false;
3099 env_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(env_cfp);
3100 env_escaped = VM_ENV_ESCAPED_P(env_cfp->ep);
3103 rb_bug(
"unknown ZJIT stackmap opcode: %u", op);
3116zjit_materialize_frames(
const rb_execution_context_t *ec, rb_control_frame_t *cfp,
bool materialize_target)
3118 if (!rb_zjit_enabled_p)
return;
3119 const rb_control_frame_t *end_cfp = ec->tag->cfp;
3120 VM_ASSERT(cfp <= end_cfp);
3133 if (cfp == end_cfp && !materialize_target)
break;
3135 if (CFP_ZJIT_FRAME_P(cfp)) {
3136 const zjit_jit_frame_t *jit_frame = CFP_ZJIT_FRAME(cfp);
3137 cfp->pc = jit_frame->pc;
3138 cfp->_iseq = (rb_iseq_t *)jit_frame->iseq;
3139 if (ZJIT_FRAME_MATERIALIZE_BLOCK_CODE_P(jit_frame)) {
3140 cfp->block_code = NULL;
3142 zjit_frame_write_stack(ec, cfp, jit_frame);
3143 cfp->jit_return = 0;
3145 if (end_cfp == cfp)
break;
3146 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3151rb_zjit_materialize_frames(
const rb_execution_context_t *ec, rb_control_frame_t *cfp)
3153 zjit_materialize_frames(ec, cfp,
true);
3157rb_zjit_materialize_frames_for_longjmp(
const rb_execution_context_t *ec, rb_control_frame_t *cfp)
3161 zjit_materialize_frames(ec, cfp, !ec->tag->zjit_frame_active);
3168rb_zjit_extract_values_from_stack_map(
const rb_execution_context_t *ec, rb_control_frame_t *cfp)
3170 if (!rb_zjit_enabled_p)
return;
3171 if (!CFP_ZJIT_FRAME_P(cfp))
return;
3183 rb_control_frame_t *innermost = cfp;
3184 while (innermost != ec->cfp) {
3185 rb_control_frame_t *callee = RUBY_VM_NEXT_CONTROL_FRAME(innermost);
3189 zjit_frame_write_stack(ec, innermost, CFP_ZJIT_FRAME(innermost));
3194vm_exec_handle_exception(rb_execution_context_t *ec,
enum ruby_tag_type state,
VALUE errinfo)
3202 unsigned long epc, cont_pc, cont_sp;
3203 const rb_iseq_t *catch_iseq;
3205 const rb_control_frame_t *escape_cfp;
3207 cont_pc = cont_sp = 0;
3210 while (CFP_PC(ec->cfp) == 0 || CFP_ISEQ(ec->cfp) == 0) {
3211 if (UNLIKELY(VM_FRAME_TYPE(ec->cfp) == VM_FRAME_MAGIC_CFUNC)) {
3213 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
3214 rb_vm_frame_method_entry(ec->cfp)->called_id,
3215 rb_vm_frame_method_entry(ec->cfp)->owner,
Qnil);
3216 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec,
3217 rb_vm_frame_method_entry(ec->cfp)->owner,
3218 rb_vm_frame_method_entry(ec->cfp)->def->original_id);
3220 rb_vm_pop_frame(ec);
3223 rb_control_frame_t *
const cfp = ec->cfp;
3224 epc = CFP_PC(cfp) - ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded;
3227 if (state == TAG_BREAK || state == TAG_RETURN) {
3228 escape_cfp = THROW_DATA_CATCH_FRAME(err);
3230 if (cfp == escape_cfp) {
3231 if (state == TAG_RETURN) {
3232 if (!VM_FRAME_FINISHED_P(cfp)) {
3233 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
3234 THROW_DATA_STATE_SET(err, state = TAG_BREAK);
3237 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3238 if (ct)
for (i = 0; i < ct->size; i++) {
3239 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3240 if (entry->start < epc && entry->end >= epc) {
3241 if (entry->type == CATCH_TYPE_ENSURE) {
3242 catch_iseq = entry->iseq;
3243 cont_pc = entry->cont;
3244 cont_sp = entry->sp;
3249 if (catch_iseq == NULL) {
3251 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
3253 hook_before_rewind(ec,
true, state, err);
3254 rb_vm_pop_frame(ec);
3255 return THROW_DATA_VAL(err);
3262 *cfp->sp++ = THROW_DATA_VAL(err);
3264 rb_zjit_materialize_frames(ec, cfp);
3270 if (state == TAG_RAISE) {
3271 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3272 if (ct)
for (i = 0; i < ct->size; i++) {
3273 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3274 if (entry->start < epc && entry->end >= epc) {
3276 if (entry->type == CATCH_TYPE_RESCUE ||
3277 entry->type == CATCH_TYPE_ENSURE) {
3278 catch_iseq = entry->iseq;
3279 cont_pc = entry->cont;
3280 cont_sp = entry->sp;
3286 else if (state == TAG_RETRY) {
3287 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3288 if (ct)
for (i = 0; i < ct->size; i++) {
3289 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3290 if (entry->start < epc && entry->end >= epc) {
3292 if (entry->type == CATCH_TYPE_ENSURE) {
3293 catch_iseq = entry->iseq;
3294 cont_pc = entry->cont;
3295 cont_sp = entry->sp;
3298 else if (entry->type == CATCH_TYPE_RETRY) {
3299 const rb_control_frame_t *escape_cfp;
3300 escape_cfp = THROW_DATA_CATCH_FRAME(err);
3301 if (cfp == escape_cfp) {
3302 rb_zjit_materialize_frames(ec, cfp);
3303 cfp->pc = ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded + entry->cont;
3311 else if ((state == TAG_BREAK && !escape_cfp) ||
3312 (state == TAG_REDO) ||
3313 (state == TAG_NEXT)) {
3314 type = (
const enum rb_catch_type[TAG_MASK]) {
3315 [TAG_BREAK] = CATCH_TYPE_BREAK,
3316 [TAG_NEXT] = CATCH_TYPE_NEXT,
3317 [TAG_REDO] = CATCH_TYPE_REDO,
3321 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3322 if (ct)
for (i = 0; i < ct->size; i++) {
3323 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3325 if (entry->start < epc && entry->end >= epc) {
3326 if (entry->type == CATCH_TYPE_ENSURE) {
3327 catch_iseq = entry->iseq;
3328 cont_pc = entry->cont;
3329 cont_sp = entry->sp;
3332 else if (entry->type ==
type) {
3333 rb_zjit_materialize_frames(ec, cfp);
3334 cfp->pc = ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded + entry->cont;
3335 cfp->sp = vm_base_ptr(cfp) + entry->sp;
3337 if (state != TAG_REDO) {
3338 *cfp->sp++ = THROW_DATA_VAL(err);
3341 VM_ASSERT(ec->tag->state == TAG_NONE);
3348 ct = ISEQ_BODY(CFP_ISEQ(cfp))->catch_table;
3349 if (ct)
for (i = 0; i < ct->size; i++) {
3350 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
3351 if (entry->start < epc && entry->end >= epc) {
3353 if (entry->type == CATCH_TYPE_ENSURE) {
3354 catch_iseq = entry->iseq;
3355 cont_pc = entry->cont;
3356 cont_sp = entry->sp;
3363 if (catch_iseq != NULL) {
3365 const int arg_size = 1;
3367 rb_iseq_check(catch_iseq);
3368 rb_zjit_materialize_frames(ec, cfp);
3369 cfp->sp = vm_base_ptr(cfp) + cont_sp;
3370 cfp->pc = ISEQ_BODY(CFP_ISEQ(cfp))->iseq_encoded + cont_pc;
3373 cfp->sp[0] = (
VALUE)err;
3374 vm_push_frame(ec, catch_iseq, VM_FRAME_MAGIC_RESCUE,
3376 VM_GUARDED_PREV_EP(cfp->ep),
3378 ISEQ_BODY(catch_iseq)->iseq_encoded,
3379 cfp->sp + arg_size ,
3380 ISEQ_BODY(catch_iseq)->local_table_size - arg_size,
3381 ISEQ_BODY(catch_iseq)->stack_max);
3384 ec->tag->state = TAG_NONE;
3390 hook_before_rewind(ec, (cfp == escape_cfp), state, err);
3392 if (VM_FRAME_FINISHED_P(ec->cfp)) {
3393 rb_vm_pop_frame(ec);
3394 ec->errinfo = (
VALUE)err;
3395 rb_vm_tag_jmpbuf_deinit(&ec->tag->buf);
3396 ec->tag = ec->tag->prev;
3397 EC_JUMP_TAG(ec, state);
3400 rb_vm_pop_frame(ec);
3409rb_iseq_eval(
const rb_iseq_t *iseq,
const rb_box_t *box)
3411 rb_execution_context_t *ec = GET_EC();
3413 vm_set_top_stack(ec, iseq, box);
3419rb_iseq_eval_main(
const rb_iseq_t *iseq)
3421 rb_execution_context_t *ec = GET_EC();
3423 vm_set_main_stack(ec, iseq);
3429rb_vm_control_frame_id_and_class(
const rb_control_frame_t *cfp,
ID *idp,
ID *called_idp,
VALUE *klassp)
3431 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
3434 if (idp) *idp = me->def->original_id;
3435 if (called_idp) *called_idp = me->called_id;
3436 if (klassp) *klassp = me->owner;
3445rb_ec_frame_method_id_and_class(
const rb_execution_context_t *ec,
ID *idp,
ID *called_idp,
VALUE *klassp)
3447 return rb_vm_control_frame_id_and_class(ec->cfp, idp, called_idp, klassp);
3453 return rb_ec_frame_method_id_and_class(GET_EC(), idp, 0, klassp);
3460 rb_execution_context_t *ec = GET_EC();
3461 const rb_control_frame_t *reg_cfp = ec->cfp;
3462 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
3463 const rb_box_t *box = rb_current_box();
3466 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
3467 recv, GC_GUARDED_PTR(box),
3468 (
VALUE)vm_cref_new_toplevel(ec),
3469 0, reg_cfp->sp, 0, 0);
3473 rb_vm_pop_frame(ec);
3481 VALUE filename,
const rb_box_t *box)
3483 rb_execution_context_t *ec = GET_EC();
3484 const rb_control_frame_t *reg_cfp = ec->cfp;
3485 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
3488 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
3489 recv, GC_GUARDED_PTR(box),
3490 (
VALUE)vm_cref_new_toplevel(ec),
3491 0, reg_cfp->sp, 0, 0);
3493 val = (*func)(arg1, arg2);
3495 rb_vm_pop_frame(ec);
3500rb_vm_frame_flag_set_box_require(
const rb_execution_context_t *ec)
3502 VM_ASSERT(rb_box_available());
3503 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_BOX_REQUIRE);
3506static const rb_box_t *current_box_on_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp);
3517static const rb_box_t *
3518caller_user_box_on_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
3520 const rb_control_frame_t *
const eocfp = RUBY_VM_END_CONTROL_FRAME(ec);
3522 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, eocfp)) {
3523 const rb_box_t *box = current_box_on_cfp(ec, cfp);
3524 if (BOX_USER_P(box))
3526 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3531static const rb_box_t *
3532current_box_on_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
3534 rb_callable_method_entry_t *cme;
3535 const rb_box_t *box;
3536 const VALUE *lep = VM_EP_RUBY_LEP(ec, cfp);
3537 VM_BOX_ASSERT(lep,
"lep should be valid");
3538 VM_BOX_ASSERT(rb_box_available(),
"box should be available here");
3540 if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_METHOD) || VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_CFUNC)) {
3541 cme = check_method_entry(lep[VM_ENV_DATA_INDEX_ME_CREF], TRUE);
3542 VM_BOX_ASSERT(cme,
"cme should be valid");
3543 VM_BOX_ASSERT(cme->def,
"cme->def shold be valid");
3544 if (cme->def->type == VM_METHOD_TYPE_ISEQ &&
3545 (ISEQ_BODY(cme->def->body.iseq.
iseqptr)->builtin_attrs & BUILTIN_ATTR_CALLER_USER_BOX)) {
3546 const rb_control_frame_t *owner_cfp = rb_vm_search_cf_from_ep(ec, cfp, lep);
3548 box = caller_user_box_on_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(owner_cfp));
3553 return cme->def->box;
3555 else if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_TOP) || VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_CLASS)) {
3556 VM_BOX_ASSERT(VM_ENV_LOCAL_P(lep),
"lep should be local on MAGIC_TOP or MAGIC_CLASS frames");
3557 return VM_ENV_BOX(lep);
3559 else if (VM_ENV_FRAME_TYPE_P(lep, VM_FRAME_MAGIC_DUMMY)) {
3562 box = rb_main_box();
3565 return rb_root_box();
3569 rb_bug(
"BUG: Local ep without cme/box, flags: %08lX", (
unsigned long)lep[VM_ENV_DATA_INDEX_FLAGS]);
3575rb_vm_current_box(
const rb_execution_context_t *ec)
3577 return current_box_on_cfp(ec, ec->cfp);
3580static const rb_control_frame_t *
3581find_loader_control_frame(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp,
const rb_control_frame_t *end_cfp)
3583 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp)) {
3584 if (!VM_ENV_FRAME_TYPE_P(cfp->ep, VM_FRAME_MAGIC_CFUNC))
3586 if (!BOX_MASTER_P(current_box_on_cfp(ec, cfp)))
3588 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3590 VM_ASSERT(RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp));
3595rb_vm_loading_box(
const rb_execution_context_t *ec)
3597 const rb_control_frame_t *cfp, *current_cfp, *end_cfp;
3599 if (!rb_box_available() || !ec)
3600 return rb_root_box();
3604 end_cfp = RUBY_VM_END_CONTROL_FRAME(ec);
3606 while (RUBY_VM_VALID_CONTROL_FRAME_P(cfp, end_cfp)) {
3607 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_BOX_REQUIRE)) {
3608 if (
RTEST(cfp->self) && BOX_OBJ_P(cfp->self)) {
3610 return rb_get_box_t(cfp->self);
3613 cfp = find_loader_control_frame(ec, cfp, end_cfp);
3614 return current_box_on_cfp(ec, cfp);
3616 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3619 return current_box_on_cfp(ec, current_cfp);
3625rb_vm_update_references(
void *ptr)
3630 rb_gc_update_moved(&vm->self);
3631 rb_gc_update_moved(&vm->orig_progname);
3632 rb_gc_update_moved(&vm->cc_refinement_set);
3635 rb_box_gc_update_references(vm->root_box);
3637 rb_box_gc_update_references(vm->main_box);
3639 rb_gc_update_values(RUBY_NSIG, vm->trap_list.cmd);
3641 if (vm->coverages) {
3642 rb_gc_update_moved(&vm->coverages);
3643 rb_gc_update_moved(&vm->cme2counter);
3644 rb_gc_update_moved(&vm->me_set);
3650rb_vm_each_stack_value(
void *ptr,
void (*cb)(
VALUE,
void*),
void *ctx)
3655 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3656 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3657 rb_ractor_status_p(r, ractor_running));
3658 if (r->threads.cnt > 0) {
3659 rb_thread_t *th = 0;
3660 ccan_list_for_each(&r->threads.set, th, lt_node) {
3661 VM_ASSERT(th != NULL);
3662 rb_execution_context_t * ec = th->ec;
3664 VALUE *p = ec->vm_stack;
3665 VALUE *sp = ec->cfp->sp;
3679static enum rb_id_table_iterator_result
3680vm_mark_negative_cme(
VALUE val,
void *dmy)
3683 return ID_TABLE_CONTINUE;
3688rb_vm_mark(
void *ptr)
3690 RUBY_MARK_ENTER(
"vm");
3691 RUBY_GC_INFO(
"-------------------------------------------------\n");
3697 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3699 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3700 rb_ractor_status_p(r, ractor_running));
3701 rb_gc_mark(rb_ractor_self(r));
3704 rb_gc_mark_movable(vm->self);
3707 rb_box_entry_mark(vm->root_box);
3710 rb_box_entry_mark(vm->main_box);
3713 rb_gc_mark_movable(vm->orig_progname);
3714 rb_gc_mark_movable(vm->coverages);
3715 rb_gc_mark_movable(vm->cme2counter);
3716 rb_gc_mark_movable(vm->me_set);
3717 rb_gc_mark_movable(vm->cc_refinement_set);
3719 rb_hook_list_mark(&vm->global_hooks);
3721 rb_id_table_foreach_values(&vm->negative_cme_table, vm_mark_negative_cme, NULL);
3722 rb_mark_tbl_no_pin(&vm->overloaded_cme_table);
3723 for (i=0; i<VM_GLOBAL_CC_CACHE_TABLE_SIZE; i++) {
3724 const struct rb_callcache *cc = vm->global_cc_cache_table[i];
3727 if (!vm_cc_invalidated_p(cc)) {
3728 rb_gc_mark((
VALUE)cc);
3731 vm->global_cc_cache_table[i] = NULL;
3737 RUBY_MARK_LEAVE(
"vm");
3740#undef rb_vm_register_special_exception
3742rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp,
VALUE cls,
VALUE mesg)
3744 rb_vm_t *vm = GET_VM();
3747 ((
VALUE *)vm->special_exceptions)[sp] = exc;
3748 rb_vm_register_global_object(exc);
3751void rb_objspace_free_objects(
void *
objspace);
3760 void rb_thread_sched_wait_winding(rb_vm_t *vm);
3761 rb_thread_sched_wait_winding(vm);
3764 RUBY_FREE_ENTER(
"vm");
3765 ruby_vm_during_cleanup =
true;
3766 rb_gc_stash_cleanup_objspace();
3769 rb_thread_t *th = vm->ractor.main_thread;
3771 if (rb_free_at_exit) {
3772 rb_free_encoded_insn_data();
3773 rb_free_global_enc_table();
3774 rb_free_loaded_builtin_table();
3775 rb_free_global_symbol_table();
3777 rb_free_shared_fiber_pool();
3778 rb_free_transcoder_table();
3779 rb_free_vm_opt_tables();
3781 rb_free_rb_global_tbl();
3783 rb_id_table_free_items(&vm->negative_cme_table);
3784 st_free_embedded_table(&vm->overloaded_cme_table);
3789 st_free_embedded_table(&vm->static_ext_inits);
3791 rb_id_table_free_items(&vm->constant_cache);
3792 set_free_embedded_table(&vm->unused_block_warning_table);
3794 rb_thread_free_native_thread(th);
3796#ifndef HAVE_SETPROCTITLE
3797 ruby_free_proctitle();
3801 rb_fiber_reset_root_local_storage(th);
3805 void *
objspace = vm->ractor.main_ractor ? vm->ractor.main_ractor->objspace : NULL;
3807 rb_vm_living_threads_init(vm);
3808 ruby_vm_run_at_exit_hooks(vm);
3809 st_free_embedded_table(&vm->ci_table);
3810 RB_ALTSTACK_FREE(vm->main_altstack);
3813 if (rb_free_at_exit) {
3814 rb_objspace_free_objects(
objspace);
3815 rb_free_generic_fields_tbl_();
3816 rb_free_default_rand_key();
3821 if (rb_free_at_exit) {
3822 free(vm->gc.registered_addrs.registry);
3827 ruby_current_vm_ptr = NULL;
3829 if (rb_free_at_exit) {
3831 rb_yjit_free_at_exit();
3835 rb_box_unload_local_extensions();
3837 RUBY_FREE_LEAVE(
"vm");
3844static enum rb_id_table_iterator_result
3845vm_memsize_constant_cache_i(
ID id,
VALUE ics,
void *size)
3847 *((
size_t *) size) += rb_set_memsize((
set_table *) ics);
3848 return ID_TABLE_CONTINUE;
3855vm_memsize_constant_cache(
void)
3857 rb_vm_t *vm = GET_VM();
3858 size_t size = rb_id_table_memsize(&vm->constant_cache) -
sizeof(
struct rb_id_table);
3860 rb_id_table_foreach(&vm->constant_cache, vm_memsize_constant_cache_i, &size);
3871 at_exit = at_exit->next;
3880vm_memsize_builtin_function_table(
const struct rb_builtin_function *builtin_function_table)
3888vm_memsize(
const void *ptr)
3890 rb_vm_t *vm = GET_VM();
3894 rb_vm_memsize_postponed_job_queue() +
3895 vm_memsize_at_exit_list(vm->at_exit) +
3896 (rb_st_memsize(&vm->ci_table) -
sizeof(
struct st_table)) +
3897 vm_memsize_builtin_function_table(vm->builtin_function_table) +
3898 (rb_id_table_memsize(&vm->negative_cme_table) -
sizeof(
struct rb_id_table)) +
3899 (rb_st_memsize(&vm->overloaded_cme_table) -
sizeof(
struct st_table)) +
3900 vm_memsize_constant_cache()
3911 {0, 0, vm_memsize,},
3912 0, 0, RUBY_TYPED_THREAD_SAFE_FREE
3915#define vm_data_type ruby_vm_data_type
3918vm_default_params(
void)
3920 rb_vm_t *vm = GET_VM();
3921 VALUE result = rb_hash_new_capa(4);
3922#define SET(name) rb_hash_aset(result, ID2SYM(rb_intern(#name)), SIZET2NUM(vm->default_params.name));
3923 SET(thread_vm_stack_size);
3924 SET(thread_machine_stack_size);
3925 SET(fiber_vm_stack_size);
3926 SET(fiber_machine_stack_size);
3933get_param(
const char *name,
size_t default_value,
size_t min_value)
3936 size_t result = default_value;
3937 if ((envval = getenv(name)) != 0) {
3938 long val = atol(envval);
3939 if (val < (
long)min_value) {
3940 val = (long)min_value;
3942 result = (size_t)(((val -1 + RUBY_VM_SIZE_ALIGN) / RUBY_VM_SIZE_ALIGN) * RUBY_VM_SIZE_ALIGN);
3944 if (0) ruby_debug_printf(
"%s: %"PRIuSIZE
"\n", name, result);
3950check_machine_stack_size(
size_t *sizep)
3952#ifdef PTHREAD_STACK_MIN
3953 size_t size = *sizep;
3956#ifdef PTHREAD_STACK_MIN
3957 if (size < (
size_t)PTHREAD_STACK_MIN) {
3958 *sizep = (size_t)PTHREAD_STACK_MIN * 2;
3964vm_default_params_setup(rb_vm_t *vm)
3966 vm->default_params.thread_vm_stack_size =
3967 get_param(
"RUBY_THREAD_VM_STACK_SIZE",
3968 RUBY_VM_THREAD_VM_STACK_SIZE,
3969 RUBY_VM_THREAD_VM_STACK_SIZE_MIN);
3971 vm->default_params.thread_machine_stack_size =
3972 get_param(
"RUBY_THREAD_MACHINE_STACK_SIZE",
3973 RUBY_VM_THREAD_MACHINE_STACK_SIZE,
3974 RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN);
3976 vm->default_params.fiber_vm_stack_size =
3977 get_param(
"RUBY_FIBER_VM_STACK_SIZE",
3978 RUBY_VM_FIBER_VM_STACK_SIZE,
3979 RUBY_VM_FIBER_VM_STACK_SIZE_MIN);
3981 vm->default_params.fiber_machine_stack_size =
3982 get_param(
"RUBY_FIBER_MACHINE_STACK_SIZE",
3983 RUBY_VM_FIBER_MACHINE_STACK_SIZE,
3984 RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN);
3987 check_machine_stack_size(&vm->default_params.thread_machine_stack_size);
3988 check_machine_stack_size(&vm->default_params.fiber_machine_stack_size);
3992vm_init2(rb_vm_t *vm)
3994 rb_vm_living_threads_init(vm);
3995 vm->thread_report_on_exception = 1;
3996 vm->src_encoding_index = -1;
3998 vm_default_params_setup(vm);
4002rb_execution_context_update(rb_execution_context_t *ec)
4008 VALUE *p = ec->vm_stack;
4009 VALUE *sp = ec->cfp->sp;
4010 rb_control_frame_t *cfp = ec->cfp;
4011 rb_control_frame_t *limit_cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
4015 if (!rb_zjit_enabled_p) {
4016 for (i = 0; i < (long)(sp - p); i++) {
4017 rb_gc_update_moved(&p[i]);
4021 while (cfp != limit_cfp) {
4022 const VALUE *ep = cfp->ep;
4023 rb_gc_update_moved(&cfp->self);
4024 if (CFP_ZJIT_FRAME_P(cfp)) {
4025 const zjit_jit_frame_t *jit_frame = CFP_ZJIT_FRAME(cfp);
4026 rb_zjit_jit_frame_update_references((zjit_jit_frame_t *)jit_frame);
4031 if (!ZJIT_FRAME_MATERIALIZE_BLOCK_CODE_P(jit_frame)) {
4032 rb_gc_update_moved_ptr(&cfp->block_code);
4036 rb_gc_update_moved_ptr(&cfp->_iseq);
4037 rb_gc_update_moved_ptr(&cfp->block_code);
4040 if (!VM_ENV_LOCAL_P(ep)) {
4041 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
4042 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
4043 rb_gc_update_moved((
VALUE *)&prev_ep[VM_ENV_DATA_INDEX_ENV]);
4046 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
4047 rb_gc_update_moved((
VALUE *)&ep[VM_ENV_DATA_INDEX_ENV]);
4048 rb_gc_update_moved((
VALUE *)&ep[VM_ENV_DATA_INDEX_ME_CREF]);
4052 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
4056 rb_gc_update_moved(&ec->storage);
4058 rb_gc_update_moved(&ec->gen_fields_cache.obj);
4059 rb_gc_update_moved(&ec->gen_fields_cache.fields_obj);
4062static enum rb_id_table_iterator_result
4063mark_local_storage_i(
VALUE local,
void *data)
4065 rb_gc_mark_ctx((
const struct rb_gc_mark_ctx *)data, local);
4066 return ID_TABLE_CONTINUE;
4070rb_execution_context_mark_ctx(
const struct rb_gc_mark_ctx *ctx,
const rb_execution_context_t *ec)
4075 VALUE *p = ec->vm_stack;
4076 VALUE *sp = ec->cfp->sp;
4077 rb_control_frame_t *cfp = ec->cfp;
4078 rb_control_frame_t *limit_cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
4080 for (
long i = 0; i < (long)(sp - p); i++) {
4081 if (rb_zjit_enabled_p) {
4084 rb_gc_mark_maybe_ctx(ctx, p[i]);
4087 rb_gc_mark_movable_ctx(ctx, p[i]);
4091 while (cfp != limit_cfp) {
4092 const VALUE *ep = cfp->ep;
4093 VM_ASSERT(!!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) == vm_ep_in_heap_p_(ec, ep));
4095 rb_gc_mark_movable_ctx(ctx, cfp->self);
4096 if (CFP_ZJIT_FRAME_P(cfp)) {
4097 const zjit_jit_frame_t *jit_frame = CFP_ZJIT_FRAME(cfp);
4098 rb_gc_mark_movable_ctx(ctx, (
VALUE)jit_frame->iseq);
4103 if (!ZJIT_FRAME_MATERIALIZE_BLOCK_CODE_P(jit_frame)) {
4104 rb_gc_mark_movable_ctx(ctx, (
VALUE)cfp->block_code);
4108 rb_gc_mark_movable_ctx(ctx, (
VALUE)cfp->_iseq);
4109 rb_gc_mark_movable_ctx(ctx, (
VALUE)cfp->block_code);
4112 if (VM_ENV_LOCAL_P(ep) && VM_ENV_BOXED_P(ep)) {
4113 const rb_box_t *box = VM_ENV_BOX(ep);
4114 if (BOX_USER_P(box)) {
4115 rb_gc_mark_movable_ctx(ctx, box->box_object);
4119 if (!VM_ENV_LOCAL_P(ep)) {
4120 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
4121 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
4122 rb_gc_mark_movable_ctx(ctx, prev_ep[VM_ENV_DATA_INDEX_ENV]);
4125 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
4126 rb_gc_mark_movable_ctx(ctx, ep[VM_ENV_DATA_INDEX_ENV]);
4127 rb_gc_mark_ctx(ctx, ep[VM_ENV_DATA_INDEX_ME_CREF]);
4131 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
4136 if (ec->machine.stack_start && ec->machine.stack_end &&
4138 ec != rb_gc_get_ec()) {
4139 rb_gc_mark_machine_context_ctx(ctx, ec);
4142 rb_gc_mark_ctx(ctx, ec->errinfo);
4143 rb_gc_mark_ctx(ctx, ec->root_svar);
4144 if (ec->local_storage) {
4145 rb_id_table_foreach_values(ec->local_storage, mark_local_storage_i, (
void *)ctx);
4147 rb_gc_mark_ctx(ctx, ec->local_storage_recursive_hash);
4148 rb_gc_mark_ctx(ctx, ec->local_storage_recursive_hash_for_trace);
4149 rb_gc_mark_ctx(ctx, ec->private_const_reference);
4151 rb_gc_mark_movable_ctx(ctx, ec->storage);
4154void rb_fiber_mark_self(
const struct rb_gc_mark_ctx *ctx,
const rb_fiber_t *fib);
4155void rb_fiber_update_self(rb_fiber_t *fib);
4156void rb_threadptr_root_fiber_setup(rb_thread_t *th);
4157void rb_root_fiber_obj_setup(rb_thread_t *th,
void *
objspace);
4158void rb_threadptr_root_fiber_release(rb_thread_t *th);
4161thread_compact(
void *ptr)
4163 rb_thread_t *th = ptr;
4165 rb_gc_update_moved(&th->self);
4172rb_thread_mark_owned_roots(
const struct rb_gc_mark_ctx *ctx, rb_thread_t *th)
4175 switch (th->invoke_type) {
4176 case thread_invoke_type_proc:
4177 case thread_invoke_type_ractor_proc:
4178 rb_gc_mark_ctx(ctx, th->invoke_arg.proc.proc);
4179 rb_gc_mark_ctx(ctx, th->invoke_arg.proc.args);
4181 case thread_invoke_type_func:
4182 rb_gc_mark_maybe_ctx(ctx, (
VALUE)th->invoke_arg.func.arg);
4188 rb_gc_mark_ctx(ctx, th->thgroup);
4189 rb_gc_mark_ctx(ctx, th->value);
4190 rb_gc_mark_ctx(ctx, th->pending_interrupt_queue);
4191 rb_gc_mark_ctx(ctx, th->pending_interrupt_mask_stack);
4192 rb_gc_mark_ctx(ctx, th->top_self);
4193 rb_gc_mark_ctx(ctx, th->top_wrapper);
4194 rb_gc_mark_ctx(ctx, th->last_status);
4195 rb_gc_mark_ctx(ctx, th->locking_mutex);
4196 rb_gc_mark_ctx(ctx, th->name);
4197 rb_gc_mark_ctx(ctx, th->scheduler);
4199 rb_threadptr_interrupt_exec_task_mark(th);
4203thread_mark(
void *ptr)
4205 rb_thread_t *th = ptr;
4206 const struct rb_gc_mark_ctx ctx = rb_gc_current_mark_ctx();
4207 RUBY_MARK_ENTER(
"thread");
4211 rb_fiber_mark_self(&ctx, th->ec->fiber_ptr);
4217 if (th->ractor) rb_gc_mark_ctx(&ctx, rb_ractor_self(th->ractor));
4218 if (th->root_fiber) rb_fiber_mark_self(&ctx, th->root_fiber);
4220 RUBY_ASSERT(th->ec == NULL || th->ec == rb_fiberptr_get_ec(th->ec->fiber_ptr));
4222 rb_thread_mark_owned_roots(&ctx, th);
4224 RUBY_MARK_LEAVE(
"thread");
4227void rb_threadptr_sched_free(rb_thread_t *th);
4230thread_free(
void *ptr)
4232 rb_thread_t *th = ptr;
4237 if (th->ec != NULL && th->ec == rb_current_execution_context(
false)) {
4241 rb_thread_free_body(ptr);
4245rb_thread_free_body(
void *ptr)
4247 rb_thread_t *th = ptr;
4248 RUBY_FREE_ENTER(
"thread");
4250 rb_threadptr_sched_free(th);
4255 if (th->locking_mutex !=
Qfalse) {
4256 rb_bug(
"thread_free: locking_mutex must be NULL (%p:%p)", (
void *)th, (
void *)th->locking_mutex);
4258 if (th->keeping_mutexes != NULL) {
4259 rb_bug(
"thread_free: keeping_mutexes must be NULL (%p:%p)", (
void *)th, (
void *)th->keeping_mutexes);
4262 ruby_xfree(th->specific_storage);
4264 if (th->vm && th->vm->ractor.main_thread == th) {
4265 RUBY_GC_INFO(
"MRI main thread\n");
4270 if (!th->main_thread) {
4275 RUBY_FREE_LEAVE(
"thread");
4279thread_memsize(
const void *ptr)
4281 const rb_thread_t *th = ptr;
4282 size_t size =
sizeof(rb_thread_t);
4284 if (!th->root_fiber) {
4285 size += th->ec->vm_stack_size *
sizeof(
VALUE);
4287 if (th->ec->local_storage) {
4288 size += rb_id_table_memsize(th->ec->local_storage);
4293#define thread_data_type ruby_threadptr_data_type
4302 0, 0, RUBY_TYPED_THREAD_SAFE_FREE
4306rb_obj_is_thread(
VALUE obj)
4308 return RBOOL(rb_typeddata_is_kind_of(obj, &thread_data_type));
4314 return rb_data_typed_object_zalloc_in_objspace(
objspace, klass,
sizeof(rb_thread_t), &thread_data_type);
4318rb_ec_set_vm_stack(rb_execution_context_t *ec,
VALUE *stack,
size_t size)
4320 ec->vm_stack = stack;
4321 ec->vm_stack_size = size;
4325rb_ec_initialize_vm_stack(rb_execution_context_t *ec,
VALUE *stack,
size_t size)
4327 rb_ec_set_vm_stack(ec, stack, size);
4329#if VM_CHECK_MODE > 0
4333 ec->cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
4337 VM_FRAME_MAGIC_DUMMY | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH | VM_FRAME_FLAG_CFRAME ,
4338 Qnil , VM_BLOCK_HANDLER_NONE ,
4340 0 , ec->vm_stack, 0, 0
4345rb_ec_clear_vm_stack(rb_execution_context_t *ec)
4352#if defined HAVE_DECL_ATOMIC_SIGNAL_FENCE && HAVE_DECL_ATOMIC_SIGNAL_FENCE
4353 atomic_signal_fence(memory_order_seq_cst);
4356 rb_ec_set_vm_stack(ec, NULL, 0);
4360rb_ec_close(rb_execution_context_t *ec)
4367th_init(rb_thread_t *th,
VALUE self, rb_vm_t *vm)
4369 const rb_box_t *box = rb_current_box();
4373 ccan_list_head_init(&th->interrupt_exec_tasks);
4379 rb_threadptr_root_fiber_setup(th);
4383 th->scheduler =
Qnil;
4386 size_t size = vm->default_params.thread_vm_stack_size /
sizeof(
VALUE);
4388 rb_ec_initialize_vm_stack(th->ec, stack, size);
4389 rb_thread_malloc_stack_set(th, stack, size);
4392 VM_ASSERT(th->ec->cfp == NULL);
4393 VM_ASSERT(th->ec->vm_stack == NULL);
4394 VM_ASSERT(th->ec->vm_stack_size == 0);
4397 th->status = THREAD_RUNNABLE;
4398 th->last_status =
Qnil;
4399 th->top_wrapper = 0;
4400 if (box->top_self) {
4401 th->top_self = box->top_self;
4408 th->ec->errinfo =
Qnil;
4409 th->ec->root_svar =
Qfalse;
4410 th->ec->local_storage_recursive_hash =
Qnil;
4411 th->ec->local_storage_recursive_hash_for_trace =
Qnil;
4413 th->ec->storage =
Qnil;
4414 th->ec->ractor_id = rb_ractor_id(th->ractor);
4416#if OPT_CALL_THREADED_CODE
4420 th->report_on_exception = vm->thread_report_on_exception;
4421 th->ext_config.ractor_safe =
true;
4423#if USE_RUBY_DEBUG_LOG
4427 RUBY_DEBUG_LOG(
"th:%u", th->serial);
4435 rb_thread_t *target_th = rb_thread_ptr(self);
4436 target_th->ractor = GET_RACTOR();
4437 th_init(target_th, self, target_th->vm = GET_VM());
4438 rb_root_fiber_obj_setup(target_th,
objspace);
4443rb_thread_alloc(
VALUE klass)
4445 return rb_thread_alloc_in_objspace(klass, GET_RACTOR()->
objspace);
4448#define REWIND_CFP(expr) do { \
4449 rb_execution_context_t *ec__ = GET_EC(); \
4450 VALUE *const curr_sp = (ec__->cfp++)->sp; \
4451 VALUE *const saved_sp = ec__->cfp->sp; \
4452 ec__->cfp->sp = curr_sp; \
4454 (ec__->cfp--)->sp = saved_sp; \
4481 rb_clear_method_cache(self, mid);
4487m_core_set_postexe(
VALUE self)
4489 rb_ractor_ensure_main_ractor(
"can not use END{} in non-main Ractors");
4495m_core_iseq_path(
VALUE self,
VALUE frozen_string_literal_option_value)
4497 rb_execution_context_t *ec = GET_EC();
4498 rb_control_frame_t *cfp = ec->cfp;
4499 cfp = vm_get_ruby_level_caller_cfp(ec, RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp));
4503 const rb_iseq_t *iseq = CFP_ISEQ(cfp);
4504 VALUE path = rb_iseq_path(iseq);
4506 int frozen_string_literal_option =
NUM2INT(frozen_string_literal_option_value);
4507 switch (frozen_string_literal_option) {
4508 case ISEQ_FROZEN_STRING_LITERAL_ENABLED:
4511 case ISEQ_FROZEN_STRING_LITERAL_DISABLED:
4514 case ISEQ_FROZEN_STRING_LITERAL_UNSET:
4515 path = rb_ec_str_resurrect(ec, path,
true);
4525core_hash_merge(
VALUE hash,
long argc,
const VALUE *argv,
bool dup)
4528 hash = rb_cHash_empty_frozen;
4531 hash = rb_to_hash_type(hash);
4535 return rb_hash_merge2_bulk(hash, argc, argv, dup);
4539m_core_hash_merge_ptr(
int argc,
VALUE *argv,
VALUE recv)
4541 VALUE hash = argv[0];
4542 VM_ASSERT(argc % 2 == 1);
4544 REWIND_CFP(hash = core_hash_merge(hash, argc - 1, argv + 1,
true));
4550m_core_hash_merge_bang_ptr(
int argc,
VALUE *argv,
VALUE recv)
4552 VALUE hash = argv[0];
4553 VM_ASSERT(argc % 2 == 1);
4559 REWIND_CFP(hash = core_hash_merge(hash, argc - 1, argv + 1,
false));
4565core_hash_merge_kwd(
VALUE hash,
VALUE kw,
bool dup)
4567 kw = rb_to_hash_type(kw);
4569 return dup ? rb_hash_resurrect(kw) : kw;
4572 hash = rb_to_hash_type(hash);
4574 return rb_hash_merge2(hash, kw, dup);
4589 hash = rb_hash_resurrect(hash);
4592 REWIND_CFP(hash = core_hash_merge_kwd(hash, kw,
true));
4607 hash = rb_hash_resurrect(hash);
4611 REWIND_CFP(hash = core_hash_merge_kwd(hash, kw,
false));
4624m_core_make_shareable_copy(
VALUE recv,
VALUE obj)
4632 return rb_ractor_ensure_shareable(obj, name);
4635extern VALUE *rb_gc_stack_start;
4636extern size_t rb_gc_stack_maxsize;
4644 rb_vm_bugreport(NULL, stderr);
4653#ifdef HAVE_BACKTRACE
4654#include <execinfo.h>
4655#define MAX_NATIVE_TRACE 1024
4656 static void *trace[MAX_NATIVE_TRACE];
4657 int n = (int)backtrace(trace, MAX_NATIVE_TRACE);
4658 char **syms = backtrace_symbols(trace, n);
4665 for (i=0; i<n; i++) {
4673#if VM_COLLECT_USAGE_DETAILS
4674static VALUE usage_analysis_insn_start(
VALUE self);
4675static VALUE usage_analysis_operand_start(
VALUE self);
4676static VALUE usage_analysis_register_start(
VALUE self);
4677static VALUE usage_analysis_insn_stop(
VALUE self);
4678static VALUE usage_analysis_operand_stop(
VALUE self);
4679static VALUE usage_analysis_register_stop(
VALUE self);
4680static VALUE usage_analysis_insn_running(
VALUE self);
4681static VALUE usage_analysis_operand_running(
VALUE self);
4682static VALUE usage_analysis_register_running(
VALUE self);
4683static VALUE usage_analysis_insn_clear(
VALUE self);
4684static VALUE usage_analysis_operand_clear(
VALUE self);
4685static VALUE usage_analysis_register_clear(
VALUE self);
4691 return rb_f_raise(c, v);
4740vm_keep_script_lines(
VALUE self)
4742 return RBOOL(ruby_vm_keep_script_lines);
4757vm_keep_script_lines_set(
VALUE self,
VALUE flags)
4759 ruby_vm_keep_script_lines =
RTEST(flags);
4781 rb_cRubyVM = rb_define_class(
"RubyVM",
rb_cObject);
4788#if USE_DEBUG_COUNTER
4812 rb_define_method(klass,
"make_shareable_copy", m_core_make_shareable_copy, 1);
4815 RBASIC_CLEAR_CLASS(klass);
4817 rb_vm_register_global_object(fcore);
4818 rb_mRubyVMFrozenCore = fcore;
4981#if VM_COLLECT_USAGE_DETAILS
4983#define define_usage_analysis_hash(name) \
4984 rb_define_const(rb_cRubyVM, "USAGE_ANALYSIS_" #name, rb_hash_new())
4985 define_usage_analysis_hash(INSN);
4986 define_usage_analysis_hash(REGS);
4987 define_usage_analysis_hash(INSN_BIGRAM);
5007 rb_define_const(rb_cRubyVM,
"OPTS", opts =
rb_ary_new());
5009#if OPT_DIRECT_THREADED_CODE
5011#elif OPT_TOKEN_THREADED_CODE
5013#elif OPT_CALL_THREADED_CODE
5017#if OPT_OPERANDS_UNIFICATION
5020#if OPT_INSTRUCTIONS_UNIFICATION
5023#if OPT_INLINE_METHOD_CACHE
5031 rb_define_const(rb_cRubyVM,
"INSTRUCTION_NAMES", rb_insns_name_array());
5039 rb_define_const(rb_cRubyVM,
"DEFAULT_PARAMS", vm_default_params());
5056 rb_vm_t *vm = ruby_current_vm_ptr;
5057 rb_thread_t *th = GET_THREAD();
5058 VALUE filename = rb_fstring_lit(
"<main>");
5059 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
5062 rb_ractor_main_setup(vm, th->ractor, th);
5069 vm->ractor.main_thread = th;
5070 vm->ractor.main_ractor = th->ractor;
5072 th->top_wrapper = 0;
5073 th->top_self = rb_vm_top_self();
5075 rb_root_fiber_obj_setup(th, th->ractor->objspace);
5077 rb_vm_register_global_object((
VALUE)iseq);
5078 th->ec->cfp->_iseq = iseq;
5079 th->ec->cfp->pc = ISEQ_BODY(iseq)->iseq_encoded;
5080 th->ec->cfp->self = th->top_self;
5082 VM_ENV_FLAGS_UNSET(th->ec->cfp->ep, VM_FRAME_FLAG_CFRAME);
5083 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));
5091 rb_objspace_gc_enable(vm->ractor.main_ractor->objspace);
5097 rb_add_method_optimized(proxy_singleton, idCall, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
5098 rb_add_method_optimized(proxy_singleton, idAREF, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
5099 rb_add_method_optimized(proxy_singleton, idYield, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
5100 rb_add_method_optimized(proxy_singleton, idEqq, OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
5102 rb_vm_register_global_object(rb_block_param_proxy);
5105 Init_vm_backtrace();
5109rb_vm_set_progname(
VALUE filename)
5111 rb_thread_t *th = GET_VM()->ractor.main_thread;
5112 rb_control_frame_t *cfp = (
void *)(th->ec->vm_stack + th->ec->vm_stack_size);
5116 rb_iseq_pathobj_set(CFP_ISEQ(cfp), filename, rb_iseq_realpath(CFP_ISEQ(cfp)));
5119extern const struct st_hash_type rb_fstring_hash_type;
5122static rb_thread_t _main_thread = {
5132 rb_thread_t *th = &_main_thread;
5137 ruby_current_vm_ptr = vm;
5140 vm->ractor.main_ractor = rb_ractor_main_alloc();
5142 rb_gc_init_objspaces();
5143 vm->ractor.main_ractor->newobj_cache = rb_gc_ractor_cache_alloc(vm->ractor.main_ractor);
5144 rb_id_table_init(&vm->negative_cme_table, 16);
5145 st_init_existing_numtable_with_size(&vm->overloaded_cme_table, 0);
5146 st_init_existing_strtable_with_size(&vm->static_ext_inits, 0);
5147 set_init_embedded_numtable_with_size(&vm->unused_block_warning_table, 0);
5148 vm->global_hooks.type = hook_list_type_global;
5152 th->ractor = vm->ractor.main_ractor;
5153 Init_native_thread(th);
5157 rb_ractor_set_current_ec(th->ractor, th->ec);
5160 ruby_thread_init_stack(th, native_main_thread_stack_top);
5166 vm->gc.orphan_merge_pjob = POSTPONED_JOB_HANDLE_INVALID;
5168 vm_opt_method_def_table = st_init_numtable();
5169 vm_opt_mid_table = st_init_numtable();
5176 native_main_thread_stack_top = addr;
5181#include <sys/mman.h>
5186rb_vm_register_global_object(
VALUE obj)
5196 if (
FL_TEST(obj, RCLASS_IS_ROOT)) {
5199 FL_SET(obj, RCLASS_IS_ROOT);
5207 rb_ractor_t *cr = GET_RACTOR();
5208 if (cr->registered_marks_cnt == cr->registered_marks_capa) {
5209 size_t nc = cr->registered_marks_capa ? cr->registered_marks_capa * 2 : 64;
5210 VALUE *p = realloc(cr->registered_marks, nc *
sizeof(
VALUE));
5211 if (!p) rb_bug(
"rb_vm_register_global_object: out of memory");
5212 cr->registered_marks = p;
5213 cr->registered_marks_capa = nc;
5215 cr->registered_marks[cr->registered_marks_cnt++] = obj;
5219VALUE rb_cc_refinement_set_create(
void);
5222Init_vm_objects(
void)
5224 rb_vm_t *vm = GET_VM();
5225 st_init_existing_table_with_size(&vm->ci_table, &vm_ci_hashtype, 0);
5226 vm->cc_refinement_set = rb_cc_refinement_set_create();
5230#include "jit_hook.rbinc"
5231#include "jit_undef.rbinc"
5235void Init_builtin_yjit(
void) {}
5240void Init_builtin_zjit(
void) {}
5254 const rb_box_t *box = rb_current_box();
5256 VM_ASSERT(box->top_self);
5257 return box->top_self;
5263 rb_vm_t *vm = GET_VM();
5264 vm->root_box = (rb_box_t *)rb_root_box();
5273 rb_ractor_t *cr = GET_RACTOR();
5274 return &cr->verbose;
5280 rb_ractor_t *cr = GET_RACTOR();
5284bool rb_free_at_exit =
false;
5289 return rb_free_at_exit;
5293VALUE rb_insn_operand_intern(
const rb_iseq_t *iseq,
5297#if VM_COLLECT_USAGE_DETAILS
5299#define HASH_ASET(h, k, v) rb_hash_aset((h), (st_data_t)(k), (st_data_t)(v))
5313vm_analysis_insn(
int insn)
5317 static int prev_insn = -1;
5323 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5324 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
5328 HASH_ASET(uh,
INT2FIX(insn), ihash);
5336 if (prev_insn != -1) {
5346 if (
NIL_P(cv = rb_hash_aref(uh, bi))) {
5355vm_analysis_operand(
int insn,
int n,
VALUE op)
5365 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5370 HASH_ASET(uh,
INT2FIX(insn), ihash);
5374 HASH_ASET(ihash,
INT2FIX(n), ophash);
5377 valstr = rb_insn_operand_intern(CFP_ISEQ(GET_EC()->cfp), insn, n, op, 0, 0, 0, 0);
5380 if (
NIL_P(cv = rb_hash_aref(ophash, valstr))) {
5387vm_analysis_register(
int reg,
int isset)
5392 static const char regstrs[][5] = {
5400 static const char getsetstr[][4] = {
5404 static VALUE syms[
sizeof(regstrs) /
sizeof(regstrs[0])][2];
5408 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
5413 for (i = 0; i < (int)(
sizeof(regstrs) /
sizeof(regstrs[0])); i++) {
5415 for (j = 0; j < 2; j++) {
5416 snprintf(buff, 0x10,
"%d %s %-4s", i, getsetstr[j], regstrs[i]);
5417 syms[i][j] =
ID2SYM(rb_intern(buff));
5421 valstr = syms[reg][isset];
5424 if (
NIL_P(cv = rb_hash_aref(uh, valstr))) {
5432static void (*ruby_vm_collect_usage_func_insn)(
int insn) = NULL;
5433static void (*ruby_vm_collect_usage_func_operand)(
int insn,
int n,
VALUE op) = NULL;
5434static void (*ruby_vm_collect_usage_func_register)(
int reg,
int isset) = NULL;
5438usage_analysis_insn_start(
VALUE self)
5440 ruby_vm_collect_usage_func_insn = vm_analysis_insn;
5446usage_analysis_operand_start(
VALUE self)
5448 ruby_vm_collect_usage_func_operand = vm_analysis_operand;
5454usage_analysis_register_start(
VALUE self)
5456 ruby_vm_collect_usage_func_register = vm_analysis_register;
5462usage_analysis_insn_stop(
VALUE self)
5464 ruby_vm_collect_usage_func_insn = 0;
5470usage_analysis_operand_stop(
VALUE self)
5472 ruby_vm_collect_usage_func_operand = 0;
5478usage_analysis_register_stop(
VALUE self)
5480 ruby_vm_collect_usage_func_register = 0;
5486usage_analysis_insn_running(
VALUE self)
5488 return RBOOL(ruby_vm_collect_usage_func_insn != 0);
5493usage_analysis_operand_running(
VALUE self)
5495 return RBOOL(ruby_vm_collect_usage_func_operand != 0);
5500usage_analysis_register_running(
VALUE self)
5502 return RBOOL(ruby_vm_collect_usage_func_register != 0);
5506usage_analysis_clear(
VALUE self,
ID usage_hash)
5518usage_analysis_insn_clear(
VALUE self)
5523 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5524 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
5525 usage_analysis_clear(rb_cRubyVM, usage_hash);
5526 return usage_analysis_clear(rb_cRubyVM, bigram_hash);
5531usage_analysis_operand_clear(
VALUE self)
5535 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
5536 return usage_analysis_clear(self, usage_hash);
5541usage_analysis_register_clear(
VALUE self)
5545 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
5546 return usage_analysis_clear(self, usage_hash);
5551vm_collect_usage_insn(
int insn)
5553 if (RUBY_DTRACE_INSN_ENABLED()) {
5554 RUBY_DTRACE_INSN(rb_insns_name(insn));
5556 if (ruby_vm_collect_usage_func_insn)
5557 (*ruby_vm_collect_usage_func_insn)(insn);
5565vm_collect_usage_operand(
int insn,
int n,
VALUE op)
5567 if (RUBY_DTRACE_INSN_OPERAND_ENABLED()) {
5570 valstr = rb_insn_operand_intern(CFP_ISEQ(GET_EC()->cfp), insn, n, op, 0, 0, 0, 0);
5572 RUBY_DTRACE_INSN_OPERAND(RSTRING_PTR(valstr), rb_insns_name(insn));
5575 if (ruby_vm_collect_usage_func_operand)
5576 (*ruby_vm_collect_usage_func_operand)(insn, n, op);
5582vm_collect_usage_register(
int reg,
int isset)
5584 if (ruby_vm_collect_usage_func_register)
5585 (*ruby_vm_collect_usage_func_register)(reg, isset);
5589#include "vm_call_iseq_optimized.inc"
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.
struct re_pattern_buffer Regexp
Old name of re_pattern_buffer.
#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 OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
#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 NUM2INT
Old name of RB_NUM2INT.
#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.
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
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.
#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.
void rb_memerror(void)
Triggers out-of-memory error.
VALUE rb_ary_delete_at(VALUE ary, rb_len_t 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_hidden_new(rb_len_t capa)
Allocates a hidden (no class) 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_hash_new(void)
Creates a new, empty hash object.
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.
VALUE rb_str_resurrect(VALUE str)
Like rb_str_dup(), but always create an instance of rb_cString regardless of the given object's class...
#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.
bool ruby_free_at_exit_p(void)
Returns whether the Ruby VM will free all memory at shutdown.
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)
References an object in an array.
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.
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
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.
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.
long rb_len_t
A signed integer type for lengths and indices of objects such as String and Array.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
#define SIZEOF_VALUE
Identical to sizeof(VALUE), except it is a macro that can also be used inside of preprocessor directi...
uintptr_t VALUE
Type that represents a Ruby object.
static 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.