Welcome to the OmniTrace Documentation!

Table of Contents

• About
  • Overview
  • OmniTrace Use Cases
• Features
  • Overview
    • Data Collection Modes
    • Data Analysis
    • Parallelism API Support
    • GPU Metrics
    • CPU Metrics
    • Third-party API support
• Installation
  • Release Links
  • Quick Start (Latest Release, Binary Installer)
  • Operating System Support
    • Identifying the Operating System
  • Architecture
  • Installing omnitrace from binary distributions
    • Download the appropriate binary distribution
    • Create the target installation directory
    • Run the installer script
  • Installing OmniTrace from source
    • Build Requirements
    • Required Third-Party Packages
    • Optional Third-Party Packages
    • Installing DynInst
      • Building Dyninst alongside OmniTrace
      • Installing Dyninst via Spack
    • Installing omnitrace
      • MPI Support within OmniTrace
  • Post-Installation Steps
    • Configure the environment
    • Test the executables
• Setup and Validation
  • Configuring Environment
  • Validating Environment Configuration
• Getting Started
  • Nomenclature
  • General Tips
  • Data Collection Mode(s)
    • Binary Instrumentation
    • Statistical Sampling
    • Binary Instrumentation vs. Statistical Sampling Example
      • Binary Instrumentation of Fibonacci Function
      • Statistical Sampling of Fibonacci Function
• Configuring OmniTrace Runtime
  • omnitrace-avail Executable
    • Exploring Runtime Settings
    • Exploring Components
    • Exploring Hardware Counters
    • Enabling Hardware Counters
      • OMNITRACE_PAPI_EVENTS
      • OMNITRACE_ROCM_EVENTS
    • omnitrace-avail Examples
      • Generating Default Configuration
      • Viewing Setting Descriptions
      • Viewing Components
      • Viewing Hardware Counters
  • Creating a Configuration File
    • Sample Text Configuration File
    • Sample JSON Configuration File
    • Sample XML Configuration File
• Call-Stack Sampling
  • omnitrace-sample Executable
  • omnitrace-sample Example
• Binary Instrumentation
  • omnitrace-instrument Executable
  • Runtime Instrumentation
  • Attaching to Running Process
  • Binary Rewrite
    • Binary Rewriting a Library
    • Binary Rewriting a Library Example
  • Selective Instrumentation
    • Viewing the Available, Instrumented, Excluded, and Overlapping Functions
    • Excluding and Including Modules and Functions
      • Example Available Module and Function Info Output
      • Example Instrumented Module and Function Info Output
  • Sampling
  • Embedding a Default Configuration
    • Troubleshooting
      • Checking for RPATH
      • Modifying RPATH
• Causal Profiling
  • What is “Causal Profiling”?
  • Getting Started
    • Progress Points
    • Key Concepts
      • Notes
    • Backends
      • Instruction Pointer Skid
      • Installing Linux Perf
    • Speedup Prediction Variability and omnitrace-causal Executable
      • Examples
      • Using omnitrace-causal with other launchers (e.g. mpirun)
    • Visualizing the Causal Output
  • OmniTrace vs. Coz
• Critical Trace Support
• OmniTrace Output
  • Overview
  • Metadata
    • Metadata JSON Sample
  • Configuring Output
    • Core Configuration Settings
      • Output Prefix Keys
  • Perfetto Output
  • Timemory Output
    • Timemory Text Output
      • Timemory Text Output Example
    • Timemory JSON Output
      • Timemory JSON Output Sample
      • Timemory JSON Output Python Post-Processing Example
• User API
  • Example
    • Compilation
      • CMake
      • General
    • User API Implementation
    • User API Output
• Python Support
  • Getting Started
  • Running OmniTrace on a Python Script
    • Command Line Options
    • Selective Instrumentation
  • OmniTrace Python Source Instrumentation
    • OmniTrace Python Source Instrumentation Configuration
• YouTube Tutorials
  • Installing a binary release
  • Instrumenting a binary
  • Writing an omnitrace configuration file
  • Visualization and Features of Perfetto Traces
• Development Guide
  • Miscellaneous Info
  • Executables
    • omnitrace-avail: source/bin/omnitrace-avail
    • omnitrace-sample: source/bin/omnitrace-sample
    • omnitrace-casual: source/bin/omnitrace-causal
    • omnitrace-instrument: source/bin/omnitrace-instrument
  • Libraries
    • Common Library: source/lib/common
    • Core Library: source/lib/core
    • Binary Library: source/lib/binary
    • libomnitrace: source/lib/omnitrace
    • libomnitrace-dl: source/lib/omnitrace-dl
    • libomnitrace-user: source/lib/omnitrace-user
  • Concepts
    • Component
      • Wall-Clock Component Example
      • Function Wrapper Component Example
      • Component Member Functions
  • Memory Model
    • Thread Identification
    • Thread-Data Class
  • Sampling Model
  • Time-Window Constraint Model