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
72 lines
2.4 KiB
ReStructuredText
72 lines
2.4 KiB
ReStructuredText
.. meta::
|
|
:description: ROCm Systems Profiler environment validation documentation and reference
|
|
:keywords: rocprof-sys, rocprofiler-systems, Omnitrace, ROCm, profiler, environment, tracking, visualization, tool, Instinct, accelerator, AMD
|
|
|
|
****************************************************
|
|
Configuring and validating the environment
|
|
****************************************************
|
|
|
|
After installing `ROCm Systems Profiler <https://github.com/ROCm/rocm-systems/tree/develop/projects/rocprofiler-systems>`_, additional steps are required to set up
|
|
and validate the environment.
|
|
|
|
.. note::
|
|
|
|
The following instructions use the installation path ``/opt/rocprofiler-systems``. If
|
|
ROCm Systems Profiler is installed elsewhere, substitute the actual installation path.
|
|
|
|
Configuring the environment
|
|
========================================
|
|
|
|
After ROCm Systems Profiler is installed, source the ``setup-env.sh`` script to prefix the
|
|
``PATH``, ``LD_LIBRARY_PATH``, and other environment variables:
|
|
|
|
.. code-block:: shell
|
|
|
|
source /opt/rocprofiler-systems/share/rocprofiler-systems/setup-env.sh
|
|
|
|
Alternatively, if environment modules are supported, add the ``<prefix>/share/modulefiles`` directory
|
|
to ``MODULEPATH``:
|
|
|
|
.. code-block:: shell
|
|
|
|
module use /opt/rocprofiler-systems/share/modulefiles
|
|
|
|
.. note::
|
|
|
|
As an alternative, the above line can be added to the ``${HOME}/.modulerc`` file.
|
|
|
|
After ROCm Systems Profiler has been added to the ``MODULEPATH``, it can be loaded
|
|
using ``module load rocprofiler-systems/<VERSION>`` and unloaded using ``module unload rocprofiler-systems/<VERSION>``.
|
|
|
|
.. code-block:: shell
|
|
|
|
module load rocprofiler-systems/1.0.0
|
|
module unload rocprofiler-systems/1.0.0
|
|
|
|
.. note::
|
|
|
|
You might also need to add the path to the ROCm libraries to ``LD_LIBRARY_PATH``,
|
|
for example, ``export LD_LIBRARY_PATH=/opt/rocm/lib:${LD_LIBRARY_PATH}``
|
|
|
|
Validating the environment configuration
|
|
========================================
|
|
|
|
If the following commands all run successfully with the expected output,
|
|
then you are ready to use ROCm Systems Profiler:
|
|
|
|
.. code-block:: shell
|
|
|
|
which rocprof-sys
|
|
which rocprof-sys-avail
|
|
which rocprof-sys-sample
|
|
rocprof-sys-instrument --help
|
|
rocprof-sys-avail --all
|
|
rocprof-sys-sample --help
|
|
|
|
If ROCm Systems Profiler was built with Python support, validate these additional commands:
|
|
|
|
.. code-block:: shell
|
|
|
|
which rocprof-sys-python
|
|
rocprof-sys-python --help
|