Ruby 3.5.0dev (2025-06-27 revision 3d5619c8b1a76626e0991d758b71afc549829c38)
vm.c (3d5619c8b1a76626e0991d758b71afc549829c38)
1/**********************************************************************
2
3 Vm.c -
4
5 $Author$
6
7 Copyright (C) 2004-2007 Koichi Sasada
8
9**********************************************************************/
10
11#define vm_exec rb_vm_exec
12
13#include "eval_intern.h"
14#include "internal.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/namespace.h"
25#include "internal/object.h"
26#include "internal/proc.h"
27#include "internal/re.h"
28#include "internal/ruby_parser.h"
29#include "internal/symbol.h"
30#include "internal/thread.h"
31#include "internal/transcode.h"
32#include "internal/vm.h"
33#include "internal/sanitizers.h"
34#include "internal/variable.h"
35#include "iseq.h"
36#include "symbol.h" // This includes a macro for a more performant rb_id2sym.
37#include "yjit.h"
38#include "ruby/st.h"
39#include "ruby/vm.h"
40#include "vm_core.h"
41#include "vm_callinfo.h"
42#include "vm_debug.h"
43#include "vm_exec.h"
44#include "vm_insnhelper.h"
45#include "ractor_core.h"
46#include "vm_sync.h"
47#include "shape.h"
48#include "insns.inc"
49#include "zjit.h"
50
51#include "builtin.h"
52
53#include "probes.h"
54#include "probes_helper.h"
55
56#ifdef RUBY_ASSERT_CRITICAL_SECTION
57int ruby_assert_critical_section_entered = 0;
58#endif
59
60static void *native_main_thread_stack_top;
61
62VALUE rb_str_concat_literals(size_t, const VALUE*);
63
65
66extern const char *const rb_debug_counter_names[];
67
68PUREFUNC(static inline const VALUE *VM_EP_LEP(const VALUE *));
69static inline const VALUE *
70VM_EP_LEP(const VALUE *ep)
71{
72 while (!VM_ENV_LOCAL_P(ep)) {
73 ep = VM_ENV_PREV_EP(ep);
74 }
75 return ep;
76}
77
78static inline const rb_control_frame_t *
79rb_vm_search_cf_from_ep(const rb_execution_context_t *ec, const rb_control_frame_t *cfp, const VALUE * const ep)
80{
81 if (!ep) {
82 return NULL;
83 }
84 else {
85 const rb_control_frame_t * const eocfp = RUBY_VM_END_CONTROL_FRAME(ec); /* end of control frame pointer */
86
87 while (cfp < eocfp) {
88 if (cfp->ep == ep) {
89 return cfp;
90 }
91 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
92 }
93
94 return NULL;
95 }
96}
97
98const VALUE *
99rb_vm_ep_local_ep(const VALUE *ep)
100{
101 return VM_EP_LEP(ep);
102}
103
104PUREFUNC(static inline const VALUE *VM_CF_LEP(const rb_control_frame_t * const cfp));
105static inline const VALUE *
106VM_CF_LEP(const rb_control_frame_t * const cfp)
107{
108 return VM_EP_LEP(cfp->ep);
109}
110
111static inline const VALUE *
112VM_CF_PREV_EP(const rb_control_frame_t * const cfp)
113{
114 return VM_ENV_PREV_EP(cfp->ep);
115}
116
117PUREFUNC(static inline VALUE VM_CF_BLOCK_HANDLER(const rb_control_frame_t * const cfp));
118static inline VALUE
119VM_CF_BLOCK_HANDLER(const rb_control_frame_t * const cfp)
120{
121 const VALUE *ep = VM_CF_LEP(cfp);
122 return VM_ENV_BLOCK_HANDLER(ep);
123}
124
125int
126rb_vm_cframe_keyword_p(const rb_control_frame_t *cfp)
127{
128 return VM_FRAME_CFRAME_KW_P(cfp);
129}
130
131VALUE
132rb_vm_frame_block_handler(const rb_control_frame_t *cfp)
133{
134 return VM_CF_BLOCK_HANDLER(cfp);
135}
136
137#if VM_CHECK_MODE > 0
138static int
139VM_CFP_IN_HEAP_P(const rb_execution_context_t *ec, const rb_control_frame_t *cfp)
140{
141 const VALUE *start = ec->vm_stack;
142 const VALUE *end = (VALUE *)ec->vm_stack + ec->vm_stack_size;
143 VM_ASSERT(start != NULL);
144
145 if (start <= (VALUE *)cfp && (VALUE *)cfp < end) {
146 return FALSE;
147 }
148 else {
149 return TRUE;
150 }
151}
152
153static int
154VM_EP_IN_HEAP_P(const rb_execution_context_t *ec, const VALUE *ep)
155{
156 const VALUE *start = ec->vm_stack;
157 const VALUE *end = (VALUE *)ec->cfp;
158 VM_ASSERT(start != NULL);
159
160 if (start <= ep && ep < end) {
161 return FALSE;
162 }
163 else {
164 return TRUE;
165 }
166}
167
168static int
169vm_ep_in_heap_p_(const rb_execution_context_t *ec, const VALUE *ep)
170{
171 if (VM_EP_IN_HEAP_P(ec, ep)) {
172 VALUE envval = ep[VM_ENV_DATA_INDEX_ENV]; /* VM_ENV_ENVVAL(ep); */
173
174 if (!UNDEF_P(envval)) {
175 const rb_env_t *env = (const rb_env_t *)envval;
176
177 VM_ASSERT(imemo_type_p(envval, imemo_env));
178 VM_ASSERT(VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED));
179 VM_ASSERT(env->ep == ep);
180 }
181 return TRUE;
182 }
183 else {
184 return FALSE;
185 }
186}
187
188int
189rb_vm_ep_in_heap_p(const VALUE *ep)
190{
191 const rb_execution_context_t *ec = GET_EC();
192 if (ec->vm_stack == NULL) return TRUE;
193 return vm_ep_in_heap_p_(ec, ep);
194}
195#endif
196
197static struct rb_captured_block *
198VM_CFP_TO_CAPTURED_BLOCK(const rb_control_frame_t *cfp)
199{
200 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
201 return (struct rb_captured_block *)&cfp->self;
202}
203
204static rb_control_frame_t *
205VM_CAPTURED_BLOCK_TO_CFP(const struct rb_captured_block *captured)
206{
207 rb_control_frame_t *cfp = ((rb_control_frame_t *)((VALUE *)(captured) - 3));
208 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp));
209 VM_ASSERT(sizeof(rb_control_frame_t)/sizeof(VALUE) == 7 + VM_DEBUG_BP_CHECK ? 1 : 0);
210 return cfp;
211}
212
213static int
214VM_BH_FROM_CFP_P(VALUE block_handler, const rb_control_frame_t *cfp)
215{
216 const struct rb_captured_block *captured = VM_CFP_TO_CAPTURED_BLOCK(cfp);
217 return VM_TAGGED_PTR_REF(block_handler, 0x03) == captured;
218}
219
220static VALUE
221vm_passed_block_handler(rb_execution_context_t *ec)
222{
223 VALUE block_handler = ec->passed_block_handler;
224 ec->passed_block_handler = VM_BLOCK_HANDLER_NONE;
225 vm_block_handler_verify(block_handler);
226 return block_handler;
227}
228
229static rb_cref_t *
230vm_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{
232 VALUE refinements = Qnil;
233 int omod_shared = FALSE;
234
235 /* scope */
236 rb_scope_visibility_t scope_visi;
237 scope_visi.method_visi = visi;
238 scope_visi.module_func = module_func;
239
240 /* refinements */
241 if (prev_cref != NULL && prev_cref != (void *)1 /* TODO: why CREF_NEXT(cref) is 1? */) {
242 refinements = CREF_REFINEMENTS(prev_cref);
243
244 if (!NIL_P(refinements)) {
245 omod_shared = TRUE;
246 CREF_OMOD_SHARED_SET(prev_cref);
247 }
248 }
249
250 VM_ASSERT(singleton || klass);
251
252 rb_cref_t *cref = IMEMO_NEW(rb_cref_t, imemo_cref, refinements);
253 cref->klass_or_self = klass;
254 cref->next = use_prev_prev ? CREF_NEXT(prev_cref) : prev_cref;
255 *((rb_scope_visibility_t *)&cref->scope_visi) = scope_visi;
256
257 if (pushed_by_eval) CREF_PUSHED_BY_EVAL_SET(cref);
258 if (omod_shared) CREF_OMOD_SHARED_SET(cref);
259 if (singleton) CREF_SINGLETON_SET(cref);
260
261 return cref;
262}
263
264static rb_cref_t *
265vm_cref_new(VALUE klass, rb_method_visibility_t visi, int module_func, rb_cref_t *prev_cref, int pushed_by_eval, int singleton)
266{
267 return vm_cref_new0(klass, visi, module_func, prev_cref, pushed_by_eval, FALSE, singleton);
268}
269
270static rb_cref_t *
271vm_cref_new_use_prev(VALUE klass, rb_method_visibility_t visi, int module_func, rb_cref_t *prev_cref, int pushed_by_eval)
272{
273 return vm_cref_new0(klass, visi, module_func, prev_cref, pushed_by_eval, TRUE, FALSE);
274}
275
276static int
277ref_delete_symkey(VALUE key, VALUE value, VALUE unused)
278{
279 return SYMBOL_P(key) ? ST_DELETE : ST_CONTINUE;
280}
281
282static rb_cref_t *
283vm_cref_dup(const rb_cref_t *cref)
284{
285 const rb_scope_visibility_t *visi = CREF_SCOPE_VISI(cref);
286 rb_cref_t *next_cref = CREF_NEXT(cref), *new_cref;
287 int pushed_by_eval = CREF_PUSHED_BY_EVAL(cref);
288 int singleton = CREF_SINGLETON(cref);
289
290 new_cref = vm_cref_new(cref->klass_or_self, visi->method_visi, visi->module_func, next_cref, pushed_by_eval, singleton);
291
292 if (!NIL_P(CREF_REFINEMENTS(cref))) {
293 VALUE ref = rb_hash_dup(CREF_REFINEMENTS(cref));
294 rb_hash_foreach(ref, ref_delete_symkey, Qnil);
295 CREF_REFINEMENTS_SET(new_cref, ref);
296 CREF_OMOD_SHARED_UNSET(new_cref);
297 }
298
299 return new_cref;
300}
301
302
303rb_cref_t *
304rb_vm_cref_dup_without_refinements(const rb_cref_t *cref)
305{
306 const rb_scope_visibility_t *visi = CREF_SCOPE_VISI(cref);
307 rb_cref_t *next_cref = CREF_NEXT(cref), *new_cref;
308 int pushed_by_eval = CREF_PUSHED_BY_EVAL(cref);
309 int singleton = CREF_SINGLETON(cref);
310
311 new_cref = vm_cref_new(cref->klass_or_self, visi->method_visi, visi->module_func, next_cref, pushed_by_eval, singleton);
312
313 if (!NIL_P(CREF_REFINEMENTS(cref))) {
314 CREF_REFINEMENTS_SET(new_cref, Qnil);
315 CREF_OMOD_SHARED_UNSET(new_cref);
316 }
317
318 return new_cref;
319}
320
321static rb_cref_t *
322vm_cref_new_toplevel(rb_execution_context_t *ec)
323{
324 rb_cref_t *cref = vm_cref_new(rb_cObject, METHOD_VISI_PRIVATE /* toplevel visibility is private */, FALSE, NULL, FALSE, FALSE);
325 VALUE top_wrapper = rb_ec_thread_ptr(ec)->top_wrapper;
326
327 if (top_wrapper) {
328 cref = vm_cref_new(top_wrapper, METHOD_VISI_PRIVATE, FALSE, cref, FALSE, FALSE);
329 }
330
331 return cref;
332}
333
334rb_cref_t *
335rb_vm_cref_new_toplevel(void)
336{
337 return vm_cref_new_toplevel(GET_EC());
338}
339
340static void
341vm_cref_dump(const char *mesg, const rb_cref_t *cref)
342{
343 ruby_debug_printf("vm_cref_dump: %s (%p)\n", mesg, (void *)cref);
344
345 while (cref) {
346 ruby_debug_printf("= cref| klass: %s\n", RSTRING_PTR(rb_class_path(CREF_CLASS(cref))));
347 cref = CREF_NEXT(cref);
348 }
349}
350
351void
352rb_vm_block_ep_update(VALUE obj, const struct rb_block *dst, const VALUE *ep)
353{
354 *((const VALUE **)&dst->as.captured.ep) = ep;
355 RB_OBJ_WRITTEN(obj, Qundef, VM_ENV_ENVVAL(ep));
356}
357
358static void
359vm_bind_update_env(VALUE bindval, rb_binding_t *bind, VALUE envval)
360{
361 const rb_env_t *env = (rb_env_t *)envval;
362 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, env->iseq);
363 rb_vm_block_ep_update(bindval, &bind->block, env->ep);
364}
365
366#if VM_COLLECT_USAGE_DETAILS
367static void vm_collect_usage_operand(int insn, int n, VALUE op);
368static void vm_collect_usage_insn(int insn);
369static void vm_collect_usage_register(int reg, int isset);
370#endif
371
372static VALUE vm_make_env_object(const rb_execution_context_t *ec, rb_control_frame_t *cfp);
373static VALUE vm_invoke_bmethod(rb_execution_context_t *ec, rb_proc_t *proc, VALUE self,
374 int argc, const VALUE *argv, int kw_splat, VALUE block_handler,
376static 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);
377
378#if USE_YJIT
379// Counter to serve as a proxy for execution time, total number of calls
380static uint64_t yjit_total_entry_hits = 0;
381
382// Number of calls used to estimate how hot an ISEQ is
383#define YJIT_CALL_COUNT_INTERV 20u
384
386static inline bool
387rb_yjit_threshold_hit(const rb_iseq_t *iseq, uint64_t entry_calls)
388{
389 yjit_total_entry_hits += 1;
390
391 // Record the number of calls at the beginning of the interval
392 if (entry_calls + YJIT_CALL_COUNT_INTERV == rb_yjit_call_threshold) {
393 iseq->body->yjit_calls_at_interv = yjit_total_entry_hits;
394 }
395
396 // Try to estimate the total time taken (total number of calls) to reach 20 calls to this ISEQ
397 // This give us a ratio of how hot/cold this ISEQ is
398 if (entry_calls == rb_yjit_call_threshold) {
399 // We expect threshold 1 to compile everything immediately
400 if (rb_yjit_call_threshold < YJIT_CALL_COUNT_INTERV) {
401 return true;
402 }
403
404 uint64_t num_calls = yjit_total_entry_hits - iseq->body->yjit_calls_at_interv;
405
406 // Reject ISEQs that don't get called often enough
407 if (num_calls > rb_yjit_cold_threshold) {
408 rb_yjit_incr_counter("cold_iseq_entry");
409 return false;
410 }
411
412 return true;
413 }
414
415 return false;
416}
417#else
418#define rb_yjit_threshold_hit(iseq, entry_calls) false
419#endif
420
421#if USE_YJIT || USE_ZJIT
422// Generate JIT code that supports the following kinds of ISEQ entries:
423// * The first ISEQ on vm_exec (e.g. <main>, or Ruby methods/blocks
424// called by a C method). The current frame has VM_FRAME_FLAG_FINISH.
425// The current vm_exec stops if JIT code returns a non-Qundef value.
426// * ISEQs called by the interpreter on vm_sendish (e.g. Ruby methods or
427// blocks called by a Ruby frame that isn't compiled or side-exited).
428// The current frame doesn't have VM_FRAME_FLAG_FINISH. The current
429// vm_exec does NOT stop whether JIT code returns Qundef or not.
430static inline rb_jit_func_t
431jit_compile(rb_execution_context_t *ec)
432{
433 const rb_iseq_t *iseq = ec->cfp->iseq;
434 struct rb_iseq_constant_body *body = ISEQ_BODY(iseq);
435
436#if USE_ZJIT
437 if (body->jit_entry == NULL && rb_zjit_enabled_p) {
438 body->jit_entry_calls++;
439
440 // At profile-threshold, rewrite some of the YARV instructions
441 // to zjit_* instructions to profile these instructions.
442 if (body->jit_entry_calls == rb_zjit_profile_threshold) {
443 rb_zjit_profile_enable(iseq);
444 }
445
446 // At call-threshold, compile the ISEQ with ZJIT.
447 if (body->jit_entry_calls == rb_zjit_call_threshold) {
448 rb_zjit_compile_iseq(iseq, ec, false);
449 }
450 }
451#endif
452
453#if USE_YJIT
454 // Increment the ISEQ's call counter and trigger JIT compilation if not compiled
455 if (body->jit_entry == NULL && rb_yjit_enabled_p) {
456 body->jit_entry_calls++;
457 if (rb_yjit_threshold_hit(iseq, body->jit_entry_calls)) {
458 rb_yjit_compile_iseq(iseq, ec, false);
459 }
460 }
461#endif
462 return body->jit_entry;
463}
464
465// Execute JIT code compiled by jit_compile()
466static inline VALUE
467jit_exec(rb_execution_context_t *ec)
468{
469 rb_jit_func_t func = jit_compile(ec);
470 if (func) {
471 // Call the JIT code
472 return func(ec, ec->cfp);
473 }
474 else {
475 return Qundef;
476 }
477}
478#else
479# define jit_compile(ec) ((rb_jit_func_t)0)
480# define jit_exec(ec) Qundef
481#endif
482
483#if USE_YJIT
484// Generate JIT code that supports the following kind of ISEQ entry:
485// * The first ISEQ pushed by vm_exec_handle_exception. The frame would
486// point to a location specified by a catch table, and it doesn't have
487// VM_FRAME_FLAG_FINISH. The current vm_exec stops if JIT code returns
488// a non-Qundef value. So you should not return a non-Qundef value
489// until ec->cfp is changed to a frame with VM_FRAME_FLAG_FINISH.
490static inline rb_jit_func_t
491jit_compile_exception(rb_execution_context_t *ec)
492{
493 const rb_iseq_t *iseq = ec->cfp->iseq;
494 struct rb_iseq_constant_body *body = ISEQ_BODY(iseq);
495
496 // Increment the ISEQ's call counter and trigger JIT compilation if not compiled
497#if USE_YJIT
498 if (body->jit_exception == NULL && rb_yjit_enabled_p) {
499 body->jit_exception_calls++;
500 if (body->jit_exception_calls == rb_yjit_call_threshold) {
501 rb_yjit_compile_iseq(iseq, ec, true);
502 }
503 }
504#endif
505 return body->jit_exception;
506}
507
508// Execute JIT code compiled by jit_compile_exception()
509static inline VALUE
510jit_exec_exception(rb_execution_context_t *ec)
511{
512 rb_jit_func_t func = jit_compile_exception(ec);
513 if (func) {
514 // Call the JIT code
515 return func(ec, ec->cfp);
516 }
517 else {
518 return Qundef;
519 }
520}
521#else
522# define jit_compile_exception(ec) ((rb_jit_func_t)0)
523# define jit_exec_exception(ec) Qundef
524#endif
525
526static void add_opt_method_entry(const rb_method_entry_t *me);
527
528#define RB_TYPE_2_P(obj, type1, type2) \
529 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2))
530#define RB_TYPE_3_P(obj, type1, type2, type3) \
531 (RB_TYPE_P(obj, type1) || RB_TYPE_P(obj, type2) || RB_TYPE_P(obj, type3))
532
533#define VM_ASSERT_TYPE(obj, type) \
534 VM_ASSERT(RB_TYPE_P(obj, type), #obj ": %s", rb_obj_info(obj))
535#define VM_ASSERT_TYPE2(obj, type1, type2) \
536 VM_ASSERT(RB_TYPE_2_P(obj, type1, type2), #obj ": %s", rb_obj_info(obj))
537#define VM_ASSERT_TYPE3(obj, type1, type2, type3) \
538 VM_ASSERT(RB_TYPE_3_P(obj, type1, type2, type3), #obj ": %s", rb_obj_info(obj))
539
540#include "vm_insnhelper.c"
541
542#include "vm_exec.c"
543
544#include "vm_method.c"
545#include "vm_eval.c"
546
547#define PROCDEBUG 0
548
549VALUE rb_cRubyVM;
551VALUE rb_mRubyVMFrozenCore;
552VALUE rb_block_param_proxy;
553
554VALUE ruby_vm_const_missing_count = 0;
555rb_vm_t *ruby_current_vm_ptr = NULL;
556rb_ractor_t *ruby_single_main_ractor;
557bool ruby_vm_keep_script_lines;
558
559#ifdef RB_THREAD_LOCAL_SPECIFIER
560RB_THREAD_LOCAL_SPECIFIER rb_execution_context_t *ruby_current_ec;
561
562#ifdef RUBY_NT_SERIAL
563RB_THREAD_LOCAL_SPECIFIER rb_atomic_t ruby_nt_serial;
564#endif
565
566// no-inline decl on vm_core.h
568rb_current_ec_noinline(void)
569{
570 return ruby_current_ec;
571}
572
573void
574rb_current_ec_set(rb_execution_context_t *ec)
575{
576 ruby_current_ec = ec;
577}
578
579
580#if defined(__arm64__) || defined(__aarch64__)
582rb_current_ec(void)
583{
584 return ruby_current_ec;
585}
586
587#endif
588#else
589native_tls_key_t ruby_current_ec_key;
590
591// no-inline decl on vm_core.h
593rb_current_ec_noinline(void)
594{
595 return native_tls_get(ruby_current_ec_key);
596}
597
598#endif
599
600rb_event_flag_t ruby_vm_event_flags;
601rb_event_flag_t ruby_vm_event_enabled_global_flags;
602unsigned int ruby_vm_event_local_num;
603
604rb_serial_t ruby_vm_constant_cache_invalidations = 0;
605rb_serial_t ruby_vm_constant_cache_misses = 0;
606rb_serial_t ruby_vm_global_cvar_state = 1;
607
608static const struct rb_callcache vm_empty_cc = {
609 .flags = T_IMEMO | (imemo_callcache << FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
610 .klass = Qfalse,
611 .cme_ = NULL,
612 .call_ = vm_call_general,
613 .aux_ = {
614 .v = Qfalse,
615 }
616};
617
618static const struct rb_callcache vm_empty_cc_for_super = {
619 .flags = T_IMEMO | (imemo_callcache << FL_USHIFT) | VM_CALLCACHE_UNMARKABLE,
620 .klass = Qfalse,
621 .cme_ = NULL,
622 .call_ = vm_call_super_method,
623 .aux_ = {
624 .v = Qfalse,
625 }
626};
627
628static void thread_free(void *ptr);
629
630void
631rb_vm_inc_const_missing_count(void)
632{
633 ruby_vm_const_missing_count +=1;
634}
635
636int
637rb_dtrace_setup(rb_execution_context_t *ec, VALUE klass, ID id,
638 struct ruby_dtrace_method_hook_args *args)
639{
641 if (!klass) {
642 if (!ec) ec = GET_EC();
643 if (!rb_ec_frame_method_id_and_class(ec, &id, 0, &klass) || !klass)
644 return FALSE;
645 }
646 if (RB_TYPE_P(klass, T_ICLASS)) {
647 klass = RBASIC(klass)->klass;
648 }
649 else if (RCLASS_SINGLETON_P(klass)) {
650 klass = RCLASS_ATTACHED_OBJECT(klass);
651 if (NIL_P(klass)) return FALSE;
652 }
653 type = BUILTIN_TYPE(klass);
654 if (type == T_CLASS || type == T_ICLASS || type == T_MODULE) {
655 VALUE name = rb_class_path(klass);
656 const char *classname, *filename;
657 const char *methodname = rb_id2name(id);
658 if (methodname && (filename = rb_source_location_cstr(&args->line_no)) != 0) {
659 if (NIL_P(name) || !(classname = StringValuePtr(name)))
660 classname = "<unknown>";
661 args->classname = classname;
662 args->methodname = methodname;
663 args->filename = filename;
664 args->klass = klass;
665 args->name = name;
666 return TRUE;
667 }
668 }
669 return FALSE;
670}
671
672extern unsigned int redblack_buffer_size;
673
674/*
675 * call-seq:
676 * RubyVM.stat -> Hash
677 * RubyVM.stat(hsh) -> hsh
678 * RubyVM.stat(Symbol) -> Numeric
679 *
680 * Returns a Hash containing implementation-dependent counters inside the VM.
681 *
682 * This hash includes information about method/constant caches:
683 *
684 * {
685 * :constant_cache_invalidations=>2,
686 * :constant_cache_misses=>14,
687 * :global_cvar_state=>27
688 * }
689 *
690 * If <tt>USE_DEBUG_COUNTER</tt> is enabled, debug counters will be included.
691 *
692 * The contents of the hash are implementation specific and may be changed in
693 * the future.
694 *
695 * This method is only expected to work on C Ruby.
696 */
697static VALUE
698vm_stat(int argc, VALUE *argv, VALUE self)
699{
700 static VALUE sym_constant_cache_invalidations, sym_constant_cache_misses, sym_global_cvar_state, sym_next_shape_id;
701 static VALUE sym_shape_cache_size;
702 VALUE arg = Qnil;
703 VALUE hash = Qnil, key = Qnil;
704
705 if (rb_check_arity(argc, 0, 1) == 1) {
706 arg = argv[0];
707 if (SYMBOL_P(arg))
708 key = arg;
709 else if (RB_TYPE_P(arg, T_HASH))
710 hash = arg;
711 else
712 rb_raise(rb_eTypeError, "non-hash or symbol given");
713 }
714 else {
715 hash = rb_hash_new();
716 }
717
718#define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
719 S(constant_cache_invalidations);
720 S(constant_cache_misses);
721 S(global_cvar_state);
722 S(next_shape_id);
723 S(shape_cache_size);
724#undef S
725
726#define SET(name, attr) \
727 if (key == sym_##name) \
728 return SERIALT2NUM(attr); \
729 else if (hash != Qnil) \
730 rb_hash_aset(hash, sym_##name, SERIALT2NUM(attr));
731
732 SET(constant_cache_invalidations, ruby_vm_constant_cache_invalidations);
733 SET(constant_cache_misses, ruby_vm_constant_cache_misses);
734 SET(global_cvar_state, ruby_vm_global_cvar_state);
735 SET(next_shape_id, (rb_serial_t)rb_shape_tree.next_shape_id);
736 SET(shape_cache_size, (rb_serial_t)rb_shape_tree.cache_size);
737#undef SET
738
739#if USE_DEBUG_COUNTER
740 ruby_debug_counter_show_at_exit(FALSE);
741 for (size_t i = 0; i < RB_DEBUG_COUNTER_MAX; i++) {
742 const VALUE name = rb_sym_intern_ascii_cstr(rb_debug_counter_names[i]);
743 const VALUE boxed_value = SIZET2NUM(rb_debug_counter[i]);
744
745 if (key == name) {
746 return boxed_value;
747 }
748 else if (hash != Qnil) {
749 rb_hash_aset(hash, name, boxed_value);
750 }
751 }
752#endif
753
754 if (!NIL_P(key)) { /* matched key should return above */
755 rb_raise(rb_eArgError, "unknown key: %"PRIsVALUE, rb_sym2str(key));
756 }
757
758 return hash;
759}
760
761/* control stack frame */
762
763static void
764vm_set_top_stack(rb_execution_context_t *ec, const rb_iseq_t *iseq)
765{
766 if (ISEQ_BODY(iseq)->type != ISEQ_TYPE_TOP) {
767 rb_raise(rb_eTypeError, "Not a toplevel InstructionSequence");
768 }
769
770 /* for return */
771 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH, rb_ec_thread_ptr(ec)->top_self,
772 VM_BLOCK_HANDLER_NONE,
773 (VALUE)vm_cref_new_toplevel(ec), /* cref or me */
774 ISEQ_BODY(iseq)->iseq_encoded, ec->cfp->sp,
775 ISEQ_BODY(iseq)->local_table_size, ISEQ_BODY(iseq)->stack_max);
776}
777
778static void
779vm_set_eval_stack(rb_execution_context_t *ec, const rb_iseq_t *iseq, const rb_cref_t *cref, const struct rb_block *base_block)
780{
781 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_EVAL | VM_FRAME_FLAG_FINISH,
782 vm_block_self(base_block), VM_GUARDED_PREV_EP(vm_block_ep(base_block)),
783 (VALUE)cref, /* cref or me */
784 ISEQ_BODY(iseq)->iseq_encoded,
785 ec->cfp->sp, ISEQ_BODY(iseq)->local_table_size,
786 ISEQ_BODY(iseq)->stack_max);
787}
788
789static void
790vm_set_main_stack(rb_execution_context_t *ec, const rb_iseq_t *iseq)
791{
792 VALUE toplevel_binding = rb_const_get(rb_cObject, rb_intern("TOPLEVEL_BINDING"));
793 rb_binding_t *bind;
794
795 GetBindingPtr(toplevel_binding, bind);
796 RUBY_ASSERT_MESG(bind, "TOPLEVEL_BINDING is not built");
797
798 vm_set_eval_stack(ec, iseq, 0, &bind->block);
799
800 /* save binding */
801 if (ISEQ_BODY(iseq)->local_table_size > 0) {
802 vm_bind_update_env(toplevel_binding, bind, vm_make_env_object(ec, ec->cfp));
803 }
804}
805
807rb_vm_get_binding_creatable_next_cfp(const rb_execution_context_t *ec, const rb_control_frame_t *cfp)
808{
809 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
810 if (cfp->iseq) {
811 return (rb_control_frame_t *)cfp;
812 }
813 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
814 }
815 return 0;
816}
817
819rb_vm_get_ruby_level_next_cfp(const rb_execution_context_t *ec, const rb_control_frame_t *cfp)
820{
821 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
822 if (VM_FRAME_RUBYFRAME_P(cfp)) {
823 return (rb_control_frame_t *)cfp;
824 }
825 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
826 }
827 return 0;
828}
829
830static rb_control_frame_t *
831vm_get_ruby_level_caller_cfp(const rb_execution_context_t *ec, const rb_control_frame_t *cfp)
832{
833 if (VM_FRAME_RUBYFRAME_P(cfp)) {
834 return (rb_control_frame_t *)cfp;
835 }
836
837 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
838
839 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
840 if (VM_FRAME_RUBYFRAME_P(cfp)) {
841 return (rb_control_frame_t *)cfp;
842 }
843
844 if (VM_ENV_FLAGS(cfp->ep, VM_FRAME_FLAG_PASSED) == FALSE) {
845 break;
846 }
847 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
848 }
849 return 0;
850}
851
852void
853rb_vm_pop_cfunc_frame(void)
854{
855 rb_execution_context_t *ec = GET_EC();
856 rb_control_frame_t *cfp = ec->cfp;
857 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
858
859 EXEC_EVENT_HOOK(ec, RUBY_EVENT_C_RETURN, cfp->self, me->def->original_id, me->called_id, me->owner, Qnil);
860 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec, me->owner, me->def->original_id);
861 vm_pop_frame(ec, cfp, cfp->ep);
862}
863
864void
865rb_vm_rewind_cfp(rb_execution_context_t *ec, rb_control_frame_t *cfp)
866{
867 /* check skipped frame */
868 while (ec->cfp != cfp) {
869#if VMDEBUG
870 printf("skipped frame: %s\n", vm_frametype_name(ec->cfp));
871#endif
872 if (VM_FRAME_TYPE(ec->cfp) != VM_FRAME_MAGIC_CFUNC) {
873 rb_vm_pop_frame(ec);
874 }
875 else { /* unlikely path */
876 rb_vm_pop_cfunc_frame();
877 }
878 }
879}
880
881/* at exit */
882
883void
884ruby_vm_at_exit(void (*func)(rb_vm_t *))
885{
886 rb_vm_t *vm = GET_VM();
888 nl->func = func;
889 nl->next = vm->at_exit;
890 vm->at_exit = nl;
891}
892
893static void
894ruby_vm_run_at_exit_hooks(rb_vm_t *vm)
895{
896 rb_at_exit_list *l = vm->at_exit;
897
898 while (l) {
899 rb_at_exit_list* t = l->next;
900 rb_vm_at_exit_func *func = l->func;
901 ruby_xfree(l);
902 l = t;
903 (*func)(vm);
904 }
905}
906
907/* Env */
908
909static VALUE check_env_value(const rb_env_t *env);
910
911static int
912check_env(const rb_env_t *env)
913{
914 fputs("---\n", stderr);
915 ruby_debug_printf("envptr: %p\n", (void *)&env->ep[0]);
916 ruby_debug_printf("envval: %10p ", (void *)env->ep[1]);
917 dp(env->ep[1]);
918 ruby_debug_printf("ep: %10p\n", (void *)env->ep);
919 if (rb_vm_env_prev_env(env)) {
920 fputs(">>\n", stderr);
921 check_env_value(rb_vm_env_prev_env(env));
922 fputs("<<\n", stderr);
923 }
924 return 1;
925}
926
927static VALUE
928check_env_value(const rb_env_t *env)
929{
930 if (check_env(env)) {
931 return (VALUE)env;
932 }
933 rb_bug("invalid env");
934 return Qnil; /* unreachable */
935}
936
937static VALUE
938vm_block_handler_escape(const rb_execution_context_t *ec, VALUE block_handler)
939{
940 switch (vm_block_handler_type(block_handler)) {
941 case block_handler_type_ifunc:
942 case block_handler_type_iseq:
943 return rb_vm_make_proc(ec, VM_BH_TO_CAPT_BLOCK(block_handler), rb_cProc);
944
945 case block_handler_type_symbol:
946 case block_handler_type_proc:
947 return block_handler;
948 }
949 VM_UNREACHABLE(vm_block_handler_escape);
950 return Qnil;
951}
952
953static VALUE
954vm_make_env_each(const rb_execution_context_t * const ec, rb_control_frame_t *const cfp)
955{
956 const VALUE * const ep = cfp->ep;
957 VALUE *env_body, *env_ep;
958 int local_size, env_size;
959
960 if (VM_ENV_ESCAPED_P(ep)) {
961 return VM_ENV_ENVVAL(ep);
962 }
963
964 if (!VM_ENV_LOCAL_P(ep)) {
965 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
966 if (!VM_ENV_ESCAPED_P(prev_ep)) {
967 rb_control_frame_t *prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
968
969 while (prev_cfp->ep != prev_ep) {
970 prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(prev_cfp);
971 VM_ASSERT(prev_cfp->ep != NULL);
972 }
973
974 vm_make_env_each(ec, prev_cfp);
975 VM_FORCE_WRITE_SPECIAL_CONST(&ep[VM_ENV_DATA_INDEX_SPECVAL], VM_GUARDED_PREV_EP(prev_cfp->ep));
976 }
977 }
978 else {
979 VALUE block_handler = VM_ENV_BLOCK_HANDLER(ep);
980
981 if (block_handler != VM_BLOCK_HANDLER_NONE) {
982 VALUE blockprocval = vm_block_handler_escape(ec, block_handler);
983 VM_STACK_ENV_WRITE(ep, VM_ENV_DATA_INDEX_SPECVAL, blockprocval);
984 }
985 }
986
987 if (!VM_FRAME_RUBYFRAME_P(cfp)) {
988 local_size = VM_ENV_DATA_SIZE;
989 }
990 else {
991 local_size = ISEQ_BODY(cfp->iseq)->local_table_size;
992 if (ISEQ_BODY(cfp->iseq)->param.flags.forwardable && VM_ENV_LOCAL_P(cfp->ep)) {
993 int ci_offset = local_size - ISEQ_BODY(cfp->iseq)->param.size + VM_ENV_DATA_SIZE;
994
995 CALL_INFO ci = (CALL_INFO)VM_CF_LEP(cfp)[-ci_offset];
996 local_size += vm_ci_argc(ci);
997 }
998 local_size += VM_ENV_DATA_SIZE;
999 }
1000
1001 /*
1002 * # local variables on a stack frame (N == local_size)
1003 * [lvar1, lvar2, ..., lvarN, SPECVAL]
1004 * ^
1005 * ep[0]
1006 *
1007 * # moved local variables
1008 * [lvar1, lvar2, ..., lvarN, SPECVAL, Envval, BlockProcval (if needed)]
1009 * ^ ^
1010 * env->env[0] ep[0]
1011 */
1012
1013 env_size = local_size +
1014 1 /* envval */;
1015
1016 // Careful with order in the following sequence. Each allocation can move objects.
1017 env_body = ALLOC_N(VALUE, env_size);
1018 rb_env_t *env = IMEMO_NEW(rb_env_t, imemo_env, 0);
1019
1020 // Set up env without WB since it's brand new (similar to newobj_init(), newobj_fill())
1021 MEMCPY(env_body, ep - (local_size - 1 /* specval */), VALUE, local_size);
1022
1023 env_ep = &env_body[local_size - 1 /* specval */];
1024 env_ep[VM_ENV_DATA_INDEX_ENV] = (VALUE)env;
1025
1026 env->iseq = (rb_iseq_t *)(VM_FRAME_RUBYFRAME_P(cfp) ? cfp->iseq : NULL);
1027 env->ep = env_ep;
1028 env->env = env_body;
1029 env->env_size = env_size;
1030
1031 cfp->ep = env_ep;
1032 VM_ENV_FLAGS_SET(env_ep, VM_ENV_FLAG_ESCAPED | VM_ENV_FLAG_WB_REQUIRED);
1033 VM_STACK_ENV_WRITE(ep, 0, (VALUE)env); /* GC mark */
1034
1035#if 0
1036 for (i = 0; i < local_size; i++) {
1037 if (VM_FRAME_RUBYFRAME_P(cfp)) {
1038 /* clear value stack for GC */
1039 ep[-local_size + i] = 0;
1040 }
1041 }
1042#endif
1043
1044 // Invalidate JIT code that assumes cfp->ep == vm_base_ptr(cfp).
1045 if (env->iseq) {
1046 rb_yjit_invalidate_ep_is_bp(env->iseq);
1047 rb_zjit_invalidate_ep_is_bp(env->iseq);
1048 }
1049
1050 return (VALUE)env;
1051}
1052
1053static VALUE
1054vm_make_env_object(const rb_execution_context_t *ec, rb_control_frame_t *cfp)
1055{
1056 VALUE envval = vm_make_env_each(ec, cfp);
1057
1058 if (PROCDEBUG) {
1059 check_env_value((const rb_env_t *)envval);
1060 }
1061
1062 return envval;
1063}
1064
1065void
1066rb_vm_stack_to_heap(rb_execution_context_t *ec)
1067{
1068 rb_control_frame_t *cfp = ec->cfp;
1069 while ((cfp = rb_vm_get_binding_creatable_next_cfp(ec, cfp)) != 0) {
1070 vm_make_env_object(ec, cfp);
1071 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1072 }
1073}
1074
1075const rb_env_t *
1076rb_vm_env_prev_env(const rb_env_t *env)
1077{
1078 const VALUE *ep = env->ep;
1079
1080 if (VM_ENV_LOCAL_P(ep)) {
1081 return NULL;
1082 }
1083 else {
1084 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
1085 return VM_ENV_ENVVAL_PTR(prev_ep);
1086 }
1087}
1088
1089static int
1090collect_local_variables_in_iseq(const rb_iseq_t *iseq, const struct local_var_list *vars)
1091{
1092 unsigned int i;
1093 if (!iseq) return 0;
1094 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1095 local_var_list_add(vars, ISEQ_BODY(iseq)->local_table[i]);
1096 }
1097 return 1;
1098}
1099
1100static void
1101collect_local_variables_in_env(const rb_env_t *env, const struct local_var_list *vars)
1102{
1103 do {
1104 if (VM_ENV_FLAGS(env->ep, VM_ENV_FLAG_ISOLATED)) break;
1105 collect_local_variables_in_iseq(env->iseq, vars);
1106 } while ((env = rb_vm_env_prev_env(env)) != NULL);
1107}
1108
1109static int
1110vm_collect_local_variables_in_heap(const VALUE *ep, const struct local_var_list *vars)
1111{
1112 if (VM_ENV_ESCAPED_P(ep)) {
1113 collect_local_variables_in_env(VM_ENV_ENVVAL_PTR(ep), vars);
1114 return 1;
1115 }
1116 else {
1117 return 0;
1118 }
1119}
1120
1121VALUE
1122rb_vm_env_local_variables(const rb_env_t *env)
1123{
1124 struct local_var_list vars;
1125 local_var_list_init(&vars);
1126 collect_local_variables_in_env(env, &vars);
1127 return local_var_list_finish(&vars);
1128}
1129
1130VALUE
1131rb_vm_env_numbered_parameters(const rb_env_t *env)
1132{
1133 struct local_var_list vars;
1134 local_var_list_init(&vars);
1135 // if (VM_ENV_FLAGS(env->ep, VM_ENV_FLAG_ISOLATED)) break; // TODO: is this needed?
1136 const rb_iseq_t *iseq = env->iseq;
1137 unsigned int i;
1138 if (!iseq) return 0;
1139 for (i = 0; i < ISEQ_BODY(iseq)->local_table_size; i++) {
1140 numparam_list_add(&vars, ISEQ_BODY(iseq)->local_table[i]);
1141 }
1142 return local_var_list_finish(&vars);
1143}
1144
1145VALUE
1146rb_iseq_local_variables(const rb_iseq_t *iseq)
1147{
1148 struct local_var_list vars;
1149 local_var_list_init(&vars);
1150 while (collect_local_variables_in_iseq(iseq, &vars)) {
1151 iseq = ISEQ_BODY(iseq)->parent_iseq;
1152 }
1153 return local_var_list_finish(&vars);
1154}
1155
1156/* Proc */
1157
1158static VALUE
1159vm_proc_create_from_captured(VALUE klass,
1160 const struct rb_captured_block *captured,
1161 enum rb_block_type block_type,
1162 int8_t is_from_method, int8_t is_lambda)
1163{
1164 VALUE procval = rb_proc_alloc(klass);
1165 rb_proc_t *proc = RTYPEDDATA_DATA(procval);
1166 const rb_namespace_t *ns = rb_current_namespace();
1167
1168 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), captured->ep));
1169
1170 /* copy block */
1171 RB_OBJ_WRITE(procval, &proc->block.as.captured.code.val, captured->code.val);
1172 RB_OBJ_WRITE(procval, &proc->block.as.captured.self, captured->self);
1173 rb_vm_block_ep_update(procval, &proc->block, captured->ep);
1174
1175 vm_block_type_set(&proc->block, block_type);
1176 proc->ns = ns;
1177 proc->is_from_method = is_from_method;
1178 proc->is_lambda = is_lambda;
1179
1180 return procval;
1181}
1182
1183void
1184rb_vm_block_copy(VALUE obj, const struct rb_block *dst, const struct rb_block *src)
1185{
1186 /* copy block */
1187 switch (vm_block_type(src)) {
1188 case block_type_iseq:
1189 case block_type_ifunc:
1190 RB_OBJ_WRITE(obj, &dst->as.captured.self, src->as.captured.self);
1191 RB_OBJ_WRITE(obj, &dst->as.captured.code.val, src->as.captured.code.val);
1192 rb_vm_block_ep_update(obj, dst, src->as.captured.ep);
1193 break;
1194 case block_type_symbol:
1195 RB_OBJ_WRITE(obj, &dst->as.symbol, src->as.symbol);
1196 break;
1197 case block_type_proc:
1198 RB_OBJ_WRITE(obj, &dst->as.proc, src->as.proc);
1199 break;
1200 }
1201}
1202
1203static VALUE
1204proc_create(VALUE klass, const struct rb_block *block, int8_t is_from_method, int8_t is_lambda)
1205{
1206 VALUE procval = rb_proc_alloc(klass);
1207 rb_proc_t *proc = RTYPEDDATA_DATA(procval);
1208 const rb_namespace_t *ns = rb_current_namespace();
1209
1210 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), vm_block_ep(block)));
1211 rb_vm_block_copy(procval, &proc->block, block);
1212 vm_block_type_set(&proc->block, block->type);
1213 proc->ns = ns;
1214 proc->is_from_method = is_from_method;
1215 proc->is_lambda = is_lambda;
1216
1217 return procval;
1218}
1219
1220VALUE
1221rb_proc_dup(VALUE self)
1222{
1223 VALUE procval;
1224 rb_proc_t *src;
1225
1226 GetProcPtr(self, src);
1227
1228 switch (vm_block_type(&src->block)) {
1229 case block_type_ifunc:
1230 procval = rb_func_proc_dup(self);
1231 break;
1232 default:
1233 procval = proc_create(rb_obj_class(self), &src->block, src->is_from_method, src->is_lambda);
1234 break;
1235 }
1236
1237 if (RB_OBJ_SHAREABLE_P(self)) FL_SET_RAW(procval, RUBY_FL_SHAREABLE);
1238 RB_GC_GUARD(self); /* for: body = rb_proc_dup(body) */
1239 return procval;
1240}
1241
1243 VALUE ary;
1244 VALUE read_only;
1245 bool yield;
1246 bool isolate;
1247};
1248
1249static VALUE
1250ID2NUM(ID id)
1251{
1252 if (SIZEOF_VOIDP > SIZEOF_LONG)
1253 return ULL2NUM(id);
1254 else
1255 return ULONG2NUM(id);
1256}
1257
1258static ID
1259NUM2ID(VALUE num)
1260{
1261 if (SIZEOF_VOIDP > SIZEOF_LONG)
1262 return (ID)NUM2ULL(num);
1263 else
1264 return (ID)NUM2ULONG(num);
1265}
1266
1267static enum rb_id_table_iterator_result
1268collect_outer_variable_names(ID id, VALUE val, void *ptr)
1269{
1271
1272 if (id == rb_intern("yield")) {
1273 data->yield = true;
1274 }
1275 else {
1276 VALUE *store;
1277 if (data->isolate ||
1278 val == Qtrue /* write */) {
1279 store = &data->ary;
1280 }
1281 else {
1282 store = &data->read_only;
1283 }
1284 if (*store == Qfalse) *store = rb_ary_new();
1285 rb_ary_push(*store, ID2NUM(id));
1286 }
1287 return ID_TABLE_CONTINUE;
1288}
1289
1290static const rb_env_t *
1291env_copy(const VALUE *src_ep, VALUE read_only_variables)
1292{
1293 const rb_env_t *src_env = (rb_env_t *)VM_ENV_ENVVAL(src_ep);
1294 VM_ASSERT(src_env->ep == src_ep);
1295
1296 VALUE *env_body = ZALLOC_N(VALUE, src_env->env_size); // fill with Qfalse
1297 VALUE *ep = &env_body[src_env->env_size - 2];
1298 const rb_env_t *copied_env = vm_env_new(ep, env_body, src_env->env_size, src_env->iseq);
1299
1300 // Copy after allocations above, since they can move objects in src_ep.
1301 RB_OBJ_WRITE(copied_env, &ep[VM_ENV_DATA_INDEX_ME_CREF], src_ep[VM_ENV_DATA_INDEX_ME_CREF]);
1302 ep[VM_ENV_DATA_INDEX_FLAGS] = src_ep[VM_ENV_DATA_INDEX_FLAGS] | VM_ENV_FLAG_ISOLATED;
1303 if (!VM_ENV_LOCAL_P(src_ep)) {
1304 VM_ENV_FLAGS_SET(ep, VM_ENV_FLAG_LOCAL);
1305 }
1306
1307 if (read_only_variables) {
1308 for (int i=RARRAY_LENINT(read_only_variables)-1; i>=0; i--) {
1309 ID id = NUM2ID(RARRAY_AREF(read_only_variables, i));
1310
1311 for (unsigned int j=0; j<ISEQ_BODY(src_env->iseq)->local_table_size; j++) {
1312 if (id == ISEQ_BODY(src_env->iseq)->local_table[j]) {
1313 VALUE v = src_env->env[j];
1314 if (!rb_ractor_shareable_p(v)) {
1315 VALUE name = rb_id2str(id);
1316 VALUE msg = rb_sprintf("can not make shareable Proc because it can refer"
1317 " unshareable object %+" PRIsVALUE " from ", v);
1318 if (name)
1319 rb_str_catf(msg, "variable '%" PRIsVALUE "'", name);
1320 else
1321 rb_str_cat_cstr(msg, "a hidden variable");
1322 rb_exc_raise(rb_exc_new_str(rb_eRactorIsolationError, msg));
1323 }
1324 RB_OBJ_WRITE((VALUE)copied_env, &env_body[j], v);
1325 rb_ary_delete_at(read_only_variables, i);
1326 break;
1327 }
1328 }
1329 }
1330 }
1331
1332 if (!VM_ENV_LOCAL_P(src_ep)) {
1333 const VALUE *prev_ep = VM_ENV_PREV_EP(src_env->ep);
1334 const rb_env_t *new_prev_env = env_copy(prev_ep, read_only_variables);
1335 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_GUARDED_PREV_EP(new_prev_env->ep);
1336 RB_OBJ_WRITTEN(copied_env, Qundef, new_prev_env);
1337 VM_ENV_FLAGS_UNSET(ep, VM_ENV_FLAG_LOCAL);
1338 }
1339 else {
1340 ep[VM_ENV_DATA_INDEX_SPECVAL] = VM_BLOCK_HANDLER_NONE;
1341 }
1342
1343 return copied_env;
1344}
1345
1346static void
1347proc_isolate_env(VALUE self, rb_proc_t *proc, VALUE read_only_variables)
1348{
1349 const struct rb_captured_block *captured = &proc->block.as.captured;
1350 const rb_env_t *env = env_copy(captured->ep, read_only_variables);
1351 *((const VALUE **)&proc->block.as.captured.ep) = env->ep;
1352 RB_OBJ_WRITTEN(self, Qundef, env);
1353}
1354
1355static VALUE
1356proc_shared_outer_variables(struct rb_id_table *outer_variables, bool isolate, const char *message)
1357{
1358 struct collect_outer_variable_name_data data = {
1359 .isolate = isolate,
1360 .ary = Qfalse,
1361 .read_only = Qfalse,
1362 .yield = false,
1363 };
1364 rb_id_table_foreach(outer_variables, collect_outer_variable_names, (void *)&data);
1365
1366 if (data.ary != Qfalse) {
1367 VALUE str = rb_sprintf("can not %s because it accesses outer variables", message);
1368 VALUE ary = data.ary;
1369 const char *sep = " (";
1370 for (long i = 0; i < RARRAY_LEN(ary); i++) {
1371 VALUE name = rb_id2str(NUM2ID(RARRAY_AREF(ary, i)));
1372 if (!name) continue;
1373 rb_str_cat_cstr(str, sep);
1374 sep = ", ";
1375 rb_str_append(str, name);
1376 }
1377 if (*sep == ',') rb_str_cat_cstr(str, ")");
1378 rb_str_cat_cstr(str, data.yield ? " and uses 'yield'." : ".");
1379 rb_exc_raise(rb_exc_new_str(rb_eArgError, str));
1380 }
1381 else if (data.yield) {
1382 rb_raise(rb_eArgError, "can not %s because it uses 'yield'.", message);
1383 }
1384
1385 return data.read_only;
1386}
1387
1388VALUE
1389rb_proc_isolate_bang(VALUE self)
1390{
1391 const rb_iseq_t *iseq = vm_proc_iseq(self);
1392
1393 if (iseq) {
1394 rb_proc_t *proc = (rb_proc_t *)RTYPEDDATA_DATA(self);
1395 if (proc->block.type != block_type_iseq) rb_raise(rb_eRuntimeError, "not supported yet");
1396
1397 if (ISEQ_BODY(iseq)->outer_variables) {
1398 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables, true, "isolate a Proc");
1399 }
1400
1401 proc_isolate_env(self, proc, Qfalse);
1402 proc->is_isolated = TRUE;
1403 }
1404
1406 return self;
1407}
1408
1409VALUE
1410rb_proc_isolate(VALUE self)
1411{
1412 VALUE dst = rb_proc_dup(self);
1413 rb_proc_isolate_bang(dst);
1414 return dst;
1415}
1416
1417VALUE
1418rb_proc_ractor_make_shareable(VALUE self)
1419{
1420 const rb_iseq_t *iseq = vm_proc_iseq(self);
1421
1422 if (iseq) {
1423 rb_proc_t *proc = (rb_proc_t *)RTYPEDDATA_DATA(self);
1424 if (proc->block.type != block_type_iseq) rb_raise(rb_eRuntimeError, "not supported yet");
1425
1426 if (!rb_ractor_shareable_p(vm_block_self(&proc->block))) {
1427 rb_raise(rb_eRactorIsolationError,
1428 "Proc's self is not shareable: %" PRIsVALUE,
1429 self);
1430 }
1431
1432 VALUE read_only_variables = Qfalse;
1433
1434 if (ISEQ_BODY(iseq)->outer_variables) {
1435 read_only_variables =
1436 proc_shared_outer_variables(ISEQ_BODY(iseq)->outer_variables, false, "make a Proc shareable");
1437 }
1438
1439 proc_isolate_env(self, proc, read_only_variables);
1440 proc->is_isolated = TRUE;
1441 }
1442
1443 rb_obj_freeze(self);
1444 return self;
1445}
1446
1447VALUE
1448rb_vm_make_proc_lambda(const rb_execution_context_t *ec, const struct rb_captured_block *captured, VALUE klass, int8_t is_lambda)
1449{
1450 VALUE procval;
1451 enum imemo_type code_type = imemo_type(captured->code.val);
1452
1453 if (!VM_ENV_ESCAPED_P(captured->ep)) {
1454 rb_control_frame_t *cfp = VM_CAPTURED_BLOCK_TO_CFP(captured);
1455 vm_make_env_object(ec, cfp);
1456 }
1457
1458 VM_ASSERT(VM_EP_IN_HEAP_P(ec, captured->ep));
1459 VM_ASSERT(code_type == imemo_iseq || code_type == imemo_ifunc);
1460
1461 procval = vm_proc_create_from_captured(klass, captured,
1462 code_type == imemo_iseq ? block_type_iseq : block_type_ifunc,
1463 FALSE, is_lambda);
1464
1465 if (code_type == imemo_ifunc) {
1466 struct vm_ifunc *ifunc = (struct vm_ifunc *)captured->code.val;
1467 if (ifunc->svar_lep) {
1468 VALUE ep0 = ifunc->svar_lep[0];
1469 if (RB_TYPE_P(ep0, T_IMEMO) && imemo_type_p(ep0, imemo_env)) {
1470 // `ep0 == imemo_env` means this ep is escaped to heap (in env object).
1471 const rb_env_t *env = (const rb_env_t *)ep0;
1472 ifunc->svar_lep = (VALUE *)env->ep;
1473 }
1474 else {
1475 VM_ASSERT(FIXNUM_P(ep0));
1476 if (ep0 & VM_ENV_FLAG_ESCAPED) {
1477 // ok. do nothing
1478 }
1479 else {
1480 ifunc->svar_lep = NULL;
1481 }
1482 }
1483 }
1484 }
1485
1486 return procval;
1487}
1488
1489/* Binding */
1490
1491VALUE
1492rb_vm_make_binding(const rb_execution_context_t *ec, const rb_control_frame_t *src_cfp)
1493{
1494 rb_control_frame_t *cfp = rb_vm_get_binding_creatable_next_cfp(ec, src_cfp);
1495 rb_control_frame_t *ruby_level_cfp = rb_vm_get_ruby_level_next_cfp(ec, src_cfp);
1496 VALUE bindval, envval;
1497 rb_binding_t *bind;
1498
1499 if (cfp == 0 || ruby_level_cfp == 0) {
1500 rb_raise(rb_eRuntimeError, "Can't create Binding Object on top of Fiber.");
1501 }
1502 if (!VM_FRAME_RUBYFRAME_P(src_cfp) &&
1503 !VM_FRAME_RUBYFRAME_P(RUBY_VM_PREVIOUS_CONTROL_FRAME(src_cfp))) {
1504 rb_raise(rb_eRuntimeError, "Cannot create Binding object for non-Ruby caller");
1505 }
1506
1507 envval = vm_make_env_object(ec, cfp);
1508 bindval = rb_binding_alloc(rb_cBinding);
1509 GetBindingPtr(bindval, bind);
1510 vm_bind_update_env(bindval, bind, envval);
1511 RB_OBJ_WRITE(bindval, &bind->block.as.captured.self, cfp->self);
1512 RB_OBJ_WRITE(bindval, &bind->block.as.captured.code.iseq, cfp->iseq);
1513 RB_OBJ_WRITE(bindval, &bind->pathobj, ISEQ_BODY(ruby_level_cfp->iseq)->location.pathobj);
1514 bind->first_lineno = rb_vm_get_sourceline(ruby_level_cfp);
1515
1516 return bindval;
1517}
1518
1519const VALUE *
1520rb_binding_add_dynavars(VALUE bindval, rb_binding_t *bind, int dyncount, const ID *dynvars)
1521{
1522 VALUE envval, pathobj = bind->pathobj;
1523 VALUE path = pathobj_path(pathobj);
1524 VALUE realpath = pathobj_realpath(pathobj);
1525 const struct rb_block *base_block;
1526 const rb_env_t *env;
1527 rb_execution_context_t *ec = GET_EC();
1528 const rb_iseq_t *base_iseq, *iseq;
1529 rb_node_scope_t tmp_node;
1530
1531 if (dyncount < 0) return 0;
1532
1533 base_block = &bind->block;
1534 base_iseq = vm_block_iseq(base_block);
1535
1536 VALUE idtmp = 0;
1537 rb_ast_id_table_t *dyns = ALLOCV(idtmp, sizeof(rb_ast_id_table_t) + dyncount * sizeof(ID));
1538 dyns->size = dyncount;
1539 MEMCPY(dyns->ids, dynvars, ID, dyncount);
1540
1541 rb_node_init(RNODE(&tmp_node), NODE_SCOPE);
1542 tmp_node.nd_tbl = dyns;
1543 tmp_node.nd_body = 0;
1544 tmp_node.nd_args = 0;
1545
1546 VALUE ast_value = rb_ruby_ast_new(RNODE(&tmp_node));
1547
1548 if (base_iseq) {
1549 iseq = rb_iseq_new(ast_value, ISEQ_BODY(base_iseq)->location.label, path, realpath, base_iseq, ISEQ_TYPE_EVAL);
1550 }
1551 else {
1552 VALUE tempstr = rb_fstring_lit("<temp>");
1553 iseq = rb_iseq_new_top(ast_value, tempstr, tempstr, tempstr, NULL);
1554 }
1555 tmp_node.nd_tbl = 0; /* reset table */
1556 ALLOCV_END(idtmp);
1557
1558 vm_set_eval_stack(ec, iseq, 0, base_block);
1559 vm_bind_update_env(bindval, bind, envval = vm_make_env_object(ec, ec->cfp));
1560 rb_vm_pop_frame(ec);
1561
1562 env = (const rb_env_t *)envval;
1563 return env->env;
1564}
1565
1566/* C -> Ruby: block */
1567
1568static inline void
1569invoke_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)
1570{
1571 int arg_size = ISEQ_BODY(iseq)->param.size;
1572
1573 vm_push_frame(ec, iseq, type | VM_FRAME_FLAG_FINISH, self,
1574 VM_GUARDED_PREV_EP(captured->ep),
1575 (VALUE)cref, /* cref or method */
1576 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1577 ec->cfp->sp + arg_size,
1578 ISEQ_BODY(iseq)->local_table_size - arg_size,
1579 ISEQ_BODY(iseq)->stack_max);
1580}
1581
1582static inline void
1583invoke_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)
1584{
1585 /* bmethod call from outside the VM */
1586 int arg_size = ISEQ_BODY(iseq)->param.size;
1587
1588 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
1589
1590 vm_push_frame(ec, iseq, type | VM_FRAME_FLAG_BMETHOD, self,
1591 VM_GUARDED_PREV_EP(captured->ep),
1592 (VALUE)me,
1593 ISEQ_BODY(iseq)->iseq_encoded + opt_pc,
1594 ec->cfp->sp + 1 /* self */ + arg_size,
1595 ISEQ_BODY(iseq)->local_table_size - arg_size,
1596 ISEQ_BODY(iseq)->stack_max);
1597
1598 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_FINISH);
1599}
1600
1601ALWAYS_INLINE(static VALUE
1602 invoke_iseq_block_from_c(rb_execution_context_t *ec, const struct rb_captured_block *captured,
1603 VALUE self, int argc, const VALUE *argv, int kw_splat, VALUE passed_block_handler,
1604 const rb_cref_t *cref, int is_lambda, const rb_callable_method_entry_t *me));
1605
1606static inline VALUE
1607invoke_iseq_block_from_c(rb_execution_context_t *ec, const struct rb_captured_block *captured,
1608 VALUE self, int argc, const VALUE *argv, int kw_splat, VALUE passed_block_handler,
1609 const rb_cref_t *cref, int is_lambda, const rb_callable_method_entry_t *me)
1610{
1611 const rb_iseq_t *iseq = rb_iseq_check(captured->code.iseq);
1612 int opt_pc;
1613 VALUE type = VM_FRAME_MAGIC_BLOCK | (is_lambda ? VM_FRAME_FLAG_LAMBDA : 0);
1614 rb_control_frame_t *cfp = ec->cfp;
1615 VALUE *sp = cfp->sp;
1616 int flags = (kw_splat ? VM_CALL_KW_SPLAT : 0);
1617 VALUE *use_argv = (VALUE *)argv;
1618 VALUE av[2];
1619
1620 stack_check(ec);
1621
1622 if (UNLIKELY(argc > VM_ARGC_STACK_MAX) &&
1623 (VM_ARGC_STACK_MAX >= 1 ||
1624 /* Skip ruby array for potential autosplat case */
1625 (argc != 1 || is_lambda))) {
1626 use_argv = vm_argv_ruby_array(av, argv, &flags, &argc, kw_splat);
1627 }
1628
1629 CHECK_VM_STACK_OVERFLOW(cfp, argc + 1);
1630 vm_check_canary(ec, sp);
1631
1632 VALUE *stack_argv = sp;
1633 if (me) {
1634 *sp = self; // bemthods need `self` on the VM stack
1635 stack_argv++;
1636 }
1637 cfp->sp = stack_argv + argc;
1638 MEMCPY(stack_argv, use_argv, VALUE, argc); // restrict: new stack space
1639
1640 opt_pc = vm_yield_setup_args(ec, iseq, argc, stack_argv, flags, passed_block_handler,
1641 (is_lambda ? arg_setup_method : arg_setup_block));
1642 cfp->sp = sp;
1643
1644 if (me == NULL) {
1645 invoke_block(ec, iseq, self, captured, cref, type, opt_pc);
1646 }
1647 else {
1648 invoke_bmethod(ec, iseq, self, captured, me, type, opt_pc);
1649 }
1650
1651 return vm_exec(ec);
1652}
1653
1654static VALUE
1655invoke_block_from_c_bh(rb_execution_context_t *ec, VALUE block_handler,
1656 int argc, const VALUE *argv,
1657 int kw_splat, VALUE passed_block_handler, const rb_cref_t *cref,
1658 int is_lambda, int force_blockarg)
1659{
1660 again:
1661 switch (vm_block_handler_type(block_handler)) {
1662 case block_handler_type_iseq:
1663 {
1664 const struct rb_captured_block *captured = VM_BH_TO_ISEQ_BLOCK(block_handler);
1665 return invoke_iseq_block_from_c(ec, captured, captured->self,
1666 argc, argv, kw_splat, passed_block_handler,
1667 cref, is_lambda, NULL);
1668 }
1669 case block_handler_type_ifunc:
1670 return vm_yield_with_cfunc(ec, VM_BH_TO_IFUNC_BLOCK(block_handler),
1671 VM_BH_TO_IFUNC_BLOCK(block_handler)->self,
1672 argc, argv, kw_splat, passed_block_handler, NULL);
1673 case block_handler_type_symbol:
1674 return vm_yield_with_symbol(ec, VM_BH_TO_SYMBOL(block_handler),
1675 argc, argv, kw_splat, passed_block_handler);
1676 case block_handler_type_proc:
1677 if (force_blockarg == FALSE) {
1678 is_lambda = block_proc_is_lambda(VM_BH_TO_PROC(block_handler));
1679 }
1680 block_handler = vm_proc_to_block_handler(VM_BH_TO_PROC(block_handler));
1681 goto again;
1682 }
1683 VM_UNREACHABLE(invoke_block_from_c_splattable);
1684 return Qundef;
1685}
1686
1687static inline VALUE
1688check_block_handler(rb_execution_context_t *ec)
1689{
1690 VALUE block_handler = VM_CF_BLOCK_HANDLER(ec->cfp);
1691 vm_block_handler_verify(block_handler);
1692 if (UNLIKELY(block_handler == VM_BLOCK_HANDLER_NONE)) {
1693 rb_vm_localjump_error("no block given", Qnil, 0);
1694 }
1695
1696 return block_handler;
1697}
1698
1699static VALUE
1700vm_yield_with_cref(rb_execution_context_t *ec, int argc, const VALUE *argv, int kw_splat, const rb_cref_t *cref, int is_lambda)
1701{
1702 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1703 argc, argv, kw_splat, VM_BLOCK_HANDLER_NONE,
1704 cref, is_lambda, FALSE);
1705}
1706
1707static VALUE
1708vm_yield(rb_execution_context_t *ec, int argc, const VALUE *argv, int kw_splat)
1709{
1710 return vm_yield_with_cref(ec, argc, argv, kw_splat, NULL, FALSE);
1711}
1712
1713static VALUE
1714vm_yield_with_block(rb_execution_context_t *ec, int argc, const VALUE *argv, VALUE block_handler, int kw_splat)
1715{
1716 return invoke_block_from_c_bh(ec, check_block_handler(ec),
1717 argc, argv, kw_splat, block_handler,
1718 NULL, FALSE, FALSE);
1719}
1720
1721static VALUE
1722vm_yield_force_blockarg(rb_execution_context_t *ec, VALUE args)
1723{
1724 return invoke_block_from_c_bh(ec, check_block_handler(ec), 1, &args,
1725 RB_NO_KEYWORDS, VM_BLOCK_HANDLER_NONE, NULL, FALSE, TRUE);
1726}
1727
1728ALWAYS_INLINE(static VALUE
1729 invoke_block_from_c_proc(rb_execution_context_t *ec, const rb_proc_t *proc,
1730 VALUE self, int argc, const VALUE *argv,
1731 int kw_splat, VALUE passed_block_handler, int is_lambda,
1732 const rb_callable_method_entry_t *me));
1733
1734static inline VALUE
1735invoke_block_from_c_proc(rb_execution_context_t *ec, const rb_proc_t *proc,
1736 VALUE self, int argc, const VALUE *argv,
1737 int kw_splat, VALUE passed_block_handler, int is_lambda,
1739{
1740 const struct rb_block *block = &proc->block;
1741
1742 again:
1743 switch (vm_block_type(block)) {
1744 case block_type_iseq:
1745 return invoke_iseq_block_from_c(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, NULL, is_lambda, me);
1746 case block_type_ifunc:
1747 if (kw_splat == 1) {
1748 VALUE keyword_hash = argv[argc-1];
1749 if (!RB_TYPE_P(keyword_hash, T_HASH)) {
1750 keyword_hash = rb_to_hash_type(keyword_hash);
1751 }
1752 if (RHASH_EMPTY_P(keyword_hash)) {
1753 argc--;
1754 }
1755 else {
1756 ((VALUE *)argv)[argc-1] = rb_hash_dup(keyword_hash);
1757 }
1758 }
1759 return vm_yield_with_cfunc(ec, &block->as.captured, self, argc, argv, kw_splat, passed_block_handler, me);
1760 case block_type_symbol:
1761 return vm_yield_with_symbol(ec, block->as.symbol, argc, argv, kw_splat, passed_block_handler);
1762 case block_type_proc:
1763 is_lambda = block_proc_is_lambda(block->as.proc);
1764 block = vm_proc_block(block->as.proc);
1765 goto again;
1766 }
1767 VM_UNREACHABLE(invoke_block_from_c_proc);
1768 return Qundef;
1769}
1770
1771static VALUE
1772vm_invoke_proc(rb_execution_context_t *ec, rb_proc_t *proc, VALUE self,
1773 int argc, const VALUE *argv, int kw_splat, VALUE passed_block_handler)
1774{
1775 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler, proc->is_lambda, NULL);
1776}
1777
1778static VALUE
1779vm_invoke_bmethod(rb_execution_context_t *ec, rb_proc_t *proc, VALUE self,
1780 int argc, const VALUE *argv, int kw_splat, VALUE block_handler, const rb_callable_method_entry_t *me)
1781{
1782 return invoke_block_from_c_proc(ec, proc, self, argc, argv, kw_splat, block_handler, TRUE, me);
1783}
1784
1785VALUE
1786rb_vm_invoke_proc(rb_execution_context_t *ec, rb_proc_t *proc,
1787 int argc, const VALUE *argv, int kw_splat, VALUE passed_block_handler)
1788{
1789 VALUE self = vm_block_self(&proc->block);
1790 vm_block_handler_verify(passed_block_handler);
1791
1792 if (proc->is_from_method) {
1793 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
1794 }
1795 else {
1796 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler);
1797 }
1798}
1799
1800VALUE
1801rb_vm_invoke_proc_with_self(rb_execution_context_t *ec, rb_proc_t *proc, VALUE self,
1802 int argc, const VALUE *argv, int kw_splat, VALUE passed_block_handler)
1803{
1804 vm_block_handler_verify(passed_block_handler);
1805
1806 if (proc->is_from_method) {
1807 return vm_invoke_bmethod(ec, proc, self, argc, argv, kw_splat, passed_block_handler, NULL);
1808 }
1809 else {
1810 return vm_invoke_proc(ec, proc, self, argc, argv, kw_splat, passed_block_handler);
1811 }
1812}
1813
1814/* special variable */
1815
1816VALUE *
1817rb_vm_svar_lep(const rb_execution_context_t *ec, const rb_control_frame_t *cfp)
1818{
1819 while (cfp->pc == 0 || cfp->iseq == 0) {
1820 if (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_IFUNC) {
1821 struct vm_ifunc *ifunc = (struct vm_ifunc *)cfp->iseq;
1822 return ifunc->svar_lep;
1823 }
1824 else {
1825 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1826 }
1827
1828 if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec, cfp)) {
1829 return NULL;
1830 }
1831 }
1832
1833 return (VALUE *)VM_CF_LEP(cfp);
1834}
1835
1836static VALUE
1837vm_cfp_svar_get(const rb_execution_context_t *ec, rb_control_frame_t *cfp, VALUE key)
1838{
1839 return lep_svar_get(ec, rb_vm_svar_lep(ec, cfp), key);
1840}
1841
1842static void
1843vm_cfp_svar_set(const rb_execution_context_t *ec, rb_control_frame_t *cfp, VALUE key, const VALUE val)
1844{
1845 lep_svar_set(ec, rb_vm_svar_lep(ec, cfp), key, val);
1846}
1847
1848static VALUE
1849vm_svar_get(const rb_execution_context_t *ec, VALUE key)
1850{
1851 return vm_cfp_svar_get(ec, ec->cfp, key);
1852}
1853
1854static void
1855vm_svar_set(const rb_execution_context_t *ec, VALUE key, VALUE val)
1856{
1857 vm_cfp_svar_set(ec, ec->cfp, key, val);
1858}
1859
1860VALUE
1862{
1863 return vm_svar_get(GET_EC(), VM_SVAR_BACKREF);
1864}
1865
1866void
1868{
1869 vm_svar_set(GET_EC(), VM_SVAR_BACKREF, val);
1870}
1871
1872VALUE
1874{
1875 return vm_svar_get(GET_EC(), VM_SVAR_LASTLINE);
1876}
1877
1878void
1880{
1881 vm_svar_set(GET_EC(), VM_SVAR_LASTLINE, val);
1882}
1883
1884void
1885rb_lastline_set_up(VALUE val, unsigned int up)
1886{
1887 rb_control_frame_t * cfp = GET_EC()->cfp;
1888
1889 for(unsigned int i = 0; i < up; i++) {
1890 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
1891 }
1892 vm_cfp_svar_set(GET_EC(), cfp, VM_SVAR_LASTLINE, val);
1893}
1894
1895/* misc */
1896
1897const char *
1899{
1900 const rb_execution_context_t *ec = GET_EC();
1901 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1902
1903 if (cfp) {
1904 return RSTRING_PTR(rb_iseq_path(cfp->iseq));
1905 }
1906 else {
1907 return 0;
1908 }
1909}
1910
1911int
1913{
1914 const rb_execution_context_t *ec = GET_EC();
1915 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1916
1917 if (cfp) {
1918 return rb_vm_get_sourceline(cfp);
1919 }
1920 else {
1921 return 0;
1922 }
1923}
1924
1925VALUE
1926rb_source_location(int *pline)
1927{
1928 const rb_execution_context_t *ec = GET_EC();
1929 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1930
1931 if (cfp && VM_FRAME_RUBYFRAME_P(cfp)) {
1932 if (pline) *pline = rb_vm_get_sourceline(cfp);
1933 return rb_iseq_path(cfp->iseq);
1934 }
1935 else {
1936 if (pline) *pline = 0;
1937 return Qnil;
1938 }
1939}
1940
1941const char *
1942rb_source_location_cstr(int *pline)
1943{
1944 VALUE path = rb_source_location(pline);
1945 if (NIL_P(path)) return NULL;
1946 return RSTRING_PTR(path);
1947}
1948
1949rb_cref_t *
1950rb_vm_cref(void)
1951{
1952 const rb_execution_context_t *ec = GET_EC();
1953 return vm_ec_cref(ec);
1954}
1955
1956rb_cref_t *
1957rb_vm_cref_replace_with_duplicated_cref(void)
1958{
1959 const rb_execution_context_t *ec = GET_EC();
1960 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1961 rb_cref_t *cref = vm_cref_replace_with_duplicated_cref(cfp->ep);
1962 ASSUME(cref);
1963 return cref;
1964}
1965
1966const rb_cref_t *
1967rb_vm_cref_in_context(VALUE self, VALUE cbase)
1968{
1969 const rb_execution_context_t *ec = GET_EC();
1970 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1971 const rb_cref_t *cref;
1972 if (!cfp || cfp->self != self) return NULL;
1973 if (!vm_env_cref_by_cref(cfp->ep)) return NULL;
1974 cref = vm_get_cref(cfp->ep);
1975 if (CREF_CLASS(cref) != cbase) return NULL;
1976 return cref;
1977}
1978
1979#if 0
1980void
1981debug_cref(rb_cref_t *cref)
1982{
1983 while (cref) {
1984 dp(CREF_CLASS(cref));
1985 printf("%ld\n", CREF_VISI(cref));
1986 cref = CREF_NEXT(cref);
1987 }
1988}
1989#endif
1990
1991VALUE
1992rb_vm_cbase(void)
1993{
1994 const rb_execution_context_t *ec = GET_EC();
1995 const rb_control_frame_t *cfp = rb_vm_get_ruby_level_next_cfp(ec, ec->cfp);
1996
1997 if (cfp == 0) {
1998 rb_raise(rb_eRuntimeError, "Can't call on top of Fiber or Thread");
1999 }
2000 return vm_get_cbase(cfp->ep);
2001}
2002
2003/* jump */
2004
2005static VALUE
2006make_localjump_error(const char *mesg, VALUE value, int reason)
2007{
2010 ID id;
2011
2012 switch (reason) {
2013 case TAG_BREAK:
2014 CONST_ID(id, "break");
2015 break;
2016 case TAG_REDO:
2017 CONST_ID(id, "redo");
2018 break;
2019 case TAG_RETRY:
2020 CONST_ID(id, "retry");
2021 break;
2022 case TAG_NEXT:
2023 CONST_ID(id, "next");
2024 break;
2025 case TAG_RETURN:
2026 CONST_ID(id, "return");
2027 break;
2028 default:
2029 CONST_ID(id, "noreason");
2030 break;
2031 }
2032 rb_iv_set(exc, "@exit_value", value);
2033 rb_iv_set(exc, "@reason", ID2SYM(id));
2034 return exc;
2035}
2036
2037void
2038rb_vm_localjump_error(const char *mesg, VALUE value, int reason)
2039{
2040 VALUE exc = make_localjump_error(mesg, value, reason);
2041 rb_exc_raise(exc);
2042}
2043
2044VALUE
2045rb_vm_make_jump_tag_but_local_jump(enum ruby_tag_type state, VALUE val)
2046{
2047 const char *mesg;
2048
2049 switch (state) {
2050 case TAG_RETURN:
2051 mesg = "unexpected return";
2052 break;
2053 case TAG_BREAK:
2054 mesg = "unexpected break";
2055 break;
2056 case TAG_NEXT:
2057 mesg = "unexpected next";
2058 break;
2059 case TAG_REDO:
2060 mesg = "unexpected redo";
2061 val = Qnil;
2062 break;
2063 case TAG_RETRY:
2064 mesg = "retry outside of rescue clause";
2065 val = Qnil;
2066 break;
2067 default:
2068 return Qnil;
2069 }
2070 if (UNDEF_P(val)) {
2071 val = GET_EC()->tag->retval;
2072 }
2073 return make_localjump_error(mesg, val, state);
2074}
2075
2076void
2077rb_vm_jump_tag_but_local_jump(enum ruby_tag_type state)
2078{
2079 VALUE exc = rb_vm_make_jump_tag_but_local_jump(state, Qundef);
2080 if (!NIL_P(exc)) rb_exc_raise(exc);
2081 EC_JUMP_TAG(GET_EC(), state);
2082}
2083
2084static rb_control_frame_t *
2085next_not_local_frame(rb_control_frame_t *cfp)
2086{
2087 while (VM_ENV_LOCAL_P(cfp->ep)) {
2088 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
2089 }
2090 return cfp;
2091}
2092
2093NORETURN(static void vm_iter_break(rb_execution_context_t *ec, VALUE val));
2094
2095static void
2096vm_iter_break(rb_execution_context_t *ec, VALUE val)
2097{
2098 rb_control_frame_t *cfp = next_not_local_frame(ec->cfp);
2099 const VALUE *ep = VM_CF_PREV_EP(cfp);
2100 const rb_control_frame_t *target_cfp = rb_vm_search_cf_from_ep(ec, cfp, ep);
2101
2102 if (!target_cfp) {
2103 rb_vm_localjump_error("unexpected break", val, TAG_BREAK);
2104 }
2105
2106 ec->errinfo = (VALUE)THROW_DATA_NEW(val, target_cfp, TAG_BREAK);
2107 EC_JUMP_TAG(ec, TAG_BREAK);
2108}
2109
2110void
2112{
2113 vm_iter_break(GET_EC(), Qnil);
2114}
2115
2116void
2118{
2119 vm_iter_break(GET_EC(), val);
2120}
2121
2122/* optimization: redefine management */
2123
2124short ruby_vm_redefined_flag[BOP_LAST_];
2125static st_table *vm_opt_method_def_table = 0;
2126static st_table *vm_opt_mid_table = 0;
2127
2128void
2129rb_free_vm_opt_tables(void)
2130{
2131 st_free_table(vm_opt_method_def_table);
2132 st_free_table(vm_opt_mid_table);
2133}
2134
2135static int
2136vm_redefinition_check_flag(VALUE klass)
2137{
2138 if (klass == rb_cInteger) return INTEGER_REDEFINED_OP_FLAG;
2139 if (klass == rb_cFloat) return FLOAT_REDEFINED_OP_FLAG;
2140 if (klass == rb_cString) return STRING_REDEFINED_OP_FLAG;
2141 if (klass == rb_cArray) return ARRAY_REDEFINED_OP_FLAG;
2142 if (klass == rb_cHash) return HASH_REDEFINED_OP_FLAG;
2143 if (klass == rb_cSymbol) return SYMBOL_REDEFINED_OP_FLAG;
2144#if 0
2145 if (klass == rb_cTime) return TIME_REDEFINED_OP_FLAG;
2146#endif
2147 if (klass == rb_cRegexp) return REGEXP_REDEFINED_OP_FLAG;
2148 if (klass == rb_cNilClass) return NIL_REDEFINED_OP_FLAG;
2149 if (klass == rb_cTrueClass) return TRUE_REDEFINED_OP_FLAG;
2150 if (klass == rb_cFalseClass) return FALSE_REDEFINED_OP_FLAG;
2151 if (klass == rb_cProc) return PROC_REDEFINED_OP_FLAG;
2152 return 0;
2153}
2154
2155int
2156rb_vm_check_optimizable_mid(VALUE mid)
2157{
2158 if (!vm_opt_mid_table) {
2159 return FALSE;
2160 }
2161
2162 return st_lookup(vm_opt_mid_table, mid, NULL);
2163}
2164
2165static int
2166vm_redefinition_check_method_type(const rb_method_entry_t *me)
2167{
2168 if (me->called_id != me->def->original_id) {
2169 return FALSE;
2170 }
2171
2172 if (METHOD_ENTRY_BASIC(me)) return TRUE;
2173
2174 const rb_method_definition_t *def = me->def;
2175 switch (def->type) {
2176 case VM_METHOD_TYPE_CFUNC:
2177 case VM_METHOD_TYPE_OPTIMIZED:
2178 return TRUE;
2179 default:
2180 return FALSE;
2181 }
2182}
2183
2184static void
2185rb_vm_check_redefinition_opt_method(const rb_method_entry_t *me, VALUE klass)
2186{
2187 st_data_t bop;
2188 if (RB_TYPE_P(klass, T_ICLASS) && RICLASS_IS_ORIGIN_P(klass) &&
2189 RB_TYPE_P(RBASIC_CLASS(klass), T_CLASS)) {
2190 klass = RBASIC_CLASS(klass);
2191 }
2192 if (vm_redefinition_check_method_type(me)) {
2193 if (st_lookup(vm_opt_method_def_table, (st_data_t)me->def, &bop)) {
2194 int flag = vm_redefinition_check_flag(klass);
2195 if (flag != 0) {
2198 "Redefining '%s#%s' disables interpreter and JIT optimizations",
2199 rb_class2name(me->owner),
2200 rb_id2name(me->called_id)
2201 );
2202 rb_yjit_bop_redefined(flag, (enum ruby_basic_operators)bop);
2203 rb_zjit_bop_redefined(flag, (enum ruby_basic_operators)bop);
2204 ruby_vm_redefined_flag[bop] |= flag;
2205 }
2206 }
2207 }
2208}
2209
2210static enum rb_id_table_iterator_result
2211check_redefined_method(ID mid, VALUE value, void *data)
2212{
2213 VALUE klass = (VALUE)data;
2214 const rb_method_entry_t *me = (rb_method_entry_t *)value;
2215 const rb_method_entry_t *newme = rb_method_entry(klass, mid);
2216
2217 if (newme != me) rb_vm_check_redefinition_opt_method(me, me->owner);
2218
2219 return ID_TABLE_CONTINUE;
2220}
2221
2222void
2223rb_vm_check_redefinition_by_prepend(VALUE klass)
2224{
2225 if (!vm_redefinition_check_flag(klass)) return;
2226 rb_id_table_foreach(RCLASS_M_TBL(RCLASS_ORIGIN(klass)), check_redefined_method, (void *)klass);
2227}
2228
2229static void
2230add_opt_method_entry_bop(const rb_method_entry_t *me, ID mid, enum ruby_basic_operators bop)
2231{
2232 st_insert(vm_opt_method_def_table, (st_data_t)me->def, (st_data_t)bop);
2233 st_insert(vm_opt_mid_table, (st_data_t)mid, (st_data_t)Qtrue);
2234}
2235
2236static void
2237add_opt_method(VALUE klass, ID mid, enum ruby_basic_operators bop)
2238{
2239 const rb_method_entry_t *me = rb_method_entry_at(klass, mid);
2240
2241 if (me && vm_redefinition_check_method_type(me)) {
2242 add_opt_method_entry_bop(me, mid, bop);
2243 }
2244 else {
2245 rb_bug("undefined optimized method: %s", rb_id2name(mid));
2246 }
2247}
2248
2249static enum ruby_basic_operators vm_redefinition_bop_for_id(ID mid);
2250
2251static void
2252add_opt_method_entry(const rb_method_entry_t *me)
2253{
2254 if (me && vm_redefinition_check_method_type(me)) {
2255 ID mid = me->called_id;
2256 enum ruby_basic_operators bop = vm_redefinition_bop_for_id(mid);
2257 if ((int)bop >= 0) {
2258 add_opt_method_entry_bop(me, mid, bop);
2259 }
2260 }
2261}
2262
2263static void
2264vm_init_redefined_flag(void)
2265{
2266 ID mid;
2267 enum ruby_basic_operators bop;
2268
2269#define OP(mid_, bop_) (mid = id##mid_, bop = BOP_##bop_, ruby_vm_redefined_flag[bop] = 0)
2270#define C(k) add_opt_method(rb_c##k, mid, bop)
2271 OP(PLUS, PLUS), (C(Integer), C(Float), C(String), C(Array));
2272 OP(MINUS, MINUS), (C(Integer), C(Float));
2273 OP(MULT, MULT), (C(Integer), C(Float));
2274 OP(DIV, DIV), (C(Integer), C(Float));
2275 OP(MOD, MOD), (C(Integer), C(Float));
2276 OP(Eq, EQ), (C(Integer), C(Float), C(String), C(Symbol));
2277 OP(Eqq, EQQ), (C(Integer), C(Float), C(Symbol), C(String),
2278 C(NilClass), C(TrueClass), C(FalseClass));
2279 OP(LT, LT), (C(Integer), C(Float));
2280 OP(LE, LE), (C(Integer), C(Float));
2281 OP(GT, GT), (C(Integer), C(Float));
2282 OP(GE, GE), (C(Integer), C(Float));
2283 OP(LTLT, LTLT), (C(String), C(Array));
2284 OP(AREF, AREF), (C(Array), C(Hash), C(Integer));
2285 OP(ASET, ASET), (C(Array), C(Hash));
2286 OP(Length, LENGTH), (C(Array), C(String), C(Hash));
2287 OP(Size, SIZE), (C(Array), C(String), C(Hash));
2288 OP(EmptyP, EMPTY_P), (C(Array), C(String), C(Hash));
2289 OP(Succ, SUCC), (C(Integer), C(String));
2290 OP(EqTilde, MATCH), (C(Regexp), C(String));
2291 OP(Freeze, FREEZE), (C(String), C(Array), C(Hash));
2292 OP(UMinus, UMINUS), (C(String));
2293 OP(Max, MAX), (C(Array));
2294 OP(Min, MIN), (C(Array));
2295 OP(Hash, HASH), (C(Array));
2296 OP(Call, CALL), (C(Proc));
2297 OP(And, AND), (C(Integer));
2298 OP(Or, OR), (C(Integer));
2299 OP(NilP, NIL_P), (C(NilClass));
2300 OP(Cmp, CMP), (C(Integer), C(Float), C(String));
2301 OP(Default, DEFAULT), (C(Hash));
2302 OP(IncludeP, INCLUDE_P), (C(Array));
2303#undef C
2304#undef OP
2305}
2306
2307static enum ruby_basic_operators
2308vm_redefinition_bop_for_id(ID mid)
2309{
2310 switch (mid) {
2311#define OP(mid_, bop_) case id##mid_: return BOP_##bop_
2312 OP(PLUS, PLUS);
2313 OP(MINUS, MINUS);
2314 OP(MULT, MULT);
2315 OP(DIV, DIV);
2316 OP(MOD, MOD);
2317 OP(Eq, EQ);
2318 OP(Eqq, EQQ);
2319 OP(LT, LT);
2320 OP(LE, LE);
2321 OP(GT, GT);
2322 OP(GE, GE);
2323 OP(LTLT, LTLT);
2324 OP(AREF, AREF);
2325 OP(ASET, ASET);
2326 OP(Length, LENGTH);
2327 OP(Size, SIZE);
2328 OP(EmptyP, EMPTY_P);
2329 OP(Succ, SUCC);
2330 OP(EqTilde, MATCH);
2331 OP(Freeze, FREEZE);
2332 OP(UMinus, UMINUS);
2333 OP(Max, MAX);
2334 OP(Min, MIN);
2335 OP(Hash, HASH);
2336 OP(Call, CALL);
2337 OP(And, AND);
2338 OP(Or, OR);
2339 OP(NilP, NIL_P);
2340 OP(Cmp, CMP);
2341 OP(Default, DEFAULT);
2342 OP(Pack, PACK);
2343#undef OP
2344 }
2345 return -1;
2346}
2347
2348/* for vm development */
2349
2350#if VMDEBUG
2351static const char *
2352vm_frametype_name(const rb_control_frame_t *cfp)
2353{
2354 switch (VM_FRAME_TYPE(cfp)) {
2355 case VM_FRAME_MAGIC_METHOD: return "method";
2356 case VM_FRAME_MAGIC_BLOCK: return "block";
2357 case VM_FRAME_MAGIC_CLASS: return "class";
2358 case VM_FRAME_MAGIC_TOP: return "top";
2359 case VM_FRAME_MAGIC_CFUNC: return "cfunc";
2360 case VM_FRAME_MAGIC_IFUNC: return "ifunc";
2361 case VM_FRAME_MAGIC_EVAL: return "eval";
2362 case VM_FRAME_MAGIC_RESCUE: return "rescue";
2363 default:
2364 rb_bug("unknown frame");
2365 }
2366}
2367#endif
2368
2369static VALUE
2370frame_return_value(const struct vm_throw_data *err)
2371{
2372 if (THROW_DATA_P(err) &&
2373 THROW_DATA_STATE(err) == TAG_BREAK &&
2374 THROW_DATA_CONSUMED_P(err) == FALSE) {
2375 return THROW_DATA_VAL(err);
2376 }
2377 else {
2378 return Qnil;
2379 }
2380}
2381
2382#if 0
2383/* for debug */
2384static const char *
2385frame_name(const rb_control_frame_t *cfp)
2386{
2387 unsigned long type = VM_FRAME_TYPE(cfp);
2388#define C(t) if (type == VM_FRAME_MAGIC_##t) return #t
2389 C(METHOD);
2390 C(BLOCK);
2391 C(CLASS);
2392 C(TOP);
2393 C(CFUNC);
2394 C(PROC);
2395 C(IFUNC);
2396 C(EVAL);
2397 C(LAMBDA);
2398 C(RESCUE);
2399 C(DUMMY);
2400#undef C
2401 return "unknown";
2402}
2403#endif
2404
2405// cfp_returning_with_value:
2406// Whether cfp is the last frame in the unwinding process for a non-local return.
2407static void
2408hook_before_rewind(rb_execution_context_t *ec, bool cfp_returning_with_value, int state, struct vm_throw_data *err)
2409{
2410 if (state == TAG_RAISE && RBASIC(err)->klass == rb_eSysStackError) {
2411 return;
2412 }
2413 else {
2414 const rb_iseq_t *iseq = ec->cfp->iseq;
2415 rb_hook_list_t *local_hooks = iseq->aux.exec.local_hooks;
2416
2417 switch (VM_FRAME_TYPE(ec->cfp)) {
2418 case VM_FRAME_MAGIC_METHOD:
2419 RUBY_DTRACE_METHOD_RETURN_HOOK(ec, 0, 0);
2420 EXEC_EVENT_HOOK_AND_POP_FRAME(ec, RUBY_EVENT_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2421
2422 if (UNLIKELY(local_hooks && local_hooks->events & RUBY_EVENT_RETURN)) {
2423 rb_exec_event_hook_orig(ec, local_hooks, RUBY_EVENT_RETURN,
2424 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2425 }
2426
2427 THROW_DATA_CONSUMED_SET(err);
2428 break;
2429 case VM_FRAME_MAGIC_BLOCK:
2430 if (VM_FRAME_BMETHOD_P(ec->cfp)) {
2431 VALUE bmethod_return_value = frame_return_value(err);
2432 if (cfp_returning_with_value) {
2433 // Non-local return terminating at a BMETHOD control frame.
2434 bmethod_return_value = THROW_DATA_VAL(err);
2435 }
2436
2437
2438 EXEC_EVENT_HOOK_AND_POP_FRAME(ec, RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, bmethod_return_value);
2439 if (UNLIKELY(local_hooks && local_hooks->events & RUBY_EVENT_B_RETURN)) {
2440 rb_exec_event_hook_orig(ec, local_hooks, RUBY_EVENT_B_RETURN,
2441 ec->cfp->self, 0, 0, 0, bmethod_return_value, TRUE);
2442 }
2443
2444 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(ec->cfp);
2445
2446 EXEC_EVENT_HOOK_AND_POP_FRAME(ec, RUBY_EVENT_RETURN, ec->cfp->self,
2447 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2448 rb_vm_frame_method_entry(ec->cfp)->called_id,
2449 rb_vm_frame_method_entry(ec->cfp)->owner,
2450 bmethod_return_value);
2451
2452 VM_ASSERT(me->def->type == VM_METHOD_TYPE_BMETHOD);
2453 local_hooks = me->def->body.bmethod.hooks;
2454
2455 if (UNLIKELY(local_hooks && local_hooks->events & RUBY_EVENT_RETURN)) {
2456 rb_exec_event_hook_orig(ec, local_hooks, RUBY_EVENT_RETURN, ec->cfp->self,
2457 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2458 rb_vm_frame_method_entry(ec->cfp)->called_id,
2459 rb_vm_frame_method_entry(ec->cfp)->owner,
2460 bmethod_return_value, TRUE);
2461 }
2462 THROW_DATA_CONSUMED_SET(err);
2463 }
2464 else {
2465 EXEC_EVENT_HOOK_AND_POP_FRAME(ec, RUBY_EVENT_B_RETURN, ec->cfp->self, 0, 0, 0, frame_return_value(err));
2466 if (UNLIKELY(local_hooks && local_hooks->events & RUBY_EVENT_B_RETURN)) {
2467 rb_exec_event_hook_orig(ec, local_hooks, RUBY_EVENT_B_RETURN,
2468 ec->cfp->self, 0, 0, 0, frame_return_value(err), TRUE);
2469 }
2470 THROW_DATA_CONSUMED_SET(err);
2471 }
2472 break;
2473 case VM_FRAME_MAGIC_CLASS:
2474 EXEC_EVENT_HOOK_AND_POP_FRAME(ec, RUBY_EVENT_END, ec->cfp->self, 0, 0, 0, Qnil);
2475 break;
2476 }
2477 }
2478}
2479
2480/* evaluator body */
2481
2482/* finish
2483 VMe (h1) finish
2484 VM finish F1 F2
2485 cfunc finish F1 F2 C1
2486 rb_funcall finish F1 F2 C1
2487 VMe finish F1 F2 C1
2488 VM finish F1 F2 C1 F3
2489
2490 F1 - F3 : pushed by VM
2491 C1 : pushed by send insn (CFUNC)
2492
2493 struct CONTROL_FRAME {
2494 VALUE *pc; // cfp[0], program counter
2495 VALUE *sp; // cfp[1], stack pointer
2496 rb_iseq_t *iseq; // cfp[2], iseq
2497 VALUE self; // cfp[3], self
2498 const VALUE *ep; // cfp[4], env pointer
2499 const void *block_code; // cfp[5], block code
2500 };
2501
2502 struct rb_captured_block {
2503 VALUE self;
2504 VALUE *ep;
2505 union code;
2506 };
2507
2508 struct METHOD_ENV {
2509 VALUE param0;
2510 ...
2511 VALUE paramN;
2512 VALUE lvar1;
2513 ...
2514 VALUE lvarM;
2515 VALUE cref; // ep[-2]
2516 VALUE special; // ep[-1]
2517 VALUE flags; // ep[ 0] == lep[0]
2518 };
2519
2520 struct BLOCK_ENV {
2521 VALUE block_param0;
2522 ...
2523 VALUE block_paramN;
2524 VALUE block_lvar1;
2525 ...
2526 VALUE block_lvarM;
2527 VALUE cref; // ep[-2]
2528 VALUE special; // ep[-1]
2529 VALUE flags; // ep[ 0]
2530 };
2531
2532 struct CLASS_ENV {
2533 VALUE class_lvar0;
2534 ...
2535 VALUE class_lvarN;
2536 VALUE cref;
2537 VALUE prev_ep; // for frame jump
2538 VALUE flags;
2539 };
2540
2541 struct C_METHOD_CONTROL_FRAME {
2542 VALUE *pc; // 0
2543 VALUE *sp; // stack pointer
2544 rb_iseq_t *iseq; // cmi
2545 VALUE self; // ?
2546 VALUE *ep; // ep == lep
2547 void *code; //
2548 };
2549
2550 struct C_BLOCK_CONTROL_FRAME {
2551 VALUE *pc; // point only "finish" insn
2552 VALUE *sp; // sp
2553 rb_iseq_t *iseq; // ?
2554 VALUE self; //
2555 VALUE *ep; // ep
2556 void *code; //
2557 };
2558 */
2559
2560static inline VALUE
2561vm_exec_handle_exception(rb_execution_context_t *ec, enum ruby_tag_type state, VALUE errinfo);
2562static inline VALUE
2563vm_exec_loop(rb_execution_context_t *ec, enum ruby_tag_type state, struct rb_vm_tag *tag, VALUE result);
2564
2565// for non-Emscripten Wasm build, use vm_exec with optimized setjmp for runtime performance
2566#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2567
2568struct rb_vm_exec_context {
2569 rb_execution_context_t *const ec;
2570 struct rb_vm_tag *const tag;
2571
2572 VALUE result;
2573};
2574
2575static void
2576vm_exec_bottom_main(void *context)
2577{
2578 struct rb_vm_exec_context *ctx = context;
2579 rb_execution_context_t *ec = ctx->ec;
2580
2581 ctx->result = vm_exec_loop(ec, TAG_NONE, ctx->tag, vm_exec_core(ec));
2582}
2583
2584static void
2585vm_exec_bottom_rescue(void *context)
2586{
2587 struct rb_vm_exec_context *ctx = context;
2588 rb_execution_context_t *ec = ctx->ec;
2589
2590 ctx->result = vm_exec_loop(ec, rb_ec_tag_state(ec), ctx->tag, ec->errinfo);
2591}
2592#endif
2593
2594VALUE
2595vm_exec(rb_execution_context_t *ec)
2596{
2597 VALUE result = Qundef;
2598
2599 EC_PUSH_TAG(ec);
2600
2601 _tag.retval = Qnil;
2602
2603#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2604 struct rb_vm_exec_context ctx = {
2605 .ec = ec,
2606 .tag = &_tag,
2607 };
2608 struct rb_wasm_try_catch try_catch;
2609
2610 EC_REPUSH_TAG();
2611
2612 rb_wasm_try_catch_init(&try_catch, vm_exec_bottom_main, vm_exec_bottom_rescue, &ctx);
2613
2614 rb_wasm_try_catch_loop_run(&try_catch, &RB_VM_TAG_JMPBUF_GET(_tag.buf));
2615
2616 result = ctx.result;
2617#else
2618 enum ruby_tag_type state;
2619 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
2620 if (UNDEF_P(result = jit_exec(ec))) {
2621 result = vm_exec_core(ec);
2622 }
2623 /* fallback to the VM */
2624 result = vm_exec_loop(ec, TAG_NONE, &_tag, result);
2625 }
2626 else {
2627 result = vm_exec_loop(ec, state, &_tag, ec->errinfo);
2628 }
2629#endif
2630
2631 EC_POP_TAG();
2632 return result;
2633}
2634
2635static inline VALUE
2636vm_exec_loop(rb_execution_context_t *ec, enum ruby_tag_type state,
2637 struct rb_vm_tag *tag, VALUE result)
2638{
2639 if (state == TAG_NONE) { /* no jumps, result is discarded */
2640 goto vm_loop_start;
2641 }
2642
2643 rb_ec_raised_reset(ec, RAISED_STACKOVERFLOW | RAISED_NOMEMORY);
2644 while (UNDEF_P(result = vm_exec_handle_exception(ec, state, result))) {
2645 // caught a jump, exec the handler. JIT code in jit_exec_exception()
2646 // may return Qundef to run remaining frames with vm_exec_core().
2647 if (UNDEF_P(result = jit_exec_exception(ec))) {
2648 result = vm_exec_core(ec);
2649 }
2650 vm_loop_start:
2651 VM_ASSERT(ec->tag == tag);
2652 /* when caught `throw`, `tag.state` is set. */
2653 if ((state = tag->state) == TAG_NONE) break;
2654 tag->state = TAG_NONE;
2655 }
2656
2657 return result;
2658}
2659
2660static inline VALUE
2661vm_exec_handle_exception(rb_execution_context_t *ec, enum ruby_tag_type state, VALUE errinfo)
2662{
2663 struct vm_throw_data *err = (struct vm_throw_data *)errinfo;
2664
2665 for (;;) {
2666 unsigned int i;
2667 const struct iseq_catch_table_entry *entry;
2668 const struct iseq_catch_table *ct;
2669 unsigned long epc, cont_pc, cont_sp;
2670 const rb_iseq_t *catch_iseq;
2671 VALUE type;
2672 const rb_control_frame_t *escape_cfp;
2673
2674 cont_pc = cont_sp = 0;
2675 catch_iseq = NULL;
2676
2677 while (ec->cfp->pc == 0 || ec->cfp->iseq == 0) {
2678 if (UNLIKELY(VM_FRAME_TYPE(ec->cfp) == VM_FRAME_MAGIC_CFUNC)) {
2679 EXEC_EVENT_HOOK_AND_POP_FRAME(ec, RUBY_EVENT_C_RETURN, ec->cfp->self,
2680 rb_vm_frame_method_entry(ec->cfp)->def->original_id,
2681 rb_vm_frame_method_entry(ec->cfp)->called_id,
2682 rb_vm_frame_method_entry(ec->cfp)->owner, Qnil);
2683 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec,
2684 rb_vm_frame_method_entry(ec->cfp)->owner,
2685 rb_vm_frame_method_entry(ec->cfp)->def->original_id);
2686 }
2687 rb_vm_pop_frame(ec);
2688 }
2689
2690 rb_control_frame_t *const cfp = ec->cfp;
2691 epc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded;
2692
2693 escape_cfp = NULL;
2694 if (state == TAG_BREAK || state == TAG_RETURN) {
2695 escape_cfp = THROW_DATA_CATCH_FRAME(err);
2696
2697 if (cfp == escape_cfp) {
2698 if (state == TAG_RETURN) {
2699 if (!VM_FRAME_FINISHED_P(cfp)) {
2700 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
2701 THROW_DATA_STATE_SET(err, state = TAG_BREAK);
2702 }
2703 else {
2704 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2705 if (ct) for (i = 0; i < ct->size; i++) {
2706 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2707 if (entry->start < epc && entry->end >= epc) {
2708 if (entry->type == CATCH_TYPE_ENSURE) {
2709 catch_iseq = entry->iseq;
2710 cont_pc = entry->cont;
2711 cont_sp = entry->sp;
2712 break;
2713 }
2714 }
2715 }
2716 if (catch_iseq == NULL) {
2717 ec->errinfo = Qnil;
2718 THROW_DATA_CATCH_FRAME_SET(err, cfp + 1);
2719 // cfp == escape_cfp here so calling with cfp_returning_with_value = true
2720 hook_before_rewind(ec, true, state, err);
2721 rb_vm_pop_frame(ec);
2722 return THROW_DATA_VAL(err);
2723 }
2724 }
2725 /* through */
2726 }
2727 else {
2728 /* TAG_BREAK */
2729 *cfp->sp++ = THROW_DATA_VAL(err);
2730 ec->errinfo = Qnil;
2731 return Qundef;
2732 }
2733 }
2734 }
2735
2736 if (state == TAG_RAISE) {
2737 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2738 if (ct) for (i = 0; i < ct->size; i++) {
2739 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2740 if (entry->start < epc && entry->end >= epc) {
2741
2742 if (entry->type == CATCH_TYPE_RESCUE ||
2743 entry->type == CATCH_TYPE_ENSURE) {
2744 catch_iseq = entry->iseq;
2745 cont_pc = entry->cont;
2746 cont_sp = entry->sp;
2747 break;
2748 }
2749 }
2750 }
2751 }
2752 else if (state == TAG_RETRY) {
2753 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2754 if (ct) for (i = 0; i < ct->size; i++) {
2755 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2756 if (entry->start < epc && entry->end >= epc) {
2757
2758 if (entry->type == CATCH_TYPE_ENSURE) {
2759 catch_iseq = entry->iseq;
2760 cont_pc = entry->cont;
2761 cont_sp = entry->sp;
2762 break;
2763 }
2764 else if (entry->type == CATCH_TYPE_RETRY) {
2765 const rb_control_frame_t *escape_cfp;
2766 escape_cfp = THROW_DATA_CATCH_FRAME(err);
2767 if (cfp == escape_cfp) {
2768 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + entry->cont;
2769 ec->errinfo = Qnil;
2770 return Qundef;
2771 }
2772 }
2773 }
2774 }
2775 }
2776 else if ((state == TAG_BREAK && !escape_cfp) ||
2777 (state == TAG_REDO) ||
2778 (state == TAG_NEXT)) {
2779 type = (const enum rb_catch_type[TAG_MASK]) {
2780 [TAG_BREAK] = CATCH_TYPE_BREAK,
2781 [TAG_NEXT] = CATCH_TYPE_NEXT,
2782 [TAG_REDO] = CATCH_TYPE_REDO,
2783 /* otherwise = dontcare */
2784 }[state];
2785
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
2790 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;
2795 break;
2796 }
2797 else if (entry->type == type) {
2798 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + entry->cont;
2799 cfp->sp = vm_base_ptr(cfp) + entry->sp;
2800
2801 if (state != TAG_REDO) {
2802 *cfp->sp++ = THROW_DATA_VAL(err);
2803 }
2804 ec->errinfo = Qnil;
2805 VM_ASSERT(ec->tag->state == TAG_NONE);
2806 return Qundef;
2807 }
2808 }
2809 }
2810 }
2811 else {
2812 ct = ISEQ_BODY(cfp->iseq)->catch_table;
2813 if (ct) for (i = 0; i < ct->size; i++) {
2814 entry = UNALIGNED_MEMBER_PTR(ct, entries[i]);
2815 if (entry->start < epc && entry->end >= epc) {
2816
2817 if (entry->type == CATCH_TYPE_ENSURE) {
2818 catch_iseq = entry->iseq;
2819 cont_pc = entry->cont;
2820 cont_sp = entry->sp;
2821 break;
2822 }
2823 }
2824 }
2825 }
2826
2827 if (catch_iseq != NULL) { /* found catch table */
2828 /* enter catch scope */
2829 const int arg_size = 1;
2830
2831 rb_iseq_check(catch_iseq);
2832 cfp->sp = vm_base_ptr(cfp) + cont_sp;
2833 cfp->pc = ISEQ_BODY(cfp->iseq)->iseq_encoded + cont_pc;
2834
2835 /* push block frame */
2836 cfp->sp[0] = (VALUE)err;
2837 vm_push_frame(ec, catch_iseq, VM_FRAME_MAGIC_RESCUE,
2838 cfp->self,
2839 VM_GUARDED_PREV_EP(cfp->ep),
2840 0, /* cref or me */
2841 ISEQ_BODY(catch_iseq)->iseq_encoded,
2842 cfp->sp + arg_size /* push value */,
2843 ISEQ_BODY(catch_iseq)->local_table_size - arg_size,
2844 ISEQ_BODY(catch_iseq)->stack_max);
2845
2846 state = 0;
2847 ec->tag->state = TAG_NONE;
2848 ec->errinfo = Qnil;
2849
2850 return Qundef;
2851 }
2852 else {
2853 hook_before_rewind(ec, (cfp == escape_cfp), state, err);
2854
2855 if (VM_FRAME_FINISHED_P(ec->cfp)) {
2856 rb_vm_pop_frame(ec);
2857 ec->errinfo = (VALUE)err;
2858 rb_vm_tag_jmpbuf_deinit(&ec->tag->buf);
2859 ec->tag = ec->tag->prev;
2860 EC_JUMP_TAG(ec, state);
2861 }
2862 else {
2863 rb_vm_pop_frame(ec);
2864 }
2865 }
2866 }
2867}
2868
2869/* misc */
2870
2871VALUE
2872rb_iseq_eval(const rb_iseq_t *iseq)
2873{
2874 rb_execution_context_t *ec = GET_EC();
2875 VALUE val;
2876 vm_set_top_stack(ec, iseq);
2877 // TODO: set the namespace frame like require/load
2878 val = vm_exec(ec);
2879 return val;
2880}
2881
2882VALUE
2883rb_iseq_eval_with_refinement(const rb_iseq_t *iseq, VALUE mod)
2884{
2885 rb_execution_context_t *ec = GET_EC();
2886 VALUE val;
2887 vm_set_top_stack(ec, iseq);
2888 rb_vm_using_module(mod);
2889 // TODO: set the namespace frame like require/load
2890 val = vm_exec(ec);
2891 return val;
2892}
2893
2894VALUE
2895rb_iseq_eval_main(const rb_iseq_t *iseq)
2896{
2897 rb_execution_context_t *ec = GET_EC();
2898 VALUE val;
2899 vm_set_main_stack(ec, iseq);
2900 // TODO: set the namespace frame like require/load
2901 val = vm_exec(ec);
2902 return val;
2903}
2904
2905int
2906rb_vm_control_frame_id_and_class(const rb_control_frame_t *cfp, ID *idp, ID *called_idp, VALUE *klassp)
2907{
2908 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
2909
2910 if (me) {
2911 if (idp) *idp = me->def->original_id;
2912 if (called_idp) *called_idp = me->called_id;
2913 if (klassp) *klassp = me->owner;
2914 return TRUE;
2915 }
2916 else {
2917 return FALSE;
2918 }
2919}
2920
2921int
2922rb_ec_frame_method_id_and_class(const rb_execution_context_t *ec, ID *idp, ID *called_idp, VALUE *klassp)
2923{
2924 return rb_vm_control_frame_id_and_class(ec->cfp, idp, called_idp, klassp);
2925}
2926
2927int
2929{
2930 return rb_ec_frame_method_id_and_class(GET_EC(), idp, 0, klassp);
2931}
2932
2933VALUE
2934rb_vm_call_cfunc(VALUE recv, VALUE (*func)(VALUE), VALUE arg,
2935 VALUE block_handler, VALUE filename)
2936{
2937 rb_execution_context_t *ec = GET_EC();
2938 const rb_control_frame_t *reg_cfp = ec->cfp;
2939 const rb_iseq_t *iseq = rb_iseq_new(Qnil, filename, filename, Qnil, 0, ISEQ_TYPE_TOP);
2940 VALUE val;
2941
2942 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
2943 recv, block_handler,
2944 (VALUE)vm_cref_new_toplevel(ec), /* cref or me */
2945 0, reg_cfp->sp, 0, 0);
2946
2947 val = (*func)(arg);
2948
2949 rb_vm_pop_frame(ec);
2950 return val;
2951}
2952
2953VALUE
2954rb_vm_call_cfunc2(VALUE recv, VALUE (*func)(VALUE, VALUE), VALUE arg1, VALUE arg2,
2955 VALUE block_handler, VALUE filename)
2956{
2957 rb_execution_context_t *ec = GET_EC();
2958 const rb_control_frame_t *reg_cfp = ec->cfp;
2959 const rb_iseq_t *iseq = rb_iseq_new(Qnil, filename, filename, Qnil, 0, ISEQ_TYPE_TOP);
2960 VALUE val;
2961
2962 vm_push_frame(ec, iseq, VM_FRAME_MAGIC_TOP | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH,
2963 recv, block_handler,
2964 (VALUE)vm_cref_new_toplevel(ec), /* cref or me */
2965 0, reg_cfp->sp, 0, 0);
2966
2967 val = (*func)(arg1, arg2);
2968
2969 rb_vm_pop_frame(ec);
2970 return val;
2971}
2972
2973/* vm */
2974
2975void
2976rb_vm_update_references(void *ptr)
2977{
2978 if (ptr) {
2979 rb_vm_t *vm = ptr;
2980
2981 vm->self = rb_gc_location(vm->self);
2982 vm->mark_object_ary = rb_gc_location(vm->mark_object_ary);
2983 vm->load_path = rb_gc_location(vm->load_path);
2984 vm->load_path_snapshot = rb_gc_location(vm->load_path_snapshot);
2985
2986 if (vm->load_path_check_cache) {
2987 vm->load_path_check_cache = rb_gc_location(vm->load_path_check_cache);
2988 }
2989
2990 vm->expanded_load_path = rb_gc_location(vm->expanded_load_path);
2991 vm->loaded_features = rb_gc_location(vm->loaded_features);
2992 vm->loaded_features_snapshot = rb_gc_location(vm->loaded_features_snapshot);
2993 vm->loaded_features_realpaths = rb_gc_location(vm->loaded_features_realpaths);
2994 vm->loaded_features_realpath_map = rb_gc_location(vm->loaded_features_realpath_map);
2995 vm->top_self = rb_gc_location(vm->top_self);
2996 vm->require_stack = rb_gc_location(vm->require_stack);
2997 vm->orig_progname = rb_gc_location(vm->orig_progname);
2998
2999 rb_gc_update_values(RUBY_NSIG, vm->trap_list.cmd);
3000
3001 if (vm->coverages) {
3002 vm->coverages = rb_gc_location(vm->coverages);
3003 vm->me2counter = rb_gc_location(vm->me2counter);
3004 }
3005 }
3006}
3007
3008void
3009rb_vm_each_stack_value(void *ptr, void (*cb)(VALUE, void*), void *ctx)
3010{
3011 if (ptr) {
3012 rb_vm_t *vm = ptr;
3013 rb_ractor_t *r = 0;
3014 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3015 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3016 rb_ractor_status_p(r, ractor_running));
3017 if (r->threads.cnt > 0) {
3018 rb_thread_t *th = 0;
3019 ccan_list_for_each(&r->threads.set, th, lt_node) {
3020 VM_ASSERT(th != NULL);
3021 rb_execution_context_t * ec = th->ec;
3022 if (ec->vm_stack) {
3023 VALUE *p = ec->vm_stack;
3024 VALUE *sp = ec->cfp->sp;
3025 while (p < sp) {
3026 if (!RB_SPECIAL_CONST_P(*p)) {
3027 cb(*p, ctx);
3028 }
3029 p++;
3030 }
3031 }
3032 }
3033 }
3034 }
3035 }
3036}
3037
3038static enum rb_id_table_iterator_result
3039vm_mark_negative_cme(VALUE val, void *dmy)
3040{
3041 rb_gc_mark(val);
3042 return ID_TABLE_CONTINUE;
3043}
3044
3045void rb_thread_sched_mark_zombies(rb_vm_t *vm);
3046
3047void
3048rb_vm_mark(void *ptr)
3049{
3050 RUBY_MARK_ENTER("vm");
3051 RUBY_GC_INFO("-------------------------------------------------\n");
3052 if (ptr) {
3053 rb_vm_t *vm = ptr;
3054 rb_ractor_t *r = 0;
3055 long i;
3056
3057 ccan_list_for_each(&vm->ractor.set, r, vmlr_node) {
3058 // ractor.set only contains blocking or running ractors
3059 VM_ASSERT(rb_ractor_status_p(r, ractor_blocking) ||
3060 rb_ractor_status_p(r, ractor_running));
3061 rb_gc_mark(rb_ractor_self(r));
3062 }
3063
3064 for (struct global_object_list *list = vm->global_object_list; list; list = list->next) {
3065 rb_gc_mark_maybe(*list->varptr);
3066 }
3067
3068 rb_gc_mark_movable(vm->self);
3069
3070 if (vm->main_namespace) {
3071 rb_namespace_entry_mark((void *)vm->main_namespace);
3072 }
3073
3074 rb_gc_mark_movable(vm->mark_object_ary);
3075 rb_gc_mark_movable(vm->load_path);
3076 rb_gc_mark_movable(vm->load_path_snapshot);
3077 rb_gc_mark_movable(vm->load_path_check_cache);
3078 rb_gc_mark_movable(vm->expanded_load_path);
3079 rb_gc_mark_movable(vm->loaded_features);
3080 rb_gc_mark_movable(vm->loaded_features_snapshot);
3081 rb_gc_mark_movable(vm->loaded_features_realpaths);
3082 rb_gc_mark_movable(vm->loaded_features_realpath_map);
3083 rb_gc_mark_movable(vm->require_stack);
3084 rb_gc_mark_movable(vm->top_self);
3085 rb_gc_mark_movable(vm->orig_progname);
3086 rb_gc_mark_movable(vm->coverages);
3087 rb_gc_mark_movable(vm->me2counter);
3088
3089 if (vm->loading_table) {
3090 rb_mark_tbl(vm->loading_table);
3091 }
3092
3093 rb_gc_mark_values(RUBY_NSIG, vm->trap_list.cmd);
3094
3095 rb_id_table_foreach_values(vm->negative_cme_table, vm_mark_negative_cme, NULL);
3096 rb_mark_tbl_no_pin(vm->overloaded_cme_table);
3097 for (i=0; i<VM_GLOBAL_CC_CACHE_TABLE_SIZE; i++) {
3098 const struct rb_callcache *cc = vm->global_cc_cache_table[i];
3099
3100 if (cc != NULL) {
3101 if (!vm_cc_invalidated_p(cc)) {
3102 rb_gc_mark((VALUE)cc);
3103 }
3104 else {
3105 vm->global_cc_cache_table[i] = NULL;
3106 }
3107 }
3108 }
3109
3110 rb_thread_sched_mark_zombies(vm);
3111 }
3112
3113 RUBY_MARK_LEAVE("vm");
3114}
3115
3116#undef rb_vm_register_special_exception
3117void
3118rb_vm_register_special_exception_str(enum ruby_special_exceptions sp, VALUE cls, VALUE mesg)
3119{
3120 rb_vm_t *vm = GET_VM();
3121 VALUE exc = rb_exc_new3(cls, rb_obj_freeze(mesg));
3122 OBJ_FREEZE(exc);
3123 ((VALUE *)vm->special_exceptions)[sp] = exc;
3124 rb_vm_register_global_object(exc);
3125}
3126
3127static int
3128free_loading_table_entry(st_data_t key, st_data_t value, st_data_t arg)
3129{
3130 xfree((char *)key);
3131 return ST_DELETE;
3132}
3133
3134void rb_free_loaded_features_index(rb_vm_t *vm);
3135void rb_objspace_free_objects(void *objspace);
3136
3137int
3139{
3140 RUBY_FREE_ENTER("vm");
3141
3142 if (vm) {
3143 rb_thread_t *th = vm->ractor.main_thread;
3144 VALUE *stack = th->ec->vm_stack;
3145 if (rb_free_at_exit) {
3146 rb_free_encoded_insn_data();
3147 rb_free_global_enc_table();
3148 rb_free_loaded_builtin_table();
3149
3150 rb_free_shared_fiber_pool();
3151 rb_free_static_symid_str();
3152 rb_free_transcoder_table();
3153 rb_free_vm_opt_tables();
3154 rb_free_warning();
3155 rb_free_rb_global_tbl();
3156 rb_free_loaded_features_index(vm);
3157
3158 rb_id_table_free(vm->negative_cme_table);
3159 st_free_table(vm->overloaded_cme_table);
3160
3161 // TODO: Is this ignorable for classext->m_tbl ?
3162 // rb_id_table_free(RCLASS(rb_mRubyVMFrozenCore)->m_tbl);
3163
3164 st_free_table(vm->static_ext_inits);
3165
3166 rb_vm_postponed_job_free();
3167
3168 rb_id_table_free(vm->constant_cache);
3169 set_free_table(vm->unused_block_warning_table);
3170
3171 xfree(th->nt);
3172 th->nt = NULL;
3173
3174#ifndef HAVE_SETPROCTITLE
3175 ruby_free_proctitle();
3176#endif
3177 }
3178 else {
3179 rb_fiber_reset_root_local_storage(th);
3180 thread_free(th);
3181 }
3182
3183 struct rb_objspace *objspace = vm->gc.objspace;
3184
3185 rb_vm_living_threads_init(vm);
3186 ruby_vm_run_at_exit_hooks(vm);
3187 if (vm->loading_table) {
3188 st_foreach(vm->loading_table, free_loading_table_entry, 0);
3189 st_free_table(vm->loading_table);
3190 vm->loading_table = 0;
3191 }
3192 if (vm->ci_table) {
3193 st_free_table(vm->ci_table);
3194 vm->ci_table = NULL;
3195 }
3196 if (vm->cc_refinement_table) {
3197 rb_set_free_table(vm->cc_refinement_table);
3198 vm->cc_refinement_table = NULL;
3199 }
3200 RB_ALTSTACK_FREE(vm->main_altstack);
3201
3202 struct global_object_list *next;
3203 for (struct global_object_list *list = vm->global_object_list; list; list = next) {
3204 next = list->next;
3205 xfree(list);
3206 }
3207
3208 if (objspace) {
3209 if (rb_free_at_exit) {
3210 rb_objspace_free_objects(objspace);
3211 rb_free_generic_fields_tbl_();
3212 rb_free_default_rand_key();
3213 if (th && vm->fork_gen == 0) {
3214 /* If we have forked, main_thread may not be the initial thread */
3215 xfree(stack);
3216 ruby_mimfree(th);
3217 }
3218 }
3219 rb_objspace_free(objspace);
3220 }
3221 rb_native_mutex_destroy(&vm->workqueue_lock);
3222 /* after freeing objspace, you *can't* use ruby_xfree() */
3223 ruby_mimfree(vm);
3224 ruby_current_vm_ptr = NULL;
3225
3226 if (rb_free_at_exit) {
3227 rb_shape_free_all();
3228#if USE_YJIT
3229 rb_yjit_free_at_exit();
3230#endif
3231 }
3232 }
3233 RUBY_FREE_LEAVE("vm");
3234 return 0;
3235}
3236
3237size_t rb_vm_memsize_workqueue(struct ccan_list_head *workqueue); // vm_trace.c
3238
3239// Used for VM memsize reporting. Returns the size of the at_exit list by
3240// looping through the linked list and adding up the size of the structs.
3241static enum rb_id_table_iterator_result
3242vm_memsize_constant_cache_i(ID id, VALUE ics, void *size)
3243{
3244 *((size_t *) size) += rb_st_memsize((st_table *) ics);
3245 return ID_TABLE_CONTINUE;
3246}
3247
3248// Returns a size_t representing the memory footprint of the VM's constant
3249// cache, which is the memsize of the table as well as the memsize of all of the
3250// nested tables.
3251static size_t
3252vm_memsize_constant_cache(void)
3253{
3254 rb_vm_t *vm = GET_VM();
3255 size_t size = rb_id_table_memsize(vm->constant_cache);
3256
3257 rb_id_table_foreach(vm->constant_cache, vm_memsize_constant_cache_i, &size);
3258 return size;
3259}
3260
3261static size_t
3262vm_memsize_at_exit_list(rb_at_exit_list *at_exit)
3263{
3264 size_t size = 0;
3265
3266 while (at_exit) {
3267 size += sizeof(rb_at_exit_list);
3268 at_exit = at_exit->next;
3269 }
3270
3271 return size;
3272}
3273
3274// Used for VM memsize reporting. Returns the size of the builtin function
3275// table if it has been defined.
3276static size_t
3277vm_memsize_builtin_function_table(const struct rb_builtin_function *builtin_function_table)
3278{
3279 return builtin_function_table == NULL ? 0 : sizeof(struct rb_builtin_function);
3280}
3281
3282// Reports the memsize of the VM struct object and the structs that are
3283// associated with it.
3284static size_t
3285vm_memsize(const void *ptr)
3286{
3287 rb_vm_t *vm = GET_VM();
3288
3289 return (
3290 sizeof(rb_vm_t) +
3291 rb_st_memsize(vm->loaded_features_index) +
3292 rb_st_memsize(vm->loading_table) +
3293 rb_vm_memsize_postponed_job_queue() +
3294 rb_vm_memsize_workqueue(&vm->workqueue) +
3295 vm_memsize_at_exit_list(vm->at_exit) +
3296 rb_st_memsize(vm->ci_table) +
3297 vm_memsize_builtin_function_table(vm->builtin_function_table) +
3298 rb_id_table_memsize(vm->negative_cme_table) +
3299 rb_st_memsize(vm->overloaded_cme_table) +
3300 rb_set_memsize(vm->cc_refinement_table) +
3301 vm_memsize_constant_cache()
3302 );
3303
3304 // TODO
3305 // struct { struct ccan_list_head set; } ractor;
3306 // void *main_altstack; #ifdef USE_SIGALTSTACK
3307 // struct rb_objspace *objspace;
3308}
3309
3310static const rb_data_type_t vm_data_type = {
3311 "VM",
3312 {0, 0, vm_memsize,},
3313 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3314};
3315
3316
3317static VALUE
3318vm_default_params(void)
3319{
3320 rb_vm_t *vm = GET_VM();
3321 VALUE result = rb_hash_new_with_size(4);
3322#define SET(name) rb_hash_aset(result, ID2SYM(rb_intern(#name)), SIZET2NUM(vm->default_params.name));
3323 SET(thread_vm_stack_size);
3324 SET(thread_machine_stack_size);
3325 SET(fiber_vm_stack_size);
3326 SET(fiber_machine_stack_size);
3327#undef SET
3328 rb_obj_freeze(result);
3329 return result;
3330}
3331
3332static size_t
3333get_param(const char *name, size_t default_value, size_t min_value)
3334{
3335 const char *envval;
3336 size_t result = default_value;
3337 if ((envval = getenv(name)) != 0) {
3338 long val = atol(envval);
3339 if (val < (long)min_value) {
3340 val = (long)min_value;
3341 }
3342 result = (size_t)(((val -1 + RUBY_VM_SIZE_ALIGN) / RUBY_VM_SIZE_ALIGN) * RUBY_VM_SIZE_ALIGN);
3343 }
3344 if (0) ruby_debug_printf("%s: %"PRIuSIZE"\n", name, result); /* debug print */
3345
3346 return result;
3347}
3348
3349static void
3350check_machine_stack_size(size_t *sizep)
3351{
3352#ifdef PTHREAD_STACK_MIN
3353 size_t size = *sizep;
3354#endif
3355
3356#ifdef PTHREAD_STACK_MIN
3357 if (size < (size_t)PTHREAD_STACK_MIN) {
3358 *sizep = (size_t)PTHREAD_STACK_MIN * 2;
3359 }
3360#endif
3361}
3362
3363static void
3364vm_default_params_setup(rb_vm_t *vm)
3365{
3366 vm->default_params.thread_vm_stack_size =
3367 get_param("RUBY_THREAD_VM_STACK_SIZE",
3368 RUBY_VM_THREAD_VM_STACK_SIZE,
3369 RUBY_VM_THREAD_VM_STACK_SIZE_MIN);
3370
3371 vm->default_params.thread_machine_stack_size =
3372 get_param("RUBY_THREAD_MACHINE_STACK_SIZE",
3373 RUBY_VM_THREAD_MACHINE_STACK_SIZE,
3374 RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN);
3375
3376 vm->default_params.fiber_vm_stack_size =
3377 get_param("RUBY_FIBER_VM_STACK_SIZE",
3378 RUBY_VM_FIBER_VM_STACK_SIZE,
3379 RUBY_VM_FIBER_VM_STACK_SIZE_MIN);
3380
3381 vm->default_params.fiber_machine_stack_size =
3382 get_param("RUBY_FIBER_MACHINE_STACK_SIZE",
3383 RUBY_VM_FIBER_MACHINE_STACK_SIZE,
3384 RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN);
3385
3386 /* environment dependent check */
3387 check_machine_stack_size(&vm->default_params.thread_machine_stack_size);
3388 check_machine_stack_size(&vm->default_params.fiber_machine_stack_size);
3389}
3390
3391static void
3392vm_init2(rb_vm_t *vm)
3393{
3394 rb_vm_living_threads_init(vm);
3395 vm->thread_report_on_exception = 1;
3396 vm->src_encoding_index = -1;
3397
3398 vm_default_params_setup(vm);
3399}
3400
3401void
3402rb_execution_context_update(rb_execution_context_t *ec)
3403{
3404 /* update VM stack */
3405 if (ec->vm_stack) {
3406 long i;
3407 VM_ASSERT(ec->cfp);
3408 VALUE *p = ec->vm_stack;
3409 VALUE *sp = ec->cfp->sp;
3410 rb_control_frame_t *cfp = ec->cfp;
3411 rb_control_frame_t *limit_cfp = (void *)(ec->vm_stack + ec->vm_stack_size);
3412
3413 for (i = 0; i < (long)(sp - p); i++) {
3414 VALUE ref = p[i];
3415 VALUE update = rb_gc_location(ref);
3416 if (ref != update) {
3417 p[i] = update;
3418 }
3419 }
3420
3421 while (cfp != limit_cfp) {
3422 const VALUE *ep = cfp->ep;
3423 cfp->self = rb_gc_location(cfp->self);
3424 cfp->iseq = (rb_iseq_t *)rb_gc_location((VALUE)cfp->iseq);
3425 cfp->block_code = (void *)rb_gc_location((VALUE)cfp->block_code);
3426
3427 if (!VM_ENV_LOCAL_P(ep)) {
3428 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3429 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3430 VM_FORCE_WRITE(&prev_ep[VM_ENV_DATA_INDEX_ENV], rb_gc_location(prev_ep[VM_ENV_DATA_INDEX_ENV]));
3431 }
3432
3433 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3434 VM_FORCE_WRITE(&ep[VM_ENV_DATA_INDEX_ENV], rb_gc_location(ep[VM_ENV_DATA_INDEX_ENV]));
3435 VM_FORCE_WRITE(&ep[VM_ENV_DATA_INDEX_ME_CREF], rb_gc_location(ep[VM_ENV_DATA_INDEX_ME_CREF]));
3436 }
3437 }
3438
3439 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3440 }
3441 }
3442
3443 ec->storage = rb_gc_location(ec->storage);
3444}
3445
3446static enum rb_id_table_iterator_result
3447mark_local_storage_i(VALUE local, void *data)
3448{
3449 rb_gc_mark(local);
3450 return ID_TABLE_CONTINUE;
3451}
3452
3453void
3454rb_execution_context_mark(const rb_execution_context_t *ec)
3455{
3456 /* mark VM stack */
3457 if (ec->vm_stack) {
3458 VM_ASSERT(ec->cfp);
3459 VALUE *p = ec->vm_stack;
3460 VALUE *sp = ec->cfp->sp;
3461 rb_control_frame_t *cfp = ec->cfp;
3462 rb_control_frame_t *limit_cfp = (void *)(ec->vm_stack + ec->vm_stack_size);
3463
3464 VM_ASSERT(sp == ec->cfp->sp);
3465 rb_gc_mark_vm_stack_values((long)(sp - p), p);
3466
3467 while (cfp != limit_cfp) {
3468 const VALUE *ep = cfp->ep;
3469 VM_ASSERT(!!VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED) == vm_ep_in_heap_p_(ec, ep));
3470
3471 rb_gc_mark_movable(cfp->self);
3472 rb_gc_mark_movable((VALUE)cfp->iseq);
3473 rb_gc_mark_movable((VALUE)cfp->block_code);
3474
3475 if (!VM_ENV_LOCAL_P(ep)) {
3476 const VALUE *prev_ep = VM_ENV_PREV_EP(ep);
3477 if (VM_ENV_FLAGS(prev_ep, VM_ENV_FLAG_ESCAPED)) {
3478 rb_gc_mark_movable(prev_ep[VM_ENV_DATA_INDEX_ENV]);
3479 }
3480
3481 if (VM_ENV_FLAGS(ep, VM_ENV_FLAG_ESCAPED)) {
3482 rb_gc_mark_movable(ep[VM_ENV_DATA_INDEX_ENV]);
3483 rb_gc_mark(ep[VM_ENV_DATA_INDEX_ME_CREF]);
3484 }
3485 }
3486
3487 cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
3488 }
3489 }
3490
3491 /* mark machine stack */
3492 if (ec->machine.stack_start && ec->machine.stack_end &&
3493 ec != GET_EC() /* marked for current ec at the first stage of marking */
3494 ) {
3495 rb_gc_mark_machine_context(ec);
3496 }
3497
3498 rb_gc_mark(ec->errinfo);
3499 rb_gc_mark(ec->root_svar);
3500 if (ec->local_storage) {
3501 rb_id_table_foreach_values(ec->local_storage, mark_local_storage_i, NULL);
3502 }
3503 rb_gc_mark(ec->local_storage_recursive_hash);
3504 rb_gc_mark(ec->local_storage_recursive_hash_for_trace);
3505 rb_gc_mark(ec->private_const_reference);
3506
3507 rb_gc_mark_movable(ec->storage);
3508}
3509
3510void rb_fiber_mark_self(rb_fiber_t *fib);
3511void rb_fiber_update_self(rb_fiber_t *fib);
3512void rb_threadptr_root_fiber_setup(rb_thread_t *th);
3513void rb_threadptr_root_fiber_release(rb_thread_t *th);
3514
3515static void
3516thread_compact(void *ptr)
3517{
3518 rb_thread_t *th = ptr;
3519
3520 th->self = rb_gc_location(th->self);
3521
3522 if (!th->root_fiber) {
3523 rb_execution_context_update(th->ec);
3524 }
3525}
3526
3527static void
3528thread_mark(void *ptr)
3529{
3530 rb_thread_t *th = ptr;
3531 RUBY_MARK_ENTER("thread");
3532 rb_fiber_mark_self(th->ec->fiber_ptr);
3533
3534 /* mark ruby objects */
3535 switch (th->invoke_type) {
3536 case thread_invoke_type_proc:
3537 case thread_invoke_type_ractor_proc:
3538 rb_gc_mark(th->invoke_arg.proc.proc);
3539 rb_gc_mark(th->invoke_arg.proc.args);
3540 break;
3541 case thread_invoke_type_func:
3542 rb_gc_mark_maybe((VALUE)th->invoke_arg.func.arg);
3543 break;
3544 default:
3545 break;
3546 }
3547
3548 rb_gc_mark(rb_ractor_self(th->ractor));
3549 rb_gc_mark(th->thgroup);
3550 rb_gc_mark(th->value);
3551 rb_gc_mark(th->pending_interrupt_queue);
3552 rb_gc_mark(th->pending_interrupt_mask_stack);
3553 rb_gc_mark(th->top_self);
3554 rb_gc_mark(th->top_wrapper);
3555 rb_gc_mark(th->namespaces);
3556 if (NAMESPACE_USER_P(th->ns)) rb_namespace_entry_mark(th->ns);
3557 if (th->root_fiber) rb_fiber_mark_self(th->root_fiber);
3558
3559 RUBY_ASSERT(th->ec == rb_fiberptr_get_ec(th->ec->fiber_ptr));
3560 rb_gc_mark(th->last_status);
3561 rb_gc_mark(th->locking_mutex);
3562 rb_gc_mark(th->name);
3563
3564 rb_gc_mark(th->scheduler);
3565
3566 rb_threadptr_interrupt_exec_task_mark(th);
3567
3568 RUBY_MARK_LEAVE("thread");
3569}
3570
3571void rb_threadptr_sched_free(rb_thread_t *th); // thread_*.c
3572
3573static void
3574thread_free(void *ptr)
3575{
3576 rb_thread_t *th = ptr;
3577 RUBY_FREE_ENTER("thread");
3578
3579 rb_threadptr_sched_free(th);
3580
3581 if (th->locking_mutex != Qfalse) {
3582 rb_bug("thread_free: locking_mutex must be NULL (%p:%p)", (void *)th, (void *)th->locking_mutex);
3583 }
3584 if (th->keeping_mutexes != NULL) {
3585 rb_bug("thread_free: keeping_mutexes must be NULL (%p:%p)", (void *)th, (void *)th->keeping_mutexes);
3586 }
3587
3588 ruby_xfree(th->specific_storage);
3589
3590 rb_threadptr_root_fiber_release(th);
3591
3592 if (th->vm && th->vm->ractor.main_thread == th) {
3593 RUBY_GC_INFO("MRI main thread\n");
3594 }
3595 else {
3596 // ruby_xfree(th->nt);
3597 // TODO: MN system collect nt, but without MN system it should be freed here.
3598 ruby_xfree(th);
3599 }
3600
3601 RUBY_FREE_LEAVE("thread");
3602}
3603
3604static size_t
3605thread_memsize(const void *ptr)
3606{
3607 const rb_thread_t *th = ptr;
3608 size_t size = sizeof(rb_thread_t);
3609
3610 if (!th->root_fiber) {
3611 size += th->ec->vm_stack_size * sizeof(VALUE);
3612 }
3613 if (th->ec->local_storage) {
3614 size += rb_id_table_memsize(th->ec->local_storage);
3615 }
3616 return size;
3617}
3618
3619#define thread_data_type ruby_threadptr_data_type
3620const rb_data_type_t ruby_threadptr_data_type = {
3621 "VM/thread",
3622 {
3623 thread_mark,
3624 thread_free,
3625 thread_memsize,
3626 thread_compact,
3627 },
3628 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3629};
3630
3631VALUE
3632rb_obj_is_thread(VALUE obj)
3633{
3634 return RBOOL(rb_typeddata_is_kind_of(obj, &thread_data_type));
3635}
3636
3637static VALUE
3638thread_alloc(VALUE klass)
3639{
3640 rb_thread_t *th;
3641 return TypedData_Make_Struct(klass, rb_thread_t, &thread_data_type, th);
3642}
3643
3644void
3645rb_ec_set_vm_stack(rb_execution_context_t *ec, VALUE *stack, size_t size)
3646{
3647 ec->vm_stack = stack;
3648 ec->vm_stack_size = size;
3649}
3650
3651void
3652rb_ec_initialize_vm_stack(rb_execution_context_t *ec, VALUE *stack, size_t size)
3653{
3654 rb_ec_set_vm_stack(ec, stack, size);
3655
3656#if VM_CHECK_MODE > 0
3657 MEMZERO(stack, VALUE, size); // malloc memory could have the VM canary in it
3658#endif
3659
3660 ec->cfp = (void *)(ec->vm_stack + ec->vm_stack_size);
3661
3662 vm_push_frame(ec,
3663 NULL /* dummy iseq */,
3664 VM_FRAME_MAGIC_DUMMY | VM_ENV_FLAG_LOCAL | VM_FRAME_FLAG_FINISH | VM_FRAME_FLAG_CFRAME /* dummy frame */,
3665 Qnil /* dummy self */, VM_BLOCK_HANDLER_NONE /* dummy block ptr */,
3666 0 /* dummy cref/me */,
3667 0 /* dummy pc */, ec->vm_stack, 0, 0
3668 );
3669}
3670
3671void
3672rb_ec_clear_vm_stack(rb_execution_context_t *ec)
3673{
3674 // set cfp to NULL before clearing the stack in case `thread_profile_frames`
3675 // gets called in this middle of `rb_ec_set_vm_stack` via signal handler.
3676 ec->cfp = NULL;
3677 rb_ec_set_vm_stack(ec, NULL, 0);
3678}
3679
3680static void
3681th_init(rb_thread_t *th, VALUE self, rb_vm_t *vm)
3682{
3683 th->self = self;
3684
3685 rb_threadptr_root_fiber_setup(th);
3686
3687 /* All threads are blocking until a non-blocking fiber is scheduled */
3688 th->blocking = 1;
3689 th->scheduler = Qnil;
3690
3691 if (self == 0) {
3692 size_t size = vm->default_params.thread_vm_stack_size / sizeof(VALUE);
3693 rb_ec_initialize_vm_stack(th->ec, ALLOC_N(VALUE, size), size);
3694 }
3695 else {
3696 VM_ASSERT(th->ec->cfp == NULL);
3697 VM_ASSERT(th->ec->vm_stack == NULL);
3698 VM_ASSERT(th->ec->vm_stack_size == 0);
3699 }
3700
3701 th->status = THREAD_RUNNABLE;
3702 th->last_status = Qnil;
3703 th->top_wrapper = 0;
3704 th->top_self = vm->top_self; // 0 while self == 0
3705 th->namespaces = 0;
3706 th->ns = 0;
3707 th->value = Qundef;
3708
3709 th->ec->errinfo = Qnil;
3710 th->ec->root_svar = Qfalse;
3711 th->ec->local_storage_recursive_hash = Qnil;
3712 th->ec->local_storage_recursive_hash_for_trace = Qnil;
3713
3714 th->ec->storage = Qnil;
3715
3716#if OPT_CALL_THREADED_CODE
3717 th->retval = Qundef;
3718#endif
3719 th->name = Qnil;
3720 th->report_on_exception = vm->thread_report_on_exception;
3721 th->ext_config.ractor_safe = true;
3722
3723 ccan_list_head_init(&th->interrupt_exec_tasks);
3724
3725#if USE_RUBY_DEBUG_LOG
3726 static rb_atomic_t thread_serial = 1;
3727 th->serial = RUBY_ATOMIC_FETCH_ADD(thread_serial, 1);
3728
3729 RUBY_DEBUG_LOG("th:%u", th->serial);
3730#endif
3731}
3732
3733VALUE
3734rb_thread_alloc(VALUE klass)
3735{
3736 rb_namespace_t *ns;
3737 rb_execution_context_t *ec = GET_EC();
3738 VALUE self = thread_alloc(klass);
3739 rb_thread_t *target_th = rb_thread_ptr(self);
3740 target_th->ractor = GET_RACTOR();
3741 th_init(target_th, self, target_th->vm = GET_VM());
3742 if ((ns = rb_ec_thread_ptr(ec)->ns) == 0) {
3743 ns = rb_main_namespace();
3744 }
3745 target_th->ns = ns;
3746 return self;
3747}
3748
3749#define REWIND_CFP(expr) do { \
3750 rb_execution_context_t *ec__ = GET_EC(); \
3751 VALUE *const curr_sp = (ec__->cfp++)->sp; \
3752 VALUE *const saved_sp = ec__->cfp->sp; \
3753 ec__->cfp->sp = curr_sp; \
3754 expr; \
3755 (ec__->cfp--)->sp = saved_sp; \
3756} while (0)
3757
3758static VALUE
3759m_core_set_method_alias(VALUE self, VALUE cbase, VALUE sym1, VALUE sym2)
3760{
3761 REWIND_CFP({
3762 rb_alias(cbase, SYM2ID(sym1), SYM2ID(sym2));
3763 });
3764 return Qnil;
3765}
3766
3767static VALUE
3768m_core_set_variable_alias(VALUE self, VALUE sym1, VALUE sym2)
3769{
3770 REWIND_CFP({
3771 rb_alias_variable(SYM2ID(sym1), SYM2ID(sym2));
3772 });
3773 return Qnil;
3774}
3775
3776static VALUE
3777m_core_undef_method(VALUE self, VALUE cbase, VALUE sym)
3778{
3779 REWIND_CFP({
3780 ID mid = SYM2ID(sym);
3781 rb_undef(cbase, mid);
3782 rb_clear_method_cache(self, mid);
3783 });
3784 return Qnil;
3785}
3786
3787static VALUE
3788m_core_set_postexe(VALUE self)
3789{
3790 rb_set_end_proc(rb_call_end_proc, rb_block_proc());
3791 return Qnil;
3792}
3793
3794static VALUE core_hash_merge_kwd(VALUE hash, VALUE kw);
3795
3796static VALUE
3797core_hash_merge(VALUE hash, long argc, const VALUE *argv)
3798{
3799 Check_Type(hash, T_HASH);
3800 VM_ASSERT(argc % 2 == 0);
3801 rb_hash_bulk_insert(argc, argv, hash);
3802 return hash;
3803}
3804
3805static VALUE
3806m_core_hash_merge_ptr(int argc, VALUE *argv, VALUE recv)
3807{
3808 VALUE hash = argv[0];
3809
3810 REWIND_CFP(hash = core_hash_merge(hash, argc-1, argv+1));
3811
3812 return hash;
3813}
3814
3815static int
3816kwmerge_i(VALUE key, VALUE value, VALUE hash)
3817{
3818 rb_hash_aset(hash, key, value);
3819 return ST_CONTINUE;
3820}
3821
3822static VALUE
3823m_core_hash_merge_kwd(VALUE recv, VALUE hash, VALUE kw)
3824{
3825 if (!NIL_P(kw)) {
3826 REWIND_CFP(hash = core_hash_merge_kwd(hash, kw));
3827 }
3828 return hash;
3829}
3830
3831static VALUE
3832m_core_make_shareable(VALUE recv, VALUE obj)
3833{
3834 return rb_ractor_make_shareable(obj);
3835}
3836
3837static VALUE
3838m_core_make_shareable_copy(VALUE recv, VALUE obj)
3839{
3841}
3842
3843static VALUE
3844m_core_ensure_shareable(VALUE recv, VALUE obj, VALUE name)
3845{
3846 return rb_ractor_ensure_shareable(obj, name);
3847}
3848
3849static VALUE
3850core_hash_merge_kwd(VALUE hash, VALUE kw)
3851{
3852 rb_hash_foreach(rb_to_hash_type(kw), kwmerge_i, hash);
3853 return hash;
3854}
3855
3856extern VALUE *rb_gc_stack_start;
3857extern size_t rb_gc_stack_maxsize;
3858
3859/* debug functions */
3860
3861/* :nodoc: */
3862static VALUE
3863sdr(VALUE self)
3864{
3865 rb_vm_bugreport(NULL, stderr);
3866 return Qnil;
3867}
3868
3869/* :nodoc: */
3870static VALUE
3871nsdr(VALUE self)
3872{
3873 VALUE ary = rb_ary_new();
3874#ifdef HAVE_BACKTRACE
3875#include <execinfo.h>
3876#define MAX_NATIVE_TRACE 1024
3877 static void *trace[MAX_NATIVE_TRACE];
3878 int n = (int)backtrace(trace, MAX_NATIVE_TRACE);
3879 char **syms = backtrace_symbols(trace, n);
3880 int i;
3881
3882 if (syms == 0) {
3883 rb_memerror();
3884 }
3885
3886 for (i=0; i<n; i++) {
3887 rb_ary_push(ary, rb_str_new2(syms[i]));
3888 }
3889 free(syms); /* OK */
3890#endif
3891 return ary;
3892}
3893
3894#if VM_COLLECT_USAGE_DETAILS
3895static VALUE usage_analysis_insn_start(VALUE self);
3896static VALUE usage_analysis_operand_start(VALUE self);
3897static VALUE usage_analysis_register_start(VALUE self);
3898static VALUE usage_analysis_insn_stop(VALUE self);
3899static VALUE usage_analysis_operand_stop(VALUE self);
3900static VALUE usage_analysis_register_stop(VALUE self);
3901static VALUE usage_analysis_insn_running(VALUE self);
3902static VALUE usage_analysis_operand_running(VALUE self);
3903static VALUE usage_analysis_register_running(VALUE self);
3904static VALUE usage_analysis_insn_clear(VALUE self);
3905static VALUE usage_analysis_operand_clear(VALUE self);
3906static VALUE usage_analysis_register_clear(VALUE self);
3907#endif
3908
3909static VALUE
3910f_raise(int c, VALUE *v, VALUE _)
3911{
3912 return rb_f_raise(c, v);
3913}
3914
3915static VALUE
3916f_proc(VALUE _)
3917{
3918 return rb_block_proc();
3919}
3920
3921static VALUE
3922f_lambda(VALUE _)
3923{
3924 return rb_block_lambda();
3925}
3926
3927static VALUE
3928f_sprintf(int c, const VALUE *v, VALUE _)
3929{
3930 return rb_f_sprintf(c, v);
3931}
3932
3933/* :nodoc: */
3934static VALUE
3935vm_mtbl(VALUE self, VALUE obj, VALUE sym)
3936{
3937 vm_mtbl_dump(CLASS_OF(obj), RTEST(sym) ? SYM2ID(sym) : 0);
3938 return Qnil;
3939}
3940
3941/* :nodoc: */
3942static VALUE
3943vm_mtbl2(VALUE self, VALUE obj, VALUE sym)
3944{
3945 vm_mtbl_dump(obj, RTEST(sym) ? SYM2ID(sym) : 0);
3946 return Qnil;
3947}
3948
3949/*
3950 * call-seq:
3951 * RubyVM.keep_script_lines -> true or false
3952 *
3953 * Return current +keep_script_lines+ status. Now it only returns
3954 * +true+ of +false+, but it can return other objects in future.
3955 *
3956 * Note that this is an API for ruby internal use, debugging,
3957 * and research. Do not use this for any other purpose.
3958 * The compatibility is not guaranteed.
3959 */
3960static VALUE
3961vm_keep_script_lines(VALUE self)
3962{
3963 return RBOOL(ruby_vm_keep_script_lines);
3964}
3965
3966/*
3967 * call-seq:
3968 * RubyVM.keep_script_lines = true / false
3969 *
3970 * It set +keep_script_lines+ flag. If the flag is set, all
3971 * loaded scripts are recorded in a interpreter process.
3972 *
3973 * Note that this is an API for ruby internal use, debugging,
3974 * and research. Do not use this for any other purpose.
3975 * The compatibility is not guaranteed.
3976 */
3977static VALUE
3978vm_keep_script_lines_set(VALUE self, VALUE flags)
3979{
3980 ruby_vm_keep_script_lines = RTEST(flags);
3981 return flags;
3982}
3983
3984void
3985Init_VM(void)
3986{
3987 VALUE opts;
3988 VALUE klass;
3989 VALUE fcore;
3990
3991 /*
3992 * Document-class: RubyVM
3993 *
3994 * The RubyVM module only exists on MRI. +RubyVM+ is not defined in
3995 * other Ruby implementations such as JRuby and TruffleRuby.
3996 *
3997 * The RubyVM module provides some access to MRI internals.
3998 * This module is for very limited purposes, such as debugging,
3999 * prototyping, and research. Normal users must not use it.
4000 * This module is not portable between Ruby implementations.
4001 */
4002 rb_cRubyVM = rb_define_class("RubyVM", rb_cObject);
4003 rb_undef_alloc_func(rb_cRubyVM);
4004 rb_undef_method(CLASS_OF(rb_cRubyVM), "new");
4005 rb_define_singleton_method(rb_cRubyVM, "stat", vm_stat, -1);
4006 rb_define_singleton_method(rb_cRubyVM, "keep_script_lines", vm_keep_script_lines, 0);
4007 rb_define_singleton_method(rb_cRubyVM, "keep_script_lines=", vm_keep_script_lines_set, 1);
4008
4009#if USE_DEBUG_COUNTER
4010 rb_define_singleton_method(rb_cRubyVM, "reset_debug_counters", rb_debug_counter_reset, 0);
4011 rb_define_singleton_method(rb_cRubyVM, "show_debug_counters", rb_debug_counter_show, 0);
4012#endif
4013
4014 /* FrozenCore (hidden) */
4016 rb_set_class_path(fcore, rb_cRubyVM, "FrozenCore");
4017 rb_vm_register_global_object(rb_class_path_cached(fcore));
4018 klass = rb_singleton_class(fcore);
4019 rb_define_method_id(klass, id_core_set_method_alias, m_core_set_method_alias, 3);
4020 rb_define_method_id(klass, id_core_set_variable_alias, m_core_set_variable_alias, 2);
4021 rb_define_method_id(klass, id_core_undef_method, m_core_undef_method, 2);
4022 rb_define_method_id(klass, id_core_set_postexe, m_core_set_postexe, 0);
4023 rb_define_method_id(klass, id_core_hash_merge_ptr, m_core_hash_merge_ptr, -1);
4024 rb_define_method_id(klass, id_core_hash_merge_kwd, m_core_hash_merge_kwd, 2);
4025 rb_define_method_id(klass, id_core_raise, f_raise, -1);
4026 rb_define_method_id(klass, id_core_sprintf, f_sprintf, -1);
4027 rb_define_method_id(klass, idProc, f_proc, 0);
4028 rb_define_method_id(klass, idLambda, f_lambda, 0);
4029 rb_define_method(klass, "make_shareable", m_core_make_shareable, 1);
4030 rb_define_method(klass, "make_shareable_copy", m_core_make_shareable_copy, 1);
4031 rb_define_method(klass, "ensure_shareable", m_core_ensure_shareable, 2);
4032 rb_obj_freeze(fcore);
4033 RBASIC_CLEAR_CLASS(klass);
4034 rb_obj_freeze(klass);
4035 rb_vm_register_global_object(fcore);
4036 rb_mRubyVMFrozenCore = fcore;
4037
4038 /*
4039 * Document-class: Thread
4040 *
4041 * Threads are the Ruby implementation for a concurrent programming model.
4042 *
4043 * Programs that require multiple threads of execution are a perfect
4044 * candidate for Ruby's Thread class.
4045 *
4046 * For example, we can create a new thread separate from the main thread's
4047 * execution using ::new.
4048 *
4049 * thr = Thread.new { puts "What's the big deal" }
4050 *
4051 * Then we are able to pause the execution of the main thread and allow
4052 * our new thread to finish, using #join:
4053 *
4054 * thr.join #=> "What's the big deal"
4055 *
4056 * If we don't call +thr.join+ before the main thread terminates, then all
4057 * other threads including +thr+ will be killed.
4058 *
4059 * Alternatively, you can use an array for handling multiple threads at
4060 * once, like in the following example:
4061 *
4062 * threads = []
4063 * threads << Thread.new { puts "What's the big deal" }
4064 * threads << Thread.new { 3.times { puts "Threads are fun!" } }
4065 *
4066 * After creating a few threads we wait for them all to finish
4067 * consecutively.
4068 *
4069 * threads.each { |thr| thr.join }
4070 *
4071 * To retrieve the last value of a thread, use #value
4072 *
4073 * thr = Thread.new { sleep 1; "Useful value" }
4074 * thr.value #=> "Useful value"
4075 *
4076 * === Thread initialization
4077 *
4078 * In order to create new threads, Ruby provides ::new, ::start, and
4079 * ::fork. A block must be provided with each of these methods, otherwise
4080 * a ThreadError will be raised.
4081 *
4082 * When subclassing the Thread class, the +initialize+ method of your
4083 * subclass will be ignored by ::start and ::fork. Otherwise, be sure to
4084 * call super in your +initialize+ method.
4085 *
4086 * === Thread termination
4087 *
4088 * For terminating threads, Ruby provides a variety of ways to do this.
4089 *
4090 * The class method ::kill, is meant to exit a given thread:
4091 *
4092 * thr = Thread.new { sleep }
4093 * Thread.kill(thr) # sends exit() to thr
4094 *
4095 * Alternatively, you can use the instance method #exit, or any of its
4096 * aliases #kill or #terminate.
4097 *
4098 * thr.exit
4099 *
4100 * === Thread status
4101 *
4102 * Ruby provides a few instance methods for querying the state of a given
4103 * thread. To get a string with the current thread's state use #status
4104 *
4105 * thr = Thread.new { sleep }
4106 * thr.status # => "sleep"
4107 * thr.exit
4108 * thr.status # => false
4109 *
4110 * You can also use #alive? to tell if the thread is running or sleeping,
4111 * and #stop? if the thread is dead or sleeping.
4112 *
4113 * === Thread variables and scope
4114 *
4115 * Since threads are created with blocks, the same rules apply to other
4116 * Ruby blocks for variable scope. Any local variables created within this
4117 * block are accessible to only this thread.
4118 *
4119 * ==== Fiber-local vs. Thread-local
4120 *
4121 * Each fiber has its own bucket for Thread#[] storage. When you set a
4122 * new fiber-local it is only accessible within this Fiber. To illustrate:
4123 *
4124 * Thread.new {
4125 * Thread.current[:foo] = "bar"
4126 * Fiber.new {
4127 * p Thread.current[:foo] # => nil
4128 * }.resume
4129 * }.join
4130 *
4131 * This example uses #[] for getting and #[]= for setting fiber-locals,
4132 * you can also use #keys to list the fiber-locals for a given
4133 * thread and #key? to check if a fiber-local exists.
4134 *
4135 * When it comes to thread-locals, they are accessible within the entire
4136 * scope of the thread. Given the following example:
4137 *
4138 * Thread.new{
4139 * Thread.current.thread_variable_set(:foo, 1)
4140 * p Thread.current.thread_variable_get(:foo) # => 1
4141 * Fiber.new{
4142 * Thread.current.thread_variable_set(:foo, 2)
4143 * p Thread.current.thread_variable_get(:foo) # => 2
4144 * }.resume
4145 * p Thread.current.thread_variable_get(:foo) # => 2
4146 * }.join
4147 *
4148 * You can see that the thread-local +:foo+ carried over into the fiber
4149 * and was changed to +2+ by the end of the thread.
4150 *
4151 * This example makes use of #thread_variable_set to create new
4152 * thread-locals, and #thread_variable_get to reference them.
4153 *
4154 * There is also #thread_variables to list all thread-locals, and
4155 * #thread_variable? to check if a given thread-local exists.
4156 *
4157 * === Exception handling
4158 *
4159 * When an unhandled exception is raised inside a thread, it will
4160 * terminate. By default, this exception will not propagate to other
4161 * threads. The exception is stored and when another thread calls #value
4162 * or #join, the exception will be re-raised in that thread.
4163 *
4164 * t = Thread.new{ raise 'something went wrong' }
4165 * t.value #=> RuntimeError: something went wrong
4166 *
4167 * An exception can be raised from outside the thread using the
4168 * Thread#raise instance method, which takes the same parameters as
4169 * Kernel#raise.
4170 *
4171 * Setting Thread.abort_on_exception = true, Thread#abort_on_exception =
4172 * true, or $DEBUG = true will cause a subsequent unhandled exception
4173 * raised in a thread to be automatically re-raised in the main thread.
4174 *
4175 * With the addition of the class method ::handle_interrupt, you can now
4176 * handle exceptions asynchronously with threads.
4177 *
4178 * === Scheduling
4179 *
4180 * Ruby provides a few ways to support scheduling threads in your program.
4181 *
4182 * The first way is by using the class method ::stop, to put the current
4183 * running thread to sleep and schedule the execution of another thread.
4184 *
4185 * Once a thread is asleep, you can use the instance method #wakeup to
4186 * mark your thread as eligible for scheduling.
4187 *
4188 * You can also try ::pass, which attempts to pass execution to another
4189 * thread but is dependent on the OS whether a running thread will switch
4190 * or not. The same goes for #priority, which lets you hint to the thread
4191 * scheduler which threads you want to take precedence when passing
4192 * execution. This method is also dependent on the OS and may be ignored
4193 * on some platforms.
4194 *
4195 */
4196 rb_cThread = rb_define_class("Thread", rb_cObject);
4198
4199#if VM_COLLECT_USAGE_DETAILS
4200 /* ::RubyVM::USAGE_ANALYSIS_* */
4201#define define_usage_analysis_hash(name) /* shut up rdoc -C */ \
4202 rb_define_const(rb_cRubyVM, "USAGE_ANALYSIS_" #name, rb_hash_new())
4203 define_usage_analysis_hash(INSN);
4204 define_usage_analysis_hash(REGS);
4205 define_usage_analysis_hash(INSN_BIGRAM);
4206
4207 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_INSN_START", usage_analysis_insn_start, 0);
4208 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_OPERAND_START", usage_analysis_operand_start, 0);
4209 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_REGISTER_START", usage_analysis_register_start, 0);
4210 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_INSN_STOP", usage_analysis_insn_stop, 0);
4211 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_OPERAND_STOP", usage_analysis_operand_stop, 0);
4212 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_REGISTER_STOP", usage_analysis_register_stop, 0);
4213 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_INSN_RUNNING", usage_analysis_insn_running, 0);
4214 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_OPERAND_RUNNING", usage_analysis_operand_running, 0);
4215 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_REGISTER_RUNNING", usage_analysis_register_running, 0);
4216 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_INSN_CLEAR", usage_analysis_insn_clear, 0);
4217 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_OPERAND_CLEAR", usage_analysis_operand_clear, 0);
4218 rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_REGISTER_CLEAR", usage_analysis_register_clear, 0);
4219#endif
4220
4221 /* ::RubyVM::OPTS
4222 * An Array of VM build options.
4223 * This constant is MRI specific.
4224 */
4225 rb_define_const(rb_cRubyVM, "OPTS", opts = rb_ary_new());
4226
4227#if OPT_DIRECT_THREADED_CODE
4228 rb_ary_push(opts, rb_str_new2("direct threaded code"));
4229#elif OPT_TOKEN_THREADED_CODE
4230 rb_ary_push(opts, rb_str_new2("token threaded code"));
4231#elif OPT_CALL_THREADED_CODE
4232 rb_ary_push(opts, rb_str_new2("call threaded code"));
4233#endif
4234
4235#if OPT_OPERANDS_UNIFICATION
4236 rb_ary_push(opts, rb_str_new2("operands unification"));
4237#endif
4238#if OPT_INSTRUCTIONS_UNIFICATION
4239 rb_ary_push(opts, rb_str_new2("instructions unification"));
4240#endif
4241#if OPT_INLINE_METHOD_CACHE
4242 rb_ary_push(opts, rb_str_new2("inline method cache"));
4243#endif
4244
4245 /* ::RubyVM::INSTRUCTION_NAMES
4246 * A list of bytecode instruction names in MRI.
4247 * This constant is MRI specific.
4248 */
4249 rb_define_const(rb_cRubyVM, "INSTRUCTION_NAMES", rb_insns_name_array());
4250
4251 /* ::RubyVM::DEFAULT_PARAMS
4252 * This constant exposes the VM's default parameters.
4253 * Note that changing these values does not affect VM execution.
4254 * Specification is not stable and you should not depend on this value.
4255 * Of course, this constant is MRI specific.
4256 */
4257 rb_define_const(rb_cRubyVM, "DEFAULT_PARAMS", vm_default_params());
4258
4259 /* debug functions ::RubyVM::SDR(), ::RubyVM::NSDR() */
4260#if VMDEBUG
4261 rb_define_singleton_method(rb_cRubyVM, "SDR", sdr, 0);
4262 rb_define_singleton_method(rb_cRubyVM, "NSDR", nsdr, 0);
4263 rb_define_singleton_method(rb_cRubyVM, "mtbl", vm_mtbl, 2);
4264 rb_define_singleton_method(rb_cRubyVM, "mtbl2", vm_mtbl2, 2);
4265#else
4266 (void)sdr;
4267 (void)nsdr;
4268 (void)vm_mtbl;
4269 (void)vm_mtbl2;
4270#endif
4271
4272 /* VM bootstrap: phase 2 */
4273 {
4274 rb_vm_t *vm = ruby_current_vm_ptr;
4275 rb_thread_t *th = GET_THREAD();
4276 VALUE filename = rb_fstring_lit("<main>");
4277 const rb_iseq_t *iseq = rb_iseq_new(Qnil, filename, filename, Qnil, 0, ISEQ_TYPE_TOP);
4278
4279 // Ractor setup
4280 rb_ractor_main_setup(vm, th->ractor, th);
4281
4282 /* create vm object */
4283 vm->self = TypedData_Wrap_Struct(rb_cRubyVM, &vm_data_type, vm);
4284
4285 /* create main thread */
4286 th->self = TypedData_Wrap_Struct(rb_cThread, &thread_data_type, th);
4287 vm->ractor.main_thread = th;
4288 vm->ractor.main_ractor = th->ractor;
4289 th->vm = vm;
4290 th->top_wrapper = 0;
4291 th->top_self = rb_vm_top_self();
4292 th->namespaces = 0;
4293 th->ns = 0;
4294
4295 rb_vm_register_global_object((VALUE)iseq);
4296 th->ec->cfp->iseq = iseq;
4297 th->ec->cfp->pc = ISEQ_BODY(iseq)->iseq_encoded;
4298 th->ec->cfp->self = th->top_self;
4299
4300 VM_ENV_FLAGS_UNSET(th->ec->cfp->ep, VM_FRAME_FLAG_CFRAME);
4301 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));
4302
4303 /*
4304 * The Binding of the top level scope
4305 */
4306 rb_define_global_const("TOPLEVEL_BINDING", rb_binding_new());
4307
4308#ifdef _WIN32
4309 rb_objspace_gc_enable(vm->gc.objspace);
4310#endif
4311 }
4312 vm_init_redefined_flag();
4313
4314 rb_block_param_proxy = rb_obj_alloc(rb_cObject);
4315 rb_add_method_optimized(rb_singleton_class(rb_block_param_proxy), idCall,
4316 OPTIMIZED_METHOD_TYPE_BLOCK_CALL, 0, METHOD_VISI_PUBLIC);
4317 rb_obj_freeze(rb_block_param_proxy);
4318 rb_vm_register_global_object(rb_block_param_proxy);
4319
4320 /* vm_backtrace.c */
4321 Init_vm_backtrace();
4322}
4323
4324void
4325rb_vm_set_progname(VALUE filename)
4326{
4327 rb_thread_t *th = GET_VM()->ractor.main_thread;
4328 rb_control_frame_t *cfp = (void *)(th->ec->vm_stack + th->ec->vm_stack_size);
4329 --cfp;
4330
4331 filename = rb_str_new_frozen(filename);
4332 rb_iseq_pathobj_set(cfp->iseq, filename, rb_iseq_realpath(cfp->iseq));
4333}
4334
4335extern const struct st_hash_type rb_fstring_hash_type;
4336
4337void
4338Init_BareVM(void)
4339{
4340 /* VM bootstrap: phase 1 */
4341 rb_vm_t *vm = ruby_mimcalloc(1, sizeof(*vm));
4342 rb_thread_t *th = ruby_mimcalloc(1, sizeof(*th));
4343 if (!vm || !th) {
4344 fputs("[FATAL] failed to allocate memory\n", stderr);
4345 exit(EXIT_FAILURE);
4346 }
4347
4348 // setup the VM
4349 vm_init2(vm);
4350
4351 rb_vm_postponed_job_queue_init(vm);
4352 ruby_current_vm_ptr = vm;
4353 rb_objspace_alloc();
4354 vm->negative_cme_table = rb_id_table_create(16);
4355 vm->overloaded_cme_table = st_init_numtable();
4356 vm->constant_cache = rb_id_table_create(0);
4357 vm->unused_block_warning_table = set_init_numtable();
4358
4359 // setup main thread
4360 th->nt = ZALLOC(struct rb_native_thread);
4361 th->vm = vm;
4362 th->ractor = vm->ractor.main_ractor = rb_ractor_main_alloc();
4363 Init_native_thread(th);
4364 rb_jit_cont_init();
4365 th_init(th, 0, vm);
4366
4367 rb_ractor_set_current_ec(th->ractor, th->ec);
4368 /* n.b. native_main_thread_stack_top is set by the INIT_STACK macro */
4369 ruby_thread_init_stack(th, native_main_thread_stack_top);
4370
4371 // setup ractor system
4372 rb_native_mutex_initialize(&vm->ractor.sync.lock);
4373 rb_native_cond_initialize(&vm->ractor.sync.terminate_cond);
4374
4375 vm_opt_method_def_table = st_init_numtable();
4376 vm_opt_mid_table = st_init_numtable();
4377
4378#ifdef RUBY_THREAD_WIN32_H
4379 rb_native_cond_initialize(&vm->ractor.sync.barrier_complete_cond);
4380 rb_native_cond_initialize(&vm->ractor.sync.barrier_release_cond);
4381#endif
4382}
4383
4384void
4386{
4387 native_main_thread_stack_top = addr;
4388}
4389
4390#ifndef _WIN32
4391#include <unistd.h>
4392#include <sys/mman.h>
4393#endif
4394
4395
4396#ifndef MARK_OBJECT_ARY_BUCKET_SIZE
4397#define MARK_OBJECT_ARY_BUCKET_SIZE 1024
4398#endif
4399
4401 VALUE next;
4402 long len;
4403 VALUE *array;
4404};
4405
4406static void
4407pin_array_list_mark(void *data)
4408{
4409 struct pin_array_list *array = (struct pin_array_list *)data;
4410 rb_gc_mark_movable(array->next);
4411
4412 rb_gc_mark_vm_stack_values(array->len, array->array);
4413}
4414
4415static void
4416pin_array_list_free(void *data)
4417{
4418 struct pin_array_list *array = (struct pin_array_list *)data;
4419 xfree(array->array);
4420}
4421
4422static size_t
4423pin_array_list_memsize(const void *data)
4424{
4425 return sizeof(struct pin_array_list) + (MARK_OBJECT_ARY_BUCKET_SIZE * sizeof(VALUE));
4426}
4427
4428static void
4429pin_array_list_update_references(void *data)
4430{
4431 struct pin_array_list *array = (struct pin_array_list *)data;
4432 array->next = rb_gc_location(array->next);
4433}
4434
4435static const rb_data_type_t pin_array_list_type = {
4436 .wrap_struct_name = "VM/pin_array_list",
4437 .function = {
4438 .dmark = pin_array_list_mark,
4439 .dfree = pin_array_list_free,
4440 .dsize = pin_array_list_memsize,
4441 .dcompact = pin_array_list_update_references,
4442 },
4443 .flags = RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE,
4444};
4445
4446static VALUE
4447pin_array_list_new(VALUE next)
4448{
4449 struct pin_array_list *array_list;
4450 VALUE obj = TypedData_Make_Struct(0, struct pin_array_list, &pin_array_list_type, array_list);
4451 RB_OBJ_WRITE(obj, &array_list->next, next);
4452 array_list->array = ALLOC_N(VALUE, MARK_OBJECT_ARY_BUCKET_SIZE);
4453 return obj;
4454}
4455
4456static VALUE
4457pin_array_list_append(VALUE obj, VALUE item)
4458{
4459 struct pin_array_list *array_list;
4460 TypedData_Get_Struct(obj, struct pin_array_list, &pin_array_list_type, array_list);
4461
4462 if (array_list->len >= MARK_OBJECT_ARY_BUCKET_SIZE) {
4463 obj = pin_array_list_new(obj);
4464 TypedData_Get_Struct(obj, struct pin_array_list, &pin_array_list_type, array_list);
4465 }
4466
4467 RB_OBJ_WRITE(obj, &array_list->array[array_list->len], item);
4468 array_list->len++;
4469 return obj;
4470}
4471
4472void
4473rb_vm_register_global_object(VALUE obj)
4474{
4476 if (RB_SPECIAL_CONST_P(obj)) {
4477 return;
4478 }
4479
4480 switch (RB_BUILTIN_TYPE(obj)) {
4481 case T_CLASS:
4482 case T_MODULE:
4483 if (FL_TEST(obj, RCLASS_IS_ROOT)) {
4484 return;
4485 }
4486 FL_SET(obj, RCLASS_IS_ROOT);
4487 break;
4488 default:
4489 break;
4490 }
4491 RB_VM_LOCKING() {
4492 VALUE list = GET_VM()->mark_object_ary;
4493 VALUE head = pin_array_list_append(list, obj);
4494 if (head != list) {
4495 GET_VM()->mark_object_ary = head;
4496 }
4497 RB_GC_GUARD(obj);
4498 }
4499}
4500
4501void
4502Init_vm_objects(void)
4503{
4504 rb_vm_t *vm = GET_VM();
4505
4506 /* initialize mark object array, hash */
4507 vm->mark_object_ary = pin_array_list_new(Qnil);
4508 vm->loading_table = st_init_strtable();
4509 vm->ci_table = st_init_table(&vm_ci_hashtype);
4510 vm->cc_refinement_table = rb_set_init_numtable();
4511}
4512
4513// Stub for builtin function when not building YJIT units
4514#if !USE_YJIT
4515void Init_builtin_yjit(void) {}
4516#endif
4517
4518// Whether YJIT is enabled or not, we load yjit_hook.rb to remove Kernel#with_yjit.
4519#include "yjit_hook.rbinc"
4520
4521// Stub for builtin function when not building ZJIT units
4522#if !USE_ZJIT
4523void Init_builtin_zjit(void) {}
4524#endif
4525
4526/* top self */
4527
4528static VALUE
4529main_to_s(VALUE obj)
4530{
4531 return rb_str_new2("main");
4532}
4533
4534VALUE
4535rb_vm_top_self(void)
4536{
4537 return GET_VM()->top_self;
4538}
4539
4540void
4541Init_top_self(void)
4542{
4543 rb_vm_t *vm = GET_VM();
4544
4545 vm->top_self = rb_obj_alloc(rb_cObject);
4546 rb_define_singleton_method(rb_vm_top_self(), "to_s", main_to_s, 0);
4547 rb_define_alias(rb_singleton_class(rb_vm_top_self()), "inspect", "to_s");
4548}
4549
4550VALUE *
4552{
4553 rb_ractor_t *cr = GET_RACTOR();
4554 return &cr->verbose;
4555}
4556
4557VALUE *
4559{
4560 rb_ractor_t *cr = GET_RACTOR();
4561 return &cr->debug;
4562}
4563
4564bool rb_free_at_exit = false;
4565
4566bool
4567ruby_free_at_exit_p(void)
4568{
4569 return rb_free_at_exit;
4570}
4571
4572/* iseq.c */
4573VALUE rb_insn_operand_intern(const rb_iseq_t *iseq,
4574 VALUE insn, int op_no, VALUE op,
4575 int len, size_t pos, VALUE *pnop, VALUE child);
4576
4577#if VM_COLLECT_USAGE_DETAILS
4578
4579#define HASH_ASET(h, k, v) rb_hash_aset((h), (st_data_t)(k), (st_data_t)(v))
4580
4581/* uh = {
4582 * insn(Fixnum) => ihash(Hash)
4583 * }
4584 * ihash = {
4585 * -1(Fixnum) => count, # insn usage
4586 * 0(Fixnum) => ophash, # operand usage
4587 * }
4588 * ophash = {
4589 * val(interned string) => count(Fixnum)
4590 * }
4591 */
4592static void
4593vm_analysis_insn(int insn)
4594{
4595 ID usage_hash;
4596 ID bigram_hash;
4597 static int prev_insn = -1;
4598
4599 VALUE uh;
4600 VALUE ihash;
4601 VALUE cv;
4602
4603 CONST_ID(usage_hash, "USAGE_ANALYSIS_INSN");
4604 CONST_ID(bigram_hash, "USAGE_ANALYSIS_INSN_BIGRAM");
4605 uh = rb_const_get(rb_cRubyVM, usage_hash);
4606 if (NIL_P(ihash = rb_hash_aref(uh, INT2FIX(insn)))) {
4607 ihash = rb_hash_new();
4608 HASH_ASET(uh, INT2FIX(insn), ihash);
4609 }
4610 if (NIL_P(cv = rb_hash_aref(ihash, INT2FIX(-1)))) {
4611 cv = INT2FIX(0);
4612 }
4613 HASH_ASET(ihash, INT2FIX(-1), INT2FIX(FIX2INT(cv) + 1));
4614
4615 /* calc bigram */
4616 if (prev_insn != -1) {
4617 VALUE bi;
4618 VALUE ary[2];
4619 VALUE cv;
4620
4621 ary[0] = INT2FIX(prev_insn);
4622 ary[1] = INT2FIX(insn);
4623 bi = rb_ary_new4(2, &ary[0]);
4624
4625 uh = rb_const_get(rb_cRubyVM, bigram_hash);
4626 if (NIL_P(cv = rb_hash_aref(uh, bi))) {
4627 cv = INT2FIX(0);
4628 }
4629 HASH_ASET(uh, bi, INT2FIX(FIX2INT(cv) + 1));
4630 }
4631 prev_insn = insn;
4632}
4633
4634static void
4635vm_analysis_operand(int insn, int n, VALUE op)
4636{
4637 ID usage_hash;
4638
4639 VALUE uh;
4640 VALUE ihash;
4641 VALUE ophash;
4642 VALUE valstr;
4643 VALUE cv;
4644
4645 CONST_ID(usage_hash, "USAGE_ANALYSIS_INSN");
4646
4647 uh = rb_const_get(rb_cRubyVM, usage_hash);
4648 if (NIL_P(ihash = rb_hash_aref(uh, INT2FIX(insn)))) {
4649 ihash = rb_hash_new();
4650 HASH_ASET(uh, INT2FIX(insn), ihash);
4651 }
4652 if (NIL_P(ophash = rb_hash_aref(ihash, INT2FIX(n)))) {
4653 ophash = rb_hash_new();
4654 HASH_ASET(ihash, INT2FIX(n), ophash);
4655 }
4656 /* intern */
4657 valstr = rb_insn_operand_intern(GET_EC()->cfp->iseq, insn, n, op, 0, 0, 0, 0);
4658
4659 /* set count */
4660 if (NIL_P(cv = rb_hash_aref(ophash, valstr))) {
4661 cv = INT2FIX(0);
4662 }
4663 HASH_ASET(ophash, valstr, INT2FIX(FIX2INT(cv) + 1));
4664}
4665
4666static void
4667vm_analysis_register(int reg, int isset)
4668{
4669 ID usage_hash;
4670 VALUE uh;
4671 VALUE valstr;
4672 static const char regstrs[][5] = {
4673 "pc", /* 0 */
4674 "sp", /* 1 */
4675 "ep", /* 2 */
4676 "cfp", /* 3 */
4677 "self", /* 4 */
4678 "iseq", /* 5 */
4679 };
4680 static const char getsetstr[][4] = {
4681 "get",
4682 "set",
4683 };
4684 static VALUE syms[sizeof(regstrs) / sizeof(regstrs[0])][2];
4685
4686 VALUE cv;
4687
4688 CONST_ID(usage_hash, "USAGE_ANALYSIS_REGS");
4689 if (syms[0] == 0) {
4690 char buff[0x10];
4691 int i;
4692
4693 for (i = 0; i < (int)(sizeof(regstrs) / sizeof(regstrs[0])); i++) {
4694 int j;
4695 for (j = 0; j < 2; j++) {
4696 snprintf(buff, 0x10, "%d %s %-4s", i, getsetstr[j], regstrs[i]);
4697 syms[i][j] = ID2SYM(rb_intern(buff));
4698 }
4699 }
4700 }
4701 valstr = syms[reg][isset];
4702
4703 uh = rb_const_get(rb_cRubyVM, usage_hash);
4704 if (NIL_P(cv = rb_hash_aref(uh, valstr))) {
4705 cv = INT2FIX(0);
4706 }
4707 HASH_ASET(uh, valstr, INT2FIX(FIX2INT(cv) + 1));
4708}
4709
4710#undef HASH_ASET
4711
4712static void (*ruby_vm_collect_usage_func_insn)(int insn) = NULL;
4713static void (*ruby_vm_collect_usage_func_operand)(int insn, int n, VALUE op) = NULL;
4714static void (*ruby_vm_collect_usage_func_register)(int reg, int isset) = NULL;
4715
4716/* :nodoc: */
4717static VALUE
4718usage_analysis_insn_start(VALUE self)
4719{
4720 ruby_vm_collect_usage_func_insn = vm_analysis_insn;
4721 return Qnil;
4722}
4723
4724/* :nodoc: */
4725static VALUE
4726usage_analysis_operand_start(VALUE self)
4727{
4728 ruby_vm_collect_usage_func_operand = vm_analysis_operand;
4729 return Qnil;
4730}
4731
4732/* :nodoc: */
4733static VALUE
4734usage_analysis_register_start(VALUE self)
4735{
4736 ruby_vm_collect_usage_func_register = vm_analysis_register;
4737 return Qnil;
4738}
4739
4740/* :nodoc: */
4741static VALUE
4742usage_analysis_insn_stop(VALUE self)
4743{
4744 ruby_vm_collect_usage_func_insn = 0;
4745 return Qnil;
4746}
4747
4748/* :nodoc: */
4749static VALUE
4750usage_analysis_operand_stop(VALUE self)
4751{
4752 ruby_vm_collect_usage_func_operand = 0;
4753 return Qnil;
4754}
4755
4756/* :nodoc: */
4757static VALUE
4758usage_analysis_register_stop(VALUE self)
4759{
4760 ruby_vm_collect_usage_func_register = 0;
4761 return Qnil;
4762}
4763
4764/* :nodoc: */
4765static VALUE
4766usage_analysis_insn_running(VALUE self)
4767{
4768 return RBOOL(ruby_vm_collect_usage_func_insn != 0);
4769}
4770
4771/* :nodoc: */
4772static VALUE
4773usage_analysis_operand_running(VALUE self)
4774{
4775 return RBOOL(ruby_vm_collect_usage_func_operand != 0);
4776}
4777
4778/* :nodoc: */
4779static VALUE
4780usage_analysis_register_running(VALUE self)
4781{
4782 return RBOOL(ruby_vm_collect_usage_func_register != 0);
4783}
4784
4785static VALUE
4786usage_analysis_clear(VALUE self, ID usage_hash)
4787{
4788 VALUE uh;
4789 uh = rb_const_get(self, usage_hash);
4790 rb_hash_clear(uh);
4791
4792 return Qtrue;
4793}
4794
4795
4796/* :nodoc: */
4797static VALUE
4798usage_analysis_insn_clear(VALUE self)
4799{
4800 ID usage_hash;
4801 ID bigram_hash;
4802
4803 CONST_ID(usage_hash, "USAGE_ANALYSIS_INSN");
4804 CONST_ID(bigram_hash, "USAGE_ANALYSIS_INSN_BIGRAM");
4805 usage_analysis_clear(rb_cRubyVM, usage_hash);
4806 return usage_analysis_clear(rb_cRubyVM, bigram_hash);
4807}
4808
4809/* :nodoc: */
4810static VALUE
4811usage_analysis_operand_clear(VALUE self)
4812{
4813 ID usage_hash;
4814
4815 CONST_ID(usage_hash, "USAGE_ANALYSIS_INSN");
4816 return usage_analysis_clear(self, usage_hash);
4817}
4818
4819/* :nodoc: */
4820static VALUE
4821usage_analysis_register_clear(VALUE self)
4822{
4823 ID usage_hash;
4824
4825 CONST_ID(usage_hash, "USAGE_ANALYSIS_REGS");
4826 return usage_analysis_clear(self, usage_hash);
4827}
4828
4829#else
4830
4831MAYBE_UNUSED(static void (*ruby_vm_collect_usage_func_insn)(int insn)) = 0;
4832MAYBE_UNUSED(static void (*ruby_vm_collect_usage_func_operand)(int insn, int n, VALUE op)) = 0;
4833MAYBE_UNUSED(static void (*ruby_vm_collect_usage_func_register)(int reg, int isset)) = 0;
4834
4835#endif
4836
4837#if VM_COLLECT_USAGE_DETAILS
4838/* @param insn instruction number */
4839static void
4840vm_collect_usage_insn(int insn)
4841{
4842 if (RUBY_DTRACE_INSN_ENABLED()) {
4843 RUBY_DTRACE_INSN(rb_insns_name(insn));
4844 }
4845 if (ruby_vm_collect_usage_func_insn)
4846 (*ruby_vm_collect_usage_func_insn)(insn);
4847}
4848
4849/* @param insn instruction number
4850 * @param n n-th operand
4851 * @param op operand value
4852 */
4853static void
4854vm_collect_usage_operand(int insn, int n, VALUE op)
4855{
4856 if (RUBY_DTRACE_INSN_OPERAND_ENABLED()) {
4857 VALUE valstr;
4858
4859 valstr = rb_insn_operand_intern(GET_EC()->cfp->iseq, insn, n, op, 0, 0, 0, 0);
4860
4861 RUBY_DTRACE_INSN_OPERAND(RSTRING_PTR(valstr), rb_insns_name(insn));
4862 RB_GC_GUARD(valstr);
4863 }
4864 if (ruby_vm_collect_usage_func_operand)
4865 (*ruby_vm_collect_usage_func_operand)(insn, n, op);
4866}
4867
4868/* @param reg register id. see code of vm_analysis_register() */
4869/* @param isset 0: read, 1: write */
4870static void
4871vm_collect_usage_register(int reg, int isset)
4872{
4873 if (ruby_vm_collect_usage_func_register)
4874 (*ruby_vm_collect_usage_func_register)(reg, isset);
4875}
4876#endif
4877
4878const struct rb_callcache *
4879rb_vm_empty_cc(void)
4880{
4881 return &vm_empty_cc;
4882}
4883
4884const struct rb_callcache *
4885rb_vm_empty_cc_for_super(void)
4886{
4887 return &vm_empty_cc_for_super;
4888}
4889
4890#include "vm_call_iseq_optimized.inc" /* required from vm_insnhelper.c */
#define RUBY_ASSERT_MESG(expr,...)
Asserts that the expression is truthy.
Definition assert.h:186
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
Definition atomic.h:69
#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...
Definition atomic.h:93
#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.
Definition event.h:40
#define RUBY_EVENT_B_RETURN
Encountered a next statement.
Definition event.h:56
#define RUBY_EVENT_RETURN
Encountered a return statement.
Definition event.h:42
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
Definition event.h:44
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
@ RUBY_FL_SHAREABLE
This flag has something to do with Ractor.
Definition fl_type.h:280
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
Definition class.c:1484
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
Definition class.c:855
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
Definition class.c:2800
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
Definition class.c:2848
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
Definition class.c:2668
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1675
#define NUM2ULONG
Old name of RB_NUM2ULONG.
Definition long.h:52
#define ALLOCV
Old name of RB_ALLOCV.
Definition memory.h:404
#define ALLOC
Old name of RB_ALLOC.
Definition memory.h:400
#define xfree
Old name of ruby_xfree.
Definition xmalloc.h:58
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
Definition fl_type.h:134
#define ULONG2NUM
Old name of RB_ULONG2NUM.
Definition long.h:60
#define SYM2ID
Old name of RB_SYM2ID.
Definition symbol.h:45
#define ZALLOC
Old name of RB_ZALLOC.
Definition memory.h:402
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:205
#define rb_ary_new4
Old name of rb_ary_new_from_values.
Definition array.h:659
#define SIZET2NUM
Old name of RB_SIZE2NUM.
Definition size_t.h:62
#define rb_exc_new2
Old name of rb_exc_new_cstr.
Definition error.h:37
#define FIX2INT
Old name of RB_FIX2INT.
Definition int.h:41
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
#define ZALLOC_N
Old name of RB_ZALLOC_N.
Definition memory.h:401
#define ASSUME
Old name of RBIMPL_ASSUME.
Definition assume.h:27
#define T_ICLASS
Old name of RUBY_T_ICLASS.
Definition value_type.h:66
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
#define FL_SET
Old name of RB_FL_SET.
Definition fl_type.h:128
#define rb_exc_new3
Old name of rb_exc_new_str.
Definition error.h:38
#define ULL2NUM
Old name of RB_ULL2NUM.
Definition long_long.h:31
#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.
Definition long_long.h:35
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
#define FL_TEST
Old name of RB_FL_TEST.
Definition fl_type.h:130
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define FL_USHIFT
Old name of RUBY_FL_USHIFT.
Definition fl_type.h:68
#define CONST_ID
Old name of RUBY_CONST_ID.
Definition symbol.h:47
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
Definition fl_type.h:129
#define ALLOCV_END
Old name of RB_ALLOCV_END.
Definition memory.h:406
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition value_type.h:88
void ruby_init_stack(void *addr)
Set stack bottom of Ruby implementation.
Definition vm.c:4385
VALUE rb_eLocalJumpError
LocalJumpError exception.
Definition eval.c:48
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:476
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
Definition eval.c:682
int rb_typeddata_is_kind_of(VALUE obj, const rb_data_type_t *data_type)
Checks if the given object is of given kind.
Definition error.c:1380
void rb_iter_break(void)
Breaks from a block.
Definition vm.c:2111
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1430
void rb_iter_break_value(VALUE val)
Identical to rb_iter_break(), except it additionally takes the "value" of this breakage.
Definition vm.c:2117
VALUE rb_eRuntimeError
RuntimeError exception.
Definition error.c:1428
VALUE * rb_ruby_verbose_ptr(void)
This is an implementation detail of ruby_verbose.
Definition vm.c:4551
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.
Definition error.c:1481
VALUE * rb_ruby_debug_ptr(void)
This is an implementation detail of ruby_debug.
Definition vm.c:4558
VALUE rb_eSysStackError
SystemStackError exception.
Definition eval.c:49
@ RB_WARN_CATEGORY_PERFORMANCE
Warning is for performance issues (not enabled by -w).
Definition error.h:54
VALUE rb_cTime
Time class.
Definition time.c:679
VALUE rb_cArray
Array class.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
Definition object.c:2125
VALUE rb_cInteger
Module class.
Definition numeric.c:198
VALUE rb_cNilClass
NilClass class.
Definition object.c:67
VALUE rb_cBinding
Binding class.
Definition proc.c:44
VALUE rb_cRegexp
Regexp class.
Definition re.c:2662
VALUE rb_cHash
Hash class.
Definition hash.c:113
VALUE rb_cFalseClass
FalseClass class.
Definition object.c:69
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:243
VALUE rb_cSymbol
Symbol class.
Definition string.c:83
VALUE rb_cBasicObject
BasicObject class.
Definition object.c:60
VALUE rb_cThread
Thread class.
Definition vm.c:550
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
Definition object.c:1299
VALUE rb_cFloat
Float class.
Definition numeric.c:197
VALUE rb_cProc
Proc class.
Definition proc.c:45
VALUE rb_cTrueClass
TrueClass class.
Definition object.c:68
VALUE rb_cString
String class.
Definition string.c:82
#define RB_OBJ_WRITTEN(old, oldv, young)
Identical to RB_OBJ_WRITE(), except it doesn't write any values, but only a WB declaration.
Definition gc.h:615
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
Defines RBIMPL_HAS_BUILTIN.
VALUE rb_ary_delete_at(VALUE ary, long pos)
Destructively removes an element which resides at the specific index of the passed array.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
void rb_undef(VALUE mod, ID mid)
Inserts a method entry that hides previous method definition of the given name.
Definition vm_method.c:2040
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
VALUE rb_backref_get(void)
Queries the last match, or Regexp.last_match, or the $~.
Definition vm.c:1861
void rb_lastline_set(VALUE str)
Updates $_.
Definition vm.c:1879
VALUE rb_lastline_get(void)
Queries the last line, or the $_.
Definition vm.c:1873
void rb_backref_set(VALUE md)
Updates $~.
Definition vm.c:1867
VALUE rb_block_proc(void)
Constructs a Proc object from implicitly passed components.
Definition proc.c:847
VALUE rb_block_lambda(void)
Identical to rb_proc_new(), except it returns a lambda.
Definition proc.c:866
VALUE rb_binding_new(void)
Snapshots the current execution context and turn it into an instance of rb_cBinding.
Definition proc.c:329
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
Definition string.c:4102
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
Definition string.c:1839
#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.
Definition string.h:1656
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
Definition variable.c:3575
void rb_set_class_path(VALUE klass, VALUE space, const char *name)
Names a class.
Definition variable.c:434
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
Definition variable.c:383
void rb_alias_variable(ID dst, ID src)
Aliases a global variable.
Definition variable.c:1125
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
Definition variable.c:374
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1419
const char * rb_sourcefile(void)
Resembles __FILE__.
Definition vm.c:1898
void rb_alias(VALUE klass, ID dst, ID src)
Resembles alias.
Definition vm_method.c:2423
int rb_frame_method_id_and_class(ID *idp, VALUE *klassp)
Resembles __method__.
Definition vm.c:2928
int rb_sourceline(void)
Resembles __LINE__.
Definition vm.c:1912
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
Definition symbol.c:972
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
Definition variable.c:4151
VALUE rb_iv_set(VALUE obj, const char *name, VALUE val)
Assigns to an instance variable.
Definition variable.c:4636
int len
Length of the buffer.
Definition io.h:8
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...
Definition ractor.c:1414
static bool rb_ractor_shareable_p(VALUE obj)
Queries if multiple Ractors can share the passed object or not.
Definition ractor.h:249
#define RB_OBJ_SHAREABLE_P(obj)
Queries if the passed object has previously classified as shareable or not.
Definition ractor.h:235
VALUE rb_ractor_make_shareable(VALUE obj)
Destructively transforms the passed object so that multiple Ractors can share it.
Definition ractor.c:1405
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.
Definition vm.c:884
int ruby_vm_destruct(ruby_vm_t *vm)
Destructs the passed VM.
Definition vm.c:3138
VALUE rb_f_sprintf(int argc, const VALUE *argv)
Identical to rb_str_format(), except how the arguments are arranged.
Definition sprintf.c:209
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
Definition memory.h:372
#define MEMZERO(p, type, n)
Handy macro to erase a region of memory.
Definition memory.h:360
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
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.
Definition rarray.h:51
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
Definition rarray.h:281
#define RARRAY_AREF(a, i)
Definition rarray.h:403
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
Definition rbasic.h:163
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
Definition rhash.h:79
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
Definition rstring.h:76
#define RTYPEDDATA_DATA(v)
Convenient getter macro.
Definition rtypeddata.h:102
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
Definition rtypeddata.h:515
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
Definition rtypeddata.h:450
#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...
Definition rtypeddata.h:497
const char * rb_class2name(VALUE klass)
Queries the name of the passed class.
Definition variable.c:499
#define RB_NO_KEYWORDS
Do not pass keywords.
Definition scan_args.h:69
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.
Definition stdarg.h:35
Definition proc.c:30
Definition iseq.h:280
Definition method.h:63
CREF (Class REFerence)
Definition method.h:45
This is the struct that holds necessary info for a struct.
Definition rtypeddata.h:203
const char * wrap_struct_name
Name of structs of this kind.
Definition rtypeddata.h:210
Definition method.h:55
Internal header for Namespace.
Definition namespace.h:14
Definition st.h:79
IFUNC (Internal FUNCtion)
Definition imemo.h:87
THROW_DATA.
Definition imemo.h:60
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.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
Definition value_type.h:182
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
Definition value_type.h:433
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
ruby_value_type
C-level type of an object.
Definition value_type.h:113