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)
15#define SHAPE_ID_FLAGS_MASK (shape_id_t)(((1 << (SHAPE_ID_NUM_BITS - SHAPE_ID_OFFSET_NUM_BITS)) - 1) << SHAPE_ID_OFFSET_NUM_BITS)
16#define SHAPE_ID_FL_FROZEN (SHAPE_FL_FROZEN << SHAPE_ID_OFFSET_NUM_BITS)
17#define SHAPE_ID_FL_HAS_OBJECT_ID (SHAPE_FL_HAS_OBJECT_ID << SHAPE_ID_OFFSET_NUM_BITS)
18#define SHAPE_ID_FL_TOO_COMPLEX (SHAPE_FL_TOO_COMPLEX << SHAPE_ID_OFFSET_NUM_BITS)
19#define SHAPE_ID_FL_NON_CANONICAL_MASK (SHAPE_FL_NON_CANONICAL_MASK << SHAPE_ID_OFFSET_NUM_BITS)
20#define SHAPE_ID_READ_ONLY_MASK (~SHAPE_ID_FL_FROZEN)
22typedef uint32_t redblack_id_t;
24#define SHAPE_MAX_FIELDS (attr_index_t)(-1)
25#define SHAPE_FLAG_SHIFT ((SIZEOF_VALUE * CHAR_BIT) - SHAPE_ID_NUM_BITS)
26#define SHAPE_FLAG_MASK (((VALUE)-1) >> SHAPE_ID_NUM_BITS)
28#define SHAPE_MAX_VARIATIONS 8
30#define INVALID_SHAPE_ID ((shape_id_t)-1)
31#define ATTR_INDEX_NOT_SET ((attr_index_t)-1)
33#define ROOT_SHAPE_ID 0x0
34#define ROOT_SHAPE_WITH_OBJ_ID 0x1
35#define ROOT_TOO_COMPLEX_SHAPE_ID (ROOT_SHAPE_ID | SHAPE_ID_FL_TOO_COMPLEX)
36#define ROOT_TOO_COMPLEX_WITH_OBJ_ID (ROOT_SHAPE_WITH_OBJ_ID | SHAPE_ID_FL_TOO_COMPLEX | SHAPE_ID_FL_HAS_OBJECT_ID)
37#define SPECIAL_CONST_SHAPE_ID (ROOT_SHAPE_ID | SHAPE_ID_FL_FROZEN)
38#define FIRST_T_OBJECT_SHAPE_ID 0x2
40extern ID ruby_internal_object_id;
49 attr_index_t next_field_index;
50 attr_index_t capacity;
72 SHAPE_FL_FROZEN = 1 << 0,
73 SHAPE_FL_HAS_OBJECT_ID = 1 << 1,
74 SHAPE_FL_TOO_COMPLEX = 1 << 2,
76 SHAPE_FL_NON_CANONICAL_MASK = SHAPE_FL_FROZEN | SHAPE_FL_HAS_OBJECT_ID,
86 unsigned int cache_size;
99rb_current_shape_tree(
void)
101 return rb_shape_tree_ptr;
103#define GET_SHAPE_TREE() rb_current_shape_tree()
105static inline shape_id_t
106RBASIC_SHAPE_ID(
VALUE obj)
110#if RBASIC_SHAPE_ID_FIELD
111 return (shape_id_t)((
RBASIC(obj)->shape_id));
113 return (shape_id_t)((
RBASIC(obj)->flags) >> SHAPE_FLAG_SHIFT);
119static inline shape_id_t
120RBASIC_SHAPE_ID_FOR_READ(
VALUE obj)
122 return RBASIC_SHAPE_ID(obj) & SHAPE_ID_READ_ONLY_MASK;
126bool rb_shape_verify_consistency(
VALUE obj, shape_id_t shape_id);
130RBASIC_SET_SHAPE_ID(
VALUE obj, shape_id_t shape_id)
134 RUBY_ASSERT(rb_shape_verify_consistency(obj, shape_id));
135#if RBASIC_SHAPE_ID_FIELD
139 RBASIC(obj)->flags &= SHAPE_FLAG_MASK;
140 RBASIC(obj)->flags |= ((
VALUE)(shape_id) << SHAPE_FLAG_SHIFT);
144#define RSHAPE rb_shape_lookup
146int32_t rb_shape_id_offset(
void);
148RUBY_FUNC_EXPORTED
rb_shape_t *rb_shape_lookup(shape_id_t shape_id);
149RUBY_FUNC_EXPORTED shape_id_t rb_obj_shape_id(
VALUE obj);
150shape_id_t rb_shape_get_next_iv_shape(shape_id_t shape_id,
ID id);
151bool rb_shape_get_iv_index(shape_id_t shape_id,
ID id, attr_index_t *value);
152bool rb_shape_get_iv_index_with_hint(shape_id_t shape_id,
ID id, attr_index_t *value, shape_id_t *shape_id_hint);
154shape_id_t rb_shape_transition_frozen(
VALUE obj);
155shape_id_t rb_shape_transition_complex(
VALUE obj);
156shape_id_t rb_shape_transition_remove_ivar(
VALUE obj,
ID id, shape_id_t *removed_shape_id);
157shape_id_t rb_shape_transition_add_ivar(
VALUE obj,
ID id);
158shape_id_t rb_shape_transition_add_ivar_no_warnings(
VALUE obj,
ID id);
159shape_id_t rb_shape_transition_object_id(
VALUE obj);
160shape_id_t rb_shape_object_id(shape_id_t original_shape_id);
162void rb_shape_free_all(
void);
164shape_id_t rb_shape_rebuild(shape_id_t initial_shape_id, shape_id_t dest_shape_id);
165void 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);
166void rb_shape_copy_complex_ivars(
VALUE dest,
VALUE obj, shape_id_t src_shape_id,
st_table *fields_table);
169rb_shape_too_complex_p(shape_id_t shape_id)
171 return shape_id & SHAPE_ID_FL_TOO_COMPLEX;
175rb_shape_obj_too_complex_p(
VALUE obj)
181rb_shape_has_object_id(shape_id_t shape_id)
183 return shape_id & SHAPE_ID_FL_HAS_OBJECT_ID;
187rb_shape_canonical_p(shape_id_t shape_id)
189 return !(shape_id & SHAPE_ID_FL_NON_CANONICAL_MASK);
192static inline shape_id_t
193rb_shape_root(
size_t heap_id)
195 return (shape_id_t)(heap_id + FIRST_T_OBJECT_SHAPE_ID);
199RSHAPE_TYPE_P(shape_id_t shape_id,
enum shape_type
type)
201 return RSHAPE(shape_id)->type ==
type;
204static inline attr_index_t
205RSHAPE_CAPACITY(shape_id_t shape_id)
207 return RSHAPE(shape_id)->capacity;
210static inline attr_index_t
211RSHAPE_LEN(shape_id_t shape_id)
213 return RSHAPE(shape_id)->next_field_index;
216static inline attr_index_t
217RSHAPE_INDEX(shape_id_t shape_id)
219 return RSHAPE_LEN(shape_id) - 1;
223RSHAPE_EDGE_NAME(shape_id_t shape_id)
225 return RSHAPE(shape_id)->edge_name;
228static inline uint32_t
229ROBJECT_FIELDS_CAPACITY(
VALUE obj)
235 return RSHAPE_CAPACITY(RBASIC_SHAPE_ID(obj));
239ROBJECT_FIELDS_HASH(
VALUE obj)
254static inline uint32_t
255ROBJECT_FIELDS_COUNT(
VALUE obj)
257 if (rb_shape_obj_too_complex_p(obj)) {
258 return (uint32_t)rb_st_table_size(ROBJECT_FIELDS_HASH(obj));
263 return RSHAPE(RBASIC_SHAPE_ID(obj))->next_field_index;
267static inline uint32_t
268RBASIC_FIELDS_COUNT(
VALUE obj)
270 return RSHAPE(rb_obj_shape_id(obj))->next_field_index;
273shape_id_t rb_shape_traverse_from_new_root(shape_id_t initial_shape_id, shape_id_t orig_shape_id);
275bool rb_obj_set_shape_id(
VALUE obj, shape_id_t shape_id);
278rb_shape_obj_has_id(
VALUE obj)
280 return rb_shape_has_object_id(RBASIC_SHAPE_ID(obj));
284RUBY_SYMBOL_EXPORT_BEGIN
285typedef void each_shape_callback(shape_id_t shape_id,
void *data);
286void rb_shape_each_shape_id(each_shape_callback callback,
void *data);
287size_t rb_shape_memsize(shape_id_t shape);
288size_t rb_shape_edges_count(shape_id_t shape_id);
289size_t rb_shape_depth(shape_id_t shape_id);
290RUBY_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 T_IMEMO
Old name of RUBY_T_IMEMO.
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.