From ec1b135dc1feda605e85e7d671300ebc599b23fb Mon Sep 17 00:00:00 2001
From: ElektroKill <elektrokilldev@protonmail.com>
Date: Tue, 28 Nov 2023 20:48:53 +0100
Subject: [PATCH] Add option to override the runtime version used for .NET FW
 debugging

---
 ...otNetFrameworkStartDebuggingOptionsPage.cs | 25 +++++++++++++--
 .../Impl/DotNetFrameworkDbgEngineImpl.cs      |  2 +-
 ...gger.DotNet.CorDebug.Resources.Designer.cs | 18 +++++++++++
 ...py.Debugger.DotNet.CorDebug.Resources.resx |  6 ++++
 .../Themes/wpf.styles.templates.xaml          |  8 +++--
 .../Utilities/DotNetHelpers.cs                | 31 +++++++++++++++++++
 .../dndbg/COM/MetaHost.cs                     |  4 +--
 .../dndbg/Engine/DebuggeeVersionDetector.cs   |  9 +++++-
 .../DotNetFrameworkStartDebuggingOptions.cs   |  6 ++++
 9 files changed, 101 insertions(+), 8 deletions(-)

diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Dialogs/DebugProgram/DotNetFrameworkStartDebuggingOptionsPage.cs b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Dialogs/DebugProgram/DotNetFrameworkStartDebuggingOptionsPage.cs
index 16092228d4..e1e677b633 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Dialogs/DebugProgram/DotNetFrameworkStartDebuggingOptionsPage.cs
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Dialogs/DebugProgram/DotNetFrameworkStartDebuggingOptionsPage.cs
@@ -18,12 +18,15 @@ You should have received a copy of the GNU General Public License
 */
 
 using System;
+using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using dnSpy.Contracts.Debugger;
 using dnSpy.Contracts.Debugger.DotNet.CorDebug;
 using dnSpy.Contracts.Debugger.StartDebugging;
 using dnSpy.Contracts.Debugger.StartDebugging.Dialog;
 using dnSpy.Contracts.MVVM;
+using dnSpy.Debugger.DotNet.CorDebug.Properties;
 using dnSpy.Debugger.DotNet.CorDebug.Utilities;
 
 namespace dnSpy.Debugger.DotNet.CorDebug.Dialogs.DebugProgram {
@@ -34,6 +37,16 @@ sealed class DotNetFrameworkStartDebuggingOptionsPage : DotNetCommonStartDebuggi
 		// Shouldn't be localized
 		public override string DisplayName => ".NET Framework";
 
+		public ListVM<string> RuntimeVersionsVM { get; } = new ListVM<string>(CreateRuntimeVersions());
+
+		static string[] CreateRuntimeVersions() {
+			var list = new List<string> {
+				dnSpy_Debugger_DotNet_CorDebug_Resources.DbgAsm_Autodetect,
+			};
+			list.AddRange(DotNetHelpers.GetInstalledFrameworkVersions().OrderByDescending(x => x));
+			return list.ToArray();
+		}
+
 		public DotNetFrameworkStartDebuggingOptionsPage(IPickFilename pickFilename, IPickDirectory pickDirectory)
 			: base(pickFilename, pickDirectory) {
 		}
@@ -74,10 +87,18 @@ DotNetFrameworkStartDebuggingOptions GetDefaultOptions(string filename, string b
 		DotNetFrameworkStartDebuggingOptions CreateOptions(string breakKind) =>
 			InitializeDefault(new DotNetFrameworkStartDebuggingOptions(), breakKind);
 
-		void Initialize(DotNetFrameworkStartDebuggingOptions options) => base.Initialize(options);
+		void Initialize(DotNetFrameworkStartDebuggingOptions options) {
+			base.Initialize(options);
+			if (options.DebuggeeVersion is null)
+				RuntimeVersionsVM.SelectedIndex = 0;
+			else
+				RuntimeVersionsVM.SelectedItem = options.DebuggeeVersion;
+		}
 
 		public override StartDebuggingOptionsInfo GetOptions() {
-			var options = GetOptions(new DotNetFrameworkStartDebuggingOptions());
+			var options = GetOptions(new DotNetFrameworkStartDebuggingOptions {
+				DebuggeeVersion = RuntimeVersionsVM.SelectedIndex == 0 ? null : RuntimeVersionsVM.SelectedItem
+			});
 			var flags = StartDebuggingOptionsInfoFlags.None;
 			if (File.Exists(options.Filename)) {
 				var extension = Path.GetExtension(options.Filename);
diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Impl/DotNetFrameworkDbgEngineImpl.cs b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Impl/DotNetFrameworkDbgEngineImpl.cs
index b36a20164d..6b696218ac 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Impl/DotNetFrameworkDbgEngineImpl.cs
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Impl/DotNetFrameworkDbgEngineImpl.cs
@@ -46,7 +46,7 @@ public DotNetFrameworkDbgEngineImpl(DbgEngineImplDependencies deps, DbgManager d
 		}
 
 		protected override CLRTypeDebugInfo CreateDebugInfo(CorDebugStartDebuggingOptions options) =>
-			new DesktopCLRTypeDebugInfo();
+			new DesktopCLRTypeDebugInfo(((DotNetFrameworkStartDebuggingOptions)options).DebuggeeVersion);
 
 		protected override CLRTypeAttachInfo CreateAttachInfo(CorDebugAttachToProgramOptions options) =>
 			new DesktopCLRTypeAttachInfo(((DotNetFrameworkAttachToProgramOptions)options).DebuggeeVersion);
diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.Designer.cs b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.Designer.cs
index 7894401d64..ffa9d4fdc3 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.Designer.cs
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.Designer.cs
@@ -69,6 +69,15 @@ public static string DbgAsm_Args {
             }
         }
         
+        /// <summary>
+        ///   Looks up a localized string similar to Autodetect.
+        /// </summary>
+        public static string DbgAsm_Autodetect {
+            get {
+                return ResourceManager.GetString("DbgAsm_Autodetect", resourceCulture);
+            }
+        }
+        
         /// <summary>
         ///   Looks up a localized string similar to _Break at.
         /// </summary>
@@ -105,6 +114,15 @@ public static string DbgAsm_HostArgs {
             }
         }
         
+        /// <summary>
+        ///   Looks up a localized string similar to _Runtime Version.
+        /// </summary>
+        public static string DbgAsm_RuntimeVersion {
+            get {
+                return ResourceManager.GetString("DbgAsm_RuntimeVersion", resourceCulture);
+            }
+        }
+        
         /// <summary>
         ///   Looks up a localized string similar to _Timeout.
         /// </summary>
diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.resx b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.resx
index cee5a6093d..4edcdf81f8 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.resx
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Properties/dnSpy.Debugger.DotNet.CorDebug.Resources.resx
@@ -129,6 +129,12 @@
   <data name="DbgAsm_HostArgs" xml:space="preserve">
     <value>Host Ar_guments</value>
   </data>
+  <data name="DbgAsm_RuntimeVersion" xml:space="preserve">
+    <value>_Runtime Version</value>
+  </data>
+  <data name="DbgAsm_Autodetect" xml:space="preserve">
+    <value>Autodetect</value>
+  </data>
   <data name="DbgAsm_Timeout" xml:space="preserve">
     <value>_Timeout</value>
   </data>
diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Themes/wpf.styles.templates.xaml b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Themes/wpf.styles.templates.xaml
index e240461eb4..876aa62a61 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Themes/wpf.styles.templates.xaml
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Themes/wpf.styles.templates.xaml
@@ -28,6 +28,7 @@
                 <RowDefinition Height="Auto" />
                 <RowDefinition Height="Auto" />
                 <RowDefinition Height="Auto" />
+                <RowDefinition Height="Auto" />
             </Grid.RowDefinitions>
             <Grid.ColumnDefinitions>
                 <ColumnDefinition Width="Auto" />
@@ -46,8 +47,11 @@
             <TextBox Grid.Row="2" Grid.Column="1" Margin="5 5 0 0" Name="cwdTextBox" Text="{Binding WorkingDirectory, ValidatesOnDataErrors=True, ValidatesOnExceptions=True, UpdateSourceTrigger=PropertyChanged}" />
             <Button Grid.Row="2" Grid.Column="2" Margin="5 5 0 0" Style="{StaticResource EllipsisButton}" Command="{Binding PickWorkingDirectoryCommand}" />
 
-            <Label Grid.Row="3" Grid.Column="0" Margin="0 5 0 0" Content="{x:Static p:dnSpy_Debugger_DotNet_CorDebug_Resources.DbgAsm_BreakAt}" Target="{Binding ElementName=breakComboBox}" />
-            <ComboBox Grid.Row="3" Grid.Column="1" Margin="5 5 0 0" HorizontalAlignment="Stretch" Name="breakComboBox" DisplayMemberPath="Name" ItemsSource="{Binding BreakProcessKindVM.Items}" SelectedIndex="{Binding BreakProcessKindVM.SelectedIndex}" VerticalContentAlignment="Center" />
+            <Label Grid.Row="3" Grid.Column="0" Margin="0 5 0 0" Content="{x:Static p:dnSpy_Debugger_DotNet_CorDebug_Resources.DbgAsm_RuntimeVersion}" Target="{Binding ElementName=runtimeVersionComboBox}" />
+            <ComboBox Grid.Row="3" Grid.Column="1" Margin="5 5 0 0" HorizontalAlignment="Stretch" Name="runtimeVersionComboBox" ItemsSource="{Binding RuntimeVersionsVM.Items}" SelectedIndex="{Binding RuntimeVersionsVM.SelectedIndex}" VerticalContentAlignment="Center" />
+
+            <Label Grid.Row="4" Grid.Column="0" Margin="0 5 0 0" Content="{x:Static p:dnSpy_Debugger_DotNet_CorDebug_Resources.DbgAsm_BreakAt}" Target="{Binding ElementName=breakComboBox}" />
+            <ComboBox Grid.Row="4" Grid.Column="1" Margin="5 5 0 0" HorizontalAlignment="Stretch" Name="breakComboBox" DisplayMemberPath="Name" ItemsSource="{Binding BreakProcessKindVM.Items}" SelectedIndex="{Binding BreakProcessKindVM.SelectedIndex}" VerticalContentAlignment="Center" />
         </Grid>
     </DataTemplate>
 
diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Utilities/DotNetHelpers.cs b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Utilities/DotNetHelpers.cs
index 8f141971f1..1c9ef41220 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Utilities/DotNetHelpers.cs
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/Utilities/DotNetHelpers.cs
@@ -21,10 +21,14 @@ You should have received a copy of the GNU General Public License
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Linq;
 using System.Runtime.InteropServices;
+using System.Text;
 using System.Text.RegularExpressions;
+using dndbg.COM.MetaHost;
 using dnlib.DotNet;
 using dnlib.PE;
+using dnSpy.Debugger.DotNet.CorDebug.Native;
 using dnSpy.Debugger.Shared;
 using Microsoft.Win32;
 
@@ -188,5 +192,32 @@ public static bool IsDotNetExecutable(string filename) {
 			}
 			return false;
 		}
+
+		public static string? GetLatestInstalledFrameworkVersion() =>
+			GetInstalledFrameworkVersions().OrderByDescending(x => x).FirstOrDefault();
+
+		public static IEnumerable<string> GetInstalledFrameworkVersions() {
+			var clsid = new Guid("9280188D-0E8E-4867-B30C-7FA83884E8DE");
+			var riid = typeof(ICLRMetaHost).GUID;
+			var mh = (ICLRMetaHost)NativeMethods.CLRCreateInstance(ref clsid, ref riid);
+
+			int hr = mh.EnumerateInstalledRuntimes(out var iter);
+			if (hr < 0)
+				yield break;
+			for (;;) {
+				hr = iter.Next(1, out object obj, out uint fetched);
+				if (hr < 0 || fetched == 0)
+					break;
+
+				var rtInfo = (ICLRRuntimeInfo)obj;
+				uint chBuffer = 0;
+				var sb = new StringBuilder(300);
+				hr = rtInfo.GetVersionString(sb, ref chBuffer);
+				sb.EnsureCapacity((int)chBuffer);
+				hr = rtInfo.GetVersionString(sb, ref chBuffer);
+
+				yield return sb.ToString();
+			}
+		}
 	}
 }
diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/COM/MetaHost.cs b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/COM/MetaHost.cs
index be43a62259..ece228f3ce 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/COM/MetaHost.cs
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/COM/MetaHost.cs
@@ -49,8 +49,8 @@ interface ICLRMetaHost {
 		[return: MarshalAs(UnmanagedType.Interface)]
 		object GetRuntime([MarshalAs(UnmanagedType.LPWStr)] [In] string pwzVersion, [In] ref Guid riid);
 		void GetVersionFromFile([MarshalAs(UnmanagedType.LPWStr)] [In] string pwzFilePath, [MarshalAs(UnmanagedType.LPWStr)] [Out] StringBuilder pwzBuffer, [In] [Out] ref uint pcchBuffer);
-		[return: MarshalAs(UnmanagedType.Interface)]
-		IEnumUnknown EnumerateInstalledRuntimes();
+		[PreserveSig]
+		int EnumerateInstalledRuntimes([MarshalAs(UnmanagedType.Interface)] out IEnumUnknown ppEnumerator);
 		[PreserveSig]
 		int EnumerateLoadedRuntimes([In] IntPtr hndProcess, [MarshalAs(UnmanagedType.Interface)] out IEnumUnknown ppEnumerator);
 		void RequestRuntimeLoadedNotification([MarshalAs(UnmanagedType.Interface)] [In] ICLRMetaHost pCallbackFunction);
diff --git a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/Engine/DebuggeeVersionDetector.cs b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/Engine/DebuggeeVersionDetector.cs
index 98b6af95ad..40edcbe1c1 100644
--- a/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/Engine/DebuggeeVersionDetector.cs
+++ b/Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/Engine/DebuggeeVersionDetector.cs
@@ -22,10 +22,17 @@ You should have received a copy of the GNU General Public License
 using System.Text;
 using dndbg.COM.CorDebug;
 using dndbg.COM.MetaHost;
+using dnSpy.Debugger.DotNet.CorDebug.Utilities;
 
 namespace dndbg.Engine {
 	static class DebuggeeVersionDetector {
-		public static string GetVersion(string filename) => TryGetVersion(filename) ?? RuntimeEnvironment.GetSystemVersion();
+		public static string GetVersion(string filename) => TryGetVersion(filename) ??
+															DotNetHelpers.GetLatestInstalledFrameworkVersion() ??
+#if NETFRAMEWORK
+															RuntimeEnvironment.GetSystemVersion();
+#else
+															"v4.0.30319";
+#endif
 
 		public static string? TryGetVersion(string filename) {
 			try {
diff --git a/dnSpy/dnSpy.Contracts.Debugger.DotNet.CorDebug/DotNetFrameworkStartDebuggingOptions.cs b/dnSpy/dnSpy.Contracts.Debugger.DotNet.CorDebug/DotNetFrameworkStartDebuggingOptions.cs
index 56aa12a82c..bcb3b30ae9 100644
--- a/dnSpy/dnSpy.Contracts.Debugger.DotNet.CorDebug/DotNetFrameworkStartDebuggingOptions.cs
+++ b/dnSpy/dnSpy.Contracts.Debugger.DotNet.CorDebug/DotNetFrameworkStartDebuggingOptions.cs
@@ -25,6 +25,11 @@ namespace dnSpy.Contracts.Debugger.DotNet.CorDebug {
 	/// This is used to debug .NET Framework assemblies.
 	/// </summary>
 	public sealed class DotNetFrameworkStartDebuggingOptions : CorDebugStartDebuggingOptions {
+		/// <summary>
+		/// Version of an already installed CLR (eg. "v2.0.50727", or "v4.0.30319") or null to auto detect it
+		/// </summary>
+		public string? DebuggeeVersion { get; set; }
+
 		/// <summary>
 		/// Clones this instance
 		/// </summary>
@@ -40,6 +45,7 @@ public DotNetFrameworkStartDebuggingOptions CopyTo(DotNetFrameworkStartDebugging
 			if (other is null)
 				throw new ArgumentNullException(nameof(other));
 			base.CopyTo(other);
+			other.DebuggeeVersion = DebuggeeVersion;
 			return other;
 		}
 	}