randyh62
1240b592a5
* Update README-doc.md Correct GitHub URL for components moved into rocm-systems * Update amd_clr.rst Update github.com URLs * Update Dockerfile Update rocm-systems paths * Update CONTRIBUTING.md update for rocm-systems * Update CONTRIBUTING.md minor change * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update hip_runtime_api.rst Update for rocm-systems * Update installation.rst update URL to libhsakmt * Update what_is_hip.rst * Update projects/clr/CONTRIBUTING.md Co-authored-by: Dominic Widdows <dwiddows@gmail.com> * Update projects/clr/README-doc.md Co-authored-by: Dominic Widdows <dwiddows@gmail.com> * Update Dockerfile Update git clone for sparse checkout * Update projects/hip/CONTRIBUTING.md * Update projects/clr/CONTRIBUTING.md * Update projects/hipother/CONTRIBUTING.md --------- Co-authored-by: Dominic Widdows <dwiddows@gmail.com>
50 línte
2.3 KiB
ReStructuredText
50 línte
2.3 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/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
|
|
Windows. CLR also includes the `OpenCL runtime <https://github.com/ROCm/rocm-systems/tree/develop/projects/clr/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/rocm-systems/tree/develop/projects/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`
|