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 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

Defining Suppression Rules in the GUI

Prerequisite: Apply suppressions when you configure a project.

To create a suppression rule to help you focus during future analysis runs on only those issues that require your attention:

  1. Choose problems to suppress during future analysis runs.

  2. Identify the new rule by name and storage location.

  3. Widen the default rule reach to suppress the greatest number of relevant problems.

  4. Save the rule.

TIP:

  • Although you are ultimately trying to suppress problems, the Intel Inspectorvehicle for defining a suppression rule is one or more code locations.

  • Narrow rules suppress a limited number of relevant problems; wider rules suppress a greater number of relevant problems.

  • Every rule applied during analysis adds processing time.

  • The goal: Suppress the greatest number of relevant problems with the fewest number of rules.

  • To review rules to be applied during analysis, check the Suppressions tab of the Project Properties dialog box.

  • To apply rules during analysis, select the Apply Suppressions radio button on the Target tab of the Project Properties dialog box.

  • A code location may be part of multiple problems; therefore, multiple rules may suppress the same code location, or a rule created to suppress one problem may partially impact another problem.

1. Choose Problems to Suppress During Future Analysis Runs

  1. In the Code Locations pane, right-click a code location for an occurrence of the problem you want to suppress during future analysis runs.

  2. In the context menu, choose Suppress....

Outcome: The Intel Inspector displays the Create Suppression dialog box. The Rule grid in the center of the dialog box shows the right-clicked code location and any related code locations in the specific occurrence of the problem.

2. Identify the new rule by name and storage location

  1. In the Name text box, type a short description to distinguish the new rule from other rules.

  2. If you want to store the new rule somewhere besides the default location, browse to and choose a filename and/or location.

TIP:

Choose a non-default location only to make the rule easily accessible to others.

3. Widen the default rule reach to suppress the greatest number of relevant problems

By default, the Intel Inspector drafts a rule that suppresses problems based on:

  • A specific problem type

  • All the code locations in the problem occurrence

  • A specific module, function, source, and line in the last-called stack frame in each code location.

To widen the rule reach, try one or more of the following - do not suppress problems by:

  • A specific problem type - In the Problem type drop-down list, click the drop-down arrow and choose * (any).

  • A specific code location - In the Rule grid, deselect the code location checkbox.

  • A specific code location description - In the Code Location Description drop-down list, click the drop-down arrow and choose * (any).

    NOTE:

    There are three Code Location Description possibilities: Allocation site, Deallocation site, and * (any). Memory error example: If you right-click a Mismatched allocation site code location for an occurrence of a Mismatched allocation/deallocation problem, the Intel Inspector displays one code location marked Allocation site and one code location marked * (any); you can click the drop-down arrow to change Allocation site to * (any). Threading error example: If you right-click a Read code location for an occurrence of a Read/Write Data race problem, the Intel Inspector displays two code locations marked * (any) and does not provide drop-down arrows.

  • A specific stack frame module, function, source, and line number -

    1. Click a code location Edit button to open the Select Stack Frame(s) dialog box.

    2. Notice you can select a different stack frame or multiple stack frames as the rule focus.

    3. In the Module, Function, Source, and/or Line drop-down list for each selected stack frame, click the drop-down arrow and choose * (any)

TIP:

  • A single code location with all but one characteristic set to * (any) is ideal for widening a rule to suppress the greatest number of relevant problems.

  • Suppression rules are more robust if you specify a stack with multiple frames instead of frames with line numbers. (Because line numbers can be altered by code insertions or deletions, suppressions may be rendered ineffective by even minor code maintenance. Stack-based suppressions require larger code changes to invalidate them, such as changes to function call sequences.)

4. Save the Rule

Click the Create button.

Outcome

Outcome:

  • Intel Inspector saves the new suppression rule in a .sup file.

  • In the Code Locations and Problems panes, the Intel Inspector marks (strikes through) all result data potentially impacted by the rule. (It may take some time for all marks to appear.) The marks remain in the result even if you close and then reopen the result.

    TIP:

    Review the marked data to assess the effectiveness and potential reach of the rule. If necessary, delete the rule and start over, or edit the suppression file in a text editor.

  • During the next analysis run, if Suppressions in the Target tab of the Project Properties dialog box is set to:

    • Apply suppressions - The Intel Inspector does not collect result data impacted by the suppression rules in files and directories specified in the Suppressions tab of the Project Properties dialog box.

    • Do not apply suppressions - The Intel Inspector ignores all suppression rules.

Parent topic: Suppressions Support Using the GUI

See Also

Level Two Title