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

inspxe-cl Actions, Options and Arguments

This reference provides details on all options supported by the Intel Inspectorinspxe-cl command tool.

Command options are categorized as follows:

  • action: The action that the command performs, such as collect data or generate a report. You must specify exactly one action per command.

  • action-option: Defines a behavior applicable to the specified action. Only use action-options that are supported by the action, or a usage error will result. You may have one or more supported action-options per command.

  • global-option: Defines a behavior applicable to all actions. You may have one or more global-options per command.

Action-Option Usage Rules:

  • If opposing action-options are used on the same command line, the last specified action-option applies.

  • An action-option that is redundant or has no meaning in the context of the specified action is ignored.

  • Attempted use of an inappropriate action-option which would lead to unexpected behavior returns a usage error.

Actions

Action

Purpose

collect

Run a memory or threading error analysis and data collection.

collect-with

Run an analysis and data collection with advanced knob settings.

command

Perform an action on a running analysis.

create-breakpoints

Add breakpoints to a baseline analysis result.

create-suppression-file

Generate a suppression file for all problems detected in a result.

export

Export a result file, optionally including code snippets and sources, to an archive file.

finalize

Redo symbol resolution for an existing result.

help

Display up-to-date information for all available command-line actions.

import

Create a new result from a legacy Intel Inspector result or raw data file.

knob-list

List knobs for the specified analysis type.

merge

Merge problem states from one result into another result.

report

Generate a summary, list of problems, or list of code locations report.

version

Display product version information.

Parent topic: Command Line Interface Support
  • appdebug
    Set when to enable the debugger.
  • app-working-dir
    Specify the directory where the application will be run.
  • archive-name
    Provide the filename when exporting results to an archived file.
  • baseline-result
    Propagate states and annotations from a specified baseline result when performing analysis or generating a report.
  • collect
    Run the specified type of analysis and collect data.
  • collect-with
    Run the collector with specified knob settings to perform analysis and data collection.
  • command
    Perform the specified action on a running analysis.
  • convert-suppression-file
    Convert a third-party suppression file for use with Intel Inspector.
  • create-breakpoints
    Set breakpoints for problems in a result to investigate with the debugger.
  • create-suppression-file
    Generate a suppression file for all detected problems in the specified result.
  • csv-delimiter
    Specify the delimiter when generating a report in tabular format.
  • debug-this
    Perform an analysis using the Intel(R) Debugger.
  • executable-of-interest
    Specify which executable to analyze.
  • export
    Export collected results and store as an archived file.
  • filter
    Specify filtering for a report.
  • finalize
    Resolve symbols and form problems sets to finalize an existing result.
  • format
    Specify the output format for a report.
  • help
    Display explanations of command line arguments.
  • include-snippets
    Include snippets when exporting results for archiving.
  • include-sources
    Include sources and snippets when exporting results for archiving.
  • import
    Import data collected using legacy Intel products.
  • knob
    Specify additional settings for a collect or collect-with action.
  • knob-list
    Display configurable settings for a collect or collect-with action.
  • merge-states
    Merge problem states from a result into problem states in another copy of the same result.
  • module-filter
    Set a filter to specify which application modules to analyze.
  • module-filter-mode
    Exclude filtered application modules from analysis.
  • no-auto-finalize
    Perform collection without finalizing the result.
  • no-summary
    Suppress the display of a summary after a collect action.
  • option-file
    Specify one or more files containing command line options.
  • quiet
    Suppress non-essential information.
  • report
    Generate a report from result data collected during a previous analysis.
  • report-all
    Create a detailed report particularly useful for regression testing purposes.
  • report-output
    Output a report file with the specified pathname.
  • result-dir
    Specify the directory where the result is stored.
  • return-app-exitcode
    Return the exit code from the target application.
  • search-dir
    Specify an alternative location(s) for finding application support files.
  • sort-asc
    Sort report data by specified field(s) in ascending order.
  • sort-desc
    Sort report data by specified field in descending order.
  • suppression-file
    Use rules defined in a suppression file to exclude known problems during collection.
  • user-data-dir
    Specify the base directory for result paths.
  • verbose
    Print additional information.
  • version
    Display product version information.
Level Two Title