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
GUI tools, or you can view a report from the command line. A variety of report types, filtering and formatting options are available.
Profiler
Limitations
:
- You cannot use thecollectandreportactions 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 tostdoutand 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:
where:
- <is the type of report that you want to create. To get the list of available report types, enter:report_type>. To display help for a specific report type, enter:-help reportvtune.-help report <vtunereport_type>
- <is a directory where your result file is located. If you do not specify a result directory, theresult_path>VTunedisplays a report for the latest collected result.Profiler
- [are action options used to manage the selected report. To view a list of available report action options, enter:report_options].-help report <vtunereport_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
report_type
> -r <result_path
>Report Types
The
command can generate the following types of reports:
vtune
- 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 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
...