Intel® VTune™ Profiler

Install Intel® VTune™ Profiler

ID 767438
Date 3/31/2024
Public

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

Install on Windows* OS

Install Intel® VTune™ Profiler on a Windows system, either as a standalone application or as a component in the Intel® oneAPI Base Toolkit.

Before you Begin

Check Requirements:

  • Your host machine should use a 64-bit operating system. Once you install VTune Profiler, you can use the application to profile 32-bit and 64-bit applications.

  • Ensure that you are using supported versions of Windows and compilers. Check System Requirements.

Get Administrative Privileges

Administrative privileges are necessary for proper installation of the Sampling Drivers that are required for many analysis types in VTune Profiler. Having administrative privileges also makes it easier to install, change, or uninstall VTune Profiler.

Download VTune Profiler

Download Intel® VTune™ Profiler for Windows OS as:

Install VTune Profiler as a Standalone Application

On the download page for VTune Profiler,

  1. Select between an Online or an Offline installer. An offline installer is better suited for systems without a stable internet connection.

  2. Once the download completes, run the installer executable with Administrative privileges.

  3. Select your preferred mode for the installation.

    • In the Recommended Installation mode, VTune Profiler installs in the default directory and integrates into your Microsoft Visual Studio* IDE.

    • In the Custom Installation mode, you can control these settings:

      • Install directory: Specify a custom install directory. The default location is <Program Files (x86)>\Intel\oneAPI\vtune\
      • Microsoft Visual Studio* IDE integration: Choose a version of Microsoft Visual Studio for integration, if necessary.
  4. Follow subsequent steps in the installer to complete the installation.

Install VTune Profiler as a Component in the Intel® oneAPI Base Toolkit

On the download page for Intel® oneAPI Base Toolkit:

  1. Select between an Online or an Offline installer. An offline installer is better suited for systems without a stable internet connection.

  2. Once the download completes, run the installer executable with Administrative privileges.

  3. Select your preferred mode for the installation.

    • Choosing the Recommended Installation mode installs all components of the Intel® oneAPI Base Toolkit in the default directory. Appropriate components are then integrated into your Microsoft Visual Studio* IDE.

    • In the Custom Installation mode, you can control these settings:

      • Components to install: Choose the toolkit components you want to install. The installer first checks for components that are already installed on your system (if any). You have the option to update or skip those components.
      • Install directory: Specify a custom install directory. The default location is <Program Files (x86)>\Intel\oneAPI\
      • Microsoft Visual Studio* IDE integration: Choose a version of Microsoft Visual Studio for integration, if necessary.

  4. Follow subsequent steps in the installer to complete the installation.

After you Install VTune Profiler

Set Environment Variables:

To use the command line interface of VTune Profiler, set environment variables first. Run the vars.bat script:

C:\"Program Files (x86)"\Intel\oneAPI\vtune\latest\env\vars.bat
Verify the Sampling Drivers:

The installation of VTune Profiler on your Windows system should also install the sampling drivers necessary for data collection in most analysis types. However, it is always good practice to verify this:

  1. Open the command prompt as an administrator.
  2. Go to the bin64 folder in your installation directory.
  3. Check to make sure your system meets the requirements for hardware event-based sampling (HEBS) collection. Run this command:
    amplxe-sepreg.exe -c
  4. Check if the sampling drivers are loaded. Run:
    amplxe-sepreg.exe -s
  5. If your system meets the requirements for HEBS collection and the sampling drivers are not installed, run this command to install the drivers with administrative privileges:
    amplxe-sepreg.exe -i

For more information on installing the sampling drivers on a Windows system, see here.

Verify Your Installation:

To verify if you installed VTune Profiler correctly or troubleshoot issues with the installation, use the self-check script (vtune-self-checker.bat) available in the package. This script runs a set of analyses on a sample application, and reports the progress interactively.

  1. Set environment variables.

  2. Verify/Install the sampling drivers.

  3. Open a terminal window.

  4. Go to this location: <Program Files (x86)>\Intel\oneAPI\vtune\latest\bin64

  5. Run the vtune-self-checker.bat script:

    vtune-self-checker.bat

    The self-check script may take several minutes to run all necessary checks.

  6. Once the script completes all checks, review the summary. Check if any analyses failed, and see the log file for additional information.

Prepare Remote Targets (Optional):

When you install VTune Profiler on a Windows platform, you can use it to profile and collect data remotely from non-Windows targets, such as Linux* machines. For more information, see Set Up Analysis Target.

Learn More