Ruby 3.5.0dev (2025-09-17 revision 6094cb51136418a7b545baa84b6ede0aaeb2eaac)
imemo.h
1#ifndef INTERNAL_IMEMO_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_IMEMO_H
11#include "ruby/internal/config.h"
12#include <stddef.h> /* for size_t */
13#include "id_table.h"
14#include "internal/array.h" /* for rb_ary_hidden_new_fill */
15#include "ruby/internal/stdbool.h" /* for bool */
16#include "ruby/ruby.h" /* for rb_block_call_func_t */
17
18#define IMEMO_MASK 0x0f
19
20/* FL_USER0 to FL_USER3 is for type */
21#define IMEMO_FL_USHIFT (FL_USHIFT + 4)
22#define IMEMO_FL_USER0 FL_USER4
23#define IMEMO_FL_USER1 FL_USER5
24#define IMEMO_FL_USER2 FL_USER6
25#define IMEMO_FL_USER3 FL_USER7
26#define IMEMO_FL_USER4 FL_USER8
27#define IMEMO_FL_USER5 FL_USER9
28#define IMEMO_FL_USER6 FL_USER10
29
30enum imemo_type {
31 imemo_env = 0,
32 imemo_cref = 1,
33 imemo_svar = 2,
34 imemo_throw_data = 3,
35 imemo_ifunc = 4,
36 imemo_memo = 5,
37 imemo_ment = 6,
38 imemo_iseq = 7,
39 imemo_tmpbuf = 8,
40 imemo_callinfo = 10,
41 imemo_callcache = 11,
42 imemo_constcache = 12,
43 imemo_fields = 13,
44};
45
46/* CREF (Class REFerence) is defined in method.h */
47
49struct vm_svar {
50 VALUE flags;
52 const VALUE lastline;
53 const VALUE backref;
54 const VALUE others;
55};
56
59 VALUE flags;
60 VALUE reserved;
61 const VALUE throw_obj;
62 const struct rb_control_frame_struct *catch_frame;
63 int throw_state;
64};
65
66#define THROW_DATA_CONSUMED IMEMO_FL_USER0
67
68/* IFUNC (Internal FUNCtion) */
69
71#if SIZEOF_INT * 2 > SIZEOF_VALUE
72 signed int min: (SIZEOF_VALUE * CHAR_BIT) / 2;
73 signed int max: (SIZEOF_VALUE * CHAR_BIT) / 2;
74#else
75 int min, max;
76#endif
77};
78
85struct vm_ifunc {
86 VALUE flags;
87 VALUE *svar_lep;
89 const void *data;
90 struct vm_ifunc_argc argc;
91};
92#define IFUNC_YIELD_OPTIMIZABLE IMEMO_FL_USER0
93
95 VALUE flags;
96 VALUE *ptr; /* malloc'ed buffer */
97 size_t cnt; /* buffer size in VALUE */
98};
99
104struct MEMO {
105 VALUE flags;
106 VALUE reserved;
107 const VALUE v1;
108 const VALUE v2;
109 union {
110 long cnt;
111 long state;
112 const VALUE value;
113 void (*func)(void);
114 } u3;
115};
116
117#define IMEMO_NEW(T, type, v0) ((T *)rb_imemo_new((type), (v0), sizeof(T)))
118
119/* ment is in method.h */
120
121#define THROW_DATA_P(err) imemo_throw_data_p((VALUE)err)
122#define MEMO_CAST(m) ((struct MEMO *)(m))
123#define MEMO_FOR(type, value) ((type *)RARRAY_PTR(value))
124#define NEW_MEMO_FOR(type, value) \
125 ((value) = rb_ary_hidden_new_fill(type_roomof(type, VALUE)), MEMO_FOR(type, value))
126#define NEW_PARTIAL_MEMO_FOR(type, value, member) \
127 ((value) = rb_ary_hidden_new_fill(type_roomof(type, VALUE)), \
128 rb_ary_set_len((value), offsetof(type, member) / sizeof(VALUE)), \
129 MEMO_FOR(type, value))
130
131#ifndef RUBY_RUBYPARSER_H
133#endif
134VALUE rb_imemo_new(enum imemo_type type, VALUE v0, size_t size);
135VALUE rb_imemo_tmpbuf_new(void);
136struct vm_ifunc *rb_vm_ifunc_new(rb_block_call_func_t func, const void *data, int min_argc, int max_argc);
137static inline enum imemo_type imemo_type(VALUE imemo);
138static inline int imemo_type_p(VALUE imemo, enum imemo_type imemo_type);
139static inline bool imemo_throw_data_p(VALUE imemo);
140static inline struct vm_ifunc *rb_vm_ifunc_proc_new(rb_block_call_func_t func, const void *data);
141static inline void *RB_IMEMO_TMPBUF_PTR(VALUE v);
142static inline void *rb_imemo_tmpbuf_set_ptr(VALUE v, void *ptr);
143static inline void MEMO_V1_SET(struct MEMO *m, VALUE v);
144static inline void MEMO_V2_SET(struct MEMO *m, VALUE v);
145
146size_t rb_imemo_memsize(VALUE obj);
147void rb_imemo_mark_and_move(VALUE obj, bool reference_updating);
148void rb_imemo_free(VALUE obj);
149
150RUBY_SYMBOL_EXPORT_BEGIN
151const char *rb_imemo_name(enum imemo_type type);
152RUBY_SYMBOL_EXPORT_END
153
154static inline struct MEMO *
155MEMO_NEW(VALUE a, VALUE b, VALUE c)
156{
157 struct MEMO *memo = IMEMO_NEW(struct MEMO, imemo_memo, 0);
158 *((VALUE *)&memo->v1) = a;
159 *((VALUE *)&memo->v2) = b;
160 *((VALUE *)&memo->u3.value) = c;
161
162 return memo;
163}
164
165static inline enum imemo_type
166imemo_type(VALUE imemo)
167{
168 return (RBASIC(imemo)->flags >> FL_USHIFT) & IMEMO_MASK;
169}
170
171static inline int
172imemo_type_p(VALUE imemo, enum imemo_type imemo_type)
173{
174 if (LIKELY(!RB_SPECIAL_CONST_P(imemo))) {
175 /* fixed at compile time if imemo_type is given. */
176 const VALUE mask = (IMEMO_MASK << FL_USHIFT) | RUBY_T_MASK;
177 const VALUE expected_type = (imemo_type << FL_USHIFT) | T_IMEMO;
178 /* fixed at runtime. */
179 return expected_type == (RBASIC(imemo)->flags & mask);
180 }
181 else {
182 return 0;
183 }
184}
185
186#define IMEMO_TYPE_P(v, t) imemo_type_p((VALUE)(v), t)
187
188static inline bool
189imemo_throw_data_p(VALUE imemo)
190{
191 return RB_TYPE_P(imemo, T_IMEMO);
192}
193
194static inline struct vm_ifunc *
195rb_vm_ifunc_proc_new(rb_block_call_func_t func, const void *data)
196{
197 return rb_vm_ifunc_new(func, data, 0, UNLIMITED_ARGUMENTS);
198}
199
200static inline void *
201RB_IMEMO_TMPBUF_PTR(VALUE v)
202{
203 const struct rb_imemo_tmpbuf_struct *p = (const void *)v;
204 return p->ptr;
205}
206
207static inline void *
208rb_imemo_tmpbuf_set_ptr(VALUE v, void *ptr)
209{
210 return ((rb_imemo_tmpbuf_t *)v)->ptr = ptr;
211}
212
213static inline VALUE
214rb_imemo_tmpbuf_new_from_an_RString(VALUE str)
215{
216 const void *src;
217 VALUE imemo;
218 rb_imemo_tmpbuf_t *tmpbuf;
219 void *dst;
220 size_t len;
221
222 StringValue(str);
223 /* create tmpbuf to keep the pointer before xmalloc */
224 imemo = rb_imemo_tmpbuf_new();
225 tmpbuf = (rb_imemo_tmpbuf_t *)imemo;
226 len = RSTRING_LEN(str);
227 src = RSTRING_PTR(str);
228 dst = ruby_xmalloc(len);
229 memcpy(dst, src, len);
230 tmpbuf->ptr = dst;
231 return imemo;
232}
233
234static inline void
235MEMO_V1_SET(struct MEMO *m, VALUE v)
236{
237 RB_OBJ_WRITE(m, &m->v1, v);
238}
239
240static inline void
241MEMO_V2_SET(struct MEMO *m, VALUE v)
242{
243 RB_OBJ_WRITE(m, &m->v2, v);
244}
245
246struct rb_fields {
247 struct RBasic basic;
248 union {
249 struct {
250 VALUE fields[1];
251 } embed;
252 struct {
253 VALUE *ptr;
254 } external;
255 struct {
256 // Note: the st_table could be embedded, but complex T_CLASS should be rare to
257 // non-existent, so not really worth the trouble.
258 st_table *table;
259 } complex;
260 } as;
261};
262
263// IMEMO/fields and T_OBJECT have exactly the same layout.
264// This is useful for JIT and common codepaths.
265#define OBJ_FIELD_HEAP ROBJECT_HEAP
266STATIC_ASSERT(imemo_fields_flags, OBJ_FIELD_HEAP == IMEMO_FL_USER0);
267STATIC_ASSERT(imemo_fields_embed_offset, offsetof(struct RObject, as.ary) == offsetof(struct rb_fields, as.embed.fields));
268STATIC_ASSERT(imemo_fields_embed_offset, offsetof(struct RObject, as.heap.fields) == offsetof(struct rb_fields, as.external.ptr));
269STATIC_ASSERT(imemo_fields_embed_offset, offsetof(struct RObject, as.heap.fields) == offsetof(struct rb_fields, as.complex.table));
270
271#define IMEMO_OBJ_FIELDS(fields) ((struct rb_fields *)fields)
272
273VALUE rb_imemo_fields_new(VALUE owner, size_t capa);
274VALUE rb_imemo_fields_new_complex(VALUE owner, size_t capa);
275VALUE rb_imemo_fields_new_complex_tbl(VALUE owner, st_table *tbl);
276VALUE rb_imemo_fields_clone(VALUE fields_obj);
277void rb_imemo_fields_clear(VALUE fields_obj);
278
279static inline VALUE
280rb_imemo_fields_owner(VALUE fields_obj)
281{
282 RUBY_ASSERT(IMEMO_TYPE_P(fields_obj, imemo_fields));
283
284 return CLASS_OF(fields_obj);
285}
286
287static inline VALUE *
288rb_imemo_fields_ptr(VALUE fields_obj)
289{
290 if (!fields_obj) {
291 return NULL;
292 }
293
294 RUBY_ASSERT(IMEMO_TYPE_P(fields_obj, imemo_fields) || RB_TYPE_P(fields_obj, T_OBJECT));
295
296 if (UNLIKELY(FL_TEST_RAW(fields_obj, OBJ_FIELD_HEAP))) {
297 return IMEMO_OBJ_FIELDS(fields_obj)->as.external.ptr;
298 }
299 else {
300 return IMEMO_OBJ_FIELDS(fields_obj)->as.embed.fields;
301 }
302}
303
304static inline st_table *
305rb_imemo_fields_complex_tbl(VALUE fields_obj)
306{
307 if (!fields_obj) {
308 return NULL;
309 }
310
311 RUBY_ASSERT(IMEMO_TYPE_P(fields_obj, imemo_fields) || RB_TYPE_P(fields_obj, T_OBJECT));
312 RUBY_ASSERT(FL_TEST_RAW(fields_obj, OBJ_FIELD_HEAP));
313
314 // Some codepaths unconditionally access the fields_ptr, and assume it can be used as st_table if the
315 // shape is too_complex.
316 RUBY_ASSERT((st_table *)rb_imemo_fields_ptr(fields_obj) == IMEMO_OBJ_FIELDS(fields_obj)->as.complex.table);
317
318 return IMEMO_OBJ_FIELDS(fields_obj)->as.complex.table;
319}
320
321#endif /* INTERNAL_IMEMO_H */
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:206
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:131
#define T_OBJECT
Old name of RUBY_T_OBJECT.
Definition value_type.h:75
#define FL_USHIFT
Old name of RUBY_FL_USHIFT.
Definition fl_type.h:68
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
#define UNLIMITED_ARGUMENTS
This macro is used in conjunction with rb_check_arity().
Definition error.h:35
int capa
Designed capacity of the buffer.
Definition io.h:11
int len
Length of the buffer.
Definition io.h:8
rb_block_call_func * rb_block_call_func_t
Shorthand type that represents an iterator-written-in-C function pointer.
Definition iterator.h:88
VALUE type(ANYARGS)
ANYARGS-ed function type.
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define StringValue(v)
Ensures that the parameter object is a String.
Definition rstring.h:66
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
C99 shim for <stdbool.h>
MEMO.
Definition imemo.h:104
Ruby object's base components.
Definition rbasic.h:69
Ruby's ordinal objects.
Definition robject.h:85
VALUE * fields
Pointer to a C array that holds instance variables.
Definition robject.h:99
struct RObject::@48::@49 heap
Object that use separated memory region for instance variables use this pattern.
Definition st.h:79
IFUNC (Internal FUNCtion)
Definition imemo.h:85
SVAR (Special VARiable)
Definition imemo.h:49
const VALUE cref_or_me
class reference or rb_method_entry_t
Definition imemo.h:51
THROW_DATA.
Definition imemo.h:58
#define SIZEOF_VALUE
Identical to sizeof(VALUE), except it is a macro that can also be used inside of preprocessor directi...
Definition value.h:69
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
@ RUBY_T_MASK
Bitmask of ruby_value_type.
Definition value_type.h:145