ROCR Debug Agent installation#
This topic provides information required to build and install ROCR Debug Agent (ROCdebug-agent) library.
Prerequisites#
A system supporting ROCm. See the supported operating systems.
A C++ 17 compiler such as GCC 7 or Clang 5.
The AMD ROCm software stack. See the ROCm installation instructions.
Install the required packages according to the OS:
apt install gcc g++ make cmake libelf-dev libdw-dev
yum install gcc gcc-c++ make cmake elfutils-libelf-devel elfutils-devel
zypper install gcc gcc-c++ make cmake libelf-devel libdw-devel
Python 3.6 or later to run the tests.
ROCdbgapi library. This can be installed using the ROCdbgapi package as part of the ROCm release. See the instructions to install ROCdbgapi library.
Build and install#
An example command line to build and install the ROCdebug-agent library on Linux:
cd rocm-debug-agent
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../install ..
make
To specify the location for the installation, use CMAKE_INSTALL_PREFIX. The default location is /usr.
To specify a list of paths (separated by semicolons) that are used to locate the cmake modules, use CMAKE_MODULE_PATH. It is used to locate the HIP cmake modules required to build the tests. The default is location is /opt/rocm/hip/cmake.
The built ROCdebug-agent library is placed in build/librocm-debug-agent.so.2*.
To install the ROCdebug-agent library, use:
make install
The installed ROCdebug-agent library and tests are placed in:
<install-prefix>/lib/librocm-debug-agent.so.2*
<install-prefix>/share/rocm-debug-agent/LICENSE.txt
<install-prefix>/share/rocm-debug-agent/README.md
<install-prefix>/src/rocm-debug-agent-test/*
Test#
To test the ROCdebug-agent library, use:
make test
Output:
Running tests...
Test project /rocm-debug-agent/build
Start 1: rocm-debug-agent-test
1/1 Test #1: rocm-debug-agent-test ............ Passed 1.59 sec
100% tests passed, 0 tests failed out of 1
Total Test time (real) = 1.59 sec
You can run the tests individually outside of the CTest harness as shown:
HSA_TOOLS_LIB=librocm-debug-agent.so.2 test/rocm-debug-agent-test 0
HSA_TOOLS_LIB=librocm-debug-agent.so.2 test/rocm-debug-agent-test 1
HSA_TOOLS_LIB=librocm-debug-agent.so.2 test/rocm-debug-agent-test 2