1#ifndef INTERNAL_CLASS_H
2#define INTERNAL_CLASS_H
13#include "internal/box.h"
14#include "internal/serial.h"
15#include "internal/static_assert.h"
16#include "internal/variable.h"
21#include "ruby_assert.h"
33 rb_serial_t global_cvar_state;
56 const VALUE refined_class;
62 VALUE attached_object;
68 uint16_t superclass_depth;
69 attr_index_t max_iv_count;
70 uint8_t variation_count;
71 bool permanent_classpath : 1;
72 bool shared_const_tbl : 1;
73 bool iclass_is_origin : 1;
74 bool iclass_origin_shared_mtbl : 1;
75 bool superclasses_with_self : 1;
76 bool expect_no_ivar : 1;
80STATIC_ASSERT(shape_max_variations, SHAPE_MAX_VARIATIONS < (1 << (
sizeof(((
rb_classext_t *)0)->variation_count) * CHAR_BIT)));
96#if SIZEOF_VALUE >= SIZEOF_LONG_LONG
107static const uint16_t RCLASS_MAX_SUPERCLASS_DEPTH = ((uint16_t)-1);
109static inline bool RCLASS_SINGLETON_P(
VALUE klass);
111static inline bool RCLASS_PRIME_CLASSEXT_READABLE_P(
VALUE obj);
112static inline bool RCLASS_PRIME_CLASSEXT_WRITABLE_P(
VALUE obj);
113static inline void RCLASS_SET_PRIME_CLASSEXT_WRITABLE(
VALUE obj,
bool writable);
115#define RCLASS_EXT_PRIME(c) (&((struct RClass_and_rb_classext_t*)(c))->classext)
116#define RCLASS_EXT_PRIME_P(ext, c) (&((struct RClass_and_rb_classext_t*)(c))->classext == ext)
124#define RCLASSEXT_BOX(ext) (ext->box)
125#define RCLASSEXT_SUPER(ext) (ext->super)
126#define RCLASSEXT_FIELDS(ext) (ext->fields_obj ? ROBJECT_FIELDS(ext->fields_obj) : NULL)
127#define RCLASSEXT_FIELDS_OBJ(ext) (ext->fields_obj)
128#define RCLASSEXT_M_TBL(ext) (ext->m_tbl)
129#define RCLASSEXT_CONST_TBL(ext) (ext->const_tbl)
130#define RCLASSEXT_CALLABLE_M_TBL(ext) (ext->callable_m_tbl)
131#define RCLASSEXT_CC_TBL(ext) (ext->cc_tbl)
132#define RCLASSEXT_CVC_TBL(ext) (ext->cvc_tbl)
133#define RCLASSEXT_SUPERCLASS_DEPTH(ext) (ext->superclass_depth)
134#define RCLASSEXT_SUPERCLASSES(ext) (ext->superclasses)
135#define RCLASSEXT_SUBCLASSES(ext) (ext->subclasses)
136#define RCLASSEXT_ORIGIN(ext) (ext->origin_)
137#define RCLASSEXT_REFINED_CLASS(ext) (ext->refined_class)
139#define RCLASSEXT_INCLUDER(ext) (ext->as.iclass.includer)
140#define RCLASSEXT_PERMANENT_CLASSPATH(ext) (ext->permanent_classpath)
141#define RCLASSEXT_SHARED_CONST_TBL(ext) (ext->shared_const_tbl)
142#define RCLASSEXT_ICLASS_IS_ORIGIN(ext) (ext->iclass_is_origin)
143#define RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext) (ext->iclass_origin_shared_mtbl)
144#define RCLASSEXT_SUPERCLASSES_WITH_SELF(ext) (ext->superclasses_with_self)
145#define RCLASSEXT_CLASSPATH(ext) (ext->classpath)
151#define RCLASS_PRIME_BOX(c) (RCLASS_EXT_PRIME(c)->box)
154#define RCLASS_PRIME_FIELDS_OBJ(c) (RCLASS_EXT_PRIME(c)->fields_obj)
155#define RCLASS_PRIME_M_TBL(c) (RCLASS_EXT_PRIME(c)->m_tbl)
156#define RCLASS_PRIME_CONST_TBL(c) (RCLASS_EXT_PRIME(c)->const_tbl)
157#define RCLASS_PRIME_CALLABLE_M_TBL(c) (RCLASS_EXT_PRIME(c)->callable_m_tbl)
158#define RCLASS_PRIME_CC_TBL(c) (RCLASS_EXT_PRIME(c)->cc_tbl)
159#define RCLASS_M_TBL_NOT_PRIME_P(c, tbl) (RCLASS_EXT_PRIME(c)->m_tbl != tbl)
160#define RCLASS_CALLABLE_M_TBL_NOT_PRIME_P(c, tbl) (RCLASS_EXT_PRIME(c)->callable_m_tbl != tbl)
161#define RCLASS_CC_TBL_NOT_PRIME_P(c, tbl) (RCLASS_EXT_PRIME(c)->cc_tbl != tbl)
164#define RCLASS_SUPER(c) (RCLASS_EXT_READABLE(c)->super)
165#define RCLASS_M_TBL(c) (RCLASS_EXT_READABLE(c)->m_tbl)
166#define RCLASS_CONST_TBL(c) (RCLASS_EXT_READABLE(c)->const_tbl)
171#define RCLASS_CVC_TBL(c) (RCLASS_EXT_READABLE(c)->cvc_tbl)
172#define RCLASS_SUBCLASSES(c) (RCLASS_EXT_PRIME(c)->subclasses)
173#define RCLASS_ORIGIN(c) (RCLASS_EXT_READABLE(c)->origin_)
174#define RICLASS_IS_ORIGIN_P(c) (RCLASS_EXT_READABLE(c)->iclass_is_origin)
175#define RCLASS_PERMANENT_CLASSPATH_P(c) (RCLASS_EXT_READABLE(c)->permanent_classpath)
176#define RCLASS_CLASSPATH(c) (RCLASS_EXT_READABLE(c)->classpath)
179#define RCLASS_SUPERCLASS_DEPTH(c) (RCLASS_EXT_PRIME(c)->superclass_depth)
180#define RCLASS_SUPERCLASSES(c) (RCLASS_EXT_PRIME(c)->superclasses)
181#define RCLASS_SUPERCLASSES_WITH_SELF_P(c) (RCLASS_EXT_PRIME(c)->superclasses_with_self)
184#define RCLASS_REFINED_CLASS(c) (RCLASS_EXT_PRIME(c)->refined_class)
185#define RCLASS_ATTACHED_OBJECT(c) (RCLASS_EXT_PRIME(c)->as.singleton_class.attached_object)
186#define RCLASS_INCLUDER(c) (RCLASS_EXT_PRIME(c)->as.iclass.includer)
189#define RCLASS_MAX_IV_COUNT(ext) (RCLASS_EXT_PRIME(ext)->max_iv_count)
190#define RCLASS_VARIATION_COUNT(ext) (RCLASS_EXT_PRIME(ext)->variation_count)
193#define RCLASS_WRITABLE_M_TBL(c) (RCLASS_EXT_WRITABLE(c)->m_tbl)
194#define RCLASS_WRITABLE_CONST_TBL(c) (RCLASS_EXT_WRITABLE(c)->const_tbl)
195#define RCLASS_WRITABLE_CALLABLE_M_TBL(c) (RCLASS_EXT_WRITABLE(c)->callable_m_tbl)
196#define RCLASS_WRITABLE_CC_TBL(c) (RCLASS_EXT_WRITABLE(c)->cc_tbl)
197#define RCLASS_WRITABLE_CVC_TBL(c) (RCLASS_EXT_WRITABLE(c)->cvc_tbl)
199#define RCLASS_WRITABLE_SUBCLASSES(c) (RCLASS_EXT_PRIME(c)->subclasses)
201static inline void RCLASS_SET_SUPER(
VALUE klass,
VALUE super);
202static inline void RCLASS_WRITE_SUPER(
VALUE klass,
VALUE super);
203static inline void RCLASS_SET_CONST_TBL(
VALUE klass,
struct rb_id_table *table,
bool shared);
204static inline void RCLASS_WRITE_CONST_TBL(
VALUE klass,
struct rb_id_table *table,
bool shared);
205static inline void RCLASS_WRITE_CALLABLE_M_TBL(
VALUE klass,
struct rb_id_table *table);
206static inline void RCLASS_WRITE_CC_TBL(
VALUE klass,
VALUE table);
207static inline void RCLASS_SET_CVC_TBL(
VALUE klass,
VALUE table);
208static inline void RCLASS_WRITE_CVC_TBL(
VALUE klass,
VALUE table);
210static inline void RCLASS_WRITE_SUPERCLASSES(
VALUE klass,
size_t depth,
VALUE *superclasses,
bool with_self);
211static inline void RCLASS_SET_SUBCLASSES(
VALUE klass,
VALUE subclasses);
213static inline void RCLASS_SET_ORIGIN(
VALUE klass,
VALUE origin);
214static inline void RCLASS_WRITE_ORIGIN(
VALUE klass,
VALUE origin);
215static inline void RICLASS_SET_ORIGIN_SHARED_MTBL(
VALUE iclass);
216static inline void RICLASS_WRITE_ORIGIN_SHARED_MTBL(
VALUE iclass);
217static inline bool RICLASS_OWNS_M_TBL_P(
VALUE iclass);
219static inline void RCLASS_SET_REFINED_CLASS(
VALUE klass,
VALUE refined);
222static inline VALUE RCLASS_SET_ATTACHED_OBJECT(
VALUE klass,
VALUE attached_object);
224static inline void RCLASS_SET_INCLUDER(
VALUE iclass,
VALUE klass);
225static inline void RCLASS_SET_MAX_IV_COUNT(
VALUE klass, attr_index_t count);
226static inline void RCLASS_SET_CLASSPATH(
VALUE klass,
VALUE classpath,
bool permanent);
227static inline void RCLASS_WRITE_CLASSPATH(
VALUE klass,
VALUE classpath,
bool permanent);
229#define RCLASS_IS_ROOT FL_USER0
231#define RCLASS_PRIME_CLASSEXT_WRITABLE FL_USER2
232#define RCLASS_IS_INITIALIZED FL_USER3
234#define RCLASS_BOXABLE FL_USER4
235#define RCLASS_ALLOCATOR_DEFINED FL_USER5
236#define RCLASS_HAS_SUBCLASSES FL_USER6
239RCLASS_CLASSEXT_TBL(
VALUE klass)
243 return box_klass->box_classext_tbl;
253 box_klass->box_classext_tbl = tbl;
258void rb_class_ensure_writable(
VALUE obj);
266 st_table *tbl = RCLASS_CLASSEXT_TBL(obj);
267 VM_ASSERT(BOX_MUTABLE_P(box));
268 VM_ASSERT(box->box_object);
269 VM_ASSERT(RCLASSEXT_BOX(ext) == box);
271 tbl = st_init_numtable_with_size(1);
272 RCLASS_SET_CLASSEXT_TBL(obj, tbl);
274 if (rb_st_table_size(tbl) == 0) {
278 rb_class_set_box_classext(obj, box, ext);
283#define VM_ASSERT_BOXABLE_TYPE(klass) \
284 VM_ASSERT(RB_TYPE_P(klass, T_CLASS) || RB_TYPE_P(klass, T_MODULE) || RB_TYPE_P(klass, T_ICLASS), "%s is not boxable type", rb_type_str(BUILTIN_TYPE(klass)))
287RCLASS_PRIME_CLASSEXT_READABLE_P(
VALUE klass)
289 VM_ASSERT(klass != 0,
"klass should be a valid object");
290 VM_ASSERT_BOXABLE_TYPE(klass);
292 return !
FL_TEST_RAW(klass, RCLASS_BOXABLE) || RCLASS_CLASSEXT_TBL(klass) == NULL;
296RCLASS_PRIME_CLASSEXT_WRITABLE_P(
VALUE klass)
298 VM_ASSERT(klass != 0,
"klass should be a valid object");
299 VM_ASSERT_BOXABLE_TYPE(klass);
301 return FL_TEST_RAW(klass, RCLASS_PRIME_CLASSEXT_WRITABLE);
305RCLASS_SET_PRIME_CLASSEXT_WRITABLE(
VALUE klass,
bool writable)
307 VM_ASSERT(klass != 0,
"klass should be a valid object");
308 VM_ASSERT_BOXABLE_TYPE(klass);
310 FL_SET_RAW(klass, RCLASS_PRIME_CLASSEXT_WRITABLE);
318RCLASS_EXT_TABLE_LOOKUP_INTERNAL(
VALUE obj,
const rb_box_t *box)
320 st_data_t classext_ptr;
321 st_table *classext_tbl = RCLASS_CLASSEXT_TBL(obj);
323 if (rb_st_lookup(classext_tbl, (st_data_t)box->box_object, &classext_ptr)) {
333 rb_classext_t *ext = RCLASS_EXT_TABLE_LOOKUP_INTERNAL(obj, box);
337 return RCLASS_EXT_PRIME(obj);
343 if (BOX_MASTER_P(box)
344 || RCLASS_PRIME_CLASSEXT_READABLE_P(obj)) {
345 return RCLASS_EXT_PRIME(obj);
347 return RCLASS_EXT_READABLE_LOOKUP(obj, box);
351RCLASS_EXT_READABLE(
VALUE obj)
354 if (RCLASS_PRIME_CLASSEXT_READABLE_P(obj)) {
355 return RCLASS_EXT_PRIME(obj);
358 box = rb_current_box();
359 if (BOX_MASTER_P(box)) {
360 return RCLASS_EXT_PRIME(obj);
362 return RCLASS_EXT_READABLE_LOOKUP(obj, box);
371 ext = RCLASS_EXT_TABLE_LOOKUP_INTERNAL(obj, box);
377 ext = RCLASS_EXT_TABLE_LOOKUP_INTERNAL(obj, box);
379 ext = rb_class_duplicate_classext(RCLASS_EXT_PRIME(obj), obj, box);
380 first_set = RCLASS_SET_BOX_CLASSEXT(obj, box, ext);
383 RCLASS_SET_PRIME_CLASSEXT_WRITABLE(obj,
false);
393 if (BOX_MASTER_P(box)
394 || RCLASS_PRIME_CLASSEXT_WRITABLE_P(obj)) {
395 return RCLASS_EXT_PRIME(obj);
397 return RCLASS_EXT_WRITABLE_LOOKUP(obj, box);
401RCLASS_EXT_WRITABLE(
VALUE obj)
404 if (LIKELY(RCLASS_PRIME_CLASSEXT_WRITABLE_P(obj))) {
405 return RCLASS_EXT_PRIME(obj);
408 box = rb_current_box();
409 if (BOX_MASTER_P(box)) {
410 return RCLASS_EXT_PRIME(obj);
412 return RCLASS_EXT_WRITABLE_LOOKUP(obj, box);
425 RB_OBJ_WRITE(klass, &(RCLASSEXT_INCLUDER(ext)), includer);
429typedef void rb_class_classext_foreach_callback_func(
rb_classext_t *classext,
bool is_prime,
VALUE box_value,
void *arg);
430void rb_class_classext_foreach(
VALUE klass, rb_class_classext_foreach_callback_func *func,
void *arg);
431void rb_class_subclass_add(
VALUE super,
VALUE klass);
433void rb_class_update_superclasses(
VALUE);
434int rb_singleton_class_internal_p(
VALUE sklass);
439void rb_class_set_initialized(
VALUE klass);
440void rb_module_check_initializable(
VALUE module);
448VALUE rb_class_undefined_instance_methods(
VALUE mod);
452void rb_undef_methods_from(
VALUE klass,
VALUE super);
454VALUE rb_keyword_error_new(
const char *,
VALUE);
460RUBY_SYMBOL_EXPORT_BEGIN
465unsigned char rb_class_variation_count(
VALUE klass);
467RUBY_SYMBOL_EXPORT_END
470RCLASS_SINGLETON_P(
VALUE klass)
479 RB_OBJ_WRITE(klass, &RCLASSEXT_SUPER(RCLASS_EXT_PRIME(klass)), super);
485 RB_OBJ_WRITE(klass, &RCLASSEXT_SUPER(RCLASS_EXT_WRITABLE(klass)), super);
489RCLASS_WRITABLE_ENSURE_FIELDS_OBJ(
VALUE obj)
493 if (!ext->fields_obj) {
494 RB_OBJ_WRITE(obj, &ext->fields_obj, rb_imemo_fields_new(obj, ROOT_SHAPE_ID,
true));
496 return ext->fields_obj;
500RCLASS_WRITABLE_FIELDS_OBJ(
VALUE obj)
503 return RCLASSEXT_FIELDS_OBJ(RCLASS_EXT_WRITABLE(obj));
511 RB_OBJ_ATOMIC_WRITE(obj, &ext->fields_obj, fields_obj);
515RCLASS_WRITABLE_SET_FIELDS_OBJ(
VALUE obj,
VALUE fields_obj)
519 RCLASSEXT_SET_FIELDS_OBJ(obj, RCLASS_EXT_WRITABLE(obj), fields_obj);
522static inline uint32_t
523RCLASS_FIELDS_COUNT(
VALUE obj)
527 VALUE fields_obj = RCLASS_WRITABLE_FIELDS_OBJ(obj);
529 if (rb_obj_shape_complex_p(fields_obj)) {
530 return (uint32_t)rb_st_table_size(rb_imemo_fields_complex_tbl(fields_obj));
533 return RSHAPE_LEN(RBASIC_SHAPE_ID(fields_obj));
542 RCLASSEXT_M_TBL(RCLASS_EXT_PRIME(klass)) = table;
548 RCLASSEXT_M_TBL(RCLASS_EXT_WRITABLE(klass)) = table;
555 RCLASSEXT_CONST_TBL(ext) = table;
557 RCLASSEXT_SHARED_CONST_TBL(ext) =
true;
564 RCLASSEXT_CONST_TBL(ext) = table;
566 RCLASSEXT_SHARED_CONST_TBL(ext) =
true;
572 RCLASSEXT_CALLABLE_M_TBL(RCLASS_EXT_WRITABLE(klass)) = table;
578 RB_OBJ_ATOMIC_WRITE(klass, &RCLASSEXT_CC_TBL(RCLASS_EXT_WRITABLE(klass)), table);
584 RB_OBJ_ATOMIC_WRITE(klass, &RCLASSEXT_CVC_TBL(RCLASS_EXT_PRIME(klass)), table);
590 RB_OBJ_ATOMIC_WRITE(klass, &RCLASSEXT_CVC_TBL(RCLASS_EXT_WRITABLE(klass)), table);
594RCLASS_SET_REFINED_CLASS(
VALUE klass,
VALUE refined)
596 RB_OBJ_WRITE(klass, &RCLASSEXT_REFINED_CLASS(RCLASS_EXT_PRIME(klass)), refined);
600RCLASS_ALLOCATOR(
VALUE klass)
602 RBIMPL_ASSERT_TYPE(klass,
T_CLASS);
604 return RCLASS_EXT_PRIME(klass)->as.class.allocator;
612 RCLASS_EXT_PRIME(klass)->as.class.allocator = allocator;
620 if (klass != origin) RCLASSEXT_ICLASS_IS_ORIGIN(RCLASS_EXT_WRITABLE(origin)) =
true;
628 if (klass != origin) RCLASSEXT_ICLASS_IS_ORIGIN(RCLASS_EXT_WRITABLE(origin)) =
true;
632RICLASS_SET_ORIGIN_SHARED_MTBL(
VALUE iclass)
634 RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(RCLASS_EXT_PRIME(iclass)) =
true;
638RICLASS_WRITE_ORIGIN_SHARED_MTBL(
VALUE iclass)
640 RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(RCLASS_EXT_WRITABLE(iclass)) =
true;
644RICLASS_OWNS_M_TBL_P(
VALUE iclass)
647 return RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext);
651RICLASS_FOR_REFINEMENT_P(
VALUE iclass)
666RCLASS_WRITE_SUPERCLASSES(
VALUE klass,
size_t depth,
VALUE *superclasses,
bool with_self)
671 RCLASSEXT_SUPERCLASS_DEPTH(ext) = depth;
672 RCLASSEXT_SUPERCLASSES(ext) = superclasses;
673 RCLASSEXT_SUPERCLASSES_WITH_SELF(ext) = with_self;
677RCLASS_SET_SUBCLASSES(
VALUE klass,
VALUE subclasses)
680 RB_OBJ_WRITE(klass, &RCLASSEXT_SUBCLASSES(ext), subclasses);
684RCLASS_SET_CLASSPATH(
VALUE klass,
VALUE classpath,
bool permanent)
691 RB_OBJ_WRITE(klass, &(RCLASSEXT_CLASSPATH(ext)), classpath);
692 RCLASSEXT_PERMANENT_CLASSPATH(ext) = permanent;
696RCLASS_WRITE_CLASSPATH(
VALUE klass,
VALUE classpath,
bool permanent)
703 RB_OBJ_WRITE(klass, &(RCLASSEXT_CLASSPATH(ext)), classpath);
704 RCLASSEXT_PERMANENT_CLASSPATH(ext) = permanent;
708RCLASS_SET_ATTACHED_OBJECT(
VALUE klass,
VALUE attached_object)
710 assert(RCLASS_SINGLETON_P(klass));
712 RB_OBJ_WRITE(klass, &RCLASS_EXT_PRIME(klass)->as.singleton_class.attached_object, attached_object);
713 return attached_object;
717RCLASS_SET_MAX_IV_COUNT(
VALUE klass, attr_index_t count)
722 RCLASS_MAX_IV_COUNT(klass) = count;
726RCLASS_SET_EXPECT_NO_IVAR(
VALUE klass)
728 RCLASS_EXT_PRIME(klass)->expect_no_ivar =
true;
732RCLASS_EXPECT_NO_IVAR(
VALUE klass)
734 return RCLASS_EXT_PRIME(klass)->expect_no_ivar;
738RCLASS_INITIALIZED_P(
VALUE klass)
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
static bool RB_FL_ABLE(VALUE obj)
Checks if the object is flaggable.
@ RUBY_FL_SHAREABLE
This flag has something to do with Ractor.
VALUE rb_class_boot(VALUE)
A utility function that wraps class_alloc.
VALUE rb_class_inherited(VALUE, VALUE)
Calls Class::inherited.
VALUE rb_singleton_class_get(VALUE obj)
Returns the singleton class of obj, or nil if obj is not a singleton object.
#define FL_SINGLETON
Old name of RUBY_FL_SINGLETON.
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
#define T_STRING
Old name of RUBY_T_STRING.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
VALUE rb_cObject
Object class.
VALUE rb_cBasicObject
BasicObject class.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
VALUE(* rb_alloc_func_t)(VALUE klass)
This is the type of functions that ruby calls when trying to allocate an object.
#define RBIMPL_ASSUME(_)
Wraps (or simulates) __builtin_unreachable.
#define RBASIC(obj)
Convenient casting macro.
Ruby object's base components.
Internal header for Ruby Box.
VALUE subclasses
imemo_subclasses VALUE tracking this class's subclasses.
Internal header for Class.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.