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
45 lines
1.7 KiB
ReStructuredText
45 lines
1.7 KiB
ReStructuredText
.. meta::
|
|
:description: hipThreads, a C++-style concurrency library for AMD GPUs
|
|
:keywords: hipThreads, ROCm, HIP, threads, mutex, condition variable, concurrency, GPU
|
|
|
|
.. _index:
|
|
|
|
******************************************
|
|
hipThreads documentation
|
|
******************************************
|
|
|
|
hipThreads is a C++-style concurrency library for AMD GPUs.
|
|
It implements ``std::thread``-like primitives (``hip::wthread``, ``hip::mutex``, ``hip::lock_guard``, ``hip::condition_variable``, and more) that run inside GPU kernels, so existing ``std::thread`` CPU code can be ported to the GPU with minimal changes.
|
|
It is built on `HIP <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_ and libhipcxx.
|
|
|
|
The hipThreads project is located at https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipthreads.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install hipThreads <install/install>`
|
|
* :doc:`Build from source <install/source-build>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Add hipThreads to a CMake project <./how-to/use-hipthreads-in-a-project>`
|
|
* :doc:`Tune scheduler concurrency <./how-to/tune-scheduler-concurrency>`
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :ref:`Execution model <execution-model>`
|
|
|
|
.. grid-item-card:: Reference
|
|
|
|
* :ref:`std to hip mapping <std-to-hip-mapping>`
|
|
* :ref:`Limitations <limitations>`
|
|
* :ref:`hipThreads API reference <api-reference>`
|
|
|
|
To contribute to the documentation, refer to
|
|
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
|
|
|
|
You can find licensing information on the
|
|
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
|