Walkthrough: Using profiler APIs

Artikkeli
11/04/2016

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

The walkthrough uses a C# application to demonstrate how to use the Visual Studio Profiling Tools APIs. You will use the profiler APIs to limit the amount of data that is collected during instrumentation profiling.

The steps in this walkthrough generally apply to a C/C++ application. For each language, you will have to configure your build environment appropriately.

Typically, you will start to analyze application performance by using sample profiling. If sample profiling does not provide information that pinpoints a bottleneck, instrumentation profiling can provide a greater level of detail. Instrumentation profiling is very useful for investigating thread interaction.

However, a greater level of detail means that more data is collected. You might find that instrumentation profiling creates large data files. Also, instrumentation is more likely to impact the performance of the application. For more information, see Understand instrumentation data values and Understand sampling data values

The Visual Studio profiler allows you to limit the collection of data. This walkthrough offers an example of how to limit the collection of data by using the profiler APIs. The Visual Studio profiler provides an API for controlling data collection from within an application.

For native code, the Visual Studio profiler APIs are in VSPerf.dll. The header file, VSPerf.h, and the import library, VSPerf.lib, are located in the Microsoft Visual Studio\2017\Team Tools\Performance Tools\PerfSDK directory. For 64-bit apps, the folder is Microsoft Visual Studio\2017\Team Tools\Performance Tools\x64\PerfSDK

For managed code, the profiler APIs are in the Microsoft.VisualStudio.Profiler.dll. This DLL is found in the Microsoft Visual Studio\Shared\Common\VSPerfCollectionTools directory. For 64-bit apps, the folder is Microsoft Visual Studio\Shared\Common\VSPerfCollectionTools\x64. For more information, see Profiler.

Prerequisites

This walkthrough assumes your choice of development environment is configured to support debugging and sampling. The following topics provide an overview of these prerequisites:

By default, when the profiler is started, the profiler collects data at the global level. The following code at the start of the program turns global profiling off.

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

You can turn off data collection at the command line without using an API call. The following steps assume your command line build environment is configured to run the profiling tools and as your development tools. This includes the settings necessary for VSInstr and VSPerfCmd. See Command-line profiling tools.

Limit data collection using profiler APIs

To create the code to profile

Create a new C# project in Visual Studio, or use a command line build, depending on your preference.

Note

Your build must reference the Microsoft.VisualStudio.Profiler.dll library, located in the Microsoft Visual Studio\Shared\Common\VSPerfCollectionTools directory.

Copy and paste the following code into your project:

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.VisualStudio.Profiler;

namespace ConsoleApplication1
{
    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 = new A(2);
                Console.WriteLine("2 square is {0}", a.DoNotProfileThis());

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

                int x;
                x = a.OnlyProfileThis();

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

                Console.WriteLine("2 doubled is {0}", x);
            }
        }

    }
}

To collect and view data in the Visual Studio IDE

Open the Visual Studio IDE. On to the Analyze menu, point to Profiler, and then select New Performance Session.
Add your compiled binary to the Targets list in the Performance Explorer window. Right-click Targets, and then select Add Target Binary. Locate the binary in the Add Target Binary dialog box, and then click Open.
Select Instrumentation from the Method list on the Performance Explorer toolbar.
Click Launch with Profiling.

The profiler will instrument and execute the binary and create a performance report file. The performance report file will appear in the Reports node of the Performance Explorer.
Open the resulting performance report file.

By default, when the profiler is started, the profiler will collect data at the global level. The following code at the start of the program turns global profiling off.

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

To collect and view data at the command line

Compile a debug version of the sample code you created in the "Creating Code to Profile" procedure, earlier in this walkthrough.
To profile a managed application, type the following command to set the appropriate environment variables:

VsPerfCLREnv /traceon
Type the following command: VSInstr <filename>.exe
Type the following command: VSPerfCmd /start:trace /output:<filename>.vsp
Type the following command: VSPerfCmd /globaloff
Execute your program.
Type the following command: VSPerfCmd /shutdown
Type the following command: VSPerfReport /calltrace:<filename>.vsp

A .csv file is created in the current directory with the resulting performance data.

Jaa