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 Using Time-oriented Collection Control APIs in Your Code Using Object-oriented Collection Control APIs in Your Code Usage Example: Time-oriented Collection Control Usage Example: Object-oriented 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

APIs for Collection Control

Intel Inspector provides a set of collection control APIs to help you specify which parts of your application should be included in, or excluded from, analysis.

To support independence of implementation between library implementers and library users, the collection control APIs allow nesting by pushing and popping state information.

There are two kinds of collection control APIs:

  • Time-oriented APIs to control which time periods of thread execution to analyze or not analyze

  • Class-oriented APIs to control which data objects to analyze or not analyze

Using Time-oriented Collection Control APIs in Your Code

Use This in C/C++ Code

Use This in Fortran Code

To Do This 

void __itt_suppress_push( 
   unsigned int etype) 

subroutine itt_suppress_push(mask)
   integer, intent(in), value :: mask
end subroutine itt_suppress_push

Tell the Intel Inspector to stop analyzing for errors on the current thread.

C/C++

etype is:

  • __itt_suppress_memory_errors to stop analyzing for memory errors

  • __itt_suppress_threading_errors to stop analyzing for threading errors

  • __itt_suppress_memory_errors| _itt_suppress_threading_errors to stop analyzing for memory or threading errors

Fortran

mask is:

  • itt_suppress_memory_errors to stop analyzing for memory errors

  • itt_suppress_threading_errors to stop analyzing for threading errors

  • itt_suppress_all_errors to stop analyzing for memory or threading errors 

void __itt_suppress_pop (
   void) 

subroutine itt_suppress_pop()
end subroutine itt_suppress_pop

Tell the Intel Inspector to undo the action corresponding to the most recent matching nested push call.

Push calls nest and are additive, so the Intel Inspector does not resume analyzing for:

  • Memory errors until there are an equal number of pop calls corresponding to push calls for memory errors

  • Threading errors until there are an equal number of pop calls corresponding to push calls for threading errors

For errors that might involve two threads, the state the other thread was in at the time the memory operation happened is more important than the current thread state. For example:

  1. Thread A writes to variable X, then makes a push call.

  2. Thread B reads variable X.

Even though thread A is currently suppressed, neither thread was suppressed at the time the conflicting accesses occurred, so the race is reported.

Conversely:

  1. Thread A suppresses, writes to variable Y, then unsuppresses.

  2. Thread B reads variable Y.

Even though both threads are currently unsuppressed, the error is not reported because thread A was suppressed at the time the conflicting accesses occurred.

Using Object-oriented Collection Control APIs in Your Code

Use This in C/C++ Code

Use This in Fortran Code

To Do This 

void __itt_suppress_mark_range(
   __itt_suppress_mode_t mode,
   unsigned int etype,
   void * address,
   size_t size); 
subroutine itt_suppress_mark_range(
   action, mask, addr, size)
   integer, intent(in), value :: action
   integer, intent(in), value :: mask
   integer(kind=itt_ptr), intent(in), value :: addr
   integer(kind=itt_ptr), intent(in), value :: size
end subroutine itt_suppress_mark_range

C/C++

Tell the Intel Inspector to mark the memory range defined by address and size with the flags mode and etype.

mode is __itt_suppress_range or __itt_unsuppress_range.

etype is:

  • __itt_suppress_memory_errors to stop analyzing for memory errors

  • __itt_suppress_threading_errors to stop analyzing for threading errors

  • __itt_suppress_memory_errors | __itt_suppress_threading_errors to stop analyzing for memory or threading errors

addr is the address of the first byte to suppress.

size is the number of bytes to suppress.

Fortran

Tell the Intel Inspector to mark the memory range defined by addr and size with the flags action and mask.

action is itt_suppress_range or itt_unsuppress_range.

mask is:

  • itt_suppress_memory_errors to stop analyzing for memory errors

  • itt_suppress_threading_errors to stop analyzing for threading errors

  • itt_suppress_all_errors to stop analyzing for memory or threading errors

addr is the address of the first byte to suppress.

size is the number of bytes to suppress. 

void __itt_suppress_clear_range(
   __itt_suppress_mode_t mode, 
   unsigned int etype, 
   void * address, 
   size_t size); 

subroutine itt_suppress_clear_range(
   action, mask, addr, size)
   integer, intent(in), value :: action
   integer, intent(in), value :: mask
   integer(kind=itt_ptr), intent(in), value :: addr
   integer(kind=itt_ptr), intent(in), value :: size
end subroutine itt_suppress_clear_range

C/C++

Tell the Intel Inspector to clear the previously marked range defined by address and size with the flags mode and etype.

mode is __itt_suppress_range or __itt_unsuppress_range.

etype is:

  • __itt_suppress_memory_errors to stop analyzing for memory errors

  • __itt_suppress_threading_errors to stop analyzing for threading errors

  • __itt_suppress_memory_errors | __itt_suppress_threading_errors to stop analyzing for memory or threading errors

addr is the address of the first byte to not suppress.

size is the number of bytes to not suppress.

Fortran

Tell the Intel Inspector to clear the previously marked range defined by addr and size with the flags action and mask.

action is itt_suppress_range or itt_unsuppress_range.

mask is:

  • itt_suppress_memory_errors to stop analyzing for memory errors

  • itt_suppress_threading_errors to stop analyzing for threading errors

  • itt_suppress_all_errors to stop analyzing for memory or threading errors

addr is the address of the first byte to not suppress.

size is the number of bytes to not suppress.

When the Intel Inspector detects an error, it checks the set of marked ranges and, using the smallest enclosing range, filters out the error if the mode/action is suppress_range and the etype/mask matches the detected error.

The largest supported range is 2 GB.

The default mode/action for all of memory is unsuppress_range. You can change the default by creating a range with address NULL and size 0.

You can nest ranges only if the new range is a subset of existing ranges.

Two calls to mark_range that specify the same range and intersecting etype/mask may not specify both suppress_range and unsuppress_range as the mode/action.

Usage Example: Time-oriented Collection Control

C/C++ Example

Fortran Example 

#include <ittnotify.h>
 
...
#pragma omp parallel
    __itt_suppress_push(
       __itt_suppress_threading_errors);
    /* Any threading errors here will be
       ignored by the calling thread.
       In this case, each thread in the region */
 
    __itt_suppress_pop();
    /* Any threading errors here will be
       seen by Inspector*/
}
 
use ittnotify

...!$omp parallel
    call itt_suppress_push(
       itt_suppress_threading_errors)
    !Any threading errors here will be
       !ignored by the calling thread.
       !In this case, each thread in the region 
 
    call itt_suppress_pop()
    ! Any threading errors here will be
       !seen by Inspector

!$omp end parallel

Usage Example: Object-oriented Collection Control

C/C++ Example

Fortran Example 

#include <ittnotify.h>

int variable_to_watch;
int other_variable;
…
     //change the default mode by using NULL and 0
       as address and size
    __itt_suppress_mark_range(
       __itt_suppress_range,
       __itt_suppress_threading_errors,
       NULL, 
       0);
     //ensure we see errors on variable_to_watch
    __itt_suppress_mark_range(
      __itt_unsuppress_range,
      __itt_suppress_threading_errors,
      &variable_to_watch,
      sizeof(variable_to_watch));
#pragma omp parallel
     …
     variable_to_watch++; //race will be reported
     other_variable++; //race will not be reported
}
     //clear the record for all of memory
    __itt_suppress_clear_range(
      __itt_suppress_range,
      __itt_suppress_threading_errors,
      NULL,
      0);
    //clear the record for variable_to_watch
    __itt_suppress_clear_range(
      __itt_unsuppress_range,
      __itt_suppress_threading_errors,
      &variable_to_watch, 
      sizeof(variable_to_watch));
    //mark the range for other_variable 
      so we don’t see errors
    __itt_suppress_mark_range(
      __itt_suppress_range,
      __itt_suppress_threading_errors,
      &other_variable,
      sizeof(other_variable));
#pragma omp parallel
     …
     variable_to_watch++; //race will be reported
     other_variable++; //race not be reported
}
 
use ittnotify

common /x/ variable_to_watch, other_variable
integer variable_to_watch
integer other_variable
…
     !change the default mode by using 0 and 0
       !as address and size
    call itt_suppress_mark_range(
      itt_suppress_range,
      itt_suppress_threading_errors,
      0,
      0)
     !ensure we see errors on variable_to_watch
    call itt_suppress_mark_range(
      itt_unsuppress_range,
      itt_suppress_threading_errors, 
      LOC(variable_to_watch),
      4)
!$omp parallel
     …
     variable_to_watch = variable_to_watch + 1
     !race will be reported
     other_variable = other_variable + 1
     !race will not be reported
!$omp end parallel
     !clear the record for all of memory
    call itt_suppress_clear_range(
      itt_suppress_range,
      itt_suppress_threading_errors,
      0,
      0);
    !clear the record for variable_to_watch
    call itt_suppress_clear_range(
      itt_unsuppress_range,
      itt_suppress_threading_errors,
      LOC(variable_to_watch),
      4)
    !mark the range for other_variable 
      !so we don’t see errors
    call itt_suppress_mark_range(
      itt_suppress_range,
      itt_suppress_threading_errors,
      LOC(other_variable),
      4)
!$omp parallel
     …
     variable_to_watch = variable_to_watch + 1
     !race will be reported
     other_variable = other_variable + 1
     !race not be reported
!$omp end parallel

Parent topic: API Support
Level Two Title