Intel® VTune™ Amplifier

Getting Started with Intel® VTune™ Amplifier

Explore the key features provided with the VTune Amplifier across different platforms.

Note

Instructions provided below for the Linux* host are also applicable to the VTune Amplifier for macOS* host but for remote analysis targets only. Local target analysis on macOS is not supported. By default, the VTune Amplifier for macOS is installed at /Applications/Intel VTune Amplifier 2018.app.

Get Started with the VTune Amplifier on Linux* or macOS*

Prerequisites

Step 1: Start the VTune Amplifier

Select the appropriate product or use the instructions for the standalone version of VTune Amplifier to set appropriate environment variables and launch the tool.

Standalone VTune Amplifier, Installed with Intel Parallel Studio, or Installed with Intel Media Studio

  1. Set up the environment variables:

    • csh/tcsh users: source <install_dir>/amplxe-vars.csh

    • bash users: source <install_dir>/amplxe-vars.sh

    By default, the <install_dir> is:

    • For root users: /opt/intel/vtune_amplifier_2018

    • For non-root users: $HOME/intel/vtune_amplifier_2018

  2. Launch the VTune Amplifier:

    • For standalone GUI interface, run the amplxe-gui command.

    • For command line interface, run the amplxe-cl command.

Installed with Intel System Studio

From within the Intel System Studio IDE, select Intel System Studio > VTune Amplifier > Launch VTune Amplifier. Launching from within Intel System Studio sets all appropriate environment variables before opening the tool.

Step 2: Set Up the Analysis Target

  1. Build your target application in the Release mode with all optimizations enabled.

  2. Create a VTune Amplifier project:

    1. Click the menu button in the right corner and go to New > Project... .

    2. Specify the project name and location in the Create Project dialog box.

    3. Click Create Project.

  3. In the Analysis Target tab, select a target system and an analysis target type.

  4. Configure your target: application location, parameters, and search directories (if required).

Step 3: Configure Analysis

  1. Switch to the Analysis Type tab.

  2. From the left pane, select an analysis type applicable to your platform and configure analysis options in the right pane.

    Tip

    Use the Find Your Analysis guide, available from the VTune Amplifier Welcome screen, for help picking your starting point for analysis based on your use case.

  3. Click the Start button on the right to launch the analysis.

Step 4: View and Analyze Performance Data

When data collection completes, the VTune Amplifier opens the result in the default viewpoint, which is a preset configuration of windows for an analysis result. You may switch between different viewpoint to analyze the data from different perspectives using different sets of performance metrics.

Start your analysis with the Summary window to get an overview of the application performance and then switch to other windows to explore the performance deeper at the granularity of function, source line and so on.

Get Started with the VTune Amplifier on Windows*

Prerequisites

Step 1: Start the VTune Amplifier

Select the appropriate product or use the instructions for the standalone version of VTune Amplifier to set appropriate environment variables and launch the tool.

Standalone VTune Amplifier

  1. Set up the environment variables with the amplxe-vars batch file. For example, if you installed the VTune Amplifier using the default directory, type: C:\[Program Files]\IntelSWTools\VTune Amplifier 2018\amplxe-vars.bat.

    Batch file displays the product name and the build number.

  2. Launch the VTune Amplifier:

    • For standalone GUI interface, open from the Start menu.

    • For command line interface, run the amplxe-cl command.

For the VTune Amplifier integrated into Microsoft Visual Studio* IDE, open your solution in Visual Studio. The VTune Amplifier toolbar is automatically enabled and your Visual Studio project is set as an analysis target.

Installed with Intel Parallel Studio

  1. Set up the environment variables with the amplxe-vars batch file. For example, if you installed the VTune Amplifier using the default directory, type: C:\[Program Files]\IntelSWTools\VTune Amplifier 2018\amplxe-vars.bat.

    Batch file displays the product name and the build number.

  2. Launch the VTune Amplifier:

    • For standalone GUI interface, open from the Start menu by selecting one of the following:

      • On Windows 7: Intel Parallel Studio XE 2018 > Analyzers > VTune Amplifier 2018

      • On Windows 8 and later: Intel Parallel Studio XE 2018 > VTune Amplifier 2018

    • For command line interface, run the amplxe-cl command.

For the VTune Amplifier integrated into Microsoft Visual Studio* IDE, open your solution in Visual Studio. The VTune Amplifier toolbar is automatically enabled and your Visual Studio project is set as an analysis target.

Installed with Intel System Studio

  • Linux* or Android* Targets: From within the Intel System Studio IDE, select Intel System Studio > VTune Amplifier > Launch VTune Amplifier. Launching from within Intel System Studio sets all appropriate environment variables before opening the tool.

  • Windows* Targets:

    1. Set up the environment variables with the amplxe-vars batch file. For example, if you installed the VTune Amplifier using the default directory, type: C:\[Program Files]\IntelSWTools\VTune Amplifier 2018\amplxe-vars.bat.

      Batch file displays the product name and the build number.

    2. Launch the VTune Amplifier:

      • For standalone GUI interface, open from the Start menu by selecting one of the following:

        • On Windows 7: Intel System Studio 2018 for Windows Target> Analyzers > VTune Amplifier 2018

        • On Windows 8 and later: Intel System Studio 2018 for Windows Target> VTune Amplifier 2018

      • For command line interface, run the amplxe-cl command.

Installed with Intel Media Studio

  1. Set up the environment variables with the amplxe-vars batch file. For example, if you installed the VTune Amplifier using the default directory, type: C:\[Program Files]\IntelSWTools\VTune Amplifier 2018\amplxe-vars.bat.

    Batch file displays the product name and the build number.

  2. Launch the VTune Amplifier:

    • For standalone GUI interface, open from the Start menu by selecting one of the following:

      • On Windows 7: Intel Media Studio 2018 > Analyzers > Intel VTune Amplifier 2018

      • On Windows 8 and later: Intel Media Studio 2018 > Intel VTune Amplifier 2018

    • For command line interface, run the amplxe-cl command.

Step 2: Set Up the Analysis Target

  1. Configure Microsoft Symbol Server and build your target application in the Release mode with all optimizations enabled.

  2. Create a VTune Amplifier project (standalone version only):
    1. Click the menu button in the right corner and go to New > Project... .

    2. Specify the project name and location in the Create Project dialog box.

  3. In the Analysis Target tab, select a target system and an analysis target type.

  4. Сonfigure your target: application location, parameters and search directories (if required).

In Visual Studio version, VTune Amplifier inherits the Visual Studio settings and uses the application generated for the selected project as your analysis target.

Step 3: Configure Analysis

  1. Switch to the Analysis Type tab.

  2. From the left pane, select an analysis type applicable to your platform and configure analysis options in the right pane.

    Tip

    Use the Find Your Analysis guide, available from the VTune Amplifier Welcome screen, for help picking your starting point for analysis based on your use case.

  3. Click the Start button on the right to launch the analysis.

Step 4: View and Analyze Performance Data

When data collection completes, the VTune Amplifier opens the result in the default viewpoint, which is a preset configuration of windows for an analysis result. You may switch between different viewpoints to analyze the data from different perspectives using different sets of performance metrics.

Start your analysis with the Summary window to get an overview of the application performance and then switch to other windows to explore the performance deeper at the granularity of function, source line and so on.

See Also