|
The .NET Profiling API and the DNProfiler Tool
http://msdn.microsoft.com/msdnmag/issues/01/12/hood/default.aspx
微软的.NET Common Language Runtime(CLR)内部提供了很多机制来创建更容易使用、更面向对象的平台。包括垃圾回收、标准的跨语言异常处理、广泛的类库、元数据、和已存native代码的互操作性、远程处理。也包括跨cpu指令格式（中间语言，IL）和将IL编译成能够在目标cpu上运行的代码的即时编译器。
随着系统的发展变得越来越复杂，能够理解系统的内部工作机制变得越来越有价值。在Windows®，调查可执行程序装载器、内存管理器的操作机制将展示很多不同的技巧。另外，有些技巧在window 9X 平台下能够正常工作，但是在Windows NT® 和Windows 2000不能工作，反之亦然。在Win32®下，查看进程的内部操作的最好方式是使用调试API，但是它也只能是包含很少的一部分。
在.NET下就完全不同了。因为CLR运行时是任何.NET程序的中心，它提供了一个逻辑位置来插入钩子以便观察.NET的内部。预计到工具开发者、系统级程序员的需要，Microsoft使用.NET来提供了一个非常详细的、一致的方式去观察进程的内部操作。本月，我要描述这种机制、并提供一个程序（DNProfile）来记录.NET运行时的操作。
The .NET Profiling API
观察.NET运行时动作的一种方式时使用剖析API。剖析API的命名不好，因为它对很多种事情都很有用，而不仅仅是剖析。考虑可以被剖析API观察的.NET动作列表，如下：
Figure 1 Functions of the Profiling API
CLR startup and shutdown
Application domain creation/shutdown
Assembly loads/unloads
Module loads/unloads
Class loads/unloads
COM interop VTable creation/destruction
JIT-compiles, code pitching, and pre-JITed method searches
Thread creation/destruction/suspends
Remoting activity
Exception handling
Managed/unmanaged code transitions
Garbage collection and managed heap objects
Method entry/exit
正如Keanu Reeves会说Whoooa! 相对于经过了多年的艰苦探索找到的如何给WINDOWS安装钩子来讲，Microsoft使观察CLR的行为变得非常容易了。列表中的每一个动作可以看作一个完全不同的CALLBACK。理论上讲，仅仅在CALLBACK函数中写需要的代码就可以了。
现在，最好的剖析API文档是.NET SDK下的Profiling.doc，在Tool Developers Guide\docs目录下。对于Beta2 来讲，这个文档和实现稍微有些不同步。在本期刊中，我不会广泛的讨论剖析API的每一个方面，而是重点讨论剖析API能做的大的方面。
.NET的一个大的卖点是它不再使用COM。这不是真的，事实上，剖析API就是基于COM的。使用剖析API包括创建一个进程内服务器，它实现了单一的接口。每一个接口方法代表了Figure 1中的一个事件。在CALLBACK方法内部，代码可以使用另外的COM接口（由CLR提供）来得到观察事件的信息。
个人来讲，我喜欢更简单的API来对所感兴趣的每一个事件进行注册。将API实现作为一个COM对象强迫你写几乎同样的代码以便使用COM对象。既然剖析API是基于COM的，剖析API的用户很可能使用C++。
尽管使用典型的COM而不是使用托管.NET代码起初看起来有些奇怪，仔细考虑之后就会明白。如果用托管代码实现接口，它将对监视的所有事件的产生负面影响。例如，如果实现接口的托管代码触发了异常怎么办？在API没有激活的情况下，异常事件也不会发生。
一旦你有一个实现了Profiling接口的COM服务器，下一步是强迫CLR装载COM服务器、调用它的方法。技巧是设置环境变量。跟注册表、XML文件比较起来，环境变量是挺古老的。
为什么不用注册表（配置文件）告诉CLR应该调用Profiling API？我从Microsoft开发者那里听说的一个原因是那要求.NET程序在启动时检查注册表将会有性能影响。考虑到.NET启动时有很多事情要做，这样的原因考虑的也是很慎重的。虽然如此，使用环境变量可以对所有程序起作用（如果在系统环境变量）或单独的进程。在后者情况下，调试器、剖析器等工具可以在启动程序时指定环境变量。稍后我将讨论所需要的环境变量。
The .NET Profiling API Interfaces
我检查的主要的接口是ICorProfilerCallback，在.NET Framework SDK的Include目录下的CorProf.IDL文件中定义。接口的实现需要使用剖析API。你的工作是提供实现。尽管有很多的方法，不要怕，对于他们中的大多说，可以简单的返回S_OK或E_NOIMPL。对于明确的事件的动作，在合适的CALLBACK方法中写合适的代码。
检查CALLBACK方法，你会发现大部分接收有关于那个事件的另外信息的参数。例如,JITCompilationStarted方法接收了一个名为functionId的UINT类型的参数。你可以对它做什么？答案在于接口ICorProfilerInfo。
ICorProfilerInfo可以提供任何剖析信息。考虑刚才提及的functionId，你可以调用ICorProfilerInfo::GetTokenAndMetaDataFromFunction，它返回给你元数据接口、函数的元数据token。使用元数据接口和token，你可以查询函数名、它所在的类、及你所知道的任何信息。
简单的讲，剖析API包含了两个COM接口。引入接口，由你来实现，是ICorProfilerCallback。当CLR事件发生时，CLR会调用接口中的某一个方法。引出接口，是ICorProfilerInfo，由CLR提供给你，让你在CALLBACK内部使用。
使用ICorProfilerCallback参数的普遍的模式是广泛的使用ID来代表函数、类、模块、程序集，等。ID是不透明的句柄。关于它的有意义的信息从ICorProfilerInfo接口来获得。程序执行过程中如果函数的代码被卸载，然后又被装载、并编译，特定的ID值（如functionId）可能会改变。但是有CALLBACK让你知道这个发生了。
ICorProfilerCallback方法可以分成逻辑的几组。大部分情况下，事件都有Started、Finished方法，并且成对的调用。让我们进行深入研究它，更好的了解我们可以通过CLR观察到什么。除非有特殊说明，下面列出的所有方法都属于ICorProfilerCallback接口。
Initialize/Shutdown Methods
在使用剖析API的进程中，Initialize是第一个被调用的方法。你的代码从这个方法得到ICorProfilerInfo指针。唯一的参数是LPUNKNOWN，对它调用QueryInterface方法得到ICorProfilerInfo指针。Initialize是你告诉剖析API你对哪些事件感兴趣的地方。
为了指出你感兴趣的事件，调用ICorProfilerInfo::SetEventMask方法，传递一个设置了合适的bit的DWORD类型的参数。这些标志来自于CorProf.h文件中的COR_PROF_MONITOR枚举变量。低位值标志被命名为COR_PRF_MONITOR_XXX，告诉CLR调用ICorProfilerCallback的哪些方法。例如，如果你想让ClassLoadStarted方法被调用，你必须设置COR_PRF_MONITOR_CLASS_LOADS标志。
ICorProfilerInfo::SetEventMask方法的参数的另外一些标志以一种方式、或者另一种方式改变CLR的行为.例如，如果你想在执行时监视对象的分配，必须设置COR_PRF_ENABLE_OBJECT_ALLOCATED标志。相似的，COR_PRF_DISABLE_INLINING告诉CLR不要内联任何函数。如果一个方法内联了，你将得不到ENTER、LEAVE通知。
你可以在以后的某个时刻调用ICorProfilerInfo::SetEventMask来修改你所感兴趣的事件。然而，某些事件是不可以改变的，意味着你一旦在Initialize设置了，他们将不能被修改。
当CLR终止进程时，Shutdown方法被调用。在某些情况下，它不会被调用，但是对于一个正常终止的.NET程序来讲，它应该被调用。
Application Domain Creation/Shutdown
这个种类的方法有AppDomainCreationStarted, AppDomainCreationFinished, AppDomainShutdownStarted, and AppDomainShutdownFinished。他们的名字是自描述的。这些方法的主要Token是AppDomainID。需要注意的是在AppDomainCreationStarted 回调方法中，不能使用AppDomainID，因为AppDomain还不存在。然而，一旦收到了AppDomainCreationFinished通知，就可以以AppDomainID为参数调用以为参数调用ICorProfilerInfo::GetAppDomainInfo 来得到新AppDomain的信息。
Assembly Loads/Unloads
在装载、卸载程序集时，AssemblyLoadStarted, AssemblyLoadFinished, AssemblyUnloadStarted, AssemblyUnloadFinished这些方法被调用。主要的Token是AssemblyID。需要注意的是在AssemblyLoadStarted方法中不能使用Token AssemblyID，因为程序集还不存在。然而，一旦收到AssemblyLoadFinished通知，就可以以AssemblyID为参数调用ICorProfilerInfo::GetAssemblyInfo来得到新程序集的信息。
Module Loads/Unloads
装载模块相关的函数有ModuleLoadStarted, ModuleLoadFinished, ModuleUnloadStarted, ModuleUnloadFinished, 和ModuleAttachedToAssembly。前四个函数的名字是自描述的。主要的Token是ModuleID。和AssemblyLoadStarted时的Token一样，传递给ModuleLoadStarted方法的Token也是不可用的。因为模块不存在。但是当收到ModuleLoadFinished通知后，就可以以ModuleID为参数调用ICorProfilerInfo::GetModuleInfo来得到新模块的信息。
当CLR将一个模块和一个程序集相关联起来时，最后一个函数，ModuleAttachedToAssembly，被调用。尽管模块和程序集经常是同一个文件，一个程序集也可能有多个模块。
Class Loads/Unloads
装载类相关的函数有ClassLoadStarted, ClassLoadFinished, ClassUnloadStarted, 和ClassUnloadFinished。这些函数的名字是自描述的。传递给ClassLoadStarted方法的Token也是不可用的。因为类不存在。但是当收到ClassLoadFinished通知后，就可以以ClassID为参数调用ICorProfilerInfo::GetClassIDInfo来得到新类的信息。
JIT Compilation
JIT编译方法（如图2）用到的主要Token是FunctionID。
JITCompilationStarted
JITCompilationFinished
JITCachedFunctionSearchStarted
JITCachedFunctionSearchFinished
JITFunctionPitched
JITInlining
这里，术语函数、方法交互的使用。以FunctionID为参数调用 ICorProfilerInfo::GetFunctionInfo来获得函数的信息。
方法JITCompilationStarted是很有趣的，因为它允许你在JITed之前查看、修改IL。查看ICorProfilerInfo:: GetILFunctionBody来获得细节，不要认为它很容易。方法JITCachedFunctionSearchStarted表示CLR寻找已经被JITed编译成native代码的函数。通过设置输出参数pbUseCachedFunction为FALSE，你可以强制运行时不考虑Pre-JITd的状态，使用最新的JITed版本。
方法JITFunctionPitched表示从内存中删除一个以前JITed的方法。只有在内存很少的情况下，才会发生。最后方法JITInlining表示JITer要内联函数。如果你要计算那个方法的enter/leave通知个数，可以设置输出参数pfShouldInline为FALSE来禁止内联。也可以通过传递给ICorProfilerInfo::SetEventMask的一个标志来禁止进程范围内的内联。
Threading
线程方法如图3
ThreadCreated
ThreadDestroyed
ThreadAssignedToOSThread
RuntimeSuspendStarted
RuntimeSuspendFinished
RuntimeSuspendAborted
RuntimeResumeStarted
RuntimeResumeFinished
RuntimeThreadSuspended
RuntimeThreadResumed
ThreadCreated/Destroyed方法包含了线程的生命周期。例如，概念上讲，一个CLR线程在其生命周期中可以运行在多个Win32线程之上。ThreadAssignedToOSThread方法指示了CLR正在运行在哪个Win32线程之上。
当CLR执行时，有时必须挂起部分或者所有的线程以便执行垃圾收集。RuntimeSuspend，RuntimeResume系列的方法指示CLR线程被挂起（实际比这更复杂，我在这里部深入细节了）。传递给RuntimeSuspendStarted的一个参数指示了线程为什么被挂起。最后两个RuntimeThread方法指示一个线程正在被挂起，并且那总在事件RuntimeSuspend内发生。
COM Interop
当CLR和普通的COM对象互操作时，需要代理接口。两个方法指示代理被创建、销毁。传递到这两个函数的参数是.NET ClassID，相应的COM接口IID，一个指向代理的虚函数表，虚函数表的项数。
Managed/Unmanaged Code Transitions
当托管代码调用非托管代码，或者非托管代码调用托管代码时，函数UnmanagedToManagedTransition 、ManagedToUnmanagedTransition被调用。传递给每个方法FunctionID来代表调用者，可以利用它调用ICorProfilerInfo::GetFunctionInfo来得到更多� | 
本类阅读TOP10