SWDEV-270961 - Update hip_programming_guide.md for event handling

Change-Id: Ieadac9972e5ee13c05ccb42a679866f494f96f47
This commit is contained in:
Julia Jiang
2021-04-09 15:00:09 -04:00
committed by Julia Jiang
parent f18a0d1405
commit cb22874ebd
2 changed files with 14 additions and 5 deletions
@@ -1524,6 +1524,13 @@ hipError_t hipEventSynchronize(hipEvent_t event);
* recorded on one or both events (that is, hipEventQuery() would return #hipErrorNotReady on at
* least one of the events), then #hipErrorNotReady is returned.
*
* Note, for HIP Events used in kernel dispatch using hipExtLaunchKernelGGL/hipExtLaunchKernel,
* events passed in hipExtLaunchKernelGGL/hipExtLaunchKernel are not explicitly recorded and should
* only be used to get elapsed time for that specific launch. In case events are used across
* multiple dispatches, for example, start and stop events from different hipExtLaunchKernelGGL/
* hipExtLaunchKernel calls, they will be treated as invalid unrecorded events, HIP will throw
* error "hipErrorInvalidHandle" from hipEventElapsedTime.
*
* @see hipEventCreate, hipEventCreateWithFlags, hipEventQuery, hipEventDestroy, hipEventRecord,
* hipEventSynchronize
*/