[UR] Stop using extension strings to report support for exp features. (#16046)

With this change all experimental features now add a ur_device_info_t
enum which adapters report support through, and all EXTENSION_STRING
macros have been removed.

Author: aarongreig

sycl/unittests/helpers/UrMock.hpp

@@ -156,7 +156,7 @@ inline ur_result_t mock_urDeviceGetInfo(void *pParams) {
   auto params = reinterpret_cast<ur_device_get_info_params_t *>(pParams);
   constexpr char MockDeviceName[] = "Mock device";
   constexpr char MockSupportedExtensions[] =
-      "cl_khr_fp64 cl_khr_fp16 cl_khr_il_program ur_exp_command_buffer";
+      "cl_khr_fp64 cl_khr_fp16 cl_khr_il_program";
   switch (*params->ppropName) {
   case UR_DEVICE_INFO_TYPE: {
     // Act like any device is a GPU.

unified-runtime/include/ur_api.h

@@ -2087,8 +2087,9 @@ typedef enum ur_device_info_t {
   UR_DEVICE_INFO_VERSION = 70,
   /// [char[]] null-terminated version of backend runtime
   UR_DEVICE_INFO_BACKEND_RUNTIME_VERSION = 71,
-  /// [char[]] Return a null-terminated space separated list of extension
-  /// names
+  /// [char[]] Return a null-terminated string representing any backend
+  /// extensions supported by the adapter. Format and content is entirely
+  /// adapter defined.
   UR_DEVICE_INFO_EXTENSIONS = 72,
   /// [size_t] Maximum size in bytes of internal printf buffer
   UR_DEVICE_INFO_PRINTF_BUFFER_SIZE = 73,
@@ -2320,6 +2321,17 @@ typedef enum ur_device_info_t {
   /// [::ur_bool_t] returns true if the device supports enqueueing of
   /// allocations and frees.
   UR_DEVICE_INFO_ASYNC_USM_ALLOCATIONS_EXP = 0x2050,
+  /// [::ur_bool_t] Returns true if the device supports the use of kernel
+  /// launch properties.
+  UR_DEVICE_INFO_LAUNCH_PROPERTIES_SUPPORT_EXP = 0x3000,
+  /// [::ur_bool_t] Returns true if the device supports the USM P2P
+  /// experimental feature.
+  UR_DEVICE_INFO_USM_P2P_SUPPORT_EXP = 0x4000,
+  /// [::ur_bool_t] Returns true if the device supports cooperative kernels.
+  UR_DEVICE_INFO_COOPERATIVE_KERNEL_SUPPORT_EXP = 0x5000,
+  /// [::ur_bool_t] Returns true if the device supports the multi device
+  /// compile experimental feature.
+  UR_DEVICE_INFO_MULTI_DEVICE_COMPILE_SUPPORT_EXP = 0x6000,
   /// @cond
   UR_DEVICE_INFO_FORCE_UINT32 = 0x7fffffff
   /// @endcond
@@ -2345,7 +2357,7 @@ typedef enum ur_device_info_t {
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE
 ///         + `NULL == hDevice`
 ///     - ::UR_RESULT_ERROR_INVALID_ENUMERATION
-///         + `::UR_DEVICE_INFO_ASYNC_USM_ALLOCATIONS_EXP < propName`
+///         + `::UR_DEVICE_INFO_MULTI_DEVICE_COMPILE_SUPPORT_EXP < propName`
 ///     - ::UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
 ///         + If `propName` is not supported by the adapter.
 ///     - ::UR_RESULT_ERROR_INVALID_SIZE
@@ -10421,13 +10433,6 @@ typedef enum ur_exp_command_buffer_command_info_t {
 
 } ur_exp_command_buffer_command_info_t;
 
-///////////////////////////////////////////////////////////////////////////////
-#ifndef UR_COMMAND_BUFFER_EXTENSION_STRING_EXP
-/// @brief The extension string which defines support for command-buffers which
-///        is returned when querying device extensions.
-#define UR_COMMAND_BUFFER_EXTENSION_STRING_EXP "ur_exp_command_buffer"
-#endif // UR_COMMAND_BUFFER_EXTENSION_STRING_EXP
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Command-Buffer Descriptor Type
 typedef struct ur_exp_command_buffer_desc_t {
@@ -11722,13 +11727,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferGetInfoExp(
 #if !defined(__GNUC__)
 #pragma region cooperative_kernels_(experimental)
 #endif
-///////////////////////////////////////////////////////////////////////////////
-#ifndef UR_COOPERATIVE_KERNELS_EXTENSION_STRING_EXP
-/// @brief The extension string which defines support for cooperative-kernels
-///        which is returned when querying device extensions.
-#define UR_COOPERATIVE_KERNELS_EXTENSION_STRING_EXP "ur_exp_cooperative_kernels"
-#endif // UR_COOPERATIVE_KERNELS_EXTENSION_STRING_EXP
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Enqueue a command to execute a cooperative kernel
 ///
@@ -11878,13 +11876,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urEnqueueTimestampRecordingExp(
 #if !defined(__GNUC__)
 #pragma region launch_properties_(experimental)
 #endif
-///////////////////////////////////////////////////////////////////////////////
-#ifndef UR_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP
-/// @brief The extension string that defines support for the Launch Properties
-///        extension, which is returned when querying device extensions.
-#define UR_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP "ur_exp_launch_properties"
-#endif // UR_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Specifies a launch property id
 ///
@@ -12031,14 +12022,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urEnqueueKernelLaunchCustomExp(
 #if !defined(__GNUC__)
 #pragma region multi_device_compile_(experimental)
 #endif
-///////////////////////////////////////////////////////////////////////////////
-#ifndef UR_MULTI_DEVICE_COMPILE_EXTENSION_STRING_EXP
-/// @brief The extension string which defines support for test
-///        which is returned when querying device extensions.
-#define UR_MULTI_DEVICE_COMPILE_EXTENSION_STRING_EXP                           \
-  "ur_exp_multi_device_compile"
-#endif // UR_MULTI_DEVICE_COMPILE_EXTENSION_STRING_EXP
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Produces an executable program from one program, negates need for the
 ///        linking step.
@@ -12226,13 +12209,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urUSMReleaseExp(
 #if !defined(__GNUC__)
 #pragma region usm_p2p_(experimental)
 #endif
-///////////////////////////////////////////////////////////////////////////////
-#ifndef UR_USM_P2P_EXTENSION_STRING_EXP
-/// @brief The extension string that defines support for USM P2P which is
-///        returned when querying device extensions.
-#define UR_USM_P2P_EXTENSION_STRING_EXP "ur_exp_usm_p2p"
-#endif // UR_USM_P2P_EXTENSION_STRING_EXP
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Supported peer info
 typedef enum ur_exp_peer_info_t {

unified-runtime/include/ur_print.hpp

@@ -3032,6 +3032,18 @@ inline std::ostream &operator<<(std::ostream &os, enum ur_device_info_t value) {
   case UR_DEVICE_INFO_ASYNC_USM_ALLOCATIONS_EXP:
     os << "UR_DEVICE_INFO_ASYNC_USM_ALLOCATIONS_EXP";
     break;
+  case UR_DEVICE_INFO_LAUNCH_PROPERTIES_SUPPORT_EXP:
+    os << "UR_DEVICE_INFO_LAUNCH_PROPERTIES_SUPPORT_EXP";
+    break;
+  case UR_DEVICE_INFO_USM_P2P_SUPPORT_EXP:
+    os << "UR_DEVICE_INFO_USM_P2P_SUPPORT_EXP";
+    break;
+  case UR_DEVICE_INFO_COOPERATIVE_KERNEL_SUPPORT_EXP:
+    os << "UR_DEVICE_INFO_COOPERATIVE_KERNEL_SUPPORT_EXP";
+    break;
+  case UR_DEVICE_INFO_MULTI_DEVICE_COMPILE_SUPPORT_EXP:
+    os << "UR_DEVICE_INFO_MULTI_DEVICE_COMPILE_SUPPORT_EXP";
+    break;
   default:
     os << "unknown enumerator";
     break;
@@ -5036,6 +5048,58 @@ inline ur_result_t printTagged(std::ostream &os, const void *ptr,
 
     os << ")";
   } break;
+  case UR_DEVICE_INFO_LAUNCH_PROPERTIES_SUPPORT_EXP: {
+    const ur_bool_t *tptr = (const ur_bool_t *)ptr;
+    if (sizeof(ur_bool_t) > size) {
+      os << "invalid size (is: " << size
+         << ", expected: >=" << sizeof(ur_bool_t) << ")";
+      return UR_RESULT_ERROR_INVALID_SIZE;
+    }
+    os << (const void *)(tptr) << " (";
+
+    os << *tptr;
+
+    os << ")";
+  } break;
+  case UR_DEVICE_INFO_USM_P2P_SUPPORT_EXP: {
+    const ur_bool_t *tptr = (const ur_bool_t *)ptr;
+    if (sizeof(ur_bool_t) > size) {
+      os << "invalid size (is: " << size
+         << ", expected: >=" << sizeof(ur_bool_t) << ")";
+      return UR_RESULT_ERROR_INVALID_SIZE;
+    }
+    os << (const void *)(tptr) << " (";
+
+    os << *tptr;
+
+    os << ")";
+  } break;
+  case UR_DEVICE_INFO_COOPERATIVE_KERNEL_SUPPORT_EXP: {
+    const ur_bool_t *tptr = (const ur_bool_t *)ptr;
+    if (sizeof(ur_bool_t) > size) {
+      os << "invalid size (is: " << size
+         << ", expected: >=" << sizeof(ur_bool_t) << ")";
+      return UR_RESULT_ERROR_INVALID_SIZE;
+    }
+    os << (const void *)(tptr) << " (";
+
+    os << *tptr;
+
+    os << ")";
+  } break;
+  case UR_DEVICE_INFO_MULTI_DEVICE_COMPILE_SUPPORT_EXP: {
+    const ur_bool_t *tptr = (const ur_bool_t *)ptr;
+    if (sizeof(ur_bool_t) > size) {
+      os << "invalid size (is: " << size
+         << ", expected: >=" << sizeof(ur_bool_t) << ")";
+      return UR_RESULT_ERROR_INVALID_SIZE;
+    }
+    os << (const void *)(tptr) << " (";
+
+    os << *tptr;
+
+    os << ")";
+  } break;
   default:
     os << "unknown enumerator";
     return UR_RESULT_ERROR_INVALID_ENUMERATION;

unified-runtime/scripts/core/EXP-COMMAND-BUFFER.rst

@@ -40,36 +40,14 @@ Querying Command-Buffer Support
 --------------------------------------------------------------------------------
 
 Support for command-buffers can be queried for a given device/adapter by using
-the device info query with ${X}_DEVICE_INFO_EXTENSIONS. Adapters supporting this
-experimental feature will report the string "ur_exp_command_buffer" in the
-returned list of supported extensions.
-
-.. hint::
-    The macro ${X}_COMMAND_BUFFER_EXTENSION_STRING_EXP is defined for the string
-    returned from extension queries for this feature. Since the actual string
-    may be subject to change it is safer to use this macro when querying for
-    support for this experimental feature.
+the device info query with ${X}_DEVICE_INFO_COMMAND_BUFFER_SUPPORT_EXP. Adapters
+supporting this experimental feature will report ``true``.
 
 .. parsed-literal::
 
-    // Retrieve length of extension string
-    size_t returnedSize;
-    ${x}DeviceGetInfo(hDevice, ${X}_DEVICE_INFO_EXTENSIONS, 0, nullptr,
-                    &returnedSize);
-
-    // Retrieve extension string
-    std::unique_ptr<char[]> returnedExtensions(new char[returnedSize]);
-    ${x}DeviceGetInfo(hDevice, ${X}_DEVICE_INFO_EXTENSIONS, returnedSize,
-                      returnedExtensions.get(), nullptr);
-
-    std::string_view ExtensionsString(returnedExtensions.get());
-    bool CmdBufferSupport =
-        ExtensionsString.find(${X}_COMMAND_BUFFER_EXTENSION_STRING_EXP)
-            != std::string::npos;
-
-.. note::
-    The ${X}_DEVICE_INFO_COMMAND_BUFFER_SUPPORT_EXP device info query exists to
-    serve the same purpose as ${X}_COMMAND_BUFFER_EXTENSION_STRING_EXP.
+    ur_bool_t CmdBufferSupport = false;
+    ${x}DeviceGetInfo(hDevice, ${X}_DEVICE_INFO_COMMAND_BUFFER_SUPPORT_EXP,
+                      sizeof(CmdBufferSupport), &CmdBufferSupport, nullptr);
 
 Command-Buffer Creation
 --------------------------------------------------------------------------------
@@ -402,10 +380,6 @@ ${x}CommandBufferUpdateSignalEventExp there must also have been a non-null
 API
 --------------------------------------------------------------------------------
 
-Macros
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-* ${X}_COMMAND_BUFFER_EXTENSION_STRING_EXP
-
 Enums
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * ${x}_device_info_t
@@ -519,6 +493,9 @@ Changelog
 +-----------+-------------------------------------------------------+
 | 1.9       | Rename enqueue API to urEnqueueCommandBufferExp       |
 +-----------+-------------------------------------------------------+
+| 1.10      | Remove extension string macro, make device info enum  |
+|           | primary mechanism for reporting support.              |
++-----------+-------------------------------------------------------+
 
 Contributors
 --------------------------------------------------------------------------------

unified-runtime/scripts/core/EXP-COOPERATIVE-KERNELS.rst

@@ -36,9 +36,10 @@ The functions defined here align with those specified in Level Zero.
 API
 --------------------------------------------------------------------------------
 
-Macros
+Enums
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-* ${X}_COOPERATIVE_KERNELS_EXTENSION_STRING_EXP
+* ${x}_device_info_t
+    * ${X}_DEVICE_INFO_COOPERATIVE_KERNEL_SUPPORT_EXP
 
 Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -47,22 +48,25 @@ Functions
 
 Changelog
 --------------------------------------------------------------------------------
-+-----------+------------------------+
-| Revision  | Changes                |
-+===========+========================+
-| 1.0       | Initial Draft           |
-+-----------+------------------------+
++-----------+---------------------------------------------+
+| Revision  | Changes                                     |
++===========+=============================================+
+| 1.0       | Initial Draft                               |
++-----------+---------------------------------------------+
+| 1.1       | Switch from extension string macro to       |
+|           | device info enum for reporting support.     |
++-----------+---------------------------------------------+
 
 Support
 --------------------------------------------------------------------------------
 
-Adapters which support this experimental feature *must* return the valid string 
-defined in ``${X}_COOPERATIVE_KERNELS_EXTENSION_STRING_EXP`` 
-as one of the options from ${x}DeviceGetInfo when querying for 
-${X}_DEVICE_INFO_EXTENSIONS. Conversely, before using any of the 
-functionality defined in this experimental feature the user *must* use the 
-device query to determine if the adapter supports this feature.
+Adapters which support this experimental feature *must* return ``true`` when
+queried for ${X}_DEVICE_INFO_COOPERATIVE_KERNEL_SUPPORT_EXP via
+${x}DeviceGetInfo. Conversely, before using any of the functionality defined in
+this experimental feature the user *must* use the device query to determine if
+the adapter supports this feature.
 
 Contributors
 --------------------------------------------------------------------------------
 * Michael Aziz `[email protected] <[email protected]>`_
+* Aaron Greig `[email protected] <[email protected]>`_

unified-runtime/scripts/core/EXP-LAUNCH-PROPERTIES.rst

@@ -55,14 +55,12 @@ cooperative kernels Unified-Runtime extension.
 API
 --------------------------------------------------------------------------------
 
-Macros
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-* ${X}_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP
-
 Enums
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+* ${x}_device_info_t
+    * ${X}_DEVICE_INFO_LAUNCH_PROPERTIES_SUPPORT_EXP
+
 * ${x}_exp_launch_property_id_t
 
 Unions
@@ -83,9 +81,12 @@ Functions
 Support
 --------------------------------------------------------------------------------
 
-Adapters which support this experimental feature *must* return the valid string
-defined in ${X}_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP as one of the options from
-${x}DeviceGetInfo when querying for ${X}_DEVICE_INFO_EXTENSIONS.
+Adapters which support this experimental feature *must* return ``true`` when
+queried for ${X}_DEVICE_INFO_LAUNCH_PROPERTIES_SUPPORT_EXP via
+${x}DeviceGetInfo. Conversely, before using any of the functionality defined
+in this experimental feature the user *must* use the device query to determine
+if the adapter supports this feature.
+
 
 Changelog
 --------------------------------------------------------------------------------
@@ -95,8 +96,12 @@ Changelog
 +===========+=============================================+
 | 1.0       | Initial Draft                               |
 +-----------+---------------------------------------------+
+| 1.1       | Switch from extension string macro to       |
+|           | device info enum for reporting support.     |
++-----------+---------------------------------------------+
 
 Contributors
 --------------------------------------------------------------------------------
 
 * JackAKirk `[email protected] <[email protected]>`_
+* Aaron Greig `[email protected] <[email protected]>`_