ROCProfiler documentation

Important

ROCProfiler, ROCTracer, rocprof, and rocprofv2 are deprecated. It’s strongly recommended to upgrade to the latest version of the ROCprofiler-SDK library and the rocprofv3 tool to ensure continued support and access to new features.

To learn about key feature improvements and benefits of ROCprofiler-SDK over the deprecated ROCProfiler and ROCTracer, see Comparing ROCprofiler-SDK to legacy ROCm profiling tools.

It’s anticipated that ROCProfiler, ROCTracer, rocprof, and rocprofv2 will reach end of support (EoS) by the end of 2026 Q2.

ROCProfiler is a powerful tool for profiling HIP and ROCm applications on AMD ROCm software. Profiling is used to identify application performance bottlenecks and optimize their performance. ROCProfiler offers a library for developing applications with profiling features and a command-line interface (CLI) tool for profiling compiled applications. The library and CLI tool for the first version of ROCProfiler are named ROCProfiler and rocprof, respectively, whereas the library and the CLI tools for the second version of ROCProfiler are ROCProfilerV2, rocprofv2, and rocsys. ROCProfiler and ROCProfilerV2 provide:

• Application tracing: Traces the execution of an application with timestamps for the start and end of each API call, as well as kernel execution.

• Performance counter collection: Collects performance counters for each API call and kernel execution.

The code is open and hosted at ROCm/rocm-systems.

Note

The ROCProfiler repository for ROCm 7.0 and earlier is located at ROCm/rocprofiler.

Install

• Installing ROCProfiler

• Installing ROCProfilerV2

The documentation is structured as follows:

Tutorials

• MatrixTranspose application tutorial

• ROCm examples

• HIP examples

How to

• ROCProfiler CLI

  • Using rocprof

  • rocprof command help

• ROCProfilerV2 CLI

  • Using rocprofv2

  • Using rocsys

  • rocprofv2 command help

References

• ROCProfiler

  • ROCProfiler library specification

  • ROCProfiler API library

    • Modules

    • Data Structures

    • Files

• ROCProfilerV2

  • ROCProfilerV2 API

To contribute to the documentation, refer to Contributing to ROCm.

You can find licensing information on the Licensing page.