Intel® Inspector User Guide for Linux* OS

Download PDF
ID 767796
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 Linux* OS
Intel® Inspector User Guide for Linux* OS x
Get Started Before You Begin Set Up a Project Collecting Results Investigating Results Testing 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 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
Extended Debugging Commands 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
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 Specifying Suppression Files Using an Option File to Pass in Multiple Suppression Files Applying Suppression Files During Analysis Applying Suppression Files When Generating a Problems Report 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 <span class='option'>csv-delimiter</span> 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

Applying Suppression Files from the Command Line

After creating or converting suppression files, you can apply suppression files during analysis, finalization (symbol re-resolution) or when generating a report. There are several ways to pass suppression files to the Intel Inspectorinspxe-cl command tool, including passing them in through an option file, which can be useful when you have many suppression files.

Ideally, a suppression file should be created for a specific analysis type, as described in Creating Suppression Files.

To make it easy to switch between the GUI and the command line, store suppression files in the standard suppressions directory: ./My Inspector Results-[project name]/suppressions.

NOTE:

Suppression files can be used along with other problem-suppression tactics, such as assigning a problem the Not a Problem state, then filtering out all problems with this state when viewing problems in the GUI or generating a report on the command line. You can also propagate this state assignment forward into other results using one of the following techniques:

  • To merge problem state assignments from one existing result to another, use the merge-states option. State assignments from the merge-from result are used to update state assignments in the merge-to result. Problem states in the merge-to result are edited according to a set of rules.

  • To propagate problem state assignments forward when performing analysis, finalization or generating a report, use the baseline-result option.

Specifying Suppression Files

Depending on the number of suppression files you want to apply and their locations, you may want to specify a single suppression file, multiple individual suppression files, or the suppressions directory, as shown in these examples. The example commands all perform analysis using the ti2Detect Deadlocks and Data Races analysis type, and the project is named myTi2Analysis.

Single Suppression File

If you want to use a single suppression file only, for example, you may have created a suppress-all file on the command line, you can specify just this one file. In this command, a suppress-all file myTi2SuppressAllFile is specified when running an analysis.

$ inspxe-cl -collect ti2 -s-f "./My Inspector Results-myTi2Analysis/suppressions/myTi2SuppressAllFile"

Example: Multiple Individual Suppression Files, Possibly with Different Paths

You may want to specify multiple individual suppression files if you have suppression files stored in multiple directories, or if you only want to apply some of the suppression files stored in your project's suppressions directory. Use one of these two syntax variations when you want to pass in multiple individual suppression files.

Specify the suppression-file option followed by a comma-separated string of suppression file PATH/names (no spaces).

$ inspxe-cl -collect ti2 -s-f "./My Inspector Results-myTi2Analysis/suppressions/myTi2SuppressAllFile","./My Inspector Results-myTi2Analysis/suppressions/myTi2SuppressAllFile5" -- myApp

Or specify the suppression-file option multiple times, each one followed by a suppression file PATH/name.

$ inspxe-cl -collect ti2 -s-f "./My Inspector Results-myTi2Analysis/suppressions/myTi2SuppressAllFile"-s-f "./My Inspector Results-myTi2Analysis/suppressions/myTi2SuppressAllFile5" -- myApp

NOTE:

It is easiest to use an option file to pass in multiple suppression files, as explained in the next section.

Example: Multiple Suppression Files in a Single Suppressions Directory

If you have multiple suppression files in the same directory and want to apply all the suppression files in this directory, you can simply specify the directory.

$ inspxe-cl -collect ti2 -s-f "./My Inspector Results-myTi2Analysis/suppressions" -- myApp

Using an Option File to Pass in Multiple Suppression Files

If you have multiple suppression files but cannot specify the suppressions directory as described above, you can use the option-file option to pass in an option file with the suppression-file option and arguments. The option file is a plain text file with each option and its arguments followed by a newline. As you create new suppression files, you can add them to the option file as desired.

This option file is named myOptionFile. It specifies suppression files from three different directories, including a suppress-all file from the baseline result directory, all suppressions from a suppressions directory that holds converted suppression files, and the latest suppression file from the current result directory. 

-s-f "./BaselineResult/suppressions/myTi2SuppressAllFile" 
-s-f "./suppressions/"
-s-f "./myNewTi2Results/suppressions/myNewSuppressions"

Now myOptionFile is passed into the analysis process, so all the suppression files specified in myOptionFile are applied.

$ inspxe-cl -collect ti2 -option-file ./myOptionFile -- myApp

Applying Suppression Files During Analysis

Use the collect or collect-with action with the suppression-file option to pass in one or more suppression files.

As previously described, it is easiest to configure analysis through the Intel Inspector GUI, then use the Dialog Box Corresponding inspxe-cl Command Options to copy the command with the analysis type and other arguments to your clipboard, and then save it for use on the command line or in scripts.

In this example, the collect action is used with the ti2Detect Deadlocks and Data Races analysis type. The command is simplified, so all other analysis settings are left to default. This command:

  • Runs a Detect Deadlocks and Data Races (ti2) analysis on the application myApp.

  • Uses the short name -s-f for the suppression-file option.

  • Specifies the suppression directory, rather than individual suppression files. When the directory is specified, the inspxe-cl command tool applies all suppression files in this directory.

  • To make it easy to switch between the GUI and the command line, the suppression files were stored in the standard location for suppression files: ./My Inspector Results-[project name]/suppressions.

$ inspxe-cl -collect ti2 -s-f "./My Inspector Results-[project name]/suppressions" -- myApp

Applying Suppression Files When Generating a Problems Report

If a suppression file was not used during analysis and data collection, it can be applied when generating a Problems report. Use the report action with the suppression-file option to pass in one or more suppression files, or a suppressions directory. For most complete suppression of problems, the suppression file should be based on the same analysis type as the result.

This simple report-generation command uses all default settings except that it:

  • Uses a result from a Deadlocks and Data Races (ti2) analysis.

  • Uses the short name -s-f for the suppression-file option.

  • Generates a Problems report of only new, unsuppressed problems.

$ inspxe-cl -report problems -s-f "./My Inspector Results-[project name]/suppressions/myTi2SuppressAllFile"

Parent topic: Working with Suppressions from the Command Line

See Also

Level Two Title