演练:使用探查器 API

更新:2007 年 11 月

本演练使用 C# 应用程序来演示如何使用 Visual Studio Team System Developer Edition 分析工具 API。您将使用探查器 API 来限制在检测分析期间收集的数据量。

本演练中的步骤通常适用于 C/C++ 应用程序。对于每种语言,都需要配置适当的生成环境。

应用程序性能分析通常是从使用取样分析开始的。如果取样分析没有提供可查明瓶颈的信息,检测分析可以提供更为详细的信息。检测分析对于调查线程交互非常有用。

但是,更为详细的信息也意味着会收集更多的数据。您可能发现检测分析会创建大型数据文件。此外,检测更有可能影响应用程序的性能。有关更多信息,请参见 了解检测数据值了解采样数据值

通过 Visual Studio 探查器,可以限制数据收集。本演练提供一个示例,说明如何使用探查器 API 来限制数据收集。Visual Studio 探查器提供了一个 API,用于从应用程序内部控制数据收集。

对于本机代码,Visual Studio 探查器 API 位于 VSPerf.dll 中。头文件 VSPerf.h 和导入库 VSPerf.lib 位于 Microsoft Visual Studio 9\Team Tools\Performance Tools 目录中。

对于托管代码,探查器 API 位于 Microsoft.VisualStudio.Profiler.dll 中。此 DLL 位于 Microsoft Visual Studio 9\Team Tools\Performance Tools 目录中。有关更多信息,请参见 Microsoft.VisualStudio.Profiler

先决条件

本演练假定您选择的开发环境配置为支持调试和取样。下面的主题概要介绍这些系统必备:

如何:选择收集方法

如何:引用 Windows 符号信息

默认情况下,当探查器启动时,探查器在全局级收集数据。下面的代码位于程序开头,其功能是禁用全局分析。

        DataCollection.StopProfile(
        ProfileLevel.Global,
        DataCollection.CurrentId);

即使不使用 API 调用,也可以在命令行关闭数据收集。下面的步骤假定命令行生成环境配置为开发工具,并运行分析工具。这包括 VSInstr 和 VSPerfCmd 所需的设置。请参见命令行分析工具。

使用探查器 API 限制数据收集

创建要分析的代码

  1. 在 Visual Studio 中创建一个新的 C# 项目,或使用命令行生成,具体取决于您的选择。

    说明:

    您的生成必须引用 Microsoft.VisualStudio.Profiler.dll 库,该库位于 Microsoft Visual Studio 9\Team Tools\Performance Tools 目录中。

  2. 将以下代码复制并粘贴到项目中:

    using System;
    using System.Collections.Generic;
    using System.Text;
    using Microsoft.VisualStudio.Profiler;
    
    namespace ConsoleApplication2
    {
        class Program
        {
            public class A
            {
             private int _x;
    
             public A(int x)
             {
              _x = x;
             }
    
             public int DoNotProfileThis()
             {
              return _x * _x;
             }
    
             public int OnlyProfileThis()
             {
              return _x + _x;
             }
    
             public static void Main()
             {
            DataCollection.StopProfile(
            ProfileLevel.Global,
            DataCollection.CurrentId);
              A a;
              a = new A(2);
              int x;    
              Console.WriteLine("2 square is {0}", a.DoNotProfileThis());
              DataCollection.StartProfile(
                  ProfileLevel.Global,
                  DataCollection.CurrentId);
              x = a.OnlyProfileThis();
              DataCollection.StopProfile(
                  ProfileLevel.Global, 
                  DataCollection.CurrentId);
              Console.WriteLine("2 doubled is {0}", x);
             }
            }
    
        }
    }
    

在 Visual Studio IDE 中收集和查看数据

  1. 打开 Visual Studio IDE。在“分析”菜单上指向“探查器”,然后选择“新建性能会话”。

  2. 将编译的二进制文件添加到“性能资源管理器”窗口中的“目标”列表中。右击“目标”,然后选择“添加目标二进制文件”。在“添加目标二进制文件”对话框中找到二进制文件,然后单击“打开”。

  3. 从“性能资源管理器”工具栏上的“方法”列表中选择“检测”。

  4. 单击“启动并启用分析功能”。

    探查器将检测和执行该二进制文件,并创建一个性能报告文件。性能报告文件将显示在“性能资源管理器”的“报告”节点中。

  5. 打开生成的性能报告文件。

默认情况下,当探查器启动时,探查器将在全局级收集数据。下面的代码位于程序开头,其功能是禁用全局分析。

        DataCollection.StopProfile(
        ProfileLevel.Global,
        DataCollection.CurrentId);

在命令行收集和查看数据

  1. 编译在“创建要分析的代码”过程(本演练前面部分)中创建的示例代码的调试版本。

  2. 若要探查托管应用程序,请键入以下命令来设置适当的环境变量:

    VsPefCLREnv /traceon

  3. 键入下面的命令:“VSInstr <文件名>.exe”

  4. 键入下面的命令:“VSPerfCmd /start:trace /output:<文件名>.vsp”

  5. 键入下面的命令:“VSPerfCmd /globaloff”

  6. 执行程序。

  7. 键入下面的命令:“VSPerfCmd /shutdown”

  8. 键入下面的命令:“VSPerfReport /calltrace:<文件名>.vsp”

    当前目录中即会创建一个 .csv 文件,该文件包含得到的性能数据。

请参见

参考

Microsoft.VisualStudio.Profiler

其他资源

Visual Studio 探查器 API 参考(本机)

分析工具入门

命令行分析工具