Skip to content

Commit

Permalink
Improve support for debugging single file .NET applications
Browse files Browse the repository at this point in the history
  • Loading branch information
@ElektroKill
ElektroKill committed May 22, 2023
1 parent e638f47 commit 4fe02eb
Show file tree
Hide file tree
Showing 4 changed files with 143 additions and 10 deletions.
19 changes: 19 additions & 0 deletions Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/COM/MetaHost.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,23 @@ interface ICLRMetaHostPolicy {
[return: MarshalAs(UnmanagedType.Interface)]
object GetRequestedRuntime([In] METAHOST_POLICY_FLAGS dwPolicyFlags, [MarshalAs(UnmanagedType.LPWStr)] [In] string pwzBinary, [MarshalAs(UnmanagedType.Interface)] [In] IStream pCfgStream, [MarshalAs(UnmanagedType.LPWStr)] [In] [Out] StringBuilder pwzVersion, [In] [Out] ref uint pcchVersion, [MarshalAs(UnmanagedType.LPWStr)] [Out] StringBuilder pwzImageVersion, [In] [Out] ref uint pcchImageVersion, out uint pdwConfigFlags, [In] ref Guid riid);
}
[Guid("E04E2FF1-DCFD-45D5-BCD1-16FFF2FAF7BA"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[ComImport, SuppressUnmanagedCodeSecurity]
interface ICLRDebuggingLibraryProvider2 {
[PreserveSig]
int ProvideLibrary2([MarshalAs(UnmanagedType.LPWStr)] [In] string pwszFileName, [In] int dwTimestamp, [In] int dwSizeOfImage, out IntPtr ppResolvedModulePath);
}
[Guid("DE3AAB18-46A0-48B4-BF0D-2C336E69EA1B"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[ComImport, SuppressUnmanagedCodeSecurity]
interface ICLRDebuggingLibraryProvider3 {
[PreserveSig]
int ProvideWindowsLibrary([MarshalAs(UnmanagedType.LPWStr)] [In] string pwszFileName, [MarshalAs(UnmanagedType.LPWStr)] [In] string pwszRuntimeModule, [In] LIBRARY_PROVIDER_INDEX_TYPE indexType, [In] int dwTimestamp, [In] int dwSizeOfImage, out IntPtr ppResolvedModulePath);
[PreserveSig]
int ProvideUnixLibrary([MarshalAs(UnmanagedType.LPWStr)] [In] string pwszFileName, [MarshalAs(UnmanagedType.LPWStr)] [In] string pwszRuntimeModule, [In] LIBRARY_PROVIDER_INDEX_TYPE indexType, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 4)] [In] byte[] pbBuildId, [In] int iBuildIdSize, out IntPtr ppResolvedModulePath);
}
enum LIBRARY_PROVIDER_INDEX_TYPE {
Unknown,
Identity,
Runtime,
}
}
115 changes: 106 additions & 9 deletions Extensions/dnSpy.Debugger/dnSpy.Debugger.DotNet.CorDebug/dndbg/Engine/CoreCLRHelper.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
using System.Runtime.InteropServices;
using System.Text;
using dndbg.COM.CorDebug;
using dndbg.COM.MetaHost;
using dnlib.PE;
using dnSpy.Contracts.Utilities;
using dnSpy.Debugger.Shared;

namespace dndbg.Engine {
Expand All @@ -37,13 +40,95 @@ namespace dndbg.Engine {
}
}

sealed class CLRDebuggingLibraryProvider : ICLRDebuggingLibraryProvider2, ICLRDebuggingLibraryProvider3 {
readonly string coreclrFileName;
readonly DotNetPathProvider dotNetPathProvider;

public CLRDebuggingLibraryProvider(string coreclrFileName) {
this.coreclrFileName = coreclrFileName;
dotNetPathProvider = new DotNetPathProvider();
}

public int ProvideLibrary2(string pwszFileName, int dwTimestamp, int dwSizeOfImage, out IntPtr ppResolvedModulePath) {
var resultFile = LocateDebuggingLibrary(coreclrFileName, pwszFileName, dwTimestamp, dwSizeOfImage);
if (resultFile is not null) {
ppResolvedModulePath = Marshal.StringToCoTaskMemUni(resultFile);
return 0;
}

ppResolvedModulePath = IntPtr.Zero;
return -1;
}

public int ProvideWindowsLibrary(string pwszFileName, string pwszRuntimeModule, LIBRARY_PROVIDER_INDEX_TYPE indexType, int dwTimestamp, int dwSizeOfImage, out IntPtr ppResolvedModulePath) {
Debug2.Assert(indexType == LIBRARY_PROVIDER_INDEX_TYPE.Identity);
Debug2.Assert(pwszRuntimeModule == coreclrFileName);

var resultFile = LocateDebuggingLibrary(pwszRuntimeModule, pwszFileName, dwTimestamp, dwSizeOfImage);
if (resultFile is not null) {
ppResolvedModulePath = Marshal.StringToCoTaskMemUni(resultFile);
return 0;
}

ppResolvedModulePath = IntPtr.Zero;
return -1;
}

string? LocateDebuggingLibrary(string clrFileName, string libraryName, int timeStamp, int sizeOfImage) {
// Check to see if the file is available next to the runtime dll.
var runtimeDirectory = Path.GetDirectoryName(clrFileName);
string? defaultFileName = null;
if (runtimeDirectory is not null) {
defaultFileName = Path.Combine(runtimeDirectory, libraryName);
if (File.Exists(defaultFileName) && VerifyPEMatches(defaultFileName, timeStamp, sizeOfImage))
return defaultFileName;
}

// Check if the user has a matching .NET runtime installed, if so, try to load the file from there.
var clrFileVersion = FileVersionInfo.GetVersionInfo(clrFileName);
var dotNetVersion = new Version(clrFileVersion.FileMajorPart, clrFileVersion.FileMinorPart, clrFileVersion.FileBuildPart / 100, 0);
var dotNetPaths = dotNetPathProvider.TryFindExactRuntimePaths(dotNetVersion, IntPtr.Size * 8);
foreach (string dotNetPath in dotNetPaths) {
var fileName = Path.Combine(dotNetPath, libraryName);
if (File.Exists(fileName) && VerifyPEMatches(fileName, timeStamp, sizeOfImage))
return fileName;
}

// Fall back to file path net to the runtime dll
return defaultFileName;
}

static bool VerifyPEMatches(string fileName, int timeStamp, int sizeOfImage) {
using (var peImage = new PEImage(fileName)) {
if (peImage.ImageNTHeaders.FileHeader.TimeDateStamp != timeStamp)
return false;
if (peImage.ImageNTHeaders.OptionalHeader.SizeOfImage != sizeOfImage)
return false;

switch (peImage.ImageNTHeaders.OptionalHeader.Magic) {
case 0x010B when IntPtr.Size == 4:
case 0x020B when IntPtr.Size == 8:
return true;
default:
return false;
}
}
}

public int ProvideUnixLibrary(string pwszFileName, string pwszRuntimeModule, LIBRARY_PROVIDER_INDEX_TYPE indexType, byte[] pbBuildId, int iBuildIdSize, out IntPtr ppResolvedModulePath) {
ppResolvedModulePath = IntPtr.Zero;
return -1;
}
}

static class CoreCLRHelper {
static readonly string dbgshimFilename = FileUtilities.GetNativeDllFilename("dbgshim");
delegate int GetStartupNotificationEvent(uint debuggeePID, out IntPtr phStartupEvent);
delegate int CloseCLREnumeration(IntPtr pHandleArray, IntPtr pStringArray, uint dwArrayLength);
delegate int EnumerateCLRs(uint debuggeePID, out IntPtr ppHandleArrayOut, out IntPtr ppStringArrayOut, out uint pdwArrayLengthOut);
delegate int CreateVersionStringFromModule(uint pidDebuggee, [MarshalAs(UnmanagedType.LPWStr)] string szModuleName, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder pBuffer, uint cchBuffer, out uint pdwLength);
delegate int CreateDebuggingInterfaceFromVersionEx(CorDebugInterfaceVersion iDebuggerVersion, [MarshalAs(UnmanagedType.LPWStr)] string? szDebuggeeVersion, [MarshalAs(UnmanagedType.IUnknown)] out object ppCordb);
delegate int CreateDebuggingInterfaceFromVersion3(CorDebugInterfaceVersion iDebuggerVersion, [MarshalAs(UnmanagedType.LPWStr)] string? szDebuggeeVersion, [MarshalAs(UnmanagedType.LPWStr)] string? szApplicationGroupId, [MarshalAs(UnmanagedType.Interface)] ICLRDebuggingLibraryProvider3 pLibraryProvider, [MarshalAs(UnmanagedType.IUnknown)] out object ppCordb);

/// <summary>
/// Searches for CoreCLR runtimes in a process
Expand Down Expand Up @@ -125,6 +210,7 @@ static class CoreCLRHelper {
dbgShimState.EnumerateCLRs = GetDelegate<EnumerateCLRs>(handle, "EnumerateCLRs");
dbgShimState.CreateVersionStringFromModule = GetDelegate<CreateVersionStringFromModule>(handle, "CreateVersionStringFromModule");
dbgShimState.CreateDebuggingInterfaceFromVersionEx = GetDelegate<CreateDebuggingInterfaceFromVersionEx>(handle, "CreateDebuggingInterfaceFromVersionEx");
dbgShimState.CreateDebuggingInterfaceFromVersion3 = GetDelegate<CreateDebuggingInterfaceFromVersion3>(handle, "CreateDebuggingInterfaceFromVersion3");
if (dbgShimState.GetStartupNotificationEvent is null ||
dbgShimState.CloseCLREnumeration is null ||
dbgShimState.EnumerateCLRs is null ||
Expand All @@ -146,6 +232,7 @@ sealed class DbgShimState {
public EnumerateCLRs? EnumerateCLRs;
public CreateVersionStringFromModule? CreateVersionStringFromModule;
public CreateDebuggingInterfaceFromVersionEx? CreateDebuggingInterfaceFromVersionEx;
public CreateDebuggingInterfaceFromVersion3? CreateDebuggingInterfaceFromVersion3;
}

static T? GetDelegate<T>(IntPtr handle, string funcName) where T : class {
Expand All @@ -164,6 +251,23 @@ sealed class DbgShimState {
return null;
}

static ICorDebug CreateDebuggingInterfaceFromVersion(DbgShimState dbgShimState, string? debuggeeVersion, string coreclrFilename) {
int hr;
object obj;
const CorDebugInterfaceVersion interfaceVersion = CorDebugInterfaceVersion.CorDebugVersion_4_5;
if (dbgShimState.CreateDebuggingInterfaceFromVersion3 is not null) {
var libraryProvider = new CLRDebuggingLibraryProvider(coreclrFilename);

hr = dbgShimState.CreateDebuggingInterfaceFromVersion3(interfaceVersion, debuggeeVersion, null, libraryProvider, out obj);
}
else
hr = dbgShimState.CreateDebuggingInterfaceFromVersionEx!(interfaceVersion, debuggeeVersion, out obj);

if (obj is not ICorDebug corDebug)
throw new Exception($"Could not create a ICorDebug: hr=0x{hr:X8}");
return corDebug;
}

public static ICorDebug? CreateCorDebug(int pid, CoreCLRTypeAttachInfo info, out string coreclrFilename, out string? otherVersion) {
string? clrPath = info.CoreCLRFilename;
otherVersion = info.Version;
Expand All @@ -182,11 +286,7 @@ sealed class DbgShimState {
var dbgShimState = GetOrCreateDbgShimState(null, info.DbgShimFilename);
if (dbgShimState is null)
return null;

int hr = dbgShimState.CreateDebuggingInterfaceFromVersionEx!(CorDebugInterfaceVersion.CorDebugVersion_4_5, otherVersion, out object obj);
if (obj is not ICorDebug corDebug)
throw new Exception($"Could not create a ICorDebug: hr=0x{hr:X8}");
return corDebug;
return CreateDebuggingInterfaceFromVersion(dbgShimState, otherVersion, coreclrFilename);
}

public unsafe static DnDebugger CreateDnDebugger(DebugProcessOptions options, CoreCLRTypeDebugInfo info, IntPtr outputHandle, IntPtr errorHandle, Func<bool> keepWaiting, Func<ICorDebug, string, uint, string?, DnDebugger> createDnDebugger) {
Expand Down Expand Up @@ -268,10 +368,7 @@ sealed class DbgShimState {
var pha = (IntPtr*)pHandleArray;
const int index = 0;
var version = GetVersionStringFromModule(dbgShimState, pi.dwProcessId, psa[index], out string coreclrFilename);
hr = dbgShimState.CreateDebuggingInterfaceFromVersionEx!(CorDebugInterfaceVersion.CorDebugVersion_4_5, version, out object obj);
var corDebug = obj as ICorDebug;
if (corDebug is null)
throw new Exception($"Could not create a ICorDebug: hr=0x{hr:X8}");
var corDebug = CreateDebuggingInterfaceFromVersion(dbgShimState, version, coreclrFilename);
var dbg = createDnDebugger(corDebug, coreclrFilename, pi.dwProcessId, version);
for (uint i = 0; i < dwArrayLength; i++)
NativeMethods.SetEvent(pha[i]);
Expand Down
2 changes: 1 addition & 1 deletion Extensions/dnSpy.Debugger/netcorefiles
Submodule netcorefiles updated 3 files
+3 −3 README.md
+ − x64/dbgshim.dll
+ − x86/dbgshim.dll
17 changes: 17 additions & 0 deletions dnSpy/dnSpy.Contracts.Logic/Utilities/DotNetPathProvider.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,23 @@ public sealed class DotNetPathProvider {
return fpMajorMinor ?? fpMajor;
}

/// <summary>
/// Returns the .NET runtime assembly directories on the system which exactly match the search criteria.
/// </summary>
/// <param name="version">The exact version of the .NET runtime</param>
/// <param name="bitness">The bitness of the .NET runtime</param>
/// <returns>The .NET runtime assembly directories. Empty if non where found.</returns>
public string[] TryFindExactRuntimePaths(Version version, int bitness) {
var candidates = new List<string>();
foreach (var frameworkPaths in netPathsShared) {
if (frameworkPaths.Bitness != bitness)
continue;
if (frameworkPaths.SystemVersion == version)
candidates.AddRange(frameworkPaths.Paths);
}
return candidates.ToArray();
}

static FrameworkPaths BestMinorVersion(int minor, FrameworkPaths a, FrameworkPaths b) {
uint da = VerDist(minor, a.Version.Minor);
uint db = VerDist(minor, b.Version.Minor);
Expand Down

0 comments on commit 4fe02eb

Please sign in to comment.