Intel® Inspector User Guide for Windows* OS

Download PDF
ID 767798
Date 3/22/2024
Public
Document Table of Contents
Document Table of Contents x
Intel® Inspector User Guide for Windows* OS
Intel® Inspector User Guide for Windows* OS x
Get Started Before You Begin Set Up a Project Collect Results Investigate Results Test for Regressions Suppressions Support API Support Troubleshooting User Interface Reference Problem Type Reference Command Line Interface Support MPI Applications Support Appendix Notices and Disclaimers
Get Started x
Dynamic Analysis vs. Static Analysis Key Terminology Sample Applications and Tutorials Workflows-Quick Paths to Maximizing Productivity
Workflows-Quick Paths to Maximizing Productivity x
Analysis Workflow Reporting Workflow Regression Testing Workflow
Before You Begin x
Visual Studio* Integration Standalone Intel Inspector GUI Startup Tasks
Startup Tasks x
Change Result and Result Directory Name Templates Choose Baseline Results for Setting States Display Application Output
Set Up a Project x
Build Your Application Choose Projects Configure Projects
Build Your Application x
Configure Debug Mode for Applications in the Visual Studio* IDE Set Up Applications to Build in Debug Mode in the Visual Studio* IDE
Choose Projects x
Choose Projects in the StandaloneIntel Inspector GUI Choose Projects in the Visual Studio* IDE Create Projects in the StandaloneIntel Inspector GUI Create Solutions/Projects From Applications in the Visual Studio* IDE
Configure Projects x
Binary/Symbol Search and Source Search Locations Choose Data Sets Manage Suppression Rules Search Non-standard Directories Set Project Properties-Advanced Set Target Application Properties - Basic
Collect Results x
Configure Analysis Run Analysis Examine Result Data During Analysis
Configure Analysis x
Memory Error Analysis Types Threading Error Analysis Types Manage Custom Analysis Types
Run Analysis x
Run Memory Error and Threading Error Analyses Stop Analysis
Examine Result Data During Analysis x
Find Memory Leaks On Demand Measure Memory Growth
Investigate Results x
View Results Choose Problems Interpret Result Data and Resolve Issues Investigate Problems Using Interactive Debugging Collaborate on Results Export and Import Files Compare Results
View Results x
Manage Help Snippet Displays Open Results Show Result Summaries
Choose Problems x
Deselecting Filter Criteria Refining the Source File Set Selecting Filter Criteria Selecting Problems
Interpret Result Data and Resolve Issues x
Severity Levels States Access the Explain Problem Help Change States Customize Frame Presentation Customize Data Columns Edit Source Code
Investigate Problems Using Interactive Debugging x
Intel Inspector Debug Extensions in the Visual Studio* IDE Disable and Re-enable Problem Breakpoints Stop Analyses During Interactive Debugging
Collaborate on Results x
State Merge Merge States Across Results Report Result Data
Export and Import Files x
Export Archives Import Archives and Other Files
Test for Regressions x
Tes for Regressions: Recommended Approach Test for Regressions: Other Approaches
Suppressions Support x
Suppressions Support Using the GUI Suppressions Support Using Handwritten Suppression Rules Suppressions Support Using Third-party Suppression Rules
Suppressions Support Using the GUI x
Typical Suppressions Usage Model Using the GUI Suppression Rule Reach in the GUI Suppression Rule Examples in the GUI Defining Suppression Rules in the GUI Deleting Suppression Rules Applied to Marked Result Data in the GUI
Suppressions Support Using Handwritten Suppression Rules x
Typical Suppressions Usage Models Using Handwritten Suppression Files Suppression Rule Syntax in Text Format Suppression Rule Examples in Text Format
Suppressions Support Using Third-party Suppression Rules x
Typical Suppressions Usage Models Using Third-party Suppression Files Third-party Suppression Files
API Support x
APIs for Custom Synchronization APIs for Custom Memory Allocation APIs for Collection Control
Troubleshooting x
Troubleshooting Anti-virus Software Issues Troubleshooting Application Crashes Troubleshooting Internal Thread Suspension Attempt Troubleshooting No Problems Detected Troubleshooting No Symbolic Information Troubleshooting OpenMP* Technology Issues Troubleshooting Out-of-memory Conditions Troubleshooting Tamper-resistance Issues Troubleshooting Unexpected Application Behavior During Memory Error Analyses
User Interface Reference x
Context Menus: Problem Details Pane Context Menus: Project Navigator Context Menus: Solution Explorer Context Menus: Sources Window Panes Context Menus: Summary Window Panes Dialog Box: Corresponding inspxe-cl Command Options Dialog Box: Create a Project Dialog Box: Create Suppression Dialog Box: Custom Analysis Dialog Box: Delete Suppressions Dialog Box: Disabled Problem Breakpoints Dialog Box: Export Result Dialog Box: Merge States Dialog Box: Options-General Dialog Box: Options-Result Location Dialog Box: Options-State Management Dialog Box: Problem Report Dialog Box: Project Properties-Binary/Symbol Search Dialog Box: Project Properties-Source Search Dialog Box: Project Properties-Suppressions Dialog Box: Project Properties-Target Dialog Box: Refine Source File Set Dialog Box: Select Stack Frame(s) Dialog Box: View Stack Hot Keys Pane: Analysis Type-Custom Pane: Analysis Type-Memory Errors Pane: Analysis Type-Threading Errors Pane: Application Output Pane: Code and Stack Pane: Code Locations Pane: Collection Log Pane: Collector Messages Pane: Compare Results Pane: Filters Pane: Import Result Pane: Launch Application Pane: Problem Details Pane: Problems Pane: Project Navigator Pane: Timeline Toolbar: Command Toolbar: Intel Inspector Toolbar: Navigation Window: Collection Log Window: Compare Results Window: Import Result Window: Sources Window: Summary After Analysis Is Complete Window: Summary During Analysis
Problem Type Reference x
Cross-thread Stack Access Data Race Deadlock GDI Resource Leak Incorrect memcpy Call Invalid Deallocation Invalid Memory Access Invalid Partial Memory Access Kernel Resource Leak Lock Hierarchy Violation Memory Growth Memory Leak Memory Not Deallocated Mismatched Allocation/Deallocation Missing Allocation Thread Exit Information Thread Start Information Unhandled Application Exception Uninitialized Memory Access Uninitialized Partial Memory Access
Command Line Interface Support x
Command Syntax Command Syntax Alternatives and Rules Command Line Output Collecting Result Data from the Command Line Working with Reports from the Command Line Working with Suppressions from the Command Line inspxe-cl Actions, Options and Arguments
Working with Reports from the Command Line x
Reporting Result Data from the Command Line Saving and Formatting Reports from the Command Line Saving a Report to a File Example Generating a Report in CSV File Format CSV Report Example Sorting Report Data Data Sorting Example Filtering Report Data Report Filtering Examples See Also Interpreting Result Data from the Command Line
Working with Suppressions from the Command Line x
Creating a Suppress-All File from the Command Line Converting Third-Party Suppression Files from the Command Line Applying Suppression Files from the Command Line Workaround for Disabled Suppressions from the Command Line
inspxe-cl Actions, Options and Arguments x
app-working-dir archive-name baseline-result collect collect-with command convert-suppression-file create-suppression-file csv-delimiter executable-of-interest export filter finalize format help include-snippets include-sources import knob knob-list merge-states module-filter module-filter-mode no-auto-finalize no-summary option-file quiet report report-all report-output result-dir return-app-exitcode search-dir sort-asc sort-desc suppression-file user-data-dir verbose version
MPI Applications Support x
MPI Analysis Workflow Configure Installation Options Collect MPI Performance/Correctness Data Finalize MPI Collected Data View MPI Collected Data MPI Analysis Limitations Support of Non-Intel MPI Implementations Additional MPI Resources
Appendix x
Product Design Sample Code Caveats Intel Inspector Filenames and Locations Notational Conventions Related Information System APIs Supported During Memory Error Analysis System APIs Supported During Threading Error Analysis Evaluation Features
Intel® Inspector User Guide for Windows* OS

Saving and Formatting Reports from the Command Line

By default, a report is written to stdout in text format, but the Intel Inspectorinspxe-cl command provides a number of options you can use when generating a report.

Saving a Report to a File

To save a report to a file, you must use the report-output option when generating a report, and specify a pathname for the output file. By default, most reports are saved as a text file, but you can also choose CSV or XML. Whichever file type you choose, filtering and sorting options are available for formatting your report.

Example

Generate a status report from the most recent result and save it as status-report.txt file in the current working directory.

$ inspxe-cl -report status -report-output status-report.txt

Generating a Report in CSV File Format

Use the format option with the CSV format.

If you choose the CSV format and want to use a delimiter other than the default comma, you must use the csv-delimiter option to specify either a comma or tab delimiter.

CSV Report Example

Generate an observations report in CSV format using tab delimiters, and save it as observations.csv.

$ inspxe-cl -report observations -format csv -csv-delimiter tab -report-output ./out/observations.csv

Sorting Report Data

There are a pair of options that you can use to sort report data: sort-asc and sort-desc. Use the sort-asc action-option to organize a report in ascending order of the specified field(s), or use sort-desc to sort it in descending order. You can specify up to three different fields.

Data Sorting Example

Generate a problems report from the most recently collected result, and display the problems by line number in ascending order.

$ inspxe-cl -report problem -sort-asc line

Filtering Report Data

You can filter a report by specifying columns and values that should be included or excluded, and these can be used singly or in combination.

Syntax

-filter | -f <column_name> = <value>

To display data that equals the specified values only, run the amplxe-cl command with the report action and filter option as follows:

$ inspxe-cl -report <report_type> -filter <column_name> = <value>

where

  • <column_name> is the column name (module, function, and so on)

  • <value> is the value to include

Specify multiple filter items by using multiple -filter option attributes.

NOTE:

  • Multiple values for the same column are combined with 'OR'.

  • Values for different columns are combined with 'AND'.

Report Filtering Examples

Generate a Problems report that only includes problems in the source file combine.cpp that have not yet been investigated.

$ inspxe-cl -report problems -filter source=combine.cpp -filter investigated=not_investigated

Generate a Problems report, filtering it so that only critical problems are reported.

$ inspxe-cl -report problems -user-data-dir "My Inspector Results - myProjectName" -f severity=critical

Parent topic: Working with Reports from the Command Line
Level Two Title