From d71eea552e6335da8fa87604783864e1f35e2ac4 Mon Sep 17 00:00:00 2001 From: ROCm CI Service Account <66695075+rocm-ci@users.noreply.github.com> Date: Fri, 8 Jul 2022 13:36:55 +0530 Subject: [PATCH] SWDEV-342570, SWDEV-340007 - update HIP documents (#2780) Change-Id: If6c2de4dd8468984cd718aea4a8613d98269a736 [ROCm/hip commit: 8b90789c3a9676d8fa26d1b7b29768cf347ff821] --- projects/hip/docs/markdown/hip_build.md | 2 +- .../docs/markdown/hip_deprecated_api_list.md | 52 ++++++++++++++++++- .../docs/markdown/hip_programming_guide.md | 3 ++ 3 files changed, 54 insertions(+), 3 deletions(-) diff --git a/projects/hip/docs/markdown/hip_build.md b/projects/hip/docs/markdown/hip_build.md index 17bc1af955..54d85fa540 100755 --- a/projects/hip/docs/markdown/hip_build.md +++ b/projects/hip/docs/markdown/hip_build.md @@ -141,7 +141,7 @@ After build and install HIP commands, catch tests can be built via the following ``` cd "$HIP_DIR" mkdir -p build; cd build -export HIP_PATH=$HIPAMD_DIR/build +export HIP_PATH=$HIPAMD_DIR/build/install cmake ../tests/catch/ -DHIP_PLATFORM=amd make -j$(nproc) build_tests ctest # run tests diff --git a/projects/hip/docs/markdown/hip_deprecated_api_list.md b/projects/hip/docs/markdown/hip_deprecated_api_list.md index 783ea4a390..b26aceecee 100644 --- a/projects/hip/docs/markdown/hip_deprecated_api_list.md +++ b/projects/hip/docs/markdown/hip_deprecated_api_list.md @@ -1,9 +1,11 @@ # HIP Deprecated APIs + ## HIP Context Management APIs CUDA supports cuCtx API, the Driver API that defines "Context" and "Devices" as separate entities. Contexts contain a single device, and a device can theoretically have multiple contexts. HIP initially added limited support for these API to facilitate easy porting from existing driver codes. These API are marked as deprecated now since there are better alternate interface (such as hipSetDevice or the stream API) to achieve the required functions. - +### hipCtxCreate +### hipCtxDestroy ### hipCtxPopCurrent ### hipCtxPushCurrent ### hipCtxSetCurrent @@ -19,6 +21,7 @@ CUDA supports cuCtx API, the Driver API that defines "Context" and "Devices" as ### hipCtxEnablePeerAccess ### hipCtxDisablePeerAccess + ## HIP Memory Management APIs ### hipMallocHost @@ -31,4 +34,49 @@ Should use "hipHostMalloc" instead. Should use "hipHostMalloc" instead. ### hipFreeHost -Should use "hipHostFree" instead. \ No newline at end of file +Should use "hipHostFree" instead. + +### hipMemcpyToArray +### hipMemcpyFromArray + + +## HIP Profiler Control APIs + +### hipProfilerStart +Should use roctracer/rocTX instead + +### hipProfilerStop +Should use roctracer/rocTX instead + + +## HIP Texture Management APIs + +###hipGetTextureReference +###hipTexRefSetAddressMode +###hipTexRefSetArray +###hipTexRefSetFilterMode +###hipTexRefSetFlags +###hipTexRefSetFormat +###hipBindTexture +###hipBindTexture2D +###hipBindTextureToArray +###hipGetTextureAlignmentOffset +###hipUnbindTexture +###hipTexRefGetAddress +###hipTexRefGetAddressMode +###hipTexRefGetFilterMode +###hipTexRefGetFlags +###hipTexRefGetFormat +###hipTexRefGetMaxAnisotropy +###hipTexRefGetMipmapFilterMode +###hipTexRefGetMipmapLevelBias +###hipTexRefGetMipmapLevelClamp +###hipTexRefGetMipMappedArray +###hipTexRefSetAddress +###hipTexRefSetAddress2D +###hipTexRefSetMaxAnisotropy +###hipTexRefSetBorderColor +###hipTexRefSetMipmapFilterMode +###hipTexRefSetMipmapLevelBias +###hipTexRefSetMipmapLevelClamp +###hipTexRefSetMipmappedArray \ No newline at end of file diff --git a/projects/hip/docs/markdown/hip_programming_guide.md b/projects/hip/docs/markdown/hip_programming_guide.md index e9d25b06bc..9f48870300 100644 --- a/projects/hip/docs/markdown/hip_programming_guide.md +++ b/projects/hip/docs/markdown/hip_programming_guide.md @@ -129,6 +129,9 @@ For more details on hipRTC APIs, refer to HIP-API.pdf in GitHub (https://github. The link here(https://github.com/ROCm-Developer-Tools/HIP/blob/main/tests/src/hiprtc/saxpy.cpp) shows an example how to program HIP application using runtime compilation mechanism, and detail hipRTC programming guide is also available in Github (https://github.com/ROCm-Developer-Tools/HIP/blob/main/docs/markdown/hip_rtc.md). +## HIP Graph +HIP graph is supported. For more details, refer to the HIP API Guide. + ## Device-Side Malloc HIP-Clang now supports device-side malloc and free.