derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
81 lines
3.6 KiB
ReStructuredText
81 lines
3.6 KiB
ReStructuredText
.. meta::
|
|
:description: ROCprofiler-SDK is a tooling infrastructure for profiling general-purpose GPU compute applications running on the ROCm software
|
|
:keywords: ROCprofiler-SDK tool, ROCprofiler-SDK library, rocprofv3, ROCprofiler-SDK API, ROCprofiler-SDK documentation
|
|
|
|
.. _index:
|
|
|
|
********************************
|
|
ROCprofiler-SDK documentation
|
|
********************************
|
|
|
|
ROCprofiler-SDK is a tooling infrastructure for profiling general-purpose GPU compute applications running on the ROCm software.
|
|
It supports application tracing to provide a big picture of the GPU application execution and kernel counter collection to provide low-level hardware details from the performance counters.
|
|
The ROCprofiler-SDK library provides runtime-independent APIs for tracing runtime calls and asynchronous activities such as GPU kernel dispatches and memory moves. The tracing includes callback APIs for runtime API tracing and activity APIs for asynchronous activity records logging.
|
|
|
|
You can utilize the ROCprofiler-SDK to develop a tool for profiling and tracing HIP applications on ROCm software.
|
|
|
|
The code is open source and hosted at `<https://github.com/ROCm/rocm-systems/tree/develop/projects/rocprofiler-sdk>`_.
|
|
|
|
.. note::
|
|
|
|
The ROCprofiler-SDK repository for ROCm 7.0 and earlier is located at `<https://github.com/ROCm/rocprofiler-sdk>`_.
|
|
|
|
ROCprofiler-SDK uses a companion library called `AQLprofile <https://rocm.docs.amd.com/projects/aqlprofile/en/latest/index.html>`_, that generates profiling command packets (AQL/PM4) for performance counters and SQ thread trace. For details, see the `AQLprofile docs <https://rocm.docs.amd.com/projects/aqlprofile/en/latest/index.html>`_.
|
|
|
|
The documentation is structured as follows:
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install ROCprofiler-SDK <install/install>`
|
|
* :doc:`Build from source <install/build>`
|
|
|
|
.. grid-item-card:: Quick Reference
|
|
|
|
* :ref:`quick-guide`
|
|
* :ref:`cli-options`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :ref:`using-rocprofv3`
|
|
* :ref:`rocprofv3-advanced-options`
|
|
* :ref:`kernel-naming-filtering`
|
|
* :ref:`rocprofv3-io-options`
|
|
* :ref:`using-rocprofv3-avail`
|
|
* :ref:`rocprofv3_process_attachment`
|
|
* :ref:`using-rocpd-output-format`
|
|
* :ref:`using-rocprofiler-sdk-roctx`
|
|
* :ref:`using-rocprofv3-with-mpi`
|
|
* :ref:`using-rocprofv3-with-openmp`
|
|
* :ref:`using-pc-sampling`
|
|
* :ref:`cdna3-cdna4-pc-sampling`
|
|
* :ref:`using-thread-trace`
|
|
* :ref:`using-spm`
|
|
* :doc:`Samples <how-to/samples>`
|
|
|
|
.. grid-item-card:: API reference
|
|
|
|
* :doc:`Tool library <api-reference/tool_library>`
|
|
* :ref:`runtime-intercept-tables`
|
|
* :doc:`Process attachment <api-reference/process_attachment>`
|
|
* :doc:`Buffered services <api-reference/buffered_services>`
|
|
* :doc:`Callback services <api-reference/callback_services>`
|
|
* :doc:`Counter collection services <api-reference/counter_collection_services>`
|
|
* :doc:`PC sampling <api-reference/pc_sampling>`
|
|
* :doc:`ROCprof Trace Decoder <api-reference/thread_trace>`
|
|
* :doc:`Streaming Performance Monitor (SPM) <api-reference/spm>`
|
|
* :doc:`ROCprofiler-SDK API <api-reference/rocprofiler-sdk_api_reference>`
|
|
* :doc:`ROCTx API <api-reference/rocprofiler-sdk-roctx_api_reference>`
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :ref:`comparing-with-legacy-tools`
|
|
|
|
To contribute to the documentation, refer to
|
|
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
|
|
|
|
You can find licensing information on the
|
|
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
|