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