如 Don Box 在《.NET本质论 第1卷:公共语言运行库》一书的第10章中介绍, CLR 调试框架是一个由 CLR 提供的,面向工具开发商的,支持调试功能的最小功能集。与 JVM 的 JDI (Java Debug Interface)不同,CLR 调试框架不仅仅关注于虚拟机一级的调试,同时也提供了 Native 一级调试的统一接口。使得现有工具开发商能够以最小代价移植并支持 CLR 调试功能。而对 CLR 调试更高层次或更细粒度的支持,则是由前面提到的 Profiling API 完成。
CLR 调试接口主要通过 mscordbi.dll 提供的 ICorDebug 接口,让调试器通过进程内或进程外方式,对被调试 CLR 进行监控。而 ICorDebug 接口可以通过 .NET Framework SDK 中 includecordebug.idl 或 includecordebug.h 直接使用。对 C#/Delphi 也可以直接 reference/import 在 SDK 的 lib 目录下的 cordebug.tlb 类型库,获得调用包装类。下面示例将都使用 C# 作为描述语言。
在使用时,可以直接获取ICorDebug接口,并调用其Initialize/Terminate方法进行初始化和析构操作,框架代码如下:
以下为引用:
using CORDBLib;
namespace cordbg
{
public class Debugger : IDisposable
{
private ICorDebug _dbg;
public void Run()
{
_dbg = new CorDebugClass();
try
{
_dbg.Initialize();
// 构造调试环境
// 处理调试事件
}
finally
{
_dbg.Terminate();
}
}
...
}
[MTAThread]
static void Main(string[] args)
{
using(Debugger dbg = new Debugger())
{
dbg.Run();
}
}
}
注意 CLR 调试环境必须在 MTA 的线程套间上下文(Thread Apartment Context)中运行,因此必须将入口函数的 STAThread 属性改成 MTAThread,否则会在调试接口调用回调函数时出现异常。对应于 COM 中的 CoInitializeEx(NULL, COINIT_MULTITHREADED) 调用。
在创建了 ICorDebug 调试接口后,需要针对托管和非托管调试事件,提供调试事件回调接口。可以将实现了调试事件接口 ICorDebugManagedCallback/ICorDebugUnmanagedCallback 的实例,使用 ICorDebug 接口的 SetManagedHandler/SetUnmanagedHandler 方法,挂接到调试系统上,在适当的时候由调试系统回调,通知调试器有调试事件发生。实现上可以通过 ManagedEventHandler/UnmanagedEventHandler 两个单独的类,抽象出对托管和非托管调试事件的处理机制,将之挂接到调试器上,如:
以下为引用:
namespace cordbg
{
public class DebugEventHandler
{
protected Debugger _dbg;
public DebugEventHandler(Debugger dbg)
{
this._dbg = dbg;
}
}
public class ManagedEventHandler : DebugEventHandler, ICorDebugManagedCallback
{
public ManagedEventHandler(Debugger dbg) : base(dbg)
{
}
// 实现 ICorDebugManagedCallback 接口
}
public class UnmanagedEventHandler : DebugEventHandler, ICorDebugUnmanagedCallback
{
public UnmanagedEventHandler(Debugger dbg) : base(dbg)
{
}
// 实现 ICorDebugUnmanagedCallback 接口
}
public class Debugger : IDisposable
{
public void Run()
{
//...
_dbg.SetManagedHandler(new ManagedEventHandler(this));
_dbg.SetUnmanagedHandler(new UnmanagedEventHandler(this));
//...
}
}
}
在准备好了调试事件处理器后,就可以根据需要,创建或者附加到目标调试进程上。ICorDebug 提供了 CreateProcess 方法对 Win32 API 中 CreateProcess 函数进行了包装。
以下为引用:
public abstract interface ICorDebug
{
public abstract new void CreateProcess (
string lpApplicationName,
string lpCommandLine,
_SECURITY_ATTRIBUTES lpProcessAttributes,
_SECURITY_ATTRIBUTES lpThreadAttributes,
int bInheritHandles,
uint dwCreationFlags,
IntPtr lpEnvironment,
System.String lpCurrentDirectory,
uint lpStartupInfo,
uint lpProcessInformation,
CorDebugCreateProcessFlags debuggingFlags,
ICorDebugProcess ppProcess)
}
BOOL CreateProcess(
LPCTSTR lpApplicationName,
LPTSTR lpCommandLine,
LPSECURITY_ATTRIBUTES lpProcessAttributes,
LPSECURITY_ATTRIBUTES lpThreadAttributes,
BOOL bInheritHandles,
DWORD dwCreationFlags,
LPVOID lpEnvironment,
LPCTSTR lpCurrentDirectory,
LPSTARTUPINFO lpStartupInfo,
LPPROCESS_INFORMATION lpProcessInformation
);
可以看到这两个函数的参数基本上是一一对应的,只不过ICo