vm_getivar: normalize shape_id to ignore frozen state

byroot · byroot · commit fa04a3e370bb · 2025-05-28T15:17:35.000+02:00
Freezing an object changes its `shape_id` This is necessary
so that `setivar` routines can use the `shape_id` as a cache key
and save on checking the frozen status every time.

However for `getivar` routines, this causes needless cache misses.
By clearing that bit we increase hit rate in codepaths that see
both frozen and mutable objects.
diff --git a/shape.h b/shape.h
@@ -27,6 +27,7 @@ STATIC_ASSERT(shape_id_num_bits, SHAPE_ID_NUM_BITS == sizeof(shape_id_t) * CHAR_
 #define SHAPE_ID_OFFSET_MASK (SHAPE_BUFFER_SIZE - 1)
 #define SHAPE_ID_FLAGS_MASK (shape_id_t)(((1 << (SHAPE_ID_NUM_BITS - SHAPE_ID_OFFSET_NUM_BITS)) - 1) << SHAPE_ID_OFFSET_NUM_BITS)
 #define SHAPE_ID_FL_FROZEN (SHAPE_FL_FROZEN << SHAPE_ID_OFFSET_NUM_BITS)
+#define SHAPE_ID_READ_ONLY_MASK (~SHAPE_ID_FL_FROZEN)
 
 typedef uint32_t redblack_id_t;
 
@@ -115,6 +116,14 @@ RBASIC_SHAPE_ID(VALUE obj)
 #endif
 }
 
+// Same as RBASIC_SHAPE_ID but with flags that have no impact
+// on reads removed. e.g. Remove FL_FROZEN.
+static inline shape_id_t
+RBASIC_SHAPE_ID_FOR_READ(VALUE obj)
+{
+    return RBASIC_SHAPE_ID(obj) & SHAPE_ID_READ_ONLY_MASK;
+}
+
 static inline void
 RBASIC_SET_SHAPE_ID(VALUE obj, shape_id_t shape_id)
 {
diff --git a/vm_insnhelper.c b/vm_insnhelper.c
@@ -1215,14 +1215,13 @@ vm_getivar(VALUE obj, ID id, const rb_iseq_t *iseq, IVC ic, const struct rb_call
 {
 #if OPT_IC_FOR_IVAR
     VALUE val = Qundef;
-    shape_id_t shape_id;
     VALUE * ivar_list;
 
     if (SPECIAL_CONST_P(obj)) {
         return default_value;
     }
 
-    shape_id = RBASIC_SHAPE_ID(obj);
+    shape_id_t shape_id = RBASIC_SHAPE_ID_FOR_READ(obj);
 
     switch (BUILTIN_TYPE(obj)) {
       case T_OBJECT:

Original file line number	Diff line number	Diff line change
`@@ -1215,14 +1215,13 @@ vm_getivar(VALUE obj, ID id, const rb_iseq_t *iseq, IVC ic, const struct rb_call`
`1215`	`1215`	`{`
`1216`	`1216`	`#if OPT_IC_FOR_IVAR`
`1217`	`1217`	`VALUE val = Qundef;`
`1218`		`- shape_id_t shape_id;`
`1219`	`1218`	`VALUE * ivar_list;`
`1220`	`1219`
`1221`	`1220`	`if (SPECIAL_CONST_P(obj)) {`
`1222`	`1221`	`return default_value;`
`1223`	`1222`	`}`
`1224`	`1223`
`1225`		`- shape_id = RBASIC_SHAPE_ID(obj);`
	`1224`	`+ shape_id_t shape_id = RBASIC_SHAPE_ID_FOR_READ(obj);`
`1226`	`1225`
`1227`	`1226`	`switch (BUILTIN_TYPE(obj)) {`
`1228`	`1227`	`case T_OBJECT:`