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
38 lines
1.7 KiB
ReStructuredText
38 lines
1.7 KiB
ReStructuredText
.. meta::
|
|
:description: HIP runtime API usage
|
|
:keywords: AMD, ROCm, HIP, HIP runtime API How to,
|
|
|
|
.. _hip_runtime_api_how-to:
|
|
|
|
********************************************************************************
|
|
Using HIP runtime API
|
|
********************************************************************************
|
|
|
|
The HIP runtime API provides C and C++ functionalities to manage event, stream,
|
|
and memory on GPUs. The HIP runtime uses :doc:`Compute Language Runtime (CLR) <../understand/amd_clr>`.
|
|
|
|
CLR contains source code for AMD ROCm's compute language runtimes: ``HIP`` and
|
|
``OpenCL™``. CLR includes the ``HIP`` implementation on the AMD ROCm
|
|
platform: `hipamd <https://github.com/ROCm/rocm-systems/tree/develop/projects/clr/hipamd>`_ and the
|
|
ROCm Compute Language Runtime (``rocclr``). ``rocclr`` is a
|
|
virtual device interface that enables the HIP runtime to interact with
|
|
different backends, such as :doc:`ROCr <rocr-runtime:index>` on Linux or PAL on
|
|
Microsoft Windows. CLR also includes the `OpenCL runtime <https://github.com/ROCm/rocm-systems/tree/develop/projects/clr/opencl>`_
|
|
implementation.
|
|
|
|
The HIP runtime API backends are summarized in the following figure:
|
|
|
|
.. figure:: ../data/how-to/hip_runtime_api/runtimes.svg
|
|
Here are the various HIP Runtime API high level functions:
|
|
|
|
* :doc:`./hip_runtime_api/initialization`
|
|
* :doc:`./hip_runtime_api/memory_management`
|
|
* :doc:`./hip_runtime_api/error_handling`
|
|
* :doc:`./hip_runtime_api/asynchronous`
|
|
* :doc:`./hip_runtime_api/cooperative_groups`
|
|
* :doc:`./hip_runtime_api/hipgraph`
|
|
* :doc:`./hip_runtime_api/call_stack`
|
|
* :doc:`./hip_runtime_api/multi_device`
|
|
* :doc:`./hip_runtime_api/opengl_interop`
|
|
* :doc:`./hip_runtime_api/external_interop`
|