User Guide

  • 2020
  • 06/18/2020
  • Public Content
Contents

Generate Command Line Reports

After performing an analysis via the command line, you can view command line results in the GUI to get full benefits of
VTune
Profiler
GUI tools, or you can view a report from the command line. A variety of report types, filtering and formatting options are available.
Limitations
:
  • You cannot use the
    collect
    and
    report
    actions in the same command, so reports must be generated from a previously collected result.
  • The analysis type used to collect a result determines which report types are compatible and can be used to generate reports from the result.
  • By default, a report is written in text format to
    stdout
    and is not saved to a file. Instructions for saving, filtering and formatting reports are provided in the following sections: Saving and Formatting Reports, Filtering and Grouping Reports.

Report Command 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
    >
    .
-R
is the short form of the
report
action, and
-r
is the short form of the
result-dir
action-option. The command syntax for generating a report could also be written as:
vtune
-R <
report_type
> -r <
result_path
>

Report Types

The
vtune
command can generate the following types of reports:
Value
Description
affinity
Display binding of a thread to a range of sockets, physical, and logical cores.
Report on the overall performance of your target.
Display collected performance metrics according to the selected analysis type and identify program units that took the most CPU time (hotspots).
Display the total number of hardware events.
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
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.
Report a call tree with the time (CPU and Wait time, if available) spent in each function and its children.
Example
This example displays a Hotspots report for the
r001hs
result, presenting CPU time for the functions of the target in descending order starting from 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 ...

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