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