From c8c58aabdf185cbab446a077299f6d11716541aa Mon Sep 17 00:00:00 2001
From: Ryan Macnak <rmacnak@google.com>
Date: Tue, 8 Jul 2025 15:44:50 -0700
Subject: [PATCH] [vm] Label object store fields in heap snapshots.

TEST=examine snapshot
Change-Id: Ief0b059ef4dae05420452069bbdbb2febcf90d95
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/439382
Reviewed-by: Alexander Aprelev <aam@google.com>
Commit-Queue: Ryan Macnak <rmacnak@google.com>
---
 runtime/vm/object_graph.cc | 45 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/runtime/vm/object_graph.cc b/runtime/vm/object_graph.cc
index 2175579b7cd..bf8142df4ba 100644
--- a/runtime/vm/object_graph.cc
+++ b/runtime/vm/object_graph.cc
@@ -1110,8 +1110,9 @@ enum ExtraCids {
   kImagePageExtraCid = 2,
   kRootSliceExtraCid = 3,
   kIsolateExtraCid = 4,
+  kObjectStoreExtraCid = 5,
 
-  kNumExtraCids = 4,
+  kNumExtraCids = 5,
 };
 
 class Pass2Visitor : public ObjectVisitor,
@@ -1581,6 +1582,42 @@ void HeapSnapshotWriter::Write() {
         WriteUtf8("");  // Reserved
       }
     }
+    {
+      ASSERT(kObjectStoreExtraCid == 5);
+      WriteUnsigned(0);          // Flags
+      WriteUtf8("ObjectStore");  // Name
+      WriteUtf8("");             // Library name
+      WriteUtf8("");             // Library uri
+      WriteUtf8("");             // Reserved
+
+      enum {
+#define V(type, name) kObjectStore_##name,
+        OBJECT_STORE_FIELD_LIST(V, V, V, V, V, V, V, V, V)
+#undef EMIT_FIELD_NAME
+            kNumObjectStoreFields
+      };
+      WriteUnsigned(kNumObjectStoreFields);
+
+      // A strtab is smaller than an array of strings.
+      static const char* const names = ""
+#define EMIT_FIELD_NAME(type, name) #name "_\0"
+          OBJECT_STORE_FIELD_LIST(EMIT_FIELD_NAME, EMIT_FIELD_NAME,
+                                  EMIT_FIELD_NAME, EMIT_FIELD_NAME,
+                                  EMIT_FIELD_NAME, EMIT_FIELD_NAME,
+                                  EMIT_FIELD_NAME, EMIT_FIELD_NAME,
+                                  EMIT_FIELD_NAME)
+#undef EMIT_FIELD_NAME
+          ;  // NOLINT
+      const char* name = names;
+      for (intptr_t i = 0; i < kNumObjectStoreFields; i++) {
+        intptr_t flags = 1;  // Strong.
+        WriteUnsigned(flags);
+        WriteUnsigned(i);  // Index.
+        WriteUtf8(name);
+        WriteUtf8("");  // Reserved
+        name += strlen(name) + 1;
+      }
+    }
 
     for (intptr_t cid = 1; cid <= class_count_; cid++) {
       if (!class_table->HasValidClassAt(cid)) {
@@ -1708,7 +1745,11 @@ void HeapSnapshotWriter::Write() {
       DEBUG_ASSERT(visitor.count() == num_image_objects);
     }
     for (intptr_t i = 0; i < kNumRootSlices; i++) {
-      WriteUnsigned(kRootSliceExtraCid);
+      if (i == kObjectStore) {
+        WriteUnsigned(kObjectStoreExtraCid);
+      } else {
+        WriteUnsigned(kRootSliceExtraCid);
+      }
       WriteUnsigned(0);  // shallowSize
       WriteUnsigned(kNameData);
       WriteUtf8(RootSliceToCString(i));