report

Generate a specified type of report from an analysis result.

GUI Equivalent

Syntax

-report <report_name>

-R <report_name>

Arguments

Argument	Description
`<report_name>`	Type of report to create.

Value

Description

summary

Report on the overall performance of your target.

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.

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

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.

gprof-cc

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

gpu-computing-tasks

Display a list of computing tasks (OpenCL™ kernels) or their instances annotated with total and average time, instance count and average values of GPU hardware metrics (if applicable). You can group or filter the report by computing-task (default) or computing-instance.

Modifiers

call-stack-mode, csv-delimiter, cumulative-threshold-percent, discard-raw-data, filter, format, group-by, inline-mode, , limit, quiet, report-output, result-dir, search-dir, source-search-dir, source-object, verbose, time-filter, loop-mode, column

Description

Use the report action to generate a report from an existing result. The report type must be compatible with the analysis type used in the collection.

By default, your report is written to stdout. If you want to save it to a file, use the report-output action-option.

Both short names and long names are case-sensitive. For example, -R is the short name of the report action, and -r is the short name of the result-dir action-option.

Note

To get the list of available report types, use the amplxe-cl -help report command.

To display help for a specific report type, use amplxe-cl -help report <report_name>, where <report_name> is the type of report that you want to create.

Example

In this pair of examples, a collect action is used to perform a hotspots analysis for the sample target and write the result to the current working directory. The second command uses the report action to generate a hotspots report from the most recent result and write it to stdout.

$ amplxe-cl -collect hotspots -- /home/test/sample

$ amplxe-cl -R hotspots

Generate a hotspots report from a basic hotspots analysis and group data by module.

$ amplxe-cl -R hotspots -result-dir r001ah -group-by module

Open source view with the hotspots performance metrics for the foo function and use the /home/my_sources directory to search for source files.

$ amplxe-cl -R hotspots  -source-object function=foo -r r001hs -source-search-dir /home/my_sources

Write stack information for all functions in the concurrency analysis result r003cc. The data is grouped by call stack.

amplxe-cl -R callstacks -r r003cc -group-by callstack