User Guide

Intel® VTune™ Profiler User Guide

ID 766319
Date 11/07/2023
Public

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

Document Table of Contents

runsa/runss Custom Command Line Analysis

Use the collect-with action to configure and run a custom analysis using any of the following data collectors:

runsa

The hardware event-based sampling collector of the VTune Profiler profiles your application using the counter overflow feature of the Performance Monitoring Unit (PMU).

Syntax:

vtune -collect-with runsa [-knob <knobName=knobValue>] [--] <target>

NOTE:

For the most current information on available knobs (configuration options) for the hardware event-based sampling, enter:

vtune -help collect-with runsa

To display a list of events available on the target PMU, enter:

vtune -collect-with runsa -knob event-config=? <target>

The command returns names and short descriptions of available events. For more information on the events, use Intel Processor Events Reference

Example 1:

This example runs a custom hardware event-based sampling collection for the sample application with the specified events:

vtune -collect-with runsa -knob event-config=CPU_CLK_UNHALTED.CORE,CPU_CLK_UNHALTED.REF,INST_RETIRED.ANY -- /home/test/sample

Example 2:

This example configures and runs a custom event-based sampling data collection with the stack size limited to 8192 bytes and defines a custom Sample After value for the CPU_CLK_UNHALTED.REF_TSC event using the sa option:

vtune -collect-with runsa -knob enable-stack-collection=true -knob stack-size=8192 -knob -knob event-config=CPU_CLK_UNHALTED.REF_TSC:sa=1800000,CPU_CLK_UNHALTED

runss

The user-mode sampling and tracing collector profiles an application execution and takes snapshots of how that application utilizes the processors in the system. The collector interrupts a process, collects the value of all active instruction addresses and captures a calling sequence for each of these samples.

Syntax:

vtune-collect-with runss [-knob <knobName=knobValue>] [--] <target>

NOTE:

For the most current information on available knobs (configuration options) for the user-mode sampling and tracing, enter:

vtune -help collect-with runss

Example:

This example runs user-mode sampling and tracing collection for the sample application with enabled loop analysis.

vtune -collect-with runss -knob analyze-loops=true -- /home/test/sample

What's Next

When the data collection is complete, do one of the following to view the result: