Generate Command Line Reports

User Guide

Intel® VTune™ Profiler User Guide

Download PDF

ID 766319

Date 11/07/2023

Version

Public

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

Visible to Intel only — GUID: GUID-96CB61B3-8A92-487D-AB6F-ED99AE7EAAEE

View Details

Generate Command Line Reports

When you run a performance analysis from the command line, you see the results in the Intel® VTune™ Profiler user interface. Use available options in the VTune Profiler GUI to filter and format the data.

You can also see the collected data as a report on the command line. The following sections describe the types of reports you can generate this way.

General Syntax

Use the following syntax to generate a report from the command line:

vtune report <report_type> -result-dir <result_path> [report_options]

where:

<report_type> is the type of report that you want to create. To get the list of available report types, enter:vtune -help report. To display help for a specific report type, enter: vtune -help report <report_type>.
<result_path> is a directory where your result file is located. If you do not specify a result directory, the VTune Profiler displays a report for the latest collected result.
[report_options] are action options used to manage the selected report. To view a list of available report action options, enter: vtune -help report <report_type>.

NOTE:

-R is the short form of the report action. -r is the short form of the result-dir action-option. The syntax vtune -R <report_type> -r <result_path> is a valid syntax to generate a command line report.

Usage Considerations

You generate command line reports from existing results. When using the command line, you cannot collect data and generate a timeline report simultaneously. Therefore, you cannot use the collect and report actions in the same command.
The analysis type used to collect a result determines the report types for that result that can be generated from the command line.
By default, a report is written in text format to stdout and is not saved to a file. To save, filter and format reports, see the topics on Saving and Formatting Reports as well as Filtering and Grouping Reports.

Types of Command Line Reports

Use the vtune command to generate these types of reports:

affinity

Display binding of a thread to a range of sockets, physical, and logical cores.

callstacks

Report full stack data for each hotspot function; identify the impact of each stack on the function CPU or Wait time. You can use the group-by or filter options to sort the data by:

callstack
function
function-callstack

exec-query

gprof-cc

Report a call tree with the time (CPU and Wait time, if available) spent in each function and its children.

hotspots

Display collected performance metrics according to the selected analysis type and identify program units that took the most CPU time (hotspots).

hw-events

Display the total number of hardware events.

platform-power-analysis

Display CPU sleep time, wake-up reasons and CPU frequency scaling time.

summary

Report on the overall performance of your target.

timeline

Display metric data over time and distributed over time intervals.

top-down

Report call sequences (stacks) detected during collection phase, starting from the application root (usually, the main() function). Use this report to see the impact of program units together with their callees.

vectspots

Display statistics that help identify code regions to tracing on a HW simulator.

Example

This example displays a Hotspots report for the r001hs result. The report shows CPU time for the functions of the target in descending order, starting with the most time-consuming function.

vtune -report hotspots -r r001hs


Function         CPU Time CPU Time:Effective Time  CPU Time:Effective Time:Idle  CPU Time:Effective Time:Poor  CPU Time:Effective Time:Ok  CPU Time:Effective Time:Ideal  CPU Time:Effective Time:Over  
---------------- -------- -----------------------  ----------------------------  ----------------------------  --------------------------  -----------------------------  ---------------------------- 
grid_intersect     3.371s                  3.371s                            0s                        3.371s                          0s                             0s                            0s
sphere_intersect   2.673s                  2.673s                            0s                        2.673s                          0s                             0s                            0s
render_one_pixel   0.559s                  0.559s                            0s                        0.559s                          0s                             0s                            0s 
...

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® VTune™ Profiler User Guide

Generate Command Line Reports

General Syntax

Usage Considerations

Types of Command Line Reports

Example

See Also