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