Fix "dump" of ManagedReferenceRegistry

Fix bug when doing a UnityDataTool analysis on Megacity project.

Two sharedAsset files had this error.
"System.Exception: Unsupported ManagedReferenceRegistry version 1001"

This is because of complexities in the TypeTress for ManagedReferenceRegistry,
The registry always exists at the top level.  So we have to ignore any that we find when
traversing the contents of the ManagedReferenceRegistry.

The fix matches the binary2text implementation, and i did side by side comparison of the previously problematic object data to confirm.

Binary2Text output:

 references  (ManagedReferencesRegistry)
  version 2 (int)
  rid -2 (class: , ns: , asm: )
  rid 1000 (class: VisualElement/UxmlSerializedData, ns: UnityEngine.UIElements, asm: UnityEngine.UIElementsModule)
   UxmlSerializedData
    uxmlAssetId -993838062 (int)
    name "main-menu-container" (string)
    name_UxmlAttributeFlags 1 (UInt8)

...

    dataSourceTypeString_UxmlAttributeFlags 0 (UInt8)
    bindings  (UxmlSerializedData)
     size 0 (int)

    bindings_UxmlAttributeFlags 0 (UInt8)
  rid 1001 (class: VisualElement/UxmlSerializedData, ns: UnityEngine.UIElements, asm: UnityEngine.UIElementsModule)
   UxmlSerializedData
    uxmlAssetId 76538276 (int)
    name "menu-panel" (string)
    name_UxmlAttributeFlags 1 (UInt8)
    enabledSelf 0 (UInt8)

UnityDataTool output after fix:

 references (ManagedReferencesRegistry)
    version (int) 2
    rid(-2) ReferencedObject
      type (ReferencedManagedType)
        class (string)
        ns (string)
        asm (string)
      data ReferencedObjectData
        null
    rid(1000) ReferencedObject
      type (ReferencedManagedType)
        class (string) VisualElement/UxmlSerializedData
        ns (string) UnityEngine.UIElements
        asm (string) UnityEngine.UIElementsModule
      data ReferencedObjectData
        uxmlAssetId (int) -993838062
        name (string) main-menu-container
        name_UxmlAttributeFlags (UInt8) 1

...

       dataSourceTypeString_UxmlAttributeFlags (UInt8) 0
        bindings (UxmlSerializedData)
          Array<managedRefArrayItem>[0]
        bindings_UxmlAttributeFlags (UInt8) 0
    rid(1001) ReferencedObject
      type (ReferencedManagedType)
        class (string) VisualElement/UxmlSerializedData
        ns (string) UnityEngine.UIElements
        asm (string) UnityEngine.UIElementsModule
      data ReferencedObjectData
        uxmlAssetId (int) 76538276
        name (string) menu-panel
        name_UxmlAttributeFlags (UInt8) 1
        enabledSelf (UInt8) 0

Author: SkowronskiAndrew

Analyzer/PPtrAndCrcProcessor.cs

@@ -12,7 +12,7 @@ namespace UnityDataTools.Analyzer;
 public class PPtrAndCrcProcessor : IDisposable
 {
     public delegate int CallbackDelegate(long objectId, int fileId, long pathId, string propertyPath, string propertyType);
-    
+
     private SerializedFile m_SerializedFile;
     private UnityFileReader m_Reader;
     private long m_Offset;
@@ -21,7 +21,7 @@ public class PPtrAndCrcProcessor : IDisposable
     private string m_Folder;
     private StringBuilder m_StringBuilder = new();
     private byte[] m_pptrBytes = new byte[4];
-    
+
     private CallbackDelegate m_Callback;
 
     private Dictionary<string, UnityFileReader> m_resourceReaders = new();
@@ -34,14 +34,14 @@ public PPtrAndCrcProcessor(SerializedFile serializedFile, UnityFileReader reader
         m_Folder = folder;
         m_Callback = callback;
     }
-    
+
     public void Dispose()
     {
         foreach (var r in m_resourceReaders.Values)
         {
             r?.Dispose();
         }
-        
+
         m_resourceReaders.Clear();
     }
 
@@ -52,7 +52,7 @@ private UnityFileReader GetResourceReader(string filename)
         {
             filename = filename.Remove(0, slashPos + 1);
         }
-        
+
         if (!m_resourceReaders.TryGetValue(filename, out var reader))
         {
             try
@@ -89,13 +89,13 @@ public uint Process(long objectId, long offset, TypeTreeNode node)
         {
             m_StringBuilder.Clear();
             m_StringBuilder.Append(child.Name);
-            ProcessNode(child);
+            ProcessNode(child, false);
         }
 
         return m_Crc32;
     }
 
-    private void ProcessNode(TypeTreeNode node)
+    private void ProcessNode(TypeTreeNode node, bool isInManagedReferenceRegistry)
     {
         if (node.IsBasicType)
         {
@@ -104,18 +104,18 @@ private void ProcessNode(TypeTreeNode node)
         }
         else if (node.IsArray)
         {
-            ProcessArray(node);
+            ProcessArray(node, false, isInManagedReferenceRegistry);
         }
         else if (node.Type == "vector" || node.Type == "map" || node.Type == "staticvector")
         {
-            ProcessArray(node.Children[0]);
+            ProcessArray(node.Children[0], false, isInManagedReferenceRegistry);
         }
         else if (node.Type.StartsWith("PPtr<"))
         {
             var startIndex = node.Type.IndexOf('<') + 1;
             var endIndex = node.Type.Length - 1;
             var referencedType = node.Type.Substring(startIndex, endIndex - startIndex);
-            
+
             ExtractPPtr(referencedType);
         }
         else if (node.Type == "StreamingInfo")
@@ -125,10 +125,10 @@ private void ProcessNode(TypeTreeNode node)
 
             var offset = node.Children[0].Size == 4 ? m_Reader.ReadInt32(m_Offset) : m_Reader.ReadInt64(m_Offset);
             m_Offset += node.Children[0].Size;
-            
+
             var size = m_Reader.ReadInt32(m_Offset);
             m_Offset += 4;
-            
+
             var stringSize = m_Reader.ReadInt32(m_Offset);
             var filename = m_Reader.ReadString(m_Offset + 4, stringSize);
             m_Offset += stringSize + 4;
@@ -148,15 +148,15 @@ private void ProcessNode(TypeTreeNode node)
         {
             if (node.Children.Count != 3)
                 throw new Exception("Invalid StreamedResource");
-            
+
             var stringSize = m_Reader.ReadInt32(m_Offset);
             var filename = m_Reader.ReadString(m_Offset + 4, stringSize);
             m_Offset += stringSize + 4;
             m_Offset = (m_Offset + 3) & ~(3);
 
             var offset = m_Reader.ReadInt64(m_Offset);
             m_Offset += 8;
-            
+
             var size = (int)m_Reader.ReadInt64(m_Offset);
             m_Offset += 8;
 
@@ -178,7 +178,9 @@ private void ProcessNode(TypeTreeNode node)
         }
         else if (node.IsManagedReferenceRegistry)
         {
-            ProcessManagedReferenceRegistry(node);
+            // ManagedReferenceRegistry are never nested
+            if (!isInManagedReferenceRegistry)
+                ProcessManagedReferenceRegistry(node);
         }
         else
         {
@@ -187,11 +189,11 @@ private void ProcessNode(TypeTreeNode node)
                 var size = m_StringBuilder.Length;
                 m_StringBuilder.Append('.');
                 m_StringBuilder.Append(child.Name);
-                ProcessNode(child);
+                ProcessNode(child, isInManagedReferenceRegistry);
                 m_StringBuilder.Remove(size, m_StringBuilder.Length - size);
             }
         }
-        
+
         if (
                 ((int)node.MetaFlags & (int)TypeTreeMetaFlags.AlignBytes) != 0 ||
                 ((int)node.MetaFlags & (int)TypeTreeMetaFlags.AnyChildUsesAlignBytes) != 0
@@ -201,7 +203,7 @@ private void ProcessNode(TypeTreeNode node)
         }
     }
 
-    private void ProcessArray(TypeTreeNode node, bool isManagedReferenceRegistry = false)
+    private void ProcessArray(TypeTreeNode node, bool isManagedReferenceRegistry, bool isInManagedReferenceRegistry)
     {
         var dataNode = node.Children[1];
 
@@ -221,14 +223,13 @@ private void ProcessArray(TypeTreeNode node, bool isManagedReferenceRegistry = f
             {
                 if (!isManagedReferenceRegistry)
                 {
-                    
                     var size = m_StringBuilder.Length;
                     m_StringBuilder.Append('[');
                     m_StringBuilder.Append(i);
                     m_StringBuilder.Append(']');
-                    
-                    ProcessNode(dataNode);
-                    
+
+                    ProcessNode(dataNode, isInManagedReferenceRegistry);
+
                     m_StringBuilder.Remove(size, m_StringBuilder.Length - size);
                 }
                 else
@@ -285,7 +286,7 @@ private void ProcessManagedReferenceRegistry(TypeTreeNode node)
             var size = m_StringBuilder.Length;
             m_StringBuilder.Append('.');
             m_StringBuilder.Append("RefIds");
-            ProcessArray(refIdsArrayNode, true);
+            ProcessArray(refIdsArrayNode, true, true);
             m_StringBuilder.Remove(size, m_StringBuilder.Length - size);
         }
         else
@@ -330,9 +331,9 @@ bool ProcessManagedReferenceData(TypeTreeNode refTypeNode, TypeTreeNode referenc
         m_StringBuilder.Append("rid(");
         m_StringBuilder.Append(rid);
         m_StringBuilder.Append(").data");
-        ProcessNode(refTypeTypeTree);
+        ProcessNode(refTypeTypeTree, true);
         m_StringBuilder.Remove(size, m_StringBuilder.Length - size);
-        
+
         return true;
     }
 

TextDumper/TextDumperTool.cs

@@ -60,7 +60,20 @@ void RecursiveDump(TypeTreeNode node, ref long offset, int level, int arrayIndex
     {
         bool skipChildren = false;
 
-        if (!node.IsArray)
+        if (level > 1 && node.IsManagedReferenceRegistry)
+        {
+            // If we are already inside a ManagedReferenceRegistry, then we ignore the ManagedReferenceRegistry node
+            // they can appear in the TypeTrees of Managed objects, but only the root object actually has a registry
+            skipChildren = true;
+        }
+        else if (node.IsArray)
+        {
+            DumpArray(node, ref offset, level);
+
+            // Skip child nodes as they were already processed here.
+            skipChildren = true;
+        }
+        else
         {
             m_StringBuilder.Append(' ', level * 2);
 
@@ -106,7 +119,7 @@ void RecursiveDump(TypeTreeNode node, ref long offset, int level, int arrayIndex
 
             m_Writer.WriteLine(m_StringBuilder);
             m_StringBuilder.Clear();
-            
+
             if (node.IsManagedReferenceRegistry)
             {
                 DumpManagedReferenceRegistry(node, ref offset, level + 1);
@@ -115,13 +128,6 @@ void RecursiveDump(TypeTreeNode node, ref long offset, int level, int arrayIndex
                 skipChildren = true;
             }
         }
-        else
-        {
-            DumpArray(node, ref offset, level);
-
-            // Skip child nodes as they were already processed here.
-            skipChildren = true;
-        }
 
         if (!skipChildren)
         {
@@ -194,7 +200,7 @@ void DumpArray(TypeTreeNode node, ref long offset, int level)
             else
             {
                 ++level;
-                    
+
                 for (int i = 0; i < arraySize; ++i)
                 {
                     RecursiveDump(dataNode, ref offset, level, i);
@@ -207,22 +213,22 @@ void DumpManagedReferenceRegistry(TypeTreeNode node, ref long offset, int level)
     {
         if (node.Children.Count < 2)
             throw new Exception("Invalid ManagedReferenceRegistry");
-                
+
         // First child is version number.
         var version = m_Reader.ReadInt32(offset);
         RecursiveDump(node.Children[0], ref offset, level);
 
         TypeTreeNode refTypeNode;
         TypeTreeNode refObjData;
-                
+
         if (version == 1)
         {
             // Second child is the ReferencedObject.
             var refObjNode = node.Children[1];
             // And its children are the referenced type and data nodes.
             refTypeNode = refObjNode.Children[0];
             refObjData = refObjNode.Children[1];
-                
+
             int i = 0;
 
             while (DumpManagedReferenceData(refTypeNode, refObjData, ref offset, level, i++))
@@ -244,7 +250,7 @@ void DumpManagedReferenceRegistry(TypeTreeNode node, ref long offset, int level)
             // First child is the array size.
             int arraySize = m_Reader.ReadInt32(offset);
             offset += 4;
-                
+
             // Second child is the ReferencedObject.
             var refObjNode = refIdsArrayNode.Children[1];
 
@@ -253,7 +259,7 @@ void DumpManagedReferenceRegistry(TypeTreeNode node, ref long offset, int level)
                 // First child is the rid.
                 long rid = m_Reader.ReadInt64(offset);
                 offset += 8;
-                
+
                 // And the next children are the referenced type and data nodes.
                 refTypeNode = refObjNode.Children[1];
                 refObjData = refObjNode.Children[2];
@@ -270,28 +276,28 @@ bool DumpManagedReferenceData(TypeTreeNode refTypeNode, TypeTreeNode referencedT
     {
         if (refTypeNode.Children.Count < 3)
             throw new Exception("Invalid ReferencedManagedType");
-            
+
         m_StringBuilder.Append(' ', level * 2);
         m_StringBuilder.Append($"rid(");
         m_StringBuilder.Append(id);
         m_StringBuilder.Append(") ReferencedObject");
-        
+
         m_Writer.WriteLine(m_StringBuilder);
         m_StringBuilder.Clear();
-        
+
         ++level;
 
         var refTypeOffset = offset;
         var stringSize = m_Reader.ReadInt32(offset);
         var className = m_Reader.ReadString(offset + 4, stringSize);
         offset += stringSize + 4;
         offset = (offset + 3) & ~(3);
-            
+
         stringSize = m_Reader.ReadInt32(offset);
         var namespaceName = m_Reader.ReadString(offset + 4, stringSize);
         offset += stringSize + 4;
         offset = (offset + 3) & ~(3);
-            
+
         stringSize = m_Reader.ReadInt32(offset);
         var assemblyName = m_Reader.ReadString(offset + 4, stringSize);
         offset += stringSize + 4;
@@ -308,23 +314,23 @@ bool DumpManagedReferenceData(TypeTreeNode refTypeNode, TypeTreeNode referencedT
         m_StringBuilder.Append(' ');
         m_StringBuilder.Append(referencedTypeDataNode.Type);
         m_StringBuilder.Append(' ');
-        
+
         m_Writer.WriteLine(m_StringBuilder);
         m_StringBuilder.Clear();
 
         if (id == -1 || id == -2)
         {
             m_StringBuilder.Append(' ', level * 2);
             m_StringBuilder.Append(id == -1 ? "  unknown" : "  null");
-        
+
             m_Writer.WriteLine(m_StringBuilder);
             m_StringBuilder.Clear();
 
             return true;
         }
 
         var refTypeRoot = m_SerializedFile.GetRefTypeTypeTreeRoot(className, namespaceName, assemblyName);
-        
+
         // Dump the ReferencedObject using its own TypeTree, but skip the root.
         foreach (var child in refTypeRoot.Children)
         {