Visible to Intel only — GUID: GUID-731837A7-DE6E-4F31-88D2-139C524DD8DF
Prepare Application for Analysis
Windows* Targets
Linux* Targets
Embedded Linux* Targets
Use the Intel System Studio Integration Layer
Use the Intel VTune Profiler Yocto Project Integration Layer
Use the Bundled Intel VTune Profiler Installation Packages
See Also
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
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
Use the Intel System Studio Integration Layer
Use the Intel VTune Profiler Yocto Project Integration Layer
Use the Bundled Intel VTune Profiler Installation Packages
See Also
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
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
Hybrid CPU Analysis
Source Code Analysis
Custom Analysis
Energy Analysis
Code Profiling Scenarios
Control Data Collection
Manage Data Views
Manage Result Files
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
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
npu
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
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
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
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
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 - 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
ALU0 Active
ALU0 Instructions
ALU1 Active
ALU1 Instructions
ALU2 Active
ALU2 Instructions
ALU0 and ALU1 Active
ALU0 and ALU2 Active
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
Host to GPU Memory Read Bandwidth
Host-to-GPU Memory Write Bandwidth
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 Read Bandwidth
L3 Write Bandwidth
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
Stack-to-stack Incoming Bandwidth
Stack-to-stack Outgoing Bandwidth
System Memory Read Bandwidth
System Memory Write Bandwidth
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
Visible to Intel only — GUID: GUID-731837A7-DE6E-4F31-88D2-139C524DD8DF
Embedded Linux* Targets
Use the Intel® VTune™ Profiler for performance analysis on Embedded Linux* systems, Wind River*, Yocto Project*, FreeBSD* and others.
Embedded device performance data can be collected remotely on the embedded device and running the analysis from an instance of VTune Profiler installed on the host system. This is useful when the target system is not capable of local data analysis (low performance, limited disk space, or lack of user interface control).
NOTE:
Root access to the operating system kernel is required to install the collectors and drivers required for performance analysis using VTune Profiler.
To enable performance analysis on an embedded device, use any of the following:
- Intel System Studio integration layer (Wind River* Linux and Yocto Project* only)
- Intel VTune Profiler Yocto Project Integration Layer
- bundled VTune Profiler installation packages
Use the Intel System Studio Integration Layer
NOTE:
The Intel System Studio integration layer works for embedded systems with Wind River Linux or Yocto Project installed.
The Intel System Studio integration layer allows the Intel System Studio products to be fully integrated with a target operating system by building the drivers and corresponding target packages into the operating system image automatically. Use this option in the case where a platform build engineer has control over the kernel sources and signature files, but the application engineer does not. The platform build engineer can integrate the product drivers with the target package and include them in the embedded device image that is delivered to the application engineer.
Install Intel System Studio using the installer GUI.
Install the Intel System Studio integration layer.
- Copy the integration layer from the Intel System Studio installation folder to the target operating system development folder.
Run the post-installation script: <iss-install-dir>/YoctoProject/meta-intel-iss/yp-setup/postinst_<OS>_iss.sh <ISS_BASE_dir>
For example, for Wind River Linux: /YoctoProject/meta-intel-iss/yp-setup/postinst_wr_iss.sh
Build the recipe that includes the appropriate VTune Profiler package.
Add the path to the /YoctoProject/meta-intel-iss to the bblayers.conf file:
BBLAYERS= "\
...
<OS_INSTALL_DIR>/YoctoProject/meta-intel-iss\
...
"
Add the VTune Profiler recipes to conf/local.conf. Possible recipes include:
intel-vtune-drivers: integrates all VTune Profiler drivers for PMU-based analysis with stacks and context switches. Requires additional kernel options to be enabled.
intel-vtune-sep-driver: integrates drivers for PMU-based analysis with minimal requirements for kernel options.
For more information about these collection methods, see Remote Linux Target Setup.
Build the target operating system, which will complete the integration of the VTune Profiler collectors and drivers.
Flash the operating system to the target embedded device.
After flashing the operating system to the target embedded device, ensure that the appropriate VTune Profiler drivers are present. For more information, see Building the Sampling Drivers for Linux Targets.
Run the analysis on the target embedded device from the host system using an SSH connection or using the SEP commands.
Set up a password-less SSH access to the target using RSA keys.
Specify your target application and remote system.
NOTE:After configuring the remote connection, VTune Profiler will install the appropriate collectors on the target system.
Choose an analysis type.
Run the analysis from the host.
Use the information available in the Sampling Enabling Product User's Guide to run the SEP commands.
View results in the VTune Profiler GUI on the host.
Examples: Configuring Yocto Project* with the Intel System Studio Integration Layer
Use the Intel VTune Profiler Yocto Project Integration Layer
Intel VTune Profiler Yocto Project integration layer builds the drivers into the operating system image automatically. Use this option in the case where a platform build engineer has control over the kernel sources and signature files, but the application engineer does not. The platform build engineer can integrate the product drivers with the target package and include them in the embedded device image that is delivered to the application engineer.
Install Intel VTune Profiler.
Configure the integration layer.
Extract the <install-dir>/target/linux/vtune_profiler_target_x86.tgz or <install-dir>/target/linux/vtune_profiler_target_x86_64.tgz package.
Modify the sepdk/vtune-layer/conf/user.conf file to specify user settings.
Specify one of the following paths:
Path to unzipped target package: VTUNE_TARGET_PACKAGE_DIR = "<PATH>"
Path to VTune Profiler installation directory: VTUNE_PROFILER_2020_DIR = "<PATH>"
(Optional) To integrate the SEP driver during system book, specify ADD_TO_INITD = "y".
Copy the integration layer to the Yocto Project development environment.
Add the path to the layer to the bblayers.conf file:
BBLAYERS= "\
...
<OS_INSTALL_DIR>/vtune-layer\
...
"
Add the VTune Profiler recipes to conf/local.conf. Possible recipes include:
intel-vtune-drivers: integrates all VTune Profiler drivers for PMU-based analysis with stacks and context switches. Requires additional kernel options to be enabled.
intel-vtune-sep-driver: integrates drivers for PMU-based analysis with minimal requirements for kernel options.
For more information about these collection methods, see Remote Linux Target Setup.
Build the target operating system, which will complete the integration of the VTune Profiler collectors and drivers.
Flash the operating system to the target embedded device.
After flashing the operating system to the target embedded device, ensure that the appropriate VTune Profiler drivers are present.
5. Run the analysis on the target embedded device from the host system using an SSH connection or using the SEP commands.
Set up a password-less SSH access to the target using RSA keys.
Specify your target application and remote system.
Choose an analysis type.
Run the analysis from the host.
Use the information available in the Sampling Enabling Product User's Guide to run the SEP commands.
View results in the VTune Profiler GUI.
Example: Configuring Yocto Project with the VTune Profiler Integration Layer
Use the Bundled Intel VTune Profiler Installation Packages
You can build the appropriate drivers and install the VTune Profiler collectors on your kernel image manually with a command line. This option requires root access to the configured kernel source.
Install Intel VTune Profiler using the installer GUI.
Run the analysis on the target embedded device.
Set up a password-less SSH access for the root user to the target using RSA keys.
Specify your target application and remote system. The collectors and drivers within the package should be automatically installed.
Choose an analysis type.
Run the analysis from the host.
3. View results in the VTune Profiler GUI on the host.
Troubleshooting
If the drivers were not built during collector installation, the installation output should inform you that building the sampling driver is required.
The drivers are built either on the target system or on the host system, depending on compiler toolchain availability:
If the compiler toolchain is available on the target system:
- On the target embedded device, build the driver from the <install-dir>/sepdk/src directory using the ./build-driver command.
- Load the driver into the kernel using the ./insmod-sep command.
If the compiler toolchain is not available on the target system:
- On the host system, cross-build the driver using the driver source from the target package sepdk/src directory with the ./build-driver command. Provide the cross-compiler (if necessary) and the target kernel source tree for the build.
- Copy the sepdk/src folder to the target system.
- Load the driver into the kernel using the ./insmod-sep command.
Example: Configuring Yocto Project with Intel VTune Profiler Target Packages