Intel® Inspector User Guide for Linux* OS

Download PDF
ID 767796
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 Linux* OS
Intel® Inspector User Guide for Linux* OS x
Get Started Before You Begin Set Up a Project Collect Results Investigate Results Test for Regressions Use Cases 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
Intel Inspector GUI Startup Tasks
Startup Tasks x
Change Result and Result Directory Name Templates Choose Baseline Results for Setting States Choose Debuggers Display Application Output
Set Up a Project x
Build Your Application Choose Projects Configure Projects
Choose Projects x
Choose Projects in the Intel Inspector GUI Create Projects in the Intel Inspector GUI
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
Extended Debugging Commands Command Argument: prob-brk-id Command Argument: type Available Commands See Also 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
Use Cases x
Analyze Offloaded Code
Analyze Offloaded Code x
Example: Memory Problem Example: Threading Problem
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
User Interface Reference x
Context Menus: Project Navigator 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: Export Result Dialog Box: Merge States Dialog Box: Options-Debugger 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: 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
Asynchronous Buffer Cross-thread Stack Access Data Race Deadlock Host Pointer Used on Device Incorrect memcpy Call Invalid Deallocation Invalid Kernel Argument Invalid Kernel Argument Size Invalid Memory Access Invalid Partial Memory Access Lock Hierarchy Violation Memory Growth Memory Leak Memory Not Deallocated Mismatched Allocation/Deallocation Mismatched Queue Missing Allocation Non-Host Pointer Pointer from Different Device 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
appdebug app-working-dir archive-name baseline-result collect collect-with command convert-suppression-file create-breakpoints create-suppression-file csv-delimiter debug-this 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 Linux* OS

Extended Debugging Commands

Intel Inspector offers a set of command extensions to use within an interactive debugging session during analysis.

Command Argument: prob-brk-id

prob-brk-id is an integer value that identifies the problem breakpoint you want to disable or re-enable. The debugger displays this number prior to the problem description when reporting a breakpoint, as in the 1 value shown in the following example: 1: Stopped at invalid write.

You can view valid prob-brk-id values using the show-problem-breakpoints command extension.

NOTE:

Do not confuse prob-brk-id values assigned by the debugger with problem IDs prefaced with the letter P in Intel Inspector result data.

Command Argument: type

type identifies the problem types you want to stop or not stop at during execution. Choose from the following according to the type of analysis: memory or threading.

Memory Problem Breakpoint Types

Description

mcpinvalid

Incorrect memcpy call

dinvalid

Invalid deallocation

rinvalid

Invalid memory access

winvalid

rpinvalid

Invalid partial memory access

dmm

Mismatched allocation/deallocation

runinit

Uninitialized memory access

rpuninit

Uninitialized partial memory access

all

All valid memory problem types

Threading Problem Breakpoint Types

Description

rwrace

Data race

wwrace

ddlk

Deadlock

lahv

Lock Hierarchy Violation

all

All valid threading problem types

NOTE:

Memory and resource leak problem types are not included because they are detected after execution completes and therefore cannot result in breakpoints.

Available Commands

Preface all extended debugging commands with monitor to alert the debugger to pass them to the Intel Inspector command handler.

Use This Command Prefaced With monitor

To Do This

begin-analysis

Short form: ba

Begin analyzing and reporting problems.

Use after starting an analysis configured with the Select analysis start location with debugger option.

NOTE:

You cannot stop and restart the analysis at a subsequent code breakpoint.

break-problem-type [type [type] [...] on | off]

Short form: bpt [type [type] [...] on | off]

NOTE:

This command is not available if you start the interactive debugging session using the Debug This Problem function.

Turn on or off breaking on specific problem types.

Available problem types differ for memory and threading analyses. Use the help extended debugging command to display the appropriate list.

In this example, the debugger breaks during a memory analysis only when problem breakpoints for invalid memory accesses are detected: 

monitor break-problem-type rinvalid winvalid on

In this example, the debugger breaks during a threading analysis for all detected problem breakpoints except deadlocks. 

monitor break-problem-type ddlk off

If you omit arguments: The Intel Inspector show the current status (on or off) of all problem breakpoint types for the analysis type.

disable-problem-breakpoint prob-brk-id

Short form: dpb prob-brk-id

Do not break at the specified problem breakpoint if it is detected again.

This command is most useful for a problem breakpoint that occurs multiple times, such as inside a loop.

Disabled problem breakpoints are not persistent between analysis runs.

enable-problem-breakpoint prob-brk-id

Short form: epb prob-brk-id

Resume breaking at the specified problem breakpoint if it is detected again.

help

Display the list of extended debugger commands provided by the Intel Inspector.

show-last-problem

Short form: slp

Show the problem breakpoint ID and a short description for the last-detected problem.

If execution is currently stopped at a problem breakpoint, the debugger displays information for the current problem.

show-problem-breakpoints

Short form: spb

Show a list of problem breakpoint IDs with short problem descriptions.

If you use the Debug This Problem function to launch the interactive debugging session, this list contains only the set of selected problems and does not change. Otherwise, this list starts empty and grows as each problem breakpoint is encountered.

Parent topic: Investigate Problems Using Interactive Debugging
Level Two Title