1 /**********************************************************************
7 Copyright (C) 2004-2007 Koichi Sasada
9 **********************************************************************/
11 #define vm_exec rb_vm_exec
13 #include "eval_intern.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"
40 #include "vm_callinfo.h"
43 #include "vm_insnhelper.h"
44 #include "ractor_core.h"
51 #include "probes_helper.h"
53 #ifdef RUBY_ASSERT_CRITICAL_SECTION
54 int ruby_assert_critical_section_entered
= 0;
57 static void *native_main_thread_stack_top
;
59 VALUE
rb_str_concat_literals(size_t, const VALUE
*);
61 VALUE
vm_exec(rb_execution_context_t
*);
63 extern const char *const rb_debug_counter_names
[];
65 PUREFUNC(static inline const VALUE
*VM_EP_LEP(const VALUE
*));
66 static inline const VALUE
*
67 VM_EP_LEP(const VALUE
*ep
)
69 while (!VM_ENV_LOCAL_P(ep
)) {
70 ep
= VM_ENV_PREV_EP(ep
);
75 static inline const rb_control_frame_t
*
76 rb_vm_search_cf_from_ep(const rb_execution_context_t
*ec
, const rb_control_frame_t
*cfp
, const VALUE
* const ep
)
82 const rb_control_frame_t
* const eocfp
= RUBY_VM_END_CONTROL_FRAME(ec
); /* end of control frame pointer */
88 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
96 rb_vm_ep_local_ep(const VALUE
*ep
)
101 PUREFUNC(static inline const VALUE
*VM_CF_LEP(const rb_control_frame_t
* const cfp
));
102 static inline const VALUE
*
103 VM_CF_LEP(const rb_control_frame_t
* const cfp
)
105 return VM_EP_LEP(cfp
->ep
);
108 static inline const VALUE
*
109 VM_CF_PREV_EP(const rb_control_frame_t
* const cfp
)
111 return VM_ENV_PREV_EP(cfp
->ep
);
114 PUREFUNC(static inline VALUE
VM_CF_BLOCK_HANDLER(const rb_control_frame_t
* const cfp
));
116 VM_CF_BLOCK_HANDLER(const rb_control_frame_t
* const cfp
)
118 const VALUE
*ep
= VM_CF_LEP(cfp
);
119 return VM_ENV_BLOCK_HANDLER(ep
);
123 rb_vm_cframe_keyword_p(const rb_control_frame_t
*cfp
)
125 return VM_FRAME_CFRAME_KW_P(cfp
);
129 rb_vm_frame_block_handler(const rb_control_frame_t
*cfp
)
131 return VM_CF_BLOCK_HANDLER(cfp
);
134 #if VM_CHECK_MODE > 0
136 VM_CFP_IN_HEAP_P(const rb_execution_context_t
*ec
, const rb_control_frame_t
*cfp
)
138 const VALUE
*start
= ec
->vm_stack
;
139 const VALUE
*end
= (VALUE
*)ec
->vm_stack
+ ec
->vm_stack_size
;
140 VM_ASSERT(start
!= NULL
);
142 if (start
<= (VALUE
*)cfp
&& (VALUE
*)cfp
< end
) {
151 VM_EP_IN_HEAP_P(const rb_execution_context_t
*ec
, const VALUE
*ep
)
153 const VALUE
*start
= ec
->vm_stack
;
154 const VALUE
*end
= (VALUE
*)ec
->cfp
;
155 VM_ASSERT(start
!= NULL
);
157 if (start
<= ep
&& ep
< end
) {
166 vm_ep_in_heap_p_(const rb_execution_context_t
*ec
, const VALUE
*ep
)
168 if (VM_EP_IN_HEAP_P(ec
, ep
)) {
169 VALUE envval
= ep
[VM_ENV_DATA_INDEX_ENV
]; /* VM_ENV_ENVVAL(ep); */
171 if (!UNDEF_P(envval
)) {
172 const rb_env_t
*env
= (const rb_env_t
*)envval
;
174 VM_ASSERT(vm_assert_env(envval
));
175 VM_ASSERT(VM_ENV_FLAGS(ep
, VM_ENV_FLAG_ESCAPED
));
176 VM_ASSERT(env
->ep
== ep
);
186 rb_vm_ep_in_heap_p(const VALUE
*ep
)
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
);
194 static struct rb_captured_block
*
195 VM_CFP_TO_CAPTURED_BLOCK(const rb_control_frame_t
*cfp
)
197 VM_ASSERT(!VM_CFP_IN_HEAP_P(GET_EC(), cfp
));
198 return (struct rb_captured_block
*)&cfp
->self
;
201 static rb_control_frame_t
*
202 VM_CAPTURED_BLOCK_TO_CFP(const struct rb_captured_block
*captured
)
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);
211 VM_BH_FROM_CFP_P(VALUE block_handler
, const rb_control_frame_t
*cfp
)
213 const struct rb_captured_block
*captured
= VM_CFP_TO_CAPTURED_BLOCK(cfp
);
214 return VM_TAGGED_PTR_REF(block_handler
, 0x03) == captured
;
218 vm_passed_block_handler(rb_execution_context_t
*ec
)
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
;
227 vm_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
)
229 VALUE refinements
= Qnil
;
230 int omod_shared
= FALSE
;
234 rb_scope_visibility_t visi
;
238 scope_visi
.visi
.method_visi
= visi
;
239 scope_visi
.visi
.module_func
= module_func
;
242 if (prev_cref
!= NULL
&& prev_cref
!= (void *)1 /* TODO: why CREF_NEXT(cref) is 1? */) {
243 refinements
= CREF_REFINEMENTS(prev_cref
);
245 if (!NIL_P(refinements
)) {
247 CREF_OMOD_SHARED_SET(prev_cref
);
251 VM_ASSERT(singleton
|| klass
);
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
;
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
);
266 vm_cref_new(VALUE klass
, rb_method_visibility_t visi
, int module_func
, rb_cref_t
*prev_cref
, int pushed_by_eval
, int singleton
)
268 return vm_cref_new0(klass
, visi
, module_func
, prev_cref
, pushed_by_eval
, FALSE
, singleton
);
272 vm_cref_new_use_prev(VALUE klass
, rb_method_visibility_t visi
, int module_func
, rb_cref_t
*prev_cref
, int pushed_by_eval
)
274 return vm_cref_new0(klass
, visi
, module_func
, prev_cref
, pushed_by_eval
, TRUE
, FALSE
);
278 ref_delete_symkey(VALUE key
, VALUE value
, VALUE unused
)
280 return SYMBOL_P(key
) ? ST_DELETE
: ST_CONTINUE
;
284 vm_cref_dup(const rb_cref_t
*cref
)
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
);
291 new_cref
= vm_cref_new(cref
->klass_or_self
, visi
->method_visi
, visi
->module_func
, next_cref
, pushed_by_eval
, singleton
);
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
);
305 rb_vm_cref_dup_without_refinements(const rb_cref_t
*cref
)
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
);
312 new_cref
= vm_cref_new(cref
->klass_or_self
, visi
->method_visi
, visi
->module_func
, next_cref
, pushed_by_eval
, singleton
);
314 if (!NIL_P(CREF_REFINEMENTS(cref
))) {
315 CREF_REFINEMENTS_SET(new_cref
, Qnil
);
316 CREF_OMOD_SHARED_UNSET(new_cref
);
323 vm_cref_new_toplevel(rb_execution_context_t
*ec
)
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
;
329 cref
= vm_cref_new(top_wrapper
, METHOD_VISI_PRIVATE
, FALSE
, cref
, FALSE
, FALSE
);
336 rb_vm_cref_new_toplevel(void)
338 return vm_cref_new_toplevel(GET_EC());
342 vm_cref_dump(const char *mesg
, const rb_cref_t
*cref
)
344 ruby_debug_printf("vm_cref_dump: %s (%p)\n", mesg
, (void *)cref
);
347 ruby_debug_printf("= cref| klass: %s\n", RSTRING_PTR(rb_class_path(CREF_CLASS(cref
))));
348 cref
= CREF_NEXT(cref
);
353 rb_vm_block_ep_update(VALUE obj
, const struct rb_block
*dst
, const VALUE
*ep
)
355 *((const VALUE
**)&dst
->as
.captured
.ep
) = ep
;
356 RB_OBJ_WRITTEN(obj
, Qundef
, VM_ENV_ENVVAL(ep
));
360 vm_bind_update_env(VALUE bindval
, rb_binding_t
*bind
, VALUE envval
)
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
);
367 #if VM_COLLECT_USAGE_DETAILS
368 static void vm_collect_usage_operand(int insn
, int n
, VALUE op
);
369 static void vm_collect_usage_insn(int insn
);
370 static void vm_collect_usage_register(int reg
, int isset
);
373 static VALUE
vm_make_env_object(const rb_execution_context_t
*ec
, rb_control_frame_t
*cfp
);
374 extern VALUE
rb_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
,
376 const rb_callable_method_entry_t
*me
);
377 static 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
);
380 // Counter to serve as a proxy for execution time, total number of calls
381 static uint64_t yjit_total_entry_hits
= 0;
383 // Number of calls used to estimate how hot an ISEQ is
384 #define YJIT_CALL_COUNT_INTERV 20u
386 /// Test whether we are ready to compile an ISEQ or not
388 rb_yjit_threshold_hit(const rb_iseq_t
*iseq
, uint64_t entry_calls
)
390 yjit_total_entry_hits
+= 1;
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
;
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
) {
405 uint64_t num_calls
= yjit_total_entry_hits
- iseq
->body
->yjit_calls_at_interv
;
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");
419 #define rb_yjit_threshold_hit(iseq, entry_calls) false
422 #if USE_RJIT || 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.
431 static inline rb_jit_func_t
432 jit_compile(rb_execution_context_t
*ec
)
434 const rb_iseq_t
*iseq
= ec
->cfp
->iseq
;
435 struct rb_iseq_constant_body
*body
= ISEQ_BODY(iseq
);
436 bool yjit_enabled
= rb_yjit_enabled_p
;
437 if (!(yjit_enabled
|| rb_rjit_call_p
)) {
441 // Increment the ISEQ's call counter and trigger JIT compilation if not compiled
442 if (body
->jit_entry
== NULL
) {
443 body
->jit_entry_calls
++;
445 if (rb_yjit_threshold_hit(iseq
, body
->jit_entry_calls
)) {
446 rb_yjit_compile_iseq(iseq
, ec
, false);
449 else if (body
->jit_entry_calls
== rb_rjit_call_threshold()) {
450 rb_rjit_compile(iseq
);
453 return body
->jit_entry
;
456 // Execute JIT code compiled by jit_compile()
458 jit_exec(rb_execution_context_t
*ec
)
460 rb_jit_func_t func
= jit_compile(ec
);
463 return func(ec
, ec
->cfp
);
470 # define jit_compile(ec) ((rb_jit_func_t)0)
471 # define jit_exec(ec) Qundef
475 // Generate JIT code that supports the following kind of ISEQ entry:
476 // * The first ISEQ pushed by vm_exec_handle_exception. The frame would
477 // point to a location specified by a catch table, and it doesn't have
478 // VM_FRAME_FLAG_FINISH. The current vm_exec stops if JIT code returns
479 // a non-Qundef value. So you should not return a non-Qundef value
480 // until ec->cfp is changed to a frame with VM_FRAME_FLAG_FINISH.
481 static inline rb_jit_func_t
482 jit_compile_exception(rb_execution_context_t
*ec
)
484 const rb_iseq_t
*iseq
= ec
->cfp
->iseq
;
485 struct rb_iseq_constant_body
*body
= ISEQ_BODY(iseq
);
486 if (!rb_yjit_enabled_p
) {
490 // Increment the ISEQ's call counter and trigger JIT compilation if not compiled
491 if (body
->jit_exception
== NULL
) {
492 body
->jit_exception_calls
++;
493 if (body
->jit_exception_calls
== rb_yjit_call_threshold
) {
494 rb_yjit_compile_iseq(iseq
, ec
, true);
498 return body
->jit_exception
;
501 // Execute JIT code compiled by jit_compile_exception()
503 jit_exec_exception(rb_execution_context_t
*ec
)
505 rb_jit_func_t func
= jit_compile_exception(ec
);
508 return func(ec
, ec
->cfp
);
515 # define jit_compile_exception(ec) ((rb_jit_func_t)0)
516 # define jit_exec_exception(ec) Qundef
519 static void add_opt_method_entry(const rb_method_entry_t
*me
);
521 #include "vm_insnhelper.c"
525 #include "vm_method.c"
532 VALUE rb_mRubyVMFrozenCore
;
533 VALUE rb_block_param_proxy
;
535 VALUE ruby_vm_const_missing_count
= 0;
536 rb_vm_t
*ruby_current_vm_ptr
= NULL
;
537 rb_ractor_t
*ruby_single_main_ractor
;
538 bool ruby_vm_keep_script_lines
;
540 #ifdef RB_THREAD_LOCAL_SPECIFIER
541 RB_THREAD_LOCAL_SPECIFIER rb_execution_context_t
*ruby_current_ec
;
543 #ifdef RUBY_NT_SERIAL
544 RB_THREAD_LOCAL_SPECIFIER rb_atomic_t ruby_nt_serial
;
547 // no-inline decl on thread_pthread.h
548 rb_execution_context_t
*
549 rb_current_ec_noinline(void)
551 return ruby_current_ec
;
555 rb_current_ec_set(rb_execution_context_t
*ec
)
557 ruby_current_ec
= ec
;
562 rb_execution_context_t
*
565 return ruby_current_ec
;
570 native_tls_key_t ruby_current_ec_key
;
573 rb_event_flag_t ruby_vm_event_flags
;
574 rb_event_flag_t ruby_vm_event_enabled_global_flags
;
575 unsigned int ruby_vm_event_local_num
;
577 rb_serial_t ruby_vm_constant_cache_invalidations
= 0;
578 rb_serial_t ruby_vm_constant_cache_misses
= 0;
579 rb_serial_t ruby_vm_global_cvar_state
= 1;
581 static const struct rb_callcache vm_empty_cc
= {
582 .flags
= T_IMEMO
| (imemo_callcache
<< FL_USHIFT
) | VM_CALLCACHE_UNMARKABLE
,
585 .call_
= vm_call_general
,
591 static const struct rb_callcache vm_empty_cc_for_super
= {
592 .flags
= T_IMEMO
| (imemo_callcache
<< FL_USHIFT
) | VM_CALLCACHE_UNMARKABLE
,
595 .call_
= vm_call_super_method
,
601 static void thread_free(void *ptr
);
604 rb_vm_inc_const_missing_count(void)
606 ruby_vm_const_missing_count
+=1;
610 rb_dtrace_setup(rb_execution_context_t
*ec
, VALUE klass
, ID id
,
611 struct ruby_dtrace_method_hook_args
*args
)
613 enum ruby_value_type type
;
615 if (!ec
) ec
= GET_EC();
616 if (!rb_ec_frame_method_id_and_class(ec
, &id
, 0, &klass
) || !klass
)
619 if (RB_TYPE_P(klass
, T_ICLASS
)) {
620 klass
= RBASIC(klass
)->klass
;
622 else if (RCLASS_SINGLETON_P(klass
)) {
623 klass
= RCLASS_ATTACHED_OBJECT(klass
);
624 if (NIL_P(klass
)) return FALSE
;
626 type
= BUILTIN_TYPE(klass
);
627 if (type
== T_CLASS
|| type
== T_ICLASS
|| type
== T_MODULE
) {
628 VALUE name
= rb_class_path(klass
);
629 const char *classname
, *filename
;
630 const char *methodname
= rb_id2name(id
);
631 if (methodname
&& (filename
= rb_source_location_cstr(&args
->line_no
)) != 0) {
632 if (NIL_P(name
) || !(classname
= StringValuePtr(name
)))
633 classname
= "<unknown>";
634 args
->classname
= classname
;
635 args
->methodname
= methodname
;
636 args
->filename
= filename
;
645 extern unsigned int redblack_buffer_size
;
649 * RubyVM.stat -> Hash
650 * RubyVM.stat(hsh) -> hsh
651 * RubyVM.stat(Symbol) -> Numeric
653 * Returns a Hash containing implementation-dependent counters inside the VM.
655 * This hash includes information about method/constant caches:
658 * :constant_cache_invalidations=>2,
659 * :constant_cache_misses=>14,
660 * :global_cvar_state=>27
663 * If <tt>USE_DEBUG_COUNTER</tt> is enabled, debug counters will be included.
665 * The contents of the hash are implementation specific and may be changed in
668 * This method is only expected to work on C Ruby.
671 vm_stat(int argc
, VALUE
*argv
, VALUE self
)
673 static VALUE sym_constant_cache_invalidations
, sym_constant_cache_misses
, sym_global_cvar_state
, sym_next_shape_id
;
674 static VALUE sym_shape_cache_size
;
676 VALUE hash
= Qnil
, key
= Qnil
;
678 if (rb_check_arity(argc
, 0, 1) == 1) {
682 else if (RB_TYPE_P(arg
, T_HASH
))
685 rb_raise(rb_eTypeError
, "non-hash or symbol given");
688 hash
= rb_hash_new();
691 #define S(s) sym_##s = ID2SYM(rb_intern_const(#s))
692 S(constant_cache_invalidations
);
693 S(constant_cache_misses
);
694 S(global_cvar_state
);
699 #define SET(name, attr) \
700 if (key == sym_##name) \
701 return SERIALT2NUM(attr); \
702 else if (hash != Qnil) \
703 rb_hash_aset(hash, sym_##name, SERIALT2NUM(attr));
705 SET(constant_cache_invalidations
, ruby_vm_constant_cache_invalidations
);
706 SET(constant_cache_misses
, ruby_vm_constant_cache_misses
);
707 SET(global_cvar_state
, ruby_vm_global_cvar_state
);
708 SET(next_shape_id
, (rb_serial_t
)GET_SHAPE_TREE()->next_shape_id
);
709 SET(shape_cache_size
, (rb_serial_t
)GET_SHAPE_TREE()->cache_size
);
712 #if USE_DEBUG_COUNTER
713 ruby_debug_counter_show_at_exit(FALSE
);
714 for (size_t i
= 0; i
< RB_DEBUG_COUNTER_MAX
; i
++) {
715 const VALUE name
= rb_sym_intern_ascii_cstr(rb_debug_counter_names
[i
]);
716 const VALUE boxed_value
= SIZET2NUM(rb_debug_counter
[i
]);
721 else if (hash
!= Qnil
) {
722 rb_hash_aset(hash
, name
, boxed_value
);
727 if (!NIL_P(key
)) { /* matched key should return above */
728 rb_raise(rb_eArgError
, "unknown key: %"PRIsVALUE
, rb_sym2str(key
));
734 /* control stack frame */
737 vm_set_top_stack(rb_execution_context_t
*ec
, const rb_iseq_t
*iseq
)
739 if (ISEQ_BODY(iseq
)->type
!= ISEQ_TYPE_TOP
) {
740 rb_raise(rb_eTypeError
, "Not a toplevel InstructionSequence");
744 vm_push_frame(ec
, iseq
, VM_FRAME_MAGIC_TOP
| VM_ENV_FLAG_LOCAL
| VM_FRAME_FLAG_FINISH
, rb_ec_thread_ptr(ec
)->top_self
,
745 VM_BLOCK_HANDLER_NONE
,
746 (VALUE
)vm_cref_new_toplevel(ec
), /* cref or me */
747 ISEQ_BODY(iseq
)->iseq_encoded
, ec
->cfp
->sp
,
748 ISEQ_BODY(iseq
)->local_table_size
, ISEQ_BODY(iseq
)->stack_max
);
752 vm_set_eval_stack(rb_execution_context_t
*ec
, const rb_iseq_t
*iseq
, const rb_cref_t
*cref
, const struct rb_block
*base_block
)
754 vm_push_frame(ec
, iseq
, VM_FRAME_MAGIC_EVAL
| VM_FRAME_FLAG_FINISH
,
755 vm_block_self(base_block
), VM_GUARDED_PREV_EP(vm_block_ep(base_block
)),
756 (VALUE
)cref
, /* cref or me */
757 ISEQ_BODY(iseq
)->iseq_encoded
,
758 ec
->cfp
->sp
, ISEQ_BODY(iseq
)->local_table_size
,
759 ISEQ_BODY(iseq
)->stack_max
);
763 vm_set_main_stack(rb_execution_context_t
*ec
, const rb_iseq_t
*iseq
)
765 VALUE toplevel_binding
= rb_const_get(rb_cObject
, rb_intern("TOPLEVEL_BINDING"));
768 GetBindingPtr(toplevel_binding
, bind
);
769 RUBY_ASSERT_MESG(bind
, "TOPLEVEL_BINDING is not built");
771 vm_set_eval_stack(ec
, iseq
, 0, &bind
->block
);
774 if (ISEQ_BODY(iseq
)->local_table_size
> 0) {
775 vm_bind_update_env(toplevel_binding
, bind
, vm_make_env_object(ec
, ec
->cfp
));
780 rb_vm_get_binding_creatable_next_cfp(const rb_execution_context_t
*ec
, const rb_control_frame_t
*cfp
)
782 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec
, cfp
)) {
784 return (rb_control_frame_t
*)cfp
;
786 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
792 rb_vm_get_ruby_level_next_cfp(const rb_execution_context_t
*ec
, const rb_control_frame_t
*cfp
)
794 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec
, cfp
)) {
795 if (VM_FRAME_RUBYFRAME_P(cfp
)) {
796 return (rb_control_frame_t
*)cfp
;
798 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
803 static rb_control_frame_t
*
804 vm_get_ruby_level_caller_cfp(const rb_execution_context_t
*ec
, const rb_control_frame_t
*cfp
)
806 if (VM_FRAME_RUBYFRAME_P(cfp
)) {
807 return (rb_control_frame_t
*)cfp
;
810 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
812 while (!RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec
, cfp
)) {
813 if (VM_FRAME_RUBYFRAME_P(cfp
)) {
814 return (rb_control_frame_t
*)cfp
;
817 if (VM_ENV_FLAGS(cfp
->ep
, VM_FRAME_FLAG_PASSED
) == FALSE
) {
820 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
826 rb_vm_pop_cfunc_frame(void)
828 rb_execution_context_t
*ec
= GET_EC();
829 rb_control_frame_t
*cfp
= ec
->cfp
;
830 const rb_callable_method_entry_t
*me
= rb_vm_frame_method_entry(cfp
);
832 EXEC_EVENT_HOOK(ec
, RUBY_EVENT_C_RETURN
, cfp
->self
, me
->def
->original_id
, me
->called_id
, me
->owner
, Qnil
);
833 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec
, me
->owner
, me
->def
->original_id
);
834 vm_pop_frame(ec
, cfp
, cfp
->ep
);
838 rb_vm_rewind_cfp(rb_execution_context_t
*ec
, rb_control_frame_t
*cfp
)
840 /* check skipped frame */
841 while (ec
->cfp
!= cfp
) {
843 printf("skipped frame: %s\n", vm_frametype_name(ec
->cfp
));
845 if (VM_FRAME_TYPE(ec
->cfp
) != VM_FRAME_MAGIC_CFUNC
) {
848 else { /* unlikely path */
849 rb_vm_pop_cfunc_frame();
857 ruby_vm_at_exit(void (*func
)(rb_vm_t
*))
859 rb_vm_t
*vm
= GET_VM();
860 rb_at_exit_list
*nl
= ALLOC(rb_at_exit_list
);
862 nl
->next
= vm
->at_exit
;
867 ruby_vm_run_at_exit_hooks(rb_vm_t
*vm
)
869 rb_at_exit_list
*l
= vm
->at_exit
;
872 rb_at_exit_list
* t
= l
->next
;
873 rb_vm_at_exit_func
*func
= l
->func
;
882 static VALUE
check_env_value(const rb_env_t
*env
);
885 check_env(const rb_env_t
*env
)
887 fputs("---\n", stderr
);
888 ruby_debug_printf("envptr: %p\n", (void *)&env
->ep
[0]);
889 ruby_debug_printf("envval: %10p ", (void *)env
->ep
[1]);
891 ruby_debug_printf("ep: %10p\n", (void *)env
->ep
);
892 if (rb_vm_env_prev_env(env
)) {
893 fputs(">>\n", stderr
);
894 check_env_value(rb_vm_env_prev_env(env
));
895 fputs("<<\n", stderr
);
901 check_env_value(const rb_env_t
*env
)
903 if (check_env(env
)) {
906 rb_bug("invalid env");
907 return Qnil
; /* unreachable */
911 vm_block_handler_escape(const rb_execution_context_t
*ec
, VALUE block_handler
)
913 switch (vm_block_handler_type(block_handler
)) {
914 case block_handler_type_ifunc
:
915 case block_handler_type_iseq
:
916 return rb_vm_make_proc(ec
, VM_BH_TO_CAPT_BLOCK(block_handler
), rb_cProc
);
918 case block_handler_type_symbol
:
919 case block_handler_type_proc
:
920 return block_handler
;
922 VM_UNREACHABLE(vm_block_handler_escape
);
927 vm_make_env_each(const rb_execution_context_t
* const ec
, rb_control_frame_t
*const cfp
)
929 const VALUE
* const ep
= cfp
->ep
;
930 VALUE
*env_body
, *env_ep
;
931 int local_size
, env_size
;
933 if (VM_ENV_ESCAPED_P(ep
)) {
934 return VM_ENV_ENVVAL(ep
);
937 if (!VM_ENV_LOCAL_P(ep
)) {
938 const VALUE
*prev_ep
= VM_ENV_PREV_EP(ep
);
939 if (!VM_ENV_ESCAPED_P(prev_ep
)) {
940 rb_control_frame_t
*prev_cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
942 while (prev_cfp
->ep
!= prev_ep
) {
943 prev_cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(prev_cfp
);
944 VM_ASSERT(prev_cfp
->ep
!= NULL
);
947 vm_make_env_each(ec
, prev_cfp
);
948 VM_FORCE_WRITE_SPECIAL_CONST(&ep
[VM_ENV_DATA_INDEX_SPECVAL
], VM_GUARDED_PREV_EP(prev_cfp
->ep
));
952 VALUE block_handler
= VM_ENV_BLOCK_HANDLER(ep
);
954 if (block_handler
!= VM_BLOCK_HANDLER_NONE
) {
955 VALUE blockprocval
= vm_block_handler_escape(ec
, block_handler
);
956 VM_STACK_ENV_WRITE(ep
, VM_ENV_DATA_INDEX_SPECVAL
, blockprocval
);
960 if (!VM_FRAME_RUBYFRAME_P(cfp
)) {
961 local_size
= VM_ENV_DATA_SIZE
;
964 local_size
= ISEQ_BODY(cfp
->iseq
)->local_table_size
+ VM_ENV_DATA_SIZE
;
968 * # local variables on a stack frame (N == local_size)
969 * [lvar1, lvar2, ..., lvarN, SPECVAL]
973 * # moved local variables
974 * [lvar1, lvar2, ..., lvarN, SPECVAL, Envval, BlockProcval (if needed)]
979 env_size
= local_size
+
982 // Careful with order in the following sequence. Each allocation can move objects.
983 env_body
= ALLOC_N(VALUE
, env_size
);
984 rb_env_t
*env
= IMEMO_NEW(rb_env_t
, imemo_env
, 0);
986 // Set up env without WB since it's brand new (similar to newobj_init(), newobj_fill())
987 MEMCPY(env_body
, ep
- (local_size
- 1 /* specval */), VALUE
, local_size
);
989 env_ep
= &env_body
[local_size
- 1 /* specval */];
990 env_ep
[VM_ENV_DATA_INDEX_ENV
] = (VALUE
)env
;
992 env
->iseq
= (rb_iseq_t
*)(VM_FRAME_RUBYFRAME_P(cfp
) ? cfp
->iseq
: NULL
);
995 env
->env_size
= env_size
;
998 VM_ENV_FLAGS_SET(env_ep
, VM_ENV_FLAG_ESCAPED
| VM_ENV_FLAG_WB_REQUIRED
);
999 VM_STACK_ENV_WRITE(ep
, 0, (VALUE
)env
); /* GC mark */
1002 for (i
= 0; i
< local_size
; i
++) {
1003 if (VM_FRAME_RUBYFRAME_P(cfp
)) {
1004 /* clear value stack for GC */
1005 ep
[-local_size
+ i
] = 0;
1010 // Invalidate JIT code that assumes cfp->ep == vm_base_ptr(cfp).
1012 rb_yjit_invalidate_ep_is_bp(env
->iseq
);
1019 vm_make_env_object(const rb_execution_context_t
*ec
, rb_control_frame_t
*cfp
)
1021 VALUE envval
= vm_make_env_each(ec
, cfp
);
1024 check_env_value((const rb_env_t
*)envval
);
1031 rb_vm_stack_to_heap(rb_execution_context_t
*ec
)
1033 rb_control_frame_t
*cfp
= ec
->cfp
;
1034 while ((cfp
= rb_vm_get_binding_creatable_next_cfp(ec
, cfp
)) != 0) {
1035 vm_make_env_object(ec
, cfp
);
1036 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
1041 rb_vm_env_prev_env(const rb_env_t
*env
)
1043 const VALUE
*ep
= env
->ep
;
1045 if (VM_ENV_LOCAL_P(ep
)) {
1049 const VALUE
*prev_ep
= VM_ENV_PREV_EP(ep
);
1050 return VM_ENV_ENVVAL_PTR(prev_ep
);
1055 collect_local_variables_in_iseq(const rb_iseq_t
*iseq
, const struct local_var_list
*vars
)
1058 if (!iseq
) return 0;
1059 for (i
= 0; i
< ISEQ_BODY(iseq
)->local_table_size
; i
++) {
1060 local_var_list_add(vars
, ISEQ_BODY(iseq
)->local_table
[i
]);
1066 collect_local_variables_in_env(const rb_env_t
*env
, const struct local_var_list
*vars
)
1069 if (VM_ENV_FLAGS(env
->ep
, VM_ENV_FLAG_ISOLATED
)) break;
1070 collect_local_variables_in_iseq(env
->iseq
, vars
);
1071 } while ((env
= rb_vm_env_prev_env(env
)) != NULL
);
1075 vm_collect_local_variables_in_heap(const VALUE
*ep
, const struct local_var_list
*vars
)
1077 if (VM_ENV_ESCAPED_P(ep
)) {
1078 collect_local_variables_in_env(VM_ENV_ENVVAL_PTR(ep
), vars
);
1087 rb_vm_env_local_variables(const rb_env_t
*env
)
1089 struct local_var_list vars
;
1090 local_var_list_init(&vars
);
1091 collect_local_variables_in_env(env
, &vars
);
1092 return local_var_list_finish(&vars
);
1096 rb_iseq_local_variables(const rb_iseq_t
*iseq
)
1098 struct local_var_list vars
;
1099 local_var_list_init(&vars
);
1100 while (collect_local_variables_in_iseq(iseq
, &vars
)) {
1101 iseq
= ISEQ_BODY(iseq
)->parent_iseq
;
1103 return local_var_list_finish(&vars
);
1109 vm_proc_create_from_captured(VALUE klass
,
1110 const struct rb_captured_block
*captured
,
1111 enum rb_block_type block_type
,
1112 int8_t is_from_method
, int8_t is_lambda
)
1114 VALUE procval
= rb_proc_alloc(klass
);
1115 rb_proc_t
*proc
= RTYPEDDATA_DATA(procval
);
1117 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), captured
->ep
));
1120 RB_OBJ_WRITE(procval
, &proc
->block
.as
.captured
.code
.val
, captured
->code
.val
);
1121 RB_OBJ_WRITE(procval
, &proc
->block
.as
.captured
.self
, captured
->self
);
1122 rb_vm_block_ep_update(procval
, &proc
->block
, captured
->ep
);
1124 vm_block_type_set(&proc
->block
, block_type
);
1125 proc
->is_from_method
= is_from_method
;
1126 proc
->is_lambda
= is_lambda
;
1132 rb_vm_block_copy(VALUE obj
, const struct rb_block
*dst
, const struct rb_block
*src
)
1135 switch (vm_block_type(src
)) {
1136 case block_type_iseq
:
1137 case block_type_ifunc
:
1138 RB_OBJ_WRITE(obj
, &dst
->as
.captured
.self
, src
->as
.captured
.self
);
1139 RB_OBJ_WRITE(obj
, &dst
->as
.captured
.code
.val
, src
->as
.captured
.code
.val
);
1140 rb_vm_block_ep_update(obj
, dst
, src
->as
.captured
.ep
);
1142 case block_type_symbol
:
1143 RB_OBJ_WRITE(obj
, &dst
->as
.symbol
, src
->as
.symbol
);
1145 case block_type_proc
:
1146 RB_OBJ_WRITE(obj
, &dst
->as
.proc
, src
->as
.proc
);
1152 proc_create(VALUE klass
, const struct rb_block
*block
, int8_t is_from_method
, int8_t is_lambda
)
1154 VALUE procval
= rb_proc_alloc(klass
);
1155 rb_proc_t
*proc
= RTYPEDDATA_DATA(procval
);
1157 VM_ASSERT(VM_EP_IN_HEAP_P(GET_EC(), vm_block_ep(block
)));
1158 rb_vm_block_copy(procval
, &proc
->block
, block
);
1159 vm_block_type_set(&proc
->block
, block
->type
);
1160 proc
->is_from_method
= is_from_method
;
1161 proc
->is_lambda
= is_lambda
;
1167 rb_proc_dup(VALUE self
)
1172 GetProcPtr(self
, src
);
1173 procval
= proc_create(rb_obj_class(self
), &src
->block
, src
->is_from_method
, src
->is_lambda
);
1174 if (RB_OBJ_SHAREABLE_P(self
)) FL_SET_RAW(procval
, RUBY_FL_SHAREABLE
);
1175 RB_GC_GUARD(self
); /* for: body = rb_proc_dup(body) */
1179 struct collect_outer_variable_name_data
{
1189 if (SIZEOF_VOIDP
> SIZEOF_LONG
)
1192 return ULONG2NUM(id
);
1198 if (SIZEOF_VOIDP
> SIZEOF_LONG
)
1199 return (ID
)NUM2ULL(num
);
1201 return (ID
)NUM2ULONG(num
);
1204 static enum rb_id_table_iterator_result
1205 collect_outer_variable_names(ID id
, VALUE val
, void *ptr
)
1207 struct collect_outer_variable_name_data
*data
= (struct collect_outer_variable_name_data
*)ptr
;
1209 if (id
== rb_intern("yield")) {
1214 if (data
->isolate
||
1215 val
== Qtrue
/* write */) {
1219 store
= &data
->read_only
;
1221 if (*store
== Qfalse
) *store
= rb_ary_new();
1222 rb_ary_push(*store
, ID2NUM(id
));
1224 return ID_TABLE_CONTINUE
;
1227 static const rb_env_t
*
1228 env_copy(const VALUE
*src_ep
, VALUE read_only_variables
)
1230 const rb_env_t
*src_env
= (rb_env_t
*)VM_ENV_ENVVAL(src_ep
);
1231 VM_ASSERT(src_env
->ep
== src_ep
);
1233 VALUE
*env_body
= ZALLOC_N(VALUE
, src_env
->env_size
); // fill with Qfalse
1234 VALUE
*ep
= &env_body
[src_env
->env_size
- 2];
1235 const rb_env_t
*copied_env
= vm_env_new(ep
, env_body
, src_env
->env_size
, src_env
->iseq
);
1237 // Copy after allocations above, since they can move objects in src_ep.
1238 RB_OBJ_WRITE(copied_env
, &ep
[VM_ENV_DATA_INDEX_ME_CREF
], src_ep
[VM_ENV_DATA_INDEX_ME_CREF
]);
1239 ep
[VM_ENV_DATA_INDEX_FLAGS
] = src_ep
[VM_ENV_DATA_INDEX_FLAGS
] | VM_ENV_FLAG_ISOLATED
;
1240 if (!VM_ENV_LOCAL_P(src_ep
)) {
1241 VM_ENV_FLAGS_SET(ep
, VM_ENV_FLAG_LOCAL
);
1244 if (read_only_variables
) {
1245 for (int i
=RARRAY_LENINT(read_only_variables
)-1; i
>=0; i
--) {
1246 ID id
= NUM2ID(RARRAY_AREF(read_only_variables
, i
));
1248 for (unsigned int j
=0; j
<ISEQ_BODY(src_env
->iseq
)->local_table_size
; j
++) {
1249 if (id
== ISEQ_BODY(src_env
->iseq
)->local_table
[j
]) {
1250 VALUE v
= src_env
->env
[j
];
1251 if (!rb_ractor_shareable_p(v
)) {
1252 VALUE name
= rb_id2str(id
);
1253 VALUE msg
= rb_sprintf("can not make shareable Proc because it can refer"
1254 " unshareable object %+" PRIsVALUE
" from ", v
);
1256 rb_str_catf(msg
, "variable '%" PRIsVALUE
"'", name
);
1258 rb_str_cat_cstr(msg
, "a hidden variable");
1259 rb_exc_raise(rb_exc_new_str(rb_eRactorIsolationError
, msg
));
1261 RB_OBJ_WRITE((VALUE
)copied_env
, &env_body
[j
], v
);
1262 rb_ary_delete_at(read_only_variables
, i
);
1269 if (!VM_ENV_LOCAL_P(src_ep
)) {
1270 const VALUE
*prev_ep
= VM_ENV_PREV_EP(src_env
->ep
);
1271 const rb_env_t
*new_prev_env
= env_copy(prev_ep
, read_only_variables
);
1272 ep
[VM_ENV_DATA_INDEX_SPECVAL
] = VM_GUARDED_PREV_EP(new_prev_env
->ep
);
1273 RB_OBJ_WRITTEN(copied_env
, Qundef
, new_prev_env
);
1274 VM_ENV_FLAGS_UNSET(ep
, VM_ENV_FLAG_LOCAL
);
1277 ep
[VM_ENV_DATA_INDEX_SPECVAL
] = VM_BLOCK_HANDLER_NONE
;
1284 proc_isolate_env(VALUE self
, rb_proc_t
*proc
, VALUE read_only_variables
)
1286 const struct rb_captured_block
*captured
= &proc
->block
.as
.captured
;
1287 const rb_env_t
*env
= env_copy(captured
->ep
, read_only_variables
);
1288 *((const VALUE
**)&proc
->block
.as
.captured
.ep
) = env
->ep
;
1289 RB_OBJ_WRITTEN(self
, Qundef
, env
);
1293 proc_shared_outer_variables(struct rb_id_table
*outer_variables
, bool isolate
, const char *message
)
1295 struct collect_outer_variable_name_data data
= {
1298 .read_only
= Qfalse
,
1301 rb_id_table_foreach(outer_variables
, collect_outer_variable_names
, (void *)&data
);
1303 if (data
.ary
!= Qfalse
) {
1304 VALUE str
= rb_sprintf("can not %s because it accesses outer variables", message
);
1305 VALUE ary
= data
.ary
;
1306 const char *sep
= " (";
1307 for (long i
= 0; i
< RARRAY_LEN(ary
); i
++) {
1308 VALUE name
= rb_id2str(NUM2ID(RARRAY_AREF(ary
, i
)));
1309 if (!name
) continue;
1310 rb_str_cat_cstr(str
, sep
);
1312 rb_str_append(str
, name
);
1314 if (*sep
== ',') rb_str_cat_cstr(str
, ")");
1315 rb_str_cat_cstr(str
, data
.yield
? " and uses 'yield'." : ".");
1316 rb_exc_raise(rb_exc_new_str(rb_eArgError
, str
));
1318 else if (data
.yield
) {
1319 rb_raise(rb_eArgError
, "can not %s because it uses 'yield'.", message
);
1322 return data
.read_only
;
1326 rb_proc_isolate_bang(VALUE self
)
1328 const rb_iseq_t
*iseq
= vm_proc_iseq(self
);
1331 rb_proc_t
*proc
= (rb_proc_t
*)RTYPEDDATA_DATA(self
);
1332 if (proc
->block
.type
!= block_type_iseq
) rb_raise(rb_eRuntimeError
, "not supported yet");
1334 if (ISEQ_BODY(iseq
)->outer_variables
) {
1335 proc_shared_outer_variables(ISEQ_BODY(iseq
)->outer_variables
, true, "isolate a Proc");
1338 proc_isolate_env(self
, proc
, Qfalse
);
1339 proc
->is_isolated
= TRUE
;
1342 FL_SET_RAW(self
, RUBY_FL_SHAREABLE
);
1347 rb_proc_isolate(VALUE self
)
1349 VALUE dst
= rb_proc_dup(self
);
1350 rb_proc_isolate_bang(dst
);
1355 rb_proc_ractor_make_shareable(VALUE self
)
1357 const rb_iseq_t
*iseq
= vm_proc_iseq(self
);
1360 rb_proc_t
*proc
= (rb_proc_t
*)RTYPEDDATA_DATA(self
);
1361 if (proc
->block
.type
!= block_type_iseq
) rb_raise(rb_eRuntimeError
, "not supported yet");
1363 if (!rb_ractor_shareable_p(vm_block_self(&proc
->block
))) {
1364 rb_raise(rb_eRactorIsolationError
,
1365 "Proc's self is not shareable: %" PRIsVALUE
,
1369 VALUE read_only_variables
= Qfalse
;
1371 if (ISEQ_BODY(iseq
)->outer_variables
) {
1372 read_only_variables
=
1373 proc_shared_outer_variables(ISEQ_BODY(iseq
)->outer_variables
, false, "make a Proc shareable");
1376 proc_isolate_env(self
, proc
, read_only_variables
);
1377 proc
->is_isolated
= TRUE
;
1380 FL_SET_RAW(self
, RUBY_FL_SHAREABLE
);
1385 rb_vm_make_proc_lambda(const rb_execution_context_t
*ec
, const struct rb_captured_block
*captured
, VALUE klass
, int8_t is_lambda
)
1388 enum imemo_type code_type
= imemo_type(captured
->code
.val
);
1390 if (!VM_ENV_ESCAPED_P(captured
->ep
)) {
1391 rb_control_frame_t
*cfp
= VM_CAPTURED_BLOCK_TO_CFP(captured
);
1392 vm_make_env_object(ec
, cfp
);
1395 VM_ASSERT(VM_EP_IN_HEAP_P(ec
, captured
->ep
));
1396 VM_ASSERT(code_type
== imemo_iseq
|| code_type
== imemo_ifunc
);
1398 procval
= vm_proc_create_from_captured(klass
, captured
,
1399 code_type
== imemo_iseq
? block_type_iseq
: block_type_ifunc
,
1402 if (code_type
== imemo_ifunc
) {
1403 struct vm_ifunc
*ifunc
= (struct vm_ifunc
*)captured
->code
.val
;
1404 if (ifunc
->svar_lep
) {
1405 VALUE ep0
= ifunc
->svar_lep
[0];
1406 if (RB_TYPE_P(ep0
, T_IMEMO
) && imemo_type_p(ep0
, imemo_env
)) {
1407 // `ep0 == imemo_env` means this ep is escaped to heap (in env object).
1408 const rb_env_t
*env
= (const rb_env_t
*)ep0
;
1409 ifunc
->svar_lep
= (VALUE
*)env
->ep
;
1412 VM_ASSERT(FIXNUM_P(ep0
));
1413 if (ep0
& VM_ENV_FLAG_ESCAPED
) {
1417 ifunc
->svar_lep
= NULL
;
1429 rb_vm_make_binding(const rb_execution_context_t
*ec
, const rb_control_frame_t
*src_cfp
)
1431 rb_control_frame_t
*cfp
= rb_vm_get_binding_creatable_next_cfp(ec
, src_cfp
);
1432 rb_control_frame_t
*ruby_level_cfp
= rb_vm_get_ruby_level_next_cfp(ec
, src_cfp
);
1433 VALUE bindval
, envval
;
1436 if (cfp
== 0 || ruby_level_cfp
== 0) {
1437 rb_raise(rb_eRuntimeError
, "Can't create Binding Object on top of Fiber.");
1439 if (!VM_FRAME_RUBYFRAME_P(src_cfp
) &&
1440 !VM_FRAME_RUBYFRAME_P(RUBY_VM_PREVIOUS_CONTROL_FRAME(src_cfp
))) {
1441 rb_raise(rb_eRuntimeError
, "Cannot create Binding object for non-Ruby caller");
1444 envval
= vm_make_env_object(ec
, cfp
);
1445 bindval
= rb_binding_alloc(rb_cBinding
);
1446 GetBindingPtr(bindval
, bind
);
1447 vm_bind_update_env(bindval
, bind
, envval
);
1448 RB_OBJ_WRITE(bindval
, &bind
->block
.as
.captured
.self
, cfp
->self
);
1449 RB_OBJ_WRITE(bindval
, &bind
->block
.as
.captured
.code
.iseq
, cfp
->iseq
);
1450 RB_OBJ_WRITE(bindval
, &bind
->pathobj
, ISEQ_BODY(ruby_level_cfp
->iseq
)->location
.pathobj
);
1451 bind
->first_lineno
= rb_vm_get_sourceline(ruby_level_cfp
);
1457 rb_binding_add_dynavars(VALUE bindval
, rb_binding_t
*bind
, int dyncount
, const ID
*dynvars
)
1459 VALUE envval
, pathobj
= bind
->pathobj
;
1460 VALUE path
= pathobj_path(pathobj
);
1461 VALUE realpath
= pathobj_realpath(pathobj
);
1462 const struct rb_block
*base_block
;
1463 const rb_env_t
*env
;
1464 rb_execution_context_t
*ec
= GET_EC();
1465 const rb_iseq_t
*base_iseq
, *iseq
;
1466 rb_node_scope_t tmp_node
;
1468 if (dyncount
< 0) return 0;
1470 base_block
= &bind
->block
;
1471 base_iseq
= vm_block_iseq(base_block
);
1474 rb_ast_id_table_t
*dyns
= ALLOCV(idtmp
, sizeof(rb_ast_id_table_t
) + dyncount
* sizeof(ID
));
1475 dyns
->size
= dyncount
;
1476 MEMCPY(dyns
->ids
, dynvars
, ID
, dyncount
);
1478 rb_node_init(RNODE(&tmp_node
), NODE_SCOPE
);
1479 tmp_node
.nd_tbl
= dyns
;
1480 tmp_node
.nd_body
= 0;
1481 tmp_node
.nd_args
= 0;
1483 VALUE ast_value
= rb_ruby_ast_new(RNODE(&tmp_node
));
1486 iseq
= rb_iseq_new(ast_value
, ISEQ_BODY(base_iseq
)->location
.label
, path
, realpath
, base_iseq
, ISEQ_TYPE_EVAL
);
1489 VALUE tempstr
= rb_fstring_lit("<temp>");
1490 iseq
= rb_iseq_new_top(ast_value
, tempstr
, tempstr
, tempstr
, NULL
);
1492 tmp_node
.nd_tbl
= 0; /* reset table */
1495 vm_set_eval_stack(ec
, iseq
, 0, base_block
);
1496 vm_bind_update_env(bindval
, bind
, envval
= vm_make_env_object(ec
, ec
->cfp
));
1497 rb_vm_pop_frame(ec
);
1499 env
= (const rb_env_t
*)envval
;
1503 /* C -> Ruby: block */
1506 invoke_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
)
1508 int arg_size
= ISEQ_BODY(iseq
)->param
.size
;
1510 vm_push_frame(ec
, iseq
, type
| VM_FRAME_FLAG_FINISH
, self
,
1511 VM_GUARDED_PREV_EP(captured
->ep
),
1512 (VALUE
)cref
, /* cref or method */
1513 ISEQ_BODY(iseq
)->iseq_encoded
+ opt_pc
,
1514 ec
->cfp
->sp
+ arg_size
,
1515 ISEQ_BODY(iseq
)->local_table_size
- arg_size
,
1516 ISEQ_BODY(iseq
)->stack_max
);
1521 invoke_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
)
1523 /* bmethod call from outside the VM */
1524 int arg_size
= ISEQ_BODY(iseq
)->param
.size
;
1527 VM_ASSERT(me
->def
->type
== VM_METHOD_TYPE_BMETHOD
);
1529 vm_push_frame(ec
, iseq
, type
| VM_FRAME_FLAG_BMETHOD
, self
,
1530 VM_GUARDED_PREV_EP(captured
->ep
),
1532 ISEQ_BODY(iseq
)->iseq_encoded
+ opt_pc
,
1533 ec
->cfp
->sp
+ 1 /* self */ + arg_size
,
1534 ISEQ_BODY(iseq
)->local_table_size
- arg_size
,
1535 ISEQ_BODY(iseq
)->stack_max
);
1537 VM_ENV_FLAGS_SET(ec
->cfp
->ep
, VM_FRAME_FLAG_FINISH
);
1543 ALWAYS_INLINE(static VALUE
1544 invoke_iseq_block_from_c(rb_execution_context_t
*ec
, const struct rb_captured_block
*captured
,
1545 VALUE self
, int argc
, const VALUE
*argv
, int kw_splat
, VALUE passed_block_handler
,
1546 const rb_cref_t
*cref
, int is_lambda
, const rb_callable_method_entry_t
*me
));
1549 invoke_iseq_block_from_c(rb_execution_context_t
*ec
, const struct rb_captured_block
*captured
,
1550 VALUE self
, int argc
, const VALUE
*argv
, int kw_splat
, VALUE passed_block_handler
,
1551 const rb_cref_t
*cref
, int is_lambda
, const rb_callable_method_entry_t
*me
)
1553 const rb_iseq_t
*iseq
= rb_iseq_check(captured
->code
.iseq
);
1555 VALUE type
= VM_FRAME_MAGIC_BLOCK
| (is_lambda
? VM_FRAME_FLAG_LAMBDA
: 0);
1556 rb_control_frame_t
*cfp
= ec
->cfp
;
1557 VALUE
*sp
= cfp
->sp
;
1558 int flags
= (kw_splat
? VM_CALL_KW_SPLAT
: 0);
1559 VALUE
*use_argv
= (VALUE
*)argv
;
1564 if (UNLIKELY(argc
> VM_ARGC_STACK_MAX
) &&
1565 (VM_ARGC_STACK_MAX
>= 1 ||
1566 /* Skip ruby array for potential autosplat case */
1567 (argc
!= 1 || is_lambda
))) {
1568 use_argv
= vm_argv_ruby_array(av
, argv
, &flags
, &argc
, kw_splat
);
1571 CHECK_VM_STACK_OVERFLOW(cfp
, argc
+ 1);
1572 vm_check_canary(ec
, sp
);
1574 VALUE
*stack_argv
= sp
;
1576 *sp
= self
; // bemthods need `self` on the VM stack
1579 cfp
->sp
= stack_argv
+ argc
;
1580 MEMCPY(stack_argv
, use_argv
, VALUE
, argc
); // restrict: new stack space
1582 opt_pc
= vm_yield_setup_args(ec
, iseq
, argc
, stack_argv
, flags
, passed_block_handler
,
1583 (is_lambda
? arg_setup_method
: arg_setup_block
));
1587 return invoke_block(ec
, iseq
, self
, captured
, cref
, type
, opt_pc
);
1590 return invoke_bmethod(ec
, iseq
, self
, captured
, me
, type
, opt_pc
);
1595 invoke_block_from_c_bh(rb_execution_context_t
*ec
, VALUE block_handler
,
1596 int argc
, const VALUE
*argv
,
1597 int kw_splat
, VALUE passed_block_handler
, const rb_cref_t
*cref
,
1598 int is_lambda
, int force_blockarg
)
1601 switch (vm_block_handler_type(block_handler
)) {
1602 case block_handler_type_iseq
:
1604 const struct rb_captured_block
*captured
= VM_BH_TO_ISEQ_BLOCK(block_handler
);
1605 return invoke_iseq_block_from_c(ec
, captured
, captured
->self
,
1606 argc
, argv
, kw_splat
, passed_block_handler
,
1607 cref
, is_lambda
, NULL
);
1609 case block_handler_type_ifunc
:
1610 return vm_yield_with_cfunc(ec
, VM_BH_TO_IFUNC_BLOCK(block_handler
),
1611 VM_BH_TO_IFUNC_BLOCK(block_handler
)->self
,
1612 argc
, argv
, kw_splat
, passed_block_handler
, NULL
);
1613 case block_handler_type_symbol
:
1614 return vm_yield_with_symbol(ec
, VM_BH_TO_SYMBOL(block_handler
),
1615 argc
, argv
, kw_splat
, passed_block_handler
);
1616 case block_handler_type_proc
:
1617 if (force_blockarg
== FALSE
) {
1618 is_lambda
= block_proc_is_lambda(VM_BH_TO_PROC(block_handler
));
1620 block_handler
= vm_proc_to_block_handler(VM_BH_TO_PROC(block_handler
));
1623 VM_UNREACHABLE(invoke_block_from_c_splattable
);
1628 check_block_handler(rb_execution_context_t
*ec
)
1630 VALUE block_handler
= VM_CF_BLOCK_HANDLER(ec
->cfp
);
1631 vm_block_handler_verify(block_handler
);
1632 if (UNLIKELY(block_handler
== VM_BLOCK_HANDLER_NONE
)) {
1633 rb_vm_localjump_error("no block given", Qnil
, 0);
1636 return block_handler
;
1640 vm_yield_with_cref(rb_execution_context_t
*ec
, int argc
, const VALUE
*argv
, int kw_splat
, const rb_cref_t
*cref
, int is_lambda
)
1642 return invoke_block_from_c_bh(ec
, check_block_handler(ec
),
1643 argc
, argv
, kw_splat
, VM_BLOCK_HANDLER_NONE
,
1644 cref
, is_lambda
, FALSE
);
1648 vm_yield(rb_execution_context_t
*ec
, int argc
, const VALUE
*argv
, int kw_splat
)
1650 return vm_yield_with_cref(ec
, argc
, argv
, kw_splat
, NULL
, FALSE
);
1654 vm_yield_with_block(rb_execution_context_t
*ec
, int argc
, const VALUE
*argv
, VALUE block_handler
, int kw_splat
)
1656 return invoke_block_from_c_bh(ec
, check_block_handler(ec
),
1657 argc
, argv
, kw_splat
, block_handler
,
1658 NULL
, FALSE
, FALSE
);
1662 vm_yield_force_blockarg(rb_execution_context_t
*ec
, VALUE args
)
1664 return invoke_block_from_c_bh(ec
, check_block_handler(ec
), 1, &args
,
1665 RB_NO_KEYWORDS
, VM_BLOCK_HANDLER_NONE
, NULL
, FALSE
, TRUE
);
1668 ALWAYS_INLINE(static VALUE
1669 invoke_block_from_c_proc(rb_execution_context_t
*ec
, const rb_proc_t
*proc
,
1670 VALUE self
, int argc
, const VALUE
*argv
,
1671 int kw_splat
, VALUE passed_block_handler
, int is_lambda
,
1672 const rb_callable_method_entry_t
*me
));
1675 invoke_block_from_c_proc(rb_execution_context_t
*ec
, const rb_proc_t
*proc
,
1676 VALUE self
, int argc
, const VALUE
*argv
,
1677 int kw_splat
, VALUE passed_block_handler
, int is_lambda
,
1678 const rb_callable_method_entry_t
*me
)
1680 const struct rb_block
*block
= &proc
->block
;
1683 switch (vm_block_type(block
)) {
1684 case block_type_iseq
:
1685 return invoke_iseq_block_from_c(ec
, &block
->as
.captured
, self
, argc
, argv
, kw_splat
, passed_block_handler
, NULL
, is_lambda
, me
);
1686 case block_type_ifunc
:
1687 if (kw_splat
== 1) {
1688 VALUE keyword_hash
= argv
[argc
-1];
1689 if (!RB_TYPE_P(keyword_hash
, T_HASH
)) {
1690 keyword_hash
= rb_to_hash_type(keyword_hash
);
1692 if (RHASH_EMPTY_P(keyword_hash
)) {
1696 ((VALUE
*)argv
)[argc
-1] = rb_hash_dup(keyword_hash
);
1699 return vm_yield_with_cfunc(ec
, &block
->as
.captured
, self
, argc
, argv
, kw_splat
, passed_block_handler
, me
);
1700 case block_type_symbol
:
1701 return vm_yield_with_symbol(ec
, block
->as
.symbol
, argc
, argv
, kw_splat
, passed_block_handler
);
1702 case block_type_proc
:
1703 is_lambda
= block_proc_is_lambda(block
->as
.proc
);
1704 block
= vm_proc_block(block
->as
.proc
);
1707 VM_UNREACHABLE(invoke_block_from_c_proc
);
1712 vm_invoke_proc(rb_execution_context_t
*ec
, rb_proc_t
*proc
, VALUE self
,
1713 int argc
, const VALUE
*argv
, int kw_splat
, VALUE passed_block_handler
)
1715 return invoke_block_from_c_proc(ec
, proc
, self
, argc
, argv
, kw_splat
, passed_block_handler
, proc
->is_lambda
, NULL
);
1719 rb_vm_invoke_bmethod(rb_execution_context_t
*ec
, rb_proc_t
*proc
, VALUE self
,
1720 int argc
, const VALUE
*argv
, int kw_splat
, VALUE block_handler
, const rb_callable_method_entry_t
*me
)
1722 return invoke_block_from_c_proc(ec
, proc
, self
, argc
, argv
, kw_splat
, block_handler
, TRUE
, me
);
1726 rb_vm_invoke_proc(rb_execution_context_t
*ec
, rb_proc_t
*proc
,
1727 int argc
, const VALUE
*argv
, int kw_splat
, VALUE passed_block_handler
)
1729 VALUE self
= vm_block_self(&proc
->block
);
1730 vm_block_handler_verify(passed_block_handler
);
1732 if (proc
->is_from_method
) {
1733 return rb_vm_invoke_bmethod(ec
, proc
, self
, argc
, argv
, kw_splat
, passed_block_handler
, NULL
);
1736 return vm_invoke_proc(ec
, proc
, self
, argc
, argv
, kw_splat
, passed_block_handler
);
1741 rb_vm_invoke_proc_with_self(rb_execution_context_t
*ec
, rb_proc_t
*proc
, VALUE self
,
1742 int argc
, const VALUE
*argv
, int kw_splat
, VALUE passed_block_handler
)
1744 vm_block_handler_verify(passed_block_handler
);
1746 if (proc
->is_from_method
) {
1747 return rb_vm_invoke_bmethod(ec
, proc
, self
, argc
, argv
, kw_splat
, passed_block_handler
, NULL
);
1750 return vm_invoke_proc(ec
, proc
, self
, argc
, argv
, kw_splat
, passed_block_handler
);
1754 /* special variable */
1757 rb_vm_svar_lep(const rb_execution_context_t
*ec
, const rb_control_frame_t
*cfp
)
1759 while (cfp
->pc
== 0 || cfp
->iseq
== 0) {
1760 if (VM_FRAME_TYPE(cfp
) == VM_FRAME_MAGIC_IFUNC
) {
1761 struct vm_ifunc
*ifunc
= (struct vm_ifunc
*)cfp
->iseq
;
1762 return ifunc
->svar_lep
;
1765 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
1768 if (RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(ec
, cfp
)) {
1773 return (VALUE
*)VM_CF_LEP(cfp
);
1777 vm_cfp_svar_get(const rb_execution_context_t
*ec
, rb_control_frame_t
*cfp
, VALUE key
)
1779 return lep_svar_get(ec
, rb_vm_svar_lep(ec
, cfp
), key
);
1783 vm_cfp_svar_set(const rb_execution_context_t
*ec
, rb_control_frame_t
*cfp
, VALUE key
, const VALUE val
)
1785 lep_svar_set(ec
, rb_vm_svar_lep(ec
, cfp
), key
, val
);
1789 vm_svar_get(const rb_execution_context_t
*ec
, VALUE key
)
1791 return vm_cfp_svar_get(ec
, ec
->cfp
, key
);
1795 vm_svar_set(const rb_execution_context_t
*ec
, VALUE key
, VALUE val
)
1797 vm_cfp_svar_set(ec
, ec
->cfp
, key
, val
);
1801 rb_backref_get(void)
1803 return vm_svar_get(GET_EC(), VM_SVAR_BACKREF
);
1807 rb_backref_set(VALUE val
)
1809 vm_svar_set(GET_EC(), VM_SVAR_BACKREF
, val
);
1813 rb_lastline_get(void)
1815 return vm_svar_get(GET_EC(), VM_SVAR_LASTLINE
);
1819 rb_lastline_set(VALUE val
)
1821 vm_svar_set(GET_EC(), VM_SVAR_LASTLINE
, val
);
1825 rb_lastline_set_up(VALUE val
, unsigned int up
)
1827 rb_control_frame_t
* cfp
= GET_EC()->cfp
;
1829 for(unsigned int i
= 0; i
< up
; i
++) {
1830 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
1832 vm_cfp_svar_set(GET_EC(), cfp
, VM_SVAR_LASTLINE
, val
);
1840 const rb_execution_context_t
*ec
= GET_EC();
1841 const rb_control_frame_t
*cfp
= rb_vm_get_ruby_level_next_cfp(ec
, ec
->cfp
);
1844 return RSTRING_PTR(rb_iseq_path(cfp
->iseq
));
1854 const rb_execution_context_t
*ec
= GET_EC();
1855 const rb_control_frame_t
*cfp
= rb_vm_get_ruby_level_next_cfp(ec
, ec
->cfp
);
1858 return rb_vm_get_sourceline(cfp
);
1866 rb_source_location(int *pline
)
1868 const rb_execution_context_t
*ec
= GET_EC();
1869 const rb_control_frame_t
*cfp
= rb_vm_get_ruby_level_next_cfp(ec
, ec
->cfp
);
1871 if (cfp
&& VM_FRAME_RUBYFRAME_P(cfp
)) {
1872 if (pline
) *pline
= rb_vm_get_sourceline(cfp
);
1873 return rb_iseq_path(cfp
->iseq
);
1876 if (pline
) *pline
= 0;
1882 rb_source_location_cstr(int *pline
)
1884 VALUE path
= rb_source_location(pline
);
1885 if (NIL_P(path
)) return NULL
;
1886 return RSTRING_PTR(path
);
1892 const rb_execution_context_t
*ec
= GET_EC();
1893 return vm_ec_cref(ec
);
1897 rb_vm_cref_replace_with_duplicated_cref(void)
1899 const rb_execution_context_t
*ec
= GET_EC();
1900 const rb_control_frame_t
*cfp
= rb_vm_get_ruby_level_next_cfp(ec
, ec
->cfp
);
1901 rb_cref_t
*cref
= vm_cref_replace_with_duplicated_cref(cfp
->ep
);
1907 rb_vm_cref_in_context(VALUE self
, VALUE cbase
)
1909 const rb_execution_context_t
*ec
= GET_EC();
1910 const rb_control_frame_t
*cfp
= rb_vm_get_ruby_level_next_cfp(ec
, ec
->cfp
);
1911 const rb_cref_t
*cref
;
1912 if (!cfp
|| cfp
->self
!= self
) return NULL
;
1913 if (!vm_env_cref_by_cref(cfp
->ep
)) return NULL
;
1914 cref
= vm_get_cref(cfp
->ep
);
1915 if (CREF_CLASS(cref
) != cbase
) return NULL
;
1921 debug_cref(rb_cref_t
*cref
)
1924 dp(CREF_CLASS(cref
));
1925 printf("%ld\n", CREF_VISI(cref
));
1926 cref
= CREF_NEXT(cref
);
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
);
1938 rb_raise(rb_eRuntimeError
, "Can't call on top of Fiber or Thread");
1940 return vm_get_cbase(cfp
->ep
);
1946 make_localjump_error(const char *mesg
, VALUE value
, int reason
)
1948 extern VALUE rb_eLocalJumpError
;
1949 VALUE exc
= rb_exc_new2(rb_eLocalJumpError
, mesg
);
1954 CONST_ID(id
, "break");
1957 CONST_ID(id
, "redo");
1960 CONST_ID(id
, "retry");
1963 CONST_ID(id
, "next");
1966 CONST_ID(id
, "return");
1969 CONST_ID(id
, "noreason");
1972 rb_iv_set(exc
, "@exit_value", value
);
1973 rb_iv_set(exc
, "@reason", ID2SYM(id
));
1978 rb_vm_localjump_error(const char *mesg
, VALUE value
, int reason
)
1980 VALUE exc
= make_localjump_error(mesg
, value
, reason
);
1985 rb_vm_make_jump_tag_but_local_jump(enum ruby_tag_type state
, VALUE val
)
1991 mesg
= "unexpected return";
1994 mesg
= "unexpected break";
1997 mesg
= "unexpected next";
2000 mesg
= "unexpected redo";
2004 mesg
= "retry outside of rescue clause";
2011 val
= GET_EC()->tag
->retval
;
2013 return make_localjump_error(mesg
, val
, state
);
2017 rb_vm_jump_tag_but_local_jump(enum ruby_tag_type state
)
2019 VALUE exc
= rb_vm_make_jump_tag_but_local_jump(state
, Qundef
);
2020 if (!NIL_P(exc
)) rb_exc_raise(exc
);
2021 EC_JUMP_TAG(GET_EC(), state
);
2024 static rb_control_frame_t
*
2025 next_not_local_frame(rb_control_frame_t
*cfp
)
2027 while (VM_ENV_LOCAL_P(cfp
->ep
)) {
2028 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
2033 NORETURN(static void vm_iter_break(rb_execution_context_t
*ec
, VALUE val
));
2036 vm_iter_break(rb_execution_context_t
*ec
, VALUE val
)
2038 rb_control_frame_t
*cfp
= next_not_local_frame(ec
->cfp
);
2039 const VALUE
*ep
= VM_CF_PREV_EP(cfp
);
2040 const rb_control_frame_t
*target_cfp
= rb_vm_search_cf_from_ep(ec
, cfp
, ep
);
2043 rb_vm_localjump_error("unexpected break", val
, TAG_BREAK
);
2046 ec
->errinfo
= (VALUE
)THROW_DATA_NEW(val
, target_cfp
, TAG_BREAK
);
2047 EC_JUMP_TAG(ec
, TAG_BREAK
);
2053 vm_iter_break(GET_EC(), Qnil
);
2057 rb_iter_break_value(VALUE val
)
2059 vm_iter_break(GET_EC(), val
);
2062 /* optimization: redefine management */
2064 short ruby_vm_redefined_flag
[BOP_LAST_
];
2065 static st_table
*vm_opt_method_def_table
= 0;
2066 static st_table
*vm_opt_mid_table
= 0;
2069 rb_free_vm_opt_tables(void)
2071 st_free_table(vm_opt_method_def_table
);
2072 st_free_table(vm_opt_mid_table
);
2076 vm_redefinition_check_flag(VALUE klass
)
2078 if (klass
== rb_cInteger
) return INTEGER_REDEFINED_OP_FLAG
;
2079 if (klass
== rb_cFloat
) return FLOAT_REDEFINED_OP_FLAG
;
2080 if (klass
== rb_cString
) return STRING_REDEFINED_OP_FLAG
;
2081 if (klass
== rb_cArray
) return ARRAY_REDEFINED_OP_FLAG
;
2082 if (klass
== rb_cHash
) return HASH_REDEFINED_OP_FLAG
;
2083 if (klass
== rb_cSymbol
) return SYMBOL_REDEFINED_OP_FLAG
;
2085 if (klass
== rb_cTime
) return TIME_REDEFINED_OP_FLAG
;
2087 if (klass
== rb_cRegexp
) return REGEXP_REDEFINED_OP_FLAG
;
2088 if (klass
== rb_cNilClass
) return NIL_REDEFINED_OP_FLAG
;
2089 if (klass
== rb_cTrueClass
) return TRUE_REDEFINED_OP_FLAG
;
2090 if (klass
== rb_cFalseClass
) return FALSE_REDEFINED_OP_FLAG
;
2091 if (klass
== rb_cProc
) return PROC_REDEFINED_OP_FLAG
;
2096 rb_vm_check_optimizable_mid(VALUE mid
)
2098 if (!vm_opt_mid_table
) {
2102 return st_lookup(vm_opt_mid_table
, mid
, NULL
);
2106 vm_redefinition_check_method_type(const rb_method_entry_t
*me
)
2108 if (me
->called_id
!= me
->def
->original_id
) {
2112 if (METHOD_ENTRY_BASIC(me
)) return TRUE
;
2114 const rb_method_definition_t
*def
= me
->def
;
2115 switch (def
->type
) {
2116 case VM_METHOD_TYPE_CFUNC
:
2117 case VM_METHOD_TYPE_OPTIMIZED
:
2125 rb_vm_check_redefinition_opt_method(const rb_method_entry_t
*me
, VALUE klass
)
2128 if (RB_TYPE_P(klass
, T_ICLASS
) && FL_TEST(klass
, RICLASS_IS_ORIGIN
) &&
2129 RB_TYPE_P(RBASIC_CLASS(klass
), T_CLASS
)) {
2130 klass
= RBASIC_CLASS(klass
);
2132 if (vm_redefinition_check_method_type(me
)) {
2133 if (st_lookup(vm_opt_method_def_table
, (st_data_t
)me
->def
, &bop
)) {
2134 int flag
= vm_redefinition_check_flag(klass
);
2137 RB_WARN_CATEGORY_PERFORMANCE
,
2138 "Redefining '%s#%s' disables interpreter and JIT optimizations",
2139 rb_class2name(me
->owner
),
2140 rb_id2name(me
->called_id
)
2142 rb_yjit_bop_redefined(flag
, (enum ruby_basic_operators
)bop
);
2143 rb_rjit_bop_redefined(flag
, (enum ruby_basic_operators
)bop
);
2144 ruby_vm_redefined_flag
[bop
] |= flag
;
2150 static enum rb_id_table_iterator_result
2151 check_redefined_method(ID mid
, VALUE value
, void *data
)
2153 VALUE klass
= (VALUE
)data
;
2154 const rb_method_entry_t
*me
= (rb_method_entry_t
*)value
;
2155 const rb_method_entry_t
*newme
= rb_method_entry(klass
, mid
);
2157 if (newme
!= me
) rb_vm_check_redefinition_opt_method(me
, me
->owner
);
2159 return ID_TABLE_CONTINUE
;
2163 rb_vm_check_redefinition_by_prepend(VALUE klass
)
2165 if (!vm_redefinition_check_flag(klass
)) return;
2166 rb_id_table_foreach(RCLASS_M_TBL(RCLASS_ORIGIN(klass
)), check_redefined_method
, (void *)klass
);
2170 add_opt_method_entry_bop(const rb_method_entry_t
*me
, ID mid
, enum ruby_basic_operators bop
)
2172 st_insert(vm_opt_method_def_table
, (st_data_t
)me
->def
, (st_data_t
)bop
);
2173 st_insert(vm_opt_mid_table
, (st_data_t
)mid
, (st_data_t
)Qtrue
);
2177 add_opt_method(VALUE klass
, ID mid
, enum ruby_basic_operators bop
)
2179 const rb_method_entry_t
*me
= rb_method_entry_at(klass
, mid
);
2181 if (me
&& vm_redefinition_check_method_type(me
)) {
2182 add_opt_method_entry_bop(me
, mid
, bop
);
2185 rb_bug("undefined optimized method: %s", rb_id2name(mid
));
2189 static enum ruby_basic_operators
vm_redefinition_bop_for_id(ID mid
);
2192 add_opt_method_entry(const rb_method_entry_t
*me
)
2194 if (me
&& vm_redefinition_check_method_type(me
)) {
2195 ID mid
= me
->called_id
;
2196 enum ruby_basic_operators bop
= vm_redefinition_bop_for_id(mid
);
2197 if ((int)bop
>= 0) {
2198 add_opt_method_entry_bop(me
, mid
, bop
);
2204 vm_init_redefined_flag(void)
2207 enum ruby_basic_operators bop
;
2209 #define OP(mid_, bop_) (mid = id##mid_, bop = BOP_##bop_, ruby_vm_redefined_flag[bop] = 0)
2210 #define C(k) add_opt_method(rb_c##k, mid, bop)
2211 OP(PLUS
, PLUS
), (C(Integer
), C(Float
), C(String
), C(Array
));
2212 OP(MINUS
, MINUS
), (C(Integer
), C(Float
));
2213 OP(MULT
, MULT
), (C(Integer
), C(Float
));
2214 OP(DIV
, DIV
), (C(Integer
), C(Float
));
2215 OP(MOD
, MOD
), (C(Integer
), C(Float
));
2216 OP(Eq
, EQ
), (C(Integer
), C(Float
), C(String
), C(Symbol
));
2217 OP(Eqq
, EQQ
), (C(Integer
), C(Float
), C(Symbol
), C(String
),
2218 C(NilClass
), C(TrueClass
), C(FalseClass
));
2219 OP(LT
, LT
), (C(Integer
), C(Float
));
2220 OP(LE
, LE
), (C(Integer
), C(Float
));
2221 OP(GT
, GT
), (C(Integer
), C(Float
));
2222 OP(GE
, GE
), (C(Integer
), C(Float
));
2223 OP(LTLT
, LTLT
), (C(String
), C(Array
));
2224 OP(AREF
, AREF
), (C(Array
), C(Hash
), C(Integer
));
2225 OP(ASET
, ASET
), (C(Array
), C(Hash
));
2226 OP(Length
, LENGTH
), (C(Array
), C(String
), C(Hash
));
2227 OP(Size
, SIZE
), (C(Array
), C(String
), C(Hash
));
2228 OP(EmptyP
, EMPTY_P
), (C(Array
), C(String
), C(Hash
));
2229 OP(Succ
, SUCC
), (C(Integer
), C(String
));
2230 OP(EqTilde
, MATCH
), (C(Regexp
), C(String
));
2231 OP(Freeze
, FREEZE
), (C(String
));
2232 OP(UMinus
, UMINUS
), (C(String
));
2233 OP(Max
, MAX
), (C(Array
));
2234 OP(Min
, MIN
), (C(Array
));
2235 OP(Hash
, HASH
), (C(Array
));
2236 OP(Call
, CALL
), (C(Proc
));
2237 OP(And
, AND
), (C(Integer
));
2238 OP(Or
, OR
), (C(Integer
));
2239 OP(NilP
, NIL_P
), (C(NilClass
));
2240 OP(Cmp
, CMP
), (C(Integer
), C(Float
), C(String
));
2241 OP(Default
, DEFAULT
), (C(Hash
));
2246 static enum ruby_basic_operators
2247 vm_redefinition_bop_for_id(ID mid
)
2250 #define OP(mid_, bop_) case id##mid_: return BOP_##bop_
2267 OP(EmptyP
, EMPTY_P
);
2280 OP(Default
, DEFAULT
);
2286 /* for vm development */
2290 vm_frametype_name(const rb_control_frame_t
*cfp
)
2292 switch (VM_FRAME_TYPE(cfp
)) {
2293 case VM_FRAME_MAGIC_METHOD
: return "method";
2294 case VM_FRAME_MAGIC_BLOCK
: return "block";
2295 case VM_FRAME_MAGIC_CLASS
: return "class";
2296 case VM_FRAME_MAGIC_TOP
: return "top";
2297 case VM_FRAME_MAGIC_CFUNC
: return "cfunc";
2298 case VM_FRAME_MAGIC_IFUNC
: return "ifunc";
2299 case VM_FRAME_MAGIC_EVAL
: return "eval";
2300 case VM_FRAME_MAGIC_RESCUE
: return "rescue";
2302 rb_bug("unknown frame");
2308 frame_return_value(const struct vm_throw_data
*err
)
2310 if (THROW_DATA_P(err
) &&
2311 THROW_DATA_STATE(err
) == TAG_BREAK
&&
2312 THROW_DATA_CONSUMED_P(err
) == FALSE
) {
2313 return THROW_DATA_VAL(err
);
2323 frame_name(const rb_control_frame_t
*cfp
)
2325 unsigned long type
= VM_FRAME_TYPE(cfp
);
2326 #define C(t) if (type == VM_FRAME_MAGIC_##t) return #t
2343 // cfp_returning_with_value:
2344 // Whether cfp is the last frame in the unwinding process for a non-local return.
2346 hook_before_rewind(rb_execution_context_t
*ec
, bool cfp_returning_with_value
, int state
, struct vm_throw_data
*err
)
2348 if (state
== TAG_RAISE
&& RBASIC(err
)->klass
== rb_eSysStackError
) {
2352 const rb_iseq_t
*iseq
= ec
->cfp
->iseq
;
2353 rb_hook_list_t
*local_hooks
= iseq
->aux
.exec
.local_hooks
;
2355 switch (VM_FRAME_TYPE(ec
->cfp
)) {
2356 case VM_FRAME_MAGIC_METHOD
:
2357 RUBY_DTRACE_METHOD_RETURN_HOOK(ec
, 0, 0);
2358 EXEC_EVENT_HOOK_AND_POP_FRAME(ec
, RUBY_EVENT_RETURN
, ec
->cfp
->self
, 0, 0, 0, frame_return_value(err
));
2360 if (UNLIKELY(local_hooks
&& local_hooks
->events
& RUBY_EVENT_RETURN
)) {
2361 rb_exec_event_hook_orig(ec
, local_hooks
, RUBY_EVENT_RETURN
,
2362 ec
->cfp
->self
, 0, 0, 0, frame_return_value(err
), TRUE
);
2365 THROW_DATA_CONSUMED_SET(err
);
2367 case VM_FRAME_MAGIC_BLOCK
:
2368 if (VM_FRAME_BMETHOD_P(ec
->cfp
)) {
2369 VALUE bmethod_return_value
= frame_return_value(err
);
2370 if (cfp_returning_with_value
) {
2371 // Non-local return terminating at a BMETHOD control frame.
2372 bmethod_return_value
= THROW_DATA_VAL(err
);
2376 EXEC_EVENT_HOOK_AND_POP_FRAME(ec
, RUBY_EVENT_B_RETURN
, ec
->cfp
->self
, 0, 0, 0, bmethod_return_value
);
2377 if (UNLIKELY(local_hooks
&& local_hooks
->events
& RUBY_EVENT_B_RETURN
)) {
2378 rb_exec_event_hook_orig(ec
, local_hooks
, RUBY_EVENT_B_RETURN
,
2379 ec
->cfp
->self
, 0, 0, 0, bmethod_return_value
, TRUE
);
2382 const rb_callable_method_entry_t
*me
= rb_vm_frame_method_entry(ec
->cfp
);
2384 EXEC_EVENT_HOOK_AND_POP_FRAME(ec
, RUBY_EVENT_RETURN
, ec
->cfp
->self
,
2385 rb_vm_frame_method_entry(ec
->cfp
)->def
->original_id
,
2386 rb_vm_frame_method_entry(ec
->cfp
)->called_id
,
2387 rb_vm_frame_method_entry(ec
->cfp
)->owner
,
2388 bmethod_return_value
);
2390 VM_ASSERT(me
->def
->type
== VM_METHOD_TYPE_BMETHOD
);
2391 local_hooks
= me
->def
->body
.bmethod
.hooks
;
2393 if (UNLIKELY(local_hooks
&& local_hooks
->events
& RUBY_EVENT_RETURN
)) {
2394 rb_exec_event_hook_orig(ec
, local_hooks
, RUBY_EVENT_RETURN
, ec
->cfp
->self
,
2395 rb_vm_frame_method_entry(ec
->cfp
)->def
->original_id
,
2396 rb_vm_frame_method_entry(ec
->cfp
)->called_id
,
2397 rb_vm_frame_method_entry(ec
->cfp
)->owner
,
2398 bmethod_return_value
, TRUE
);
2400 THROW_DATA_CONSUMED_SET(err
);
2403 EXEC_EVENT_HOOK_AND_POP_FRAME(ec
, RUBY_EVENT_B_RETURN
, ec
->cfp
->self
, 0, 0, 0, frame_return_value(err
));
2404 if (UNLIKELY(local_hooks
&& local_hooks
->events
& RUBY_EVENT_B_RETURN
)) {
2405 rb_exec_event_hook_orig(ec
, local_hooks
, RUBY_EVENT_B_RETURN
,
2406 ec
->cfp
->self
, 0, 0, 0, frame_return_value(err
), TRUE
);
2408 THROW_DATA_CONSUMED_SET(err
);
2411 case VM_FRAME_MAGIC_CLASS
:
2412 EXEC_EVENT_HOOK_AND_POP_FRAME(ec
, RUBY_EVENT_END
, ec
->cfp
->self
, 0, 0, 0, Qnil
);
2418 /* evaluator body */
2423 cfunc finish F1 F2 C1
2424 rb_funcall finish F1 F2 C1
2426 VM finish F1 F2 C1 F3
2428 F1 - F3 : pushed by VM
2429 C1 : pushed by send insn (CFUNC)
2431 struct CONTROL_FRAME {
2432 VALUE *pc; // cfp[0], program counter
2433 VALUE *sp; // cfp[1], stack pointer
2434 rb_iseq_t *iseq; // cfp[2], iseq
2435 VALUE self; // cfp[3], self
2436 const VALUE *ep; // cfp[4], env pointer
2437 const void *block_code; // cfp[5], block code
2440 struct rb_captured_block {
2453 VALUE cref; // ep[-2]
2454 VALUE special; // ep[-1]
2455 VALUE flags; // ep[ 0] == lep[0]
2465 VALUE cref; // ep[-2]
2466 VALUE special; // ep[-1]
2467 VALUE flags; // ep[ 0]
2475 VALUE prev_ep; // for frame jump
2479 struct C_METHOD_CONTROL_FRAME {
2481 VALUE *sp; // stack pointer
2482 rb_iseq_t *iseq; // cmi
2484 VALUE *ep; // ep == lep
2488 struct C_BLOCK_CONTROL_FRAME {
2489 VALUE *pc; // point only "finish" insn
2491 rb_iseq_t *iseq; // ?
2499 vm_exec_handle_exception(rb_execution_context_t
*ec
, enum ruby_tag_type state
, VALUE errinfo
);
2501 vm_exec_loop(rb_execution_context_t
*ec
, enum ruby_tag_type state
, struct rb_vm_tag
*tag
, VALUE result
);
2503 // for non-Emscripten Wasm build, use vm_exec with optimized setjmp for runtime performance
2504 #if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2506 struct rb_vm_exec_context
{
2507 rb_execution_context_t
*const ec
;
2508 struct rb_vm_tag
*const tag
;
2514 vm_exec_bottom_main(void *context
)
2516 struct rb_vm_exec_context
*ctx
= context
;
2517 rb_execution_context_t
*ec
= ctx
->ec
;
2519 ctx
->result
= vm_exec_loop(ec
, TAG_NONE
, ctx
->tag
, vm_exec_core(ec
));
2523 vm_exec_bottom_rescue(void *context
)
2525 struct rb_vm_exec_context
*ctx
= context
;
2526 rb_execution_context_t
*ec
= ctx
->ec
;
2528 ctx
->result
= vm_exec_loop(ec
, rb_ec_tag_state(ec
), ctx
->tag
, ec
->errinfo
);
2533 vm_exec(rb_execution_context_t
*ec
)
2535 VALUE result
= Qundef
;
2541 #if defined(__wasm__) && !defined(__EMSCRIPTEN__)
2542 struct rb_vm_exec_context ctx
= {
2546 struct rb_wasm_try_catch try_catch
;
2550 rb_wasm_try_catch_init(&try_catch
, vm_exec_bottom_main
, vm_exec_bottom_rescue
, &ctx
);
2552 rb_wasm_try_catch_loop_run(&try_catch
, &RB_VM_TAG_JMPBUF_GET(_tag
.buf
));
2554 result
= ctx
.result
;
2556 enum ruby_tag_type state
;
2557 if ((state
= EC_EXEC_TAG()) == TAG_NONE
) {
2558 if (UNDEF_P(result
= jit_exec(ec
))) {
2559 result
= vm_exec_core(ec
);
2561 /* fallback to the VM */
2562 result
= vm_exec_loop(ec
, TAG_NONE
, &_tag
, result
);
2565 result
= vm_exec_loop(ec
, state
, &_tag
, ec
->errinfo
);
2574 vm_exec_loop(rb_execution_context_t
*ec
, enum ruby_tag_type state
,
2575 struct rb_vm_tag
*tag
, VALUE result
)
2577 if (state
== TAG_NONE
) { /* no jumps, result is discarded */
2581 rb_ec_raised_reset(ec
, RAISED_STACKOVERFLOW
| RAISED_NOMEMORY
);
2582 while (UNDEF_P(result
= vm_exec_handle_exception(ec
, state
, result
))) {
2583 // caught a jump, exec the handler. JIT code in jit_exec_exception()
2584 // may return Qundef to run remaining frames with vm_exec_core().
2585 if (UNDEF_P(result
= jit_exec_exception(ec
))) {
2586 result
= vm_exec_core(ec
);
2589 VM_ASSERT(ec
->tag
== tag
);
2590 /* when caught `throw`, `tag.state` is set. */
2591 if ((state
= tag
->state
) == TAG_NONE
) break;
2592 tag
->state
= TAG_NONE
;
2599 vm_exec_handle_exception(rb_execution_context_t
*ec
, enum ruby_tag_type state
, VALUE errinfo
)
2601 struct vm_throw_data
*err
= (struct vm_throw_data
*)errinfo
;
2605 const struct iseq_catch_table_entry
*entry
;
2606 const struct iseq_catch_table
*ct
;
2607 unsigned long epc
, cont_pc
, cont_sp
;
2608 const rb_iseq_t
*catch_iseq
;
2610 const rb_control_frame_t
*escape_cfp
;
2612 cont_pc
= cont_sp
= 0;
2615 while (ec
->cfp
->pc
== 0 || ec
->cfp
->iseq
== 0) {
2616 if (UNLIKELY(VM_FRAME_TYPE(ec
->cfp
) == VM_FRAME_MAGIC_CFUNC
)) {
2617 EXEC_EVENT_HOOK_AND_POP_FRAME(ec
, RUBY_EVENT_C_RETURN
, ec
->cfp
->self
,
2618 rb_vm_frame_method_entry(ec
->cfp
)->def
->original_id
,
2619 rb_vm_frame_method_entry(ec
->cfp
)->called_id
,
2620 rb_vm_frame_method_entry(ec
->cfp
)->owner
, Qnil
);
2621 RUBY_DTRACE_CMETHOD_RETURN_HOOK(ec
,
2622 rb_vm_frame_method_entry(ec
->cfp
)->owner
,
2623 rb_vm_frame_method_entry(ec
->cfp
)->def
->original_id
);
2625 rb_vm_pop_frame(ec
);
2628 rb_control_frame_t
*const cfp
= ec
->cfp
;
2629 epc
= cfp
->pc
- ISEQ_BODY(cfp
->iseq
)->iseq_encoded
;
2632 if (state
== TAG_BREAK
|| state
== TAG_RETURN
) {
2633 escape_cfp
= THROW_DATA_CATCH_FRAME(err
);
2635 if (cfp
== escape_cfp
) {
2636 if (state
== TAG_RETURN
) {
2637 if (!VM_FRAME_FINISHED_P(cfp
)) {
2638 THROW_DATA_CATCH_FRAME_SET(err
, cfp
+ 1);
2639 THROW_DATA_STATE_SET(err
, state
= TAG_BREAK
);
2642 ct
= ISEQ_BODY(cfp
->iseq
)->catch_table
;
2643 if (ct
) for (i
= 0; i
< ct
->size
; i
++) {
2644 entry
= UNALIGNED_MEMBER_PTR(ct
, entries
[i
]);
2645 if (entry
->start
< epc
&& entry
->end
>= epc
) {
2646 if (entry
->type
== CATCH_TYPE_ENSURE
) {
2647 catch_iseq
= entry
->iseq
;
2648 cont_pc
= entry
->cont
;
2649 cont_sp
= entry
->sp
;
2654 if (catch_iseq
== NULL
) {
2656 THROW_DATA_CATCH_FRAME_SET(err
, cfp
+ 1);
2657 // cfp == escape_cfp here so calling with cfp_returning_with_value = true
2658 hook_before_rewind(ec
, true, state
, err
);
2659 rb_vm_pop_frame(ec
);
2660 return THROW_DATA_VAL(err
);
2667 *cfp
->sp
++ = THROW_DATA_VAL(err
);
2674 if (state
== TAG_RAISE
) {
2675 ct
= ISEQ_BODY(cfp
->iseq
)->catch_table
;
2676 if (ct
) for (i
= 0; i
< ct
->size
; i
++) {
2677 entry
= UNALIGNED_MEMBER_PTR(ct
, entries
[i
]);
2678 if (entry
->start
< epc
&& entry
->end
>= epc
) {
2680 if (entry
->type
== CATCH_TYPE_RESCUE
||
2681 entry
->type
== CATCH_TYPE_ENSURE
) {
2682 catch_iseq
= entry
->iseq
;
2683 cont_pc
= entry
->cont
;
2684 cont_sp
= entry
->sp
;
2690 else if (state
== TAG_RETRY
) {
2691 ct
= ISEQ_BODY(cfp
->iseq
)->catch_table
;
2692 if (ct
) for (i
= 0; i
< ct
->size
; i
++) {
2693 entry
= UNALIGNED_MEMBER_PTR(ct
, entries
[i
]);
2694 if (entry
->start
< epc
&& entry
->end
>= epc
) {
2696 if (entry
->type
== CATCH_TYPE_ENSURE
) {
2697 catch_iseq
= entry
->iseq
;
2698 cont_pc
= entry
->cont
;
2699 cont_sp
= entry
->sp
;
2702 else if (entry
->type
== CATCH_TYPE_RETRY
) {
2703 const rb_control_frame_t
*escape_cfp
;
2704 escape_cfp
= THROW_DATA_CATCH_FRAME(err
);
2705 if (cfp
== escape_cfp
) {
2706 cfp
->pc
= ISEQ_BODY(cfp
->iseq
)->iseq_encoded
+ entry
->cont
;
2714 else if ((state
== TAG_BREAK
&& !escape_cfp
) ||
2715 (state
== TAG_REDO
) ||
2716 (state
== TAG_NEXT
)) {
2717 type
= (const enum rb_catch_type
[TAG_MASK
]) {
2718 [TAG_BREAK
] = CATCH_TYPE_BREAK
,
2719 [TAG_NEXT
] = CATCH_TYPE_NEXT
,
2720 [TAG_REDO
] = CATCH_TYPE_REDO
,
2721 /* otherwise = dontcare */
2724 ct
= ISEQ_BODY(cfp
->iseq
)->catch_table
;
2725 if (ct
) for (i
= 0; i
< ct
->size
; i
++) {
2726 entry
= UNALIGNED_MEMBER_PTR(ct
, entries
[i
]);
2728 if (entry
->start
< epc
&& entry
->end
>= epc
) {
2729 if (entry
->type
== CATCH_TYPE_ENSURE
) {
2730 catch_iseq
= entry
->iseq
;
2731 cont_pc
= entry
->cont
;
2732 cont_sp
= entry
->sp
;
2735 else if (entry
->type
== type
) {
2736 cfp
->pc
= ISEQ_BODY(cfp
->iseq
)->iseq_encoded
+ entry
->cont
;
2737 cfp
->sp
= vm_base_ptr(cfp
) + entry
->sp
;
2739 if (state
!= TAG_REDO
) {
2740 *cfp
->sp
++ = THROW_DATA_VAL(err
);
2743 VM_ASSERT(ec
->tag
->state
== TAG_NONE
);
2750 ct
= ISEQ_BODY(cfp
->iseq
)->catch_table
;
2751 if (ct
) for (i
= 0; i
< ct
->size
; i
++) {
2752 entry
= UNALIGNED_MEMBER_PTR(ct
, entries
[i
]);
2753 if (entry
->start
< epc
&& entry
->end
>= epc
) {
2755 if (entry
->type
== CATCH_TYPE_ENSURE
) {
2756 catch_iseq
= entry
->iseq
;
2757 cont_pc
= entry
->cont
;
2758 cont_sp
= entry
->sp
;
2765 if (catch_iseq
!= NULL
) { /* found catch table */
2766 /* enter catch scope */
2767 const int arg_size
= 1;
2769 rb_iseq_check(catch_iseq
);
2770 cfp
->sp
= vm_base_ptr(cfp
) + cont_sp
;
2771 cfp
->pc
= ISEQ_BODY(cfp
->iseq
)->iseq_encoded
+ cont_pc
;
2773 /* push block frame */
2774 cfp
->sp
[0] = (VALUE
)err
;
2775 vm_push_frame(ec
, catch_iseq
, VM_FRAME_MAGIC_RESCUE
,
2777 VM_GUARDED_PREV_EP(cfp
->ep
),
2779 ISEQ_BODY(catch_iseq
)->iseq_encoded
,
2780 cfp
->sp
+ arg_size
/* push value */,
2781 ISEQ_BODY(catch_iseq
)->local_table_size
- arg_size
,
2782 ISEQ_BODY(catch_iseq
)->stack_max
);
2785 ec
->tag
->state
= TAG_NONE
;
2791 hook_before_rewind(ec
, (cfp
== escape_cfp
), state
, err
);
2793 if (VM_FRAME_FINISHED_P(ec
->cfp
)) {
2794 rb_vm_pop_frame(ec
);
2795 ec
->errinfo
= (VALUE
)err
;
2796 ec
->tag
= ec
->tag
->prev
;
2797 EC_JUMP_TAG(ec
, state
);
2800 rb_vm_pop_frame(ec
);
2809 rb_iseq_eval(const rb_iseq_t
*iseq
)
2811 rb_execution_context_t
*ec
= GET_EC();
2813 vm_set_top_stack(ec
, iseq
);
2819 rb_iseq_eval_main(const rb_iseq_t
*iseq
)
2821 rb_execution_context_t
*ec
= GET_EC();
2824 vm_set_main_stack(ec
, iseq
);
2830 rb_vm_control_frame_id_and_class(const rb_control_frame_t
*cfp
, ID
*idp
, ID
*called_idp
, VALUE
*klassp
)
2832 const rb_callable_method_entry_t
*me
= rb_vm_frame_method_entry(cfp
);
2835 if (idp
) *idp
= me
->def
->original_id
;
2836 if (called_idp
) *called_idp
= me
->called_id
;
2837 if (klassp
) *klassp
= me
->owner
;
2846 rb_ec_frame_method_id_and_class(const rb_execution_context_t
*ec
, ID
*idp
, ID
*called_idp
, VALUE
*klassp
)
2848 return rb_vm_control_frame_id_and_class(ec
->cfp
, idp
, called_idp
, klassp
);
2852 rb_frame_method_id_and_class(ID
*idp
, VALUE
*klassp
)
2854 return rb_ec_frame_method_id_and_class(GET_EC(), idp
, 0, klassp
);
2858 rb_vm_call_cfunc(VALUE recv
, VALUE (*func
)(VALUE
), VALUE arg
,
2859 VALUE block_handler
, VALUE filename
)
2861 rb_execution_context_t
*ec
= GET_EC();
2862 const rb_control_frame_t
*reg_cfp
= ec
->cfp
;
2863 const rb_iseq_t
*iseq
= rb_iseq_new(Qnil
, filename
, filename
, Qnil
, 0, ISEQ_TYPE_TOP
);
2866 vm_push_frame(ec
, iseq
, VM_FRAME_MAGIC_TOP
| VM_ENV_FLAG_LOCAL
| VM_FRAME_FLAG_FINISH
,
2867 recv
, block_handler
,
2868 (VALUE
)vm_cref_new_toplevel(ec
), /* cref or me */
2869 0, reg_cfp
->sp
, 0, 0);
2873 rb_vm_pop_frame(ec
);
2880 rb_vm_update_references(void *ptr
)
2885 rb_gc_update_tbl_refs(vm
->ci_table
);
2886 rb_gc_update_tbl_refs(vm
->frozen_strings
);
2887 vm
->mark_object_ary
= rb_gc_location(vm
->mark_object_ary
);
2888 vm
->load_path
= rb_gc_location(vm
->load_path
);
2889 vm
->load_path_snapshot
= rb_gc_location(vm
->load_path_snapshot
);
2891 if (vm
->load_path_check_cache
) {
2892 vm
->load_path_check_cache
= rb_gc_location(vm
->load_path_check_cache
);
2895 vm
->expanded_load_path
= rb_gc_location(vm
->expanded_load_path
);
2896 vm
->loaded_features
= rb_gc_location(vm
->loaded_features
);
2897 vm
->loaded_features_snapshot
= rb_gc_location(vm
->loaded_features_snapshot
);
2898 vm
->loaded_features_realpaths
= rb_gc_location(vm
->loaded_features_realpaths
);
2899 vm
->loaded_features_realpath_map
= rb_gc_location(vm
->loaded_features_realpath_map
);
2900 vm
->top_self
= rb_gc_location(vm
->top_self
);
2901 vm
->orig_progname
= rb_gc_location(vm
->orig_progname
);
2903 rb_gc_update_tbl_refs(vm
->overloaded_cme_table
);
2905 rb_gc_update_values(RUBY_NSIG
, vm
->trap_list
.cmd
);
2907 if (vm
->coverages
) {
2908 vm
->coverages
= rb_gc_location(vm
->coverages
);
2909 vm
->me2counter
= rb_gc_location(vm
->me2counter
);
2915 rb_vm_each_stack_value(void *ptr
, void (*cb
)(VALUE
, void*), void *ctx
)
2920 ccan_list_for_each(&vm
->ractor
.set
, r
, vmlr_node
) {
2921 VM_ASSERT(rb_ractor_status_p(r
, ractor_blocking
) ||
2922 rb_ractor_status_p(r
, ractor_running
));
2923 if (r
->threads
.cnt
> 0) {
2924 rb_thread_t
*th
= 0;
2925 ccan_list_for_each(&r
->threads
.set
, th
, lt_node
) {
2926 VM_ASSERT(th
!= NULL
);
2927 rb_execution_context_t
* ec
= th
->ec
;
2929 VALUE
*p
= ec
->vm_stack
;
2930 VALUE
*sp
= ec
->cfp
->sp
;
2932 if (!RB_SPECIAL_CONST_P(*p
)) {
2944 static enum rb_id_table_iterator_result
2945 vm_mark_negative_cme(VALUE val
, void *dmy
)
2948 return ID_TABLE_CONTINUE
;
2951 void rb_thread_sched_mark_zombies(rb_vm_t
*vm
);
2954 rb_vm_mark(void *ptr
)
2956 RUBY_MARK_ENTER("vm");
2957 RUBY_GC_INFO("-------------------------------------------------\n");
2963 ccan_list_for_each(&vm
->ractor
.set
, r
, vmlr_node
) {
2964 // ractor.set only contains blocking or running ractors
2965 VM_ASSERT(rb_ractor_status_p(r
, ractor_blocking
) ||
2966 rb_ractor_status_p(r
, ractor_running
));
2967 rb_gc_mark(rb_ractor_self(r
));
2970 for (struct global_object_list
*list
= vm
->global_object_list
; list
; list
= list
->next
) {
2971 rb_gc_mark_maybe(*list
->varptr
);
2974 rb_gc_mark_movable(vm
->mark_object_ary
);
2975 rb_gc_mark_movable(vm
->load_path
);
2976 rb_gc_mark_movable(vm
->load_path_snapshot
);
2977 rb_gc_mark_movable(vm
->load_path_check_cache
);
2978 rb_gc_mark_movable(vm
->expanded_load_path
);
2979 rb_gc_mark_movable(vm
->loaded_features
);
2980 rb_gc_mark_movable(vm
->loaded_features_snapshot
);
2981 rb_gc_mark_movable(vm
->loaded_features_realpaths
);
2982 rb_gc_mark_movable(vm
->loaded_features_realpath_map
);
2983 rb_gc_mark_movable(vm
->top_self
);
2984 rb_gc_mark_movable(vm
->orig_progname
);
2985 rb_gc_mark_movable(vm
->coverages
);
2986 rb_gc_mark_movable(vm
->me2counter
);
2988 if (vm
->loading_table
) {
2989 rb_mark_tbl(vm
->loading_table
);
2992 rb_gc_mark_values(RUBY_NSIG
, vm
->trap_list
.cmd
);
2994 rb_id_table_foreach_values(vm
->negative_cme_table
, vm_mark_negative_cme
, NULL
);
2995 rb_mark_tbl_no_pin(vm
->overloaded_cme_table
);
2996 for (i
=0; i
<VM_GLOBAL_CC_CACHE_TABLE_SIZE
; i
++) {
2997 const struct rb_callcache
*cc
= vm
->global_cc_cache_table
[i
];
3000 if (!vm_cc_invalidated_p(cc
)) {
3001 rb_gc_mark((VALUE
)cc
);
3004 vm
->global_cc_cache_table
[i
] = NULL
;
3009 rb_thread_sched_mark_zombies(vm
);
3013 RUBY_MARK_LEAVE("vm");
3016 #undef rb_vm_register_special_exception
3018 rb_vm_register_special_exception_str(enum ruby_special_exceptions sp
, VALUE cls
, VALUE mesg
)
3020 rb_vm_t
*vm
= GET_VM();
3021 VALUE exc
= rb_exc_new3(cls
, rb_obj_freeze(mesg
));
3023 ((VALUE
*)vm
->special_exceptions
)[sp
] = exc
;
3024 rb_vm_register_global_object(exc
);
3028 free_loading_table_entry(st_data_t key
, st_data_t value
, st_data_t arg
)
3034 void rb_free_loaded_features_index(rb_vm_t
*vm
);
3035 void rb_objspace_free_objects(void *objspace
);
3038 ruby_vm_destruct(rb_vm_t
*vm
)
3040 RUBY_FREE_ENTER("vm");
3043 rb_thread_t
*th
= vm
->ractor
.main_thread
;
3044 VALUE
*stack
= th
->ec
->vm_stack
;
3045 if (rb_free_at_exit
) {
3046 rb_free_encoded_insn_data();
3047 rb_free_global_enc_table();
3048 rb_free_loaded_builtin_table();
3050 rb_free_shared_fiber_pool();
3051 rb_free_static_symid_str();
3052 rb_free_transcoder_table();
3053 rb_free_vm_opt_tables();
3055 rb_free_rb_global_tbl();
3056 rb_free_loaded_features_index(vm
);
3058 rb_id_table_free(vm
->negative_cme_table
);
3059 st_free_table(vm
->overloaded_cme_table
);
3061 rb_id_table_free(RCLASS(rb_mRubyVMFrozenCore
)->m_tbl
);
3063 rb_shape_t
*cursor
= rb_shape_get_root_shape();
3064 rb_shape_t
*end
= rb_shape_get_shape_by_id(GET_SHAPE_TREE()->next_shape_id
);
3065 while (cursor
< end
) {
3066 // 0x1 == SINGLE_CHILD_P
3067 if (cursor
->edges
&& !(((uintptr_t)cursor
->edges
) & 0x1))
3068 rb_id_table_free(cursor
->edges
);
3072 xfree(GET_SHAPE_TREE());
3074 st_free_table(vm
->static_ext_inits
);
3075 st_free_table(vm
->ensure_rollback_table
);
3077 rb_vm_postponed_job_free();
3079 rb_id_table_free(vm
->constant_cache
);
3080 st_free_table(vm
->unused_block_warning_table
);
3087 #ifndef HAVE_SETPROCTITLE
3088 ruby_free_proctitle();
3093 rb_fiber_reset_root_local_storage(th
);
3098 struct rb_objspace
*objspace
= vm
->objspace
;
3100 rb_vm_living_threads_init(vm
);
3101 ruby_vm_run_at_exit_hooks(vm
);
3102 if (vm
->loading_table
) {
3103 st_foreach(vm
->loading_table
, free_loading_table_entry
, 0);
3104 st_free_table(vm
->loading_table
);
3105 vm
->loading_table
= 0;
3108 st_free_table(vm
->ci_table
);
3109 vm
->ci_table
= NULL
;
3111 if (vm
->frozen_strings
) {
3112 st_free_table(vm
->frozen_strings
);
3113 vm
->frozen_strings
= 0;
3115 RB_ALTSTACK_FREE(vm
->main_altstack
);
3117 struct global_object_list
*next
;
3118 for (struct global_object_list
*list
= vm
->global_object_list
; list
; list
= next
) {
3124 if (rb_free_at_exit
) {
3125 rb_objspace_free_objects(objspace
);
3126 rb_free_generic_iv_tbl_();
3127 rb_free_default_rand_key();
3128 if (th
&& vm
->fork_gen
== 0) {
3129 /* If we have forked, main_thread may not be the initial thread */
3134 rb_objspace_free(objspace
);
3136 rb_native_mutex_destroy(&vm
->workqueue_lock
);
3137 /* after freeing objspace, you *can't* use ruby_xfree() */
3139 ruby_current_vm_ptr
= NULL
;
3141 RUBY_FREE_LEAVE("vm");
3145 size_t rb_vm_memsize_waiting_fds(struct ccan_list_head
*waiting_fds
); // thread.c
3146 size_t rb_vm_memsize_workqueue(struct ccan_list_head
*workqueue
); // vm_trace.c
3148 // Used for VM memsize reporting. Returns the size of the at_exit list by
3149 // looping through the linked list and adding up the size of the structs.
3150 static enum rb_id_table_iterator_result
3151 vm_memsize_constant_cache_i(ID id
, VALUE ics
, void *size
)
3153 *((size_t *) size
) += rb_st_memsize((st_table
*) ics
);
3154 return ID_TABLE_CONTINUE
;
3157 // Returns a size_t representing the memory footprint of the VM's constant
3158 // cache, which is the memsize of the table as well as the memsize of all of the
3161 vm_memsize_constant_cache(void)
3163 rb_vm_t
*vm
= GET_VM();
3164 size_t size
= rb_id_table_memsize(vm
->constant_cache
);
3166 rb_id_table_foreach(vm
->constant_cache
, vm_memsize_constant_cache_i
, &size
);
3171 vm_memsize_at_exit_list(rb_at_exit_list
*at_exit
)
3176 size
+= sizeof(rb_at_exit_list
);
3177 at_exit
= at_exit
->next
;
3183 // Used for VM memsize reporting. Returns the size of the builtin function
3184 // table if it has been defined.
3186 vm_memsize_builtin_function_table(const struct rb_builtin_function
*builtin_function_table
)
3188 return builtin_function_table
== NULL
? 0 : sizeof(struct rb_builtin_function
);
3191 // Reports the memsize of the VM struct object and the structs that are
3192 // associated with it.
3194 vm_memsize(const void *ptr
)
3196 rb_vm_t
*vm
= GET_VM();
3200 rb_vm_memsize_waiting_fds(&vm
->waiting_fds
) +
3201 rb_st_memsize(vm
->loaded_features_index
) +
3202 rb_st_memsize(vm
->loading_table
) +
3203 rb_st_memsize(vm
->ensure_rollback_table
) +
3204 rb_vm_memsize_postponed_job_queue() +
3205 rb_vm_memsize_workqueue(&vm
->workqueue
) +
3206 vm_memsize_at_exit_list(vm
->at_exit
) +
3207 rb_st_memsize(vm
->ci_table
) +
3208 rb_st_memsize(vm
->frozen_strings
) +
3209 vm_memsize_builtin_function_table(vm
->builtin_function_table
) +
3210 rb_id_table_memsize(vm
->negative_cme_table
) +
3211 rb_st_memsize(vm
->overloaded_cme_table
) +
3212 vm_memsize_constant_cache() +
3213 GET_SHAPE_TREE()->cache_size
* sizeof(redblack_node_t
)
3217 // struct { struct ccan_list_head set; } ractor;
3218 // void *main_altstack; #ifdef USE_SIGALTSTACK
3219 // struct rb_objspace *objspace;
3222 static const rb_data_type_t vm_data_type
= {
3224 {0, 0, vm_memsize
,},
3225 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3230 vm_default_params(void)
3232 rb_vm_t
*vm
= GET_VM();
3233 VALUE result
= rb_hash_new_with_size(4);
3234 #define SET(name) rb_hash_aset(result, ID2SYM(rb_intern(#name)), SIZET2NUM(vm->default_params.name));
3235 SET(thread_vm_stack_size
);
3236 SET(thread_machine_stack_size
);
3237 SET(fiber_vm_stack_size
);
3238 SET(fiber_machine_stack_size
);
3240 rb_obj_freeze(result
);
3245 get_param(const char *name
, size_t default_value
, size_t min_value
)
3248 size_t result
= default_value
;
3249 if ((envval
= getenv(name
)) != 0) {
3250 long val
= atol(envval
);
3251 if (val
< (long)min_value
) {
3252 val
= (long)min_value
;
3254 result
= (size_t)(((val
-1 + RUBY_VM_SIZE_ALIGN
) / RUBY_VM_SIZE_ALIGN
) * RUBY_VM_SIZE_ALIGN
);
3256 if (0) ruby_debug_printf("%s: %"PRIuSIZE
"\n", name
, result
); /* debug print */
3262 check_machine_stack_size(size_t *sizep
)
3264 #ifdef PTHREAD_STACK_MIN
3265 size_t size
= *sizep
;
3268 #ifdef PTHREAD_STACK_MIN
3269 if (size
< (size_t)PTHREAD_STACK_MIN
) {
3270 *sizep
= (size_t)PTHREAD_STACK_MIN
* 2;
3276 vm_default_params_setup(rb_vm_t
*vm
)
3278 vm
->default_params
.thread_vm_stack_size
=
3279 get_param("RUBY_THREAD_VM_STACK_SIZE",
3280 RUBY_VM_THREAD_VM_STACK_SIZE
,
3281 RUBY_VM_THREAD_VM_STACK_SIZE_MIN
);
3283 vm
->default_params
.thread_machine_stack_size
=
3284 get_param("RUBY_THREAD_MACHINE_STACK_SIZE",
3285 RUBY_VM_THREAD_MACHINE_STACK_SIZE
,
3286 RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN
);
3288 vm
->default_params
.fiber_vm_stack_size
=
3289 get_param("RUBY_FIBER_VM_STACK_SIZE",
3290 RUBY_VM_FIBER_VM_STACK_SIZE
,
3291 RUBY_VM_FIBER_VM_STACK_SIZE_MIN
);
3293 vm
->default_params
.fiber_machine_stack_size
=
3294 get_param("RUBY_FIBER_MACHINE_STACK_SIZE",
3295 RUBY_VM_FIBER_MACHINE_STACK_SIZE
,
3296 RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN
);
3298 /* environment dependent check */
3299 check_machine_stack_size(&vm
->default_params
.thread_machine_stack_size
);
3300 check_machine_stack_size(&vm
->default_params
.fiber_machine_stack_size
);
3304 vm_init2(rb_vm_t
*vm
)
3306 rb_vm_living_threads_init(vm
);
3307 vm
->thread_report_on_exception
= 1;
3308 vm
->src_encoding_index
= -1;
3310 vm_default_params_setup(vm
);
3314 rb_execution_context_update(rb_execution_context_t
*ec
)
3316 /* update VM stack */
3320 VALUE
*p
= ec
->vm_stack
;
3321 VALUE
*sp
= ec
->cfp
->sp
;
3322 rb_control_frame_t
*cfp
= ec
->cfp
;
3323 rb_control_frame_t
*limit_cfp
= (void *)(ec
->vm_stack
+ ec
->vm_stack_size
);
3325 for (i
= 0; i
< (long)(sp
- p
); i
++) {
3327 VALUE update
= rb_gc_location(ref
);
3328 if (ref
!= update
) {
3333 while (cfp
!= limit_cfp
) {
3334 const VALUE
*ep
= cfp
->ep
;
3335 cfp
->self
= rb_gc_location(cfp
->self
);
3336 cfp
->iseq
= (rb_iseq_t
*)rb_gc_location((VALUE
)cfp
->iseq
);
3337 cfp
->block_code
= (void *)rb_gc_location((VALUE
)cfp
->block_code
);
3339 if (!VM_ENV_LOCAL_P(ep
)) {
3340 const VALUE
*prev_ep
= VM_ENV_PREV_EP(ep
);
3341 if (VM_ENV_FLAGS(prev_ep
, VM_ENV_FLAG_ESCAPED
)) {
3342 VM_FORCE_WRITE(&prev_ep
[VM_ENV_DATA_INDEX_ENV
], rb_gc_location(prev_ep
[VM_ENV_DATA_INDEX_ENV
]));
3345 if (VM_ENV_FLAGS(ep
, VM_ENV_FLAG_ESCAPED
)) {
3346 VM_FORCE_WRITE(&ep
[VM_ENV_DATA_INDEX_ENV
], rb_gc_location(ep
[VM_ENV_DATA_INDEX_ENV
]));
3347 VM_FORCE_WRITE(&ep
[VM_ENV_DATA_INDEX_ME_CREF
], rb_gc_location(ep
[VM_ENV_DATA_INDEX_ME_CREF
]));
3351 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
3355 ec
->storage
= rb_gc_location(ec
->storage
);
3358 static enum rb_id_table_iterator_result
3359 mark_local_storage_i(VALUE local
, void *data
)
3362 return ID_TABLE_CONTINUE
;
3366 rb_execution_context_mark(const rb_execution_context_t
*ec
)
3371 VALUE
*p
= ec
->vm_stack
;
3372 VALUE
*sp
= ec
->cfp
->sp
;
3373 rb_control_frame_t
*cfp
= ec
->cfp
;
3374 rb_control_frame_t
*limit_cfp
= (void *)(ec
->vm_stack
+ ec
->vm_stack_size
);
3376 VM_ASSERT(sp
== ec
->cfp
->sp
);
3377 rb_gc_mark_vm_stack_values((long)(sp
- p
), p
);
3379 while (cfp
!= limit_cfp
) {
3380 const VALUE
*ep
= cfp
->ep
;
3381 VM_ASSERT(!!VM_ENV_FLAGS(ep
, VM_ENV_FLAG_ESCAPED
) == vm_ep_in_heap_p_(ec
, ep
));
3383 if (VM_FRAME_TYPE(cfp
) != VM_FRAME_MAGIC_DUMMY
) {
3384 rb_gc_mark_movable(cfp
->self
);
3385 rb_gc_mark_movable((VALUE
)cfp
->iseq
);
3386 rb_gc_mark_movable((VALUE
)cfp
->block_code
);
3388 if (!VM_ENV_LOCAL_P(ep
)) {
3389 const VALUE
*prev_ep
= VM_ENV_PREV_EP(ep
);
3390 if (VM_ENV_FLAGS(prev_ep
, VM_ENV_FLAG_ESCAPED
)) {
3391 rb_gc_mark_movable(prev_ep
[VM_ENV_DATA_INDEX_ENV
]);
3394 if (VM_ENV_FLAGS(ep
, VM_ENV_FLAG_ESCAPED
)) {
3395 rb_gc_mark_movable(ep
[VM_ENV_DATA_INDEX_ENV
]);
3396 rb_gc_mark(ep
[VM_ENV_DATA_INDEX_ME_CREF
]);
3401 cfp
= RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp
);
3405 /* mark machine stack */
3406 if (ec
->machine
.stack_start
&& ec
->machine
.stack_end
&&
3407 ec
!= GET_EC() /* marked for current ec at the first stage of marking */
3409 rb_gc_mark_machine_context(ec
);
3412 rb_gc_mark(ec
->errinfo
);
3413 rb_gc_mark(ec
->root_svar
);
3414 if (ec
->local_storage
) {
3415 rb_id_table_foreach_values(ec
->local_storage
, mark_local_storage_i
, NULL
);
3417 rb_gc_mark(ec
->local_storage_recursive_hash
);
3418 rb_gc_mark(ec
->local_storage_recursive_hash_for_trace
);
3419 rb_gc_mark(ec
->private_const_reference
);
3421 rb_gc_mark_movable(ec
->storage
);
3424 void rb_fiber_mark_self(rb_fiber_t
*fib
);
3425 void rb_fiber_update_self(rb_fiber_t
*fib
);
3426 void rb_threadptr_root_fiber_setup(rb_thread_t
*th
);
3427 void rb_threadptr_root_fiber_release(rb_thread_t
*th
);
3430 thread_compact(void *ptr
)
3432 rb_thread_t
*th
= ptr
;
3434 th
->self
= rb_gc_location(th
->self
);
3436 if (!th
->root_fiber
) {
3437 rb_execution_context_update(th
->ec
);
3442 thread_mark(void *ptr
)
3444 rb_thread_t
*th
= ptr
;
3445 RUBY_MARK_ENTER("thread");
3446 rb_fiber_mark_self(th
->ec
->fiber_ptr
);
3448 /* mark ruby objects */
3449 switch (th
->invoke_type
) {
3450 case thread_invoke_type_proc
:
3451 case thread_invoke_type_ractor_proc
:
3452 rb_gc_mark(th
->invoke_arg
.proc
.proc
);
3453 rb_gc_mark(th
->invoke_arg
.proc
.args
);
3455 case thread_invoke_type_func
:
3456 rb_gc_mark_maybe((VALUE
)th
->invoke_arg
.func
.arg
);
3462 rb_gc_mark(rb_ractor_self(th
->ractor
));
3463 rb_gc_mark(th
->thgroup
);
3464 rb_gc_mark(th
->value
);
3465 rb_gc_mark(th
->pending_interrupt_queue
);
3466 rb_gc_mark(th
->pending_interrupt_mask_stack
);
3467 rb_gc_mark(th
->top_self
);
3468 rb_gc_mark(th
->top_wrapper
);
3469 if (th
->root_fiber
) rb_fiber_mark_self(th
->root_fiber
);
3471 RUBY_ASSERT(th
->ec
== rb_fiberptr_get_ec(th
->ec
->fiber_ptr
));
3472 rb_gc_mark(th
->stat_insn_usage
);
3473 rb_gc_mark(th
->last_status
);
3474 rb_gc_mark(th
->locking_mutex
);
3475 rb_gc_mark(th
->name
);
3477 rb_gc_mark(th
->scheduler
);
3479 RUBY_MARK_LEAVE("thread");
3482 void rb_threadptr_sched_free(rb_thread_t
*th
); // thread_*.c
3485 thread_free(void *ptr
)
3487 rb_thread_t
*th
= ptr
;
3488 RUBY_FREE_ENTER("thread");
3490 rb_threadptr_sched_free(th
);
3492 if (th
->locking_mutex
!= Qfalse
) {
3493 rb_bug("thread_free: locking_mutex must be NULL (%p:%p)", (void *)th
, (void *)th
->locking_mutex
);
3495 if (th
->keeping_mutexes
!= NULL
) {
3496 rb_bug("thread_free: keeping_mutexes must be NULL (%p:%p)", (void *)th
, (void *)th
->keeping_mutexes
);
3499 ruby_xfree(th
->specific_storage
);
3501 rb_threadptr_root_fiber_release(th
);
3503 if (th
->vm
&& th
->vm
->ractor
.main_thread
== th
) {
3504 RUBY_GC_INFO("MRI main thread\n");
3507 // ruby_xfree(th->nt);
3508 // TODO: MN system collect nt, but without MN system it should be freed here.
3512 RUBY_FREE_LEAVE("thread");
3516 thread_memsize(const void *ptr
)
3518 const rb_thread_t
*th
= ptr
;
3519 size_t size
= sizeof(rb_thread_t
);
3521 if (!th
->root_fiber
) {
3522 size
+= th
->ec
->vm_stack_size
* sizeof(VALUE
);
3524 if (th
->ec
->local_storage
) {
3525 size
+= rb_id_table_memsize(th
->ec
->local_storage
);
3530 #define thread_data_type ruby_threadptr_data_type
3531 const rb_data_type_t ruby_threadptr_data_type
= {
3539 0, 0, RUBY_TYPED_FREE_IMMEDIATELY
3543 rb_obj_is_thread(VALUE obj
)
3545 return RBOOL(rb_typeddata_is_kind_of(obj
, &thread_data_type
));
3549 thread_alloc(VALUE klass
)
3552 return TypedData_Make_Struct(klass
, rb_thread_t
, &thread_data_type
, th
);
3556 rb_ec_set_vm_stack(rb_execution_context_t
*ec
, VALUE
*stack
, size_t size
)
3558 ec
->vm_stack
= stack
;
3559 ec
->vm_stack_size
= size
;
3563 rb_ec_initialize_vm_stack(rb_execution_context_t
*ec
, VALUE
*stack
, size_t size
)
3565 rb_ec_set_vm_stack(ec
, stack
, size
);
3567 #if VM_CHECK_MODE > 0
3568 MEMZERO(stack
, VALUE
, size
); // malloc memory could have the VM canary in it
3571 ec
->cfp
= (void *)(ec
->vm_stack
+ ec
->vm_stack_size
);
3574 NULL
/* dummy iseq */,
3575 VM_FRAME_MAGIC_DUMMY
| VM_ENV_FLAG_LOCAL
| VM_FRAME_FLAG_FINISH
| VM_FRAME_FLAG_CFRAME
/* dummy frame */,
3576 Qnil
/* dummy self */, VM_BLOCK_HANDLER_NONE
/* dummy block ptr */,
3577 0 /* dummy cref/me */,
3578 0 /* dummy pc */, ec
->vm_stack
, 0, 0
3583 rb_ec_clear_vm_stack(rb_execution_context_t
*ec
)
3585 rb_ec_set_vm_stack(ec
, NULL
, 0);
3587 // Avoid dangling pointers:
3592 th_init(rb_thread_t
*th
, VALUE self
, rb_vm_t
*vm
)
3596 rb_threadptr_root_fiber_setup(th
);
3598 /* All threads are blocking until a non-blocking fiber is scheduled */
3600 th
->scheduler
= Qnil
;
3603 size_t size
= vm
->default_params
.thread_vm_stack_size
/ sizeof(VALUE
);
3604 rb_ec_initialize_vm_stack(th
->ec
, ALLOC_N(VALUE
, size
), size
);
3607 VM_ASSERT(th
->ec
->cfp
== NULL
);
3608 VM_ASSERT(th
->ec
->vm_stack
== NULL
);
3609 VM_ASSERT(th
->ec
->vm_stack_size
== 0);
3612 th
->status
= THREAD_RUNNABLE
;
3613 th
->last_status
= Qnil
;
3614 th
->top_wrapper
= 0;
3615 th
->top_self
= vm
->top_self
; // 0 while self == 0
3618 th
->ec
->errinfo
= Qnil
;
3619 th
->ec
->root_svar
= Qfalse
;
3620 th
->ec
->local_storage_recursive_hash
= Qnil
;
3621 th
->ec
->local_storage_recursive_hash_for_trace
= Qnil
;
3623 th
->ec
->storage
= Qnil
;
3625 #if OPT_CALL_THREADED_CODE
3626 th
->retval
= Qundef
;
3629 th
->report_on_exception
= vm
->thread_report_on_exception
;
3630 th
->ext_config
.ractor_safe
= true;
3632 #if USE_RUBY_DEBUG_LOG
3633 static rb_atomic_t thread_serial
= 1;
3634 th
->serial
= RUBY_ATOMIC_FETCH_ADD(thread_serial
, 1);
3636 RUBY_DEBUG_LOG("th:%u", th
->serial
);
3641 rb_thread_alloc(VALUE klass
)
3643 VALUE self
= thread_alloc(klass
);
3644 rb_thread_t
*target_th
= rb_thread_ptr(self
);
3645 target_th
->ractor
= GET_RACTOR();
3646 th_init(target_th
, self
, target_th
->vm
= GET_VM());
3650 #define REWIND_CFP(expr) do { \
3651 rb_execution_context_t *ec__ = GET_EC(); \
3652 VALUE *const curr_sp = (ec__->cfp++)->sp; \
3653 VALUE *const saved_sp = ec__->cfp->sp; \
3654 ec__->cfp->sp = curr_sp; \
3656 (ec__->cfp--)->sp = saved_sp; \
3660 m_core_set_method_alias(VALUE self
, VALUE cbase
, VALUE sym1
, VALUE sym2
)
3663 rb_alias(cbase
, SYM2ID(sym1
), SYM2ID(sym2
));
3669 m_core_set_variable_alias(VALUE self
, VALUE sym1
, VALUE sym2
)
3672 rb_alias_variable(SYM2ID(sym1
), SYM2ID(sym2
));
3678 m_core_undef_method(VALUE self
, VALUE cbase
, VALUE sym
)
3681 ID mid
= SYM2ID(sym
);
3682 rb_undef(cbase
, mid
);
3683 rb_clear_method_cache(self
, mid
);
3689 m_core_set_postexe(VALUE self
)
3691 rb_set_end_proc(rb_call_end_proc
, rb_block_proc());
3695 static VALUE
core_hash_merge_kwd(VALUE hash
, VALUE kw
);
3698 core_hash_merge(VALUE hash
, long argc
, const VALUE
*argv
)
3700 Check_Type(hash
, T_HASH
);
3701 VM_ASSERT(argc
% 2 == 0);
3702 rb_hash_bulk_insert(argc
, argv
, hash
);
3707 m_core_hash_merge_ptr(int argc
, VALUE
*argv
, VALUE recv
)
3709 VALUE hash
= argv
[0];
3711 REWIND_CFP(hash
= core_hash_merge(hash
, argc
-1, argv
+1));
3717 kwmerge_i(VALUE key
, VALUE value
, VALUE hash
)
3719 rb_hash_aset(hash
, key
, value
);
3724 m_core_hash_merge_kwd(VALUE recv
, VALUE hash
, VALUE kw
)
3727 REWIND_CFP(hash
= core_hash_merge_kwd(hash
, kw
));
3733 m_core_make_shareable(VALUE recv
, VALUE obj
)
3735 return rb_ractor_make_shareable(obj
);
3739 m_core_make_shareable_copy(VALUE recv
, VALUE obj
)
3741 return rb_ractor_make_shareable_copy(obj
);
3745 m_core_ensure_shareable(VALUE recv
, VALUE obj
, VALUE name
)
3747 return rb_ractor_ensure_shareable(obj
, name
);
3751 core_hash_merge_kwd(VALUE hash
, VALUE kw
)
3753 rb_hash_foreach(rb_to_hash_type(kw
), kwmerge_i
, hash
);
3757 extern VALUE
*rb_gc_stack_start
;
3758 extern size_t rb_gc_stack_maxsize
;
3760 /* debug functions */
3766 rb_vm_bugreport(NULL
, stderr
);
3774 VALUE ary
= rb_ary_new();
3775 #ifdef HAVE_BACKTRACE
3776 #include <execinfo.h>
3777 #define MAX_NATIVE_TRACE 1024
3778 static void *trace
[MAX_NATIVE_TRACE
];
3779 int n
= (int)backtrace(trace
, MAX_NATIVE_TRACE
);
3780 char **syms
= backtrace_symbols(trace
, n
);
3787 for (i
=0; i
<n
; i
++) {
3788 rb_ary_push(ary
, rb_str_new2(syms
[i
]));
3790 free(syms
); /* OK */
3795 #if VM_COLLECT_USAGE_DETAILS
3796 static VALUE
usage_analysis_insn_start(VALUE self
);
3797 static VALUE
usage_analysis_operand_start(VALUE self
);
3798 static VALUE
usage_analysis_register_start(VALUE self
);
3799 static VALUE
usage_analysis_insn_stop(VALUE self
);
3800 static VALUE
usage_analysis_operand_stop(VALUE self
);
3801 static VALUE
usage_analysis_register_stop(VALUE self
);
3802 static VALUE
usage_analysis_insn_running(VALUE self
);
3803 static VALUE
usage_analysis_operand_running(VALUE self
);
3804 static VALUE
usage_analysis_register_running(VALUE self
);
3805 static VALUE
usage_analysis_insn_clear(VALUE self
);
3806 static VALUE
usage_analysis_operand_clear(VALUE self
);
3807 static VALUE
usage_analysis_register_clear(VALUE self
);
3811 f_raise(int c
, VALUE
*v
, VALUE _
)
3813 return rb_f_raise(c
, v
);
3819 return rb_block_proc();
3825 return rb_block_lambda();
3829 f_sprintf(int c
, const VALUE
*v
, VALUE _
)
3831 return rb_f_sprintf(c
, v
);
3836 vm_mtbl(VALUE self
, VALUE obj
, VALUE sym
)
3838 vm_mtbl_dump(CLASS_OF(obj
), RTEST(sym
) ? SYM2ID(sym
) : 0);
3844 vm_mtbl2(VALUE self
, VALUE obj
, VALUE sym
)
3846 vm_mtbl_dump(obj
, RTEST(sym
) ? SYM2ID(sym
) : 0);
3852 * RubyVM.keep_script_lines -> true or false
3854 * Return current +keep_script_lines+ status. Now it only returns
3855 * +true+ of +false+, but it can return other objects in future.
3857 * Note that this is an API for ruby internal use, debugging,
3858 * and research. Do not use this for any other purpose.
3859 * The compatibility is not guaranteed.
3862 vm_keep_script_lines(VALUE self
)
3864 return RBOOL(ruby_vm_keep_script_lines
);
3869 * RubyVM.keep_script_lines = true / false
3871 * It set +keep_script_lines+ flag. If the flag is set, all
3872 * loaded scripts are recorded in a interpreter process.
3874 * Note that this is an API for ruby internal use, debugging,
3875 * and research. Do not use this for any other purpose.
3876 * The compatibility is not guaranteed.
3879 vm_keep_script_lines_set(VALUE self
, VALUE flags
)
3881 ruby_vm_keep_script_lines
= RTEST(flags
);
3893 * Document-class: RubyVM
3895 * The RubyVM module only exists on MRI. +RubyVM+ is not defined in
3896 * other Ruby implementations such as JRuby and TruffleRuby.
3898 * The RubyVM module provides some access to MRI internals.
3899 * This module is for very limited purposes, such as debugging,
3900 * prototyping, and research. Normal users must not use it.
3901 * This module is not portable between Ruby implementations.
3903 rb_cRubyVM
= rb_define_class("RubyVM", rb_cObject
);
3904 rb_undef_alloc_func(rb_cRubyVM
);
3905 rb_undef_method(CLASS_OF(rb_cRubyVM
), "new");
3906 rb_define_singleton_method(rb_cRubyVM
, "stat", vm_stat
, -1);
3907 rb_define_singleton_method(rb_cRubyVM
, "keep_script_lines", vm_keep_script_lines
, 0);
3908 rb_define_singleton_method(rb_cRubyVM
, "keep_script_lines=", vm_keep_script_lines_set
, 1);
3910 #if USE_DEBUG_COUNTER
3911 rb_define_singleton_method(rb_cRubyVM
, "reset_debug_counters", rb_debug_counter_reset
, 0);
3912 rb_define_singleton_method(rb_cRubyVM
, "show_debug_counters", rb_debug_counter_show
, 0);
3915 /* FrozenCore (hidden) */
3916 fcore
= rb_class_new(rb_cBasicObject
);
3917 rb_set_class_path(fcore
, rb_cRubyVM
, "FrozenCore");
3918 rb_vm_register_global_object(rb_class_path_cached(fcore
));
3919 RBASIC(fcore
)->flags
= T_ICLASS
;
3920 klass
= rb_singleton_class(fcore
);
3921 rb_define_method_id(klass
, id_core_set_method_alias
, m_core_set_method_alias
, 3);
3922 rb_define_method_id(klass
, id_core_set_variable_alias
, m_core_set_variable_alias
, 2);
3923 rb_define_method_id(klass
, id_core_undef_method
, m_core_undef_method
, 2);
3924 rb_define_method_id(klass
, id_core_set_postexe
, m_core_set_postexe
, 0);
3925 rb_define_method_id(klass
, id_core_hash_merge_ptr
, m_core_hash_merge_ptr
, -1);
3926 rb_define_method_id(klass
, id_core_hash_merge_kwd
, m_core_hash_merge_kwd
, 2);
3927 rb_define_method_id(klass
, id_core_raise
, f_raise
, -1);
3928 rb_define_method_id(klass
, id_core_sprintf
, f_sprintf
, -1);
3929 rb_define_method_id(klass
, idProc
, f_proc
, 0);
3930 rb_define_method_id(klass
, idLambda
, f_lambda
, 0);
3931 rb_define_method(klass
, "make_shareable", m_core_make_shareable
, 1);
3932 rb_define_method(klass
, "make_shareable_copy", m_core_make_shareable_copy
, 1);
3933 rb_define_method(klass
, "ensure_shareable", m_core_ensure_shareable
, 2);
3934 rb_obj_freeze(fcore
);
3935 RBASIC_CLEAR_CLASS(klass
);
3936 rb_obj_freeze(klass
);
3937 rb_vm_register_global_object(fcore
);
3938 rb_mRubyVMFrozenCore
= fcore
;
3941 * Document-class: Thread
3943 * Threads are the Ruby implementation for a concurrent programming model.
3945 * Programs that require multiple threads of execution are a perfect
3946 * candidate for Ruby's Thread class.
3948 * For example, we can create a new thread separate from the main thread's
3949 * execution using ::new.
3951 * thr = Thread.new { puts "What's the big deal" }
3953 * Then we are able to pause the execution of the main thread and allow
3954 * our new thread to finish, using #join:
3956 * thr.join #=> "What's the big deal"
3958 * If we don't call +thr.join+ before the main thread terminates, then all
3959 * other threads including +thr+ will be killed.
3961 * Alternatively, you can use an array for handling multiple threads at
3962 * once, like in the following example:
3965 * threads << Thread.new { puts "What's the big deal" }
3966 * threads << Thread.new { 3.times { puts "Threads are fun!" } }
3968 * After creating a few threads we wait for them all to finish
3971 * threads.each { |thr| thr.join }
3973 * To retrieve the last value of a thread, use #value
3975 * thr = Thread.new { sleep 1; "Useful value" }
3976 * thr.value #=> "Useful value"
3978 * === Thread initialization
3980 * In order to create new threads, Ruby provides ::new, ::start, and
3981 * ::fork. A block must be provided with each of these methods, otherwise
3982 * a ThreadError will be raised.
3984 * When subclassing the Thread class, the +initialize+ method of your
3985 * subclass will be ignored by ::start and ::fork. Otherwise, be sure to
3986 * call super in your +initialize+ method.
3988 * === Thread termination
3990 * For terminating threads, Ruby provides a variety of ways to do this.
3992 * The class method ::kill, is meant to exit a given thread:
3994 * thr = Thread.new { sleep }
3995 * Thread.kill(thr) # sends exit() to thr
3997 * Alternatively, you can use the instance method #exit, or any of its
3998 * aliases #kill or #terminate.
4004 * Ruby provides a few instance methods for querying the state of a given
4005 * thread. To get a string with the current thread's state use #status
4007 * thr = Thread.new { sleep }
4008 * thr.status # => "sleep"
4010 * thr.status # => false
4012 * You can also use #alive? to tell if the thread is running or sleeping,
4013 * and #stop? if the thread is dead or sleeping.
4015 * === Thread variables and scope
4017 * Since threads are created with blocks, the same rules apply to other
4018 * Ruby blocks for variable scope. Any local variables created within this
4019 * block are accessible to only this thread.
4021 * ==== Fiber-local vs. Thread-local
4023 * Each fiber has its own bucket for Thread#[] storage. When you set a
4024 * new fiber-local it is only accessible within this Fiber. To illustrate:
4027 * Thread.current[:foo] = "bar"
4029 * p Thread.current[:foo] # => nil
4033 * This example uses #[] for getting and #[]= for setting fiber-locals,
4034 * you can also use #keys to list the fiber-locals for a given
4035 * thread and #key? to check if a fiber-local exists.
4037 * When it comes to thread-locals, they are accessible within the entire
4038 * scope of the thread. Given the following example:
4041 * Thread.current.thread_variable_set(:foo, 1)
4042 * p Thread.current.thread_variable_get(:foo) # => 1
4044 * Thread.current.thread_variable_set(:foo, 2)
4045 * p Thread.current.thread_variable_get(:foo) # => 2
4047 * p Thread.current.thread_variable_get(:foo) # => 2
4050 * You can see that the thread-local +:foo+ carried over into the fiber
4051 * and was changed to +2+ by the end of the thread.
4053 * This example makes use of #thread_variable_set to create new
4054 * thread-locals, and #thread_variable_get to reference them.
4056 * There is also #thread_variables to list all thread-locals, and
4057 * #thread_variable? to check if a given thread-local exists.
4059 * === Exception handling
4061 * When an unhandled exception is raised inside a thread, it will
4062 * terminate. By default, this exception will not propagate to other
4063 * threads. The exception is stored and when another thread calls #value
4064 * or #join, the exception will be re-raised in that thread.
4066 * t = Thread.new{ raise 'something went wrong' }
4067 * t.value #=> RuntimeError: something went wrong
4069 * An exception can be raised from outside the thread using the
4070 * Thread#raise instance method, which takes the same parameters as
4073 * Setting Thread.abort_on_exception = true, Thread#abort_on_exception =
4074 * true, or $DEBUG = true will cause a subsequent unhandled exception
4075 * raised in a thread to be automatically re-raised in the main thread.
4077 * With the addition of the class method ::handle_interrupt, you can now
4078 * handle exceptions asynchronously with threads.
4082 * Ruby provides a few ways to support scheduling threads in your program.
4084 * The first way is by using the class method ::stop, to put the current
4085 * running thread to sleep and schedule the execution of another thread.
4087 * Once a thread is asleep, you can use the instance method #wakeup to
4088 * mark your thread as eligible for scheduling.
4090 * You can also try ::pass, which attempts to pass execution to another
4091 * thread but is dependent on the OS whether a running thread will switch
4092 * or not. The same goes for #priority, which lets you hint to the thread
4093 * scheduler which threads you want to take precedence when passing
4094 * execution. This method is also dependent on the OS and may be ignored
4095 * on some platforms.
4098 rb_cThread
= rb_define_class("Thread", rb_cObject
);
4099 rb_undef_alloc_func(rb_cThread
);
4101 #if VM_COLLECT_USAGE_DETAILS
4102 /* ::RubyVM::USAGE_ANALYSIS_* */
4103 #define define_usage_analysis_hash(name) /* shut up rdoc -C */ \
4104 rb_define_const(rb_cRubyVM, "USAGE_ANALYSIS_" #name, rb_hash_new())
4105 define_usage_analysis_hash(INSN
);
4106 define_usage_analysis_hash(REGS
);
4107 define_usage_analysis_hash(INSN_BIGRAM
);
4109 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_INSN_START", usage_analysis_insn_start
, 0);
4110 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_OPERAND_START", usage_analysis_operand_start
, 0);
4111 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_REGISTER_START", usage_analysis_register_start
, 0);
4112 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_INSN_STOP", usage_analysis_insn_stop
, 0);
4113 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_OPERAND_STOP", usage_analysis_operand_stop
, 0);
4114 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_REGISTER_STOP", usage_analysis_register_stop
, 0);
4115 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_INSN_RUNNING", usage_analysis_insn_running
, 0);
4116 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_OPERAND_RUNNING", usage_analysis_operand_running
, 0);
4117 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_REGISTER_RUNNING", usage_analysis_register_running
, 0);
4118 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_INSN_CLEAR", usage_analysis_insn_clear
, 0);
4119 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_OPERAND_CLEAR", usage_analysis_operand_clear
, 0);
4120 rb_define_singleton_method(rb_cRubyVM
, "USAGE_ANALYSIS_REGISTER_CLEAR", usage_analysis_register_clear
, 0);
4124 * An Array of VM build options.
4125 * This constant is MRI specific.
4127 rb_define_const(rb_cRubyVM
, "OPTS", opts
= rb_ary_new());
4129 #if OPT_DIRECT_THREADED_CODE
4130 rb_ary_push(opts
, rb_str_new2("direct threaded code"));
4131 #elif OPT_TOKEN_THREADED_CODE
4132 rb_ary_push(opts
, rb_str_new2("token threaded code"));
4133 #elif OPT_CALL_THREADED_CODE
4134 rb_ary_push(opts
, rb_str_new2("call threaded code"));
4137 #if OPT_OPERANDS_UNIFICATION
4138 rb_ary_push(opts
, rb_str_new2("operands unification"));
4140 #if OPT_INSTRUCTIONS_UNIFICATION
4141 rb_ary_push(opts
, rb_str_new2("instructions unification"));
4143 #if OPT_INLINE_METHOD_CACHE
4144 rb_ary_push(opts
, rb_str_new2("inline method cache"));
4147 /* ::RubyVM::INSTRUCTION_NAMES
4148 * A list of bytecode instruction names in MRI.
4149 * This constant is MRI specific.
4151 rb_define_const(rb_cRubyVM
, "INSTRUCTION_NAMES", rb_insns_name_array());
4153 /* ::RubyVM::DEFAULT_PARAMS
4154 * This constant exposes the VM's default parameters.
4155 * Note that changing these values does not affect VM execution.
4156 * Specification is not stable and you should not depend on this value.
4157 * Of course, this constant is MRI specific.
4159 rb_define_const(rb_cRubyVM
, "DEFAULT_PARAMS", vm_default_params());
4161 /* debug functions ::RubyVM::SDR(), ::RubyVM::NSDR() */
4163 rb_define_singleton_method(rb_cRubyVM
, "SDR", sdr
, 0);
4164 rb_define_singleton_method(rb_cRubyVM
, "NSDR", nsdr
, 0);
4165 rb_define_singleton_method(rb_cRubyVM
, "mtbl", vm_mtbl
, 2);
4166 rb_define_singleton_method(rb_cRubyVM
, "mtbl2", vm_mtbl2
, 2);
4174 /* VM bootstrap: phase 2 */
4176 rb_vm_t
*vm
= ruby_current_vm_ptr
;
4177 rb_thread_t
*th
= GET_THREAD();
4178 VALUE filename
= rb_fstring_lit("<main>");
4179 const rb_iseq_t
*iseq
= rb_iseq_new(Qnil
, filename
, filename
, Qnil
, 0, ISEQ_TYPE_TOP
);
4182 rb_ractor_main_setup(vm
, th
->ractor
, th
);
4184 /* create vm object */
4185 vm
->self
= TypedData_Wrap_Struct(rb_cRubyVM
, &vm_data_type
, vm
);
4187 /* create main thread */
4188 th
->self
= TypedData_Wrap_Struct(rb_cThread
, &thread_data_type
, th
);
4189 vm
->ractor
.main_thread
= th
;
4190 vm
->ractor
.main_ractor
= th
->ractor
;
4192 th
->top_wrapper
= 0;
4193 th
->top_self
= rb_vm_top_self();
4195 rb_vm_register_global_object((VALUE
)iseq
);
4196 th
->ec
->cfp
->iseq
= iseq
;
4197 th
->ec
->cfp
->pc
= ISEQ_BODY(iseq
)->iseq_encoded
;
4198 th
->ec
->cfp
->self
= th
->top_self
;
4200 VM_ENV_FLAGS_UNSET(th
->ec
->cfp
->ep
, VM_FRAME_FLAG_CFRAME
);
4201 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
));
4204 * The Binding of the top level scope
4206 rb_define_global_const("TOPLEVEL_BINDING", rb_binding_new());
4209 rb_objspace_gc_enable(vm
->objspace
);
4212 vm_init_redefined_flag();
4214 rb_block_param_proxy
= rb_obj_alloc(rb_cObject
);
4215 rb_add_method_optimized(rb_singleton_class(rb_block_param_proxy
), idCall
,
4216 OPTIMIZED_METHOD_TYPE_BLOCK_CALL
, 0, METHOD_VISI_PUBLIC
);
4217 rb_obj_freeze(rb_block_param_proxy
);
4218 rb_vm_register_global_object(rb_block_param_proxy
);
4220 /* vm_backtrace.c */
4221 Init_vm_backtrace();
4225 rb_vm_set_progname(VALUE filename
)
4227 rb_thread_t
*th
= GET_VM()->ractor
.main_thread
;
4228 rb_control_frame_t
*cfp
= (void *)(th
->ec
->vm_stack
+ th
->ec
->vm_stack_size
);
4231 filename
= rb_str_new_frozen(filename
);
4232 rb_iseq_pathobj_set(cfp
->iseq
, filename
, rb_iseq_realpath(cfp
->iseq
));
4235 extern const struct st_hash_type rb_fstring_hash_type
;
4240 /* VM bootstrap: phase 1 */
4241 rb_vm_t
*vm
= ruby_mimcalloc(1, sizeof(*vm
));
4242 rb_thread_t
*th
= ruby_mimcalloc(1, sizeof(*th
));
4244 fputs("[FATAL] failed to allocate memory\n", stderr
);
4251 rb_vm_postponed_job_queue_init(vm
);
4252 ruby_current_vm_ptr
= vm
;
4253 rb_objspace_alloc();
4254 vm
->negative_cme_table
= rb_id_table_create(16);
4255 vm
->overloaded_cme_table
= st_init_numtable();
4256 vm
->constant_cache
= rb_id_table_create(0);
4257 vm
->unused_block_warning_table
= st_init_numtable();
4259 // TODO: remove before Ruby 3.4.0 release
4260 const char *s
= getenv("RUBY_TRY_UNUSED_BLOCK_WARNING_STRICT");
4261 if (s
&& strcmp(s
, "1") == 0) {
4262 vm
->unused_block_warning_strict
= true;
4265 // setup main thread
4266 th
->nt
= ZALLOC(struct rb_native_thread
);
4268 th
->ractor
= vm
->ractor
.main_ractor
= rb_ractor_main_alloc();
4269 Init_native_thread(th
);
4273 rb_ractor_set_current_ec(th
->ractor
, th
->ec
);
4274 /* n.b. native_main_thread_stack_top is set by the INIT_STACK macro */
4275 ruby_thread_init_stack(th
, native_main_thread_stack_top
);
4277 // setup ractor system
4278 rb_native_mutex_initialize(&vm
->ractor
.sync
.lock
);
4279 rb_native_cond_initialize(&vm
->ractor
.sync
.terminate_cond
);
4281 vm_opt_method_def_table
= st_init_numtable();
4282 vm_opt_mid_table
= st_init_numtable();
4284 #ifdef RUBY_THREAD_WIN32_H
4285 rb_native_cond_initialize(&vm
->ractor
.sync
.barrier_cond
);
4290 ruby_init_stack(void *addr
)
4292 native_main_thread_stack_top
= addr
;
4297 #include <sys/mman.h>
4301 #ifndef MARK_OBJECT_ARY_BUCKET_SIZE
4302 #define MARK_OBJECT_ARY_BUCKET_SIZE 1024
4305 struct pin_array_list
{
4312 pin_array_list_mark(void *data
)
4314 struct pin_array_list
*array
= (struct pin_array_list
*)data
;
4315 rb_gc_mark_movable(array
->next
);
4317 rb_gc_mark_vm_stack_values(array
->len
, array
->array
);
4321 pin_array_list_free(void *data
)
4323 struct pin_array_list
*array
= (struct pin_array_list
*)data
;
4324 xfree(array
->array
);
4328 pin_array_list_memsize(const void *data
)
4330 return sizeof(struct pin_array_list
) + (MARK_OBJECT_ARY_BUCKET_SIZE
* sizeof(VALUE
));
4334 pin_array_list_update_references(void *data
)
4336 struct pin_array_list
*array
= (struct pin_array_list
*)data
;
4337 array
->next
= rb_gc_location(array
->next
);
4340 static const rb_data_type_t pin_array_list_type
= {
4341 .wrap_struct_name
= "VM/pin_array_list",
4343 .dmark
= pin_array_list_mark
,
4344 .dfree
= pin_array_list_free
,
4345 .dsize
= pin_array_list_memsize
,
4346 .dcompact
= pin_array_list_update_references
,
4348 .flags
= RUBY_TYPED_FREE_IMMEDIATELY
| RUBY_TYPED_WB_PROTECTED
| RUBY_TYPED_EMBEDDABLE
,
4352 pin_array_list_new(VALUE next
)
4354 struct pin_array_list
*array_list
;
4355 VALUE obj
= TypedData_Make_Struct(0, struct pin_array_list
, &pin_array_list_type
, array_list
);
4356 RB_OBJ_WRITE(obj
, &array_list
->next
, next
);
4357 array_list
->array
= ALLOC_N(VALUE
, MARK_OBJECT_ARY_BUCKET_SIZE
);
4362 pin_array_list_append(VALUE obj
, VALUE item
)
4364 struct pin_array_list
*array_list
;
4365 TypedData_Get_Struct(obj
, struct pin_array_list
, &pin_array_list_type
, array_list
);
4367 if (array_list
->len
>= MARK_OBJECT_ARY_BUCKET_SIZE
) {
4368 obj
= pin_array_list_new(obj
);
4369 TypedData_Get_Struct(obj
, struct pin_array_list
, &pin_array_list_type
, array_list
);
4372 RB_OBJ_WRITE(obj
, &array_list
->array
[array_list
->len
], item
);
4378 rb_vm_register_global_object(VALUE obj
)
4380 RUBY_ASSERT(!RB_SPECIAL_CONST_P(obj
));
4381 if (RB_SPECIAL_CONST_P(obj
)) {
4385 switch (RB_BUILTIN_TYPE(obj
)) {
4388 if (FL_TEST(obj
, RCLASS_IS_ROOT
)) {
4391 FL_SET(obj
, RCLASS_IS_ROOT
);
4398 VALUE list
= GET_VM()->mark_object_ary
;
4399 VALUE head
= pin_array_list_append(list
, obj
);
4401 GET_VM()->mark_object_ary
= head
;
4409 Init_vm_objects(void)
4411 rb_vm_t
*vm
= GET_VM();
4413 /* initialize mark object array, hash */
4414 vm
->mark_object_ary
= pin_array_list_new(Qnil
);
4415 vm
->loading_table
= st_init_strtable();
4416 vm
->ci_table
= st_init_table(&vm_ci_hashtype
);
4417 vm
->frozen_strings
= st_init_table_with_size(&rb_fstring_hash_type
, 10000);
4420 /* Stub for builtin function when not building YJIT units*/
4422 void Init_builtin_yjit(void) {}
4428 main_to_s(VALUE obj
)
4430 return rb_str_new2("main");
4434 rb_vm_top_self(void)
4436 return GET_VM()->top_self
;
4442 rb_vm_t
*vm
= GET_VM();
4444 vm
->top_self
= rb_obj_alloc(rb_cObject
);
4445 rb_define_singleton_method(rb_vm_top_self(), "to_s", main_to_s
, 0);
4446 rb_define_alias(rb_singleton_class(rb_vm_top_self()), "inspect", "to_s");
4450 rb_ruby_verbose_ptr(void)
4452 rb_ractor_t
*cr
= GET_RACTOR();
4453 return &cr
->verbose
;
4459 rb_ruby_prism_ptr(void)
4465 rb_ruby_debug_ptr(void)
4467 rb_ractor_t
*cr
= GET_RACTOR();
4471 bool rb_free_at_exit
= false;
4474 ruby_free_at_exit_p(void)
4476 return rb_free_at_exit
;
4480 VALUE
rb_insn_operand_intern(const rb_iseq_t
*iseq
,
4481 VALUE insn
, int op_no
, VALUE op
,
4482 int len
, size_t pos
, VALUE
*pnop
, VALUE child
);
4485 rb_vm_fstring_table(void)
4487 return GET_VM()->frozen_strings
;
4490 #if VM_COLLECT_USAGE_DETAILS
4492 #define HASH_ASET(h, k, v) rb_hash_aset((h), (st_data_t)(k), (st_data_t)(v))
4495 * insn(Fixnum) => ihash(Hash)
4498 * -1(Fixnum) => count, # insn usage
4499 * 0(Fixnum) => ophash, # operand usage
4502 * val(interned string) => count(Fixnum)
4506 vm_analysis_insn(int insn
)
4510 static int prev_insn
= -1;
4516 CONST_ID(usage_hash
, "USAGE_ANALYSIS_INSN");
4517 CONST_ID(bigram_hash
, "USAGE_ANALYSIS_INSN_BIGRAM");
4518 uh
= rb_const_get(rb_cRubyVM
, usage_hash
);
4519 if (NIL_P(ihash
= rb_hash_aref(uh
, INT2FIX(insn
)))) {
4520 ihash
= rb_hash_new();
4521 HASH_ASET(uh
, INT2FIX(insn
), ihash
);
4523 if (NIL_P(cv
= rb_hash_aref(ihash
, INT2FIX(-1)))) {
4526 HASH_ASET(ihash
, INT2FIX(-1), INT2FIX(FIX2INT(cv
) + 1));
4529 if (prev_insn
!= -1) {
4534 ary
[0] = INT2FIX(prev_insn
);
4535 ary
[1] = INT2FIX(insn
);
4536 bi
= rb_ary_new4(2, &ary
[0]);
4538 uh
= rb_const_get(rb_cRubyVM
, bigram_hash
);
4539 if (NIL_P(cv
= rb_hash_aref(uh
, bi
))) {
4542 HASH_ASET(uh
, bi
, INT2FIX(FIX2INT(cv
) + 1));
4548 vm_analysis_operand(int insn
, int n
, VALUE op
)
4558 CONST_ID(usage_hash
, "USAGE_ANALYSIS_INSN");
4560 uh
= rb_const_get(rb_cRubyVM
, usage_hash
);
4561 if (NIL_P(ihash
= rb_hash_aref(uh
, INT2FIX(insn
)))) {
4562 ihash
= rb_hash_new();
4563 HASH_ASET(uh
, INT2FIX(insn
), ihash
);
4565 if (NIL_P(ophash
= rb_hash_aref(ihash
, INT2FIX(n
)))) {
4566 ophash
= rb_hash_new();
4567 HASH_ASET(ihash
, INT2FIX(n
), ophash
);
4570 valstr
= rb_insn_operand_intern(GET_EC()->cfp
->iseq
, insn
, n
, op
, 0, 0, 0, 0);
4573 if (NIL_P(cv
= rb_hash_aref(ophash
, valstr
))) {
4576 HASH_ASET(ophash
, valstr
, INT2FIX(FIX2INT(cv
) + 1));
4580 vm_analysis_register(int reg
, int isset
)
4585 static const char regstrs
[][5] = {
4593 static const char getsetstr
[][4] = {
4597 static VALUE syms
[sizeof(regstrs
) / sizeof(regstrs
[0])][2];
4601 CONST_ID(usage_hash
, "USAGE_ANALYSIS_REGS");
4606 for (i
= 0; i
< (int)(sizeof(regstrs
) / sizeof(regstrs
[0])); i
++) {
4608 for (j
= 0; j
< 2; j
++) {
4609 snprintf(buff
, 0x10, "%d %s %-4s", i
, getsetstr
[j
], regstrs
[i
]);
4610 syms
[i
][j
] = ID2SYM(rb_intern(buff
));
4614 valstr
= syms
[reg
][isset
];
4616 uh
= rb_const_get(rb_cRubyVM
, usage_hash
);
4617 if (NIL_P(cv
= rb_hash_aref(uh
, valstr
))) {
4620 HASH_ASET(uh
, valstr
, INT2FIX(FIX2INT(cv
) + 1));
4625 static void (*ruby_vm_collect_usage_func_insn
)(int insn
) = NULL
;
4626 static void (*ruby_vm_collect_usage_func_operand
)(int insn
, int n
, VALUE op
) = NULL
;
4627 static void (*ruby_vm_collect_usage_func_register
)(int reg
, int isset
) = NULL
;
4631 usage_analysis_insn_start(VALUE self
)
4633 ruby_vm_collect_usage_func_insn
= vm_analysis_insn
;
4639 usage_analysis_operand_start(VALUE self
)
4641 ruby_vm_collect_usage_func_operand
= vm_analysis_operand
;
4647 usage_analysis_register_start(VALUE self
)
4649 ruby_vm_collect_usage_func_register
= vm_analysis_register
;
4655 usage_analysis_insn_stop(VALUE self
)
4657 ruby_vm_collect_usage_func_insn
= 0;
4663 usage_analysis_operand_stop(VALUE self
)
4665 ruby_vm_collect_usage_func_operand
= 0;
4671 usage_analysis_register_stop(VALUE self
)
4673 ruby_vm_collect_usage_func_register
= 0;
4679 usage_analysis_insn_running(VALUE self
)
4681 return RBOOL(ruby_vm_collect_usage_func_insn
!= 0);
4686 usage_analysis_operand_running(VALUE self
)
4688 return RBOOL(ruby_vm_collect_usage_func_operand
!= 0);
4693 usage_analysis_register_running(VALUE self
)
4695 return RBOOL(ruby_vm_collect_usage_func_register
!= 0);
4699 usage_analysis_clear(VALUE self
, ID usage_hash
)
4702 uh
= rb_const_get(self
, usage_hash
);
4711 usage_analysis_insn_clear(VALUE self
)
4716 CONST_ID(usage_hash
, "USAGE_ANALYSIS_INSN");
4717 CONST_ID(bigram_hash
, "USAGE_ANALYSIS_INSN_BIGRAM");
4718 usage_analysis_clear(rb_cRubyVM
, usage_hash
);
4719 return usage_analysis_clear(rb_cRubyVM
, bigram_hash
);
4724 usage_analysis_operand_clear(VALUE self
)
4728 CONST_ID(usage_hash
, "USAGE_ANALYSIS_INSN");
4729 return usage_analysis_clear(self
, usage_hash
);
4734 usage_analysis_register_clear(VALUE self
)
4738 CONST_ID(usage_hash
, "USAGE_ANALYSIS_REGS");
4739 return usage_analysis_clear(self
, usage_hash
);
4744 MAYBE_UNUSED(static void (*ruby_vm_collect_usage_func_insn
)(int insn
)) = 0;
4745 MAYBE_UNUSED(static void (*ruby_vm_collect_usage_func_operand
)(int insn
, int n
, VALUE op
)) = 0;
4746 MAYBE_UNUSED(static void (*ruby_vm_collect_usage_func_register
)(int reg
, int isset
)) = 0;
4750 #if VM_COLLECT_USAGE_DETAILS
4751 /* @param insn instruction number */
4753 vm_collect_usage_insn(int insn
)
4755 if (RUBY_DTRACE_INSN_ENABLED()) {
4756 RUBY_DTRACE_INSN(rb_insns_name(insn
));
4758 if (ruby_vm_collect_usage_func_insn
)
4759 (*ruby_vm_collect_usage_func_insn
)(insn
);
4762 /* @param insn instruction number
4763 * @param n n-th operand
4764 * @param op operand value
4767 vm_collect_usage_operand(int insn
, int n
, VALUE op
)
4769 if (RUBY_DTRACE_INSN_OPERAND_ENABLED()) {
4772 valstr
= rb_insn_operand_intern(GET_EC()->cfp
->iseq
, insn
, n
, op
, 0, 0, 0, 0);
4774 RUBY_DTRACE_INSN_OPERAND(RSTRING_PTR(valstr
), rb_insns_name(insn
));
4775 RB_GC_GUARD(valstr
);
4777 if (ruby_vm_collect_usage_func_operand
)
4778 (*ruby_vm_collect_usage_func_operand
)(insn
, n
, op
);
4781 /* @param reg register id. see code of vm_analysis_register() */
4782 /* @param isset 0: read, 1: write */
4784 vm_collect_usage_register(int reg
, int isset
)
4786 if (ruby_vm_collect_usage_func_register
)
4787 (*ruby_vm_collect_usage_func_register
)(reg
, isset
);
4791 const struct rb_callcache
*
4792 rb_vm_empty_cc(void)
4794 return &vm_empty_cc
;
4797 const struct rb_callcache
*
4798 rb_vm_empty_cc_for_super(void)
4800 return &vm_empty_cc_for_super
;
4803 #include "vm_call_iseq_optimized.inc" /* required from vm_insnhelper.c */