Reporting Result Data from the Command Line
After performing an
Intel Inspector
analysis, data is collected into a result that can be viewed in the GUI or used to generate a report from the command line. By default, a report is written to
stdout
in text format, but the
inspxe-cl
command provides a number of options you can use when generating a report.
Report Types
The
report
action can be used with the following report types:
- summary
- Brief statement of the total number of problems detected during analysis, with a breakdown by problem type. After eachcollectorcollect-withaction, a summary report is generated by default, sent tostdoutand also saved as an XML file in the current working directory.
- status
- Brief statement of the total number of problems detected in the result, with a breakdown by problem state.
- problems
- Detailed report of detected problem sets, including their location in the source code, such as the problem type, severity, module and line number.
- observations
- Detailed report of all code locations (observations) included in defined problem sets, such as the allocation site, function, module and line number.
Report Process Summary
- Set up thecommand environment.inspxe-cl
- Invoke thecommand with theinspxe-clcollectorcollect-withaction to inspect the application.
- Invoke thecommand with theinspxe-clreportaction to generate a report of detected problems.
Report Process Example
- Add thebin64(orbin32) directory (located in the installation directory) to your PATH environment variable.You can open a terminal and use the following commend to run the script that establishesIntel Inspectorenvironment settings:source <install-dir>/inspxe-vars.shForIntel® oneAPI HPC ToolkitorIntel® oneAPI IoT Toolkitinstallations, the script is namedrather than inspxe-vars.env\vars
- In a command window, inspect themyAppapplication for memory problems and store the result in themyRes007mi2directory in the current working directory:inspxe-cl-collect mi2 -result-dir myRes007mi2 -- myApp
- mi2is the short name for theDetect Memory Problemsanalysis type.
- If you do not supply an absolute pathname for the application, system path environment settings are used to locate it.
- Print tostdouta list of new memory problems found in themyRes007mi2result:inspxe-cl-report problems -result-dir myRes007mi2
Status Report Example
Generate a status report for the specified result and display it to standard out.
-R
is the short name of the
-report
action, and
-r
is the short name of the
-result-dir
action.
$ inspxe-cl -R status -r myRes007mi2
The output status report:
181 problem(s) found 15 Investigated 166 Not investigated Breakdown by state: 13 Confirmed 2 Fixed 166 New
Next Step
Interpret result data.