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 Available States Typical Usage Model State Propagation States and Filters States Hierarchy 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

States

To avoid investigating issues over and over again, save your investigative conclusions by assigning states to the issues you investigate.

State information is persistent within the Intel Inspector result, including when you reopen the result.

Intel Inspector also propagates state information from an older result to a newer result when you take advantage of various baseline result options.

Available States

Intel Inspector offers the following states:

Filter Criterion

Set By

State

Meaning

Not investigated

Intel Inspector

Regression

The issue requires more investigation because it was marked as Fixed in the baseline result, but still appears.

New

The issue did not appear in the baseline result, or there is no older result from which the Intel Inspector can propagate state information.

Intel Inspector or User

Not Fixed

The issue appeared in the baseline result and still requires investigation.

Investigated

User

Confirmed

The issue requires fixing but has not yet been fixed.

TIP:

Report Confirmed issues in a bug tracking system.

Fixed

The issue requires fixing and has been fixed.

Not a problem

The issue does not require fixing.

Deferred

You are postponing further investigation on an issue that may or may not require fixing.

Typical Usage Model

  1. Use the default Get problem states from previous result of same analysis type baseline result option.

  2. Run an analysis.

  3. Use the filtering function to temporarily limit the displayed issues to only those that are Not investigated.

  4. Set the state of each problem issue you investigate as:

    • Confirmed - Issue requires fixing but has not yet been fixed.

    • Fixed - Issue requires fixing and has been fixed.

    • Not a Problem - Issue does not require fixing.

    • Deferred - Delay further investigation.

  5. The next time you rerun the analysis, verify the issues you expect to be fixed are indeed fixed.

State Propagation

Intel Inspector propagates state information from the baseline result when it determines an issue in a new result corresponds to an issue in the baseline result. For example, if you set the state for a problem in the baseline result to Not a Problem, the Intel Inspector sets the state for the corresponding problem in the new result to Not a Problem.

The only exception: If you set an issue state to Fixed in the baseline result but the issue still appears in the new result, the Intel Inspector sets the issue state to Regression in the new result.

CAUTION:

Intel Inspector may not recognize an issue as previously investigated when it propagates state information from a baseline result. This is more likely to happen when source code has undergone drastic changes between analysis runs.

States and Filters

Use the Intel Inspector filtering to focus on issues in specific states. For example, in the Filters pane on the Summary window:

  • In the Investigated category, choose Not investigated to reduce clutter by displaying only issues with a state of New, Not fixed, or Regression.

  • In the State category, choose Confirmed to review issues that are - or should be - reported in your bug tracking system.

  • In the State category, choose New to concentrate on issues introduced since the last analysis run.

  • In the State category, choose Regression to verify all issues marked as Fixed in the baseline were successfully fixed.

  • In the State category, choose Not a problem to double-check earlier conclusions that no fix is needed.

States Hierarchy

When you change the state of a problem set, the Intel Inspector responds by similarly changing the state of all problems currently in the problem set.

In scenarios where a problem set contains problems with different states (such as when source code changes introduce a new instance of a problem previously set to a non-new state), the Intel Inspector assigns the most severe state to the problem set according to this hierarchy:

  1. Regression (most severe state)

  2. New

  3. Not Fixed

  4. Confirmed

  5. Fixed

  6. Not a Problem

  7. Deferred (least severe state)

Parent topic: Interpreting Result Data and Resolving Issues

See Also

Level Two Title