Intel® Inspector User Guide for Windows* OS

Download PDF
ID 767798
Date 5/15/2022
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 Collecting Results Investigating Results Testing 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 Setting Target Application Properties-Basic
Collecting Results x
Configuring Analyses Running Analyses Examining Result Data During Analysis
Configuring Analyses x
Memory Error Analysis Types Threading Error Analysis Types Managing Custom Analysis Types
Running Analyses x
Running Memory Error and Threading Error Analyses Stopping Analyses
Examining Result Data During Analysis x
Finding Memory Leaks On Demand Measuring Memory Growth
Investigating Results x
Viewing Results Choosing Problems Interpreting Result Data and Resolving Issues Investigating Problems Using Interactive Debugging Collaborating on Results Exporting and Importing Files Comparing Results
Viewing Results x
About Viewing Results Managing Help Snippet Displays Opening Results Showing Result Summaries
Choosing Problems x
Deselecting Filter Criteria Refining the Source File Set Selecting Filter Criteria Selecting Problems
Interpreting Result Data and Resolving Issues x
Severity Levels States Accessing Explain Problem Help Changing States Customizing Frame Presentation Customizing Data Columns Editing Source Code
Investigating Problems Using Interactive Debugging x
Intel Inspector Debug Extensions in the Visual Studio* IDE Disabling and Re-enabling Problem Breakpoints Stopping Analyses During Interactive Debugging
Collaborating on Results x
State Merge Merging States Across Results Reporting Result Data
Exporting and Importing Files x
Exporting Archives Importing Archives and Other Files
Testing for Regressions x
Testing for Regressions: Recommended Approach Testing 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 convert-suppression-file create-suppression-file <span class='option'>csv-delimiter</span> 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

Pane: Code Locations

Pane position in window

To access this Intel Inspector pane: Click the Summary button on the Navigation toolbar.

During Analysis

Use this pane on the Summary window to:

  • View code locations for selected problems.

  • Choose problem occurrences of interest to display in the Sources window.

  • Edit corresponding source code in your default editor.

After Analysis is Complete

The Intel Inspector displays this pane after analysis is complete and when you open a result. Use this pane on the Summary window to:

TIP:

The number of problem occurrences available for display in this pane depends on how you configure the analysis. For future analysis runs:

  • Deselect the Remove duplicates checkbox on the Analysis Type window to report all occurrences of a detected problem. Deselecting is:

    • Useful when you need to fully visualize all threads and problem occurrences in relation to time

    • Low cost in terms of performance; however, the number of detected problem occurrences could be significantly higher and may require more system resources for storage and processing

  • Select the Remove duplicates checkbox to report only a representative occurrence of each detected problem.

Use This

To Do This

Pane title

Verify the type of the selected problems.

Pane controls

  • Review code location, surrounding source code snippet, call stack, and timeline information for all code locations in:

    • An occurrence of the selected problems (move the slider control, click or , or press Ctrl+Left Arrow or Ctrl+Right Arrow).

    • All occurrences of the selected problems (click the All button to toggle on and off).

  • Hide/show this pane (click or ).

Code location region

  • Review summary information for a code location in a problem occurrence.

  • Review a source code snippet surrounding a code location. (The yellow highlight marks the code location source line.)

  • Review the call stack for a problem occurrence.

  • Identify the thread associated with a code location (click to color the code location marker blue in the Timeline pane).

  • Choose a problem or problem occurrence of interest to display in the Sources window (double-click).

Data column header

  • Reposition the data column (drag).

  • Resize the data column (drag left or right border).

  • Sort code locations in ascending or descending order by column data (click). (Enabled only after analysis is complete.)

Pane border

Resize the pane (drag).

Context menu

  • View Source - Display a Sources window focused on the selected problem occurrence. (Default action when you double-click a data row in the Code Locations pane.)

  • Edit Source - Open the source file for the selected code location in your default editor.

  • Copy to Clipboard - Copy a summary of the selected code location to the system clipboard.

  • Explain Problem - Explain, in generic terms, the error associated with the code.

  • Create Problem Report... - Export details of the selected code location to plain text format. (Enabled only after analysis is complete.)

  • Suppress... or Do Not Suppress... -

    • Create a rule to suppress problems associated with the selected code location during the next analysis run. (Intel Inspector marks - with strikethroughs - problems potentially impacted during the next analysis run.)

    • Or delete a rule for a marked code location. (Strikethroughs disappear.)

    (Enabled only after analysis is complete.)
    NOTE:

    You can also delete suppression rules using the Suppressions tab of the Project Properties dialog box.

  • Show Source Code Snippets - Display or not display several source code lines surrounding each code location. (The yellow highlight marks the code location source line.)

Parent topic: User Interface Reference

See Also

Level Two Title