Add DPCTLDevice_GetPartionMaxSubDevices requested in #1004

Author: oleksandr-pavlyk

libsyclinterface/include/dpctl_sycl_device_interface.h

@@ -597,6 +597,18 @@ DPCTL_API
 __dpctl_give DPCTLSyclDeviceRef
 DPCTLDevice_GetParentDevice(__dpctl_keep const DPCTLSyclDeviceRef DRef);
 
+/*!
+ * @brief Wrapper over
+ * device.get_info<info::device::partition_max_sub_devices>
+ *
+ * @param    DRef           Opaque pointer to a sycl::device
+ * @return   Returns the maximum number of sub-devices that can be created
+ * when this device is partitioned.
+ */
+DPCTL_API
+uint32_t DPCTLDevice_GetPartitionMaxSubDevices(
+    __dpctl_keep const DPCTLSyclDeviceRef DRef);
+
 /*!
  * @brief Wrapper over
  * std::hash<sycl::device>'s operator()

libsyclinterface/source/dpctl_sycl_device_interface.cpp

@@ -573,6 +573,24 @@ DPCTLDevice_GetParentDevice(__dpctl_keep const DPCTLSyclDeviceRef DRef)
         return nullptr;
 }
 
+uint32_t DPCTLDevice_GetPartitionMaxSubDevices(
+    __dpctl_keep const DPCTLSyclDeviceRef DRef)
+{
+    auto D = unwrap<device>(DRef);
+    if (D) {
+        try {
+            uint32_t part_max_sub_devs =
+                D->get_info<info::device::partition_max_sub_devices>();
+            return part_max_sub_devs;
+        } catch (std::exception const &e) {
+            error_handler(e, __FILE__, __func__, __LINE__);
+            return 0;
+        }
+    }
+    else
+        return 0;
+}
+
 __dpctl_give DPCTLDeviceVectorRef
 DPCTLDevice_CreateSubDevicesEqually(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                                     size_t count)

libsyclinterface/tests/test_sycl_device_interface.cpp

@@ -415,6 +415,17 @@ TEST_P(TestDPCTLSyclDeviceInterface, ChkGetParentDevice)
     EXPECT_TRUE(pDRef == nullptr);
 }
 
+TEST_P(TestDPCTLSyclDeviceInterface, ChkGetPartitionMaxSubDevices)
+{
+    uint32_t max_part = 0;
+    size_t max_cu = 0;
+    EXPECT_NO_FATAL_FAILURE(max_part =
+                                DPCTLDevice_GetPartitionMaxSubDevices(DRef));
+    EXPECT_TRUE(max_part >= 0);
+    EXPECT_NO_FATAL_FAILURE(max_cu = DPCTLDevice_GetMaxComputeUnits(DRef));
+    EXPECT_TRUE(max_part <= max_cu);
+}
+
 TEST_P(TestDPCTLSyclDeviceInterface, ChkGetProfilingTimerResolution)
 {
     size_t res = 0;
@@ -705,6 +716,14 @@ TEST_F(TestDPCTLSyclDeviceNullArgs, ChkGetParentDevice)
     ASSERT_TRUE(pDRef == nullptr);
 }
 
+TEST_F(TestDPCTLSyclDeviceNullArgs, ChkGetPartitionMaxSubDevices)
+{
+    uint32_t max_part = 0;
+    EXPECT_NO_FATAL_FAILURE(
+        max_part = DPCTLDevice_GetPartitionMaxSubDevices(Null_DRef));
+    ASSERT_TRUE(max_part == 0);
+}
+
 TEST_F(TestDPCTLSyclDeviceNullArgs, ChkCreateSubDevicesEqually)
 {
     DPCTLDeviceVectorRef DVRef = nullptr;