User Guide

Contents

Set Up System for GPU Analysis

To analyze Intel HD and Intel Iris Graphics (further: Intel Graphics) hardware events on a GPU,
  • Your system must have the Intel Metric Discovery (MD) API library installed on it.
  • You need relevant permissions.

Install Intel Metric Discovery API Library on Windows* OS

On Windows, Intel Metric Discovery API library is part of the official Intel Graphics driver package. You can install a driver for your system from https://downloadcenter.intel.com.
If you run GPU analysis via a Remote Desktop connection, make sure your software fits these requirements:
  • VTune Amplifier 2015 Update 2, or higher
  • Intel® Graphics driver version 15.36.14.64.4080, or higher
  • target analysis application runnable via RDC

Install Intel Metrics Discovery API Library on Linux* OS

Intel Metrics Discovery API library is supported on Linux operating systems with kernel version 4.14 or newer. If
VTune
Profiler
cannot collect GPU hardware metrics and provides a corresponding error message, make sure you have installed the API library correctly.
You can download Intel Metrics Discovery API library from https://github.com/intel/metrics-discovery.

Enable Permissions

Typically, you should run the GPU Offload and GPU Compute/Media Hotspots analyses with root privileges on Linux or as an Administrator on Windows.
If you lack root permissions on Linux, enable collecting GPU hardware metrics for non-privileged users. Follow these steps:
  • Add your username to the
    video
    group.
    To check whether your username is part of the
    video
    group, enter:
    groups | grep video
    .
    To add your username to the
    video
    group, enter:
    sudo usermod -a -G video <
    username
    >
    .
  • Set the value of
    dev.i915.perf_stream_paranoid
    sysctl
    option to 0 as follows:
    sysctl -w dev.i915.perf_stream_paranoid=0
    This command makes a temporary change that is lost after reboot. To make a permanent change, enter:
    echo dev.i915.perf_stream_paranoid=0 > /etc/sysctl.d/60-mdapi.conf
  • Since GPU analysis relies on the Ftrace* technology, use the script that sets read/write permissions to debugFS.

Enable GPU utilization events (i915 ftrace events)

To analyze detailed GPU utilization on Linux, you may need to rebuild the kernel. Because the i915 driver has to provide low-level tracing events, for kernels 4.14 and newer, enable tracing events using these kernel configuration options:
CONFIG_EXPERT=y
CONFIG_DRM_I915_LOW_LEVEL_TRACEPOINTS=y
To check the current state of the
CONFIG_DRM_I915_LOW_LEVEL_TRACEPOINTS
option, enter:
grep CONFIG_DRM_I915_LOW_LEVEL_TRACEPOINTS /boot/config-$(uname -r)
If the option is disabled, you need to rebuild the i915 driver or the whole kernel.
Use the
./install/bin64/prepare-gpu-hardware-metrics.sh
script to automatically enable permissions for non-privileged users.
The kernel rebuild is only required for detailed metrics on GPU utilization. For high level GPU utilization information, you do not need to reconfigure the kernel.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804