Intel® Inspector User Guide for Windows* OS

Download PDF
ID 767798
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

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 Result Directory Result File Summary Output, Log and Errors Exit Codes Suppression Files Reports See Also 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 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

Command Line Output

Output from the Intel Inspectorinspxe-cl command includes the following:

Result Directory

A collect or collect-with action generates a result directory to contain the analysis result.

By default, the result directory name is r@@@{at} where:

  • @@@ - next available number for similarly named result directories in the current working directory. The series begins with 000.

  • {at} - analysis type code. This code represents the analysis type used when the result was created.

For example: r001ti3, where:

  • 001 - next available number

  • ti3 - the selected analysis type (ti stands for "threading error analysis" and 3 indicates that this uses the level 3 setting, which is the highest setting. The ti3 analysis type is known as the Locate Deadlocks and Data Races setting.)

The result directory name may be assigned according to the default naming conventions, or you may use the result-dir option to specify the result directory name during collection. Your specified result directory name can include up to five @ counters, so the result directory can be specified in scripts without having to update the result directory value each time.

By default, result directories are created in the current working directory. If you want to specify an alternative location, use the user-data-dir option to specify the parent directory for result directories. If you use this option during collection, remember to include it for any other actions you might perform on these results, such as generating reports.

CAUTION:

You cannot put multiple results into the same result directory. If you specify the same result directory for multiple analysis runs, an error is returned. Use the auto-increment counter (@@@) to work around this restriction.

Result File

During a collect or collect-with action, the inspxe-cl command tool creates a result directory in which it stores the *.inspxe result file. In addition to analysis data, the result file stores data about the analysis environment, including start time, host machine name, product ID, CPU count, and analysis type used for collection.

The result filename is derived from the result directory name. For example: If the result directory name is r001ti3, the result filename is r001ti3.inspxe.

Summary Output, Log and Errors

At the end of an analysis run, the inspxe-cl command tool also writes the following files to the result directory:

  • inspxe-cl.txt: Summary that includes the total number of problems found and types of problems found.

  • inspxe-cl.log: Information useful to the Intel support team if the inspxe-cl command encounters internal errors

  • The summary is also written to stdout.

  • Internal errors are written to stderr.

Exit Codes

The inspxe-cl command returns the following exit codes:

0

Success and no new problems detected

1

Usage error

2

Internal error

4

Application returned a non-zero exit code

8

At least one new problem detected

12

Application returned a non-zero exit code and at least one new problem detected

NOTE:

Use the return-app-exitcode action-option if you want to return the application exit code instead of the inspxe-cl exit code.

Suppression Files

Suppression files can be created and used in the GUI or on the command line.

  • Suppression files that suppress all problems in the code (suppress-all files) can only be created from the command line.

  • Use the command line to convert third-party suppression files (Purify, Valgrind) to a format that can be used by Intel Inspector.

  • Once created, you can use suppression files when performing analysis or generating reports.

Reports

After collecting a result, you can use the report action to generate one or more types of reports from the result:

  • status: Brief statement of the total number of new problems found, and a breakdown by state.

  • problems: Detailed list of all new problem sets found, including their location in the source code.

  • observations: Detailed list of all code locations in the source code used to form new problem sets.

  • summary: This report is generated automatically in .txt form, but can also be generated on demand. Brief statement of the total number of new problems found, and a breakdown by problem type.

By default, the report is output in text format to stdout.

  • To write a report to a file, use the report-output option when generating the report.

  • To specify CSV or XML format, use the format option.

  • To control how a report displays, you can use the sort-asc, sort-desc and filter-include options.

  • To view a report from a result directory other than the default, use the result-dir option.

Parent topic: Command Line Interface Support
Level Two Title