Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update deprecated API list + minor fix in faq.rst #3669

Merged
merged 2 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ Compiler related questions
hipcc detected my platform incorrectly. What should I do?
---------------------------------------------------------

The environment variable `HIP_PLATFORM` can be used to specify the platform for
which the code is going to be compiled with ``hipcc``. See the
The environment variable ``HIP_PLATFORM`` can be used to specify the platform
for which the code is going to be compiled with ``hipcc``. See the
:doc:`hipcc environment variables<hipcc:env>` for more information.

How to use HIP-Clang to build HIP programs?
Expand Down
21 changes: 19 additions & 2 deletions docs/reference/deprecated_api_list.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes in this file look good.

Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,23 @@ 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.

Deprecated since ROCm 6.3.0
============================================================

Deprecated memory management functions.

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

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

Deprecated since ROCm 6.1.0
============================================================

Expand Down Expand Up @@ -53,7 +70,7 @@ Deprecated texture management functions.
* - :cpp:func:`hipTexRefSetArray`
* - :cpp:func:`hipTexRefSetFlags`
* - :cpp:func:`hipTexRefSetFilterMode`
* - :cpp:func:`hipTexRefSetBorderColor`
* - :cpp:func:`hipTexRefSetFormat`
* - :cpp:func:`hipTexRefSetMipmapFilterMode`
* - :cpp:func:`hipTexRefSetMipmapLevelBias`
* - :cpp:func:`hipTexRefSetMipmapLevelClamp`
Expand All @@ -70,7 +87,6 @@ Deprecated texture management functions.
:align: left

* - function
* - :cpp:func:`hipTexRefSetFormat`
* - :cpp:func:`hipTexRefGetAddress`
* - :cpp:func:`hipTexRefGetAddressMode`
* - :cpp:func:`hipTexRefGetFilterMode`
Expand All @@ -83,6 +99,7 @@ Deprecated texture management functions.
* - :cpp:func:`hipTexRefGetMipMappedArray`
* - :cpp:func:`hipTexRefSetAddress`
* - :cpp:func:`hipTexRefSetAddress2D`
* - :cpp:func:`hipTexRefSetBorderColor`
* - :cpp:func:`hipTexRefSetMaxAnisotropy`

Deprecated since ROCm 3.8.0
Expand Down
16 changes: 9 additions & 7 deletions include/hip/hip_runtime_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -3444,11 +3444,6 @@ hipError_t hipMallocHost(void** ptr, size_t size);
*/
HIP_DEPRECATED("use hipHostAlloc instead")
hipError_t hipMemAllocHost(void** ptr, size_t size);
// end doxygen deprecated management memory
/**
* @}
*/

/**
* @brief Allocates device accessible page locked (pinned) host memory
*
Expand Down Expand Up @@ -3485,6 +3480,11 @@ hipError_t hipMemAllocHost(void** ptr, size_t size);
*/
HIP_DEPRECATED("use hipExtHostAlloc instead")
hipError_t hipHostMalloc(void** ptr, size_t size, unsigned int flags);
// end doxygen deprecated management memory
/**
* @}
*/

/**
* @brief Allocates device accessible page locked (pinned) host memory
*
Expand Down Expand Up @@ -9643,15 +9643,17 @@ static inline hipError_t hipExtHostAlloc(T** ptr, size_t size,
return hipExtHostAlloc((void**)ptr, size, flags);
}
/**
* @brief: C++ wrapper for hipHostMalloc
* @ingroup Memory
* @brief C++ wrapper for hipHostMalloc [Deprecated].
* @ingroup MemoryD
* Provide an override to automatically typecast the pointer type from void**, and also provide a
* default for the flags.
*
* __HIP_DISABLE_CPP_FUNCTIONS__ macro can be defined to suppress these
* wrappers. It is useful for applications which need to obtain decltypes of
* HIP runtime APIs.
*
* @warning This API is deprecated.
*
* @see hipHostMalloc
*/
template <class T>
Expand Down
Loading