Changed error type raised on failure to create SyclDevice

It used to be ValueError, now SyclDeviceCreationError is raised.

removed incorrect comment
Adjusted example sycl_queue to handle error creating sub-devices
lower the value of partition keyword from 4 to 2

Author: oleksandr-pavlyk

dpctl/__init__.py

@@ -33,7 +33,11 @@
 __author__ = "Intel Corp."
 
 from dpctl._sycl_context import SyclContext
-from dpctl._sycl_device import SyclDevice
+from dpctl._sycl_device import (
+    SyclDevice,
+    SyclDeviceCreationError,
+    SyclSubDeviceCreationError,
+)
 from dpctl._sycl_device_factory import (
     get_devices,
     get_num_devices,
@@ -76,6 +80,8 @@
 ]
 __all__ += [
     "SyclDevice",
+    "SyclDeviceCreationError",
+    "SyclSubDeviceCreationError",
 ]
 __all__ += [
     "get_devices",

dpctl/_sycl_device.pyx

@@ -95,11 +95,20 @@ import collections
 import warnings
 
 __all__ = [
-    "SyclDevice",
+    "SyclDevice", "SyclDeviceCreationError", "SyclSubDeviceCreationError",
 ]
 
 
-cdef class SubDeviceCreationError(Exception):
+cdef class SyclDeviceCreationError(Exception):
+    """
+    A DeviceCreationError exception is raised when
+    device could not created.
+
+    """
+    pass
+
+
+cdef class SyclSubDeviceCreationError(Exception):
     """
     A SubDeviceCreationError exception is raised when
     sub-devices were not created.
@@ -165,6 +174,7 @@ cdef str _device_type_to_filter_string_part(_device_type DTy):
     else:
         return "unknown"
 
+
 cdef void _init_helper(_SyclDevice device, DPCTLSyclDeviceRef DRef):
     "Populate attributes of device from opaque device reference DRef"
     device._device_ref = DRef
@@ -262,20 +272,20 @@ cdef class SyclDevice(_SyclDevice):
             DSRef = DPCTLFilterSelector_Create(filter_c_str)
             ret = self._init_from_selector(DSRef)
             if ret == -1:
-                raise ValueError(
+                raise SyclDeviceCreationError(
                     "Could not create a SyclDevice with the selector string"
                 )
         elif isinstance(arg, _SyclDevice):
             ret = self._init_from__SyclDevice(arg)
             if ret == -1:
-                raise ValueError(
+                raise SyclDeviceCreationError(
                     "Could not create a SyclDevice from _SyclDevice instance"
                 )
         elif arg is None:
             DSRef = DPCTLDefaultSelector_Create()
             ret = self._init_from_selector(DSRef)
             if ret == -1:
-                raise ValueError(
+                raise SyclDeviceCreationError(
                     "Could not create a SyclDevice from default selector"
                 )
         else:
@@ -746,7 +756,7 @@ cdef class SyclDevice(_SyclDevice):
         if count > 0:
             DVRef = DPCTLDevice_CreateSubDevicesEqually(self._device_ref, count)
         if DVRef is NULL:
-            raise SubDeviceCreationError(
+            raise SyclSubDeviceCreationError(
                 "Sub-devices were not created." if (count > 0) else
                 "Sub-devices were not created, "
                 "requested compute units count was zero."
@@ -785,7 +795,7 @@ cdef class SyclDevice(_SyclDevice):
             )
         free(counts_buff)
         if DVRef is NULL:
-            raise SubDeviceCreationError(
+            raise SyclSubDeviceCreationError(
                 "Sub-devices were not created." if (min_count > 0) else
                 "Sub-devices were not created, "
                 "sub-device execution units counts must be positive."
@@ -801,7 +811,7 @@ cdef class SyclDevice(_SyclDevice):
         cdef DPCTLDeviceVectorRef DVRef = NULL
         DVRef = DPCTLDevice_CreateSubDevicesByAffinity(self._device_ref, domain)
         if DVRef is NULL:
-            raise SubDeviceCreationError("Sub-devices were not created.")
+            raise SyclSubDeviceCreationError("Sub-devices were not created.")
         return _get_devices(DVRef)
 
     def create_sub_devices(self, **kwargs):

dpctl/tests/test_sycl_device.py

@@ -20,7 +20,7 @@
 import pytest
 
 import dpctl
-from dpctl._sycl_device import SubDeviceCreationError
+from dpctl import SyclDeviceCreationError, SyclSubDeviceCreationError
 
 list_of_standard_selectors = [
     dpctl.select_accelerator_device,
@@ -363,7 +363,7 @@ def check_create_sub_devices_equally(device):
     try:
         n = int(device.max_compute_units / 2)
         device.create_sub_devices(partition=n)
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -382,7 +382,7 @@ def check_create_sub_devices_by_counts(device):
     try:
         n = device.max_compute_units / 2
         device.create_sub_devices(partition=(n, n))
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -400,7 +400,7 @@ def check_create_sub_devices_by_counts_zeros(device):
 def check_create_sub_devices_by_affinity_not_applicable(device):
     try:
         device.create_sub_devices(partition="not_applicable")
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -411,7 +411,7 @@ def check_create_sub_devices_by_affinity_not_applicable(device):
 def check_create_sub_devices_by_affinity_numa(device):
     try:
         device.create_sub_devices(partition="numa")
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -422,7 +422,7 @@ def check_create_sub_devices_by_affinity_numa(device):
 def check_create_sub_devices_by_affinity_L4_cache(device):
     try:
         device.create_sub_devices(partition="L4_cache")
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -433,7 +433,7 @@ def check_create_sub_devices_by_affinity_L4_cache(device):
 def check_create_sub_devices_by_affinity_L3_cache(device):
     try:
         device.create_sub_devices(partition="L3_cache")
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -444,7 +444,7 @@ def check_create_sub_devices_by_affinity_L3_cache(device):
 def check_create_sub_devices_by_affinity_L2_cache(device):
     try:
         device.create_sub_devices(partition="L2_cache")
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -455,7 +455,7 @@ def check_create_sub_devices_by_affinity_L2_cache(device):
 def check_create_sub_devices_by_affinity_L1_cache(device):
     try:
         device.create_sub_devices(partition="L1_cache")
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -466,7 +466,7 @@ def check_create_sub_devices_by_affinity_L1_cache(device):
 def check_create_sub_devices_by_affinity_next_partitionable(device):
     try:
         device.create_sub_devices(partition="next_partitionable")
-    except SubDeviceCreationError:
+    except SyclSubDeviceCreationError:
         pytest.skip(
             "create_sub_devices can't create sub-devices on this device"
         )
@@ -613,7 +613,12 @@ def test_invalid_filter_selectors(invalid_filter):
     """
     An invalid filter string should always be caught and a ValueError raised.
     """
-    with pytest.raises(ValueError):
+    exc = (
+        SyclDeviceCreationError
+        if isinstance(invalid_filter, str)
+        else ValueError
+    )
+    with pytest.raises(exc):
         dpctl.SyclDevice(invalid_filter)
 
 

examples/python/sycl_queue.py

@@ -55,7 +55,12 @@ def create_queue_from_subdevice():
     Create a queue from a sub-device.
     """
     cpu_d = dpctl.SyclDevice("opencl:cpu:0")
-    sub_devs = cpu_d.create_sub_devices(partition=4)
+    try:
+        sub_devs = cpu_d.create_sub_devices(partition=2)
+    except dpctl.SyclSubDeviceCreationError:
+        print("Could not create sub device.")
+        print(f"{cpu_d} has {cpu_d.max_compute_units} compute units")
+        return
     q = dpctl.SyclQueue(sub_devs[0])
     # a single-device context is created automatically
     print(
@@ -69,10 +74,14 @@ def create_queue_from_subdevice_multidevice_context():
     Create a queue from a sub-device.
     """
     cpu_d = dpctl.SyclDevice("opencl:cpu:0")
-    sub_devs = cpu_d.create_sub_devices(partition=4)
+    try:
+        sub_devs = cpu_d.create_sub_devices(partition=2)
+    except dpctl.SyclSubDeviceCreationError:
+        print("Could not create sub device.")
+        print(f"{cpu_d} has {cpu_d.max_compute_units} compute units")
+        return
     ctx = dpctl.SyclContext(sub_devs)
-    q = dpctl.SyclQueue(ctx, sub_devs[0])
-    # a single-device context is created automatically
+    q = dpctl.SyclQueue(ctx, sub_devs[0], partition="enable_profiling")
     print(
         "Number of devices in SyclContext " "associated with the queue: ",
         q.sycl_context.device_count,