Skip to content

[HIP] Improve urEnqueueUSMAdvise return code for non-shared mem #1773

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[HIP] Improve urEnqueueUSMAdvise return code for non-shared mem #1773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions source/adapters/hip/enqueue.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1424,8 +1424,6 @@ urEnqueueUSMAdvise(ur_queue_handle_t hQueue, const void *pMem, size_t size,
UR_ASSERT(size <= PointerRangeSize, UR_RESULT_ERROR_INVALID_SIZE);
#endif

ur_result_t Result = UR_RESULT_SUCCESS;

try {
ScopedContext Active(Device);
std::unique_ptr<ur_event_handle_t_> EventPtr{nullptr};
Expand Down Expand Up @@ -1480,6 +1478,20 @@ urEnqueueUSMAdvise(ur_queue_handle_t hQueue, const void *pMem, size_t size,
// UR_USM_MEM_ADVICE_SET/MEM_ADVICE_CLEAR_READ_MOSTLY.
}

// hipMemAdvise only supports managed memory allocated via
// hipMallocManaged. We can't support this API with any other types of
// pointer. We should ignore them and result UR_RESULT_SUCCESS but instead
// we report a warning.
// FIXME: Fix this up when there's a better warning mechanism.
if (auto ptrAttribs = getPointerAttributes(pMem);
!ptrAttribs || !ptrAttribs->isManaged) {
releaseEvent();
setErrorMessage("mem_advise is ignored as the pointer argument is not "
"a shared USM pointer",
UR_RESULT_SUCCESS);
return UR_RESULT_ERROR_ADAPTER_SPECIFIC;
}

const auto DeviceID = Device->get();
if (advice & UR_USM_ADVICE_FLAG_DEFAULT) {
UR_CHECK_ERROR(
Expand All @@ -1493,7 +1505,11 @@ urEnqueueUSMAdvise(ur_queue_handle_t hQueue, const void *pMem, size_t size,
hipMemAdvise(pMem, size, hipMemAdviseUnsetCoarseGrain, DeviceID));
#endif
} else {
Result = setHipMemAdvise(HIPDevicePtr, size, advice, DeviceID);
ur_result_t Result =
setHipMemAdvise(HIPDevicePtr, size, advice, DeviceID);
assert((Result == UR_RESULT_SUCCESS ||
Result == UR_RESULT_ERROR_INVALID_ENUMERATION) &&
"Unexpected return code");
// UR_RESULT_ERROR_INVALID_ENUMERATION is returned when using a valid
// but currently unmapped advice arguments as not supported by this
// platform. Therefore, warn the user instead of throwing and aborting
Expand All @@ -1509,12 +1525,12 @@ urEnqueueUSMAdvise(ur_queue_handle_t hQueue, const void *pMem, size_t size,

releaseEvent();
} catch (ur_result_t err) {
Result = err;
return err;
} catch (...) {
Result = UR_RESULT_ERROR_UNKNOWN;
return UR_RESULT_ERROR_UNKNOWN;
}

return Result;
return UR_RESULT_SUCCESS;
}

UR_APIEXPORT ur_result_t UR_APICALL urEnqueueUSMFill2D(
Expand Down
7 changes: 6 additions & 1 deletion test/conformance/enqueue/enqueue_adapter_hip.match
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@ urEnqueueKernelLaunchUSMLinkedList.Success/AMD_HIP_BACKEND___{{.*}}___UsePoolEna
{{OPT}}urEnqueueMemBufferCopyRectTestWithParam.Success/AMD_HIP_BACKEND___{{.*}}___copy_3d_2d
{{OPT}}urEnqueueMemBufferWriteRectTestWithParam.Success/AMD_HIP_BACKEND___{{.*}}___write_row_2D
{{OPT}}urEnqueueMemBufferWriteRectTestWithParam.Success/AMD_HIP_BACKEND___{{.*}}___write_3d_2d

# HIP doesn't ignore unsupported USM advice or prefetching. Instead of
# returning UR_RESULT_SUCCESS as per the spec, it instead returns
# UR_RESULT_ERROR_ADAPTER_SPECIFIC to issue a warning. These tests will fail
# until this is rectified.
urEnqueueUSMAdviseWithParamTest.Success/AMD_HIP_BACKEND___{{.*}}___UR_USM_ADVICE_FLAG_DEFAULT
urEnqueueUSMAdviseTest.MultipleParamsSuccess/AMD_HIP_BACKEND___{{.*}}_
urEnqueueUSMAdviseTest.NonCoherentDeviceMemorySuccessOrWarning/AMD_HIP_BACKEND___{{.*}}_
urEnqueueUSMPrefetchWithParamTest.Success/AMD_HIP_BACKEND___{{.*}}___UR_USM_MIGRATION_FLAG_DEFAULT
urEnqueueUSMPrefetchWithParamTest.CheckWaitEvent/AMD_HIP_BACKEND___{{.*}}___UR_USM_MIGRATION_FLAG_DEFAULT

urEnqueueTimestampRecordingExpTest.Success/AMD_HIP_BACKEND___{{.*}}
urEnqueueTimestampRecordingExpTest.SuccessBlocking/AMD_HIP_BACKEND___{{.*}}