11#define vm_exec rb_vm_exec
13#include "eval_intern.h"
15#include "internal/class.h"
16#include "internal/compile.h"
17#include "internal/cont.h"
18#include "internal/error.h"
19#include "internal/encoding.h"
20#include "internal/eval.h"
21#include "internal/gc.h"
22#include "internal/inits.h"
23#include "internal/missing.h"
24#include "internal/object.h"
25#include "internal/proc.h"
26#include "internal/re.h"
27#include "internal/ruby_parser.h"
28#include "internal/symbol.h"
29#include "internal/thread.h"
30#include "internal/transcode.h"
31#include "internal/vm.h"
32#include "internal/sanitizers.h"
33#include "internal/variable.h"
41#include "vm_callinfo.h"
44#include "vm_insnhelper.h"
45#include "ractor_core.h"
52#include "probes_helper.h"
54#ifdef RUBY_ASSERT_CRITICAL_SECTION
55int ruby_assert_critical_section_entered = 0;
58static void *native_main_thread_stack_top;
60VALUE rb_str_concat_literals(
size_t,
const VALUE*);
62VALUE vm_exec(rb_execution_context_t *);
64extern const char *
const rb_debug_counter_names[];
66PUREFUNC(
static inline const VALUE *VM_EP_LEP(
const VALUE *));
67static inline const VALUE *
68VM_EP_LEP(
const VALUE *ep)
70 while (!VM_ENV_LOCAL_P(ep)) {
71 ep = VM_ENV_PREV_EP(ep);
76static inline const rb_control_frame_t *
77rb_vm_search_cf_from_ep(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp,
const VALUE *
const ep)
83 const rb_control_frame_t *
const eocfp = RUBY_VM_END_CONTROL_FRAME(ec);
89 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
97rb_vm_ep_local_ep(
const VALUE *ep)
102PUREFUNC(
static inline const VALUE *VM_CF_LEP(
const rb_control_frame_t *
const cfp));
103static inline const VALUE *
104VM_CF_LEP(
const rb_control_frame_t *
const cfp)
106 return VM_EP_LEP(cfp->ep);
109static inline const VALUE *
110VM_CF_PREV_EP(
const rb_control_frame_t *
const cfp)
112 return VM_ENV_PREV_EP(cfp->ep);
115PUREFUNC(
static inline VALUE VM_CF_BLOCK_HANDLER(
const rb_control_frame_t *
const cfp));
117VM_CF_BLOCK_HANDLER(
const rb_control_frame_t *
const cfp)
119 const VALUE *ep = VM_CF_LEP(cfp);
120 return VM_ENV_BLOCK_HANDLER(ep);
124rb_vm_cframe_keyword_p(
const rb_control_frame_t *cfp)
126 return VM_FRAME_CFRAME_KW_P(cfp);
130rb_vm_frame_block_handler(
const rb_control_frame_t *cfp)
132 return VM_CF_BLOCK_HANDLER(cfp);
137VM_CFP_IN_HEAP_P(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
139 const VALUE *start = ec->vm_stack;
140 const VALUE *end = (
VALUE *)ec->vm_stack + ec->vm_stack_size;
141 VM_ASSERT(start != NULL);
143 if (start <= (
VALUE *)cfp && (
VALUE *)cfp < end) {
152VM_EP_IN_HEAP_P(
const rb_execution_context_t *ec,
const VALUE *ep)
154 const VALUE *start = ec->vm_stack;
156 VM_ASSERT(start != NULL);
158 if (start <= ep && ep < end) {
167vm_ep_in_heap_p_(
const rb_execution_context_t *ec,
const VALUE *ep)
169 if (VM_EP_IN_HEAP_P(ec, ep)) {
170 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV];
172 if (!UNDEF_P(envval)) {
175 VM_ASSERT(imemo_type_p(envval, imemo_env));
176 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
177 VM_ASSERT(env->ep == ep);
187rb_vm_ep_in_heap_p(
const VALUE *ep)
189 const rb_execution_context_t *ec = GET_EC();
190 if (ec->vm_stack == NULL)
return TRUE;
191 return vm_ep_in_heap_p_(ec, ep);
196VM_CFP_TO_CAPTURED_BLOCK(
const rb_control_frame_t *cfp)
198 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
202static rb_control_frame_t *
205 rb_control_frame_t *cfp = ((rb_control_frame_t *)((
VALUE *)(captured) - 3));
206 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
207 VM_ASSERT(
sizeof(rb_control_frame_t)/
sizeof(
VALUE) == 7 + VM_DEBUG_BP_CHECK ? 1 : 0);
212VM_BH_FROM_CFP_P(
VALUE block_handler,
const rb_control_frame_t *cfp)
215 return VM_TAGGED_PTR_REF(block_handler, 0x03) == captured;
219vm_passed_block_handler(rb_execution_context_t *ec)
221 VALUE block_handler = ec->passed_block_handler;
222 ec->passed_block_handler = VM_BLOCK_HANDLER_NONE;
223 vm_block_handler_verify(block_handler);
224 return block_handler;
228vm_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)
231 int omod_shared = FALSE;
235 rb_scope_visibility_t visi;
239 scope_visi.visi.method_visi = visi;
240 scope_visi.visi.module_func = module_func;
243 if (prev_cref != NULL && prev_cref != (
void *)1 ) {
244 refinements = CREF_REFINEMENTS(prev_cref);
246 if (!
NIL_P(refinements)) {
248 CREF_OMOD_SHARED_SET(prev_cref);
252 VM_ASSERT(singleton || klass);
254 rb_cref_t *cref = IMEMO_NEW(rb_cref_t, imemo_cref, refinements);
255 cref->klass_or_self = klass;
256 cref->next = use_prev_prev ? CREF_NEXT(prev_cref) : prev_cref;
257 *((rb_scope_visibility_t *)&cref->scope_visi) = scope_visi.visi;
259 if (pushed_by_eval) CREF_PUSHED_BY_EVAL_SET(cref);
260 if (omod_shared) CREF_OMOD_SHARED_SET(cref);
261 if (singleton) CREF_SINGLETON_SET(cref);
267vm_cref_new(
VALUE klass, rb_method_visibility_t visi,
int module_func, rb_cref_t *prev_cref,
int pushed_by_eval,
int singleton)
269 return vm_cref_new0(klass, visi, module_func, prev_cref, pushed_by_eval, FALSE, singleton);
273vm_cref_new_use_prev(
VALUE klass, rb_method_visibility_t visi,
int module_func, rb_cref_t *prev_cref,
int pushed_by_eval)
275 return vm_cref_new0(klass, visi, module_func, prev_cref, pushed_by_eval, TRUE, FALSE);
281 return SYMBOL_P(key) ? ST_DELETE : ST_CONTINUE;
285vm_cref_dup(
const rb_cref_t *cref)
287 const rb_scope_visibility_t *visi = CREF_SCOPE_VISI(cref);
288 rb_cref_t *next_cref = CREF_NEXT(cref), *new_cref;
289 int pushed_by_eval = CREF_PUSHED_BY_EVAL(cref);
290 int singleton = CREF_SINGLETON(cref);
292 new_cref = vm_cref_new(cref->klass_or_self, visi->method_visi, visi->module_func, next_cref, pushed_by_eval, singleton);
294 if (!
NIL_P(CREF_REFINEMENTS(cref))) {
295 VALUE ref = rb_hash_dup(CREF_REFINEMENTS(cref));
297 CREF_REFINEMENTS_SET(new_cref, ref);
298 CREF_OMOD_SHARED_UNSET(new_cref);
306rb_vm_cref_dup_without_refinements(
const rb_cref_t *cref)
308 const rb_scope_visibility_t *visi = CREF_SCOPE_VISI(cref);
309 rb_cref_t *next_cref = CREF_NEXT(cref), *new_cref;
310 int pushed_by_eval = CREF_PUSHED_BY_EVAL(cref);
311 int singleton = CREF_SINGLETON(cref);
313 new_cref = vm_cref_new(cref->klass_or_self, visi->method_visi, visi->module_func, next_cref, pushed_by_eval, singleton);
315 if (!
NIL_P(CREF_REFINEMENTS(cref))) {
316 CREF_REFINEMENTS_SET(new_cref,
Qnil);
317 CREF_OMOD_SHARED_UNSET(new_cref);
324vm_cref_new_toplevel(rb_execution_context_t *ec)
326 rb_cref_t *cref = vm_cref_new(rb_cObject, METHOD_VISI_PRIVATE , FALSE, NULL, FALSE, FALSE);
327 VALUE top_wrapper = rb_ec_thread_ptr(ec)->top_wrapper;
330 cref = vm_cref_new(top_wrapper, METHOD_VISI_PRIVATE, FALSE, cref, FALSE, FALSE);
337rb_vm_cref_new_toplevel(
void)
339 return vm_cref_new_toplevel(GET_EC());
343vm_cref_dump(
const char *mesg,
const rb_cref_t *cref)
345 ruby_debug_printf(
"vm_cref_dump: %s (%p)\n", mesg, (
void *)cref);
348 ruby_debug_printf(
"= cref| klass: %s\n", RSTRING_PTR(
rb_class_path(CREF_CLASS(cref))));
349 cref = CREF_NEXT(cref);
356 *((
const VALUE **)&dst->as.captured.ep) = ep;
364 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, env->iseq);
365 rb_vm_block_ep_update(bindval, &bind->block, env->ep);
368#if VM_COLLECT_USAGE_DETAILS
369static void vm_collect_usage_operand(
int insn,
int n,
VALUE op);
370static void vm_collect_usage_insn(
int insn);
371static void vm_collect_usage_register(
int reg,
int isset);
374static VALUE vm_make_env_object(
const rb_execution_context_t *ec, rb_control_frame_t *cfp);
376 int argc,
const VALUE *argv,
int kw_splat,
VALUE block_handler,
377 const rb_callable_method_entry_t *me);
378static 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);
382static uint64_t yjit_total_entry_hits = 0;
385#define YJIT_CALL_COUNT_INTERV 20u
389rb_yjit_threshold_hit(
const rb_iseq_t *iseq, uint64_t entry_calls)
391 yjit_total_entry_hits += 1;
394 if (entry_calls + YJIT_CALL_COUNT_INTERV == rb_yjit_call_threshold) {
395 iseq->body->yjit_calls_at_interv = yjit_total_entry_hits;
400 if (entry_calls == rb_yjit_call_threshold) {
402 if (rb_yjit_call_threshold < YJIT_CALL_COUNT_INTERV) {
406 uint64_t num_calls = yjit_total_entry_hits - iseq->body->yjit_calls_at_interv;
409 if (num_calls > rb_yjit_cold_threshold) {
410 rb_yjit_incr_counter(
"cold_iseq_entry");
420#define rb_yjit_threshold_hit(iseq, entry_calls) false
423#if USE_RJIT || USE_YJIT
432static inline rb_jit_func_t
433jit_compile(rb_execution_context_t *ec)
435 const rb_iseq_t *iseq = ec->cfp->iseq;
437 bool yjit_enabled = rb_yjit_enabled_p;
438 if (!(yjit_enabled || rb_rjit_call_p)) {
443 if (body->jit_entry == NULL) {
444 body->jit_entry_calls++;
446 if (rb_yjit_threshold_hit(iseq, body->jit_entry_calls)) {
447 rb_yjit_compile_iseq(iseq, ec,
false);
450 else if (body->jit_entry_calls == rb_rjit_call_threshold()) {
451 rb_rjit_compile(iseq);
454 return body->jit_entry;
459jit_exec(rb_execution_context_t *ec)
461 rb_jit_func_t func = jit_compile(ec);
464 return func(ec, ec->cfp);
471# define jit_compile(ec) ((rb_jit_func_t)0)
472# define jit_exec(ec) Qundef
482static inline rb_jit_func_t
483jit_compile_exception(rb_execution_context_t *ec)
485 const rb_iseq_t *iseq = ec->cfp->iseq;
487 if (!rb_yjit_enabled_p) {
492 if (body->jit_exception == NULL) {
493 body->jit_exception_calls++;
494 if (body->jit_exception_calls == rb_yjit_call_threshold) {
495 rb_yjit_compile_iseq(iseq, ec,
true);
499 return body->jit_exception;
504jit_exec_exception(rb_execution_context_t *ec)
506 rb_jit_func_t func = jit_compile_exception(ec);
509 return func(ec, ec->cfp);
516# define jit_compile_exception(ec) ((rb_jit_func_t)0)
517# define jit_exec_exception(ec) Qundef
520static void add_opt_method_entry(
const rb_method_entry_t *me);
522#define RB_TYPE_2_P(obj, type1, type2) \
523 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2))
524#define RB_TYPE_3_P(obj, type1, type2, type3) \
525 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2) || RB_TYPE_P(obj, type3))
527#define VM_ASSERT_TYPE(obj, type) \
528 VM_ASSERT(RB_TYPE_P(obj, type), #obj ": %s", rb_obj_info(obj))
529#define VM_ASSERT_TYPE2(obj, type1, type2) \
530 VM_ASSERT(RB_TYPE_2_P(obj, type1, type2), #obj ": %s", rb_obj_info(obj))
531#define VM_ASSERT_TYPE3(obj, type1, type2, type3) \
532 VM_ASSERT(RB_TYPE_3_P(obj, type1, type2, type3), #obj ": %s", rb_obj_info(obj))
534#include "vm_insnhelper.c"
538#include "vm_method.c"
545VALUE rb_mRubyVMFrozenCore;
546VALUE rb_block_param_proxy;
548VALUE ruby_vm_const_missing_count = 0;
549rb_vm_t *ruby_current_vm_ptr = NULL;
550rb_ractor_t *ruby_single_main_ractor;
551bool ruby_vm_keep_script_lines;
553#ifdef RB_THREAD_LOCAL_SPECIFIER
554RB_THREAD_LOCAL_SPECIFIER rb_execution_context_t *ruby_current_ec;
557RB_THREAD_LOCAL_SPECIFIER
rb_atomic_t ruby_nt_serial;
561rb_execution_context_t *
562rb_current_ec_noinline(
void)
564 return ruby_current_ec;
568rb_current_ec_set(rb_execution_context_t *ec)
570 ruby_current_ec = ec;
574#if defined(__arm64__) || defined(__aarch64__)
575rb_execution_context_t *
578 return ruby_current_ec;
583native_tls_key_t ruby_current_ec_key;
586rb_execution_context_t *
587rb_current_ec_noinline(
void)
589 return native_tls_get(ruby_current_ec_key);
596unsigned int ruby_vm_event_local_num;
598rb_serial_t ruby_vm_constant_cache_invalidations = 0;
599rb_serial_t ruby_vm_constant_cache_misses = 0;
600rb_serial_t ruby_vm_global_cvar_state = 1;
603 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
606 .call_ = vm_call_general,
612static const struct rb_callcache vm_empty_cc_for_super = {
613 .flags =
T_IMEMO | (imemo_callcache <<
FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
616 .call_ = vm_call_super_method,
622static void thread_free(
void *ptr);
625rb_vm_inc_const_missing_count(
void)
627 ruby_vm_const_missing_count +=1;
631rb_dtrace_setup(rb_execution_context_t *ec,
VALUE klass,
ID id,
636 if (!ec) ec = GET_EC();
637 if (!rb_ec_frame_method_id_and_class(ec, &
id, 0, &klass) || !klass)
641 klass =
RBASIC(klass)->klass;
643 else if (RCLASS_SINGLETON_P(klass)) {
644 klass = RCLASS_ATTACHED_OBJECT(klass);
645 if (
NIL_P(klass))
return FALSE;
650 const char *classname, *filename;
651 const char *methodname = rb_id2name(
id);
652 if (methodname && (filename = rb_source_location_cstr(&args->line_no)) != 0) {
654 classname =
"<unknown>";
655 args->classname = classname;
656 args->methodname = methodname;
657 args->filename = filename;
666extern unsigned int redblack_buffer_size;
694 static VALUE sym_constant_cache_invalidations, sym_constant_cache_misses, sym_global_cvar_state, sym_next_shape_id;
695 static VALUE sym_shape_cache_size;
709 hash = rb_hash_new();
712#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
713 S(constant_cache_invalidations);
714 S(constant_cache_misses);
715 S(global_cvar_state);
720#define SET(name, attr) \
721 if (key == sym_##name) \
722 return SERIALT2NUM(attr); \
723 else if (hash != Qnil) \
724 rb_hash_aset(hash, sym_##name, SERIALT2NUM(attr));
726 SET(constant_cache_invalidations, ruby_vm_constant_cache_invalidations);
727 SET(constant_cache_misses, ruby_vm_constant_cache_misses);
728 SET(global_cvar_state, ruby_vm_global_cvar_state);
729 SET(next_shape_id, (rb_serial_t)GET_SHAPE_TREE()->next_shape_id);
730 SET(shape_cache_size, (rb_serial_t)GET_SHAPE_TREE()->cache_size);
734 ruby_debug_counter_show_at_exit(FALSE);
735 for (
size_t i = 0; i < RB_DEBUG_COUNTER_MAX; i++) {
736 const VALUE name = rb_sym_intern_ascii_cstr(rb_debug_counter_names[i]);
742 else if (hash !=
Qnil) {
743 rb_hash_aset(hash, name, boxed_value);
749 rb_raise(rb_eArgError,
"unknown key: %"PRIsVALUE,
rb_sym2str(key));
758vm_set_top_stack(rb_execution_context_t *ec,
const rb_iseq_t *iseq)
760 if (ISEQ_BODY(iseq)->
type != ISEQ_TYPE_TOP) {
761 rb_raise(
rb_eTypeError,
"Not a toplevel InstructionSequence");
765 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH, rb_ec_thread_ptr(ec)->top_self,
766 VM_BLOCK_HANDLER_NONE,
767 (
VALUE)vm_cref_new_toplevel(ec),
768 ISEQ_BODY(iseq)->iseq_encoded, ec->cfp->sp,
769 ISEQ_BODY(iseq)->local_table_size, ISEQ_BODY(iseq)->stack_max);
773vm_set_eval_stack(rb_execution_context_t *ec,
const rb_iseq_t *iseq,
const rb_cref_t *cref,
const struct rb_block *base_block)
775 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_EVAL | VM_FRAME_FLAG_FINISH,
776 vm_block_self(base_block), VM_GUARDED_PREV_EP(vm_block_ep(base_block)),
778 ISEQ_BODY(iseq)->iseq_encoded,
779 ec->cfp->sp, ISEQ_BODY(iseq)->local_table_size,
780 ISEQ_BODY(iseq)->stack_max);
784vm_set_main_stack(rb_execution_context_t *ec,
const rb_iseq_t *iseq)
786 VALUE toplevel_binding =
rb_const_get(rb_cObject, rb_intern(
"TOPLEVEL_BINDING"));
789 GetBindingPtr(toplevel_binding, bind);
792 vm_set_eval_stack(ec, iseq, 0, &bind->block);
795 if (ISEQ_BODY(iseq)->local_table_size > 0) {
796 vm_bind_update_env(toplevel_binding, bind, vm_make_env_object(ec, ec->cfp));
801rb_vm_get_binding_creatable_next_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
803 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
805 return (rb_control_frame_t *)cfp;
807 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
813rb_vm_get_ruby_level_next_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
815 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
816 if (VM_FRAME_RUBYFRAME_P(cfp)) {
817 return (rb_control_frame_t *)cfp;
819 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
824static rb_control_frame_t *
825vm_get_ruby_level_caller_cfp(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
827 if (VM_FRAME_RUBYFRAME_P(cfp)) {
828 return (rb_control_frame_t *)cfp;
831 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
833 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
834 if (VM_FRAME_RUBYFRAME_P(cfp)) {
835 return (rb_control_frame_t *)cfp;
838 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_PASSED) == FALSE) {
841 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
847rb_vm_pop_cfunc_frame(
void)
849 rb_execution_context_t *ec = GET_EC();
850 rb_control_frame_t *cfp = ec->cfp;
851 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
854 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec, me->owner, me->def->original_id);
855 vm_pop_frame(ec, cfp, cfp->ep);
859rb_vm_rewind_cfp(rb_execution_context_t *ec, rb_control_frame_t *cfp)
862 while (ec->cfp != cfp) {
864 printf(
"skipped frame: %s\n", vm_frametype_name(ec->cfp));
866 if (VM_FRAME_TYPE(ec->cfp) != VM_FRAME_MAGIC_CFUNC) {
870 rb_vm_pop_cfunc_frame();
880 rb_vm_t *vm = GET_VM();
883 nl->next = vm->at_exit;
888ruby_vm_run_at_exit_hooks(rb_vm_t *vm)
894 rb_vm_at_exit_func *func = l->func;
908 fputs(
"---\n", stderr);
909 ruby_debug_printf(
"envptr: %p\n", (
void *)&env->ep[0]);
910 ruby_debug_printf(
"envval: %10p ", (
void *)env->ep[1]);
912 ruby_debug_printf(
"ep: %10p\n", (
void *)env->ep);
913 if (rb_vm_env_prev_env(env)) {
914 fputs(
">>\n", stderr);
915 check_env_value(rb_vm_env_prev_env(env));
916 fputs(
"<<\n", stderr);
924 if (check_env(env)) {
927 rb_bug(
"invalid env");
932vm_block_handler_escape(
const rb_execution_context_t *ec,
VALUE block_handler)
934 switch (vm_block_handler_type(block_handler)) {
935 case block_handler_type_ifunc:
936 case block_handler_type_iseq:
937 return rb_vm_make_proc(ec, VM_BH_TO_CAPT_BLOCK(block_handler),
rb_cProc);
939 case block_handler_type_symbol:
940 case block_handler_type_proc:
941 return block_handler;
943 VM_UNREACHABLE(vm_block_handler_escape);
948vm_make_env_each(
const rb_execution_context_t *
const ec, rb_control_frame_t *
const cfp)
950 const VALUE *
const ep = cfp->ep;
951 VALUE *env_body, *env_ep;
952 int local_size, env_size;
954 if (VM_ENV_ESCAPED_P(ep)) {
955 return VM_ENV_ENVVAL(ep);
958 if (!VM_ENV_LOCAL_P(ep)) {
959 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
960 if (!VM_ENV_ESCAPED_P(prev_ep)) {
961 rb_control_frame_t *prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
963 while (prev_cfp->ep != prev_ep) {
964 prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(prev_cfp);
965 VM_ASSERT(prev_cfp->ep != NULL);
968 vm_make_env_each(ec, prev_cfp);
969 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_SPECVAL], VM_GUARDED_PREV_EP(prev_cfp->ep));
973 VALUE block_handler = VM_ENV_BLOCK_HANDLER(ep);
975 if (block_handler != VM_BLOCK_HANDLER_NONE) {
976 VALUE blockprocval = vm_block_handler_escape(ec, block_handler);
977 VM_STACK_ENV_WRITE(ep, VM_ENV_DATA_INDEX_SPECVAL, blockprocval);
981 if (!VM_FRAME_RUBYFRAME_P(cfp)) {
982 local_size = VM_ENV_DATA_SIZE;
985 local_size = ISEQ_BODY(cfp->iseq)->local_table_size;
986 if (ISEQ_BODY(cfp->iseq)->param.flags.forwardable && VM_ENV_LOCAL_P(cfp->ep)) {
987 int ci_offset = local_size - ISEQ_BODY(cfp->iseq)->param.size + VM_ENV_DATA_SIZE;
989 CALL_INFO ci = (CALL_INFO)VM_CF_LEP(cfp)[-ci_offset];
990 local_size += vm_ci_argc(ci);
992 local_size += VM_ENV_DATA_SIZE;
1007 env_size = local_size +
1015 MEMCPY(env_body, ep - (local_size - 1 ),
VALUE, local_size);
1017 env_ep = &env_body[local_size - 1 ];
1018 env_ep[VM_ENV_DATA_INDEX_ENV] = (
VALUE)env;
1020 env->iseq = (rb_iseq_t *)(VM_FRAME_RUBYFRAME_P(cfp) ? cfp->iseq : NULL);
1022 env->env = env_body;
1023 env->env_size = env_size;
1026 VM_ENV_FLAGS_SET(env_ep, VM_ENV_FLAG_ESCAPED | VM_ENV_FLAG_WB_REQUIRED);
1027 VM_STACK_ENV_WRITE(ep, 0, (
VALUE)env);
1030 for (i = 0; i < local_size; i++) {
1031 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1033 ep[-local_size + i] = 0;
1040 rb_yjit_invalidate_ep_is_bp(env->iseq);
1047vm_make_env_object(
const rb_execution_context_t *ec, rb_control_frame_t *cfp)
1049 VALUE envval = vm_make_env_each(ec, cfp);
1052 check_env_value((
const rb_env_t *)envval);
1059rb_vm_stack_to_heap(rb_execution_context_t *ec)
1061 rb_control_frame_t *cfp = ec->cfp;
1062 while ((cfp = rb_vm_get_binding_creatable_next_cfp(ec, cfp)) != 0) {
1063 vm_make_env_object(ec, cfp);
1064 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1069rb_vm_env_prev_env(
const rb_env_t *env)
1071 const VALUE *ep = env->ep;
1073 if (VM_ENV_LOCAL_P(ep)) {
1077 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1078 return VM_ENV_ENVVAL_PTR(prev_ep);
1083collect_local_variables_in_iseq(
const rb_iseq_t *iseq,
const struct local_var_list *vars)
1086 if (!iseq)
return 0;
1087 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1088 local_var_list_add(vars, ISEQ_BODY(iseq)->local_table[i]);
1097 if (VM_ENV_FLAGS(env->ep, VM_ENV_FLAG_ISOLATED))
break;
1098 collect_local_variables_in_iseq(env->iseq, vars);
1099 }
while ((env = rb_vm_env_prev_env(env)) != NULL);
1105 if (VM_ENV_ESCAPED_P(ep)) {
1106 collect_local_variables_in_env(VM_ENV_ENVVAL_PTR(ep), vars);
1115rb_vm_env_local_variables(
const rb_env_t *env)
1118 local_var_list_init(&vars);
1119 collect_local_variables_in_env(env, &vars);
1120 return local_var_list_finish(&vars);
1124rb_iseq_local_variables(
const rb_iseq_t *iseq)
1127 local_var_list_init(&vars);
1128 while (collect_local_variables_in_iseq(iseq, &vars)) {
1129 iseq = ISEQ_BODY(iseq)->parent_iseq;
1131 return local_var_list_finish(&vars);
1137vm_proc_create_from_captured(
VALUE klass,
1139 enum rb_block_type block_type,
1140 int8_t is_from_method, int8_t is_lambda)
1142 VALUE procval = rb_proc_alloc(klass);
1145 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), captured->ep));
1148 RB_OBJ_WRITE(procval, &proc->block.as.captured.code.val, captured->code.val);
1149 RB_OBJ_WRITE(procval, &proc->block.as.captured.self, captured->self);
1150 rb_vm_block_ep_update(procval, &proc->block, captured->ep);
1152 vm_block_type_set(&proc->block, block_type);
1153 proc->is_from_method = is_from_method;
1154 proc->is_lambda = is_lambda;
1163 switch (vm_block_type(src)) {
1164 case block_type_iseq:
1165 case block_type_ifunc:
1166 RB_OBJ_WRITE(obj, &dst->as.captured.self, src->as.captured.self);
1167 RB_OBJ_WRITE(obj, &dst->as.captured.code.val, src->as.captured.code.val);
1168 rb_vm_block_ep_update(obj, dst, src->as.captured.ep);
1170 case block_type_symbol:
1173 case block_type_proc:
1180proc_create(
VALUE klass,
const struct rb_block *block, int8_t is_from_method, int8_t is_lambda)
1182 VALUE procval = rb_proc_alloc(klass);
1185 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), vm_block_ep(block)));
1186 rb_vm_block_copy(procval, &proc->block, block);
1187 vm_block_type_set(&proc->block, block->type);
1188 proc->is_from_method = is_from_method;
1189 proc->is_lambda = is_lambda;
1195rb_proc_dup(
VALUE self)
1200 GetProcPtr(self, src);
1202 switch (vm_block_type(&src->block)) {
1203 case block_type_ifunc:
1204 procval = rb_func_proc_dup(self);
1207 procval = proc_create(
rb_obj_class(self), &src->block, src->is_from_method, src->is_lambda);
1226 if (SIZEOF_VOIDP > SIZEOF_LONG)
1235 if (SIZEOF_VOIDP > SIZEOF_LONG)
1241static enum rb_id_table_iterator_result
1242collect_outer_variable_names(
ID id,
VALUE val,
void *ptr)
1246 if (
id == rb_intern(
"yield")) {
1251 if (data->isolate ||
1256 store = &data->read_only;
1258 if (*store ==
Qfalse) *store = rb_ary_new();
1259 rb_ary_push(*store, ID2NUM(
id));
1261 return ID_TABLE_CONTINUE;
1265env_copy(
const VALUE *src_ep,
VALUE read_only_variables)
1268 VM_ASSERT(src_env->ep == src_ep);
1271 VALUE *ep = &env_body[src_env->env_size - 2];
1272 const rb_env_t *copied_env = vm_env_new(ep, env_body, src_env->env_size, src_env->iseq);
1275 RB_OBJ_WRITE(copied_env, &ep[VM_ENV_DATA_INDEX_ME_CREF], src_ep[VM_ENV_DATA_INDEX_ME_CREF]);
1276 ep[VM_ENV_DATA_INDEX_FLAGS] = src_ep[VM_ENV_DATA_INDEX_FLAGS] | VM_ENV_FLAG_ISOLATED;
1277 if (!VM_ENV_LOCAL_P(src_ep)) {
1278 VM_ENV_FLAGS_SET(ep, VM_ENV_FLAG_LOCAL);
1281 if (read_only_variables) {
1282 for (
int i=
RARRAY_LENINT(read_only_variables)-1; i>=0; i--) {
1285 for (
unsigned int j=0; j<ISEQ_BODY(src_env->iseq)->local_table_size; j++) {
1286 if (
id == ISEQ_BODY(src_env->iseq)->local_table[j]) {
1287 VALUE v = src_env->env[j];
1289 VALUE name = rb_id2str(
id);
1290 VALUE msg = rb_sprintf(
"can not make shareable Proc because it can refer"
1291 " unshareable object %+" PRIsVALUE
" from ", v);
1293 rb_str_catf(msg,
"variable '%" PRIsVALUE
"'", name);
1299 rb_ary_delete_at(read_only_variables, i);
1306 if (!VM_ENV_LOCAL_P(src_ep)) {
1307 const VALUE *prev_ep = VM_ENV_PREV_EP(src_env->ep);
1308 const rb_env_t *new_prev_env = env_copy(prev_ep, read_only_variables);
1309 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_GUARDED_PREV_EP(new_prev_env->ep);
1311 VM_ENV_FLAGS_UNSET(ep, VM_ENV_FLAG_LOCAL);
1314 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_BLOCK_HANDLER_NONE;
1324 const rb_env_t *env = env_copy(captured->ep, read_only_variables);
1325 *((
const VALUE **)&proc->block.as.captured.ep) = env->ep;
1330proc_shared_outer_variables(
struct rb_id_table *outer_variables,
bool isolate,
const char *message)
1338 rb_id_table_foreach(outer_variables, collect_outer_variable_names, (
void *)&data);
1340 if (data.ary !=
Qfalse) {
1341 VALUE str = rb_sprintf(
"can not %s because it accesses outer variables", message);
1342 VALUE ary = data.ary;
1343 const char *sep =
" (";
1346 if (!name)
continue;
1355 else if (data.yield) {
1356 rb_raise(rb_eArgError,
"can not %s because it uses 'yield'.", message);
1359 return data.read_only;
1363rb_proc_isolate_bang(
VALUE self)
1365 const rb_iseq_t *iseq = vm_proc_iseq(self);
1369 if (proc->block.type != block_type_iseq) rb_raise(
rb_eRuntimeError,
"not supported yet");
1371 if (ISEQ_BODY(iseq)->outer_variables) {
1372 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables,
true,
"isolate a Proc");
1375 proc_isolate_env(self, proc,
Qfalse);
1376 proc->is_isolated = TRUE;
1384rb_proc_isolate(
VALUE self)
1386 VALUE dst = rb_proc_dup(self);
1387 rb_proc_isolate_bang(dst);
1392rb_proc_ractor_make_shareable(
VALUE self)
1394 const rb_iseq_t *iseq = vm_proc_iseq(self);
1398 if (proc->block.type != block_type_iseq) rb_raise(
rb_eRuntimeError,
"not supported yet");
1401 rb_raise(rb_eRactorIsolationError,
1402 "Proc's self is not shareable: %" PRIsVALUE,
1408 if (ISEQ_BODY(iseq)->outer_variables) {
1409 read_only_variables =
1410 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables,
false,
"make a Proc shareable");
1413 proc_isolate_env(self, proc, read_only_variables);
1414 proc->is_isolated = TRUE;
1422rb_vm_make_proc_lambda(
const rb_execution_context_t *ec,
const struct rb_captured_block *captured,
VALUE klass, int8_t is_lambda)
1425 enum imemo_type code_type = imemo_type(captured->code.val);
1427 if (!VM_ENV_ESCAPED_P(captured->ep)) {
1428 rb_control_frame_t *cfp = VM_CAPTURED_BLOCK_TO_CFP(captured);
1429 vm_make_env_object(ec, cfp);
1432 VM_ASSERT(VM_EP_IN_HEAP_P(ec, captured->ep));
1433 VM_ASSERT(code_type == imemo_iseq || code_type == imemo_ifunc);
1435 procval = vm_proc_create_from_captured(klass, captured,
1436 code_type == imemo_iseq ? block_type_iseq : block_type_ifunc,
1439 if (code_type == imemo_ifunc) {
1441 if (ifunc->svar_lep) {
1442 VALUE ep0 = ifunc->svar_lep[0];
1446 ifunc->svar_lep = (
VALUE *)env->ep;
1450 if (ep0 & VM_ENV_FLAG_ESCAPED) {
1454 ifunc->svar_lep = NULL;
1466rb_vm_make_binding(
const rb_execution_context_t *ec,
const rb_control_frame_t *src_cfp)
1468 rb_control_frame_t *cfp = rb_vm_get_binding_creatable_next_cfp(ec, src_cfp);
1469 rb_control_frame_t *ruby_level_cfp = rb_vm_get_ruby_level_next_cfp(ec, src_cfp);
1470 VALUE bindval, envval;
1473 if (cfp == 0 || ruby_level_cfp == 0) {
1474 rb_raise(
rb_eRuntimeError,
"Can't create Binding Object on top of Fiber.");
1476 if (!VM_FRAME_RUBYFRAME_P(src_cfp) &&
1477 !VM_FRAME_RUBYFRAME_P(RUBY_VM_PREVIOUS_CONTROL_FRAME(src_cfp))) {
1478 rb_raise(
rb_eRuntimeError,
"Cannot create Binding object for non-Ruby caller");
1481 envval = vm_make_env_object(ec, cfp);
1483 GetBindingPtr(bindval, bind);
1484 vm_bind_update_env(bindval, bind, envval);
1485 RB_OBJ_WRITE(bindval, &bind->block.as.captured.self, cfp->self);
1486 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, cfp->iseq);
1487 RB_OBJ_WRITE(bindval, &bind->pathobj, ISEQ_BODY(ruby_level_cfp->iseq)->location.pathobj);
1488 bind->first_lineno = rb_vm_get_sourceline(ruby_level_cfp);
1494rb_binding_add_dynavars(
VALUE bindval,
rb_binding_t *bind,
int dyncount,
const ID *dynvars)
1496 VALUE envval, pathobj = bind->pathobj;
1497 VALUE path = pathobj_path(pathobj);
1498 VALUE realpath = pathobj_realpath(pathobj);
1501 rb_execution_context_t *ec = GET_EC();
1502 const rb_iseq_t *base_iseq, *iseq;
1503 rb_node_scope_t tmp_node;
1505 if (dyncount < 0)
return 0;
1507 base_block = &bind->block;
1508 base_iseq = vm_block_iseq(base_block);
1511 rb_ast_id_table_t *dyns =
ALLOCV(idtmp,
sizeof(rb_ast_id_table_t) + dyncount *
sizeof(
ID));
1512 dyns->size = dyncount;
1513 MEMCPY(dyns->ids, dynvars,
ID, dyncount);
1515 rb_node_init(RNODE(&tmp_node), NODE_SCOPE);
1516 tmp_node.nd_tbl = dyns;
1517 tmp_node.nd_body = 0;
1518 tmp_node.nd_args = 0;
1520 VALUE ast_value = rb_ruby_ast_new(RNODE(&tmp_node));
1523 iseq = rb_iseq_new(ast_value, ISEQ_BODY(base_iseq)->location.label, path, realpath, base_iseq, ISEQ_TYPE_EVAL);
1526 VALUE tempstr = rb_fstring_lit(
"<temp>");
1527 iseq = rb_iseq_new_top(ast_value, tempstr, tempstr, tempstr, NULL);
1529 tmp_node.nd_tbl = 0;
1532 vm_set_eval_stack(ec, iseq, 0, base_block);
1533 vm_bind_update_env(bindval, bind, envval = vm_make_env_object(ec, ec->cfp));
1534 rb_vm_pop_frame(ec);
1543invoke_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)
1545 int arg_size = ISEQ_BODY(iseq)->param.size;
1547 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_FINISH, self,
1548 VM_GUARDED_PREV_EP(captured->ep),
1550 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1551 ec->cfp->sp + arg_size,
1552 ISEQ_BODY(iseq)->local_table_size - arg_size,
1553 ISEQ_BODY(iseq)->stack_max);
1557invoke_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)
1560 int arg_size = ISEQ_BODY(iseq)->param.size;
1562 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
1564 vm_push_frame(ec, iseq,
type | VM_FRAME_FLAG_BMETHOD, self,
1565 VM_GUARDED_PREV_EP(captured->ep),
1567 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1568 ec->cfp->sp + 1 + arg_size,
1569 ISEQ_BODY(iseq)->local_table_size - arg_size,
1570 ISEQ_BODY(iseq)->stack_max);
1572 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_FINISH);
1575ALWAYS_INLINE(
static VALUE
1576 invoke_iseq_block_from_c(rb_execution_context_t *ec,
const struct rb_captured_block *captured,
1577 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1578 const rb_cref_t *cref,
int is_lambda,
const rb_callable_method_entry_t *me));
1581invoke_iseq_block_from_c(rb_execution_context_t *ec,
const struct rb_captured_block *captured,
1582 VALUE self,
int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler,
1583 const rb_cref_t *cref,
int is_lambda,
const rb_callable_method_entry_t *me)
1585 const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq);
1587 VALUE type = VM_FRAME_MAGIC_BLOCK | (is_lambda ? VM_FRAME_FLAG_LAMBDA : 0);
1588 rb_control_frame_t *cfp = ec->cfp;
1589 VALUE *sp = cfp->sp;
1590 int flags = (kw_splat ? VM_CALL_KW_SPLAT : 0);
1596 if (UNLIKELY(argc > VM_ARGC_STACK_MAX) &&
1597 (VM_ARGC_STACK_MAX >= 1 ||
1599 (argc != 1 || is_lambda))) {
1600 use_argv = vm_argv_ruby_array(av, argv, &flags, &argc, kw_splat);
1603 CHECK_VM_STACK_OVERFLOW(cfp, argc + 1);
1604 vm_check_canary(ec, sp);
1606 VALUE *stack_argv = sp;
1611 cfp->sp = stack_argv + argc;
1614 opt_pc = vm_yield_setup_args(ec, iseq, argc, stack_argv, flags, passed_block_handler,
1615 (is_lambda ? arg_setup_method : arg_setup_block));
1619 invoke_block(ec, iseq, self, captured, cref,
type, opt_pc);
1622 invoke_bmethod(ec, iseq, self, captured, me,
type, opt_pc);
1629invoke_block_from_c_bh(rb_execution_context_t *ec,
VALUE block_handler,
1630 int argc,
const VALUE *argv,
1631 int kw_splat,
VALUE passed_block_handler,
const rb_cref_t *cref,
1632 int is_lambda,
int force_blockarg)
1635 switch (vm_block_handler_type(block_handler)) {
1636 case block_handler_type_iseq:
1639 return invoke_iseq_block_from_c(ec, captured, captured->self,
1640 argc, argv, kw_splat, passed_block_handler,
1641 cref, is_lambda, NULL);
1643 case block_handler_type_ifunc:
1644 return vm_yield_with_cfunc(ec, VM_BH_TO_IFUNC_BLOCK(block_handler),
1645 VM_BH_TO_IFUNC_BLOCK(block_handler)->self,
1646 argc, argv, kw_splat, passed_block_handler, NULL);
1647 case block_handler_type_symbol:
1648 return vm_yield_with_symbol(ec, VM_BH_TO_SYMBOL(block_handler),
1649 argc, argv, kw_splat, passed_block_handler);
1650 case block_handler_type_proc:
1651 if (force_blockarg == FALSE) {
1652 is_lambda = block_proc_is_lambda(VM_BH_TO_PROC(block_handler));
1654 block_handler = vm_proc_to_block_handler(VM_BH_TO_PROC(block_handler));
1657 VM_UNREACHABLE(invoke_block_from_c_splattable);
1662check_block_handler(rb_execution_context_t *ec)
1664 VALUE block_handler = VM_CF_BLOCK_HANDLER(ec->cfp);
1665 vm_block_handler_verify(block_handler);
1666 if (UNLIKELY(block_handler == VM_BLOCK_HANDLER_NONE)) {
1667 rb_vm_localjump_error(
"no block given",
Qnil, 0);
1670 return block_handler;
1674vm_yield_with_cref(rb_execution_context_t *ec,
int argc,
const VALUE *argv,
int kw_splat,
const rb_cref_t *cref,
int is_lambda)
1676 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1677 argc, argv, kw_splat, VM_BLOCK_HANDLER_NONE,
1678 cref, is_lambda, FALSE);
1682vm_yield(rb_execution_context_t *ec,
int argc,
const VALUE *argv,
int kw_splat)
1684 return vm_yield_with_cref(ec, argc, argv, kw_splat, NULL, FALSE);
1688vm_yield_with_block(rb_execution_context_t *ec,
int argc,
const VALUE *argv,
VALUE block_handler,
int kw_splat)
1690 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1691 argc, argv, kw_splat, block_handler,
1692 NULL, FALSE, FALSE);
1696vm_yield_force_blockarg(rb_execution_context_t *ec,
VALUE args)
1698 return invoke_block_from_c_bh(ec, check_block_handler(ec), 1, &args,
1702ALWAYS_INLINE(
static VALUE
1703 invoke_block_from_c_proc(rb_execution_context_t *ec,
const rb_proc_t *proc,
1705 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
1706 const rb_callable_method_entry_t *me));
1709invoke_block_from_c_proc(rb_execution_context_t *ec,
const rb_proc_t *proc,
1711 int kw_splat,
VALUE passed_block_handler,
int is_lambda,
1712 const rb_callable_method_entry_t *me)
1714 const struct rb_block *block = &proc->block;
1717 switch (vm_block_type(block)) {
1718 case block_type_iseq:
1719 return invoke_iseq_block_from_c(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, NULL, is_lambda, me);
1720 case block_type_ifunc:
1721 if (kw_splat == 1) {
1722 VALUE keyword_hash = argv[argc-1];
1724 keyword_hash = rb_to_hash_type(keyword_hash);
1730 ((
VALUE *)argv)[argc-1] = rb_hash_dup(keyword_hash);
1733 return vm_yield_with_cfunc(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, me);
1734 case block_type_symbol:
1735 return vm_yield_with_symbol(ec, block->as.symbol, argc, argv, kw_splat, passed_block_handler);
1736 case block_type_proc:
1737 is_lambda = block_proc_is_lambda(block->as.proc);
1738 block = vm_proc_block(block->as.proc);
1741 VM_UNREACHABLE(invoke_block_from_c_proc);
1746vm_invoke_proc(rb_execution_context_t *ec,
rb_proc_t *proc,
VALUE self,
1747 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler)
1749 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, proc->is_lambda, NULL);
1753vm_invoke_bmethod(rb_execution_context_t *ec,
rb_proc_t *proc,
VALUE self,
1754 int argc,
const VALUE *argv,
int kw_splat,
VALUE block_handler,
const rb_callable_method_entry_t *me)
1756 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, block_handler, TRUE, me);
1760rb_vm_invoke_proc(rb_execution_context_t *ec,
rb_proc_t *proc,
1761 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler)
1763 VALUE self = vm_block_self(&proc->block);
1764 vm_block_handler_verify(passed_block_handler);
1766 if (proc->is_from_method) {
1767 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
1770 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler);
1775rb_vm_invoke_proc_with_self(rb_execution_context_t *ec,
rb_proc_t *proc,
VALUE self,
1776 int argc,
const VALUE *argv,
int kw_splat,
VALUE passed_block_handler)
1778 vm_block_handler_verify(passed_block_handler);
1780 if (proc->is_from_method) {
1781 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
1784 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler);
1791rb_vm_svar_lep(
const rb_execution_context_t *ec,
const rb_control_frame_t *cfp)
1793 while (cfp->pc == 0 || cfp->iseq == 0) {
1794 if (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_IFUNC) {
1796 return ifunc->svar_lep;
1799 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1802 if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
1807 return (
VALUE *)VM_CF_LEP(cfp);
1811vm_cfp_svar_get(
const rb_execution_context_t *ec, rb_control_frame_t *cfp,
VALUE key)
1813 return lep_svar_get(ec, rb_vm_svar_lep(ec, cfp), key);
1817vm_cfp_svar_set(
const rb_execution_context_t *ec, rb_control_frame_t *cfp,
VALUE key,
const VALUE val)
1819 lep_svar_set(ec, rb_vm_svar_lep(ec, cfp), key, val);
1823vm_svar_get(
const rb_execution_context_t *ec,
VALUE key)
1825 return vm_cfp_svar_get(ec, ec->cfp, key);
1829vm_svar_set(
const rb_execution_context_t *ec,
VALUE key,
VALUE val)
1831 vm_cfp_svar_set(ec, ec->cfp, key, val);
1837 return vm_svar_get(GET_EC(), VM_SVAR_BACKREF);
1843 vm_svar_set(GET_EC(), VM_SVAR_BACKREF, val);
1849 return vm_svar_get(GET_EC(), VM_SVAR_LASTLINE);
1855 vm_svar_set(GET_EC(), VM_SVAR_LASTLINE, val);
1859rb_lastline_set_up(
VALUE val,
unsigned int up)
1861 rb_control_frame_t * cfp = GET_EC()->cfp;
1863 for(
unsigned int i = 0; i < up; i++) {
1864 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1866 vm_cfp_svar_set(GET_EC(), cfp, VM_SVAR_LASTLINE, val);
1874 const rb_execution_context_t *ec = GET_EC();
1875 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1878 return RSTRING_PTR(rb_iseq_path(cfp->iseq));
1888 const rb_execution_context_t *ec = GET_EC();
1889 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1892 return rb_vm_get_sourceline(cfp);
1900rb_source_location(
int *pline)
1902 const rb_execution_context_t *ec = GET_EC();
1903 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1905 if (cfp && VM_FRAME_RUBYFRAME_P(cfp)) {
1906 if (pline) *pline = rb_vm_get_sourceline(cfp);
1907 return rb_iseq_path(cfp->iseq);
1910 if (pline) *pline = 0;
1916rb_source_location_cstr(
int *pline)
1918 VALUE path = rb_source_location(pline);
1919 if (
NIL_P(path))
return NULL;
1920 return RSTRING_PTR(path);
1926 const rb_execution_context_t *ec = GET_EC();
1927 return vm_ec_cref(ec);
1931rb_vm_cref_replace_with_duplicated_cref(
void)
1933 const rb_execution_context_t *ec = GET_EC();
1934 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1935 rb_cref_t *cref = vm_cref_replace_with_duplicated_cref(cfp->ep);
1941rb_vm_cref_in_context(
VALUE self,
VALUE cbase)
1943 const rb_execution_context_t *ec = GET_EC();
1944 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1945 const rb_cref_t *cref;
1946 if (!cfp || cfp->self != self)
return NULL;
1947 if (!vm_env_cref_by_cref(cfp->ep))
return NULL;
1948 cref = vm_get_cref(cfp->ep);
1949 if (CREF_CLASS(cref) != cbase)
return NULL;
1955debug_cref(rb_cref_t *cref)
1958 dp(CREF_CLASS(cref));
1959 printf(
"%ld\n", CREF_VISI(cref));
1960 cref = CREF_NEXT(cref);
1968 const rb_execution_context_t *ec = GET_EC();
1969 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1974 return vm_get_cbase(cfp->ep);
1980make_localjump_error(
const char *mesg,
VALUE value,
int reason)
2012rb_vm_localjump_error(
const char *mesg,
VALUE value,
int reason)
2014 VALUE exc = make_localjump_error(mesg, value, reason);
2019rb_vm_make_jump_tag_but_local_jump(
enum ruby_tag_type state,
VALUE val)
2025 mesg =
"unexpected return";
2028 mesg =
"unexpected break";
2031 mesg =
"unexpected next";
2034 mesg =
"unexpected redo";
2038 mesg =
"retry outside of rescue clause";
2045 val = GET_EC()->tag->retval;
2047 return make_localjump_error(mesg, val, state);
2051rb_vm_jump_tag_but_local_jump(
enum ruby_tag_type state)
2053 VALUE exc = rb_vm_make_jump_tag_but_local_jump(state,
Qundef);
2054 if (!
NIL_P(exc)) rb_exc_raise(exc);
2055 EC_JUMP_TAG(GET_EC(), state);
2058static rb_control_frame_t *
2059next_not_local_frame(rb_control_frame_t *cfp)
2061 while (VM_ENV_LOCAL_P(cfp->ep)) {
2062 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2067NORETURN(
static void vm_iter_break(rb_execution_context_t *ec,
VALUE val));
2070vm_iter_break(rb_execution_context_t *ec,
VALUE val)
2072 rb_control_frame_t *cfp = next_not_local_frame(ec->cfp);
2073 const VALUE *ep = VM_CF_PREV_EP(cfp);
2074 const rb_control_frame_t *target_cfp = rb_vm_search_cf_from_ep(ec, cfp, ep);
2077 rb_vm_localjump_error(
"unexpected break", val, TAG_BREAK);
2080 ec->errinfo = (
VALUE)THROW_DATA_NEW(val, target_cfp, TAG_BREAK);
2081 EC_JUMP_TAG(ec, TAG_BREAK);
2087 vm_iter_break(GET_EC(),
Qnil);
2093 vm_iter_break(GET_EC(), val);
2098short ruby_vm_redefined_flag[BOP_LAST_];
2099static st_table *vm_opt_method_def_table = 0;
2100static st_table *vm_opt_mid_table = 0;
2103rb_free_vm_opt_tables(
void)
2105 st_free_table(vm_opt_method_def_table);
2106 st_free_table(vm_opt_mid_table);
2110vm_redefinition_check_flag(
VALUE klass)
2112 if (klass ==
rb_cInteger)
return INTEGER_REDEFINED_OP_FLAG;
2113 if (klass ==
rb_cFloat)
return FLOAT_REDEFINED_OP_FLAG;
2114 if (klass ==
rb_cString)
return STRING_REDEFINED_OP_FLAG;
2115 if (klass ==
rb_cArray)
return ARRAY_REDEFINED_OP_FLAG;
2116 if (klass ==
rb_cHash)
return HASH_REDEFINED_OP_FLAG;
2117 if (klass ==
rb_cSymbol)
return SYMBOL_REDEFINED_OP_FLAG;
2119 if (klass ==
rb_cTime)
return TIME_REDEFINED_OP_FLAG;
2121 if (klass ==
rb_cRegexp)
return REGEXP_REDEFINED_OP_FLAG;
2122 if (klass ==
rb_cNilClass)
return NIL_REDEFINED_OP_FLAG;
2125 if (klass ==
rb_cProc)
return PROC_REDEFINED_OP_FLAG;
2130rb_vm_check_optimizable_mid(
VALUE mid)
2132 if (!vm_opt_mid_table) {
2136 return st_lookup(vm_opt_mid_table, mid, NULL);
2140vm_redefinition_check_method_type(
const rb_method_entry_t *me)
2142 if (me->called_id != me->def->original_id) {
2146 if (METHOD_ENTRY_BASIC(me))
return TRUE;
2148 const rb_method_definition_t *def = me->def;
2149 switch (def->type) {
2150 case VM_METHOD_TYPE_CFUNC:
2151 case VM_METHOD_TYPE_OPTIMIZED:
2159rb_vm_check_redefinition_opt_method(
const rb_method_entry_t *me,
VALUE klass)
2166 if (vm_redefinition_check_method_type(me)) {
2167 if (st_lookup(vm_opt_method_def_table, (st_data_t)me->def, &bop)) {
2168 int flag = vm_redefinition_check_flag(klass);
2172 "Redefining '%s#%s' disables interpreter and JIT optimizations",
2174 rb_id2name(me->called_id)
2176 rb_yjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2177 rb_rjit_bop_redefined(flag, (
enum ruby_basic_operators)bop);
2178 ruby_vm_redefined_flag[bop] |= flag;
2184static enum rb_id_table_iterator_result
2185check_redefined_method(
ID mid,
VALUE value,
void *data)
2188 const rb_method_entry_t *me = (rb_method_entry_t *)value;
2189 const rb_method_entry_t *newme = rb_method_entry(klass, mid);
2191 if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner);
2193 return ID_TABLE_CONTINUE;
2197rb_vm_check_redefinition_by_prepend(
VALUE klass)
2199 if (!vm_redefinition_check_flag(klass))
return;
2200 rb_id_table_foreach(RCLASS_M_TBL(RCLASS_ORIGIN(klass)), check_redefined_method, (
void *)klass);
2204add_opt_method_entry_bop(
const rb_method_entry_t *me,
ID mid,
enum ruby_basic_operators bop)
2206 st_insert(vm_opt_method_def_table, (st_data_t)me->def, (st_data_t)bop);
2207 st_insert(vm_opt_mid_table, (st_data_t)mid, (st_data_t)
Qtrue);
2211add_opt_method(
VALUE klass,
ID mid,
enum ruby_basic_operators bop)
2213 const rb_method_entry_t *me = rb_method_entry_at(klass, mid);
2215 if (me && vm_redefinition_check_method_type(me)) {
2216 add_opt_method_entry_bop(me, mid, bop);
2219 rb_bug(
"undefined optimized method: %s", rb_id2name(mid));
2223static enum ruby_basic_operators vm_redefinition_bop_for_id(
ID mid);
2226add_opt_method_entry(
const rb_method_entry_t *me)
2228 if (me && vm_redefinition_check_method_type(me)) {
2229 ID mid = me->called_id;
2230 enum ruby_basic_operators bop = vm_redefinition_bop_for_id(mid);
2231 if ((
int)bop >= 0) {
2232 add_opt_method_entry_bop(me, mid, bop);
2238vm_init_redefined_flag(
void)
2241 enum ruby_basic_operators bop;
2243#define OP(mid_, bop_) (mid = id##mid_, bop = BOP_##bop_, ruby_vm_redefined_flag[bop] = 0)
2244#define C(k) add_opt_method(rb_c##k, mid, bop)
2245 OP(PLUS, PLUS), (C(Integer), C(Float), C(String), C(Array));
2246 OP(MINUS, MINUS), (C(Integer), C(Float));
2247 OP(MULT, MULT), (C(Integer), C(Float));
2248 OP(DIV, DIV), (C(Integer), C(Float));
2249 OP(MOD, MOD), (C(Integer), C(Float));
2250 OP(Eq, EQ), (C(Integer), C(Float), C(String), C(Symbol));
2251 OP(Eqq, EQQ), (C(Integer), C(Float), C(Symbol), C(String),
2252 C(NilClass), C(TrueClass), C(FalseClass));
2253 OP(LT, LT), (C(Integer), C(Float));
2254 OP(LE, LE), (C(Integer), C(Float));
2255 OP(GT, GT), (C(Integer), C(Float));
2256 OP(GE, GE), (C(Integer), C(Float));
2257 OP(LTLT, LTLT), (C(String), C(Array));
2258 OP(AREF, AREF), (C(Array), C(Hash), C(Integer));
2259 OP(ASET, ASET), (C(Array), C(Hash));
2260 OP(Length, LENGTH), (C(Array), C(String), C(Hash));
2261 OP(Size, SIZE), (C(Array), C(String), C(Hash));
2262 OP(EmptyP, EMPTY_P), (C(Array), C(String), C(Hash));
2263 OP(Succ, SUCC), (C(Integer), C(String));
2264 OP(EqTilde, MATCH), (C(
Regexp), C(String));
2265 OP(Freeze, FREEZE), (C(String), C(Array), C(Hash));
2266 OP(UMinus, UMINUS), (C(String));
2267 OP(Max, MAX), (C(Array));
2268 OP(Min, MIN), (C(Array));
2269 OP(Hash, HASH), (C(Array));
2270 OP(Call, CALL), (C(Proc));
2271 OP(And, AND), (C(Integer));
2272 OP(Or, OR), (C(Integer));
2273 OP(NilP,
NIL_P), (C(NilClass));
2274 OP(Cmp, CMP), (C(Integer), C(Float), C(String));
2275 OP(Default, DEFAULT), (C(Hash));
2276 OP(IncludeP, INCLUDE_P), (C(Array));
2281static enum ruby_basic_operators
2282vm_redefinition_bop_for_id(
ID mid)
2285#define OP(mid_, bop_) case id##mid_: return BOP_##bop_
2302 OP(EmptyP, EMPTY_P);
2315 OP(Default, DEFAULT);
2326vm_frametype_name(
const rb_control_frame_t *cfp)
2328 switch (VM_FRAME_TYPE(cfp)) {
2329 case VM_FRAME_MAGIC_METHOD:
return "method";
2330 case VM_FRAME_MAGIC_BLOCK:
return "block";
2331 case VM_FRAME_MAGIC_CLASS:
return "class";
2332 case VM_FRAME_MAGIC_TOP:
return "top";
2333 case VM_FRAME_MAGIC_CFUNC:
return "cfunc";
2334 case VM_FRAME_MAGIC_IFUNC:
return "ifunc";
2335 case VM_FRAME_MAGIC_EVAL:
return "eval";
2336 case VM_FRAME_MAGIC_RESCUE:
return "rescue";
2338 rb_bug(
"unknown frame");
2346 if (THROW_DATA_P(err) &&
2347 THROW_DATA_STATE(err) == TAG_BREAK &&
2348 THROW_DATA_CONSUMED_P(err) == FALSE) {
2349 return THROW_DATA_VAL(err);
2359frame_name(
const rb_control_frame_t *cfp)
2361 unsigned long type = VM_FRAME_TYPE(cfp);
2362#define C(t) if (type == VM_FRAME_MAGIC_##t) return #t
2382hook_before_rewind(rb_execution_context_t *ec,
bool cfp_returning_with_value,
int state,
struct vm_throw_data *err)
2388 const rb_iseq_t *iseq = ec->cfp->iseq;
2389 rb_hook_list_t *local_hooks = iseq->aux.exec.local_hooks;
2391 switch (VM_FRAME_TYPE(ec->cfp)) {
2392 case VM_FRAME_MAGIC_METHOD:
2393 RUBY_DTRACE_METHOD_RETURN_HOOK(ec, 0, 0);
2394 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2398 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2401 THROW_DATA_CONSUMED_SET(err);
2403 case VM_FRAME_MAGIC_BLOCK:
2404 if (VM_FRAME_BMETHOD_P(ec->cfp)) {
2405 VALUE bmethod_return_value = frame_return_value(err);
2406 if (cfp_returning_with_value) {
2408 bmethod_return_value = THROW_DATA_VAL(err);
2412 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, bmethod_return_value);
2415 ec->cfp->self, 0, 0, 0, bmethod_return_value, TRUE);
2418 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(ec->cfp);
2421 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2422 rb_vm_frame_method_entry(ec->cfp)->called_id,
2423 rb_vm_frame_method_entry(ec->cfp)->owner,
2424 bmethod_return_value);
2426 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
2427 local_hooks = me->def->body.bmethod.hooks;
2431 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2432 rb_vm_frame_method_entry(ec->cfp)->called_id,
2433 rb_vm_frame_method_entry(ec->cfp)->owner,
2434 bmethod_return_value, TRUE);
2436 THROW_DATA_CONSUMED_SET(err);
2439 EXEC_EVENT_HOOK_AND_POP_FRAME(ec,
RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2442 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2444 THROW_DATA_CONSUMED_SET(err);
2447 case VM_FRAME_MAGIC_CLASS:
2535vm_exec_handle_exception(rb_execution_context_t *ec,
enum ruby_tag_type state,
VALUE errinfo);
2537vm_exec_loop(rb_execution_context_t *ec,
enum ruby_tag_type state,
struct rb_vm_tag *tag,
VALUE result);
2540#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2542struct rb_vm_exec_context {
2543 rb_execution_context_t *
const ec;
2544 struct rb_vm_tag *
const tag;
2550vm_exec_bottom_main(
void *context)
2552 struct rb_vm_exec_context *ctx = context;
2553 rb_execution_context_t *ec = ctx->ec;
2555 ctx->result = vm_exec_loop(ec, TAG_NONE, ctx->tag, vm_exec_core(ec));
2559vm_exec_bottom_rescue(
void *context)
2561 struct rb_vm_exec_context *ctx = context;
2562 rb_execution_context_t *ec = ctx->ec;
2564 ctx->result = vm_exec_loop(ec, rb_ec_tag_state(ec), ctx->tag, ec->errinfo);
2569vm_exec(rb_execution_context_t *ec)
2577#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2578 struct rb_vm_exec_context ctx = {
2586 rb_wasm_try_catch_init(&try_catch, vm_exec_bottom_main, vm_exec_bottom_rescue, &ctx);
2588 rb_wasm_try_catch_loop_run(&try_catch, &RB_VM_TAG_JMPBUF_GET(_tag.buf));
2590 result = ctx.result;
2592 enum ruby_tag_type state;
2593 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2594 if (UNDEF_P(result = jit_exec(ec))) {
2595 result = vm_exec_core(ec);
2598 result = vm_exec_loop(ec, TAG_NONE, &_tag, result);
2601 result = vm_exec_loop(ec, state, &_tag, ec->errinfo);
2610vm_exec_loop(rb_execution_context_t *ec,
enum ruby_tag_type state,
2613 if (state == TAG_NONE) {
2617 rb_ec_raised_reset(ec, RAISED_STACKOVERFLOW | RAISED_NOMEMORY);
2618 while (UNDEF_P(result = vm_exec_handle_exception(ec, state, result))) {
2621 if (UNDEF_P(result = jit_exec_exception(ec))) {
2622 result = vm_exec_core(ec);
2625 VM_ASSERT(ec->tag == tag);
2627 if ((state = tag->state) == TAG_NONE)
break;
2628 tag->state = TAG_NONE;
2635vm_exec_handle_exception(rb_execution_context_t *ec,
enum ruby_tag_type state,
VALUE errinfo)
2643 unsigned long epc, cont_pc, cont_sp;
2644 const rb_iseq_t *catch_iseq;
2646 const rb_control_frame_t *escape_cfp;
2648 cont_pc = cont_sp = 0;
2651 while (ec->cfp->pc == 0 || ec->cfp->iseq == 0) {
2652 if (UNLIKELY(VM_FRAME_TYPE(ec->cfp) == VM_FRAME_MAGIC_CFUNC)) {
2654 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2655 rb_vm_frame_method_entry(ec->cfp)->called_id,
2656 rb_vm_frame_method_entry(ec->cfp)->owner,
Qnil);
2657 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec,
2658 rb_vm_frame_method_entry(ec->cfp)->owner,
2659 rb_vm_frame_method_entry(ec->cfp)->def->original_id);
2661 rb_vm_pop_frame(ec);
2664 rb_control_frame_t *
const cfp = ec->cfp;
2665 epc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded;
2668 if (state == TAG_BREAK || state == TAG_RETURN) {
2669 escape_cfp = THROW_DATA_CATCH_FRAME(err);
2671 if (cfp == escape_cfp) {
2672 if (state == TAG_RETURN) {
2673 if (!VM_FRAME_FINISHED_P(cfp)) {
2674 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
2675 THROW_DATA_STATE_SET(err, state = TAG_BREAK);
2678 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2679 if (ct)
for (i = 0; i < ct->size; i++) {
2680 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2681 if (entry->start < epc && entry->end >= epc) {
2682 if (entry->type == CATCH_TYPE_ENSURE) {
2683 catch_iseq = entry->iseq;
2684 cont_pc = entry->cont;
2685 cont_sp = entry->sp;
2690 if (catch_iseq == NULL) {
2692 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
2694 hook_before_rewind(ec,
true, state, err);
2695 rb_vm_pop_frame(ec);
2696 return THROW_DATA_VAL(err);
2703 *cfp->sp++ = THROW_DATA_VAL(err);
2710 if (state == TAG_RAISE) {
2711 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2712 if (ct)
for (i = 0; i < ct->size; i++) {
2713 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2714 if (entry->start < epc && entry->end >= epc) {
2716 if (entry->type == CATCH_TYPE_RESCUE ||
2717 entry->type == CATCH_TYPE_ENSURE) {
2718 catch_iseq = entry->iseq;
2719 cont_pc = entry->cont;
2720 cont_sp = entry->sp;
2726 else if (state == TAG_RETRY) {
2727 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2728 if (ct)
for (i = 0; i < ct->size; i++) {
2729 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2730 if (entry->start < epc && entry->end >= epc) {
2732 if (entry->type == CATCH_TYPE_ENSURE) {
2733 catch_iseq = entry->iseq;
2734 cont_pc = entry->cont;
2735 cont_sp = entry->sp;
2738 else if (entry->type == CATCH_TYPE_RETRY) {
2739 const rb_control_frame_t *escape_cfp;
2740 escape_cfp = THROW_DATA_CATCH_FRAME(err);
2741 if (cfp == escape_cfp) {
2742 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + entry->cont;
2750 else if ((state == TAG_BREAK && !escape_cfp) ||
2751 (state == TAG_REDO) ||
2752 (state == TAG_NEXT)) {
2753 type = (
const enum rb_catch_type[TAG_MASK]) {
2754 [TAG_BREAK] = CATCH_TYPE_BREAK,
2755 [TAG_NEXT] = CATCH_TYPE_NEXT,
2756 [TAG_REDO] = CATCH_TYPE_REDO,
2760 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2761 if (ct)
for (i = 0; i < ct->size; i++) {
2762 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2764 if (entry->start < epc && entry->end >= epc) {
2765 if (entry->type == CATCH_TYPE_ENSURE) {
2766 catch_iseq = entry->iseq;
2767 cont_pc = entry->cont;
2768 cont_sp = entry->sp;
2771 else if (entry->type ==
type) {
2772 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + entry->cont;
2773 cfp->sp = vm_base_ptr(cfp) + entry->sp;
2775 if (state != TAG_REDO) {
2776 *cfp->sp++ = THROW_DATA_VAL(err);
2779 VM_ASSERT(ec->tag->state == TAG_NONE);
2786 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2787 if (ct)
for (i = 0; i < ct->size; i++) {
2788 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2789 if (entry->start < epc && entry->end >= epc) {
2791 if (entry->type == CATCH_TYPE_ENSURE) {
2792 catch_iseq = entry->iseq;
2793 cont_pc = entry->cont;
2794 cont_sp = entry->sp;
2801 if (catch_iseq != NULL) {
2803 const int arg_size = 1;
2805 rb_iseq_check(catch_iseq);
2806 cfp->sp = vm_base_ptr(cfp) + cont_sp;
2807 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + cont_pc;
2810 cfp->sp[0] = (
VALUE)err;
2811 vm_push_frame(ec, catch_iseq, VM_FRAME_MAGIC_RESCUE,
2813 VM_GUARDED_PREV_EP(cfp->ep),
2815 ISEQ_BODY(catch_iseq)->iseq_encoded,
2816 cfp->sp + arg_size ,
2817 ISEQ_BODY(catch_iseq)->local_table_size - arg_size,
2818 ISEQ_BODY(catch_iseq)->stack_max);
2821 ec->tag->state = TAG_NONE;
2827 hook_before_rewind(ec, (cfp == escape_cfp), state, err);
2829 if (VM_FRAME_FINISHED_P(ec->cfp)) {
2830 rb_vm_pop_frame(ec);
2831 ec->errinfo = (
VALUE)err;
2832 ec->tag = ec->tag->prev;
2833 EC_JUMP_TAG(ec, state);
2836 rb_vm_pop_frame(ec);
2845rb_iseq_eval(
const rb_iseq_t *iseq)
2847 rb_execution_context_t *ec = GET_EC();
2849 vm_set_top_stack(ec, iseq);
2855rb_iseq_eval_main(
const rb_iseq_t *iseq)
2857 rb_execution_context_t *ec = GET_EC();
2860 vm_set_main_stack(ec, iseq);
2866rb_vm_control_frame_id_and_class(
const rb_control_frame_t *cfp,
ID *idp,
ID *called_idp,
VALUE *klassp)
2868 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
2871 if (idp) *idp = me->def->original_id;
2872 if (called_idp) *called_idp = me->called_id;
2873 if (klassp) *klassp = me->owner;
2882rb_ec_frame_method_id_and_class(
const rb_execution_context_t *ec,
ID *idp,
ID *called_idp,
VALUE *klassp)
2884 return rb_vm_control_frame_id_and_class(ec->cfp, idp, called_idp, klassp);
2890 return rb_ec_frame_method_id_and_class(GET_EC(), idp, 0, klassp);
2897 rb_execution_context_t *ec = GET_EC();
2898 const rb_control_frame_t *reg_cfp = ec->cfp;
2899 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
2902 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
2903 recv, block_handler,
2904 (
VALUE)vm_cref_new_toplevel(ec),
2905 0, reg_cfp->sp, 0, 0);
2909 rb_vm_pop_frame(ec);
2916rb_vm_update_references(
void *ptr)
2921 rb_gc_update_tbl_refs(vm->ci_table);
2922 rb_gc_update_tbl_refs(vm->frozen_strings);
2923 vm->mark_object_ary = rb_gc_location(vm->mark_object_ary);
2924 vm->load_path = rb_gc_location(vm->load_path);
2925 vm->load_path_snapshot = rb_gc_location(vm->load_path_snapshot);
2927 if (vm->load_path_check_cache) {
2928 vm->load_path_check_cache = rb_gc_location(vm->load_path_check_cache);
2931 vm->expanded_load_path = rb_gc_location(vm->expanded_load_path);
2932 vm->loaded_features = rb_gc_location(vm->loaded_features);
2933 vm->loaded_features_snapshot = rb_gc_location(vm->loaded_features_snapshot);
2934 vm->loaded_features_realpaths = rb_gc_location(vm->loaded_features_realpaths);
2935 vm->loaded_features_realpath_map = rb_gc_location(vm->loaded_features_realpath_map);
2936 vm->top_self = rb_gc_location(vm->top_self);
2937 vm->orig_progname = rb_gc_location(vm->orig_progname);
2939 rb_gc_update_tbl_refs(vm->overloaded_cme_table);
2941 rb_gc_update_values(RUBY_NSIG, vm->trap_list.cmd);
2943 if (vm->coverages) {
2944 vm->coverages = rb_gc_location(vm->coverages);
2945 vm->me2counter = rb_gc_location(vm->me2counter);
2951rb_vm_each_stack_value(
void *ptr,
void (*cb)(
VALUE,
void*),
void *ctx)
2956 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
2957 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
2958 rb_ractor_status_p(r, ractor_running));
2959 if (r->threads.cnt > 0) {
2960 rb_thread_t *th = 0;
2961 ccan_list_for_each(&r->threads.set, th, lt_node) {
2962 VM_ASSERT(th != NULL);
2963 rb_execution_context_t * ec = th->ec;
2965 VALUE *p = ec->vm_stack;
2966 VALUE *sp = ec->cfp->sp;
2980static enum rb_id_table_iterator_result
2981vm_mark_negative_cme(
VALUE val,
void *dmy)
2984 return ID_TABLE_CONTINUE;
2987void rb_thread_sched_mark_zombies(rb_vm_t *vm);
2990rb_vm_mark(
void *ptr)
2992 RUBY_MARK_ENTER(
"vm");
2993 RUBY_GC_INFO(
"-------------------------------------------------\n");
2999 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3001 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3002 rb_ractor_status_p(r, ractor_running));
3003 rb_gc_mark(rb_ractor_self(r));
3006 for (
struct global_object_list *list = vm->global_object_list; list; list = list->next) {
3007 rb_gc_mark_maybe(*list->varptr);
3010 rb_gc_mark_movable(vm->mark_object_ary);
3011 rb_gc_mark_movable(vm->load_path);
3012 rb_gc_mark_movable(vm->load_path_snapshot);
3013 rb_gc_mark_movable(vm->load_path_check_cache);
3014 rb_gc_mark_movable(vm->expanded_load_path);
3015 rb_gc_mark_movable(vm->loaded_features);
3016 rb_gc_mark_movable(vm->loaded_features_snapshot);
3017 rb_gc_mark_movable(vm->loaded_features_realpaths);
3018 rb_gc_mark_movable(vm->loaded_features_realpath_map);
3019 rb_gc_mark_movable(vm->top_self);
3020 rb_gc_mark_movable(vm->orig_progname);
3021 rb_gc_mark_movable(vm->coverages);
3022 rb_gc_mark_movable(vm->me2counter);
3024 if (vm->loading_table) {
3025 rb_mark_tbl(vm->loading_table);
3028 rb_gc_mark_values(RUBY_NSIG, vm->trap_list.cmd);
3030 rb_id_table_foreach_values(vm->negative_cme_table, vm_mark_negative_cme, NULL);
3031 rb_mark_tbl_no_pin(vm->overloaded_cme_table);
3032 for (i=0; i<VM_GLOBAL_CC_CACHE_TABLE_SIZE; i++) {
3033 const struct rb_callcache *cc = vm->global_cc_cache_table[i];
3036 if (!vm_cc_invalidated_p(cc)) {
3037 rb_gc_mark((
VALUE)cc);
3040 vm->global_cc_cache_table[i] = NULL;
3045 rb_thread_sched_mark_zombies(vm);
3049 RUBY_MARK_LEAVE(
"vm");
3052#undef rb_vm_register_special_exception
3054rb_vm_register_special_exception_str(
enum ruby_special_exceptions sp,
VALUE cls,
VALUE mesg)
3056 rb_vm_t *vm = GET_VM();
3059 ((
VALUE *)vm->special_exceptions)[sp] = exc;
3060 rb_vm_register_global_object(exc);
3064free_loading_table_entry(st_data_t key, st_data_t value, st_data_t arg)
3070void rb_free_loaded_features_index(rb_vm_t *vm);
3071void rb_objspace_free_objects(
void *
objspace);
3076 RUBY_FREE_ENTER(
"vm");
3079 rb_thread_t *th = vm->ractor.main_thread;
3080 VALUE *stack = th->ec->vm_stack;
3081 if (rb_free_at_exit) {
3082 rb_free_encoded_insn_data();
3083 rb_free_global_enc_table();
3084 rb_free_loaded_builtin_table();
3086 rb_free_shared_fiber_pool();
3087 rb_free_static_symid_str();
3088 rb_free_transcoder_table();
3089 rb_free_vm_opt_tables();
3091 rb_free_rb_global_tbl();
3092 rb_free_loaded_features_index(vm);
3094 rb_id_table_free(vm->negative_cme_table);
3095 st_free_table(vm->overloaded_cme_table);
3097 rb_id_table_free(
RCLASS(rb_mRubyVMFrozenCore)->m_tbl);
3099 rb_shape_t *cursor = rb_shape_get_root_shape();
3100 rb_shape_t *end = rb_shape_get_shape_by_id(GET_SHAPE_TREE()->next_shape_id);
3101 while (cursor < end) {
3103 if (cursor->edges && !(((uintptr_t)cursor->edges) & 0x1))
3104 rb_id_table_free(cursor->edges);
3108 xfree(GET_SHAPE_TREE());
3110 st_free_table(vm->static_ext_inits);
3112 rb_vm_postponed_job_free();
3114 rb_id_table_free(vm->constant_cache);
3115 st_free_table(vm->unused_block_warning_table);
3120#ifndef HAVE_SETPROCTITLE
3121 ruby_free_proctitle();
3125 rb_fiber_reset_root_local_storage(th);
3131 rb_vm_living_threads_init(vm);
3132 ruby_vm_run_at_exit_hooks(vm);
3133 if (vm->loading_table) {
3134 st_foreach(vm->loading_table, free_loading_table_entry, 0);
3135 st_free_table(vm->loading_table);
3136 vm->loading_table = 0;
3139 st_free_table(vm->ci_table);
3140 vm->ci_table = NULL;
3142 if (vm->frozen_strings) {
3143 st_free_table(vm->frozen_strings);
3144 vm->frozen_strings = 0;
3146 RB_ALTSTACK_FREE(vm->main_altstack);
3155 if (rb_free_at_exit) {
3156 rb_objspace_free_objects(
objspace);
3157 rb_free_generic_iv_tbl_();
3158 rb_free_default_rand_key();
3159 if (th && vm->fork_gen == 0) {
3170 ruby_current_vm_ptr = NULL;
3173 if (rb_free_at_exit) {
3174 rb_yjit_free_at_exit();
3178 RUBY_FREE_LEAVE(
"vm");
3182size_t rb_vm_memsize_waiting_fds(
struct ccan_list_head *waiting_fds);
3183size_t rb_vm_memsize_workqueue(
struct ccan_list_head *workqueue);
3187static enum rb_id_table_iterator_result
3188vm_memsize_constant_cache_i(
ID id,
VALUE ics,
void *size)
3190 *((
size_t *) size) += rb_st_memsize((st_table *) ics);
3191 return ID_TABLE_CONTINUE;
3198vm_memsize_constant_cache(
void)
3200 rb_vm_t *vm = GET_VM();
3201 size_t size = rb_id_table_memsize(vm->constant_cache);
3203 rb_id_table_foreach(vm->constant_cache, vm_memsize_constant_cache_i, &size);
3214 at_exit = at_exit->next;
3223vm_memsize_builtin_function_table(
const struct rb_builtin_function *builtin_function_table)
3231vm_memsize(
const void *ptr)
3233 rb_vm_t *vm = GET_VM();
3237 rb_vm_memsize_waiting_fds(&vm->waiting_fds) +
3238 rb_st_memsize(vm->loaded_features_index) +
3239 rb_st_memsize(vm->loading_table) +
3240 rb_vm_memsize_postponed_job_queue() +
3241 rb_vm_memsize_workqueue(&vm->workqueue) +
3242 vm_memsize_at_exit_list(vm->at_exit) +
3243 rb_st_memsize(vm->ci_table) +
3244 rb_st_memsize(vm->frozen_strings) +
3245 vm_memsize_builtin_function_table(vm->builtin_function_table) +
3246 rb_id_table_memsize(vm->negative_cme_table) +
3247 rb_st_memsize(vm->overloaded_cme_table) +
3248 vm_memsize_constant_cache() +
3249 GET_SHAPE_TREE()->cache_size *
sizeof(redblack_node_t)
3260 {0, 0, vm_memsize,},
3261 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3266vm_default_params(
void)
3268 rb_vm_t *vm = GET_VM();
3269 VALUE result = rb_hash_new_with_size(4);
3270#define SET(name) rb_hash_aset(result, ID2SYM(rb_intern(#name)), SIZET2NUM(vm->default_params.name));
3271 SET(thread_vm_stack_size);
3272 SET(thread_machine_stack_size);
3273 SET(fiber_vm_stack_size);
3274 SET(fiber_machine_stack_size);
3281get_param(
const char *name,
size_t default_value,
size_t min_value)
3284 size_t result = default_value;
3285 if ((envval = getenv(name)) != 0) {
3286 long val = atol(envval);
3287 if (val < (
long)min_value) {
3288 val = (long)min_value;
3290 result = (size_t)(((val -1 + RUBY_VM_SIZE_ALIGN) / RUBY_VM_SIZE_ALIGN) * RUBY_VM_SIZE_ALIGN);
3292 if (0) ruby_debug_printf(
"%s: %"PRIuSIZE
"\n", name, result);
3298check_machine_stack_size(
size_t *sizep)
3300#ifdef PTHREAD_STACK_MIN
3301 size_t size = *sizep;
3304#ifdef PTHREAD_STACK_MIN
3305 if (size < (
size_t)PTHREAD_STACK_MIN) {
3306 *sizep = (size_t)PTHREAD_STACK_MIN * 2;
3312vm_default_params_setup(rb_vm_t *vm)
3314 vm->default_params.thread_vm_stack_size =
3315 get_param(
"RUBY_THREAD_VM_STACK_SIZE",
3316 RUBY_VM_THREAD_VM_STACK_SIZE,
3317 RUBY_VM_THREAD_VM_STACK_SIZE_MIN);
3319 vm->default_params.thread_machine_stack_size =
3320 get_param(
"RUBY_THREAD_MACHINE_STACK_SIZE",
3321 RUBY_VM_THREAD_MACHINE_STACK_SIZE,
3322 RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN);
3324 vm->default_params.fiber_vm_stack_size =
3325 get_param(
"RUBY_FIBER_VM_STACK_SIZE",
3326 RUBY_VM_FIBER_VM_STACK_SIZE,
3327 RUBY_VM_FIBER_VM_STACK_SIZE_MIN);
3329 vm->default_params.fiber_machine_stack_size =
3330 get_param(
"RUBY_FIBER_MACHINE_STACK_SIZE",
3331 RUBY_VM_FIBER_MACHINE_STACK_SIZE,
3332 RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN);
3335 check_machine_stack_size(&vm->default_params.thread_machine_stack_size);
3336 check_machine_stack_size(&vm->default_params.fiber_machine_stack_size);
3340vm_init2(rb_vm_t *vm)
3342 rb_vm_living_threads_init(vm);
3343 vm->thread_report_on_exception = 1;
3344 vm->src_encoding_index = -1;
3346 vm_default_params_setup(vm);
3350rb_execution_context_update(rb_execution_context_t *ec)
3356 VALUE *p = ec->vm_stack;
3357 VALUE *sp = ec->cfp->sp;
3358 rb_control_frame_t *cfp = ec->cfp;
3359 rb_control_frame_t *limit_cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
3361 for (i = 0; i < (long)(sp - p); i++) {
3363 VALUE update = rb_gc_location(ref);
3364 if (ref != update) {
3369 while (cfp != limit_cfp) {
3370 const VALUE *ep = cfp->ep;
3371 cfp->self = rb_gc_location(cfp->self);
3372 cfp->iseq = (rb_iseq_t *)rb_gc_location((
VALUE)cfp->iseq);
3373 cfp->block_code = (
void *)rb_gc_location((
VALUE)cfp->block_code);
3375 if (!VM_ENV_LOCAL_P(ep)) {
3376 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3377 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3378 VM_FORCE_WRITE(&prev_ep[VM_ENV_DATA_INDEX_ENV], rb_gc_location(prev_ep[VM_ENV_DATA_INDEX_ENV]));
3381 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3382 VM_FORCE_WRITE(&ep[VM_ENV_DATA_INDEX_ENV], rb_gc_location(ep[VM_ENV_DATA_INDEX_ENV]));
3383 VM_FORCE_WRITE(&ep[VM_ENV_DATA_INDEX_ME_CREF], rb_gc_location(ep[VM_ENV_DATA_INDEX_ME_CREF]));
3387 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3391 ec->storage = rb_gc_location(ec->storage);
3394static enum rb_id_table_iterator_result
3395mark_local_storage_i(
VALUE local,
void *data)
3398 return ID_TABLE_CONTINUE;
3402rb_execution_context_mark(
const rb_execution_context_t *ec)
3407 VALUE *p = ec->vm_stack;
3408 VALUE *sp = ec->cfp->sp;
3409 rb_control_frame_t *cfp = ec->cfp;
3410 rb_control_frame_t *limit_cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
3412 VM_ASSERT(sp == ec->cfp->sp);
3413 rb_gc_mark_vm_stack_values((
long)(sp - p), p);
3415 while (cfp != limit_cfp) {
3416 const VALUE *ep = cfp->ep;
3417 VM_ASSERT(!!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) == vm_ep_in_heap_p_(ec, ep));
3419 rb_gc_mark_movable(cfp->self);
3420 rb_gc_mark_movable((
VALUE)cfp->iseq);
3421 rb_gc_mark_movable((
VALUE)cfp->block_code);
3423 if (!VM_ENV_LOCAL_P(ep)) {
3424 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3425 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3426 rb_gc_mark_movable(prev_ep[VM_ENV_DATA_INDEX_ENV]);
3429 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3430 rb_gc_mark_movable(ep[VM_ENV_DATA_INDEX_ENV]);
3431 rb_gc_mark(ep[VM_ENV_DATA_INDEX_ME_CREF]);
3435 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3440 if (ec->machine.stack_start && ec->machine.stack_end &&
3443 rb_gc_mark_machine_context(ec);
3446 rb_gc_mark(ec->errinfo);
3447 rb_gc_mark(ec->root_svar);
3448 if (ec->local_storage) {
3449 rb_id_table_foreach_values(ec->local_storage, mark_local_storage_i, NULL);
3451 rb_gc_mark(ec->local_storage_recursive_hash);
3452 rb_gc_mark(ec->local_storage_recursive_hash_for_trace);
3453 rb_gc_mark(ec->private_const_reference);
3455 rb_gc_mark_movable(ec->storage);
3458void rb_fiber_mark_self(rb_fiber_t *fib);
3459void rb_fiber_update_self(rb_fiber_t *fib);
3460void rb_threadptr_root_fiber_setup(rb_thread_t *th);
3461void rb_threadptr_root_fiber_release(rb_thread_t *th);
3464thread_compact(
void *ptr)
3466 rb_thread_t *th = ptr;
3468 th->self = rb_gc_location(th->self);
3470 if (!th->root_fiber) {
3471 rb_execution_context_update(th->ec);
3476thread_mark(
void *ptr)
3478 rb_thread_t *th = ptr;
3479 RUBY_MARK_ENTER(
"thread");
3480 rb_fiber_mark_self(th->ec->fiber_ptr);
3483 switch (th->invoke_type) {
3484 case thread_invoke_type_proc:
3485 case thread_invoke_type_ractor_proc:
3486 rb_gc_mark(th->invoke_arg.proc.proc);
3487 rb_gc_mark(th->invoke_arg.proc.args);
3489 case thread_invoke_type_func:
3490 rb_gc_mark_maybe((
VALUE)th->invoke_arg.func.arg);
3496 rb_gc_mark(rb_ractor_self(th->ractor));
3497 rb_gc_mark(th->thgroup);
3498 rb_gc_mark(th->value);
3499 rb_gc_mark(th->pending_interrupt_queue);
3500 rb_gc_mark(th->pending_interrupt_mask_stack);
3501 rb_gc_mark(th->top_self);
3502 rb_gc_mark(th->top_wrapper);
3503 if (th->root_fiber) rb_fiber_mark_self(th->root_fiber);
3505 RUBY_ASSERT(th->ec == rb_fiberptr_get_ec(th->ec->fiber_ptr));
3506 rb_gc_mark(th->stat_insn_usage);
3507 rb_gc_mark(th->last_status);
3508 rb_gc_mark(th->locking_mutex);
3509 rb_gc_mark(th->name);
3511 rb_gc_mark(th->scheduler);
3513 rb_threadptr_interrupt_exec_task_mark(th);
3515 RUBY_MARK_LEAVE(
"thread");
3518void rb_threadptr_sched_free(rb_thread_t *th);
3521thread_free(
void *ptr)
3523 rb_thread_t *th = ptr;
3524 RUBY_FREE_ENTER(
"thread");
3526 rb_threadptr_sched_free(th);
3528 if (th->locking_mutex !=
Qfalse) {
3529 rb_bug(
"thread_free: locking_mutex must be NULL (%p:%p)", (
void *)th, (
void *)th->locking_mutex);
3531 if (th->keeping_mutexes != NULL) {
3532 rb_bug(
"thread_free: keeping_mutexes must be NULL (%p:%p)", (
void *)th, (
void *)th->keeping_mutexes);
3535 ruby_xfree(th->specific_storage);
3537 rb_threadptr_root_fiber_release(th);
3539 if (th->vm && th->vm->ractor.main_thread == th) {
3540 RUBY_GC_INFO(
"MRI main thread\n");
3548 RUBY_FREE_LEAVE(
"thread");
3552thread_memsize(
const void *ptr)
3554 const rb_thread_t *th = ptr;
3555 size_t size =
sizeof(rb_thread_t);
3557 if (!th->root_fiber) {
3558 size += th->ec->vm_stack_size *
sizeof(
VALUE);
3560 if (th->ec->local_storage) {
3561 size += rb_id_table_memsize(th->ec->local_storage);
3566#define thread_data_type ruby_threadptr_data_type
3575 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3579rb_obj_is_thread(
VALUE obj)
3585thread_alloc(
VALUE klass)
3592rb_ec_set_vm_stack(rb_execution_context_t *ec,
VALUE *stack,
size_t size)
3594 ec->vm_stack = stack;
3595 ec->vm_stack_size = size;
3599rb_ec_initialize_vm_stack(rb_execution_context_t *ec,
VALUE *stack,
size_t size)
3601 rb_ec_set_vm_stack(ec, stack, size);
3603#if VM_CHECK_MODE > 0
3607 ec->cfp = (
void *)(ec->vm_stack + ec->vm_stack_size);
3611 VM_FRAME_MAGIC_DUMMY | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH | VM_FRAME_FLAG_CFRAME ,
3612 Qnil , VM_BLOCK_HANDLER_NONE ,
3614 0 , ec->vm_stack, 0, 0
3619rb_ec_clear_vm_stack(rb_execution_context_t *ec)
3621 rb_ec_set_vm_stack(ec, NULL, 0);
3628th_init(rb_thread_t *th,
VALUE self, rb_vm_t *vm)
3632 rb_threadptr_root_fiber_setup(th);
3636 th->scheduler =
Qnil;
3639 size_t size = vm->default_params.thread_vm_stack_size /
sizeof(
VALUE);
3640 rb_ec_initialize_vm_stack(th->ec,
ALLOC_N(
VALUE, size), size);
3643 VM_ASSERT(th->ec->cfp == NULL);
3644 VM_ASSERT(th->ec->vm_stack == NULL);
3645 VM_ASSERT(th->ec->vm_stack_size == 0);
3648 th->status = THREAD_RUNNABLE;
3649 th->last_status =
Qnil;
3650 th->top_wrapper = 0;
3651 th->top_self = vm->top_self;
3654 th->ec->errinfo =
Qnil;
3655 th->ec->root_svar =
Qfalse;
3656 th->ec->local_storage_recursive_hash =
Qnil;
3657 th->ec->local_storage_recursive_hash_for_trace =
Qnil;
3659 th->ec->storage =
Qnil;
3661#if OPT_CALL_THREADED_CODE
3665 th->report_on_exception = vm->thread_report_on_exception;
3666 th->ext_config.ractor_safe =
true;
3668 ccan_list_head_init(&th->interrupt_exec_tasks);
3670#if USE_RUBY_DEBUG_LOG
3674 RUBY_DEBUG_LOG(
"th:%u", th->serial);
3679rb_thread_alloc(
VALUE klass)
3681 VALUE self = thread_alloc(klass);
3682 rb_thread_t *target_th = rb_thread_ptr(self);
3683 target_th->ractor = GET_RACTOR();
3684 th_init(target_th, self, target_th->vm = GET_VM());
3688#define REWIND_CFP(expr) do { \
3689 rb_execution_context_t *ec__ = GET_EC(); \
3690 VALUE *const curr_sp = (ec__->cfp++)->sp; \
3691 VALUE *const saved_sp = ec__->cfp->sp; \
3692 ec__->cfp->sp = curr_sp; \
3694 (ec__->cfp--)->sp = saved_sp; \
3721 rb_clear_method_cache(self, mid);
3727m_core_set_postexe(
VALUE self)
3736core_hash_merge(
VALUE hash,
long argc,
const VALUE *argv)
3739 VM_ASSERT(argc % 2 == 0);
3740 rb_hash_bulk_insert(argc, argv, hash);
3745m_core_hash_merge_ptr(
int argc,
VALUE *argv,
VALUE recv)
3747 VALUE hash = argv[0];
3749 REWIND_CFP(hash = core_hash_merge(hash, argc-1, argv+1));
3757 rb_hash_aset(hash, key, value);
3765 REWIND_CFP(hash = core_hash_merge_kwd(hash, kw));
3777m_core_make_shareable_copy(
VALUE recv,
VALUE obj)
3785 return rb_ractor_ensure_shareable(obj, name);
3795extern VALUE *rb_gc_stack_start;
3796extern size_t rb_gc_stack_maxsize;
3804 rb_vm_bugreport(NULL, stderr);
3812 VALUE ary = rb_ary_new();
3813#ifdef HAVE_BACKTRACE
3814#include <execinfo.h>
3815#define MAX_NATIVE_TRACE 1024
3816 static void *trace[MAX_NATIVE_TRACE];
3817 int n = (int)backtrace(trace, MAX_NATIVE_TRACE);
3818 char **syms = backtrace_symbols(trace, n);
3825 for (i=0; i<n; i++) {
3833#if VM_COLLECT_USAGE_DETAILS
3834static VALUE usage_analysis_insn_start(
VALUE self);
3835static VALUE usage_analysis_operand_start(
VALUE self);
3836static VALUE usage_analysis_register_start(
VALUE self);
3837static VALUE usage_analysis_insn_stop(
VALUE self);
3838static VALUE usage_analysis_operand_stop(
VALUE self);
3839static VALUE usage_analysis_register_stop(
VALUE self);
3840static VALUE usage_analysis_insn_running(
VALUE self);
3841static VALUE usage_analysis_operand_running(
VALUE self);
3842static VALUE usage_analysis_register_running(
VALUE self);
3843static VALUE usage_analysis_insn_clear(
VALUE self);
3844static VALUE usage_analysis_operand_clear(
VALUE self);
3845static VALUE usage_analysis_register_clear(
VALUE self);
3851 return rb_f_raise(c, v);
3900vm_keep_script_lines(
VALUE self)
3902 return RBOOL(ruby_vm_keep_script_lines);
3917vm_keep_script_lines_set(
VALUE self,
VALUE flags)
3919 ruby_vm_keep_script_lines =
RTEST(flags);
3948#if USE_DEBUG_COUNTER
3970 rb_define_method(klass,
"make_shareable_copy", m_core_make_shareable_copy, 1);
3973 RBASIC_CLEAR_CLASS(klass);
3975 rb_vm_register_global_object(fcore);
3976 rb_mRubyVMFrozenCore = fcore;
4139#if VM_COLLECT_USAGE_DETAILS
4141#define define_usage_analysis_hash(name) \
4142 rb_define_const(rb_cRubyVM, "USAGE_ANALYSIS_" #name, rb_hash_new())
4143 define_usage_analysis_hash(INSN);
4144 define_usage_analysis_hash(REGS);
4145 define_usage_analysis_hash(INSN_BIGRAM);
4167#if OPT_DIRECT_THREADED_CODE
4168 rb_ary_push(opts,
rb_str_new2(
"direct threaded code"));
4169#elif OPT_TOKEN_THREADED_CODE
4170 rb_ary_push(opts,
rb_str_new2(
"token threaded code"));
4171#elif OPT_CALL_THREADED_CODE
4172 rb_ary_push(opts,
rb_str_new2(
"call threaded code"));
4175#if OPT_OPERANDS_UNIFICATION
4176 rb_ary_push(opts,
rb_str_new2(
"operands unification"));
4178#if OPT_INSTRUCTIONS_UNIFICATION
4179 rb_ary_push(opts,
rb_str_new2(
"instructions unification"));
4181#if OPT_INLINE_METHOD_CACHE
4182 rb_ary_push(opts,
rb_str_new2(
"inline method cache"));
4189 rb_define_const(rb_cRubyVM,
"INSTRUCTION_NAMES", rb_insns_name_array());
4214 rb_vm_t *vm = ruby_current_vm_ptr;
4215 rb_thread_t *th = GET_THREAD();
4216 VALUE filename = rb_fstring_lit(
"<main>");
4217 const rb_iseq_t *iseq = rb_iseq_new(
Qnil, filename, filename,
Qnil, 0, ISEQ_TYPE_TOP);
4220 rb_ractor_main_setup(vm, th->ractor, th);
4227 vm->ractor.main_thread = th;
4228 vm->ractor.main_ractor = th->ractor;
4230 th->top_wrapper = 0;
4231 th->top_self = rb_vm_top_self();
4233 rb_vm_register_global_object((
VALUE)iseq);
4234 th->ec->cfp->iseq = iseq;
4235 th->ec->cfp->pc = ISEQ_BODY(iseq)->iseq_encoded;
4236 th->ec->cfp->self = th->top_self;
4238 VM_ENV_FLAGS_UNSET(th->ec->cfp->ep, VM_FRAME_FLAG_CFRAME);
4239 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));
4247 rb_objspace_gc_enable(vm->gc.objspace);
4250 vm_init_redefined_flag();
4254 OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
4256 rb_vm_register_global_object(rb_block_param_proxy);
4259 Init_vm_backtrace();
4263rb_vm_set_progname(
VALUE filename)
4265 rb_thread_t *th = GET_VM()->ractor.main_thread;
4266 rb_control_frame_t *cfp = (
void *)(th->ec->vm_stack + th->ec->vm_stack_size);
4270 rb_iseq_pathobj_set(cfp->iseq, filename, rb_iseq_realpath(cfp->iseq));
4273extern const struct st_hash_type rb_fstring_hash_type;
4279 rb_vm_t *vm = ruby_mimcalloc(1,
sizeof(*vm));
4280 rb_thread_t *th = ruby_mimcalloc(1,
sizeof(*th));
4282 fputs(
"[FATAL] failed to allocate memory\n", stderr);
4289 rb_vm_postponed_job_queue_init(vm);
4290 ruby_current_vm_ptr = vm;
4291 rb_objspace_alloc();
4292 vm->negative_cme_table = rb_id_table_create(16);
4293 vm->overloaded_cme_table = st_init_numtable();
4294 vm->constant_cache = rb_id_table_create(0);
4295 vm->unused_block_warning_table = st_init_numtable();
4300 th->ractor = vm->ractor.main_ractor = rb_ractor_main_alloc();
4301 Init_native_thread(th);
4305 rb_ractor_set_current_ec(th->ractor, th->ec);
4307 ruby_thread_init_stack(th, native_main_thread_stack_top);
4313 vm_opt_method_def_table = st_init_numtable();
4314 vm_opt_mid_table = st_init_numtable();
4316#ifdef RUBY_THREAD_WIN32_H
4324 native_main_thread_stack_top = addr;
4329#include <sys/mman.h>
4333#ifndef MARK_OBJECT_ARY_BUCKET_SIZE
4334#define MARK_OBJECT_ARY_BUCKET_SIZE 1024
4344pin_array_list_mark(
void *data)
4347 rb_gc_mark_movable(array->next);
4349 rb_gc_mark_vm_stack_values(array->len, array->array);
4353pin_array_list_free(
void *data)
4356 xfree(array->array);
4360pin_array_list_memsize(
const void *data)
4366pin_array_list_update_references(
void *data)
4369 array->next = rb_gc_location(array->next);
4373 .wrap_struct_name =
"VM/pin_array_list",
4375 .dmark = pin_array_list_mark,
4376 .dfree = pin_array_list_free,
4377 .dsize = pin_array_list_memsize,
4378 .dcompact = pin_array_list_update_references,
4380 .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE,
4384pin_array_list_new(
VALUE next)
4389 array_list->array =
ALLOC_N(
VALUE, MARK_OBJECT_ARY_BUCKET_SIZE);
4399 if (array_list->len >= MARK_OBJECT_ARY_BUCKET_SIZE) {
4400 obj = pin_array_list_new(obj);
4404 RB_OBJ_WRITE(obj, &array_list->array[array_list->len], item);
4410rb_vm_register_global_object(
VALUE obj)
4420 if (
FL_TEST(obj, RCLASS_IS_ROOT)) {
4423 FL_SET(obj, RCLASS_IS_ROOT);
4430 VALUE list = GET_VM()->mark_object_ary;
4431 VALUE head = pin_array_list_append(list, obj);
4433 GET_VM()->mark_object_ary = head;
4441Init_vm_objects(
void)
4443 rb_vm_t *vm = GET_VM();
4446 vm->mark_object_ary = pin_array_list_new(
Qnil);
4447 vm->loading_table = st_init_strtable();
4448 vm->ci_table = st_init_table(&vm_ci_hashtype);
4449 vm->frozen_strings = st_init_table_with_size(&rb_fstring_hash_type, 10000);
4454void Init_builtin_yjit(
void) {}
4458#include "yjit_hook.rbinc"
4462void Init_builtin_rjit(
void) {}
4463void Init_builtin_rjit_c(
void) {}
4477 return GET_VM()->top_self;
4483 rb_vm_t *vm = GET_VM();
4493 rb_ractor_t *cr = GET_RACTOR();
4494 return &cr->verbose;
4500 rb_ractor_t *cr = GET_RACTOR();
4504bool rb_free_at_exit =
false;
4507ruby_free_at_exit_p(
void)
4509 return rb_free_at_exit;
4513VALUE rb_insn_operand_intern(
const rb_iseq_t *iseq,
4518rb_vm_fstring_table(
void)
4520 return GET_VM()->frozen_strings;
4523#if VM_COLLECT_USAGE_DETAILS
4525#define HASH_ASET(h, k, v) rb_hash_aset((h), (st_data_t)(k), (st_data_t)(v))
4539vm_analysis_insn(
int insn)
4543 static int prev_insn = -1;
4549 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
4550 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
4553 ihash = rb_hash_new();
4554 HASH_ASET(uh,
INT2FIX(insn), ihash);
4562 if (prev_insn != -1) {
4572 if (
NIL_P(cv = rb_hash_aref(uh, bi))) {
4581vm_analysis_operand(
int insn,
int n,
VALUE op)
4591 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
4595 ihash = rb_hash_new();
4596 HASH_ASET(uh,
INT2FIX(insn), ihash);
4599 ophash = rb_hash_new();
4600 HASH_ASET(ihash,
INT2FIX(n), ophash);
4603 valstr = rb_insn_operand_intern(GET_EC()->cfp->iseq, insn, n, op, 0, 0, 0, 0);
4606 if (
NIL_P(cv = rb_hash_aref(ophash, valstr))) {
4613vm_analysis_register(
int reg,
int isset)
4618 static const char regstrs[][5] = {
4626 static const char getsetstr[][4] = {
4630 static VALUE syms[
sizeof(regstrs) /
sizeof(regstrs[0])][2];
4634 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
4639 for (i = 0; i < (int)(
sizeof(regstrs) /
sizeof(regstrs[0])); i++) {
4641 for (j = 0; j < 2; j++) {
4642 snprintf(buff, 0x10,
"%d %s %-4s", i, getsetstr[j], regstrs[i]);
4643 syms[i][j] =
ID2SYM(rb_intern(buff));
4647 valstr = syms[reg][isset];
4650 if (
NIL_P(cv = rb_hash_aref(uh, valstr))) {
4658static void (*ruby_vm_collect_usage_func_insn)(
int insn) = NULL;
4659static void (*ruby_vm_collect_usage_func_operand)(
int insn,
int n,
VALUE op) = NULL;
4660static void (*ruby_vm_collect_usage_func_register)(
int reg,
int isset) = NULL;
4664usage_analysis_insn_start(
VALUE self)
4666 ruby_vm_collect_usage_func_insn = vm_analysis_insn;
4672usage_analysis_operand_start(
VALUE self)
4674 ruby_vm_collect_usage_func_operand = vm_analysis_operand;
4680usage_analysis_register_start(
VALUE self)
4682 ruby_vm_collect_usage_func_register = vm_analysis_register;
4688usage_analysis_insn_stop(
VALUE self)
4690 ruby_vm_collect_usage_func_insn = 0;
4696usage_analysis_operand_stop(
VALUE self)
4698 ruby_vm_collect_usage_func_operand = 0;
4704usage_analysis_register_stop(
VALUE self)
4706 ruby_vm_collect_usage_func_register = 0;
4712usage_analysis_insn_running(
VALUE self)
4714 return RBOOL(ruby_vm_collect_usage_func_insn != 0);
4719usage_analysis_operand_running(
VALUE self)
4721 return RBOOL(ruby_vm_collect_usage_func_operand != 0);
4726usage_analysis_register_running(
VALUE self)
4728 return RBOOL(ruby_vm_collect_usage_func_register != 0);
4732usage_analysis_clear(
VALUE self,
ID usage_hash)
4744usage_analysis_insn_clear(
VALUE self)
4749 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
4750 CONST_ID(bigram_hash,
"USAGE_ANALYSIS_INSN_BIGRAM");
4751 usage_analysis_clear(rb_cRubyVM, usage_hash);
4752 return usage_analysis_clear(rb_cRubyVM, bigram_hash);
4757usage_analysis_operand_clear(
VALUE self)
4761 CONST_ID(usage_hash,
"USAGE_ANALYSIS_INSN");
4762 return usage_analysis_clear(self, usage_hash);
4767usage_analysis_register_clear(
VALUE self)
4771 CONST_ID(usage_hash,
"USAGE_ANALYSIS_REGS");
4772 return usage_analysis_clear(self, usage_hash);
4777MAYBE_UNUSED(
static void (*ruby_vm_collect_usage_func_insn)(
int insn)) = 0;
4778MAYBE_UNUSED(
static void (*ruby_vm_collect_usage_func_operand)(
int insn,
int n,
VALUE op)) = 0;
4779MAYBE_UNUSED(
static void (*ruby_vm_collect_usage_func_register)(
int reg,
int isset)) = 0;
4783#if VM_COLLECT_USAGE_DETAILS
4786vm_collect_usage_insn(
int insn)
4788 if (RUBY_DTRACE_INSN_ENABLED()) {
4789 RUBY_DTRACE_INSN(rb_insns_name(insn));
4791 if (ruby_vm_collect_usage_func_insn)
4792 (*ruby_vm_collect_usage_func_insn)(insn);
4800vm_collect_usage_operand(
int insn,
int n,
VALUE op)
4802 if (RUBY_DTRACE_INSN_OPERAND_ENABLED()) {
4805 valstr = rb_insn_operand_intern(GET_EC()->cfp->iseq, insn, n, op, 0, 0, 0, 0);
4807 RUBY_DTRACE_INSN_OPERAND(RSTRING_PTR(valstr), rb_insns_name(insn));
4810 if (ruby_vm_collect_usage_func_operand)
4811 (*ruby_vm_collect_usage_func_operand)(insn, n, op);
4817vm_collect_usage_register(
int reg,
int isset)
4819 if (ruby_vm_collect_usage_func_register)
4820 (*ruby_vm_collect_usage_func_register)(reg, isset);
4827 return &vm_empty_cc;
4831rb_vm_empty_cc_for_super(
void)
4833 return &vm_empty_cc_for_super;
4836#include "vm_call_iseq_optimized.inc"
#define RUBY_ASSERT_MESG(expr,...)
Asserts that the expression is truthy.
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ATOMIC_FETCH_ADD(var, val)
Atomically replaces the value pointed by var with the result of addition of val to the old value of v...
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_method_id(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define RUBY_EVENT_END
Encountered an end of a class clause.
#define RUBY_EVENT_B_RETURN
Encountered a next statement.
#define RUBY_EVENT_RETURN
Encountered a return statement.
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
uint32_t rb_event_flag_t
Represents event(s).
@ RUBY_FL_SHAREABLE
This flag has something to do with Ractor.
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
#define rb_str_new2
Old name of rb_str_new_cstr.
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 xfree
Old name of ruby_xfree.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define T_IMEMO
Old name of RUBY_T_IMEMO.
#define ID2SYM
Old name of RB_ID2SYM.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define ULONG2NUM
Old name of RB_ULONG2NUM.
#define SYM2ID
Old name of RB_SYM2ID.
#define ZALLOC
Old name of RB_ZALLOC.
#define CLASS_OF
Old name of rb_class_of.
#define rb_ary_new4
Old name of rb_ary_new_from_values.
#define SIZET2NUM
Old name of RB_SIZE2NUM.
#define rb_exc_new2
Old name of rb_exc_new_cstr.
#define FIX2INT
Old name of RB_FIX2INT.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define ZALLOC_N
Old name of RB_ZALLOC_N.
#define ASSUME
Old name of RBIMPL_ASSUME.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define FL_SET
Old name of RB_FL_SET.
#define rb_exc_new3
Old name of rb_exc_new_str.
#define ULL2NUM
Old name of RB_ULL2NUM.
#define Qtrue
Old name of RUBY_Qtrue.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define NIL_P
Old name of RB_NIL_P.
#define NUM2ULL
Old name of RB_NUM2ULL.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FL_TEST
Old name of RB_FL_TEST.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define FL_USHIFT
Old name of RUBY_FL_USHIFT.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
#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.
int rb_typeddata_is_kind_of(VALUE obj, const rb_data_type_t *data_type)
Checks if the given object is of given kind.
void rb_iter_break(void)
Breaks from a block.
VALUE rb_eTypeError
TypeError exception.
void rb_iter_break_value(VALUE val)
Identical to rb_iter_break(), except it additionally takes the "value" of this breakage.
VALUE rb_eRuntimeError
RuntimeError exception.
VALUE * rb_ruby_verbose_ptr(void)
This is an implementation detail of ruby_verbose.
VALUE rb_exc_new_str(VALUE etype, VALUE str)
Identical to rb_exc_new_cstr(), except it takes a Ruby's string instead of C's.
VALUE * rb_ruby_debug_ptr(void)
This is an implementation detail of ruby_debug.
VALUE rb_eSysStackError
SystemStackError exception.
@ RB_WARN_CATEGORY_PERFORMANCE
Warning is for performance issues (not enabled by -w).
VALUE rb_cTime
Time class.
VALUE rb_cArray
Array class.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
VALUE rb_cInteger
Module class.
VALUE rb_cNilClass
NilClass class.
VALUE rb_cBinding
Binding class.
VALUE rb_cRegexp
Regexp class.
VALUE rb_cHash
Hash class.
VALUE rb_cFalseClass
FalseClass class.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_cSymbol
Symbol class.
VALUE rb_cBasicObject
BasicObject class.
VALUE rb_cThread
Thread class.
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
VALUE rb_cFloat
Float class.
VALUE rb_cProc
Proc class.
VALUE rb_cTrueClass
TrueClass class.
VALUE rb_cString
String class.
#define RB_OBJ_WRITTEN(old, oldv, young)
Identical to RB_OBJ_WRITE(), except it doesn't write any values, but only a WB declaration.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
void rb_undef(VALUE mod, ID mid)
Inserts a method entry that hides previous method definition of the given name.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_backref_get(void)
Queries the last match, or Regexp.last_match, or the $~.
void rb_lastline_set(VALUE str)
Updates $_.
VALUE rb_lastline_get(void)
Queries the last line, or the $_.
void rb_backref_set(VALUE md)
Updates $~.
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
VALUE rb_block_lambda(void)
Identical to rb_proc_new(), except it returns a lambda.
VALUE rb_binding_new(void)
Snapshots the current execution context and turn it into an instance of rb_cBinding.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
void rb_set_class_path(VALUE klass, VALUE space, const char *name)
Names a class.
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
void rb_alias_variable(ID dst, ID src)
Aliases a global variable.
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
const char * rb_sourcefile(void)
Resembles __FILE__.
void rb_alias(VALUE klass, ID dst, ID src)
Resembles alias.
int rb_frame_method_id_and_class(ID *idp, VALUE *klassp)
Resembles __method__.
int rb_sourceline(void)
Resembles __LINE__.
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
void rb_define_const(VALUE klass, const char *name, VALUE val)
Defines a Ruby level constant under a namespace.
VALUE rb_iv_set(VALUE obj, const char *name, VALUE val)
Assigns to an instance variable.
int len
Length of the buffer.
VALUE rb_ractor_make_shareable_copy(VALUE obj)
Identical to rb_ractor_make_shareable(), except it returns a (deep) copy of the passed one instead of...
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
VALUE rb_ractor_make_shareable(VALUE obj)
Destructively transforms the passed object so that multiple Ractors can share it.
void ruby_vm_at_exit(void(*func)(ruby_vm_t *))
ruby_vm_at_exit registers a function func to be invoked when a VM passed away.
int ruby_vm_destruct(ruby_vm_t *vm)
Destructs the passed VM.
VALUE rb_f_sprintf(int argc, const VALUE *argv)
Identical to rb_str_format(), except how the arguments are arranged.
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
#define RARRAY_LEN
Just another name of rb_array_len.
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
#define RARRAY_AREF(a, i)
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RBASIC(obj)
Convenient casting macro.
#define RCLASS(obj)
Convenient casting macro.
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
const char * rb_class2name(VALUE klass)
Queries the name of the passed class.
#define RB_NO_KEYWORDS
Do not pass keywords.
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
IFUNC (Internal FUNCtion)
void rb_native_cond_initialize(rb_nativethread_cond_t *cond)
Fills the passed condition variable with an initial value.
void rb_native_mutex_initialize(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_initialize.
void rb_native_mutex_destroy(rb_nativethread_lock_t *lock)
Just another name of rb_nativethread_lock_destroy.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
ruby_value_type
C-level type of an object.