Intel® Inspector User Guide for Windows* OS

Download PDF
ID 767798
Date 3/31/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 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 About Prioritization About Filtering by Inclusion About Filtering by Exclusion About Filtering by a Set of Source Files 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
About Prioritization About Filtering by Inclusion About Filtering by Exclusion About Filtering by a Set of Source Files 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 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

Choosing Problems

During analysis, the Intel Inspector displays problems in the order detected in the Problems pane.

After analysis is complete, the Intel Inspector:

  • Groups problems detected during analysis into problem sets (but still provides visibility into individual problems and problem occurrences).

  • Prioritizes the items in the Problems pane.

  • Offers filtering to help you focus on those items that require your attention. For example, you can temporarily limit the items displayed in the Problems pane by:

About Prioritization

Intel Inspector assigns problems a severity level: Critical (), Error () and Warning (). The severity indicates the seriousness of the defect.

Problem sets inherit the severity of the problems they contain. The Intel Inspector prioritizes problem sets first by severity and then by number of code locations. Problem sets containing more code locations precede those containing fewer.

Think of this prioritized list of items on the Problems pane as a to-do list. Start at the top and work down.

About Filtering by Inclusion

Use the Intel Inspector filtering function to temporarily limit the items in the Problems pane to only those problem sets containing problems that meet specific criteria.

For example, you can filter the list to show only those problem sets containing problems...

  • With Investigated=Not investigated to show only problem sets with a state of New, Not fixed, or Regression (that is, hide the problem sets you have already investigated)

  • Or with State=Not fixed and Severity=Error

  • Or with State=Not fixed and Severity=Error and Type=Data Race

  • Or in a specific file

About Filtering by Exclusion

Use the Intel Inspector filtering function to temporarily set aside occurrences of the same, possibly false positive, items en masse in the Problems pane. For example:

  1. In the Investigated category in the Filters pane on the Summary window, choose Not investigated to display only problems with a state of New, Not fixed, or Regression.

    NOTE:

    If this is the first result of this analysis type, or if you chose the Do not get problem states from another result option on the State Management page of the product Options dialog box during startup, all problems have a state of New.

  2. Click the Sort drop-down list in the Filters pane and choose Sort by Item Count to sort remaining problems by count in descending numerical order.

  3. In the Type category in the Filters pane, choose the problem type with the highest item count to display only those problems in the Problems pane.

  4. Click on any problem in the Problems pane, then press Ctrl+A to select all problems.

  5. Right-click any of the selected problems to display a context menu, then choose Change State > Not a Problem to change the state of all selected problems.

  6. In the Type category, click the All button to deselect problem criteria.

  7. Repeat steps 3 - 6 for each problem type with many occurrences.

  8. Start working the remaining problems.

Be aware that when you temporarily set aside problems en masse, you may inadvertently set aside a problem of interest. For example, if you are not responsible for problems in source file A and you:

  1. Use the filtering function to select all problems in source file A.

  2. Set the state for all problems in source file A to Not a problem.

Some of these problems may touch more than one source file. When you filter on a source file, you filter on all problems intersecting that source file. The fact that a problem has some intersection with a file for which you are not responsible does not mean the problem does not concern you.

However if you are responsible for source files A, B, and C, you can filter first to source file A, then to source file B, then to source file C. You may see some problems more than once, but you will ultimately investigate all problems in files for which you are responsible.

About Filtering by a Set of Source Files

Use the Intel Inspector filtering function to temporarily limit the items in the Problems pane to those from a set of source files.

Parent topic: Investigating Results
Level Two Title