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