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