Add cl_ext_immutable_memory_objects tests writing to and from buffer (#2432)

This change extends the test coverage for
https://github.com/KhronosGroup/OpenCL-Docs/pull/1280

The change tests:
1. Writing to immutable buffers.
2. Writing to buffer/image from immutable buffers.
3. Reading from immutable buffers.

This change adds the following tests:
1. `test_negative_imagearraycopy`
2. `test_negative_imagearraycopy3d`
3. `test_immutable_bufferreadwriterect`
4. `test_immutable_arrayreadwrite`
5. `test_write_from_immutable_buffer_to_buffer`
6. `test_immutable_buffer_map_*`

and extends the following tests:
1. `test_arrayimagecopy3d`
2. `test_arrayimagecopy`
3. `test_imagearraycopy3d`
4. `test_imagearraycopy`
5. `test_buffer_copy`
6. `test_buffer_partial_copy`

Signed-off-by: Michael Rizkalla <michael.rizkalla@arm.com>
This commit is contained in:
Michael Rizkalla
2026-01-13 17:46:02 +00:00
committed by GitHub
parent 02a3c7e609
commit b681d4f2c8
11 changed files with 834 additions and 46 deletions

View File

@@ -188,9 +188,17 @@ REGISTER_TEST(arrayimagecopy)
{
PASSIVE_REQUIRE_IMAGE_SUPPORT(device)
return test_arrayimagecommon(device, context, queue, CL_MEM_READ_WRITE,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE2D,
test_arrayimagecopy_single_format);
int error = test_arrayimagecommon(device, context, queue, CL_MEM_READ_WRITE,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE2D,
test_arrayimagecopy_single_format);
if (is_extension_available(device, "cl_ext_immutable_memory_objects"))
{
error |= test_arrayimagecommon(
device, context, queue, CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE2D,
test_arrayimagecopy_single_format);
}
return error;
}
@@ -198,7 +206,15 @@ REGISTER_TEST(arrayimagecopy3d)
{
PASSIVE_REQUIRE_3D_IMAGE_SUPPORT(device)
return test_arrayimagecommon(device, context, queue, CL_MEM_READ_WRITE,
CL_MEM_READ_ONLY, CL_MEM_OBJECT_IMAGE3D,
test_arrayimagecopy_single_format);
int error = test_arrayimagecommon(device, context, queue, CL_MEM_READ_WRITE,
CL_MEM_READ_ONLY, CL_MEM_OBJECT_IMAGE3D,
test_arrayimagecopy_single_format);
if (is_extension_available(device, "cl_ext_immutable_memory_objects"))
{
error |= test_arrayimagecommon(
device, context, queue, CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE3D,
test_arrayimagecopy_single_format);
}
return error;
}

View File

@@ -72,16 +72,36 @@ static int test_arrayreadwrite_impl(cl_device_id device, cl_context context,
err = clEnqueueWriteBuffer(
queue, buffer, CL_TRUE, offset * sizeof(cl_uint),
sizeof(cl_uint) * cb, &reference_vals[offset], 0, nullptr, nullptr);
test_error(err, "clEnqueueWriteBuffer failed");
if (flags & CL_MEM_IMMUTABLE_EXT)
{
test_failure_error_ret(err, CL_INVALID_OPERATION,
"clEnqueueWriteBuffer is expected to fail "
"with CL_INVALID_OPERATION when the buffer "
"is created with CL_MEM_IMMUTABLE_EXT",
TEST_FAIL);
}
else
{
test_error(err, "clEnqueueWriteBuffer failed");
}
err = clEnqueueReadBuffer(
queue, buffer, CL_TRUE, offset * sizeof(cl_uint),
cb * sizeof(cl_uint), &outptr[offset], 0, nullptr, nullptr);
test_error(err, "clEnqueueReadBuffer failed");
const cl_uint* expected_buffer_values = nullptr;
if (flags & CL_MEM_IMMUTABLE_EXT)
{
expected_buffer_values = inptr.data();
}
else
{
expected_buffer_values = reference_vals.data();
}
for (int j = offset; j < offset + cb; j++)
{
if (reference_vals[j] != outptr[j])
if (expected_buffer_values[j] != outptr[j])
{
log_error("ARRAY read, write test failed\n");
err = -1;
@@ -105,3 +125,11 @@ REGISTER_TEST(arrayreadwrite)
return test_arrayreadwrite_impl(device, context, queue, num_elements,
CL_MEM_READ_WRITE);
}
REGISTER_TEST(immutable_arrayreadwrite)
{
REQUIRE_EXTENSION("cl_ext_immutable_memory_objects");
return test_arrayreadwrite_impl(device, context, queue, num_elements,
CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR);
}

View File

@@ -14,6 +14,7 @@
// limitations under the License.
//
#include "harness/compat.h"
#include "errorHelpers.h"
#include <stdio.h>
#include <stdlib.h>
@@ -194,6 +195,43 @@ int copy_region(size_t src, size_t soffset[3], size_t sregion[3], size_t dst, si
return 0;
}
int immutable_copy_region(size_t src, size_t soffset[3], size_t sregion[3],
size_t dst, size_t doffset[3], size_t dregion[3])
{
// Copy between cl buffers.
size_t src_slice_pitch =
(width[src] * height[src] != 1) ? width[src] * height[src] : 0;
size_t dst_slice_pitch =
(width[dst] * height[dst] != 1) ? width[dst] * height[dst] : 0;
size_t src_row_pitch = width[src];
cl_int err;
if (check_overlap_rect(soffset, doffset, sregion, src_row_pitch,
src_slice_pitch))
{
log_info("Copy overlap reported, skipping copy buffer rect\n");
return CL_SUCCESS;
}
else
{
err = clEnqueueCopyBufferRect(gQueue, buffer[src], buffer[dst], soffset,
doffset, sregion, /*dregion,*/
width[src], src_slice_pitch, width[dst],
dst_slice_pitch, 0, nullptr, nullptr);
if (err != CL_INVALID_OPERATION)
{
log_error(
"clEnqueueCopyBufferRect should return "
"CL_INVALID_OPERATION but returned %s between %zu and %zu",
IGetErrorString(err), src, dst);
return TEST_FAIL;
}
}
return TEST_PASS;
}
// This function compares the destination region in the buffer pointed
// to by device, to the source region of the specified verify buffer.
int verify_region(BufferType* device, size_t src, size_t soffset[3], size_t sregion[3], size_t dst, size_t doffset[3]) {
@@ -337,6 +375,32 @@ int write_region(size_t src, size_t soffset[3], size_t sregion[3], size_t dst, s
return 0;
}
int immutable_write_region(size_t src, size_t soffset[3], size_t sregion[3],
size_t dst, size_t doffset[3], size_t dregion[3])
{
initialize_image(tmp_buffer, tmp_buffer_size, 1, 1, mt);
size_t src_slice_pitch =
(width[src] * height[src] != 1) ? width[src] * height[src] : 0;
size_t dst_slice_pitch =
(width[dst] * height[dst] != 1) ? width[dst] * height[dst] : 0;
cl_int error = clEnqueueWriteBufferRect(
gQueue, buffer[dst], CL_TRUE, doffset, soffset, dregion, width[dst],
dst_slice_pitch, width[src], src_slice_pitch, tmp_buffer, 0, nullptr,
nullptr);
if (error != CL_INVALID_OPERATION)
{
log_error("clEnqueueWriteBufferRect should return CL_INVALID_OPERATION "
"but retured %s between %zu and %zu",
IGetErrorString(error), src, dst);
return TEST_FAIL;
}
return TEST_PASS;
}
void CL_CALLBACK mem_obj_destructor_callback( cl_mem, void *data )
{
free( data );
@@ -591,3 +655,16 @@ REGISTER_TEST(bufferreadwriterect)
device, context, queue, num_elements,
CL_MEM_USE_HOST_PTR | CL_MEM_READ_WRITE, test_functions);
}
REGISTER_TEST(immutable_bufferreadwriterect)
{
REQUIRE_EXTENSION("cl_ext_immutable_memory_objects");
TestFunctions test_functions;
test_functions.copy = immutable_copy_region;
test_functions.read = read_verify_region;
test_functions.write = immutable_write_region;
return test_bufferreadwriterect_impl(
device, context, queue, num_elements,
CL_MEM_USE_HOST_PTR | CL_MEM_IMMUTABLE_EXT, test_functions);
}

View File

@@ -27,6 +27,82 @@ using test_function_t = int (*)(cl_device_id, cl_context, cl_command_queue,
cl_mem_flags, cl_mem_flags, cl_mem_object_type,
const cl_image_format *);
static int test_negative_imagearraycopy_single_format(
cl_device_id device, cl_context context, cl_command_queue queue,
cl_mem_flags image_flags, cl_mem_flags buffer_flags,
cl_mem_object_type image_type, const cl_image_format *format)
{
std::unique_ptr<cl_uchar, decltype(&free)> bufptr{ nullptr, free },
imgptr{ nullptr, free };
clMemWrapper image;
clMemWrapper buffer;
const size_t img_width = 512;
const size_t img_height = 512;
const size_t img_depth = (image_type == CL_MEM_OBJECT_IMAGE3D) ? 32 : 1;
size_t elem_size;
size_t buffer_size;
cl_int err;
RandomSeed seed(gRandomSeed);
const size_t origin[3] = { 0, 0, 0 },
region[3] = { img_width, img_height, img_depth };
log_info("Testing %s %s\n",
GetChannelOrderName(format->image_channel_order),
GetChannelTypeName(format->image_channel_data_type));
elem_size = get_pixel_size(format);
buffer_size =
sizeof(cl_uchar) * elem_size * img_width * img_height * img_depth;
if (image_flags & CL_MEM_USE_HOST_PTR || image_flags & CL_MEM_COPY_HOST_PTR)
{
imgptr.reset(static_cast<cl_uchar *>(
create_random_data(kUChar, seed, buffer_size)));
}
bufptr.reset(
static_cast<cl_uchar *>(create_random_data(kUChar, seed, buffer_size)));
if (CL_MEM_OBJECT_IMAGE2D == image_type)
{
image = create_image_2d(context, image_flags, format, img_width,
img_height, 0, imgptr.get(), &err);
}
else
{
image =
create_image_3d(context, image_flags, format, img_width, img_height,
img_depth, 0, 0, imgptr.get(), &err);
}
test_error(err, "create_image_xd failed");
if (!(image_flags & CL_MEM_USE_HOST_PTR
|| image_flags & CL_MEM_COPY_HOST_PTR))
{
imgptr.reset(static_cast<cl_uchar *>(
create_random_data(kUChar, seed, buffer_size)));
err = clEnqueueWriteImage(queue, image, CL_TRUE, origin, region, 0, 0,
imgptr.get(), 0, nullptr, nullptr);
test_error(err, "clEnqueueWriteImage failed");
}
buffer =
clCreateBuffer(context, buffer_flags, buffer_size, bufptr.get(), &err);
test_error(err, "clCreateBuffer failed");
err = clEnqueueCopyImageToBuffer(queue, image, buffer, origin, region, 0, 0,
nullptr, nullptr);
test_failure_error_ret(
err, CL_INVALID_OPERATION,
"clEnqueueCopyImageToBuffer should return CL_INVALID_OPERATION when: "
"\" dst_buffer is created with CL_MEM_IMMUTABLE_EXT flag\"",
TEST_FAIL);
return TEST_PASS;
}
static int test_imagearraycopy_single_format(
cl_device_id device, cl_context context, cl_command_queue queue,
cl_mem_flags image_flags, cl_mem_flags buffer_flags,
@@ -188,9 +264,18 @@ REGISTER_TEST(imagearraycopy)
{
PASSIVE_REQUIRE_IMAGE_SUPPORT(device)
return test_imagearraycommon(device, context, queue, CL_MEM_READ_WRITE,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE2D,
test_imagearraycopy_single_format);
int error = test_imagearraycommon(device, context, queue, CL_MEM_READ_WRITE,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE2D,
test_imagearraycopy_single_format);
if (is_extension_available(device, "cl_ext_immutable_memory_objects"))
{
error |= test_imagearraycommon(
device, context, queue, CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE2D,
test_imagearraycopy_single_format);
}
return error;
}
@@ -198,7 +283,38 @@ REGISTER_TEST(imagearraycopy3d)
{
PASSIVE_REQUIRE_3D_IMAGE_SUPPORT(device)
return test_imagearraycommon(device, context, queue, CL_MEM_READ_ONLY,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE3D,
test_imagearraycopy_single_format);
int error = test_imagearraycommon(device, context, queue, CL_MEM_READ_ONLY,
CL_MEM_READ_WRITE, CL_MEM_OBJECT_IMAGE3D,
test_imagearraycopy_single_format);
if (is_extension_available(device, "cl_ext_immutable_memory_objects"))
{
error |= test_imagearraycommon(
device, context, queue, CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR,
CL_MEM_READ_ONLY, CL_MEM_OBJECT_IMAGE3D,
test_imagearraycopy_single_format);
}
return error;
}
REGISTER_TEST(negative_imagearraycopy)
{
PASSIVE_REQUIRE_IMAGE_SUPPORT(device);
REQUIRE_EXTENSION("cl_ext_immutable_memory_objects");
return test_imagearraycommon(device, context, queue, CL_MEM_READ_WRITE,
CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR,
CL_MEM_OBJECT_IMAGE2D,
test_negative_imagearraycopy_single_format);
}
REGISTER_TEST(negative_imagearraycopy3d)
{
PASSIVE_REQUIRE_3D_IMAGE_SUPPORT(device);
REQUIRE_EXTENSION("cl_ext_immutable_memory_objects");
return test_imagearraycommon(device, context, queue, CL_MEM_READ_ONLY,
CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR,
CL_MEM_OBJECT_IMAGE3D,
test_negative_imagearraycopy_single_format);
}