From 8bd151245792426c555d2097e8590403bd09bcd5 Mon Sep 17 00:00:00 2001 From: Sajina Kandy Date: Tue, 28 Jul 2026 15:39:01 -0400 Subject: [PATCH 1/2] Rocprofiler-systems profiler edits --- systems/frontier_user_guide.rst | 78 +++++++++++++++++++++------------ 1 file changed, 51 insertions(+), 27 deletions(-) diff --git a/systems/frontier_user_guide.rst b/systems/frontier_user_guide.rst index 1bdfbb14..1fe65779 100644 --- a/systems/frontier_user_guide.rst +++ b/systems/frontier_user_guide.rst @@ -3313,33 +3313,6 @@ Valgrind4hpc is available on Frontier under all compiler families: Additional information about Valgrind4hpc usage can be found on the `HPE Cray Programming Environment User Guide Page `__. -Omnitrace/ROCm Systems Profiler -------------------------------- - -OLCF provides installations of AMD's `Omnitrace `_ and the new re-branded `ROCm Systems Profiler `_ profiling tools on Frontier. -AMD provides documentation on the usage of the ROCm Systems Profiler at ``_. -This section details the installation and common pitfalls of the ``omnitrace`` and ``rocprofiler-systems`` modules on Frontier. - -A ROCm module must be loaded before being able to view or load either the ``omnitrace`` or ``rocprofiler-systems`` modules. -As a rule of thumb, always load the profiler's module last (but specifically after you load a ROCm module). -If you load a new version of ROCm, you will need to re-load the profiler module. - -To use ``omnitrace`` or ``rocprofiler-systems``, you may use the following commands - -.. code:: - - module load rocm - module load omnitrace # or module load rocprofiler-systems - -``rocprofiler-systems`` does not support all available ROCm modules. Please consult the table below for the compatibility matrix. - -+---------------------+--------------------------+ -| rocprofiler-compute | Supported ROCm Versions | -+=====================+==========================+ -| 1.0.1 | 6.3.*, 6.4.* | -+---------------------+--------------------------+ - - Profiling Applications ====================== @@ -3461,6 +3434,57 @@ More detailed information on HPCToolkit can be found in the `HPCToolkit User's M Getting Started with the ROCm Profiler -------------------------------------- +ROCm Systems Profiler +^^^^^^^^^^^^^^^^^^^^^ + +OLCF provides installations of AMD's `ROCm Systems Profiler `_ profiling tool on Frontier. +AMD provides documentation on the usage of the ROCm Systems Profiler at ``_. + +We recommend using a newer ROCm and its accompanying ``rocprofiler-systems`` binaries, which ship alongside the ROCm installation under its ``bin`` folder, to benefit from the latest features and bug fixes. +If you would like to build ``rocprofiler-systems`` from source, follow the instructions at ``_. + +A ROCm module must be loaded before being able to use the ``rocprofiler-systems`` binaries. + +.. code:: + + module load rocm + +**Looking up configuration options.** +Use ``rocprof-sys-avail`` to look up configuration settings, hardware counters, and data collection components. For example, ``rocprof-sys-avail --list-domains`` lists the API trace domains supported for profiling. + +.. code:: bash + + rocprof-sys-avail --list-domains + +Read more about configuring runtime options at ``_. + +**Example usage.** + +.. code:: bash + + rocprof-sys-sample -- ./myapp + mpirun -np 2 rocprof-sys-run -- ./mpi-example + srun -N 2 -n 16 --ntasks-per-node=8 --gpus-per-node=8 --gpu-bind=closest rocprof-sys-run -- ./mpi-example + +**Using predefined presets.** +ROCm Systems Profiler provides predefined presets that simplify configuring the profiler for common workload scenarios. Read more at ``_. + +Balanced profiling with moderate overhead and comprehensive data: + +.. code:: bash + + rocprof-sys-run --preset=balanced -- ./myapp + +Optimized for MPI, OpenMP, and compute-intensive applications: + +.. code:: bash + + mpirun -n 4 rocprof-sys-sample --preset=trace-hpc -- ./mpi_app + +**Understanding the output.** +Several output files can be generated, as detailed at ``_. +The traces are generated as Perfetto traces and/or a rocPD database, which can be viewed in the `Perfetto UI `_ and the `ROCm Optiq `_ visualizer respectively. + Rocprof v1 (For ROCm<=6.5) ^^^^^^^^^^^^^^^^^^^^^^^^^^ From 5a939e4bf41da759c343a7f806314c0528a20e6c Mon Sep 17 00:00:00 2001 From: Sajina Kandy Date: Thu, 10 Sep 2026 11:14:17 -0400 Subject: [PATCH 2/2] Update doc to use srun instead of mpirun --- systems/frontier_user_guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/systems/frontier_user_guide.rst b/systems/frontier_user_guide.rst index 1fe65779..8377ebea 100644 --- a/systems/frontier_user_guide.rst +++ b/systems/frontier_user_guide.rst @@ -3463,7 +3463,7 @@ Read more about configuring runtime options at ``_.