Installation#

This chapter provides information about the installation of RPP and related packages.

Prerequisites#

  • Linux distribution

    • Ubuntu 22.04 or 24.04

    • RedHat 8 or 9

    • SLES 15-SP5

  • ROCm supported hardware

  • Install ROCm with amdgpu-install with --usecase=rocm

  • CMake Version 3.10 and above

    sudo apt-get install cmake
    
  • AMD Clang++ Version 18.0.0 or later - installed with ROCm

    • NOTE: For CPU only backend use Clang Version 5.0.1 and above

      sudo apt-get install clang
      
  • IEEE 754-based half-precision floating-point library (half.hpp)

    sudo apt-get install half
    
  • Compiler with support for C++ Version 17 and above

    sudo apt-get install libstdc++-12-dev
    
  • OpenMP

    sudo apt-get install libomp-dev
    
  • Threads

    Note

    Use appropriate package manager depending on the OS

Build and install instructions#

The installation process uses the following steps:

Package install#

Install RPP runtime, development, and test packages.

  • Runtime package - rpp only provides the rpp library librpp.so

  • Development package - rpp-dev/rpp-devel provides the library, header files, and samples

  • Test package - rpp-test provides ctest to verify installation

Note

Package installation will auto install all dependencies.

On Ubuntu#

sudo apt install rpp rpp-dev rpp-test

On RHEL#

sudo yum install rpp rpp-devel rpp-test

On SLES#

sudo zypper install rpp rpp-devel rpp-test

Source build and install#

The process for installing is as follows:

  • Clone RPP git repository

    git clone https://github.com/ROCm/rpp.git
    

    Note

    RPP has support for two GPU backends: OPENCL and HIP

  • Instructions for building RPP with the HIP GPU backend (default GPU backend):

    mkdir build-hip
    cd build-hip
    cmake ../rpp
    make -j8
    sudo make install
    
  • Instructions for building RPP with OPENCL GPU backend

    mkdir build-ocl
    cd build-ocl
    cmake -DBACKEND=OCL ../rpp
    make -j8
    sudo make install
    

Verify installation#

The installer will copy

  • Libraries into /opt/rocm/lib

  • Header files into /opt/rocm/include/rpp

  • Samples folder into /opt/rocm/share/rpp

  • Documents folder into /opt/rocm/share/doc/rpp

Verify with rpp-test package#

Test package will install ctest module to test rpp. Use the following steps to test the installation:

mkdir rpp-test && cd rpp-test
cmake /opt/rocm/share/rpp/test/
ctest -VV

Note

Installation of test suite prerequisites are required to run tests

Test RPP functionalities#

To test the functionalities of rpp, run the code shown for your backend:

  • HIP

    cd rpp/utilities/rpp-unittests/HIP_NEW
    ./testAllScript.sh
    
  • OpenCL

    cd rpp/utilities/rpp-unittests/OCL_NEW
    ./testAllScript.sh
    
  • CPU

    cd rpp/utilities/rpp-unittests/HOST_NEW
    ./testAllScript.sh