4#include "internal/gc.h"
6typedef uint16_t attr_index_t;
7typedef uint32_t shape_id_t;
8#define SHAPE_ID_NUM_BITS 32
9#define SHAPE_ID_OFFSET_NUM_BITS 19
11STATIC_ASSERT(shape_id_num_bits, SHAPE_ID_NUM_BITS ==
sizeof(shape_id_t) * CHAR_BIT);
13#define SHAPE_BUFFER_SIZE (1 << SHAPE_ID_OFFSET_NUM_BITS)
14#define SHAPE_ID_OFFSET_MASK (SHAPE_BUFFER_SIZE - 1)
16#define SHAPE_ID_HEAP_INDEX_BITS 3
17#define SHAPE_ID_HEAP_INDEX_MAX ((1 << SHAPE_ID_HEAP_INDEX_BITS) - 1)
19#define SHAPE_ID_FL_USHIFT (SHAPE_ID_OFFSET_NUM_BITS + SHAPE_ID_HEAP_INDEX_BITS)
20#define SHAPE_ID_HEAP_INDEX_OFFSET SHAPE_ID_FL_USHIFT
34enum shape_id_fl_type {
35#define RBIMPL_SHAPE_ID_FL(n) (1<<(SHAPE_ID_FL_USHIFT+n))
37 SHAPE_ID_HEAP_INDEX_MASK = RBIMPL_SHAPE_ID_FL(0) | RBIMPL_SHAPE_ID_FL(1) | RBIMPL_SHAPE_ID_FL(2),
39 SHAPE_ID_FL_FROZEN = RBIMPL_SHAPE_ID_FL(3),
40 SHAPE_ID_FL_HAS_OBJECT_ID = RBIMPL_SHAPE_ID_FL(4),
41 SHAPE_ID_FL_TOO_COMPLEX = RBIMPL_SHAPE_ID_FL(5),
43 SHAPE_ID_FL_NON_CANONICAL_MASK = SHAPE_ID_FL_FROZEN | SHAPE_ID_FL_HAS_OBJECT_ID,
44 SHAPE_ID_FLAGS_MASK = SHAPE_ID_HEAP_INDEX_MASK | SHAPE_ID_FL_NON_CANONICAL_MASK | SHAPE_ID_FL_TOO_COMPLEX,
46#undef RBIMPL_SHAPE_ID_FL
51#define SHAPE_ID_HAS_IVAR_MASK (SHAPE_ID_FL_TOO_COMPLEX | (SHAPE_ID_OFFSET_MASK - 1))
56#define SHAPE_ID_READ_ONLY_MASK (~(SHAPE_ID_FL_FROZEN | SHAPE_ID_HEAP_INDEX_MASK))
58typedef uint32_t redblack_id_t;
60#define SHAPE_MAX_FIELDS (attr_index_t)(-1)
61#define SHAPE_FLAG_SHIFT ((SIZEOF_VALUE * CHAR_BIT) - SHAPE_ID_NUM_BITS)
62#define SHAPE_FLAG_MASK (((VALUE)-1) >> SHAPE_ID_NUM_BITS)
64#define SHAPE_MAX_VARIATIONS 8
66#define INVALID_SHAPE_ID ((shape_id_t)-1)
67#define ATTR_INDEX_NOT_SET ((attr_index_t)-1)
69#define ROOT_SHAPE_ID 0x0
70#define ROOT_SHAPE_WITH_OBJ_ID 0x1
71#define ROOT_TOO_COMPLEX_SHAPE_ID (ROOT_SHAPE_ID | SHAPE_ID_FL_TOO_COMPLEX)
72#define ROOT_TOO_COMPLEX_WITH_OBJ_ID (ROOT_SHAPE_WITH_OBJ_ID | SHAPE_ID_FL_TOO_COMPLEX | SHAPE_ID_FL_HAS_OBJECT_ID)
73#define SPECIAL_CONST_SHAPE_ID (ROOT_SHAPE_ID | SHAPE_ID_FL_FROZEN)
82 attr_index_t next_field_index;
83 attr_index_t capacity;
103 SHAPE_FL_FROZEN = 1 << 0,
104 SHAPE_FL_HAS_OBJECT_ID = 1 << 1,
105 SHAPE_FL_TOO_COMPLEX = 1 << 2,
107 SHAPE_FL_NON_CANONICAL_MASK = SHAPE_FL_FROZEN | SHAPE_FL_HAS_OBJECT_ID,
114 const attr_index_t *capacities;
118 unsigned int cache_size;
121RUBY_SYMBOL_EXPORT_BEGIN
123RUBY_SYMBOL_EXPORT_END
133static inline shape_id_t
134RBASIC_SHAPE_ID(
VALUE obj)
138#if RBASIC_SHAPE_ID_FIELD
139 return (shape_id_t)((
RBASIC(obj)->shape_id));
141 return (shape_id_t)((
RBASIC(obj)->flags) >> SHAPE_FLAG_SHIFT);
147static inline shape_id_t
148RBASIC_SHAPE_ID_FOR_READ(
VALUE obj)
150 return RBASIC_SHAPE_ID(obj) & SHAPE_ID_READ_ONLY_MASK;
154bool rb_shape_verify_consistency(
VALUE obj, shape_id_t shape_id);
158RBASIC_SET_SHAPE_ID(
VALUE obj, shape_id_t shape_id)
162#if RBASIC_SHAPE_ID_FIELD
166 RBASIC(obj)->flags &= SHAPE_FLAG_MASK;
167 RBASIC(obj)->flags |= ((
VALUE)(shape_id) << SHAPE_FLAG_SHIFT);
169 RUBY_ASSERT(rb_shape_verify_consistency(obj, shape_id));
172void rb_set_namespaced_class_shape_id(
VALUE obj, shape_id_t shape_id);
175RB_SET_SHAPE_ID(
VALUE obj, shape_id_t shape_id)
180 rb_set_namespaced_class_shape_id(obj, shape_id);
183 RBASIC_SET_SHAPE_ID(obj, shape_id);
189RSHAPE(shape_id_t shape_id)
191 uint32_t offset = (shape_id & SHAPE_ID_OFFSET_MASK);
194 return &rb_shape_tree.shape_list[offset];
197int32_t rb_shape_id_offset(
void);
199RUBY_FUNC_EXPORTED shape_id_t rb_obj_shape_id(
VALUE obj);
200shape_id_t rb_shape_get_next_iv_shape(shape_id_t shape_id,
ID id);
201bool rb_shape_get_iv_index(shape_id_t shape_id,
ID id, attr_index_t *value);
202bool rb_shape_get_iv_index_with_hint(shape_id_t shape_id,
ID id, attr_index_t *value, shape_id_t *shape_id_hint);
203bool rb_shape_find_ivar(shape_id_t shape_id,
ID id, shape_id_t *ivar_shape);
205typedef int rb_shape_foreach_transition_callback(shape_id_t shape_id,
void *data);
206bool rb_shape_foreach_field(shape_id_t shape_id, rb_shape_foreach_transition_callback func,
void *data);
208shape_id_t rb_shape_transition_frozen(
VALUE obj);
209shape_id_t rb_shape_transition_complex(
VALUE obj);
210shape_id_t rb_shape_transition_remove_ivar(
VALUE obj,
ID id, shape_id_t *removed_shape_id);
211shape_id_t rb_shape_transition_add_ivar(
VALUE obj,
ID id);
212shape_id_t rb_shape_transition_add_ivar_no_warnings(
VALUE obj,
ID id);
213shape_id_t rb_shape_transition_object_id(
VALUE obj);
214shape_id_t rb_shape_transition_heap(
VALUE obj,
size_t heap_index);
215shape_id_t rb_shape_object_id(shape_id_t original_shape_id);
217void rb_shape_free_all(
void);
219shape_id_t rb_shape_rebuild(shape_id_t initial_shape_id, shape_id_t dest_shape_id);
220void rb_shape_copy_fields(
VALUE dest,
VALUE *dest_buf, shape_id_t dest_shape_id,
VALUE src,
VALUE *src_buf, shape_id_t src_shape_id);
221void rb_shape_copy_complex_ivars(
VALUE dest,
VALUE obj, shape_id_t src_shape_id,
st_table *fields_table);
224rb_shape_too_complex_p(shape_id_t shape_id)
226 return shape_id & SHAPE_ID_FL_TOO_COMPLEX;
230rb_shape_obj_too_complex_p(
VALUE obj)
236rb_shape_has_object_id(shape_id_t shape_id)
238 return shape_id & SHAPE_ID_FL_HAS_OBJECT_ID;
242rb_shape_canonical_p(shape_id_t shape_id)
244 return !(shape_id & SHAPE_ID_FL_NON_CANONICAL_MASK);
248rb_shape_heap_index(shape_id_t shape_id)
250 return (uint8_t)((shape_id & SHAPE_ID_HEAP_INDEX_MASK) >> SHAPE_ID_HEAP_INDEX_OFFSET);
253static inline shape_id_t
254rb_shape_root(
size_t heap_id)
256 shape_id_t heap_index = (shape_id_t)(heap_id + 1);
257 shape_id_t heap_flags = heap_index << SHAPE_ID_HEAP_INDEX_OFFSET;
259 RUBY_ASSERT((heap_flags & SHAPE_ID_HEAP_INDEX_MASK) == heap_flags);
260 RUBY_ASSERT(rb_shape_heap_index(heap_flags) == heap_index);
262 return ROOT_SHAPE_ID | heap_flags;
265static inline shape_id_t
266RSHAPE_PARENT(shape_id_t shape_id)
268 return RSHAPE(shape_id)->parent_id;
271static inline enum shape_type
272RSHAPE_TYPE(shape_id_t shape_id)
274 return RSHAPE(shape_id)->type;
278RSHAPE_TYPE_P(shape_id_t shape_id,
enum shape_type
type)
280 return RSHAPE_TYPE(shape_id) ==
type;
283static inline attr_index_t
284RSHAPE_EMBEDDED_CAPACITY(shape_id_t shape_id)
286 uint8_t heap_index = rb_shape_heap_index(shape_id);
288 return rb_shape_tree.capacities[heap_index - 1];
293static inline attr_index_t
294RSHAPE_CAPACITY(shape_id_t shape_id)
296 attr_index_t embedded_capacity = RSHAPE_EMBEDDED_CAPACITY(shape_id);
298 if (embedded_capacity > RSHAPE(shape_id)->capacity) {
299 return embedded_capacity;
302 return RSHAPE(shape_id)->capacity;
306static inline attr_index_t
307RSHAPE_LEN(shape_id_t shape_id)
309 return RSHAPE(shape_id)->next_field_index;
312static inline attr_index_t
313RSHAPE_INDEX(shape_id_t shape_id)
315 return RSHAPE_LEN(shape_id) - 1;
319RSHAPE_EDGE_NAME(shape_id_t shape_id)
321 return RSHAPE(shape_id)->edge_name;
324static inline uint32_t
325ROBJECT_FIELDS_CAPACITY(
VALUE obj)
331 return RSHAPE_CAPACITY(RBASIC_SHAPE_ID(obj));
335ROBJECT_FIELDS_HASH(
VALUE obj)
350static inline uint32_t
351ROBJECT_FIELDS_COUNT(
VALUE obj)
353 if (rb_shape_obj_too_complex_p(obj)) {
354 return (uint32_t)rb_st_table_size(ROBJECT_FIELDS_HASH(obj));
359 return RSHAPE(RBASIC_SHAPE_ID(obj))->next_field_index;
363static inline uint32_t
364RBASIC_FIELDS_COUNT(
VALUE obj)
366 return RSHAPE(rb_obj_shape_id(obj))->next_field_index;
369bool rb_obj_set_shape_id(
VALUE obj, shape_id_t shape_id);
372rb_shape_obj_has_id(
VALUE obj)
374 return rb_shape_has_object_id(RBASIC_SHAPE_ID(obj));
378rb_shape_has_ivars(shape_id_t shape_id)
380 return shape_id & SHAPE_ID_HAS_IVAR_MASK;
384rb_shape_obj_has_ivars(
VALUE obj)
386 return rb_shape_has_ivars(RBASIC_SHAPE_ID(obj));
390rb_shape_has_fields(shape_id_t shape_id)
392 return shape_id & (SHAPE_ID_OFFSET_MASK | SHAPE_ID_FL_TOO_COMPLEX);
396rb_shape_obj_has_fields(
VALUE obj)
398 return rb_shape_has_fields(RBASIC_SHAPE_ID(obj));
402rb_obj_exivar_p(
VALUE obj)
414 return rb_shape_obj_has_fields(obj);
418RUBY_SYMBOL_EXPORT_BEGIN
419typedef void each_shape_callback(shape_id_t shape_id,
void *data);
420void rb_shape_each_shape_id(each_shape_callback callback,
void *data);
421size_t rb_shape_memsize(shape_id_t shape);
422size_t rb_shape_edges_count(shape_id_t shape_id);
423size_t rb_shape_depth(shape_id_t shape_id);
424RUBY_SYMBOL_EXPORT_END
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_EXTERN
Declaration of externally visible global variables.
#define TYPE(_)
Old name of rb_type.
#define T_IMEMO
Old name of RUBY_T_IMEMO.
#define T_NONE
Old name of RUBY_T_NONE.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
VALUE type(ANYARGS)
ANYARGS-ed function type.
#define RBASIC(obj)
Convenient casting macro.
#define ROBJECT(obj)
Convenient casting macro.
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.