Skip to content
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.

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

Correct level of indirection used in KernelSetArgPointer calls. #805

Merged
merged 5 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions include/ur_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -5023,8 +5023,8 @@ urKernelSetArgPointer(
ur_kernel_handle_t hKernel, ///< [in] handle of the kernel object
uint32_t argIndex, ///< [in] argument index in range [0, num args - 1]
const ur_kernel_arg_pointer_properties_t *pProperties, ///< [in][optional] pointer to USM pointer properties.
const void *pArgValue ///< [in][optional] USM pointer to memory location holding the argument
///< value. If null then argument value is considered null.
const void *pArgValue ///< [in][optional] Pointer obtained by USM allocation or virtual memory
///< mapping operation. If null then argument value is considered null.
);

///////////////////////////////////////////////////////////////////////////////
Expand Down
2 changes: 1 addition & 1 deletion scripts/core/kernel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ params:
desc: "[in][optional] pointer to USM pointer properties."
- type: "const void*"
name: pArgValue
desc: "[in][optional] USM pointer to memory location holding the argument value. If null then argument value is considered null."
desc: "[in][optional] Pointer obtained by USM allocation or virtual memory mapping operation. If null then argument value is considered null."
returns:
- $X_RESULT_ERROR_INVALID_KERNEL_ARGUMENT_INDEX
- $X_RESULT_ERROR_INVALID_KERNEL_ARGUMENT_SIZE
Expand Down
3 changes: 2 additions & 1 deletion source/adapters/cuda/kernel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,8 @@ urKernelSetArgPointer(ur_kernel_handle_t hKernel, uint32_t argIndex,
const ur_kernel_arg_pointer_properties_t *pProperties,
const void *pArgValue) {
std::ignore = pProperties;
hKernel->setKernelArg(argIndex, sizeof(pArgValue), pArgValue);
// setKernelArg is expecting a pointer to our argument
hKernel->setKernelArg(argIndex, sizeof(pArgValue), &pArgValue);
return UR_RESULT_SUCCESS;
}

Expand Down
3 changes: 2 additions & 1 deletion source/adapters/hip/kernel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,8 @@ urKernelGetSubGroupInfo(ur_kernel_handle_t hKernel, ur_device_handle_t hDevice,
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgPointer(
ur_kernel_handle_t hKernel, uint32_t argIndex,
const ur_kernel_arg_pointer_properties_t *, const void *pArgValue) {
hKernel->setKernelArg(argIndex, sizeof(pArgValue), pArgValue);
// setKernelArg is expecting a pointer to our argument
hKernel->setKernelArg(argIndex, sizeof(pArgValue), &pArgValue);
return UR_RESULT_SUCCESS;
}

Expand Down
3 changes: 2 additions & 1 deletion source/adapters/level_zero/kernel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1004,8 +1004,9 @@ UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgPointer(
) {
std::ignore = Properties;

// KernelSetArgValue is expecting a pointer to the argument
UR_CALL(urKernelSetArgValue(Kernel, ArgIndex, sizeof(const void *), nullptr,
ArgValue));
&ArgValue));
return UR_RESULT_SUCCESS;
}

Expand Down
4 changes: 1 addition & 3 deletions source/adapters/native_cpu/kernel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,7 @@ urKernelSetArgPointer(ur_kernel_handle_t hKernel, uint32_t argIndex,
UR_ASSERT(hKernel, UR_RESULT_ERROR_INVALID_NULL_HANDLE);
UR_ASSERT(pArgValue, UR_RESULT_ERROR_INVALID_NULL_POINTER);

auto ptrToPtr = reinterpret_cast<const intptr_t *>(pArgValue);
auto derefPtr = reinterpret_cast<void *>(*ptrToPtr);
hKernel->_args.push_back(derefPtr);
hKernel->_args.push_back(const_cast<void *>(pArgValue));

return UR_RESULT_SUCCESS;
}
Expand Down
4 changes: 2 additions & 2 deletions source/adapters/null/ur_nullddi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2446,8 +2446,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelSetArgPointer(
const ur_kernel_arg_pointer_properties_t
*pProperties, ///< [in][optional] pointer to USM pointer properties.
const void *
pArgValue ///< [in][optional] USM pointer to memory location holding the argument
///< value. If null then argument value is considered null.
pArgValue ///< [in][optional] Pointer obtained by USM allocation or virtual memory
///< mapping operation. If null then argument value is considered null.
) try {
ur_result_t result = UR_RESULT_SUCCESS;

Expand Down
6 changes: 1 addition & 5 deletions source/adapters/opencl/kernel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -359,13 +359,9 @@ UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgPointer(
cl_ext::SetKernelArgMemPointerName, &FuncPtr));

if (FuncPtr) {
/* OpenCL passes pointers by value not by reference. This means we need to
* deref the arg to get the pointer value */
auto PtrToPtr = reinterpret_cast<const intptr_t *>(pArgValue);
auto DerefPtr = reinterpret_cast<void *>(*PtrToPtr);
CL_RETURN_ON_FAILURE(FuncPtr(cl_adapter::cast<cl_kernel>(hKernel),
cl_adapter::cast<cl_uint>(argIndex),
DerefPtr));
pArgValue));
}

return UR_RESULT_SUCCESS;
Expand Down
4 changes: 2 additions & 2 deletions source/loader/layers/sanitizer/asan_interceptor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,7 @@ ur_result_t SanitizerInterceptor::prepareLaunch(
char *ArgPointer = nullptr;
UR_CALL(MemBuffer->getHandle(DeviceInfo->Handle, ArgPointer));
ur_result_t URes = context.urDdiTable.Kernel.pfnSetArgPointer(
Kernel, ArgIndex, nullptr, &ArgPointer);
Kernel, ArgIndex, nullptr, ArgPointer);
if (URes != UR_RESULT_SUCCESS) {
context.logger.error(
"Failed to set buffer {} as the {} arg to kernel {}: {}",
Expand All @@ -722,7 +722,7 @@ ur_result_t SanitizerInterceptor::prepareLaunch(
(void *)LaunchInfo.Data, LaunchInfo.Data->NumLocalArgs,
(void *)LaunchInfo.Data->LocalArgs);
ur_result_t URes = context.urDdiTable.Kernel.pfnSetArgPointer(
Kernel, ArgNums - 1, nullptr, &LaunchInfo.Data);
Kernel, ArgNums - 1, nullptr, LaunchInfo.Data);
if (URes != UR_RESULT_SUCCESS) {
context.logger.error("Failed to set launch info: {}", URes);
return URes;
Expand Down
4 changes: 2 additions & 2 deletions source/loader/layers/tracing/ur_trcddi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3167,8 +3167,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelSetArgPointer(
const ur_kernel_arg_pointer_properties_t
*pProperties, ///< [in][optional] pointer to USM pointer properties.
const void *
pArgValue ///< [in][optional] USM pointer to memory location holding the argument
///< value. If null then argument value is considered null.
pArgValue ///< [in][optional] Pointer obtained by USM allocation or virtual memory
///< mapping operation. If null then argument value is considered null.
) {
auto pfnSetArgPointer = context.urDdiTable.Kernel.pfnSetArgPointer;

Expand Down
4 changes: 2 additions & 2 deletions source/loader/layers/validation/ur_valddi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3589,8 +3589,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelSetArgPointer(
const ur_kernel_arg_pointer_properties_t
*pProperties, ///< [in][optional] pointer to USM pointer properties.
const void *
pArgValue ///< [in][optional] USM pointer to memory location holding the argument
///< value. If null then argument value is considered null.
pArgValue ///< [in][optional] Pointer obtained by USM allocation or virtual memory
///< mapping operation. If null then argument value is considered null.
) {
auto pfnSetArgPointer = context.urDdiTable.Kernel.pfnSetArgPointer;

Expand Down
4 changes: 2 additions & 2 deletions source/loader/ur_ldrddi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3230,8 +3230,8 @@ __urdlllocal ur_result_t UR_APICALL urKernelSetArgPointer(
const ur_kernel_arg_pointer_properties_t
*pProperties, ///< [in][optional] pointer to USM pointer properties.
const void *
pArgValue ///< [in][optional] USM pointer to memory location holding the argument
///< value. If null then argument value is considered null.
pArgValue ///< [in][optional] Pointer obtained by USM allocation or virtual memory
///< mapping operation. If null then argument value is considered null.
) {
ur_result_t result = UR_RESULT_SUCCESS;

Expand Down
4 changes: 2 additions & 2 deletions source/loader/ur_libapi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3863,8 +3863,8 @@ ur_result_t UR_APICALL urKernelSetArgPointer(
const ur_kernel_arg_pointer_properties_t
*pProperties, ///< [in][optional] pointer to USM pointer properties.
const void *
pArgValue ///< [in][optional] USM pointer to memory location holding the argument
///< value. If null then argument value is considered null.
pArgValue ///< [in][optional] Pointer obtained by USM allocation or virtual memory
///< mapping operation. If null then argument value is considered null.
) try {
auto pfnSetArgPointer = ur_lib::context->urDdiTable.Kernel.pfnSetArgPointer;
if (nullptr == pfnSetArgPointer) {
Expand Down
4 changes: 2 additions & 2 deletions source/ur_api.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3284,8 +3284,8 @@ ur_result_t UR_APICALL urKernelSetArgPointer(
const ur_kernel_arg_pointer_properties_t
*pProperties, ///< [in][optional] pointer to USM pointer properties.
const void *
pArgValue ///< [in][optional] USM pointer to memory location holding the argument
///< value. If null then argument value is considered null.
pArgValue ///< [in][optional] Pointer obtained by USM allocation or virtual memory
///< mapping operation. If null then argument value is considered null.
) {
ur_result_t result = UR_RESULT_SUCCESS;
return result;
Expand Down
4 changes: 2 additions & 2 deletions test/conformance/enqueue/urEnqueueKernelLaunch.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ TEST_P(urEnqueueKernelLaunchWithVirtualMemory, Success) {
size_t global_size = alloc_size / sizeof(uint32_t);
uint32_t fill_val = 42;

ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &virtual_ptr));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, virtual_ptr));
ASSERT_SUCCESS(
urKernelSetArgValue(kernel, 1, sizeof(fill_val), nullptr, &fill_val));

Expand Down Expand Up @@ -516,7 +516,7 @@ TEST_P(urEnqueueKernelLaunchUSMLinkedList, Success) {
}

// Run kernel which will iterate the list and modify the values
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &list_head));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, list_head));
ASSERT_SUCCESS(urEnqueueKernelLaunch(queue, kernel, 1, &global_offset,
&global_size, nullptr, 0, nullptr,
nullptr));
Expand Down
2 changes: 1 addition & 1 deletion test/conformance/exp_command_buffer/invalid_update.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ struct InvalidUpdateTest
std::memset(shared_ptr, 0, allocation_size);

// Index 0 is output
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &shared_ptr));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, shared_ptr));
// Index 1 is input scalar
ASSERT_SUCCESS(
urKernelSetArgValue(kernel, 1, sizeof(val), nullptr, &val));
Expand Down
2 changes: 1 addition & 1 deletion test/conformance/exp_command_buffer/ndrange_update.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ struct NDRangeUpdateTest
ASSERT_NE(shared_ptr, nullptr);
std::memset(shared_ptr, 0, allocation_size);

ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &shared_ptr));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, shared_ptr));

// Add a 3 dimension kernel command to command-buffer and close
// command-buffer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ struct USMFillCommandTest
std::memset(shared_ptr, 0, allocation_size);

// Index 0 is output
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &shared_ptr));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, shared_ptr));
// Index 1 is input scalar
ASSERT_SUCCESS(
urKernelSetArgValue(kernel, 1, sizeof(val), nullptr, &val));
Expand Down Expand Up @@ -223,7 +223,7 @@ struct USMMultipleFillCommandTest
// kernel output.
void *offset_ptr = (uint32_t *)shared_ptr + (k * elements);
ASSERT_SUCCESS(
urKernelSetArgPointer(kernel, 0, nullptr, &offset_ptr));
urKernelSetArgPointer(kernel, 0, nullptr, offset_ptr));

// Each kernel has a unique fill value
uint32_t fill_val = val + k;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ struct USMSaxpyKernelTestBase

// Index 0 is output
ASSERT_SUCCESS(
urKernelSetArgPointer(kernel, 0, nullptr, &shared_ptrs[0]));
urKernelSetArgPointer(kernel, 0, nullptr, shared_ptrs[0]));
// Index 1 is A
ASSERT_SUCCESS(urKernelSetArgValue(kernel, 1, sizeof(A), nullptr, &A));
// Index 2 is X
ASSERT_SUCCESS(
urKernelSetArgPointer(kernel, 2, nullptr, &shared_ptrs[1]));
urKernelSetArgPointer(kernel, 2, nullptr, shared_ptrs[1]));
// Index 3 is Y
ASSERT_SUCCESS(
urKernelSetArgPointer(kernel, 3, nullptr, &shared_ptrs[2]));
urKernelSetArgPointer(kernel, 3, nullptr, shared_ptrs[2]));
}

void Validate(uint32_t *output, uint32_t *X, uint32_t *Y, uint32_t A,
Expand Down
2 changes: 1 addition & 1 deletion test/conformance/integration/QueueEmptyStatus.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ struct QueueEmptyStatusTestWithParam : uur::IntegrationQueueTestWithParam {
ArraySize * sizeof(uint32_t), 0, nullptr, &Event));
ASSERT_NO_FATAL_FAILURE(submitBarrierIfNeeded(Event));

ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &SharedMem));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, SharedMem));

constexpr size_t global_offset = 0;
constexpr size_t n_dimensions = 1;
Expand Down
8 changes: 4 additions & 4 deletions test/conformance/integration/QueueUSM.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ TEST_P(QueueUSMTestWithParam, QueueUSMTest) {

for (uint32_t i = 0; i < NumIterations; ++i) {
/* Copy from DeviceMem2 to DeviceMem1 and multiply by 2 */
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &DeviceMem1));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 1, nullptr, &DeviceMem2));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, DeviceMem1));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 1, nullptr, DeviceMem2));

ASSERT_SUCCESS(urEnqueueKernelLaunch(Queue, kernel, NDimensions,
&GlobalOffset, &ArraySize, nullptr,
Expand All @@ -99,8 +99,8 @@ TEST_P(QueueUSMTestWithParam, QueueUSMTest) {
CurValueMem2 = CurValueMem1 * 2;

/* Copy from DeviceMem1 to DeviceMem2 and multiply by 2 */
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &DeviceMem2));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 1, nullptr, &DeviceMem1));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, DeviceMem2));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 1, nullptr, DeviceMem1));

ASSERT_SUCCESS(urEnqueueKernelLaunch(Queue, kernel, NDimensions,
&GlobalOffset, &ArraySize, nullptr,
Expand Down
10 changes: 5 additions & 5 deletions test/conformance/kernel/urKernelSetArgPointer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ TEST_P(urKernelSetArgPointerTest, SuccessHost) {
&allocation));
ASSERT_NE(allocation, nullptr);

ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &allocation));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, allocation));
ASSERT_SUCCESS(
urKernelSetArgValue(kernel, 1, sizeof(data), nullptr, &data));
Launch1DRange(array_size);
Expand All @@ -60,7 +60,7 @@ TEST_P(urKernelSetArgPointerTest, SuccessDevice) {
allocation_size, &allocation));
ASSERT_NE(allocation, nullptr);

ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &allocation));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, allocation));
ASSERT_SUCCESS(
urKernelSetArgValue(kernel, 1, sizeof(data), nullptr, &data));
Launch1DRange(array_size);
Expand All @@ -87,7 +87,7 @@ TEST_P(urKernelSetArgPointerTest, SuccessShared) {
allocation_size, &allocation));
ASSERT_NE(allocation, nullptr);

ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, &allocation));
ASSERT_SUCCESS(urKernelSetArgPointer(kernel, 0, nullptr, allocation));
ASSERT_SUCCESS(
urKernelSetArgValue(kernel, 1, sizeof(data), nullptr, &data));
Launch1DRange(array_size);
Expand Down Expand Up @@ -138,7 +138,7 @@ UUR_INSTANTIATE_KERNEL_TEST_SUITE_P(urKernelSetArgPointerNegativeTest);

TEST_P(urKernelSetArgPointerNegativeTest, InvalidNullHandleKernel) {
ASSERT_EQ_RESULT(UR_RESULT_ERROR_INVALID_NULL_HANDLE,
urKernelSetArgPointer(nullptr, 0, nullptr, &allocation));
urKernelSetArgPointer(nullptr, 0, nullptr, allocation));
}

TEST_P(urKernelSetArgPointerNegativeTest, InvalidKernelArgumentIndex) {
Expand All @@ -149,5 +149,5 @@ TEST_P(urKernelSetArgPointerNegativeTest, InvalidKernelArgumentIndex) {

ASSERT_EQ_RESULT(UR_RESULT_ERROR_INVALID_KERNEL_ARGUMENT_INDEX,
urKernelSetArgPointer(kernel, num_kernel_args + 1, nullptr,
&allocation));
allocation));
}
Loading