AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

SWDEV-342025 - Update API documentation for hipEventCreateWithFlags (#2774)

Browse Source 
- Add information that hipEventDisableTiming flag also must be set when hipEventInterprocess flag is set

Change-Id: Ic65bcc2258c1bacf870251383e5cf3c1e0e0c0c8
This commit is contained in:
ROCm CI Service Account
2022-06-28 23:16:47 +05:30
committed by GitHub
parent 329616bfd4
commit 7c306091bf
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/hip/hip_runtime_api.h
+7 -7
View File
@@ -574,7 +574,7 @@ enum hipLimit_t {
/** Disable event's capability to record timing information. May improve performance.*/
#define hipEventDisableTiming 0x2
/** Event can support IPC. Warnig: It is not supported in HIP.*/
/** Event can support IPC. hipEventDisableTiming also must be set.*/
#define hipEventInterprocess 0x4
/** Use a device-scope release when recording this event. This flag is useful to obtain more
@@ -1713,13 +1713,13 @@ hipError_t hipIpcCloseMemHandle(void* devPtr);
/**
* @brief Gets an opaque interprocess handle for an event.
*
* This opaque handle may be copied into other processes and opened with cudaIpcOpenEventHandle.
* Then cudaEventRecord, cudaEventSynchronize, cudaStreamWaitEvent and cudaEventQuery may be used in
* This opaque handle may be copied into other processes and opened with hipIpcOpenEventHandle.
* Then hipEventRecord, hipEventSynchronize, hipStreamWaitEvent and hipEventQuery may be used in
* either process. Operations on the imported event after the exported event has been freed with hipEventDestroy
* will result in undefined behavior.
*
* @param[out] handle Pointer to cudaIpcEventHandle to return the opaque event handle
* @param[in] event Event allocated with cudaEventInterprocess and cudaEventDisableTiming flags
* @param[out] handle Pointer to hipIpcEventHandle to return the opaque event handle
* @param[in] event Event allocated with hipEventInterprocess and hipEventDisableTiming flags
*
* @returns #hipSuccess, #hipErrorInvalidConfiguration, #hipErrorInvalidValue
*
@@ -2227,8 +2227,8 @@ hipError_t hipStreamWriteValue64(hipStream_t stream, void* ptr, uint64_t value,
for the synchroniation but can result in lower power and more resources for other CPU threads.
* #hipEventDisableTiming : Disable recording of timing information. Events created with this flag
would not record profiling data and provide best performance if used for synchronization.
* @warning On AMD platform, hipEventInterprocess support is under development. Use of this flag
will return an error.
* #hipEventInterprocess : The event can be used as an interprocess event. hipEventDisableTiming
flag also must be set when hipEventInterprocess flag is set.
*
* @returns #hipSuccess, #hipErrorNotInitialized, #hipErrorInvalidValue,
#hipErrorLaunchFailure, #hipErrorOutOfMemory