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
34 lines
1.3 KiB
ReStructuredText
34 lines
1.3 KiB
ReStructuredText
.. meta::
|
|
:description: Using hipThreads in a CMake project
|
|
:keywords: hipThreads, ROCm, cmake, find_package, link, include
|
|
|
|
.. _use-in-a-project:
|
|
|
|
*******************************************
|
|
How to use hipThreads in a CMake project
|
|
*******************************************
|
|
|
|
After :doc:`installing hipThreads <../install/source-build>`, add the following lines to your ``CMakeLists.txt`` to find, include, and link the library:
|
|
|
|
.. code-block:: cmake
|
|
|
|
find_package(hipthreads REQUIRED)
|
|
|
|
# ...
|
|
|
|
target_link_libraries(<your_target> hipthreads::hipthreads)
|
|
|
|
The ``hipthreads::hipthreads`` target carries the public include directories, so the headers are available without any extra ``target_include_directories`` call.
|
|
Include the umbrella headers you need from your sources:
|
|
|
|
.. code-block:: cpp
|
|
|
|
#include <hip/thread>
|
|
#include <hip/mutex>
|
|
#include <hip/condition_variable>
|
|
|
|
If hipThreads is not installed under ``$ROCM_PATH``, point CMake at it by adding ``-DCMAKE_PREFIX_PATH=/path/to/hipthreads`` to your configure command.
|
|
|
|
The ``examples/`` directory in the repository contains complete, standalone CMake projects (SAXPY, a ray tracer, sparse matrix multiply, and a llama3.c port).
|
|
Each example uses ``find_package(hipthreads)`` exactly as shown above and is a good starting point for a new project.
|