From d5e490ad503563c7b827f4a0555b9e7c0c35f958 Mon Sep 17 00:00:00 2001 From: Istvan Kiss Date: Tue, 2 Jul 2024 14:51:39 +0200 Subject: [PATCH] Internal review --- docs/how-to/stream_ordered_allocator.rst | 162 ++++--------- docs/index.md | 2 +- docs/sphinx/_toc.yml.in | 3 +- include/hip/hip_runtime_api.h | 278 +++++++++++------------ 4 files changed, 188 insertions(+), 257 deletions(-) diff --git a/docs/how-to/stream_ordered_allocator.rst b/docs/how-to/stream_ordered_allocator.rst index 6a52552ae9..d7b45f83a9 100644 --- a/docs/how-to/stream_ordered_allocator.rst +++ b/docs/how-to/stream_ordered_allocator.rst @@ -6,43 +6,25 @@ Stream Ordered Memory Allocator ******************************************************************************* -The Stream Ordered Memory Allocator (SOMA) is part of the HIP runtime API. It -provides an asynchronous memory allocation mechanism with stream-ordering -semantics. With SOMA, you can allocate and free memory in stream order, -ensuring that all asynchronous accesses occur between the stream executions of -allocation and de-allocation. Compliance with stream order prevents -use-before-allocation or use-after-free errors, which would otherwise lead to -undefined behavior. +The Stream Ordered Memory Allocator (SOMA) is part of the HIP runtime API. It provides an asynchronous memory allocation mechanism with stream-ordering semantics. With SOMA, you can allocate and free memory in stream order, ensuring that all asynchronous accesses occur between the stream executions of allocation and de-allocation. Compliance with stream order prevents use-before-allocation or use-after-free errors, which would otherwise lead to undefined behavior. Advantages of SOMA: -- Efficient Reuse: SOMA enables efficient memory reuse across streams, reducing - unnecessary allocation overhead. -- Fine-Grained Control: You can set attributes and control caching behavior for - memory pools. -- Inter-Process Sharing: Secure sharing of allocations between processes is - possible. -- Optimizations: The driver can optimize based on its awareness of SOMA and - other stream management APIs. +- Efficient reuse: SOMA enables efficient memory reuse across streams, reducing unnecessary allocation overhead. +- Fine-grained control: You can set attributes and control caching behavior for memory pools. +- Inter-process sharing: Secure sharing of allocations between processes is possible. +- Optimizations: The driver can optimize based on its awareness of SOMA and other stream management APIs. Disadvantages of SOMA: -- Temporal Constraints: Developers must adhere strictly to stream order to - avoid errors. + +- Temporal constraints: Developers must adhere strictly to stream order to avoid errors. - Complexity: Properly managing memory in stream order can be intricate. -- Learning Curve: Understanding and utilizing SOMA effectively may require - additional effort. +- Learning curve: Understanding and utilizing SOMA effectively may require additional effort. -How is Stream Ordered Memory Allocator Used? -============================================ +Stream ordered memory allocator usage +===================================== -Users can allocate memory using ``hipMallocAsync()`` with stream-ordered -semantics. This means that all asynchronous accesses to the allocation must -occur between the stream executions of the allocation and the free. -If memory is accessed outside of this promised stream order, it can lead to -undefined behavior (e.g., use before allocation or use after free errors). -The allocator may reallocate memory as long as it guarantees compliant memory -accesses will not overlap temporally. ``hipFreeAsync()`` frees memory from the -pool with stream-ordered semantics. +Users can allocate memory using ``hipMallocAsync()`` with stream-ordered semantics. This means that all asynchronous accesses to the allocation must occur between the stream executions of the allocation and the free. If memory is accessed outside of this promised stream order, it can lead to undefined behavior (e.g., use before allocation or use after free errors). The allocator may reallocate memory as long as it guarantees compliant memory accesses will not overlap temporally. ``hipFreeAsync()`` frees memory from the pool with stream-ordered semantics. The following example explains how to use stream ordered memory allocation. @@ -127,27 +109,17 @@ The following example explains how to use stream ordered memory allocation. return 0; } -Memory Pools +Memory pools ============ -Memory pools provide a way to manage memory with stream-ordered behavior, -ensuring proper synchronization and avoiding memory access errors. Division of -a single memory system into separate pools allows querying each partition's -access path properties. Memory pools are used for host memory, device memory, -and unified memory. +Memory pools provide a way to manage memory with stream-ordered behavior, ensuring proper synchronization and avoiding memory access errors. Division of a single memory system into separate pools allows querying each partition's access path properties. Memory pools are used for host memory, device memory, and unified memory. -Set Pools +Set pools --------- -The ``hipMallocAsync()`` function uses the current memory pool, while also -providing the opportunity to create and use different pools with the -``hipMemPoolCreate()`` and ``hipMallocFromPoolAsync()`` functions -respectively. +The ``hipMallocAsync()`` function uses the current memory pool, while also providing the opportunity to create and use different pools with the ``hipMemPoolCreate()`` and ``hipMallocFromPoolAsync()`` functions respectively. -Unlike CUDA, where stream-ordered memory allocation can be implicit, in AMD -HIP, it's always explicit. This means that you need to manage memory allocation -for each stream, ensuring precise control over memory usage and -synchronization. +Unlike CUDA, where stream-ordered memory allocation can be implicit, in AMD HIP, it's always explicit. This means that you need to manage memory allocation for each stream, ensuring precise control over memory usage and synchronization. .. code-block::cpp @@ -192,27 +164,18 @@ synchronization. return 0; } -Trim Pools +Trim pools ---------- -The memory allocator allows you to allocate and free memory in stream order. -To control memory usage, the release threshold attribute can be set by -``hipMemPoolAttrReleaseThreshold``. This threshold specifies the amount of -reserved memory in bytes that a pool should hold onto before attempting to -release memory back to the operating system. +The memory allocator allows you to allocate and free memory in stream order. To control memory usage, the release threshold attribute can be set by ``hipMemPoolAttrReleaseThreshold``. This threshold specifies the amount of reserved memory in bytes that a pool should hold onto before attempting to release memory back to the operating system. .. code-block::cpp uint64_t threshold = UINT64_MAX; hipMemPoolSetAttribute(memPool, hipMemPoolAttrReleaseThreshold, &threshold); -When more than the specified threshold bytes of memory are held by the -memory pool, the allocator will try to release memory back to the operating -system during the next call to stream, event, or context synchronization. +When more than the specified threshold bytes of memory are held by the memory pool, the allocator will try to release memory back to the operating system during the next call to stream, event, or context synchronization. -Sometimes for a better performance it is a good practice to adjust the memory -pool size with ``hipMemPoolTrimTo()``. It can be useful to reclaim memory from -a memory pool that is larger than necessary, optimizing memory usage for your -application. +Sometimes for a better performance it is a good practice to adjust the memory pool size with ``hipMemPoolTrimTo()``. It can be useful to reclaim memory from a memory pool that is larger than necessary, optimizing memory usage for your application. .. code-block::cpp @@ -246,19 +209,15 @@ application. } -Resource Usage Statistics +Resource usage statistics ------------------------- -Resource usage statistics can help in optimization. The following pool -attributes to query memory usage: - - - ``hipMemPoolAttrReservedMemCurrent`` returns the current total physical - GPU memory consumed by the pool. - - ``hipMemPoolAttrUsedMemCurrent`` returns the total size of all memory - allocated from the pool. - - ``hipMemPoolAttrReservedMemHigh`` returns the total physical GPU memory - consumed by the pool since the last reset. - - ``hipMemPoolAttrUsedMemHigh`` returns the all memory allocated from the - pool since the last reset. + +Resource usage statistics can help in optimization. The following pool attributes to query memory usage: + + - ``hipMemPoolAttrReservedMemCurrent`` returns the current total physical GPU memory consumed by the pool. + - ``hipMemPoolAttrUsedMemCurrent`` returns the total size of all memory allocated from the pool. + - ``hipMemPoolAttrReservedMemHigh`` returns the total physical GPU memory consumed by the pool since the last reset. + - ``hipMemPoolAttrUsedMemHigh`` returns the all memory allocated from the pool since the last reset. You can reset them to the current value using the ``hipMemPoolSetAttribute()``. @@ -288,47 +247,33 @@ You can reset them to the current value using the ``hipMemPoolSetAttribute()``. uint64_t value = 0; hipMemPoolSetAttribute(memPool, hipMemPoolAttrReservedMemHigh, &value); hipMemPoolSetAttribute(memPool, hipMemPoolAttrUsedMemHigh, &value); -} - + } -Memory Reuse Policies +Memory reuse policies --------------------- -The allocator may reallocate memory as long as it guarantees that compliant -memory accesses won't overlap temporally. Turning on and of the following -memory pool reuse policy attribute flags can optimize the memory use: - - - ``hipMemPoolReuseFollowEventDependencies`` checks event - dependencies before allocating additional GPU memory. - - ``hipMemPoolReuseAllowOpportunistic`` checks freed allocations to - determine if the stream order semantic indicated by the free operation - has been met. - - ``hipMemPoolReuseAllowInternalDependencies`` manages reuse based on - internal dependencies in runtime. If the driver fails to allocate and map - additional physical memory, it will search for memory that relies on - another stream's pending progress and reuse it. - -Device Accessibility for Multi-GPU Support +The allocator may reallocate memory as long as it guarantees that compliant memory accesses won't overlap temporally. Turning on and of the following memory pool reuse policy attribute flags can optimize the memory use: + + - ``hipMemPoolReuseFollowEventDependencies`` checks event dependencies before allocating additional GPU memory. + - ``hipMemPoolReuseAllowOpportunistic`` checks freed allocations to determine if the stream order semantic indicated by the free operation has been met. + - ``hipMemPoolReuseAllowInternalDependencies`` manages reuse based on internal dependencies in runtime. If the driver fails to allocate and map additional physical memory, it will search for memory that relies on another stream's pending progress and reuse it. + +Device accessibility for multi-GPU support ------------------------------------------ Allocations are initially accessible only from the device where they reside. -Inter-process Memory Handling +Inter-process memory handling ============================= -Inter-process capable (IPC) memory pools facilitate efficient and secure -sharing of GPU memory between processes. +Inter-process capable (IPC) memory pools facilitate efficient and secure sharing of GPU memory between processes. -There are two ways for inter-process memory sharing: pointer sharing or -shareable handles. Both have allocator (export) and consumer (import) -interface. +There are two ways for inter-process memory sharing: pointer sharing or shareable handles. Both have allocator (export) and consumer (import) interface. -Device Pointer +Device pointer -------------- -The ``hipMemPoolExportPointer()`` function allows to export data to share a -memory pool pointer directly between processes. It is useful to share a memory -allocation with another process. +The ``hipMemPoolExportPointer()`` function allows to export data to share a memory pool pointer directly between processes. It is useful to share a memory allocation with another process. .. code-block::cpp @@ -364,11 +309,9 @@ allocation with another process. return 0; } -The ``hipMemPoolImportPointer()`` function allows to import a memory pool -pointer directly from another process. +The ``hipMemPoolImportPointer()`` function allows to import a memory pool pointer directly from another process. -Here is the example code to read the exported -pool from the previous example. +Here is the example code to read the exported pool from the previous example. .. code-block::cpp @@ -404,13 +347,10 @@ pool from the previous example. return 0; } -Shareable Handle +Shareable handle ---------------- -The ``hipMemPoolExportToSharedHandle()`` is used to export a memory pool -pointer to a shareable handle. This handle can be a file descriptor or a handle -obtained from another process. The exported handle contains information about -the memory pool, including its size, location, and other relevant details. +The ``hipMemPoolExportToSharedHandle()`` is used to export a memory pool pointer to a shareable handle. This handle can be a file descriptor or a handle obtained from another process. The exported handle contains information about the memory pool, including its size, location, and other relevant details. .. code-block::cpp @@ -446,15 +386,7 @@ the memory pool, including its size, location, and other relevant details. return 0; } -The ``hipMemPoolImportFromShareableHandle()`` function is used to import a -memory pool pointer from a shareable handle -- such as a file descriptor or a -handle obtained from another process. It allows to restore a memory pool -pointer that was previously exported using ``hipMemPoolExportPointer()`` or a -similar mechanism. The exported shareable handle data contains information -about the memory pool, including its size, location, and other relevant -details. After importing, valid memory pointer is received that points to the -same memory area. Useful for inter-process communication or sharing memory -across different contexts. +The ``hipMemPoolImportFromShareableHandle()`` function is used to import a memory pool pointer from a shareable handle -- such as a file descriptor or a handle obtained from another process. It allows to restore a memory pool pointer that was previously exported using ``hipMemPoolExportPointer()`` or a similar mechanism. The exported shareable handle data contains information about the memory pool, including its size, location, and other relevant details. After importing, valid memory pointer is received that points to the same memory area. Useful for inter-process communication or sharing memory across different contexts. .. code-block::cpp diff --git a/docs/index.md b/docs/index.md index 602f3715a0..930e930d9a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,10 +43,10 @@ On non-AMD platforms, like NVIDIA, HIP provides header files required to support * [HIP Porting: Driver API Guide](./how-to/hip_porting_driver_api) * {doc}`./how-to/hip_rtc` * {doc}`./how-to/performance_guidelines` -* {doc}`./how-to/stream_ordered_allocator` * [Debugging with HIP](./how-to/debugging) * {doc}`./how-to/logging` * [Unified Memory](./how-to/unified_memory) +* {doc}`./how-to/stream_ordered_allocator` * {doc}`./how-to/faq` ::: diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index e0fdd20af5..52ea04ee81 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -27,11 +27,10 @@ subtrees: - file: how-to/hip_porting_driver_api - file: how-to/hip_rtc - file: how-to/performance_guidelines - - file: how-to/stream_ordered_allocator - file: how-to/debugging - file: how-to/logging - file: how-to/unified_memory - title: Unified Memory + - file: how-to/stream_ordered_allocator - file: how-to/faq - caption: Reference diff --git a/include/hip/hip_runtime_api.h b/include/hip/hip_runtime_api.h index bb1fabc8b8..c1f41e0271 100644 --- a/include/hip/hip_runtime_api.h +++ b/include/hip/hip_runtime_api.h @@ -1918,7 +1918,7 @@ hipError_t hipDeviceGetAttribute(int* pi, hipDeviceAttribute_t attr, int deviceI * @see hipDeviceGetDefaultMemPool, hipMallocAsync, hipMemPoolTrimTo, hipMemPoolGetAttribute, * hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDeviceGetDefaultMemPool(hipMemPool_t* mem_pool, int device); @@ -1940,7 +1940,7 @@ hipError_t hipDeviceGetDefaultMemPool(hipMemPool_t* mem_pool, int device); * @see hipDeviceGetDefaultMemPool, hipMallocAsync, hipMemPoolTrimTo, hipMemPoolGetAttribute, * hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDeviceSetMemPool(int device, hipMemPool_t mem_pool); @@ -1960,7 +1960,7 @@ hipError_t hipDeviceSetMemPool(int device, hipMemPool_t mem_pool); * @see hipDeviceGetDefaultMemPool, hipMallocAsync, hipMemPoolTrimTo, hipMemPoolGetAttribute, * hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDeviceGetMemPool(hipMemPool_t* mem_pool, int device); @@ -2807,7 +2807,7 @@ hipError_t hipEventCreate(hipEvent_t* event); * If this function is called on an event that is currently being recorded, results are undefined * - either outstanding recording may save state into the event, and the order is not guaranteed. * - * @note: If this function is not called before use hipEventQuery() or hipEventSynchronize(), + * @note If this function is not called before use hipEventQuery() or hipEventSynchronize(), * #hipSuccess is returned, meaning no pending event in the stream. * * @see hipEventCreate, hipEventCreateWithFlags, hipEventQuery, hipEventSynchronize, @@ -2895,7 +2895,7 @@ hipError_t hipEventElapsedTime(float* ms, hipEvent_t start, hipEvent_t stop); * commands in the appropriate stream (specified to hipEventRecord()) have completed. If any execution * has not completed, then #hipErrorNotReady is returned. * - * @note: This API returns #hipSuccess, if hipEventRecord() is not called before this API. + * @note This API returns #hipSuccess, if hipEventRecord() is not called before this API. * * @see hipEventCreate, hipEventCreateWithFlags, hipEventRecord, hipEventDestroy, * hipEventSynchronize, hipEventElapsedTime @@ -3388,7 +3388,7 @@ hipError_t hipStreamAttachMemAsync(hipStream_t stream, * @see hipMallocFromPoolAsync, hipFreeAsync, hipMemPoolTrimTo, hipMemPoolGetAttribute, * hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3413,7 +3413,7 @@ hipError_t hipMallocAsync(void** dev_ptr, size_t size, hipStream_t stream); * @see hipMallocFromPoolAsync, hipMallocAsync, hipMemPoolTrimTo, hipMemPoolGetAttribute, * hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warnings This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3427,8 +3427,8 @@ hipError_t hipFreeAsync(void* dev_ptr, hipStream_t stream); * The allocator cannot release OS allocations that back outstanding asynchronous allocations. * The OS allocations may happen at different granularity from the user allocations. * - * @note: Allocations that have not been freed count as outstanding. - * @note: Allocations that have been asynchronously freed but whose completion has + * @note Allocations that have not been freed count as outstanding. + * @note Allocations that have been asynchronously freed but whose completion has * not been observed on the host (eg. by a synchronize) can count as outstanding. * * @param[in] mem_pool The memory pool to trim allocations @@ -3441,7 +3441,7 @@ hipError_t hipFreeAsync(void* dev_ptr, hipStream_t stream); * @see hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, * hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3480,7 +3480,7 @@ hipError_t hipMemPoolTrimTo(hipMemPool_t mem_pool, size_t min_bytes_to_hold); * @see hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, * hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3519,7 +3519,7 @@ hipError_t hipMemPoolSetAttribute(hipMemPool_t mem_pool, hipMemPoolAttr attr, vo * @see hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, * hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3537,7 +3537,7 @@ hipError_t hipMemPoolGetAttribute(hipMemPool_t mem_pool, hipMemPoolAttr attr, vo * @see hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, * hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3557,7 +3557,7 @@ hipError_t hipMemPoolSetAccess(hipMemPool_t mem_pool, const hipMemAccessDesc* de * @see hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, * hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3581,7 +3581,7 @@ hipError_t hipMemPoolGetAccess(hipMemAccessFlags* flags, hipMemPool_t mem_pool, * @see hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, hipMemPoolDestroy, * hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3608,7 +3608,7 @@ hipError_t hipMemPoolCreate(hipMemPool_t* mem_pool, const hipMemPoolProps* pool_ * @see hipMallocFromPoolAsync, hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, hipMemPoolCreate * hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3642,7 +3642,7 @@ hipError_t hipMemPoolDestroy(hipMemPool_t mem_pool); * @see hipMallocAsync, hipFreeAsync, hipMemPoolGetAttribute, hipMemPoolCreate * hipMemPoolTrimTo, hipDeviceSetMemPool, hipMemPoolSetAttribute, hipMemPoolSetAccess, hipMemPoolGetAccess, * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3657,7 +3657,7 @@ hipError_t hipMallocFromPoolAsync(void** dev_ptr, size_t size, hipMemPool_t mem_ * The implementation of what the shareable handle is and how it can be transferred is defined by the requested * handle type. * - * @note: To create an IPC capable mempool, create a mempool with a @p hipMemAllocationHandleType other + * @note To create an IPC capable mempool, create a mempool with a @p hipMemAllocationHandleType other * than @p hipMemHandleTypeNone. * * @param [out] shared_handle Pointer to the location in which to store the requested handle @@ -3669,7 +3669,7 @@ hipError_t hipMallocFromPoolAsync(void** dev_ptr, size_t size, hipMemPool_t mem_ * * @see hipMemPoolImportFromShareableHandle * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3697,7 +3697,7 @@ hipError_t hipMemPoolExportToShareableHandle( * * @see hipMemPoolExportToShareableHandle * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3721,7 +3721,7 @@ hipError_t hipMemPoolImportFromShareableHandle( * * @see hipMemPoolImportPointer * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -3750,7 +3750,7 @@ hipError_t hipMemPoolExportPointer(hipMemPoolPtrExportData* export_data, void* d * * @see hipMemPoolExportPointer * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -5790,7 +5790,7 @@ hipError_t hipOccupancyMaxPotentialBlockSize(int* gridSize, int* blockSize, * @brief Start recording of profiling information * When using this API, start the profiler with profiling disabled. (--startdisabled) * @returns #hipErrorNotSupported - * @warning : hipProfilerStart API is deprecated, use roctracer/rocTX instead. + * @warning hipProfilerStart API is deprecated, use roctracer/rocTX instead. */ DEPRECATED("use roctracer/rocTX instead") hipError_t hipProfilerStart(); @@ -6844,7 +6844,7 @@ int hipGetStreamDeviceId(hipStream_t stream); * * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6864,7 +6864,7 @@ are not safe. * * @returns #hipSuccess, #hipErrorInvalidValue * -* @warning : param "const hipGraphEdgeData* dependencyData" is currently not supported and has to +* @warning param "const hipGraphEdgeData* dependencyData" is currently not supported and has to passed as nullptr. This API is marked as beta, meaning, while this is feature complete, it is still open to changes and may have outstanding issues. * @@ -6882,7 +6882,7 @@ hipError_t hipStreamBeginCaptureToGraph(hipStream_t stream, hipGraph_t graph, * * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6897,7 +6897,7 @@ hipError_t hipStreamEndCapture(hipStream_t stream, hipGraph_t* pGraph); * * @returns #hipSuccess, #hipErrorStreamCaptureImplicit * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6916,7 +6916,7 @@ hipError_t hipStreamGetCaptureInfo(hipStream_t stream, hipStreamCaptureStatus* p * * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorStreamCaptureImplicit * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6934,7 +6934,7 @@ hipError_t hipStreamGetCaptureInfo_v2(hipStream_t stream, hipStreamCaptureStatus * * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorStreamCaptureImplicit * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6950,7 +6950,7 @@ hipError_t hipStreamIsCapturing(hipStream_t stream, hipStreamCaptureStatus* pCap * #hipStreamUpdateCaptureDependenciesFlags * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorIllegalState * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6964,7 +6964,7 @@ hipError_t hipStreamUpdateCaptureDependencies(hipStream_t stream, hipGraphNode_t * @param [in] mode - Pointer to mode value to swap with the current mode * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6978,7 +6978,7 @@ hipError_t hipThreadExchangeStreamCaptureMode(hipStreamCaptureMode* mode); * * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryAllocation * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -6991,7 +6991,7 @@ hipError_t hipGraphCreate(hipGraph_t* pGraph, unsigned int flags); * * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7006,7 +7006,7 @@ hipError_t hipGraphDestroy(hipGraph_t graph); * @param [in] numDependencies - the number of dependencies to add. * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7022,7 +7022,7 @@ hipError_t hipGraphAddDependencies(hipGraph_t graph, const hipGraphNode_t* from, * @param [in] numDependencies - the number of dependencies to remove. * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7042,7 +7042,7 @@ hipError_t hipGraphRemoveDependencies(hipGraph_t graph, const hipGraphNode_t* fr * numEdges. Otherwise, numEdges entries will be filled in. If numEdges is higher than the actual * number of edges, the remaining entries in from and to will be set to NULL, and the number of * edges actually returned will be written to numEdges - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7061,7 +7061,7 @@ hipError_t hipGraphGetEdges(hipGraph_t graph, hipGraphNode_t* from, hipGraphNode * Otherwise, numNodes entries will be filled in. If numNodes is higher than the actual number of * nodes, the remaining entries in nodes will be set to NULL, and the number of nodes actually * obtained will be returned in numNodes. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7079,7 +7079,7 @@ hipError_t hipGraphGetNodes(hipGraph_t graph, hipGraphNode_t* nodes, size_t* num * pNumRootNodes. Otherwise, pNumRootNodes entries will be filled in. If pNumRootNodes is higher * than the actual number of root nodes, the remaining entries in pRootNodes will be set to NULL, * and the number of nodes actually obtained will be returned in pNumRootNodes. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7098,7 +7098,7 @@ hipError_t hipGraphGetRootNodes(hipGraph_t graph, hipGraphNode_t* pRootNodes, * pNumDependencies. Otherwise, pNumDependencies entries will be filled in. If pNumDependencies is * higher than the actual number of dependencies, the remaining entries in pDependencies will be set * to NULL, and the number of nodes actually obtained will be returned in pNumDependencies. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7118,7 +7118,7 @@ hipError_t hipGraphNodeGetDependencies(hipGraphNode_t node, hipGraphNode_t* pDep * pNumDependentNodes is higher than the actual number of dependent nodes, the remaining entries in * pDependentNodes will be set to NULL, and the number of nodes actually obtained will be returned * in pNumDependentNodes. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7132,7 +7132,7 @@ hipError_t hipGraphNodeGetDependentNodes(hipGraphNode_t node, hipGraphNode_t* pD * @param [out] pType - pointer to the return the type * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7144,7 +7144,7 @@ hipError_t hipGraphNodeGetType(hipGraphNode_t node, hipGraphNodeType* pType); * @param [in] node - graph node to remove * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7157,7 +7157,7 @@ hipError_t hipGraphDestroyNode(hipGraphNode_t node); * @param [in] originalGraph - original graph to clone from. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryAllocation * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7171,7 +7171,7 @@ hipError_t hipGraphClone(hipGraph_t* pGraphClone, hipGraph_t originalGraph); * @param [in] clonedGraph - Cloned graph to query. * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7190,7 +7190,7 @@ hipError_t hipGraphNodeFindInClone(hipGraphNode_t* pNode, hipGraphNode_t origina * * @returns #hipSuccess, #hipErrorOutOfMemory * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * */ @@ -7205,7 +7205,7 @@ hipError_t hipGraphInstantiate(hipGraphExec_t* pGraphExec, hipGraph_t graph, * @param [in] flags - Flags to control instantiation. * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues.It does not support * any of flag and is behaving as hipGraphInstantiate. */ @@ -7220,7 +7220,7 @@ hipError_t hipGraphInstantiateWithFlags(hipGraphExec_t* pGraphExec, hipGraph_t g * @param [in] instantiateParams - Graph Instantiate Params * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphInstantiateWithParams(hipGraphExec_t* pGraphExec, hipGraph_t graph, @@ -7232,7 +7232,7 @@ hipError_t hipGraphInstantiateWithParams(hipGraphExec_t* pGraphExec, hipGraph_t * @param [in] stream - instance of stream in which to launch executable graph. * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphLaunch(hipGraphExec_t graphExec, hipStream_t stream); @@ -7244,7 +7244,7 @@ hipError_t hipGraphLaunch(hipGraphExec_t graphExec, hipStream_t stream); * @param [in] stream - instance of stream in which to launch executable graph. * @returns #hipSuccess, #hipErrorInvalidValue * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphUpload(hipGraphExec_t graphExec, hipStream_t stream); @@ -7258,7 +7258,7 @@ hipError_t hipGraphUpload(hipGraphExec_t graphExec, hipStream_t stream); * @param [in] numDependencies - the number of the dependencies. * @param [in] nodeParams - pointer to the parameters for the node. * @returns #hipSuccess, #hipErrorInvalidValue. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddNode(hipGraphNode_t *pGraphNode, hipGraph_t graph, @@ -7271,7 +7271,7 @@ hipError_t hipGraphAddNode(hipGraphNode_t *pGraphNode, hipGraph_t graph, * @param [in] graphExec - Executable graph to get the flags. * @param [out] flags - Flags used to instantiate this executable graph. * @returns #hipSuccess, #hipErrorInvalidValue. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecGetFlags(hipGraphExec_t graphExec, unsigned long long* flags); @@ -7282,7 +7282,7 @@ hipError_t hipGraphExecGetFlags(hipGraphExec_t graphExec, unsigned long long* fl * @param [in] node - instance of the node to set parameters to. * @param [in] nodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorInvalidDeviceFunction, #hipErrorNotSupported. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphNodeSetParams(hipGraphNode_t node, hipGraphNodeParams *nodeParams); @@ -7294,7 +7294,7 @@ hipError_t hipGraphNodeSetParams(hipGraphNode_t node, hipGraphNodeParams *nodePa * @param [in] node - instance of the node to set parameters to. * @param [in] nodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorInvalidDeviceFunction, #hipErrorNotSupported. - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecNodeSetParams(hipGraphExec_t graphExec, hipGraphNode_t node, hipGraphNodeParams* nodeParams); @@ -7306,7 +7306,7 @@ hipError_t hipGraphExecNodeSetParams(hipGraphExec_t graphExec, hipGraphNode_t no * * @returns #hipSuccess. * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecDestroy(hipGraphExec_t graphExec); @@ -7322,7 +7322,7 @@ hipError_t hipGraphExecDestroy(hipGraphExec_t graphExec); * @param [in] updateResult_out - Whether the graph update was permitted. * @returns #hipSuccess, #hipErrorGraphExecUpdateFailure * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecUpdate(hipGraphExec_t hGraphExec, hipGraph_t hGraph, @@ -7338,7 +7338,7 @@ hipError_t hipGraphExecUpdate(hipGraphExec_t hGraphExec, hipGraph_t hGraph, * @param [in] numDependencies - the number of the dependencies. * @param [in] pNodeParams - pointer to the parameters to the kernel execution node on the GPU. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorInvalidDeviceFunction - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddKernelNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7351,7 +7351,7 @@ hipError_t hipGraphAddKernelNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] node - instance of the node to get parameters from. * @param [out] pNodeParams - pointer to the parameters * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphKernelNodeGetParams(hipGraphNode_t node, hipKernelNodeParams* pNodeParams); @@ -7362,7 +7362,7 @@ hipError_t hipGraphKernelNodeGetParams(hipGraphNode_t node, hipKernelNodeParams* * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - const pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphKernelNodeSetParams(hipGraphNode_t node, const hipKernelNodeParams* pNodeParams); @@ -7374,7 +7374,7 @@ hipError_t hipGraphKernelNodeSetParams(hipGraphNode_t node, const hipKernelNodeP * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - const pointer to the kernel node parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecKernelNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7390,7 +7390,7 @@ hipError_t hipGraphExecKernelNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNo * @param [in] copyParams - const pointer to the parameters for the memory copy. * @param [in] ctx - cotext related to current device. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDrvGraphAddMemcpyNode(hipGraphNode_t* phGraphNode, hipGraph_t hGraph, @@ -7406,7 +7406,7 @@ hipError_t hipDrvGraphAddMemcpyNode(hipGraphNode_t* phGraphNode, hipGraph_t hGra * @param [in] numDependencies - the number of the dependencies. * @param [in] pCopyParams - const pointer to the parameters for the memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddMemcpyNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7418,7 +7418,7 @@ hipError_t hipGraphAddMemcpyNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] node - instance of the node to get parameters from. * @param [out] pNodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemcpyNodeGetParams(hipGraphNode_t node, hipMemcpy3DParms* pNodeParams); @@ -7429,7 +7429,7 @@ hipError_t hipGraphMemcpyNodeGetParams(hipGraphNode_t node, hipMemcpy3DParms* pN * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - const pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemcpyNodeSetParams(hipGraphNode_t node, const hipMemcpy3DParms* pNodeParams); @@ -7441,7 +7441,7 @@ hipError_t hipGraphMemcpyNodeSetParams(hipGraphNode_t node, const hipMemcpy3DPar * @param [in] attr - the attribute node is set to. * @param [in] value - const pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphKernelNodeSetAttribute(hipGraphNode_t hNode, hipKernelNodeAttrID attr, @@ -7453,7 +7453,7 @@ hipError_t hipGraphKernelNodeSetAttribute(hipGraphNode_t hNode, hipKernelNodeAtt * @param [in] attr - the attribute node is set to. * @param [in] value - const pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphKernelNodeGetAttribute(hipGraphNode_t hNode, hipKernelNodeAttrID attr, @@ -7465,7 +7465,7 @@ hipError_t hipGraphKernelNodeGetAttribute(hipGraphNode_t hNode, hipKernelNodeAtt * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - const pointer to the kernel node parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecMemcpyNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7483,7 +7483,7 @@ hipError_t hipGraphExecMemcpyNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNo * @param [in] count - the size of the memory to copy. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddMemcpyNode1D(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7499,7 +7499,7 @@ hipError_t hipGraphAddMemcpyNode1D(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] count - the size of the memory to copy. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemcpyNodeSetParams1D(hipGraphNode_t node, void* dst, const void* src, @@ -7516,7 +7516,7 @@ hipError_t hipGraphMemcpyNodeSetParams1D(hipGraphNode_t node, void* dst, const v * @param [in] count - the size of the memory to copy. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecMemcpyNodeSetParams1D(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7536,7 +7536,7 @@ hipError_t hipGraphExecMemcpyNodeSetParams1D(hipGraphExec_t hGraphExec, hipGraph * @param [in] offset - Offset from start of symbol in bytes. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddMemcpyNodeFromSymbol(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7554,7 +7554,7 @@ hipError_t hipGraphAddMemcpyNodeFromSymbol(hipGraphNode_t* pGraphNode, hipGraph_ * @param [in] offset - Offset from start of symbol in bytes. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemcpyNodeSetParamsFromSymbol(hipGraphNode_t node, void* dst, const void* symbol, @@ -7572,7 +7572,7 @@ hipError_t hipGraphMemcpyNodeSetParamsFromSymbol(hipGraphNode_t node, void* dst, * @param [in] offset - Offset from start of symbol in bytes. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecMemcpyNodeSetParamsFromSymbol(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7592,7 +7592,7 @@ hipError_t hipGraphExecMemcpyNodeSetParamsFromSymbol(hipGraphExec_t hGraphExec, * @param [in] offset - Offset from start of symbol in bytes. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddMemcpyNodeToSymbol(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7611,7 +7611,7 @@ hipError_t hipGraphAddMemcpyNodeToSymbol(hipGraphNode_t* pGraphNode, hipGraph_t * @param [in] offset - Offset from start of symbol in bytes. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemcpyNodeSetParamsToSymbol(hipGraphNode_t node, const void* symbol, @@ -7630,7 +7630,7 @@ hipError_t hipGraphMemcpyNodeSetParamsToSymbol(hipGraphNode_t node, const void* * @param [in] offset - Offset from start of symbol in bytes. * @param [in] kind - the type of memory copy. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecMemcpyNodeSetParamsToSymbol(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7646,7 +7646,7 @@ hipError_t hipGraphExecMemcpyNodeSetParamsToSymbol(hipGraphExec_t hGraphExec, hi * @param [in] numDependencies - the number of the dependencies. * @param [in] pMemsetParams - const pointer to the parameters for the memory set. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddMemsetNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7659,7 +7659,7 @@ hipError_t hipGraphAddMemsetNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] node - instane of the node to get parameters from. * @param [out] pNodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemsetNodeGetParams(hipGraphNode_t node, hipMemsetParams* pNodeParams); @@ -7670,7 +7670,7 @@ hipError_t hipGraphMemsetNodeGetParams(hipGraphNode_t node, hipMemsetParams* pNo * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemsetNodeSetParams(hipGraphNode_t node, const hipMemsetParams* pNodeParams); @@ -7682,7 +7682,7 @@ hipError_t hipGraphMemsetNodeSetParams(hipGraphNode_t node, const hipMemsetParam * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecMemsetNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7697,7 +7697,7 @@ hipError_t hipGraphExecMemsetNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNo * @param [in] numDependencies - the number of the dependencies. * @param [in] pNodeParams -pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddHostNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7710,7 +7710,7 @@ hipError_t hipGraphAddHostNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] node - instane of the node to get parameters from. * @param [out] pNodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphHostNodeGetParams(hipGraphNode_t node, hipHostNodeParams* pNodeParams); @@ -7721,7 +7721,7 @@ hipError_t hipGraphHostNodeGetParams(hipGraphNode_t node, hipHostNodeParams* pNo * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphHostNodeSetParams(hipGraphNode_t node, const hipHostNodeParams* pNodeParams); @@ -7733,7 +7733,7 @@ hipError_t hipGraphHostNodeSetParams(hipGraphNode_t node, const hipHostNodeParam * @param [in] node - instance of the node to set parameters to. * @param [in] pNodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecHostNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7748,7 +7748,7 @@ hipError_t hipGraphExecHostNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode * @param [in] numDependencies - the number of the dependencies. * @param [in] childGraph - the graph to clone into this node * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddChildGraphNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7761,7 +7761,7 @@ hipError_t hipGraphAddChildGraphNode(hipGraphNode_t* pGraphNode, hipGraph_t grap * @param [in] node - instane of the node to get child graph. * @param [out] pGraph - pointer to get the graph. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphChildGraphNodeGetGraph(hipGraphNode_t node, hipGraph_t* pGraph); @@ -7773,7 +7773,7 @@ hipError_t hipGraphChildGraphNodeGetGraph(hipGraphNode_t node, hipGraph_t* pGrap * @param [in] node - node from the graph which was used to instantiate graphExec. * @param [in] childGraph - child graph with updated parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecChildGraphNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t node, @@ -7787,7 +7787,7 @@ hipError_t hipGraphExecChildGraphNodeSetParams(hipGraphExec_t hGraphExec, hipGra * @param [in] pDependencies - const pointer to the node dependenties. * @param [in] numDependencies - the number of dependencies. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddEmptyNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7803,7 +7803,7 @@ hipError_t hipGraphAddEmptyNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] numDependencies - the number of dependencies. * @param [in] event - Event for the node. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddEventRecordNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7816,7 +7816,7 @@ hipError_t hipGraphAddEventRecordNode(hipGraphNode_t* pGraphNode, hipGraph_t gra * @param [in] node - instane of the node to get event from. * @param [out] event_out - Pointer to return the event. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphEventRecordNodeGetEvent(hipGraphNode_t node, hipEvent_t* event_out); @@ -7827,7 +7827,7 @@ hipError_t hipGraphEventRecordNodeGetEvent(hipGraphNode_t node, hipEvent_t* even * @param [in] node - instane of the node to set event to. * @param [in] event - pointer to the event. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphEventRecordNodeSetEvent(hipGraphNode_t node, hipEvent_t event); @@ -7839,7 +7839,7 @@ hipError_t hipGraphEventRecordNodeSetEvent(hipGraphNode_t node, hipEvent_t event * @param [in] hNode - node from the graph which was used to instantiate graphExec. * @param [in] event - pointer to the event. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecEventRecordNodeSetEvent(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -7854,7 +7854,7 @@ hipError_t hipGraphExecEventRecordNodeSetEvent(hipGraphExec_t hGraphExec, hipGra * @param [in] numDependencies - the number of dependencies. * @param [in] event - Event for the node. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddEventWaitNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7868,7 +7868,7 @@ hipError_t hipGraphAddEventWaitNode(hipGraphNode_t* pGraphNode, hipGraph_t graph * @param [in] node - instane of the node to get event from. * @param [out] event_out - Pointer to return the event. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphEventWaitNodeGetEvent(hipGraphNode_t node, hipEvent_t* event_out); @@ -7879,7 +7879,7 @@ hipError_t hipGraphEventWaitNodeGetEvent(hipGraphNode_t node, hipEvent_t* event_ * @param [in] node - instane of the node to set event to. * @param [in] event - pointer to the event. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphEventWaitNodeSetEvent(hipGraphNode_t node, hipEvent_t event); @@ -7891,7 +7891,7 @@ hipError_t hipGraphEventWaitNodeSetEvent(hipGraphNode_t node, hipEvent_t event); * @param [in] hNode - node from the graph which was used to instantiate graphExec. * @param [in] event - pointer to the event. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecEventWaitNodeSetEvent(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -7906,7 +7906,7 @@ hipError_t hipGraphExecEventWaitNodeSetEvent(hipGraphExec_t hGraphExec, hipGraph * @param [in] numDependencies - The number of dependencies * @param [in] pNodeParams - Node parameters for memory allocation * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddMemAllocNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7918,7 +7918,7 @@ hipError_t hipGraphAddMemAllocNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] node - Memory allocation node for a query * @param [out] pNodeParams - Parameters for the specified memory allocation node * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemAllocNodeGetParams(hipGraphNode_t node, hipMemAllocNodeParams* pNodeParams); @@ -7932,7 +7932,7 @@ hipError_t hipGraphMemAllocNodeGetParams(hipGraphNode_t node, hipMemAllocNodePar * @param [in] numDependencies - The number of dependencies * @param [in] dev_ptr - Pointer to the memory to be freed * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddMemFreeNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -7944,7 +7944,7 @@ hipError_t hipGraphAddMemFreeNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, * @param [in] node - Memory free node for a query * @param [out] dev_ptr - Device pointer for the specified memory free node * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphMemFreeNodeGetParams(hipGraphNode_t node, void* dev_ptr); @@ -7956,7 +7956,7 @@ hipError_t hipGraphMemFreeNodeGetParams(hipGraphNode_t node, void* dev_ptr); * @param [in] attr - attr to get. * @param [out] value - value for specific attr. * @returns #hipSuccess, #hipErrorInvalidDevice - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDeviceGetGraphMemAttribute(int device, hipGraphMemAttributeType attr, void* value); @@ -7968,7 +7968,7 @@ hipError_t hipDeviceGetGraphMemAttribute(int device, hipGraphMemAttributeType at * @param [in] attr - attr to set. * @param [in] value - value for specific attr. * @returns #hipSuccess, #hipErrorInvalidDevice - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDeviceSetGraphMemAttribute(int device, hipGraphMemAttributeType attr, void* value); @@ -7979,7 +7979,7 @@ hipError_t hipDeviceSetGraphMemAttribute(int device, hipGraphMemAttributeType at * @param [in] device - device the memory is used for graphs * @returns #hipSuccess, #hipErrorInvalidDevice * - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDeviceGraphMemTrim(int device); @@ -7993,7 +7993,7 @@ hipError_t hipDeviceGraphMemTrim(int device); * @param [in] initialRefcount - reference to resource. * @param [in] flags - flags passed to API. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipUserObjectCreate(hipUserObject_t* object_out, void* ptr, hipHostFn_t destroy, @@ -8005,7 +8005,7 @@ hipError_t hipUserObjectCreate(hipUserObject_t* object_out, void* ptr, hipHostFn * @param [in] object - pointer to instace of userobj. * @param [in] count - reference to resource to be retained. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipUserObjectRelease(hipUserObject_t object, unsigned int count __dparm(1)); @@ -8016,7 +8016,7 @@ hipError_t hipUserObjectRelease(hipUserObject_t object, unsigned int count __dpa * @param [in] object - pointer to instace of userobj. * @param [in] count - reference to resource to be retained. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipUserObjectRetain(hipUserObject_t object, unsigned int count __dparm(1)); @@ -8029,7 +8029,7 @@ hipError_t hipUserObjectRetain(hipUserObject_t object, unsigned int count __dpar * @param [in] count - reference to resource to be retained. * @param [in] flags - flags passed to API. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphRetainUserObject(hipGraph_t graph, hipUserObject_t object, @@ -8042,7 +8042,7 @@ hipError_t hipGraphRetainUserObject(hipGraph_t graph, hipUserObject_t object, * @param [in] object - pointer to instace of userobj. * @param [in] count - reference to resource to be retained. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphReleaseUserObject(hipGraph_t graph, hipUserObject_t object, @@ -8055,7 +8055,7 @@ hipError_t hipGraphReleaseUserObject(hipGraph_t graph, hipUserObject_t object, * @param [in] path - path to write the DOT file. * @param [in] flags - Flags from hipGraphDebugDotFlags to get additional node information. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorOperatingSystem - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphDebugDotPrint(hipGraph_t graph, const char* path, unsigned int flags); @@ -8071,7 +8071,7 @@ hipError_t hipGraphDebugDotPrint(hipGraph_t graph, const char* path, unsigned in * For list of attributes see ::hipKernelNodeAttrID. * * @returns #hipSuccess, #hipErrorInvalidContext - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphKernelNodeCopyAttributes(hipGraphNode_t hSrc, hipGraphNode_t hDst); @@ -8095,7 +8095,7 @@ hipError_t hipGraphKernelNodeCopyAttributes(hipGraphNode_t hSrc, hipGraphNode_t * @param [in] isEnabled - Node is enabled if != 0, otherwise the node is disabled. * * @returns #hipSuccess, #hipErrorInvalidValue, - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphNodeSetEnabled(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -8117,7 +8117,7 @@ hipError_t hipGraphNodeSetEnabled(hipGraphExec_t hGraphExec, hipGraphNode_t hNod * @param [out] isEnabled - Location to return the enabled status of the node. * * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphNodeGetEnabled(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -8132,7 +8132,7 @@ hipError_t hipGraphNodeGetEnabled(hipGraphExec_t hGraphExec, hipGraphNode_t hNod * @param [in] numDependencies - the number of the dependencies. * @param [in] nodeParams -pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddExternalSemaphoresWaitNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -8148,7 +8148,7 @@ hipError_t hipGraphAddExternalSemaphoresWaitNode(hipGraphNode_t* pGraphNode, hip * @param [in] numDependencies - the number of the dependencies. * @param [in] nodeParams -pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphAddExternalSemaphoresSignalNode(hipGraphNode_t* pGraphNode, hipGraph_t graph, @@ -8160,7 +8160,7 @@ hipError_t hipGraphAddExternalSemaphoresSignalNode(hipGraphNode_t* pGraphNode, h * @param [in] hNode - Node from the graph from which graphExec was instantiated. * @param [in] nodeParams - Pointer to the params to be set. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExternalSemaphoresSignalNodeSetParams(hipGraphNode_t hNode, @@ -8171,7 +8171,7 @@ hipError_t hipGraphExternalSemaphoresSignalNodeSetParams(hipGraphNode_t hNode, * @param [in] hNode - Node from the graph from which graphExec was instantiated. * @param [in] nodeParams - Pointer to the params to be set. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExternalSemaphoresWaitNodeSetParams(hipGraphNode_t hNode, @@ -8182,7 +8182,7 @@ hipError_t hipGraphExternalSemaphoresWaitNodeSetParams(hipGraphNode_t hNode, * @param [in] hNode - Node from the graph from which graphExec was instantiated. * @param [out] params_out - Pointer to params. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExternalSemaphoresSignalNodeGetParams(hipGraphNode_t hNode, @@ -8193,7 +8193,7 @@ hipError_t hipGraphExternalSemaphoresSignalNodeGetParams(hipGraphNode_t hNode, * @param [in] hNode - Node from the graph from which graphExec was instantiated. * @param [out] params_out - Pointer to params. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExternalSemaphoresWaitNodeGetParams(hipGraphNode_t hNode, @@ -8205,7 +8205,7 @@ hipError_t hipGraphExternalSemaphoresWaitNodeGetParams(hipGraphNode_t hNode, * @param [in] hNode - Node from the graph from which graphExec was instantiated. * @param [in] nodeParams - Pointer to the params to be set. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecExternalSemaphoresSignalNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -8217,7 +8217,7 @@ hipError_t hipGraphExecExternalSemaphoresSignalNodeSetParams(hipGraphExec_t hGra * @param [in] hNode - Node from the graph from which graphExec was instantiated. * @param [in] nodeParams - Pointer to the params to be set. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipGraphExecExternalSemaphoresWaitNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -8229,7 +8229,7 @@ hipError_t hipGraphExecExternalSemaphoresWaitNodeSetParams(hipGraphExec_t hGraph * @param [in] hNode - instance of the node to get parameters from. * @param [out] nodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDrvGraphMemcpyNodeGetParams(hipGraphNode_t hNode, HIP_MEMCPY3D* nodeParams); @@ -8240,7 +8240,7 @@ hipError_t hipDrvGraphMemcpyNodeGetParams(hipGraphNode_t hNode, HIP_MEMCPY3D* no * @param [in] hNode - instance of the node to Set parameters for. * @param [out] nodeParams - pointer to the parameters. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDrvGraphMemcpyNodeSetParams(hipGraphNode_t hNode, const HIP_MEMCPY3D* nodeParams); @@ -8255,7 +8255,7 @@ hipError_t hipDrvGraphMemcpyNodeSetParams(hipGraphNode_t hNode, const HIP_MEMCPY * @param [in] memsetParams - const pointer to the parameters for the memory set. * @param [in] ctx - cotext related to current device. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDrvGraphAddMemsetNode(hipGraphNode_t* phGraphNode, hipGraph_t hGraph, @@ -8271,7 +8271,7 @@ hipError_t hipDrvGraphAddMemsetNode(hipGraphNode_t* phGraphNode, hipGraph_t hGra * @param [in] numDependencies - The number of dependencies * @param [in] dptr - Pointer to the memory to be freed * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDrvGraphAddMemFreeNode(hipGraphNode_t* phGraphNode, hipGraph_t hGraph, @@ -8286,7 +8286,7 @@ hipError_t hipDrvGraphAddMemFreeNode(hipGraphNode_t* phGraphNode, hipGraph_t hGr * @param [in] copyParams - const pointer to the memcpy node params. * @param [in] ctx - cotext related to current device. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDrvGraphExecMemcpyNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -8300,7 +8300,7 @@ hipError_t hipDrvGraphExecMemcpyNodeSetParams(hipGraphExec_t hGraphExec, hipGrap * @param [in] memsetParams - pointer to the parameters. * @param [in] ctx - cotext related to current device. * @returns #hipSuccess, #hipErrorInvalidValue - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. */ hipError_t hipDrvGraphExecMemsetNodeSetParams(hipGraphExec_t hGraphExec, hipGraphNode_t hNode, @@ -8329,7 +8329,7 @@ hipError_t hipDrvGraphExecMemsetNodeSetParams(hipGraphExec_t hGraphExec, hipGrap * @param [in] devPtr - starting address of the range. * @param [in] size - size of the range. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8345,7 +8345,7 @@ hipError_t hipMemAddressFree(void* devPtr, size_t size); * @param [in] addr - requested starting address of the range. * @param [in] flags - currently unused, must be zero. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8360,7 +8360,7 @@ hipError_t hipMemAddressReserve(void** ptr, size_t size, size_t alignment, void* * @param [in] prop - properties of the allocation. * @param [in] flags - currently unused, must be zero. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8375,7 +8375,7 @@ hipError_t hipMemCreate(hipMemGenericAllocationHandle_t* handle, size_t size, co * @param [in] handleType - type of the shareable handle. * @param [in] flags - currently unused, must be zero. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8389,7 +8389,7 @@ hipError_t hipMemExportToShareableHandle(void* shareableHandle, hipMemGenericAll * @param [in] location - target location. * @param [in] ptr - address to check the access flags. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8403,7 +8403,7 @@ hipError_t hipMemGetAccess(unsigned long long* flags, const hipMemLocation* loca * @param [in] prop - location properties. * @param [in] option - determines which granularity to return. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8417,7 +8417,7 @@ hipError_t hipMemGetAllocationGranularity(size_t* granularity, const hipMemAlloc * @param [out] prop - properties of the given handle. * @param [in] handle - handle to perform the query on. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux under development on Windows. @@ -8431,7 +8431,7 @@ hipError_t hipMemGetAllocationPropertiesFromHandle(hipMemAllocationProp* prop, h * @param [in] osHandle - shareable handle representing the memory allocation. * @param [in] shHandleType - handle type. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8447,7 +8447,7 @@ hipError_t hipMemImportFromShareableHandle(hipMemGenericAllocationHandle_t* hand * @param [in] handle - memory allocation to be mapped. * @param [in] flags - currently unused, must be zero. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8461,7 +8461,7 @@ hipError_t hipMemMap(void* ptr, size_t size, size_t offset, hipMemGenericAllocat * @param [in] count - number of hipArrayMapInfo in mapInfoList. * @param [in] stream - stream identifier for the stream to use for map or unmap operations. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8473,7 +8473,7 @@ hipError_t hipMemMapArrayAsync(hipArrayMapInfo* mapInfoList, unsigned int count * * @param [in] handle - handle of the memory allocation. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8486,7 +8486,7 @@ hipError_t hipMemRelease(hipMemGenericAllocationHandle_t handle); * @param [out] handle - handle representing addr. * @param [in] addr - address to look up. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8501,7 +8501,7 @@ hipError_t hipMemRetainAllocationHandle(hipMemGenericAllocationHandle_t* handle, * @param [in] desc - array of hipMemAccessDesc. * @param [in] count - number of hipMemAccessDesc in desc. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows. @@ -8514,7 +8514,7 @@ hipError_t hipMemSetAccess(void* ptr, size_t size, const hipMemAccessDesc* desc, * @param [in] ptr - starting address of the range to unmap. * @param [in] size - size of the virtual address range. * @returns #hipSuccess, #hipErrorInvalidValue, #hipErrorNotSupported - * @warning : This API is marked as beta, meaning, while this is feature complete, + * @warning This API is marked as beta, meaning, while this is feature complete, * it is still open to changes and may have outstanding issues. * * @note This API is implemented on Linux, under development on Windows.