User Guide

Intel® VTune™ Profiler User Guide

Download PDF
ID 766319
Date 7/13/2023
Public

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

Document Table of Contents
Document Table of Contents x
Intel® VTune™ Profiler User Guide
Intel® VTune™ Profiler User Guide x
Introduction Install Intel® VTune™ Profiler Open Intel® VTune™ Profiler Set Up Project Set Up Analysis Target Analyze Performance Intel® VTune™ Profiler Command Line Interface API Support Troubleshooting Reference Notices and Disclaimers
Introduction x
Tuning Methodology Tutorials and Samples Notational Conventions Get Help Product Website and Support Related Information
Install Intel® VTune™ Profiler x
Sampling Drivers Set Up System for GPU Analysis Verify Intel® VTune™ Profiler Installation Install VTune Profiler Server Security Best Practices
Set Up System for GPU Analysis x
Rebuild and Install the Kernel for GPU Analysis Rebuild and Install Module i915 for GPU Analysis on CentOS* Rebuild and Install Module i915 for GPU Analysis on Ubuntu*
Install VTune Profiler Server x
Set Up Transport Security Configure User Authentication/Authorization
Open Intel® VTune™ Profiler x
Get Started with Intel® VTune™ Profiler Intel® VTune™ Profiler Graphical User Interface Web Server Interface Microsoft Visual Studio* Integration Eclipse* and Intel System Studio IDE Integration Containerization Support macOS* Support
Containerization Support x
Run VTune Profiler in a Container Profile Container Targets from the Host
Set Up Project x
WHERE: Analysis System WHAT: Analysis Target HOW: Analysis Types Search Directories
WHERE: Analysis System x
Analysis System Options
WHAT: Analysis Target x
Analysis Target Options
Search Directories x
Search Order
Set Up Analysis Target x
Prepare Application for Analysis Windows* Targets Linux* Targets Embedded Linux* Targets FreeBSD* Targets QNX* Targets Managed Code Targets Android* Targets Intel® Xeon Phi™ Processor Targets Targets in Virtualized Environments Targets in a Cloud Environment Arbitrary Targets Embedded System Targets
Windows* Targets x
Install the Sampling Drivers for Windows* Targets Debug Information for Windows* Application Binaries Compiler Switches for Performance Analysis on Windows* Targets Debug Information for Windows* System Libraries Add Administrative Privileges
Linux* Targets x
Build and Install the Sampling Drivers for Linux* Targets Debug Information for Linux* Application Binaries Compiler Switches for Performance Analysis on Linux* Targets Enable Linux* Kernel Analysis Resolution of Symbol Names for Linux-Loadable Kernel Modules Analyze Statically Linked Binaries on Linux* Targets Set Up Remote Linux* Target
Set Up Remote Linux* Target x
Set Up Linux* System for Remote Analysis Configure SSH Access for Remote Collection Search Directories for Remote Linux* Targets Temporary Directory for Performance Results on Linux* Targets
Embedded Linux* Targets x
Configure Yocto Project* and VTune Profiler with the Integration Layer Configure Yocto Project*/Wind River* Linux* and Intel® VTune™ Profiler with the Intel System Studio Integration Layer Configure Yocto Project* and Intel® VTune™ Profiler with the Linux* Target Package
FreeBSD* Targets x
Set Up FreeBSD* System
Managed Code Targets x
.NET* Targets Windows Store Application Targets Go* Application Targets
Android* Targets x
Build and Install Sampling Drivers for Android* Targets Set Up Android* System Enable Java* Analysis on Android* System Prepare an Android* Application for Analysis Analyze Unplugged Devices Search Directories for Android* Targets
Targets in Virtualized Environments x
Profile Targets on a VMware* Guest System Profile Targets on a Parallels* Guest System Profile Targets on a KVM* Guest System Profile Targets on a Xen* Virtualization Platform Profile Targets in the Hyper-V* Environment
Profile Targets on a KVM* Guest System x
Profile KVM Kernel Modules from the Host Profile KVM Kernel and User Space on the KVM System Profile KVM Kernel and User Space from the Host
Analyze Performance x
User-Mode Sampling and Tracing Collection Hardware Event-based Sampling Collection Performance Snapshot Algorithm Group Microarchitecture Analysis Group Parallelism Analysis Group Input and Output Analysis Accelerators Analysis Group Platform Analysis Group Platform Analysis Platform Analysis Workflow Configure the Collector Environment Start Platform Profiler Stop Platform Profiler Import Collected Data View Collected Data Next Steps Hybrid CPU Analysis Source Code Analysis Custom Analysis Energy Analysis Code Profiling Scenarios Control Data Collection Manage Data Views Manage Result Files
Hardware Event-based Sampling Collection x
Allow Multiple Runs or Multiplex Events Hardware Event-based Sampling Collection with Stacks
Algorithm Group x
Hotspots Analysis for CPU Usage Issues Anomaly Detection Analysis (preview) Memory Consumption Analysis
Hotspots Analysis for CPU Usage Issues x
Hotspots View
Anomaly Detection Analysis (preview) x
Anomaly Detection View
Memory Consumption Analysis x
Memory Consumption and Allocations View
Microarchitecture Analysis Group x
Microarchitecture Exploration Analysis for Hardware Issues Memory Access Analysis for Cache Misses and High Bandwidth Issues
Microarchitecture Exploration Analysis for Hardware Issues x
Microarchitecture Exploration View Microarchitecture Pipe
Memory Access Analysis for Cache Misses and High Bandwidth Issues x
Memory Usage View
Parallelism Analysis Group x
Threading Analysis HPC Performance Characterization Analysis
Threading Analysis x
Threading Efficiency View
HPC Performance Characterization Analysis x
HPC Performance Characterization View
Input and Output Analysis x
Analyze Platform Performance Analyze DPDK Applications Analyze SPDK Applications Analyze Linux Kernel I/O
Accelerators Analysis Group x
GPU Offload Analysis GPU Compute/Media Hotspots Analysis (Preview) CPU/FPGA Interaction Analysis
GPU Compute/Media Hotspots Analysis (Preview) x
GPU Compute/Media Hotspots View
CPU/FPGA Interaction Analysis x
CPU/FPGA Interaction View
Platform Analysis Group x
System Overview Analysis
System Overview Analysis x
Analyze Interrupts Analyze Latency Issues
Custom Analysis x
Custom Analysis Options
Custom Analysis Options x
Highly Accurate CPU Time Data Collection Hardware Event List Linux* and Android* Kernel Analysis Sampling Interval Sample After Value
Hardware Event List x
Hardware Event Skid Instructions Retired Event Precise Events
Energy Analysis x
Run Energy Analysis View Energy Analysis Data with Intel® VTune™ Profiler Interpret Energy Analysis Data with Intel® VTune™ Profiler
Code Profiling Scenarios x
Java* Code Analysis Python* Code Analysis Intel® Threading Building Blocks Code Analysis MPI Code Analysis OpenSHMEM* Code Analysis with Fabric Profiler GPU Application Analysis on Intel® HD Graphics and Intel® Iris® Graphics Frame Data Analysis Task Analysis
GPU Application Analysis on Intel® HD Graphics and Intel® Iris® Graphics x
GPU OpenCL™ Application Analysis Intel® Media SDK Program Analysis
Control Data Collection x
Finalization Pause Data Collection Limit Data Collection Generate Command Line Configuration from GUI Minimize Collection Overhead Import External Data
Import External Data x
Use a Custom Collector Create a CSV File with External Data Import Linux Perf* Trace with VTune Profiler Metrics Examples of CSV Format and Imported Data
Manage Data Views x
Switch Viewpoints Control Window Synchronization View Stacks Manage Grid Views Manage Timeline View Change Threshold Values Choose Data Format Group and Filter Data View Data on Inline Functions Analyze Loops Stitch Stacks for Intel® oneAPI Threading Building Blocks or OpenMP* Analysis Search for Data
View Stacks x
Call Stack Mode Metrics Distribution Over Call Stacks
Manage Result Files x
VTune Profiler Filenames and Locations Import Results and Traces into VTune Profiler GUI Compare Results
Compare Results x
Compare Source Code View Comparison Data
View Comparison Data x
Comparison Summary Bottom-up Comparison Top-down Tree Comparison
Intel® VTune™ Profiler Command Line Interface x
vtune Command Syntax vtune Actions Run Command Line Analysis Work with Results from Command Line Generate Command Line Reports Command Line Usage Scenarios Command Line Interface Reference Report Problems from Command Line
Run Command Line Analysis x
performance-snapshot Command Line Analysis hotspots Command Line Analysis anomaly-detection Command Line Analysis threading Command Line Analysis memory-consumption Command Line Analysis hpc-performance Command Line Analysis uarch-exploration Command Line Analysis memory-access Command Line Analysis tsx-exploration Command Line Analysis tsx-hotspots Command Line Analysis sgx-hotspots Command Line Analysis gpu-hotspots Command Line Analysis gpu-offload Command Line Analysis graphics-rendering Command Line Analysis fpga-interaction Command Line Analysis io Command Line Analysis system-overview Command Line Analysis runsa/runss Custom Command Line Analysis Configure Analysis Options from Command Line
Configure Analysis Options from Command Line x
Collect System-Wide Data from Command Line Collect Data on Remote Linux* Systems from Command Line Configure GPU Analysis from Command Line Specify Search Directories from Command Line Specify Result Directory from Command Line Pause Collection from Command Line Manage Analysis Duration from Command Line Limit Data Collection from Command Line
Work with Results from Command Line x
View Command Line Results in the GUI Import Results from Command Line Re-finalize Results from Command Line
Generate Command Line Reports x
Summary Report Hotspots Report Hardware Events Report Callstacks Report Top-down Report gprof-cc Report Difference Report View Source Objects from Command Line Save and Format Command Line Reports Filter and Group Command Line Reports
Command Line Usage Scenarios x
Use VTune Profiler Server in Containers Android* Target Analysis from the Command Line OpenMP* Analysis from the Command Line Java* Code Analysis from the Command Line
Command Line Interface Reference x
Option Descriptions and General Rules allow-multiple-runs analyze-kvm-guest analyze-system app-working-dir archive call-stack-mode collect collect-with column command cpu-mask csv-delimiter cumulative-threshold-percent custom-collector data-limit discard-raw-data duration filter finalization-mode finalize format group-by help import inline-mode knob kvm-guest-kallsyms kvm-guest-modules limit loop-mode mrte-mode no-follow-child no-summary no-unplugged-mode quiet report report-knob report-output report-width result-dir resume-after return-app-exitcode ring-buffer search-dir show-as sort-asc sort-desc source-object source-search-dir stack-size start-paused strategy target-install-dir target-system target-tmp-dir target-duration-type target-pid target-process time-filter trace-mpi user-data-dir verbose version
API Support x
Instrumentation and Tracing Technology APIs JIT Profiling API System APIs Supported by Intel® VTune™ Profiler
Instrumentation and Tracing Technology APIs x
Basic Usage and Configuration Instrumentation and Tracing Technology API Reference
Basic Usage and Configuration x
Configure Your Build System Attach ITT APIs to a Launched Application Instrument Your Application Minimize ITT API Overhead View Instrumentation and Tracing Technology (ITT) API Task Data in Intel® VTune™ Profiler
Instrumentation and Tracing Technology API Reference x
Domain API String Handle API Collection Control API Thread Naming API Task API Frame API Histogram API User-Defined Synchronization API Event API Counter API Load Module API Memory Allocation APIs
JIT Profiling API x
Using JIT Profiling API JIT Profiling API Reference
JIT Profiling API Reference x
iJIT_NotifyEvent iJIT_IsProfilingActive iJIT_ GetNewMethodID
Troubleshooting x
Best Practices: Resolve Intel® VTune™ Profiler BSODs, Crashes, and Hangs in Windows* OS Error Message: Application Sets Its Own Handler for Signal Error Message: Cannot Enable Event-Based Sampling Collection Error Message: Cannot Collect GPU Hardware Metrics Error Message: Cannot Load Data File Error Message: Cannot Locate Debugging Information Error Message: Cannot Open Data Error Message: Client Is Not Authorized to Connect to Server Error Message: Root Privileges Required for Processor Graphics Events Error Message: No Pre-built Driver Exists for This System Error Message: Not All OpenCL™ API Profiling Callbacks Are Received Error Message: Problem Accessing the Sampling Driver Error Message: Required Key Not Available Error Message: Scope of ptrace System Call Is Limited Error Message: Stack Size Is Too Small Error Message: Symbol File Is Not Found Problem: Analysis of the .NET* Application Fails Problem: Cannot Access VTune Profiler Documentation Problem: CPU time for Hotspots or Threading Analysis is Too Low Problem: 'Events= Sample After Value (SAV) * Samples' Is Not True If Multiple Runs Are Disabled Problem: Guessed Stack Frames Problem: GUI Hangs or Crashes Problem: Inaccurate Sum in the Grid Problem: Information Collected via ITT API Is Not Available When Attaching to a Process Problem: No GPU Utilization Data Is Collected Problem: Same Functions Are Compared As Different Instances Problem: Skipped Stack Frames Problem: Stack in the Top-Down Tree Window Is Incorrect Problem: Stacks in Call Stack and Bottom-Up Panes Are Different Problem: System Functions Appear in the User Functions Only Mode Problem: VTune Profiler is Slow to Respond When Collecting or Displaying Data Problem: VTune Profiler is Slow on X-Servers with SSH Connection Problem: Unexpected Paused Time Problem: {Unknown Timer} in the Platform Power Analysis Viewpoint Problem: Unknown Critical Error Due to Disabled Loopback Interface Problem: Unknown Frames Problem: Unreadable Text on macOS* Problem: Unsupported Microsoft* Windows* OS Warnings about Accurate CPU Time Collection
Reference x
User Interface Reference CPU Metrics Reference GPU Metrics Reference OpenCL™ Kernel Analysis Metrics Reference Energy Analysis Metrics Reference Intel Processor Events Reference
User Interface Reference x
Context Menu: Grid Context Menus: Call Stack Pane Context Menus: Project Navigator Context Menus: Source/Assembly Window Dialog Box: Binary/Symbol Search Dialog Box: Source Search Hot Keys Menu: Customize Grouping Menu: Intel VTune Profiler Pane: Call Stack Pane: Options - General Pane: Options - Result Location Pane: Options - Source/Assembly Project Navigator Pane: Timeline Toolbar: Configure Analysis Toolbar: Filter Toolbar: Source/Assembly Toolbar: Intel VTune Profiler Window: Bandwidth - Platform Power Analysis Window: Bottom-up Window: Caller/Callee Window: Cannot Find <file type> File Window: Collection Log Window: Compare Results Window: Configure Analysis Window: Core Wake-ups - Platform Power Analysis Window: Correlate Metrics - Platform Power Analysis Window: CPU C/P States - Platform Power Analysis Window: Debug Window: Event Count - Hardware Events Window: Flame Graph Window: Graphics - GPU Compute/Media Hotspots Window: Graphics C/P States - Platform Power Analysis Window: NC Device States - Platform Power Analysis Window: Platform Window: Platform Power Analysis Window: Sample Count - Hardware Events Window: SC Device States - Platform Power Analysis Window: Summary Window: System Sleep States - Platform Power Analysis Window: Temperature/Thermal Sample - Platform Power Analysis Window: Timer Resolution - Platform Power Analysis Window: Top-down Tree Window: Uncore Event Count - Hardware Events Window: Wakelocks - Platform Power Analysis
Window: Summary x
Window: Summary - Input and Output Summary Window: Summary - Microarchitecture Exploration Window: Summary - GPU Analysis Window: Summary - Hardware Events Window: Summary - Hotspots by CPU Utilization Window: Summary - HPC Performance Characterization Window: Summary - Memory Consumption Window: Summary - Memory Usage Window: Summary - Platform Power Analysis
GPU Metrics Reference x
Average Time Computing Threads Started Computing Threads Started, Threads/sec CPU Time EU 2 FPU Pipelines Active EU Array Active EU Array Idle EU Array Stalled/Idle EU Array Stalled EU IPC Rate EU Send pipeline active EU Threads Occupancy Global GPU EU Array Usage GPU L3 Bound GPU L3 Miss Ratio GPU L3 Misses GPU L3 Misses, Misses/sec GPU Memory Read Bandwidth, GB/sec GPU Memory Texture Read Bandwidth, GB/sec GPU Memory Write Bandwidth, GB/sec GPU Texel Quads Count, Count/sec GPU Utilization Instance Count L3 Sampler Bandwidth, GB/sec L3 Shader Bandwidth, GB/sec LLC Miss Rate due GPU Lookups LLC Miss Ratio due GPU Lookups Local Maximum GPU Utilization Occupancy PS EU Active % PS EU Stall % Ratio to Max Bandwidth, % Ratio to Max Bandwidth, % Ratio to Max Bandwidth, % Render/GPGPU Command Streamer Loaded Samples Blended Samples Killed in PS, pixels Samples Written Sampler Busy Sampler Is Bottleneck Shared Local Memory Read Bandwidth, GB/sec Shared Local Memory Write Bandwidth, GB/sec SIMD Width Size Total, GB/sec Total Time Typed Memory Read Bandwidth, GB/sec Typed Memory Write Bandwidth, GB/sec Typed Reads Coalescence Typed Writes Coalescence Untyped Memory Read Bandwidth, GB/sec Untyped Memory Write Bandwidth, GB/sec Untyped Reads Coalescence Untyped Writes Coalescence VS EU Active VS EU Stall
OpenCL™ Kernel Analysis Metrics Reference x
Computing Task Total Time Instance Count SIMD Width SIMD Utilization Work Size
Energy Analysis Metrics Reference x
Available Core Time C-State D0ix States DRAM Self Refresh Energy Consumed (mJ) Idle Wake-ups P-State S0ix States Temperature Timer Resolution Total Time in C0 State Total Time in Non-C0 States Total Time in S0 State Total Wake-up Count Wake-ups Wake-ups/sec per Core
Intel® VTune™ Profiler User Guide

Platform Analysis

Use Intel® VTune™ Profiler-Platform Profiler to get a holistic view of system behavior. You can then perform system characterization on a deployed system that runs a full load over an extended period of time.

With Intel® VTune™ Profiler-Platform Profiler, you can get insights into these aspects:

  • Platform configuration
  • Utilization
  • Performance
  • Imbalances related to compute, memory, storage, IO, and interconnects

You can use Platform Profiler to conduct a coarse-grained, system-level analysis. Use the collected data to triage and characterize your system for a particular workload. This method differs from the System Overview Analysis in some important ways:

Aspect

System Overview Analysis

Analysis using Platform Profiler

Type of analysis Fine-grained Coarse-grained
Coverage Hardware and software Hardware only
Type of workload Light workloads (runtime around a few minutes) Heavy workloads (runtime running to several hours)

For heavy workloads with long runtimes, run Platform Profiler to ensure that you use available hardware in the most optimal way.

Platform Profiler consists of a command line data collector and a server implementing a RESTful interface to a time-series database. The collector ships with the VTune Profiler package. You can run Platform Profiler on Windows* and Linux* systems.

Platform Analysis Workflow

Here is the basic workflow to use this application:

  1. Configure the collector environment.
  2. Start Platform Profiler.
  3. After data collection, stop Platform Profiler.
  4. Import the collected data into Intel® VTune™ Profiler-Platform Profiler server.
  5. View the collected data.

Configure the Collector Environment

When you configure your environment for the first time, you must have root/Administrator privilege.

To set up your environment, run vpp-collect-vars.

  • For a Linux OS, source vpp-collect-vars.sh in the server directory. 
    $ source /opt/intel/oneapi/vtune/latest/vpp/collect/vpp-collect-vars.sh
  • For a Windows OS, run the vpp-collect-vars.cmd script in the server directory. 
    $ C:\Program Files (x86)\Intel\oneAPI\vtune\latest\vpp\collector\vpp-collect-vars.cmd

Next, create the Platform Profiler server virtual Python* environment. At the command prompt, type: 

$ vpp-server-config

Start Platform Profiler

  1. In the command window, type: 

    $ vpp-collect start -c "data collection comment"

    where the comment argument is optional.

  2. If you want to insert marks in the data metrics timeline, run: 

    vpp-collect mark “optional comment”

Stop Platform Profiler

When you have finished collecting data, run this command to stop Platform Profiler: 

vpp-collect stop

After data collection completes, Platform Profiler compresses the results into a .tgz (Linux) or .zip (Windows) file whose name contains the name of the target system and a date/time stamp.

Import Collected Data

Next, you import the collected data into Platform Profiler server. Use the Platform Profiler server to examine a performance overview of system behavior. Understand platform-level configuration, utilization and imbalance issues related to compute, memory, storage, IO and interconnects.

  1. To start, set up the environment for Platform Profiler server. When you configure your environment for the first time, you must have root/Administrator privilege.

    • For a Linux OS, source vpp-server-vars.sh in the server directory. 
      $ source /opt/intel/oneapi/vtune/latest/vpp/collect/vpp-server-vars.sh
    • For a Windows OS, run the vpp-server-vars.cmd script in the server directory. 
      $ C:\Program Files (x86)\Intel\oneAPI\vtune\latest\vpp\server\vpp-server-vars.cmd

  2. Next, create the virtual Python* environment for Platform Profiler server. 

    vpp-server config
    NOTE:

    You can configure several command line options, if necessary:

    Option Purpose
    --webserver-port PORT

    Change the default port (originally 6543) on which the Platform Profiler web server listens for connections.

    --database-port PORT

    Change the default port (originally 8086) on which the database server of the Platform Profiler listens for connections.

    --data-dir PATH

    Change the default directory where the Platform Profiler data is stored.

    --reset-passphrase

    Display the server password prompt so that it can be changed.

    --quiet

    Silence all prompts and accept the default data directory.

  3. Start the Platform Profiler server using default settings. Run this command: 

    vpp-server start

  4. In the Server Settings dialog box, specify a directory for storage and/or authentication if necessary.

  5. Open a web browser to the address and port number of the server instance of Intel® VTune™ Profiler-Platform Profiler. For example, in the address bar of the web browser, type: 

    localhost:6543

  6. Enter your passphrase for the database and click Login. You can also create a new folder to store the imported results and then click on the folder name to open it.

  7. Once you log in, go to the View Results tab and click the Upload button.

  8. After the data import completes, you can view results by clicking on the results name.

View Collected Data

After data collection and import, VTune Profiler server displays information in three areas:

  • The Platform Configuration Diagram - Use this diagram to get quick metrics for each subsystem (socket, core, memory, disk, etc.).
  • An interactive timeline - Filter on a smaller range of collection time.
  • Detailed performance charts

Start with the platform configuration diagram to see configuration details and key metrics. Hover over component icons to see additional details for a component.

There are several views to help you visualize and interpret the collected data. A good starting point is the Overview, which you can select from the Select View pulldown menu.

Hover over here to see information about the system used for data collection.

See different views for information on sockets, cores, memory, and storage devices.

Hover over here to see additional information about the platform configuration. Click on specific elements to switch views.

Filter the data for a specific time range.

Undo or reset a zoom level.

See summary information about CPU and memory utilization.

See performance information over time. Click and drag to select and zoom into a specific time range.

Next Steps

  • Consider whether an upgrade to hardware components (CPU, memory, storage, network) could improve performance. After you install new hardware, repeat the platform analysis and compare performance between the older and newer components.

  • Analyze the collected data to determine the most prevalent performance bottlenecks and the most impacted components. If a specific portion of the workload is causing performance issues, consider running the following analysis types using VTune Profiler using a targeted collection interval (seconds instead of hours):

    • Microarchitecture Exploration: Identify issues with CPU utilization, cache, or memory

    • Memory Access: Identify memory issues

    • Input and Output: Identify storage usage issues

Parent topic: Analyze Performance
Level Two Title