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
90 lines
3.0 KiB
ReStructuredText
90 lines
3.0 KiB
ReStructuredText
.. meta::
|
|
:description: Building and installing rocFFT
|
|
:keywords: rocFFT, ROCm, API, documentation, install, build from source
|
|
|
|
.. _building-installing-rocfft:
|
|
|
|
************************************
|
|
Build and install rocFFT from source
|
|
************************************
|
|
|
|
To build rocFFT as part of the ROCm Core SDK, see `TheRock build
|
|
instructions
|
|
<https://github.com/ROCm/TheRock/blob/main/docs/development/README.md>`__.
|
|
TheRock is the recommended way to build ROCm components from source.
|
|
|
|
Alternatively, you can build rocFFT standalone using the following
|
|
instructions.
|
|
|
|
Building rocFFT from source
|
|
=============================
|
|
|
|
You can use the GitHub releases tab to download the source code. This might provide you with a more recent version
|
|
than the prebuilt packages.
|
|
|
|
rocFFT uses the AMD clang++ compiler and CMake. You can specify several options to customize your build.
|
|
Use the following commands to build a shared library for the supported AMD GPUs.
|
|
Run these commands from the ``rocm-libraries/projects/rocfft`` directory:
|
|
|
|
.. code-block:: shell
|
|
|
|
mkdir build && cd build
|
|
cmake -DCMAKE_CXX_COMPILER=amdclang++ -DCMAKE_C_COMPILER=amdclang ..
|
|
make -j
|
|
|
|
.. note::
|
|
|
|
To compile a static library, use the ``-DBUILD_SHARED_LIBS=off`` option.
|
|
|
|
In ROCm version 4.3 or higher, indirect function calls are enabled for rocFFT by default.
|
|
Use ``-DROCFFT_CALLBACKS_ENABLED=off`` with CMake to prevent these calls on older ROCm versions.
|
|
|
|
.. note::
|
|
|
|
If rocFFT is built with this configuration, callbacks won't work correctly.
|
|
|
|
rocFFT clients
|
|
=============================
|
|
|
|
rocFFT includes the following clients and utilities:
|
|
|
|
* **rocfft-bench**: Runs general transforms and performance analysis
|
|
|
|
* **rocfft-test**: Runs a series of regression tests
|
|
|
|
* Various samples
|
|
|
|
The following table includes the CMake option to build each client and the client dependencies.
|
|
|
|
.. csv-table::
|
|
:header: "Client","CMake option","Dependencies"
|
|
:widths: 20, 30, 30
|
|
|
|
"rocfft-bench","``-DBUILD_CLIENTS_BENCH=on``","hipRAND"
|
|
"rocfft-test","``-DBUILD_CLIENTS_TESTS=on``","hipRAND, FFTW, GoogleTest"
|
|
"samples","``-DBUILD_CLIENTS_SAMPLES=on``","none"
|
|
|
|
The clients are not built by default. To build them, use ``-DBUILD_CLIENTS=on``.
|
|
The build process downloads and builds GoogleTest and FFTW if they are not already installed.
|
|
rocFFT uses version 1.11 of GoogleTest.
|
|
|
|
You can build the clients separately from the main library.
|
|
For example, to build all the clients with an existing rocFFT library, invoke CMake from
|
|
within the ``rocm-libraries/projects/rocfft/rocFFT-src/clients`` folder using these commands:
|
|
|
|
.. code-block:: shell
|
|
|
|
mkdir build && cd build
|
|
cmake -DCMAKE_CXX_COMPILER=amdclang++ -DCMAKE_PREFIX_PATH=/path/to/rocFFT-libb ..
|
|
make -j
|
|
|
|
To install the client dependencies on Ubuntu, run the following command:
|
|
|
|
.. code-block:: shell
|
|
|
|
sudo apt install libgtest-dev libfftw3-dev
|
|
|
|
.. note::
|
|
|
|
On Red Hat-related distributions, these packages are named ``gtest-devel`` and ``fftw-devel``.
|