Add tests for cl_ext_immutable_memory_objects #2286
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| // | ||
| // Copyright (c) 2024 The Khronos Group Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| #include "testBase.h" | ||
| #include "harness/clImageHelper.h" | ||
|
|
||
| #include <array> | ||
| #include <vector> | ||
| #include <memory> | ||
|
|
||
| static constexpr cl_mem_object_type image_types[] = { | ||
| CL_MEM_OBJECT_IMAGE2D, CL_MEM_OBJECT_IMAGE3D, CL_MEM_OBJECT_IMAGE2D_ARRAY, | ||
| CL_MEM_OBJECT_IMAGE1D, CL_MEM_OBJECT_IMAGE1D_ARRAY | ||
| }; | ||
|
|
||
| REGISTER_TEST(negative_enqueue_map_image) | ||
| { | ||
| constexpr size_t image_dim = 32; | ||
|
|
||
| if (is_extension_available(device, "cl_ext_immutable_memory_objects")) | ||
|
There was a problem hiding this comment. Minor: I think it would be preferable to skip this test if immutable memory objects are not supported. Can we use |
||
| { | ||
| static constexpr cl_mem_flags mem_flags[]{ | ||
| CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR, | ||
| CL_MEM_IMMUTABLE_EXT | CL_MEM_COPY_HOST_PTR, | ||
| CL_MEM_IMMUTABLE_EXT | CL_MEM_COPY_HOST_PTR | CL_MEM_ALLOC_HOST_PTR | ||
| }; | ||
|
|
||
| static constexpr const char *mem_flags_string[]{ | ||
| "CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR", | ||
| "CL_MEM_IMMUTABLE_EXT | CL_MEM_COPY_HOST_PTR", | ||
| "CL_MEM_IMMUTABLE_EXT | CL_MEM_COPY_HOST_PTR | " | ||
| "CL_MEM_ALLOC_HOST_PTR" | ||
| }; | ||
|
|
||
| static_assert( | ||
| ARRAY_SIZE(mem_flags) == ARRAY_SIZE(mem_flags_string), | ||
| "mem_flags and mem_flags_string must be of the same size"); | ||
|
|
||
| using CLUCharPtr = std::unique_ptr<cl_uchar, decltype(&free)>; | ||
|
|
||
| for (size_t index = 0; index < ARRAY_SIZE(mem_flags); ++index) | ||
| { | ||
| cl_mem_flags mem_flag = mem_flags[index]; | ||
|
|
||
| log_info("Testing memory flag: %s\n", mem_flags_string[index]); | ||
| for (cl_mem_object_type image_type : image_types) | ||
| { | ||
| // find supported image formats | ||
| cl_uint num_formats = 0; | ||
|
|
||
| cl_int error = clGetSupportedImageFormats( | ||
| context, mem_flag, image_type, 0, nullptr, &num_formats); | ||
| test_error( | ||
| error, | ||
| "clGetSupportedImageFormats failed to return supported " | ||
| "formats"); | ||
|
|
||
| std::vector<cl_image_format> formats(num_formats); | ||
| error = clGetSupportedImageFormats(context, mem_flag, | ||
| image_type, num_formats, | ||
| formats.data(), nullptr); | ||
| test_error( | ||
| error, | ||
| "clGetSupportedImageFormats failed to return supported " | ||
| "formats"); | ||
|
|
||
| clMemWrapper image; | ||
| for (cl_image_format &fmt : formats) | ||
| { | ||
| log_info("Testing %s %s\n", | ||
| GetChannelOrderName(fmt.image_channel_order), | ||
| GetChannelTypeName(fmt.image_channel_data_type)); | ||
|
|
||
| RandomSeed seed(gRandomSeed); | ||
| size_t origin[3] = { 0, 0, 0 }; | ||
| size_t region[3] = { image_dim, image_dim, image_dim }; | ||
| switch (image_type) | ||
| { | ||
| case CL_MEM_OBJECT_IMAGE1D: { | ||
| const size_t pixel_size = get_pixel_size(&fmt); | ||
| const size_t image_size = | ||
| image_dim * pixel_size * sizeof(cl_uchar); | ||
| CLUCharPtr imgptr{ | ||
| static_cast<cl_uchar *>(create_random_data( | ||
| kUChar, seed, image_size)), | ||
| free | ||
| }; | ||
| image = create_image_1d(context, mem_flag, &fmt, | ||
| image_dim, 0, imgptr.get(), | ||
| nullptr, &error); | ||
| region[1] = 1; | ||
| region[2] = 1; | ||
| break; | ||
| } | ||
| case CL_MEM_OBJECT_IMAGE2D: { | ||
| const size_t pixel_size = get_pixel_size(&fmt); | ||
| const size_t image_size = image_dim * image_dim | ||
| * pixel_size * sizeof(cl_uchar); | ||
| CLUCharPtr imgptr{ | ||
| static_cast<cl_uchar *>(create_random_data( | ||
| kUChar, seed, image_size)), | ||
| free | ||
| }; | ||
| image = create_image_2d(context, mem_flag, &fmt, | ||
| image_dim, image_dim, 0, | ||
| imgptr.get(), &error); | ||
| region[2] = 1; | ||
| break; | ||
| } | ||
| case CL_MEM_OBJECT_IMAGE3D: { | ||
| const size_t pixel_size = get_pixel_size(&fmt); | ||
| const size_t image_size = image_dim * image_dim | ||
| * image_dim * pixel_size * sizeof(cl_uchar); | ||
| CLUCharPtr imgptr{ | ||
| static_cast<cl_uchar *>(create_random_data( | ||
| kUChar, seed, image_size)), | ||
| free | ||
| }; | ||
| image = create_image_3d( | ||
| context, mem_flag, &fmt, image_dim, image_dim, | ||
| image_dim, 0, 0, imgptr.get(), &error); | ||
| break; | ||
| } | ||
| case CL_MEM_OBJECT_IMAGE1D_ARRAY: { | ||
| const size_t pixel_size = get_pixel_size(&fmt); | ||
| const size_t image_size = image_dim * image_dim | ||
| * pixel_size * sizeof(cl_uchar); | ||
| CLUCharPtr imgptr{ | ||
| static_cast<cl_uchar *>(create_random_data( | ||
| kUChar, seed, image_size)), | ||
| free | ||
| }; | ||
| image = create_image_1d_array( | ||
| context, mem_flag, &fmt, image_dim, image_dim, | ||
| 0, 0, imgptr.get(), &error); | ||
| region[1] = 1; | ||
| region[2] = 1; | ||
| break; | ||
| } | ||
| case CL_MEM_OBJECT_IMAGE2D_ARRAY: { | ||
| const size_t pixel_size = get_pixel_size(&fmt); | ||
| const size_t image_size = image_dim * image_dim | ||
| * image_dim * pixel_size * sizeof(cl_uchar); | ||
| CLUCharPtr imgptr{ | ||
| static_cast<cl_uchar *>(create_random_data( | ||
| kUChar, seed, image_size)), | ||
| free | ||
| }; | ||
| image = create_image_2d_array( | ||
| context, mem_flag, &fmt, image_dim, image_dim, | ||
| image_dim, 0, 0, imgptr.get(), &error); | ||
| region[2] = 1; | ||
| break; | ||
| } | ||
| } | ||
| test_error(error, "Failed to create image"); | ||
|
|
||
| void *map = clEnqueueMapImage( | ||
| queue, image, CL_TRUE, CL_MAP_WRITE, origin, region, | ||
| nullptr, nullptr, 0, nullptr, nullptr, &error); | ||
| test_object_failure_ret( | ||
| map, error, CL_INVALID_OPERATION, | ||
| "clEnqueueMapImage should return CL_INVALID_OPERATION " | ||
| "when: \"image has been created with " | ||
| "CL_MEM_IMMUTABLE_EXT and CL_MAP_WRITE is set in " | ||
| "map_flags\"", | ||
| TEST_FAIL); | ||
|
|
||
| map = clEnqueueMapImage(queue, image, CL_TRUE, | ||
| CL_MAP_WRITE_INVALIDATE_REGION, | ||
| origin, region, nullptr, nullptr, 0, | ||
| nullptr, nullptr, &error); | ||
| test_object_failure_ret( | ||
| map, error, CL_INVALID_OPERATION, | ||
| "clEnqueueMapImage should return CL_INVALID_OPERATION " | ||
| "when: \"image has been created with " | ||
| "CL_MEM_IMMUTABLE_EXT and " | ||
| "CL_MAP_WRITE_INVALIDATE_REGION is set in map_flags\"", | ||
| TEST_FAIL); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return TEST_PASS; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like we already have too many of these error macros, and this one seems like it will be used only in a few narrow cases (it's only used twice in this PR). Could we just write
test_assert_error_retandtest_failure_error_retinstead?Note that "object" is really just a "pointer" in actual use, so if we decide to keep it, I'd prefer to give it a different name.