Intel® VTune™ Profiler Installation Guide

ID 767438
Date 12/16/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Install on Windows* OS

On Windows* OS, Intel® VTune™ Profiler is available as:

Once installed, it is recommended that you review the post-installation steps.

Prerequisites

Supported Systems

See the System Requirements for a list of supported Windows versions and compilers.

NOTE:

A 64-bit operating system host is required to use VTune Profiler. You can use VTune Profiler to analyze both 32-bit and 64-bit applications.

Administrative Privileges

Administrative privileges are recommended to install, change, or uninstall VTune Profiler. Administrative privileges are necessary to correctly install the Sampling Driver that is required for many analysis types. You can install VTune Profiler without Administrative privileges, but not all capabilities will be available.

Install as Standalone Component

To install VTune Profiler as standalone component:

  1. Download the standalone Windows installer from the VTune Profiler download page.

    You can select between an Online or an Offline installer. On systems without a stable Internet connection, it is recommended to use the Offline installer.

  2. Run the installer executable with Administrative privileges.
  3. Select between a Recommended and a Custom installation.

    The Recommended Installation option installs VTune Profiler in the default directory and integrates VTune Profiler into your Microsoft Visual Studio* IDE.

    The Custom Installation allows you to control:

    • Install directory: specify a custom install directory. Default is <Program Files>\Intel\oneAPI\vtune\
    • Microsoft Visual Studio* IDE integration: choose a version of Visual Studio to integrate VTune Profiler into, or opt out of integration.
  4. Follow the instructions in the installer to complete the install process.

Install as Part of Intel® oneAPI Base Toolkit

To install VTune Profiler as part of an Intel® oneAPI Base Toolkit:

  1. Download the Intel® oneAPI Base Toolkit installer for Windows.

    You can select between an Online or an Offline installer. On systems without a stable Internet connection, it is recommended to use the Offline installer.

  2. Run the installer executable with Administrative privileges.
  3. Select between a Recommended and a Custom installation.

    The Recommended Installation installs all components included in this toolkit in the default directory, and integrates appropriate components into your Microsoft Visual Studio IDE.

    The Custom Installation allows you to control:

    • Components to install: select specific toolkit components to install.
      NOTE:
      The installer checks for components that are already installed on the system, and offers to update or skip these components, if appropriate.
    • Install directory: specify a custom install directory. Default is <Program Files>\Intel\oneAPI\
    • Microsoft Visual Studio* integration: choose a version of Visual Studio to integrate VTune Profiler into, or opt out of integration.
  4. Follow the instructions in the installer to complete the install process.

Post-Installation Steps

  1. Set Environment Variables:

    If you are planning to use the command line interface of VTune Profiler, it is recommended to set environment variables by running the script:

    C:\"Program Files (x86)"\Intel\oneAPI\vtune\latest\env\vars.bat
  2. Verify Your Installation:

    VTune Profiler comes with a self-check script that helps verify if the product is installed correctly and troubleshoot issues, if any.

    The script runs a set of analyses on a sample application, and reports the progress interactively.

    To run the self-check script:

    1. Open a terminal window.
    2. Assuming the environment variables are set, run the script with this command:
      vtune-self-checker.bat

      Alternatively, you can find this script in: <Program Files>\Intel\oneAPI\vtune\latest\bin64

      NOTE:
      The script may take several minutes run all the necessary checks.
    3. Let the script run to completion and review the summary. The script offers advice if any of the analyses have failed, and saves a log file for support.
  3. Get to Know VTune Profiler:

    For a quick introduction to VTune Profiler, try these documents:

    General information on VTune Profiler is available from:

    • User Guide—all features and analysis types, workflows, command line interface, user interface.
    • Performance Analysis Cookbook—profiling methodology, examples of applying VTune Profiler to interesting cases and specific bottlenecks.