Update REQUIRE_EXTENSION macro to use the new overload

Change `REQUIRE_EXTENSION` to use the new overload of
`is_extension_available`. The macro will now use its argument, `ext`,
to construct `ext##_EXTENSION_NAME` and `ext##_EXTENSION_VERSION`,
which, for example, correspond to `CL_KHR_SEMAPHORE_EXTENSION_NAME`
and `CL_KHR_SEMAPHORE_EXTENSION_VERSION`, respectively. The extension
name and version are both defined in the OpenCL headers.

This guarantees that the macro is checking for the latest extension
version before running the test, and eliminates a class of errors,
where the user has a spelling mistake in the extension name to
check. This is enforced at compile time, as a variable with a typo in
its name will not be defined in the headers.

Update all instances of `REQUIRE_EXTENSION` to match.

Add a new macro, `HAS_EXTENSION`, that also calls the new overload,
but does not check the result or return a test status if the call
failed. This is useful for instances where tests require acting upon
the result of the call, and not necessarily skip the test.

Signed-off-by: Ahmed Hesham <ahmed.hesham@arm.com>

Author: ahesham-arm

test_common/harness/testHarness.h

@@ -150,17 +150,22 @@ template <typename T> T *register_test(const char *name, Version version)
 
 #define REGISTER_TEST(name) REGISTER_TEST_VERSION(name, Version(1, 2))
 
-#define REQUIRE_EXTENSION(name)                                                \
+#define REQUIRE_EXTENSION(ext)                                                 \
     do                                                                         \
     {                                                                          \
-        if (!is_extension_available(device, name))                             \
+        if (!is_extension_available(device, ext##_EXTENSION_NAME,              \
+                                    ext##_EXTENSION_VERSION))                  \
         {                                                                      \
-            log_info(name                                                      \
+            log_info(ext##_EXTENSION_NAME                                      \
                      " is not supported on this device. Skipping test.\n");    \
             return TEST_SKIPPED_ITSELF;                                        \
         }                                                                      \
     } while (0)
 
+#define HAS_EXTENSION(ext)                                                     \
+    is_extension_available(device, ext##_EXTENSION_NAME,                       \
+                           ext##_EXTENSION_VERSION)
+
 extern int gFailCount;
 extern int gTestCount;
 extern cl_uint gReSeed;

test_conformance/api/negative_enqueue_map_image.cpp

@@ -29,7 +29,7 @@ REGISTER_TEST(negative_enqueue_map_image)
 {
     constexpr size_t image_dim = 32;
 
-    REQUIRE_EXTENSION("cl_ext_immutable_memory_objects");
+    REQUIRE_EXTENSION(CL_EXT_IMMUTABLE_MEMORY_OBJECTS);
 
     static constexpr cl_mem_flags mem_flags[]{
         CL_MEM_IMMUTABLE_EXT | CL_MEM_USE_HOST_PTR,

test_conformance/api/test_kernels.cpp

@@ -1,6 +1,6 @@
 //
 // Copyright (c) 2017 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
@@ -667,7 +667,7 @@ REGISTER_TEST(kernel_global_constant)
 
 REGISTER_TEST(negative_set_immutable_memory_to_writeable_kernel_arg)
 {
-    REQUIRE_EXTENSION("cl_ext_immutable_memory_objects");
+    REQUIRE_EXTENSION(CL_EXT_IMMUTABLE_MEMORY_OBJECTS);
 
     cl_int error = CL_SUCCESS;
     clProgramWrapper program;

test_conformance/extensions/cl_khr_external_semaphore/test_external_semaphore.cpp

@@ -121,8 +121,8 @@ static cl_int get_device_semaphore_handle_types(
 // Confirm the semaphores can be successfully queried
 REGISTER_TEST_VERSION(external_semaphores_queries, Version(1, 2))
 {
-    REQUIRE_EXTENSION("cl_khr_semaphore");
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_SEMAPHORE);
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     if (init_vulkan_device(1, &device))
     {
@@ -199,7 +199,7 @@ REGISTER_TEST_VERSION(external_semaphores_queries, Version(1, 2))
 
 REGISTER_TEST_VERSION(external_semaphores_cross_context, Version(1, 2))
 {
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     GET_PFN(device, clEnqueueSignalSemaphoresKHR);
     GET_PFN(device, clEnqueueWaitSemaphoresKHR);
@@ -322,7 +322,7 @@ REGISTER_TEST_VERSION(external_semaphores_cross_context, Version(1, 2))
 // Confirm that a signal followed by a wait will complete successfully
 REGISTER_TEST_VERSION(external_semaphores_simple_1, Version(1, 2))
 {
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     if (init_vulkan_device(1, &device))
     {
@@ -391,7 +391,7 @@ REGISTER_TEST_VERSION(external_semaphores_simple_1, Version(1, 2))
 // Confirm that a semaphore can be reused multiple times
 REGISTER_TEST_VERSION(external_semaphores_reuse, Version(1, 2))
 {
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     if (init_vulkan_device(1, &device))
     {
@@ -509,7 +509,7 @@ static int external_semaphore_cross_queue_helper(cl_device_id device,
                                                  cl_command_queue queue_1,
                                                  cl_command_queue queue_2)
 {
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     if (init_vulkan_device(1, &device))
     {
@@ -612,7 +612,7 @@ REGISTER_TEST_VERSION(external_semaphores_cross_queues_io, Version(1, 2))
 
 REGISTER_TEST_VERSION(external_semaphores_cross_queues_io2, Version(1, 2))
 {
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     if (init_vulkan_device(1, &device))
     {
@@ -714,7 +714,7 @@ REGISTER_TEST_VERSION(external_semaphores_cross_queues_io2, Version(1, 2))
 // Confirm that we can signal multiple semaphores with one command
 REGISTER_TEST_VERSION(external_semaphores_multi_signal, Version(1, 2))
 {
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     if (init_vulkan_device(1, &device))
     {
@@ -796,7 +796,7 @@ REGISTER_TEST_VERSION(external_semaphores_multi_signal, Version(1, 2))
 // Confirm that we can wait for multiple semaphores with one command
 REGISTER_TEST_VERSION(external_semaphores_multi_wait, Version(1, 2))
 {
-    REQUIRE_EXTENSION("cl_khr_external_semaphore");
+    REQUIRE_EXTENSION(CL_KHR_EXTERNAL_SEMAPHORE);
 
     if (init_vulkan_device(1, &device))
     {

test_conformance/spir/main.cpp

@@ -1,6 +1,6 @@
 //
 // Copyright (c) 2017 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
@@ -6911,7 +6911,7 @@ int main (int argc, const char* argv[])
         cl_device_id device = get_platform_device(device_type, choosen_device_index, choosen_platform_index);
         printDeviceHeader(device);
 
-        REQUIRE_EXTENSION("cl_khr_spir");
+        REQUIRE_EXTENSION(CL_KHR_SPIR);
 
         std::vector<Version> versions;
         get_spir_version(device, versions);
@@ -6986,4 +6986,3 @@ int main (int argc, const char* argv[])
         return 3;
     }
 }
-