Ruby: internal/vm.h Source File

Ruby 3.3.7p123 (2025-01-15 revision be31f993d7fa0219d85f7b3c694d454da4ecc10b)

vm.h
1#ifndef INTERNAL_VM_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_VM_H
11#include "ruby/internal/stdbool.h" /* for bool */
12#include "internal/serial.h" /* for rb_serial_t */
13#include "internal/static_assert.h" /* for STATIC_ASSERT */
14#include "ruby/ruby.h" /* for ID */
15#include "ruby/st.h" /* for st_table */
16
17#ifdef rb_funcallv
18# undef rb_funcallv
19#endif
20
21#ifdef rb_method_basic_definition_p
22# undef rb_method_basic_definition_p
23#endif
24
25struct rb_callable_method_entry_struct; /* in method.h */
26struct rb_method_definition_struct; /* in method.h */
27struct rb_execution_context_struct; /* in vm_core.h */
28struct rb_control_frame_struct; /* in vm_core.h */
29struct rb_callinfo; /* in vm_core.h */
30
31enum method_missing_reason {
32 MISSING_NOENTRY = 0x00,
33 MISSING_PRIVATE = 0x01,
34 MISSING_PROTECTED = 0x02,
35 MISSING_FCALL = 0x04,
36 MISSING_VCALL = 0x08,
37 MISSING_SUPER = 0x10,
38 MISSING_MISSING = 0x20,
39 MISSING_NONE = 0x40
40};
41
42/* vm_insnhelper.h */
43 VALUE rb_vm_push_frame_fname(struct rb_execution_context_struct *ec, VALUE fname);
44
45/* vm.c */
46 VALUE rb_obj_is_thread(VALUE obj);
47void rb_vm_mark(void *ptr);
48void rb_vm_each_stack_value(void *ptr, void (*cb)(VALUE, void*), void *ctx);
49PUREFUNC(VALUE rb_vm_top_self(void));
50const void **rb_vm_get_insns_address_table(void);
51 VALUE rb_source_location(int *pline);
52const char *rb_source_location_cstr(int *pline);
53void rb_vm_pop_cfunc_frame(void);
54int rb_vm_add_root_module(VALUE module);
55void rb_vm_check_redefinition_by_prepend(VALUE klass);
56int rb_vm_check_optimizable_mid(VALUE mid);
57 VALUE rb_yield_refine_block(VALUE refinement, VALUE refinements);
58 VALUE ruby_vm_special_exception_copy(VALUE);
59PUREFUNC(st_table *rb_vm_fstring_table(void));
60
61void rb_lastline_set_up(VALUE val, unsigned int up);
62
63/* vm_eval.c */
64 VALUE rb_current_realfilepath(void);
65 VALUE rb_check_block_call(VALUE, ID, int, const VALUE *, rb_block_call_func_t, VALUE);
66typedef void rb_check_funcall_hook(int, VALUE, ID, int, const VALUE *, VALUE);
67 VALUE rb_check_funcall_with_hook(VALUE recv, ID mid, int argc, const VALUE *argv,
68 rb_check_funcall_hook *hook, VALUE arg);
69 VALUE rb_check_funcall_with_hook_kw(VALUE recv, ID mid, int argc, const VALUE *argv,
70 rb_check_funcall_hook *hook, VALUE arg, int kw_splat);
71const char *rb_type_str(enum ruby_value_type type);
72 VALUE rb_check_funcall_default(VALUE, ID, int, const VALUE *, VALUE);
73 VALUE rb_check_funcall_basic_kw(VALUE, ID, VALUE, int, const VALUE*, int);
74 VALUE rb_yield_1(VALUE val);
75 VALUE rb_yield_force_blockarg(VALUE values);
76 VALUE rb_lambda_call(VALUE obj, ID mid, int argc, const VALUE *argv,
77 rb_block_call_func_t bl_proc, int min_argc, int max_argc,
78 VALUE data2);
79void rb_check_stack_overflow(void);
80
81#if USE_YJIT
82/* vm_exec.c */
83extern uint64_t rb_vm_insns_count;
84#endif
85
86extern bool rb_free_at_exit;
87
88/* miniinit.c and builtin.c */
89void rb_free_loaded_builtin_table(void);
90
91/* vm_insnhelper.c */
92 VALUE rb_equal_opt(VALUE obj1, VALUE obj2);
93 VALUE rb_eql_opt(VALUE obj1, VALUE obj2);
94
95struct rb_iseq_struct;
96const struct rb_callcache *rb_vm_search_method_slowpath(const struct rb_callinfo *ci, VALUE klass);
97
98/* vm_method.c */
99struct rb_execution_context_struct;
100int rb_ec_obj_respond_to(struct rb_execution_context_struct *ec, VALUE obj, ID id, int priv);
101
102void rb_clear_constant_cache(void);
103
104/* vm_dump.c */
105void rb_print_backtrace(FILE *);
106
107/* vm_backtrace.c */
108 VALUE rb_vm_thread_backtrace(int argc, const VALUE *argv, VALUE thval);
109 VALUE rb_vm_thread_backtrace_locations(int argc, const VALUE *argv, VALUE thval);
110 VALUE rb_vm_backtrace(int argc, const VALUE * argv, struct rb_execution_context_struct * ec);
111 VALUE rb_vm_backtrace_locations(int argc, const VALUE * argv, struct rb_execution_context_struct * ec);
112 VALUE rb_make_backtrace(void);
113void rb_backtrace_print_as_bugreport(FILE*);
114int rb_backtrace_p(VALUE obj);
115 VALUE rb_backtrace_to_str_ary(VALUE obj);
116 VALUE rb_backtrace_to_location_ary(VALUE obj);
117void rb_backtrace_each(VALUE (*iter)(VALUE recv, VALUE str), VALUE output);
118int rb_frame_info_p(VALUE obj);
119int rb_get_node_id_from_frame_info(VALUE obj);
120const struct rb_iseq_struct *rb_get_iseq_from_frame_info(VALUE obj);
121
122 VALUE rb_ec_backtrace_object(const struct rb_execution_context_struct *ec);
123void rb_backtrace_use_iseq_first_lineno_for_last_location(VALUE self);
124
125#define RUBY_DTRACE_CREATE_HOOK(name, arg) \
126 RUBY_DTRACE_HOOK(name##_CREATE, arg)
127#define RUBY_DTRACE_HOOK(name, arg) \
128do { \
129 if (UNLIKELY(RUBY_DTRACE_##name##_ENABLED())) { \
130 int dtrace_line; \
131 const char *dtrace_file = rb_source_location_cstr(&dtrace_line); \
132 if (!dtrace_file) dtrace_file = ""; \
133 RUBY_DTRACE_##name(arg, dtrace_file, dtrace_line); \
134 } \
135} while (0)
136#endif /* INTERNAL_VM_H */
rb_block_call_func_t
rb_block_call_func * rb_block_call_func_t
Shorthand type that represents an iterator-written-in-C function pointer.
Definition iterator.h:88
ruby::backward::cxxanyargs::type
VALUE type(ANYARGS)
ANYARGS-ed function type.
Definition cxxanyargs.hpp:56
ruby.h
stdbool.h
C99 shim for <stdbool.h>
rb_callable_method_entry_struct
Definition method.h:62
rb_callcache
Definition vm_callinfo.h:273
rb_callinfo
Definition vm_callinfo.h:61
rb_control_frame_struct
Definition vm_core.h:854
rb_execution_context_struct
Definition vm_core.h:987
rb_iseq_struct
Definition vm_core.h:534
rb_method_definition_struct
Definition method.h:178
ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
ruby_value_type
ruby_value_type
C-level type of an object.
Definition value_type.h:112