Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
WIP
  • Loading branch information
neon60 committed Sep 16, 2024
1 parent cb79eb5 commit 0decb31
Showing 1 changed file with 65 additions and 38 deletions.
103 changes: 65 additions & 38 deletions docs/reference/deprecated_api_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,40 @@
HIP deprecated runtime API functions
**********************************************************************************************

Several of our API functions have been flagged for deprecation. Using the following functions results in errors and unexpected results, so we encourage you to update your code accordingly.
Several of our API functions have been flagged for deprecation. Using the
following functions results in errors and unexpected results, so we encourage
you to update your code accordingly.

Context management
Deprecated since ROCm 1.6.0
============================================================

CUDA supports cuCtx API, which is the driver API that defines "Context" and "Devices" as separate entities. Context contains a single device, and a device can theoretically have multiple contexts. HIP initially added limited support for these APIs in order to facilitate porting from existing driver codes. These APIs are now marked as deprecated because there are better alternate interfaces (such as ``hipSetDevice`` or the stream API) to achieve these functions.
Deprecated memory management functions.

.. list-table:: Deprecated context management functions
.. list-table::
:widths: 40, 60
:header-rows: 1
:align: left

* - function
-
* - :cpp:func:`hipMallocHost`
- replaced with :cpp:func:`hipHostMalloc`
* - :cpp:func:`hipMemAllocHost`
- replaced with :cpp:func:`hipHostMalloc`
* - :cpp:func:`hipFreeHost`
- replaced with :cpp:func:`hipHostFree`

Deprecated since ROCm 1.9.0
============================================================

CUDA supports cuCtx API, which is the driver API that defines "Context" and
"Devices" as separate entities. Context contains a single device, and a device
can theoretically have multiple contexts. HIP initially added limited support
for context APIs in order to facilitate porting from existing driver codes. These
APIs are now marked as deprecated because there are better alternate interfaces
(such as ``hipSetDevice`` or the stream API) to achieve these functions.

.. list-table::
:widths: 40
:header-rows: 1
:align: left
Expand Down Expand Up @@ -41,38 +67,15 @@ CUDA supports cuCtx API, which is the driver API that defines "Context" and "Dev
* - :cpp:func:`hipDevicePrimaryCtxReset`
* - :cpp:func:`hipDevicePrimaryCtxSetFlags`

Memory management
============================================================

.. list-table:: Deprecated memory management functions since ROCm 1.6.0
:widths: 40, 60
:header-rows: 1
:align: left

* - function
-
* - :cpp:func:`hipMallocHost`
- replaced with :cpp:func:`hipHostMalloc`
* - :cpp:func:`hipMemAllocHost`
- replaced with :cpp:func:`hipHostMalloc`
* - :cpp:func:`hipFreeHost`
- replaced with :cpp:func:`hipHostFree`

.. list-table:: Deprecated memory management functions since ROCm 3.8.0
:widths: 40
:header-rows: 1
:align: left

* - function
* - :cpp:func:`hipMemcpyToArray`
* - :cpp:func:`hipMemcpyFromArray`

Profiler control
Deprecated since ROCm 3.0.0
============================================================

The ``hipProfilerStart`` and ``hipProfilerStop`` functions are deprecated. Instead, you can use ``roctracer`` or ``rocTX`` for profiling which provide more flexibility and detailed profiling capabilities.
The ``hipProfilerStart`` and ``hipProfilerStop`` functions are deprecated.
Instead, you can use ``roctracer`` or ``rocTX`` for profiling which provide more
flexibility and detailed profiling capabilities.

.. list-table:: Deprecated profiler control functions since ROCm 3.0.0
.. list-table::
:widths: 40
:header-rows: 1
:align: left
Expand All @@ -81,10 +84,12 @@ The ``hipProfilerStart`` and ``hipProfilerStop`` functions are deprecated. Inste
* - :cpp:func:`hipProfilerStart`
* - :cpp:func:`hipProfilerStop`

Texture management
Deprecated since ROCm 3.8.0
============================================================

.. list-table:: Deprecated texture management functions since ROCm 3.8.0
Deprecated memory management and texture management functions.

.. list-table::
:widths: 40
:header-rows: 1
:align: left
Expand All @@ -95,8 +100,15 @@ Texture management
* - :cpp:func:`hipBindTextureToArray`
* - :cpp:func:`hipGetTextureAlignmentOffset`
* - :cpp:func:`hipUnbindTexture`
* - :cpp:func:`hipMemcpyToArray`
* - :cpp:func:`hipMemcpyFromArray`

Deprecated since ROCm 4.3.0
============================================================

Deprecated texture management functions.

.. list-table:: Deprecated texture management functions since ROCm 4.3.0
.. list-table::
:widths: 40
:header-rows: 1
:align: left
Expand All @@ -118,7 +130,12 @@ Texture management
* - :cpp:func:`hipTexRefSetAddress2D`
* - :cpp:func:`hipTexRefSetMaxAnisotropy`

.. list-table:: Deprecated texture management functions since ROCm 5.3.0
Deprecated since ROCm 5.3.0
============================================================

Deprecated texture management functions.

.. list-table::
:widths: 40
:header-rows: 1
:align: left
Expand All @@ -134,15 +151,25 @@ Texture management
* - :cpp:func:`hipTexRefSetMipmapLevelClamp`
* - :cpp:func:`hipTexRefSetMipmappedArray`

.. list-table:: Deprecated texture management function since ROCm 5.7.0
Deprecated since ROCm 5.7.0
============================================================

Deprecated texture management functions.

.. list-table::
:widths: 40
:header-rows: 1
:align: left

* - function
* - :cpp:func:`hipBindTextureToMipmappedArray`

.. list-table:: Deprecated texture management function since ROCm 6.1.0
Deprecated since ROCm 6.1.0
============================================================

Deprecated texture management functions.

.. list-table::
:widths: 40
:header-rows: 1
:align: left
Expand Down

0 comments on commit 0decb31

Please sign in to comment.