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