Add support for debugging generics <T> (#387)

josesimoes · web-flow · commit 8480e6dcacd0 · 2025-04-09T18:12:31.000+01:00
diff --git a/nanoFramework.Tools.DebugLibrary.Net/nanoFramework.Tools.DebugLibrary.Net.csproj b/nanoFramework.Tools.DebugLibrary.Net/nanoFramework.Tools.DebugLibrary.Net.csproj
@@ -15,7 +15,6 @@
     <!-- need this here to rebuild the packages.lock.json file in case the hashes fail to validate -->
     <!-- <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder> -->
   </PropertyGroup>
-
   <PropertyGroup>
     <PackageId>nanoFramework.Tools.Debugger.Net</PackageId>
     <Authors>nanoframework</Authors>
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RunTimeValue.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RunTimeValue.cs
@@ -219,6 +219,7 @@ public virtual bool IsBoxed
         public abstract bool IsArray { get; }
         public virtual bool IsArrayReference { get { return m_handle.m_arrayref_referenceID != 0; } }
         public abstract bool IsReflection { get; }
+        public abstract bool IsGenericInst { get; }
 
         public virtual nanoClrDataType DataType
         {
@@ -337,9 +338,9 @@ static protected RuntimeValue Convert(Engine eng, WireProtocol.Commands.Debuggin
                 case nanoClrDataType.DATATYPE_CLASS: return new RuntimeValue_Class(eng, src);
                 case nanoClrDataType.DATATYPE_VALUETYPE: return new RuntimeValue_ValueType(eng, src);
 
-                case nanoClrDataType.DATATYPE_VAR: return new RuntimeValue_Class(eng, src);
-                case nanoClrDataType.DATATYPE_GENERICINST: return new RuntimeValue_Class(eng, src);
-                case nanoClrDataType.DATATYPE_MVAR: return new RuntimeValue_Class(eng, src);
+                case nanoClrDataType.DATATYPE_VAR: return new RuntimeValue_Var(eng, src);
+                case nanoClrDataType.DATATYPE_GENERICINST: return new RuntimeValue_Generic(eng, src);
+                case nanoClrDataType.DATATYPE_MVAR: return new RuntimeValue_MVar(eng, src);
 
                 case nanoClrDataType.DATATYPE_SZARRAY: return new RuntimeValue_Array(eng, src);
 
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Array.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Array.cs
@@ -18,6 +18,7 @@ protected internal RuntimeValue_Array(Engine eng, WireProtocol.Commands.Debuggin
         public override bool IsValueType { get { return false; } }
         public override bool IsArray { get { return true; } }
         public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
 
         public override RuntimeValue GetElement(uint index)
         {
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Class.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Class.cs
@@ -18,6 +18,7 @@ protected internal RuntimeValue_Class(Engine eng, WireProtocol.Commands.Debuggin
         public override bool IsValueType { get { return false; } }
         public override bool IsArray { get { return false; } }
         public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
 
         public override uint NumOfFields
         {
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Generic.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Generic.cs
@@ -0,0 +1,38 @@
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// Portions Copyright (c) Microsoft Corporation.  All rights reserved.
+// See LICENSE file in the project root for full license information.
+//
+
+namespace nanoFramework.Tools.Debugger
+{
+    public class RuntimeValue_Generic : RuntimeValue
+    {
+        protected internal RuntimeValue_Generic(Engine eng, WireProtocol.Commands.Debugging_Value handle) : base(eng, handle)
+        {
+        }
+
+        public override bool IsReference { get { return false; } }
+        public override bool IsNull { get { return false; } }
+        public override bool IsPrimitive { get { return false; } }
+        public override bool IsValueType { get { return false; } }
+        public override bool IsArray { get { return false; } }
+        public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return true; } }
+
+        public override uint Type => m_handle.m_ts;
+
+        public override uint NumOfFields
+        {
+            get
+            {
+                return m_handle.m_size - 1;
+            }
+        }
+
+        public override RuntimeValue GetField(uint offset, uint fd)
+        {
+            return m_eng.GetFieldValue(this, offset, fd);
+        }
+    }
+}
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Indirect.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Indirect.cs
@@ -52,6 +52,7 @@ public override bool IsBoxed
         public override bool IsValueType { get { return (m_value != null && m_value.IsValueType); } }
         public override bool IsArray { get { return (m_value != null && m_value.IsArray); } }
         public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
 
         public override object Value
         {
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Internal.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Internal.cs
@@ -18,5 +18,6 @@ protected internal RuntimeValue_Internal(Engine eng, WireProtocol.Commands.Debug
         public override bool IsValueType { get { return false; } }
         public override bool IsArray { get { return false; } }
         public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
     }
 }
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_MVar.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_MVar.cs
@@ -0,0 +1,24 @@
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// Portions Copyright (c) Microsoft Corporation.  All rights reserved.
+// See LICENSE file in the project root for full license information.
+//
+
+namespace nanoFramework.Tools.Debugger
+{
+    public class RuntimeValue_MVar : RuntimeValue
+    {
+        protected internal RuntimeValue_MVar(Engine eng, WireProtocol.Commands.Debugging_Value handle) : base(eng, handle)
+        {
+        }
+
+        public override bool IsReference { get { return false; } }
+        public override bool IsNull { get { return false; } }
+        public override bool IsPrimitive { get { return false; } }
+        public override bool IsValueType { get { return false; } }
+        public override bool IsArray { get { return false; } }
+        public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
+
+    }
+}
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Primitive.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Primitive.cs
@@ -49,6 +49,7 @@ protected internal RuntimeValue_Primitive(Engine eng, WireProtocol.Commands.Debu
         public override bool IsValueType { get { return false; } }
         public override bool IsArray { get { return false; } }
         public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
 
         public override object Value
         {
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Reflection.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Reflection.cs
@@ -25,6 +25,7 @@ protected internal RuntimeValue_Reflection(Engine eng, WireProtocol.Commands.Deb
         public override bool IsValueType { get { return false; } }
         public override bool IsArray { get { return false; } }
         public override bool IsReflection { get { return true; } }
+        public override bool IsGenericInst { get { return false; } }
 
         public ReflectionDefinition.Kind ReflectionType
         {
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_String.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_String.cs
@@ -42,6 +42,7 @@ protected internal RuntimeValue_String(Engine eng, WireProtocol.Commands.Debuggi
         public override bool IsValueType { get { return false; } }
         public override bool IsArray { get { return false; } }
         public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
 
         public override object Value
         {
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_ValueType.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_ValueType.cs
@@ -18,5 +18,6 @@ protected internal RuntimeValue_ValueType(Engine eng, WireProtocol.Commands.Debu
         public override bool IsValueType { get { return true; } }
         public override bool IsArray { get { return false; } }
         public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
     }
 }
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Var.cs b/nanoFramework.Tools.DebugLibrary.Shared/Runtime/RuntimeValue_Var.cs
@@ -0,0 +1,24 @@
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// Portions Copyright (c) Microsoft Corporation.  All rights reserved.
+// See LICENSE file in the project root for full license information.
+//
+
+namespace nanoFramework.Tools.Debugger
+{
+    public class RuntimeValue_Var : RuntimeValue
+    {
+        protected internal RuntimeValue_Var(Engine eng, WireProtocol.Commands.Debugging_Value handle) : base(eng, handle)
+        {
+        }
+
+        public override bool IsReference { get { return false; } }
+        public override bool IsNull { get { return false; } }
+        public override bool IsPrimitive { get { return false; } }
+        public override bool IsValueType { get { return false; } }
+        public override bool IsArray { get { return false; } }
+        public override bool IsReflection { get { return false; } }
+        public override bool IsGenericInst { get { return false; } }
+
+    }
+}
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/WireProtocol/Commands.cs b/nanoFramework.Tools.DebugLibrary.Shared/WireProtocol/Commands.cs
@@ -1506,6 +1506,10 @@ public void PrepareForDeserialize(int size, byte[] data, Converter converter)
             }
         }
 
+        /////////////////////////////////////////////////////////////
+        // Keep in sync with Debugging_Value struct in native code //
+        /////////////////////////////////////////////////////////////
+
         public class Debugging_Value
         {
             public const uint HB_Alive = 0x01;
@@ -1534,6 +1538,9 @@ public class Debugging_Value
 
             public uint m_td;
 
+            // For DATATYPE_GENERICINST
+            public uint m_ts;
+
             // For DATATYPE_SZARRAY
 
             public uint m_array_numOfElements;
@@ -1548,7 +1555,10 @@ public class Debugging_Value
 
             static internal Debugging_Value[] Allocate(int size, byte[] data)
             {
-                int num = size / (12 * 4 + 128);
+                // size of the Debugging_Value struct comming from Wire Protocol is:
+                // 13 uint fields (size 4 bytes)
+                // 128 bytes in the m_builtinValue field
+                int num = size / (13 * 4 + 128);
 
                 Debugging_Value[] res = new Debugging_Value[num];
 
diff --git a/nanoFramework.Tools.DebugLibrary.Shared/nanoFramework.Tools.DebugLibrary.Net.projitems b/nanoFramework.Tools.DebugLibrary.Shared/nanoFramework.Tools.DebugLibrary.Net.projitems
@@ -100,6 +100,9 @@
     <Compile Include="$(MSBuildThisFileDirectory)Runtime\RunTimeValue.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Runtime\RuntimeValue_Array.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Runtime\RuntimeValue_ByRef.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)Runtime\RuntimeValue_MVar.cs" />
+    <Compile Include="..\nanoFramework.Tools.DebugLibrary.Shared\Runtime\RuntimeValue_Var.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)Runtime\RuntimeValue_Generic.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Runtime\RuntimeValue_Class.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Runtime\RuntimeValue_Indirect.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Runtime\RuntimeValue_Internal.cs" />
diff --git a/version.json b/version.json
@@ -1,6 +1,6 @@
 ﻿{
   "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "2.5",
+  "version": "3.0-preview.{height}",
   "assemblyVersion": {
     "precision": "minor"
   },

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ protected internal RuntimeValue_Array(Engine eng, WireProtocol.Commands.Debuggin`
`18`	`18`	`public override bool IsValueType { get { return false; } }`
`19`	`19`	`public override bool IsArray { get { return true; } }`
`20`	`20`	`public override bool IsReflection { get { return false; } }`
	`21`	`+ public override bool IsGenericInst { get { return false; } }`
`21`	`22`
`22`	`23`	`public override RuntimeValue GetElement(uint index)`
`23`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@ public override bool IsBoxed`
`52`	`52`	`public override bool IsValueType { get { return (m_value != null && m_value.IsValueType); } }`
`53`	`53`	`public override bool IsArray { get { return (m_value != null && m_value.IsArray); } }`
`54`	`54`	`public override bool IsReflection { get { return false; } }`
	`55`	`+ public override bool IsGenericInst { get { return false; } }`
`55`	`56`
`56`	`57`	`public override object Value`
`57`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,6 @@ protected internal RuntimeValue_Internal(Engine eng, WireProtocol.Commands.Debug`
`18`	`18`	`public override bool IsValueType { get { return false; } }`
`19`	`19`	`public override bool IsArray { get { return false; } }`
`20`	`20`	`public override bool IsReflection { get { return false; } }`
	`21`	`+ public override bool IsGenericInst { get { return false; } }`
`21`	`22`	`}`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ protected internal RuntimeValue_Primitive(Engine eng, WireProtocol.Commands.Debu`
`49`	`49`	`public override bool IsValueType { get { return false; } }`
`50`	`50`	`public override bool IsArray { get { return false; } }`
`51`	`51`	`public override bool IsReflection { get { return false; } }`
	`52`	`+ public override bool IsGenericInst { get { return false; } }`
`52`	`53`
`53`	`54`	`public override object Value`
`54`	`55`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ protected internal RuntimeValue_Reflection(Engine eng, WireProtocol.Commands.Deb`
`25`	`25`	`public override bool IsValueType { get { return false; } }`
`26`	`26`	`public override bool IsArray { get { return false; } }`
`27`	`27`	`public override bool IsReflection { get { return true; } }`
	`28`	`+ public override bool IsGenericInst { get { return false; } }`
`28`	`29`
`29`	`30`	`public ReflectionDefinition.Kind ReflectionType`
`30`	`31`	`{`