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 with Package Managers

On Linux* OS, you can install Intel® VTune™ Profiler using the APT, YUM, DNF, or Zypper package managers.

Prerequisites

  • Review the list of supported operating systems in the System Requirements.
  • If you haven't installed Intel® oneAPI software products using package managers before, configure your package manager to work with the repository following the instructions.

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

APT

Add the Intel oneAPI Repository

If you haven't installed Intel® oneAPI Toolkits or components before, it is necessary to configure your package managers to use Intel repositories. Follow these steps:

  1. (Optional) Switch to any directory with write access. We use /tmp in this example:
    cd /tmp
  2. Use wget to download the Intel repository public key:
    wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
  3. Add the key to your apt keyring:
    sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
  4. (Optional) Remove the public key file, as it is no longer needed:
    rm GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
  5. Configure the APT client to use the Intel repository:
    echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list

    Or, if the add-apt-repository utility is installed, you can use the following command:

    sudo add-apt-repository "deb https://apt.repos.intel.com/oneapi all main"

Install the VTune Profiler Package

  1. Update the APT package lists:
    sudo apt update
  2. Install the VTune Profiler standalone package:
    sudo apt install intel-oneapi-vtune

YUM

Add the Intel oneAPI Repository

If you haven't installed Intel® oneAPI Toolkits or components before, it is necessary to configure your package managers to use Intel repositories. Follow these steps:

  1. Create a YUM/DNF .repo file in a directory with write access, such as /tmp:
    tee > /tmp/oneAPI.repo << EOF
    [oneAPI]
    name=Intel® oneAPI repository
    baseurl=https://yum.repos.intel.com/oneapi
    enabled=1
    gpgcheck=1
    repo_gpgcheck=1
    gpgkey=https://yum.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
    EOF
  2. Move the newly created oneAPI.repo file to the YUM/DNF configuration directory /etc/yum.repos.d:
    sudo mv /tmp/oneAPI.repo /etc/yum.repos.d

Install the VTune Profiler Package

sudo yum install intel-oneapi-vtune

DNF

Add the Intel oneAPI Repository

If you haven't installed Intel® oneAPI Toolkits or components before, it is necessary to configure your package managers to use Intel repositories. Follow these steps:

  1. Create a YUM/DNF .repo file in a directory with write access, such as /tmp:
    tee > /tmp/oneAPI.repo << EOF
    [oneAPI]
    name=Intel® oneAPI repository
    baseurl=https://yum.repos.intel.com/oneapi
    enabled=1
    gpgcheck=1
    repo_gpgcheck=1
    gpgkey=https://yum.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
    EOF
  2. Move the newly created oneAPI.repo file to the YUM/DNF configuration directory /etc/yum.repos.d:
    sudo mv /tmp/oneAPI.repo /etc/yum.repos.d

Install the VTune Profiler Package

sudo dnf install intel-oneapi-vtune

Zypper

Add the Intel oneAPI Repository

If you haven't installed Intel oneAPI Toolkits or components before, it is necessary to configure your package managers to use Intel repositories.

Run this command to add the Intel repository key:

sudo zypper addrepo https://yum.repos.intel.com/oneapi oneAPI

Install the VTune Profiler Package

sudo zypper install intel-oneapi-vtune

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 these scripts:

    bash:

    source /opt/intel/oneapi/vtune/latest/env/vars.sh

    csh/tcsh:

    source /opt/intel/oneapi/vtune/latest/env/vars.csh
  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.sh

      Alternatively, you can find this script in: /opt/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.
  4. (Optional) Configure Collection Without Sampling Driver:

    If you installed VTune Profiler without superuser privileges, certain configuration steps are required to enable hardware analyses through Linux Perf*. See the Profiling Hardware Without Intel Sampling Drivers Cookbook recipe to understand the configuration and possible limitations.