Kiss, Istvan
e60263a55a
Co-authored-by: Istvan Kiss <neon60@gmail.com>
[ROCm/hip commit: 69becfc7a8]
49 lines
2.2 KiB
ReStructuredText
49 lines
2.2 KiB
ReStructuredText
.. meta::
|
|
:description: HIP runtime API usage
|
|
:keywords: AMD, ROCm, HIP, CUDA, 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. On the AMD platform, the HIP runtime uses
|
|
:doc:`Compute Language Runtime (CLR) <../understand/amd_clr>`, while on NVIDIA
|
|
CUDA platform, it is only a thin layer over the CUDA runtime or Driver API.
|
|
|
|
- **CLR** contains source code for AMD's compute language runtimes: ``HIP`` and
|
|
``OpenCL™``. CLR includes the ``HIP`` implementation on the AMD
|
|
platform: `hipamd <https://github.com/ROCm/clr/tree/develop/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
|
|
Windows. CLR also includes the `OpenCL runtime <https://github.com/ROCm/clr/tree/develop/opencl>`_
|
|
implementation.
|
|
- The **CUDA runtime** is built on top of the CUDA driver API, which is a C API
|
|
with lower-level access to NVIDIA GPUs. For details about the CUDA driver and
|
|
runtime API with reference to HIP, see :doc:`CUDA driver API porting guide <../how-to/hip_porting_driver_api>`.
|
|
|
|
The backends of HIP runtime API under AMD and NVIDIA platform are summarized in
|
|
the following figure:
|
|
|
|
.. figure:: ../data/how-to/hip_runtime_api/runtimes.svg
|
|
|
|
.. note::
|
|
|
|
On NVIDIA platform HIP runtime API calls CUDA runtime or CUDA driver via
|
|
hipother interface. For more information, see the `hipother repository <https://github.com/ROCm/hipother>`_.
|
|
|
|
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` |