Intel® Inspector User Guide for Windows* OS

Download PDF
ID 767798
Date 7/13/2023
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 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 GUI Equivalent Syntax Arguments Default Modifiers Description Examples See Also 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

Perform the specified action on a running analysis.

GUI Equivalent

Toolbar: Command

Syntax

-command <value>

-C <value>
NOTE:

Both short names and long names are case-sensitive. For example, -c is the short name of the collect action, and -C is the short name of the command action.

Arguments

Possible values are:

stop

Terminate target execution and collection for a threading or memory error analysis.

reset-leak-tracking

Reset the start point for finding memory leaks in the currently running memory error analysis. The default start point is the application start.

find-leaks

Search for new memory leaks since the currently running memory error analysis started (default) or since the last reset. View findings - in the form of zero, one, or more Memory leak problems - in the Problem report or GUI Problems pane. See Description section for prerequisites.

reset-growth-tracking

Reset the start point for measuring memory growth in the currently running memory error analysis. The default start point is the application start.

measure-growth

Measure memory growth since the currently running memory error analysis started (default) or since the last reset. View findings - in the form of one Memory growth problem - in the Problem report or GUI Problems pane. See Description section for prerequisites.

Default

The action is performed in the current working directory.

Description

NOTE:

If you use the result-dir option to specify the result directory during analysis and data collection, you must use it when issuing these commands.

Use the command action to:

  • Terminate the currently running threading or memory error analysis.

  • Find memory leaks on demand in the currently running memory error analysis.

  • Measure memory growth in the currently running memory error analysis.

On-demand Memory Leak and Memory Growth Detection

Prerequisites: On-demand memory leak detection and memory growth detection commands are valid only for the mi2 or mi3 analysis types. The knobs that support on-demand memory leak detection and memory growth detection are enabled in these analysis types by default: enable-on-demand-leak-detection and enable-memory-growth-detection.

Use command with find-leaks and reset-leak-tracking to gather memory leak information while an application is running. This is useful if:

  • An application does not terminate (such as a server process).

  • You want memory leak information, but you do not want to wait for an application to terminate.

  • You want to determine if memory is leaked during a specific interval of application execution, or during a specific user action.

  • You want to discard information about allocations performed during initialization as a way of filtering out allocations that are not currently of interest.

Use command with measure-growth and reset-growth-tracking to ensure an application uses no more memory than expected. This includes:

  • Memory an application has allocated and still needs for future calculations

  • Memory an application has allocated and no longer needs, but has not deallocated

  • Memory an application has allocated and then leaked

For more precision, consider using these commands in tandem with APIs for custom memory allocation.

Examples

Terminate the analysis and data collection process that is currently running and storing the result in the myRes result directory. 

$ inspxe-cl -command stop -result-dir myRes

After starting an analysis on the command line that is storing a result in the myRes result directory, measure memory growth from application start to this point. Note that the result directory used when starting the collection must be specified in all subsequent commands operating on that result. The command has no effect if myRes does not match a result directory for a currently running collection. 

$ inspxe-cl -command measure-growth -result-dir myRes
Parent topic: inspxe-cl Actions, Options and Arguments
Level Two Title