cgmb / hipsolver

ROCm SOLVER marshalling library

hipSOLVER

hipSOLVER is a LAPACK marshalling library, with multiple supported backends. It sits between the application and a 'worker' LAPACK library, marshalling inputs into the backend library and marshalling results back to the application. hipSOLVER exports an interface that does not require the client to change, regardless of the chosen backend. Currently, hipSOLVER supports rocSOLVER and cuSOLVER as backends.

Installing Pre-built Packages

Download pre-built packages either from ROCm's package servers or by clicking the github releases tab and manually downloading, which could be newer. Release notes are available for each release on the releases tab.

• sudo apt update && sudo apt install hipsolver

Building hipSOLVER

Build Library Using Script (Ubuntu only)

The root of this repository has a helper bash script install.sh to build and install hipSOLVER on Ubuntu with a single command. It does not take a lot of options and hard-codes configuration that can be specified through invoking cmake directly, but it's a great way to get started quickly and can serve as an example of how to build/install. A few commands in the script need sudo access, so it may prompt you for a password.

• ./install.sh -h -- shows help
• ./install.sh -id -- build library, build dependencies, and install (-d flag only needs to be passed once on a system)
• ./install.sh -ic -- build library, build clients (tests, benchmarks, and samples), and install

Build Library Manually

mkdir -p [HIPSOLVER_BUILD_DIR]/release
cd [HIPSOLVER_BUILD_DIR]/release
# Default install location is in /opt/rocm, define -DCMAKE_INSTALL_PREFIX=<path> to specify other
# Default build config is 'Release', define -DCMAKE_BUILD_TYPE=<config> to specify other
CXX=/opt/rocm/bin/hipcc cmake [HIPSOLVER_SOURCE]
make -j$(nproc)
sudo make install   # sudo required if installing into a system directory such as /opt/rocm

Build Library + Tests + Benchmarks + Samples Manually

The repository contains source code for client programs that serve as tests, benchmarks, and samples. Client source code can be found in the clients subdirectory.

Dependencies (only necessary for hipSOLVER clients)

The hipSOLVER samples have no external dependencies, but our unit test and benchmarking applications do. These clients introduce the following dependencies:

1. boost
2. lapack (lapack itself brings a dependency on a fortran compiler)
3. googletest

Linux distros typically have an easy installation mechanism for boost through the native package manager.

• Ubuntu: sudo apt install libboost-program-options-dev
• Fedora: sudo dnf install boost-program-options

Unfortunately, googletest and lapack are not as easy to install. Many distros do not provide a googletest package with pre-compiled libraries, and the lapack packages do not have the necessary cmake config files for cmake to configure linking the cblas library. hipSOLVER provide a cmake script that builds the above dependencies from source. This is an optional step; users can provide their own builds of these dependencies and help cmake find them by setting the CMAKE_PREFIX_PATH definition. The following is a sequence of steps to build dependencies and install them to the cmake default /usr/local.

mkdir -p [HIPSOLVER_BUILD_DIR]/release/deps
cd [HIPSOLVER_BUILD_DIR]/release/deps
cmake -DBUILD_BOOST=OFF [HIPSOLVER_SOURCE]/deps   # assuming boost is installed through package manager as above
make -j$(nproc) install

Library and clients

Once dependencies are available on the system, it is possible to configure the clients to build. This requires a few extra cmake flags to the library's cmake configure script. If the dependencies are not installed into system defaults (like /usr/local), you should pass the CMAKE_PREFIX_PATH to cmake to help find them.

• -DCMAKE_PREFIX_PATH="<semicolon separated paths>"

# Default install location is in /opt/rocm, use -DCMAKE_INSTALL_PREFIX=<path> to specify other
CXX=/opt/rocm/bin/hcc cmake -DBUILD_CLIENTS_TESTS=ON -DBUILD_CLIENTS_BENCHMARKS=ON [HIPSOLVER_SOURCE]
make -j$(nproc)
sudo make install   # sudo required if installing into system directory such as /opt/rocm

hipSOLVER Interface

The hipSOLVER interface is compatible with rocSOLVER and cuBLAS-v11 APIs. Porting a CUDA application that originally calls the cuSOLVER API to an application calling the hipSOLVER API should be relatively straightforward. For example, the hipSOLVER SGETRF interface is

GETRF API

hipsolverStatus_t
hipsolverSgetrf_bufferSize(hipsolverHandle_t handle,
                           int m,
                           int n,
                           float* A,
                           int lda,
                           int* lwork);

hipsolverStatus_t
hipsolverSgetrf(hipsolverHandle_t handle,
                int               m,
                int               n,
                float*            A,
                int               lda,
                float*            work,
                int*              devIpiv,
                int*              devInfo);

Functions Supported

Auxiliary functions

Function
hipsolverCreate
hipsolverDestroy
hipsolverSetStream
hipsolverGetStream

LAPACK functions

Function	single	double	single complex	double complex
hipsolverXgetrf_bufferSize	x	x	x	x
hipsolverXgetrf	x	x	x	x