SWDEV-502480 - Update documentation from GitHub 2024-12-05
Change-Id: I179814351b77935aff55e8ae47dd322a3e15a868
This commit is contained in:
Istvan Kiss
@@ -6,87 +6,171 @@
|
||||
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 6.1.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 texture management functions.
|
||||
|
||||
* ``hipCtxCreate``
|
||||
* ``hipCtxDestroy``
|
||||
* ``hipCtxPopCurrent``
|
||||
* ``hipCtxPushCurrent``
|
||||
* ``hipCtxSetCurrent``
|
||||
* ``hipCtxGetCurrent``
|
||||
* ``hipCtxGetDevice``
|
||||
* ``hipCtxGetApiVersion``
|
||||
* ``hipCtxGetCacheConfig``
|
||||
* ``hipCtxSetCacheConfig``
|
||||
* ``hipCtxSetSharedMemConfig``
|
||||
* ``hipCtxGetSharedMemConfig``
|
||||
* ``hipCtxSynchronize``
|
||||
* ``hipCtxGetFlags``
|
||||
* ``hipCtxEnablePeerAccess``
|
||||
* ``hipCtxDisablePeerAccess``
|
||||
* ``hipDevicePrimaryCtxGetState``
|
||||
* ``hipDevicePrimaryCtxRelease``
|
||||
* ``hipDevicePrimaryCtxRetain``
|
||||
* ``hipDevicePrimaryCtxReset``
|
||||
* ``hipDevicePrimaryCtxSetFlags``
|
||||
.. list-table::
|
||||
:widths: 40
|
||||
:header-rows: 1
|
||||
:align: left
|
||||
|
||||
Memory management
|
||||
* - function
|
||||
* - :cpp:func:`hipTexRefGetBorderColor`
|
||||
* - :cpp:func:`hipTexRefGetArray`
|
||||
|
||||
Deprecated since ROCm 5.7.0
|
||||
============================================================
|
||||
|
||||
* ``hipMallocHost`` (replaced with ``hipHostMalloc``)
|
||||
* ``hipMemAllocHost`` (replaced with ``hipHostMalloc``)
|
||||
* ``hipMemcpyToArray``
|
||||
* ``hipMemcpyFromArray``
|
||||
Deprecated texture management functions.
|
||||
|
||||
Profiler control
|
||||
.. list-table::
|
||||
:widths: 40
|
||||
:header-rows: 1
|
||||
:align: left
|
||||
|
||||
* - function
|
||||
* - :cpp:func:`hipBindTextureToMipmappedArray`
|
||||
|
||||
Deprecated since ROCm 5.3.0
|
||||
============================================================
|
||||
|
||||
* ``hipProfilerStart`` (use roctracer/rocTX)
|
||||
* ``hipProfilerStop`` (use roctracer/rocTX)
|
||||
Deprecated texture management functions.
|
||||
|
||||
.. list-table::
|
||||
:widths: 40
|
||||
:header-rows: 1
|
||||
:align: left
|
||||
|
||||
Texture management
|
||||
* - function
|
||||
* - :cpp:func:`hipGetTextureReference`
|
||||
* - :cpp:func:`hipTexRefSetAddressMode`
|
||||
* - :cpp:func:`hipTexRefSetArray`
|
||||
* - :cpp:func:`hipTexRefSetFlags`
|
||||
* - :cpp:func:`hipTexRefSetFilterMode`
|
||||
* - :cpp:func:`hipTexRefSetFormat`
|
||||
* - :cpp:func:`hipTexRefSetMipmapFilterMode`
|
||||
* - :cpp:func:`hipTexRefSetMipmapLevelBias`
|
||||
* - :cpp:func:`hipTexRefSetMipmapLevelClamp`
|
||||
* - :cpp:func:`hipTexRefSetMipmappedArray`
|
||||
|
||||
Deprecated since ROCm 4.3.0
|
||||
============================================================
|
||||
|
||||
* ``hipGetTextureReference``
|
||||
* ``hipTexRefSetAddressMode``
|
||||
* ``hipTexRefSetArray``
|
||||
* ``hipTexRefSetFilterMode``
|
||||
* ``hipTexRefSetFlags``
|
||||
* ``hipTexRefSetFormat``
|
||||
* ``hipTexRefGetAddress``
|
||||
* ``hipTexRefGetAddressMode``
|
||||
* ``hipTexRefGetFilterMode``
|
||||
* ``hipTexRefGetFlags``
|
||||
* ``hipTexRefGetFormat``
|
||||
* ``hipTexRefGetMaxAnisotropy``
|
||||
* ``hipTexRefGetMipmapFilterMode``
|
||||
* ``hipTexRefGetMipmapLevelBias``
|
||||
* ``hipTexRefGetMipmapLevelClamp``
|
||||
* ``hipTexRefGetMipMappedArray``
|
||||
* ``hipTexRefSetAddress``
|
||||
* ``hipTexRefSetAddress2D``
|
||||
* ``hipTexRefSetMaxAnisotropy``
|
||||
* ``hipTexRefSetBorderColor``
|
||||
* ``hipTexRefSetMipmapFilterMode``
|
||||
* ``hipTexRefSetMipmapLevelBias``
|
||||
* ``hipTexRefSetMipmapLevelClamp``
|
||||
* ``hipTexRefSetMipmappedArray``
|
||||
* ``hipTexRefGetBorderColor``
|
||||
* ``hipTexRefGetArray``
|
||||
* ``hipBindTexture``
|
||||
* ``hipBindTexture2D``
|
||||
* ``hipBindTextureToArray``
|
||||
* ``hipGetTextureAlignmentOffset``
|
||||
* ``hipUnbindTexture``
|
||||
* ``hipBindTextureToMipmappedArray``
|
||||
Deprecated texture management functions.
|
||||
|
||||
.. list-table::
|
||||
:widths: 40
|
||||
:header-rows: 1
|
||||
:align: left
|
||||
|
||||
* - function
|
||||
* - :cpp:func:`hipTexRefGetAddress`
|
||||
* - :cpp:func:`hipTexRefGetAddressMode`
|
||||
* - :cpp:func:`hipTexRefGetFilterMode`
|
||||
* - :cpp:func:`hipTexRefGetFlags`
|
||||
* - :cpp:func:`hipTexRefGetFormat`
|
||||
* - :cpp:func:`hipTexRefGetMaxAnisotropy`
|
||||
* - :cpp:func:`hipTexRefGetMipmapFilterMode`
|
||||
* - :cpp:func:`hipTexRefGetMipmapLevelBias`
|
||||
* - :cpp:func:`hipTexRefGetMipmapLevelClamp`
|
||||
* - :cpp:func:`hipTexRefGetMipMappedArray`
|
||||
* - :cpp:func:`hipTexRefSetAddress`
|
||||
* - :cpp:func:`hipTexRefSetAddress2D`
|
||||
* - :cpp:func:`hipTexRefSetBorderColor`
|
||||
* - :cpp:func:`hipTexRefSetMaxAnisotropy`
|
||||
|
||||
Deprecated since ROCm 3.8.0
|
||||
============================================================
|
||||
|
||||
Deprecated memory management and texture management functions.
|
||||
|
||||
.. list-table::
|
||||
:widths: 40
|
||||
:header-rows: 1
|
||||
:align: left
|
||||
|
||||
* - function
|
||||
* - :cpp:func:`hipBindTexture`
|
||||
* - :cpp:func:`hipBindTexture2D`
|
||||
* - :cpp:func:`hipBindTextureToArray`
|
||||
* - :cpp:func:`hipGetTextureAlignmentOffset`
|
||||
* - :cpp:func:`hipUnbindTexture`
|
||||
* - :cpp:func:`hipMemcpyToArray`
|
||||
* - :cpp:func:`hipMemcpyFromArray`
|
||||
|
||||
Deprecated since ROCm 3.1.0
|
||||
============================================================
|
||||
|
||||
Deprecated memory management functions.
|
||||
|
||||
.. list-table::
|
||||
:widths: 40, 60
|
||||
:header-rows: 1
|
||||
:align: left
|
||||
|
||||
* - function
|
||||
-
|
||||
* - :cpp:func:`hipMallocHost`
|
||||
- replaced with :cpp:func:`hipHostAlloc`
|
||||
* - :cpp:func:`hipMemAllocHost`
|
||||
- replaced with :cpp:func:`hipHostAlloc`
|
||||
|
||||
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.
|
||||
|
||||
.. list-table::
|
||||
:widths: 40
|
||||
:header-rows: 1
|
||||
:align: left
|
||||
|
||||
* - function
|
||||
* - :cpp:func:`hipProfilerStart`
|
||||
* - :cpp:func:`hipProfilerStop`
|
||||
|
||||
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
|
||||
|
||||
* - function
|
||||
* - :cpp:func:`hipCtxCreate`
|
||||
* - :cpp:func:`hipCtxDestroy`
|
||||
* - :cpp:func:`hipCtxPopCurrent`
|
||||
* - :cpp:func:`hipCtxPushCurrent`
|
||||
* - :cpp:func:`hipCtxSetCurrent`
|
||||
* - :cpp:func:`hipCtxGetCurrent`
|
||||
* - :cpp:func:`hipCtxGetDevice`
|
||||
* - :cpp:func:`hipCtxGetApiVersion`
|
||||
* - :cpp:func:`hipCtxGetCacheConfig`
|
||||
* - :cpp:func:`hipCtxSetCacheConfig`
|
||||
* - :cpp:func:`hipCtxSetSharedMemConfig`
|
||||
* - :cpp:func:`hipCtxGetSharedMemConfig`
|
||||
* - :cpp:func:`hipCtxSynchronize`
|
||||
* - :cpp:func:`hipCtxGetFlags`
|
||||
* - :cpp:func:`hipCtxEnablePeerAccess`
|
||||
* - :cpp:func:`hipCtxDisablePeerAccess`
|
||||
* - :cpp:func:`hipDevicePrimaryCtxGetState`
|
||||
* - :cpp:func:`hipDevicePrimaryCtxRelease`
|
||||
* - :cpp:func:`hipDevicePrimaryCtxRetain`
|
||||
* - :cpp:func:`hipDevicePrimaryCtxReset`
|
||||
* - :cpp:func:`hipDevicePrimaryCtxSetFlags`
|
||||
|
||||
Reference in New Issue
Block a user