Installing ROCProfilerV2

Installing ROCProfilerV2#

As ROCProfilerV2 library and rocprofv2 are standard components of the ROCm distribution, the simplest installation method is to perform a complete installation of ROCm as described in Installation Guide. This approach is straightforward and dependable, making it suitable for most users.

Alternatively, installing ROCProfiler from the source files offers some advantages. Due to the additional complexity involved, this option is only recommended for experienced users when necessary.

Supported AMD GPU architectures#

The following AMD GPU architectures are supported for ROCProfilerV2:

  • gfx900 (AMD Vega 10)

  • gfx906 (AMD Vega 7nm also referred to as AMD Vega 20)

  • gfx908 (AMD Instinct™ MI100 accelerator)

  • gfx90a (AMD Instinct™ MI200)

  • gfx94x (AMD Instinct™ MI300)

  • gfx10xx ([Navi2x] AMD Radeon(TM) Graphics)

  • gfx11xx ([Navi3x] AMD Radeon(TM) Graphics)

Installing from source files#

The following section discusses how to install and build from the source files.

Prerequisites#

Installing ROCProfilerV2 from the source requires:

  • AMD GPU driver for supported GPUs

  • Linux system supported by ROCm as described in System requirements

  • ROCm installed in the system

  • Packages necessary for ROCProfilerV2 on supported Linux distributions:

    • Ubuntu 20.04 and 22.04

      sudo apt install libelf-dev libnuma-dev libpciaccess-dev libgtest-dev

    • For other OS, install packages libelf-devel, libnuma-devel, libpciaccess-devel, libgtest-devel.

  • Libraries such as makecache, CppHeaderParser, websockets, matplotlib, lxml, barectf, and Python3.

  • Python packages:

    pip3 install -r requirements.txt

Building from source#

Based on the ROCM_PATH environment variable, choose one of the following build options:

Build option 1#

To install in the path saved in ROCM_PATH environment variable or in the default path /opt/rocm, if ROCM_PATH is empty, use:

  • For normal build:

./build.sh --build OR ./build.sh -b

  • For clean build:

./build.sh --clean-build OR ./build.sh -cb

Build option 2#

When setting the ROCM_PATH environment variable with the current ROCm installation directory, use:

  1. Create the build directory:

mkdir build && cd build

  1. Configure the rocprofv2 build

cmake -DCMAKE_PREFIX_PATH=$ROCM_PATH -DCMAKE_MODULE_PATH=$ROCM_PATH/hip/cmake -DROCPROFILER_BUILD_TESTS=1 -DROCPROFILER_BUILD_SAMPLES=1 <CMAKE_OPTIONS> ..

  1. Build the main runtime of the rocprofv2 project:

cmake --build . -- -j

  1. Optionally, to build API documentation, use:

cmake --build . -- -j doc

  1. Optionally, to build packages (DEB, RPM, TGZ), use:

cmake --build . -- -j package

Note that these packages require rpm package on Ubuntu.

  1. Optionally, to install rocprofv2, use:

cd build
cmake --build . -- -j install

Installing rocprofv2 provides installation package files for:

  • Documentation

rocprofiler-docs_9.0.0-local_amd64.deb
rocprofiler-docs-9.0.0-local.x86_64.rpm

  • Samples

rocprofiler-samples_9.0.0-local_amd64.deb
rocprofiler-samples-9.0.0-local.x86_64.rpm

These installation packages are present in the path specified in ROCM_PATH or in the default path /opt/rocm when ROCM_PATH is empty.