探查器是一种工具,监视另一个应用程序的执行。 公共语言运行时 (CLR) 探查器是一个动态链接库 (DLL),具有使用分析 API 从 CLR 中接收消息以及向 CLR 发送消息的功能。 CLR 在运行时加载探查器 DLL。
传统的分析工具专注于测量应用程序的执行情况。 即测量随着时间的推移应用程序使用每个功能或内存所花费的时间。 而分析 API 则针对更广泛的诊断工具,如代码覆盖率实用程序,甚至高级的调试辅助工具。 实际上,它们全都用于诊断用途。 分析 API 不仅测量而且还监视应用程序的执行情况。 基于此原因,应用程序本身始终不应使用分析 API 并且应用程序的执行情况不应依赖于探查器或受探查器影响。
与分析常规编译的机器代码相比,分析 CLR 应用程序需要更多支持。 这是因为 CLR 引进了诸如应用程序域、垃圾回收、托管异常处理、实时 (JIT) 代码编译(将 Microsoft 中间语言、MSIL 或代码转换为本机代码)以及类似功能的概念。 常规的分析机制无法识别或提供关于这些功能的有用信息。 分析 API 则有效地提供缺少的信息,并对 CLR 和分析的应用程序的性能产生最小的影响。
运行时的 JIT 编译可以很好地进行分析。 分析 API 允许探查器在对某一例程进行 JIT 编译之前更改该例程的内存中 MSIL 代码流。 探查器可以利用这种方式向需要深入调查的特定例程动态添加检测代码。 尽管此种方法在常规方案中可用,但是通过使用分析 API 可以更轻松地实现 CLR。
本概述包含以下几节:
分析 API
通常情况下,分析 API 用于编写代码探查器,这是一个程序,监视托管的应用程序的执行。
分析 API 由探查器 DLL 使用,加载到与所分析应用程序相同的进程中。 探查器 DLL 实现回调接口 (ICorProfilerCallback .NET Framework 版本 1.0 和 1.1 中,在ICorProfilerCallback2版本 2.0 及更高版本中)。 CLR 调用该接口的方法,以通知探查器所分析进程中发生的事件。 探查器可以重新使用调入运行时中的方法ICorProfilerInfo并ICorProfilerInfo2接口来获取有关所分析应用程序的状态信息。
Note: 只有探查器解决方案的数据收集部分才能在与所分析应用程序相同的进程中运行。 所有用户界面和数据分析都应在单独的进程中执行。
下图显示探查器 DLL 如何与所分析应用程序和 CLR 交互。
显示分析体系结构的屏幕截图。
通知接口
ICorProfilerCallback并ICorProfilerCallback2可视为通知接口。 这些接口如包含方法ClassLoadStarted, ClassLoadFinished,并JITCompilationStarted。 每次 CLR 进行加载或卸载类、编译函数等操作时,都会调用探查器的 ICorProfilerCallback 或 ICorProfilerCallback2 接口中的相应方法。
例如,探查器可以测量代码性能,通过两个通知函数:FunctionEnter2并FunctionLeave2。 它会对每个通知添加时间戳、累积结果并输出一个列表指示在应用程序执行期间哪个函数占用的 CPU 最多或消耗的时钟时间最长。
信息检索接口
其他主要接口分析涉及ICorProfilerInfo并ICorProfilerInfo2。 探查器根据需要调用这些接口,以获取更多的信息来帮助进行分析。 例如,每当 CLR 调用FunctionEnter2函数,它会提供函数标识符。 探查器可以通过调用来获取有关该函数的详细信息ICorProfilerInfo2::GetFunctionInfo2方法来发现该函数的父类、 其名称和等等。
支持的功能
分析 API 提供公共语言运行时中发生的各种事件和操作的相关信息。 你可以使用此信息来监视进程的内部工作情况,也可分析 .NET Framework 应用程序的性能。
分析 API 检索 CLR 中发生的以下操作和事件的相关信息:
-
CLR 启动和关闭事件。
-
应用程序域创建和关闭事件。
-
程序集加载和卸载事件。
-
模块加载和卸载事件。
-
COM vtable 创建和析构事件。
-
实时 (JIT) 编译和代码间距调整事件。
-
类加载和卸载事件。
-
线程创建和析构事件。
-
函数入口和退出事件。
-
异常。
-
托管和非托管代码执行之间的转换。
-
不同运行时上下文之间的转换。
-
有关运行时挂起的信息。
-
有关运行时内存堆和垃圾回收活动的信息。
分析 API 可从任何(非托管)COM 兼容语言调用。
API 可高效减少 CPU 和内存占用。 分析不包括对所分析应用程序进行足以导致误导性结果的更改。
分析 API 有益于采样和非采样探查器。 一个采样探查器检查配置文件将在常规时钟计时周期数,即每 5 毫秒。 一个非采样探查器将得到通知,以同步方式具有导致事件的线程的事件。
不支持的功能
分析 API 不支持以下功能:
-
非托管代码,此类代码必须使用常规 Win32 方法进行分析。 然而,CLR 探查器包括过渡事件,以确定托管与非托管代码之间的边界。
-
自修改应用程序,即出于某种目的(如面向方面的编程)修改自己的代码。
-
边界检查,原因是分析 API 不提供此信息。 CLR 为所有托管代码的边界检查提供内部支持。
-
远程分析,在以下情况不受支持:
-
远程分析延长执行时间。 当使用分析接口时,必须最大限度地缩短执行时间,确保分析结果不会受到不良影响。 在执行性能受到监视时尤为如此。 然而,当分析接口用于监视内存使用情况或用于获取有关堆栈帧、对象等的运行时信息时,远程分析并不是一个限制。
-
CLR 代码探查器必须向运行所分析应用程序的本地计算机上的运行时注册一个或多个回调接口。 这便限制了创建远程代码探查器的功能。
-
-
在具有高可用性要求的生产环境中进行分析。 为了支持开发时诊断,已经创建了分析 API。 但尚未进行支持生产环境所需的严格测试。
通知线程
在大多数情况下,生成事件的线程也会执行通知。 此类通知 (例如, FunctionEnter并FunctionLeave) 无需提供显式ThreadID。 此外,探查器还可能决定使用线程本地存储来存储和更新其分析块,而不是基于受影响线程的 ThreadID 对全局存储中的分析块建立索引。
注意,这些回调未经过序列化。 用户必须通过创建线程安全数据结构并在必要时锁定探查器代码以防止从多个线程并行访问的方式保护代码。 因此,在某些情况下,会收到不正常的回调序列。 例如,假设托管应用程序正在生成执行相同代码的两个线程。 在这种情况下,就可以接收icorprofilercallback:: Jitcompilationstarted执行某项功能从一个线程的事件和一个FunctionEnter从另一个线程才收到回调Icorprofilercallback:: Jitcompilationfinished回调。 在这种情况下,用户将收到可能尚未完全实时 (JIT) 编译的函数的 FunctionEnter 回调。
安全性
探查器 DLL 是作为公共语言运行时执行引擎的一部分运行的非托管 DLL。 因此,探查器 DLL 中的代码并不受到托管代码访问安全性的约束。 探查器 DLL 的唯一限制是操作系统强加在运行所分析应用程序的用户身上的限制。
探查器作者应采取适当的预防措施以避免安全相关问题。 例如,在安装期间,应将探查器 DLL 添加到访问控制列表 (ACL),以确保恶意用户无法对其进行修改。
在代码探查器中组合托管和非托管代码
编写错误的探查器可能会引起自身的循环引用,从而导致不可预知的行为。
审查 CLR 分析 API 可能会形成这样的印象:可以编写包含托管和非托管组件的探查器,在探查器中这些组件通过 COM 互操作或间接调用相互调用。
虽然从设计角度而言这是可行的,但分析 API 并不支持托管组件。 CLR 探查器必须完全处于非托管状态。 尝试在 CLR 探查器中组合托管和非托管代码可能会导致访问冲突、程序故障或死锁。 探查器的托管组件将激发事件返回其非托管组件,随后将再次调用托管组件,从而导致循环引用。
CLR 探查器可以安全调用托管代码的唯一位置是方法的 Microsoft 中间语言 (MSIL) 体。 修改 MSIL 体的建议的做法是使用 JIT 重新编译方法中的ICorProfilerCallback4接口。
还可以使用较早的检测方法修改 MSIL。 探查器实时 (JIT) 编译的函数完成之前,可以在方法,然后 JIT 编译的 MSIL 体中插入托管的调用它 (请参阅icorprofilerinfo:: Getilfunctionbody方法)。 这种技术可成功用于托管代码的选择性检测,也可用于收集有关 JIT 的统计信息和性能数据。
代码探查器也可以在调用到非托管代码的每个托管函数的 MSIL 体中插入本机挂钩。 这种技术可用于检测和覆盖。 例如,代码探查器可以在每个 MSIL 块后插入检测挂钩,以确保该块已执行。 修改方法的 MSIL 体是一项非常细致的操作,因此必须将许多因素考虑在内。
分析非托管代码
公共语言运行时 (CLR) 分析 API 为分析非托管代码提供最低支持。 它具有以下功能:
-
堆栈链的枚举。 借助此功能,代码探查器能够确定托管代码与非托管代码之间的边界。
-
确定堆栈链是否与托管代码或本机代码对应。
在 .NET Framework 1.0 和 1.1 版中,可通过 CLR 调试 API 的进程内子集使用这些方法。 它们在 CorDebug.idl 文件中定义。
在.NET Framework 2.0 及更高版本,可以使用ICorProfilerInfo2::DoStackSnapshot方法实现此功能。
使用 COM
尽管将分析接口定义为 COM 接口,但公共语言运行时 (CLR) 并不会实际初始化 COM 以使用这些接口。 原因是为了避免使用设置线程模型CoInitialize函数之前托管应用程序有机会指定其所需的线程模型。 同样,探查器本身不应调用 CoInitialize,因为它可能会选取与所分析应用程序不兼容的线程模型,并可能会导致应用程序失败。
调用堆栈
分析 API 提供两种方法来获取调用堆栈:堆栈快照方法和阴影堆栈方法,前者以分散方式收集调用堆栈,后者时刻跟踪调用堆栈。
堆栈快照
堆栈快照是线程堆栈在某一时刻的跟踪。 分析 API 支持在堆栈上跟踪托管函数,但它会将跟踪非托管函数的工作交给探查器自己的堆栈审核器来完成。
有关如何对探查器以审核托管的堆栈的详细信息,请参阅ICorProfilerInfo2::DoStackSnapshot此文档集中的方法和.NET Framework 2.0 中的 Profiler 堆栈审核:基础和超越。
阴影堆栈
过度频繁使用快照方法很快就会产生性能问题。 如果你想要经常执行的堆栈跟踪,探查器而是应使用生成阴影堆栈FunctionEnter2, FunctionLeave2, FunctionTailcall2,并ICorProfilerCallback2异常回调。 阴影堆栈始终是最新的,并且在需要堆栈快照时可以快速复制到存储区。
阴影堆栈可以获取函数自变量、返回值和有关泛型实例化的信息。 泛型实例化信息只能通过阴影堆栈获取,并可能在将控件传递到函数时获取。 然而,后续运行此函数时,此信息可能不可用。
回调和堆栈深度
在堆栈受到严重限制的情况下,可能会引发探查器回调;并且探查器回调中的堆栈溢出将导致进程立即退出。 探查器应确保尽可能少使用堆栈来响应回调。 如果希望将探查器用于抑制堆栈溢出的可靠进程中,那么探查器本身也应避免触发堆栈溢出。
相关主题
| Title | 描述 |
|---|---|
| 设置分析环境 | 说明如何初始化探查器、设置事件通知和分析 Windows 服务。 |
| Profiling 接口 | 描述分析 API 使用的非托管接口。 |
| 分析全局静态函数 | 描述分析 API 使用的非托管全局静态函数。 |
| 分析枚举 | 描述分析 API 使用的非托管枚举。 |
| 分析结构 | 描述分析 API 使用的非托管结构。 |
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 mairaw)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
