[UR] Addition of num_compute_units query (#16538)

Co-authored-by: Greg Lueck <[email protected]>
Co-authored-by: Kenneth Benzie (Benie) <[email protected]>

Author: 3 people

sycl/cmake/modules/UnifiedRuntimeTag.cmake

@@ -1,7 +1,7 @@
-# commit 095e8464124a48c8ed4b995403e754254c072143
-# Merge: 0bb6789f 07001aa7
-# Author: Kenneth Benzie (Benie) <k.benzie@codeplay.com>
-# Date:   Mon Jan 27 14:53:22 2025 +0000
-#     Merge pull request #2574 from bratpiorka/rrudnick_fix_usm_pool_config_parse
-#     fix parseDisjointPoolConfig and add tests
-set(UNIFIED_RUNTIME_TAG 095e8464124a48c8ed4b995403e754254c072143)
+# commit 78e1b33271d28d26845a4bfae7ae3b72c14e0e63
+# Merge: 902bb2e2 94b32ac2
+# Author: Ross Brunton <ross@codeplay.com>
+# Date:   Tue Jan 28 11:02:44 2025 +0000
+#     Merge pull request #2624 from RossBrunton/ross/msanfix
+#     Assert that Device is valid for memory poisoning
+set(UNIFIED_RUNTIME_TAG 78e1b33271d28d26845a4bfae7ae3b72c14e0e63)

sycl/doc/extensions/proposed/sycl_ext_oneapi_num_compute_units.asciidoc renamed to sycl/doc/extensions/supported/sycl_ext_oneapi_num_compute_units.asciidoc

@@ -44,12 +44,7 @@ SYCL specification refer to that revision.
 
 == Status
 
-This is a proposed extension specification, intended to gather community
-feedback.  Interfaces defined in this specification may not be implemented yet
-or may be in a preliminary state.  The specification itself may also change in
-incompatible ways before it is finalized.  *Shipping software products should
-not rely on APIs defined in this specification.*
-
+This extension is implemented and fully supported by {dpcpp}.
 
 == Overview
 

sycl/include/sycl/info/ext_oneapi_device_traits.def

@@ -81,6 +81,10 @@ __SYCL_PARAM_TRAITS_SPEC(ext::oneapi::experimental, device,
                          composite_device, sycl::device,
                         UR_DEVICE_INFO_COMPOSITE_DEVICE)
 
+__SYCL_PARAM_TRAITS_SPEC(ext::oneapi, device,
+                        num_compute_units, size_t,
+                        UR_DEVICE_INFO_NUM_COMPUTE_UNITS)
+
 #ifdef __SYCL_PARAM_TRAITS_TEMPLATE_SPEC_NEEDS_UNDEF
 #undef __SYCL_PARAM_TRAITS_TEMPLATE_SPEC
 #undef __SYCL_PARAM_TRAITS_TEMPLATE_SPEC_NEEDS_UNDEF

sycl/source/feature_test.hpp.in

@@ -112,6 +112,7 @@ inline namespace _V1 {
 #define SYCL_EXT_ONEAPI_WORK_GROUP_MEMORY 1
 #define SYCL_EXT_ONEAPI_WORK_GROUP_SCRATCH_MEMORY 1
 #define SYCL_EXT_ONEAPI_WORK_GROUP_STATIC 1
+#define SYCL_EXT_ONEAPI_NUM_COMPUTE_UNITS 1
 // In progress yet
 #define SYCL_EXT_ONEAPI_ATOMIC16 0
 

sycl/test-e2e/NumComputeUnits/num_compute_units.cpp

@@ -0,0 +1,27 @@
+// This test checks whether the number of compute units in the device descriptor
+// returns a valid value.
+
+// RUN: %{build} -o %t.out
+// RUN: %{run} %t.out
+
+#include <cassert>
+#include <sycl/detail/core.hpp>
+
+int main() {
+
+#ifdef SYCL_EXT_ONEAPI_NUM_COMPUTE_UNITS
+  sycl::queue Queue;
+  sycl::device Device = Queue.get_device();
+
+  size_t NumberComputeUnits =
+      Device.get_info<sycl::ext::oneapi::info::device::num_compute_units>();
+
+  assert(NumberComputeUnits >= 1 &&
+         "The minimum value for number of compute units in the device is 1");
+
+#else
+  static_assert(false, "SYCL_EXT_ONEAPI_NUM_COMPUTE_UNITS not defined");
+#endif
+
+  return 0;
+}

sycl/test/abi/sycl_symbols_linux.dump

@@ -4029,3 +4029,5 @@ _ZNK4sycl3_V19kernel_id8get_nameEv
 _ZNKSt4hashIN4sycl3_V15queueEEclERKS2_
 __sycl_register_lib
 __sycl_unregister_lib
+_ZNK4sycl3_V16detail11device_impl8get_infoINS0_3ext6oneapi4info6device17num_compute_unitsEEENT_11return_typeEv
+_ZNK4sycl3_V16device13get_info_implINS0_3ext6oneapi4info6device17num_compute_unitsEEENS0_6detail11ABINeutralTINS8_19is_device_info_descIT_E11return_typeEE4typeEv

sycl/test/abi/sycl_symbols_windows.dump

@@ -4344,3 +4344,5 @@
 DllMain
 __sycl_register_lib
 __sycl_unregister_lib
+??$get_info@Unum_compute_units@device@info@oneapi@ext@_V1@sycl@@@device_impl@detail@_V1@sycl@@QEBA_KXZ
+??$get_info_impl@Unum_compute_units@device@info@oneapi@ext@_V1@sycl@@@device@_V1@sycl@@AEBA_KXZ

sycl/unittests/Extensions/CMakeLists.txt

@@ -24,3 +24,4 @@ add_sycl_unittest(ExtensionsTests OBJECT
 add_subdirectory(CommandGraph)
 add_subdirectory(VirtualFunctions)
 add_subdirectory(VirtualMemory)
+add_subdirectory(NumComputeUnits)

sycl/unittests/Extensions/NumComputeUnits/CMakeLists.txt

@@ -0,0 +1,4 @@
+add_sycl_unittest(NumComputeUnitsTests OBJECT
+  ReturnedQueryValue.cpp
+)
+

sycl/unittests/Extensions/NumComputeUnits/ReturnedQueryValue.cpp

@@ -0,0 +1,36 @@
+#include <sycl/sycl.hpp>
+
+#include "ur_api.h"
+
+#include <gtest/gtest.h>
+#include <helpers/UrMock.hpp>
+
+template <uint32_t ExpectedValue>
+ur_result_t after_urDeviceGetInfo(void *pParams) {
+  auto params = reinterpret_cast<ur_device_get_info_params_t *>(pParams);
+  if (*params->ppropName == UR_DEVICE_INFO_NUM_COMPUTE_UNITS) {
+    if (*params->ppPropValue)
+      *static_cast<uint32_t *>(*params->ppPropValue) = ExpectedValue;
+    if (*params->ppPropSizeRet)
+      **params->ppPropSizeRet = sizeof(uint32_t);
+  }
+  return UR_RESULT_SUCCESS;
+}
+
+TEST(NumComputeUnitsTests, CheckExpectedValue) {
+
+  constexpr uint32_t ExpectedNumComputeUnits = 111;
+
+  sycl::unittest::UrMock<> Mock;
+  sycl::platform Platform = sycl::platform();
+  sycl::queue Queue{Platform.get_devices()[0]};
+
+  mock::getCallbacks().set_after_callback(
+      "urDeviceGetInfo", &after_urDeviceGetInfo<ExpectedNumComputeUnits>);
+
+  size_t NumberComputeUnits =
+      Queue.get_device()
+          .get_info<sycl::ext::oneapi::info::device::num_compute_units>();
+
+  EXPECT_EQ(NumberComputeUnits, ExpectedNumComputeUnits);
+}