Ruby: iseq.h Source File

Ruby 3.4.8p72 (2025-12-17 revision 995b59f66677d44767ce9faac6957e5543617ff9)

iseq.h
1#ifndef RUBY_ISEQ_H
2#define RUBY_ISEQ_H 1
3/**********************************************************************
4
5 iseq.h -
6
7 $Author$
8 created at: 04/01/01 23:36:57 JST
9
10 Copyright (C) 2004-2008 Koichi Sasada
11
12**********************************************************************/
13#include "internal/gc.h"
14#include "shape.h"
15#include "vm_core.h"
16#include "prism_compile.h"
17
18 RUBY_EXTERN const int ruby_api_version[];
19#define ISEQ_MAJOR_VERSION ((unsigned int)ruby_api_version[0])
20#define ISEQ_MINOR_VERSION ((unsigned int)ruby_api_version[1])
21
22#define ISEQ_MBITS_SIZE sizeof(iseq_bits_t)
23#define ISEQ_MBITS_BITLENGTH (ISEQ_MBITS_SIZE * CHAR_BIT)
24#define ISEQ_MBITS_SET(buf, i) (buf[(i) / ISEQ_MBITS_BITLENGTH] |= ((iseq_bits_t)1 << ((i) % ISEQ_MBITS_BITLENGTH)))
25#define ISEQ_MBITS_SET_P(buf, i) ((buf[(i) / ISEQ_MBITS_BITLENGTH] >> ((i) % ISEQ_MBITS_BITLENGTH)) & 0x1)
26#define ISEQ_MBITS_BUFLEN(size) roomof(size, ISEQ_MBITS_BITLENGTH)
27
28#ifndef USE_ISEQ_NODE_ID
29#define USE_ISEQ_NODE_ID 1
30#endif
31
32#ifndef rb_iseq_t
33typedef struct rb_iseq_struct rb_iseq_t;
34#define rb_iseq_t rb_iseq_t
35#endif
36typedef void (*rb_iseq_callback)(const rb_iseq_t *, void *);
37
38extern const ID rb_iseq_shared_exc_local_tbl[];
39
40#define ISEQ_COVERAGE(iseq) ISEQ_BODY(iseq)->variable.coverage
41#define ISEQ_COVERAGE_SET(iseq, cov) RB_OBJ_WRITE(iseq, &ISEQ_BODY(iseq)->variable.coverage, cov)
42#define ISEQ_LINE_COVERAGE(iseq) RARRAY_AREF(ISEQ_COVERAGE(iseq), COVERAGE_INDEX_LINES)
43#define ISEQ_BRANCH_COVERAGE(iseq) RARRAY_AREF(ISEQ_COVERAGE(iseq), COVERAGE_INDEX_BRANCHES)
44
45#define ISEQ_PC2BRANCHINDEX(iseq) ISEQ_BODY(iseq)->variable.pc2branchindex
46#define ISEQ_PC2BRANCHINDEX_SET(iseq, h) RB_OBJ_WRITE(iseq, &ISEQ_BODY(iseq)->variable.pc2branchindex, h)
47
48#define ISEQ_FLIP_CNT(iseq) ISEQ_BODY(iseq)->variable.flip_count
49
50#define ISEQ_FROZEN_STRING_LITERAL_ENABLED 1
51#define ISEQ_FROZEN_STRING_LITERAL_DISABLED 0
52#define ISEQ_FROZEN_STRING_LITERAL_UNSET -1
53
54static inline rb_snum_t
55ISEQ_FLIP_CNT_INCREMENT(const rb_iseq_t *iseq)
56{
57 rb_snum_t cnt = ISEQ_BODY(iseq)->variable.flip_count;
58 ISEQ_BODY(iseq)->variable.flip_count += 1;
59 return cnt;
60}
61
62static inline VALUE *
63ISEQ_ORIGINAL_ISEQ(const rb_iseq_t *iseq)
64{
65 return ISEQ_BODY(iseq)->variable.original_iseq;
66}
67
68static inline void
69ISEQ_ORIGINAL_ISEQ_CLEAR(const rb_iseq_t *iseq)
70{
71 void *ptr = ISEQ_BODY(iseq)->variable.original_iseq;
72 ISEQ_BODY(iseq)->variable.original_iseq = NULL;
73 ruby_xfree(ptr);
74}
75
76static inline VALUE *
77ISEQ_ORIGINAL_ISEQ_ALLOC(const rb_iseq_t *iseq, long size)
78{
79 return ISEQ_BODY(iseq)->variable.original_iseq =
80 ALLOC_N(VALUE, size);
81}
82
83#define ISEQ_TRACE_EVENTS (RUBY_EVENT_LINE | \
84 RUBY_EVENT_CLASS | \
85 RUBY_EVENT_END | \
86 RUBY_EVENT_CALL | \
87 RUBY_EVENT_RETURN| \
88 RUBY_EVENT_C_CALL| \
89 RUBY_EVENT_C_RETURN | \
90 RUBY_EVENT_B_CALL | \
91 RUBY_EVENT_B_RETURN | \
92 RUBY_EVENT_RESCUE | \
93 RUBY_EVENT_COVERAGE_LINE| \
94 RUBY_EVENT_COVERAGE_BRANCH)
95
96#define ISEQ_NOT_LOADED_YET IMEMO_FL_USER1
97#define ISEQ_USE_COMPILE_DATA IMEMO_FL_USER2
98#define ISEQ_TRANSLATED IMEMO_FL_USER3
99
100#define ISEQ_EXECUTABLE_P(iseq) (FL_TEST_RAW(((VALUE)iseq), ISEQ_NOT_LOADED_YET | ISEQ_USE_COMPILE_DATA) == 0)
101
102 struct iseq_compile_data {
103 /* GC is needed */
104 const VALUE err_info;
105 const VALUE catch_table_ary; /* Array */
106
107 /* GC is not needed */
108 struct iseq_label_data *start_label;
109 struct iseq_label_data *end_label;
110 struct iseq_label_data *redo_label;
111 const rb_iseq_t *current_block;
112 struct iseq_compile_data_ensure_node_stack *ensure_node_stack;
113 struct {
114 struct iseq_compile_data_storage *storage_head;
115 struct iseq_compile_data_storage *storage_current;
116 } node;
117 struct {
118 struct iseq_compile_data_storage *storage_head;
119 struct iseq_compile_data_storage *storage_current;
120 } insn;
121 bool in_rescue;
122 bool in_masgn;
123 int loopval_popped; /* used by NODE_BREAK */
124 int last_line;
125 int label_no;
126 int node_level;
127 int isolated_depth;
128 unsigned int ci_index;
129 unsigned int ic_index;
130 const rb_compile_option_t *option;
131 struct rb_id_table *ivar_cache_table;
132 const struct rb_builtin_function *builtin_function_table;
133 const NODE *root_node;
134 bool catch_except_p; // If a frame of this ISeq may catch exception, set true.
135#if OPT_SUPPORT_JOKE
136 st_table *labels_table;
137#endif
138};
139
140static inline struct iseq_compile_data *
141ISEQ_COMPILE_DATA(const rb_iseq_t *iseq)
142{
143 if (iseq->flags & ISEQ_USE_COMPILE_DATA) {
144 return iseq->aux.compile_data;
145 }
146 else {
147 return NULL;
148 }
149}
150
151static inline void
152ISEQ_COMPILE_DATA_ALLOC(rb_iseq_t *iseq)
153{
154 iseq->aux.compile_data = ZALLOC(struct iseq_compile_data);
155 iseq->flags |= ISEQ_USE_COMPILE_DATA;
156}
157
158static inline void
159ISEQ_COMPILE_DATA_CLEAR(rb_iseq_t *iseq)
160{
161 iseq->flags &= ~ISEQ_USE_COMPILE_DATA;
162 iseq->aux.compile_data = NULL;
163}
164
165static inline rb_iseq_t *
166iseq_imemo_alloc(void)
167{
168 return IMEMO_NEW(rb_iseq_t, imemo_iseq, 0);
169}
170
171 VALUE rb_iseq_ibf_dump(const rb_iseq_t *iseq, VALUE opt);
172void rb_ibf_load_iseq_complete(rb_iseq_t *iseq);
173const rb_iseq_t *rb_iseq_ibf_load(VALUE str);
174const rb_iseq_t *rb_iseq_ibf_load_bytes(const char *cstr, size_t);
175 VALUE rb_iseq_ibf_load_extra_data(VALUE str);
176void rb_iseq_init_trace(rb_iseq_t *iseq);
177int rb_iseq_add_local_tracepoint_recursively(const rb_iseq_t *iseq, rb_event_flag_t turnon_events, VALUE tpval, unsigned int target_line, bool target_bmethod);
178int rb_iseq_remove_local_tracepoint_recursively(const rb_iseq_t *iseq, VALUE tpval);
179const rb_iseq_t *rb_iseq_load_iseq(VALUE fname);
180int rb_iseq_opt_frozen_string_literal(void);
181
182#if VM_INSN_INFO_TABLE_IMPL == 2
183unsigned int *rb_iseq_insns_info_decode_positions(const struct rb_iseq_constant_body *body);
184#endif
185
186int rb_vm_insn_addr2opcode(const void *addr);
187
188RUBY_SYMBOL_EXPORT_BEGIN
189
190/* compile.c */
191 VALUE rb_iseq_compile_node(rb_iseq_t *iseq, const NODE *node);
192 VALUE rb_iseq_compile_callback(rb_iseq_t *iseq, const struct rb_iseq_new_with_callback_callback_func * ifunc);
193 VALUE *rb_iseq_original_iseq(const rb_iseq_t *iseq);
194void rb_iseq_build_from_ary(rb_iseq_t *iseq, VALUE misc,
195 VALUE locals, VALUE args,
196 VALUE exception, VALUE body);
197void rb_iseq_mark_and_pin_insn_storage(struct iseq_compile_data_storage *arena);
198
199 VALUE rb_iseq_load(VALUE data, VALUE parent, VALUE opt);
200 VALUE rb_iseq_parameters(const rb_iseq_t *iseq, int is_proc);
201unsigned int rb_iseq_line_no(const rb_iseq_t *iseq, size_t pos);
202#ifdef USE_ISEQ_NODE_ID
203int rb_iseq_node_id(const rb_iseq_t *iseq, size_t pos);
204#endif
205void rb_iseq_trace_set(const rb_iseq_t *iseq, rb_event_flag_t turnon_events);
206void rb_iseq_trace_set_all(rb_event_flag_t turnon_events);
207void rb_iseq_insns_info_encode_positions(const rb_iseq_t *iseq);
208
209struct rb_iseq_constant_body *rb_iseq_constant_body_alloc(void);
210 VALUE rb_iseqw_new(const rb_iseq_t *iseq);
211const rb_iseq_t *rb_iseqw_to_iseq(VALUE iseqw);
212
213 VALUE rb_iseq_absolute_path(const rb_iseq_t *iseq); /* obsolete */
214int rb_iseq_from_eval_p(const rb_iseq_t *iseq);
215 VALUE rb_iseq_type(const rb_iseq_t *iseq);
216 VALUE rb_iseq_label(const rb_iseq_t *iseq);
217 VALUE rb_iseq_base_label(const rb_iseq_t *iseq);
218 VALUE rb_iseq_first_lineno(const rb_iseq_t *iseq);
219 VALUE rb_iseq_method_name(const rb_iseq_t *iseq);
220void rb_iseq_code_location(const rb_iseq_t *iseq, int *first_lineno, int *first_column, int *last_lineno, int *last_column);
221
222void rb_iseq_remove_coverage_all(void);
223
224/* proc.c */
225const rb_iseq_t *rb_method_iseq(VALUE body);
226const rb_iseq_t *rb_proc_get_iseq(VALUE proc, int *is_proc);
227
228 struct rb_compile_option_struct {
229 unsigned int inline_const_cache: 1;
230 unsigned int peephole_optimization: 1;
231 unsigned int tailcall_optimization: 1;
232 unsigned int specialized_instruction: 1;
233 unsigned int operands_unification: 1;
234 unsigned int instructions_unification: 1;
235 signed int frozen_string_literal: 2; /* -1: not specified, 0: false, 1: true */
236 unsigned int debug_frozen_string_literal: 1;
237 unsigned int coverage_enabled: 1;
238 int debug_level;
239};
240
241 struct iseq_insn_info_entry {
242 int line_no;
243#ifdef USE_ISEQ_NODE_ID
244 int node_id;
245#endif
246 rb_event_flag_t events;
247};
248
249/*
250 * iseq type:
251 * CATCH_TYPE_RESCUE, CATCH_TYPE_ENSURE:
252 * use iseq as continuation.
253 *
254 * CATCH_TYPE_BREAK (iter):
255 * use iseq as key.
256 *
257 * CATCH_TYPE_BREAK (while), CATCH_TYPE_RETRY,
258 * CATCH_TYPE_REDO, CATCH_TYPE_NEXT:
259 * NULL.
260 */
261enum rb_catch_type {
262 CATCH_TYPE_RESCUE = INT2FIX(1),
263 CATCH_TYPE_ENSURE = INT2FIX(2),
264 CATCH_TYPE_RETRY = INT2FIX(3),
265 CATCH_TYPE_BREAK = INT2FIX(4),
266 CATCH_TYPE_REDO = INT2FIX(5),
267 CATCH_TYPE_NEXT = INT2FIX(6)
268};
269
270 struct iseq_catch_table_entry {
271 enum rb_catch_type type;
272 rb_iseq_t *iseq;
273
274 unsigned int start;
275 unsigned int end;
276 unsigned int cont;
277 unsigned int sp;
278};
279
280RBIMPL_ATTR_PACKED_STRUCT_UNALIGNED_BEGIN()
281struct iseq_catch_table {
282 unsigned int size;
283 struct iseq_catch_table_entry entries[FLEX_ARY_LEN];
284} RBIMPL_ATTR_PACKED_STRUCT_UNALIGNED_END();
285
286static inline int
287iseq_catch_table_bytes(int n)
288{
289 enum {
290 catch_table_entry_size = sizeof(struct iseq_catch_table_entry),
291 catch_table_entries_max = (INT_MAX - offsetof(struct iseq_catch_table, entries)) / catch_table_entry_size
292 };
293 if (n > catch_table_entries_max) rb_fatal("too large iseq_catch_table - %d", n);
294 return (int)(offsetof(struct iseq_catch_table, entries) +
295 n * catch_table_entry_size);
296}
297
298#define INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE (512)
299
300 struct iseq_compile_data_storage {
301 struct iseq_compile_data_storage *next;
302 unsigned int pos;
303 unsigned int size;
304 char buff[FLEX_ARY_LEN];
305};
306
307/* defined? */
308
309enum defined_type {
310 DEFINED_NOT_DEFINED,
311 DEFINED_NIL = 1,
312 DEFINED_IVAR,
313 DEFINED_LVAR,
314 DEFINED_GVAR,
315 DEFINED_CVAR,
316 DEFINED_CONST,
317 DEFINED_METHOD,
318 DEFINED_YIELD,
319 DEFINED_ZSUPER,
320 DEFINED_SELF,
321 DEFINED_TRUE,
322 DEFINED_FALSE,
323 DEFINED_ASGN,
324 DEFINED_EXPR,
325 DEFINED_REF,
326 DEFINED_FUNC,
327 DEFINED_CONST_FROM
328};
329
330 VALUE rb_iseq_defined_string(enum defined_type type);
331
332/* vm.c */
333 VALUE rb_iseq_local_variables(const rb_iseq_t *iseq);
334
335attr_index_t rb_estimate_iv_count(VALUE klass, const rb_iseq_t * initialize_iseq);
336
337void rb_free_encoded_insn_data(void);
338
339RUBY_SYMBOL_EXPORT_END
340
341#endif /* RUBY_ISEQ_H */
RUBY_EXTERN
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
rb_event_flag_t
uint32_t rb_event_flag_t
Represents event(s).
Definition event.h:108
INT2FIX
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
ZALLOC
#define ZALLOC
Old name of RB_ZALLOC.
Definition memory.h:402
ALLOC_N
#define ALLOC_N
Old name of RB_ALLOC_N.
Definition memory.h:399
ruby_api_version
const int ruby_api_version[3]
API versions, in { major, minor, teeny } order.
Definition version.c:48
ruby::backward::cxxanyargs::type
VALUE type(ANYARGS)
ANYARGS-ed function type.
Definition cxxanyargs.hpp:56
RNode
Definition rubyparser.h:240
iseq_catch_table_entry
Definition iseq.h:270
iseq_catch_table
Definition iseq.h:281
iseq_compile_data_ensure_node_stack
Definition compile.c:121
iseq_compile_data_storage
Definition iseq.h:300
iseq_compile_data
Definition iseq.h:102
iseq_insn_info_entry
Definition iseq.h:241
iseq_label_data
Definition compile.c:78
rb_builtin_function
Definition builtin.h:6
rb_compile_option_struct
Definition iseq.h:228
rb_id_table
Definition id_table.c:41
rb_iseq_constant_body
Definition vm_core.h:404
rb_iseq_new_with_callback_callback_func
Definition vm_core.h:1233
rb_iseq_struct
Definition vm_core.h:568
st_table
Definition st.h:79
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