add sentinel values for enums and remove duplication

Author: ndgrigorian

dpctl/_backend.pxd

@@ -106,6 +106,8 @@ cdef extern from "syclinterface/dpctl_sycl_enum_types.h":
 
     ctypedef enum _partition_affinity_domain_type \
             "DPCTLPartitionAffinityDomainType":
+        _PARTITION_AFFINITY_DOMAIN_UNKNOWN  \
+            "DPCTL_PARTITION_AFFINITY_DOMAIN_UNKNOWN",
         _not_applicable                     "not_applicable",
         _numa                               "numa",
         _L4_cache                           "L4_cache",
@@ -131,17 +133,20 @@ cdef extern from "syclinterface/dpctl_sycl_enum_types.h":
         _MEM_CACHE_TYPE_READ_WRITE       "DPCTL_MEM_CACHE_TYPE_READ_WRITE"
 
     ctypedef enum _local_mem_type "DPCTLLocalMemType":
+        _LOCAL_MEM_TYPE_UNKNOWN          "DPCTL_LOCAL_MEM_TYPE_UNKNOWN"
         _LOCAL_MEM_TYPE_NONE             "DPCTL_LOCAL_MEM_TYPE_NONE"
         _LOCAL_MEM_TYPE_LOCAL            "DPCTL_LOCAL_MEM_TYPE_LOCAL"
         _LOCAL_MEM_TYPE_GLOBAL           "DPCTL_LOCAL_MEM_TYPE_GLOBAL"
 
     ctypedef enum _partition_property_type "DPCTLPartitionPropertyType":
+        _PARTITION_UNKNOWN               "DPCTL_PARTITION_UNKNOWN"
         _PARTITION_NO_PARTITION          "DPCTL_PARTITION_NO_PARTITION"
         _PARTITION_EQUALLY               "DPCTL_PARTITION_EQUALLY"
         _PARTITION_BY_COUNTS             "DPCTL_PARTITION_BY_COUNTS"
         _PARTITION_BY_AFFINITY_DOMAIN    "DPCTL_PARTITION_BY_AFFINITY_DOMAIN"
 
     ctypedef enum _fp_config_type "DPCTLFPConfigType":
+        _FP_UNKNOWN                    "DPCTL_FP_UNKNOWN"
         _FP_DENORM                     "DPCTL_FP_DENORM"
         _FP_INF_NAN                    "DPCTL_FP_INF_NAN"
         _FP_ROUND_TO_NEAREST           "DPCTL_FP_ROUND_TO_NEAREST"
@@ -152,13 +157,15 @@ cdef extern from "syclinterface/dpctl_sycl_enum_types.h":
         _FP_SOFT_FLOAT                 "DPCTL_FP_SOFT_FLOAT"
 
     ctypedef enum _memory_order_type "DPCTLMemoryOrderType":
+        _MEMORY_ORDER_UNKNOWN            "DPCTL_MEMORY_ORDER_UNKNOWN"
         _MEMORY_ORDER_RELAXED            "DPCTL_MEMORY_ORDER_RELAXED"
         _MEMORY_ORDER_ACQUIRE            "DPCTL_MEMORY_ORDER_ACQUIRE"
         _MEMORY_ORDER_RELEASE            "DPCTL_MEMORY_ORDER_RELEASE"
         _MEMORY_ORDER_ACQ_REL            "DPCTL_MEMORY_ORDER_ACQ_REL"
         _MEMORY_ORDER_SEQ_CST            "DPCTL_MEMORY_ORDER_SEQ_CST"
 
     ctypedef enum _memory_scope_type "DPCTLMemoryScopeType":
+        _MEMORY_SCOPE_UNKNOWN            "DPCTL_MEMORY_SCOPE_UNKNOWN"
         _MEMORY_SCOPE_WORK_ITEM          "DPCTL_MEMORY_SCOPE_WORK_ITEM"
         _MEMORY_SCOPE_SUB_GROUP          "DPCTL_MEMORY_SCOPE_SUB_GROUP"
         _MEMORY_SCOPE_WORK_GROUP         "DPCTL_MEMORY_SCOPE_WORK_GROUP"

dpctl/_sycl_device.pyx

@@ -214,6 +214,10 @@ cdef tuple _to_enum_tuple(
 ):
     """
     Converts an array of DPCTL enum values into a tuple of ``enum_type``s
+
+    The DPCTL enums reserve value 0 for an unrecognized value, so a DPCTL
+    value of ``n`` corresponds to the ``n``-th member of ``enum_type``, whose
+    members are numbered from 1 by ``enum.auto()``.
     """
     cdef list res = []
     cdef size_t i
@@ -222,9 +226,10 @@ cdef tuple _to_enum_tuple(
         return ()
     try:
         for i in range(arr_len):
-            if arr[i] < 0:
+            try:
+                res.append(enum_type(arr[i]))
+            except ValueError:
                 raise RuntimeError(f"Unrecognized {descr} reported")
-            res.append(enum_type(arr[i] + 1))
     finally:
         DPCTLInt_Array_Delete(arr)
 
@@ -2336,6 +2341,10 @@ cdef class SyclDevice(_SyclDevice):
         Returns:
             :class:`dpctl.partition_property`:
                 The partition property that was used to create this device.
+
+        Raises:
+            RuntimeError:
+                If an unrecognized partition property is reported by runtime.
         """
         cdef _partition_property_type ppTy = (
             DPCTLDevice_GetPartitionTypeProperty(self._device_ref)
@@ -2348,7 +2357,7 @@ cdef class SyclDevice(_SyclDevice):
             return partition_property.partition_by_counts
         elif ppTy == _partition_property_type._PARTITION_BY_AFFINITY_DOMAIN:
             return partition_property.partition_by_affinity_domain
-        return partition_property.no_partition
+        raise RuntimeError("Unrecognized partition property reported")
 
     @property
     def partition_type_affinity_domain(self):
@@ -2359,6 +2368,11 @@ cdef class SyclDevice(_SyclDevice):
         Returns:
             str:
                 The affinity domain string.
+
+        Raises:
+            RuntimeError:
+                If an unrecognized partition affinity domain is reported by
+                runtime.
         """
         cdef _partition_affinity_domain_type padTy = (
             DPCTLDevice_GetPartitionTypeAffinityDomain(self._device_ref)
@@ -2377,7 +2391,9 @@ cdef class SyclDevice(_SyclDevice):
             return "L1_cache"
         elif padTy == _partition_affinity_domain_type._next_partitionable:
             return "next_partitionable"
-        return "not_applicable"
+        raise RuntimeError(
+            "Unrecognized partition affinity domain reported"
+        )
 
     @property
     def half_fp_config(self):
@@ -2560,6 +2576,11 @@ cdef class SyclDevice(_SyclDevice):
         Returns:
             Tuple[str]:
                 Tuple of supported affinity domain names.
+
+        Raises:
+            RuntimeError:
+                If an unrecognized partition affinity domain is reported by
+                runtime.
         """
         cdef int *arr = NULL
         cdef size_t arr_len = 0
@@ -2580,15 +2601,20 @@ cdef class SyclDevice(_SyclDevice):
         arr = DPCTLDevice_GetPartitionAffinityDomains(
             self._device_ref, &arr_len
         )
-        if arr is not NULL and arr_len > 0:
+        if arr is NULL:
+            return ()
+        try:
             res = []
             for i in range(arr_len):
-                res.append(_pad_map.get(arr[i], "not_applicable"))
-            DPCTLInt_Array_Delete(arr)
-            return tuple(res)
-        if arr is not NULL:
+                if arr[i] not in _pad_map:
+                    raise RuntimeError(
+                        "Unrecognized partition affinity domain reported"
+                    )
+                res.append(_pad_map[arr[i]])
+        finally:
             DPCTLInt_Array_Delete(arr)
-        return ()
+
+        return tuple(res)
 
     cdef cpp_bool equals(self, SyclDevice other):
         """ Returns ``True`` if the :class:`dpctl.SyclDevice` argument has the

libsyclinterface/helper/include/dpctl_utils_helper.h

@@ -172,13 +172,82 @@ DPCTL_DPCTLPartitionAffinityDomainTypeToSycl(
  * @param    PartitionAffinityDomain sycl::info::partition_affinity_domain to be
  * converted to DPCTLPartitionAffinityDomainType enum.
  * @return   A DPCTLPartitionAffinityDomainType enum value for the input
- * sycl::info::partition_affinity_domain enum value.
- * @throws runtime_error
+ * sycl::info::partition_affinity_domain enum value, or
+ * DPCTL_PARTITION_AFFINITY_DOMAIN_UNKNOWN if the value is not recognized.
  */
 DPCTL_API
 DPCTLPartitionAffinityDomainType DPCTL_SyclPartitionAffinityDomainToDPCTLType(
     sycl::info::partition_affinity_domain PartitionAffinityDomain);
 
+/*!
+ * @brief Converts a sycl::info::fp_config enum value to corresponding
+ * DPCTLFPConfigType enum value.
+ *
+ * @param    FPConfig sycl::info::fp_config to be converted to
+ * DPCTLFPConfigType enum.
+ * @return   A DPCTLFPConfigType enum value for the input
+ * sycl::info::fp_config enum value, or DPCTL_FP_UNKNOWN if the value is
+ * not recognized.
+ */
+DPCTL_API
+DPCTLFPConfigType DPCTL_SyclFPConfigToDPCTLType(sycl::info::fp_config FPConfig);
+
+/*!
+ * @brief Converts a sycl::info::local_mem_type enum value to corresponding
+ * DPCTLLocalMemType enum value.
+ *
+ * @param    LocalMemType sycl::info::local_mem_type to be converted to
+ * DPCTLLocalMemType enum.
+ * @return   A DPCTLLocalMemType enum value for the input
+ * sycl::info::local_mem_type enum value, or DPCTL_LOCAL_MEM_TYPE_UNKNOWN if
+ * the value is not recognized.
+ */
+DPCTL_API
+DPCTLLocalMemType
+DPCTL_SyclLocalMemTypeToDPCTLType(sycl::info::local_mem_type LocalMemType);
+
+/*!
+ * @brief Converts a sycl::memory_order enum value to corresponding
+ * DPCTLMemoryOrderType enum value.
+ *
+ * @param    MemoryOrder sycl::memory_order to be converted to
+ * DPCTLMemoryOrderType enum.
+ * @return   A DPCTLMemoryOrderType enum value for the input
+ * sycl::memory_order enum value, or DPCTL_MEMORY_ORDER_UNKNOWN if the value
+ * is not recognized.
+ */
+DPCTL_API
+DPCTLMemoryOrderType
+DPCTL_SyclMemoryOrderToDPCTLType(sycl::memory_order MemoryOrder);
+
+/*!
+ * @brief Converts a sycl::memory_scope enum value to corresponding
+ * DPCTLMemoryScopeType enum value.
+ *
+ * @param    MemoryScope sycl::memory_scope to be converted to
+ * DPCTLMemoryScopeType enum.
+ * @return   A DPCTLMemoryScopeType enum value for the input
+ * sycl::memory_scope enum value, or DPCTL_MEMORY_SCOPE_UNKNOWN if the value
+ * is not recognized.
+ */
+DPCTL_API
+DPCTLMemoryScopeType
+DPCTL_SyclMemoryScopeToDPCTLType(sycl::memory_scope MemoryScope);
+
+/*!
+ * @brief Converts a sycl::info::partition_property enum value to corresponding
+ * DPCTLPartitionPropertyType enum value.
+ *
+ * @param    PartitionProperty sycl::info::partition_property to be converted
+ * to DPCTLPartitionPropertyType enum.
+ * @return   A DPCTLPartitionPropertyType enum value for the input
+ * sycl::info::partition_property enum value, or DPCTL_PARTITION_UNKNOWN if
+ * the value is not recognized.
+ */
+DPCTL_API
+DPCTLPartitionPropertyType DPCTL_SyclPartitionPropertyToDPCTLType(
+    sycl::info::partition_property PartitionProperty);
+
 /*!
  * @brief Converts a DPCTLPeerAccessType enum value to its corresponding
  * sycl::ext::oneapi::peer_access enum value.

libsyclinterface/helper/source/dpctl_utils_helper.cpp

@@ -26,6 +26,7 @@
 #include "dpctl_utils_helper.h"
 #include "Config/dpctl_config.h"
 #include <sstream>
+#include <stdexcept>
 #include <string>
 
 using namespace sycl;
@@ -466,7 +467,101 @@ DPCTLPartitionAffinityDomainType DPCTL_SyclPartitionAffinityDomainToDPCTLType(
     case info::partition_affinity_domain::next_partitionable:
         return DPCTLPartitionAffinityDomainType::next_partitionable;
     default:
-        throw std::runtime_error("Unsupported partition_affinity_domain type");
+        return DPCTLPartitionAffinityDomainType::
+            DPCTL_PARTITION_AFFINITY_DOMAIN_UNKNOWN;
+    }
+}
+
+DPCTLFPConfigType DPCTL_SyclFPConfigToDPCTLType(info::fp_config FPConfig)
+{
+    switch (FPConfig) {
+    case info::fp_config::denorm:
+        return DPCTLFPConfigType::DPCTL_FP_DENORM;
+    case info::fp_config::inf_nan:
+        return DPCTLFPConfigType::DPCTL_FP_INF_NAN;
+    case info::fp_config::round_to_nearest:
+        return DPCTLFPConfigType::DPCTL_FP_ROUND_TO_NEAREST;
+    case info::fp_config::round_to_zero:
+        return DPCTLFPConfigType::DPCTL_FP_ROUND_TO_ZERO;
+    case info::fp_config::round_to_inf:
+        return DPCTLFPConfigType::DPCTL_FP_ROUND_TO_INF;
+    case info::fp_config::fma:
+        return DPCTLFPConfigType::DPCTL_FP_FMA;
+    case info::fp_config::correctly_rounded_divide_sqrt:
+        return DPCTLFPConfigType::DPCTL_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT;
+    case info::fp_config::soft_float:
+        return DPCTLFPConfigType::DPCTL_FP_SOFT_FLOAT;
+    default:
+        return DPCTLFPConfigType::DPCTL_FP_UNKNOWN;
+    }
+}
+
+DPCTLLocalMemType
+DPCTL_SyclLocalMemTypeToDPCTLType(info::local_mem_type LocalMemType)
+{
+    switch (LocalMemType) {
+    case info::local_mem_type::none:
+        return DPCTLLocalMemType::DPCTL_LOCAL_MEM_TYPE_NONE;
+    case info::local_mem_type::local:
+        return DPCTLLocalMemType::DPCTL_LOCAL_MEM_TYPE_LOCAL;
+    case info::local_mem_type::global:
+        return DPCTLLocalMemType::DPCTL_LOCAL_MEM_TYPE_GLOBAL;
+    default:
+        return DPCTLLocalMemType::DPCTL_LOCAL_MEM_TYPE_UNKNOWN;
+    }
+}
+
+DPCTLMemoryOrderType DPCTL_SyclMemoryOrderToDPCTLType(memory_order MemoryOrder)
+{
+    switch (MemoryOrder) {
+    case memory_order::relaxed:
+        return DPCTLMemoryOrderType::DPCTL_MEMORY_ORDER_RELAXED;
+    case memory_order::acquire:
+        return DPCTLMemoryOrderType::DPCTL_MEMORY_ORDER_ACQUIRE;
+    case memory_order::release:
+        return DPCTLMemoryOrderType::DPCTL_MEMORY_ORDER_RELEASE;
+    case memory_order::acq_rel:
+        return DPCTLMemoryOrderType::DPCTL_MEMORY_ORDER_ACQ_REL;
+    case memory_order::seq_cst:
+        return DPCTLMemoryOrderType::DPCTL_MEMORY_ORDER_SEQ_CST;
+    default:
+        return DPCTLMemoryOrderType::DPCTL_MEMORY_ORDER_UNKNOWN;
+    }
+}
+
+DPCTLMemoryScopeType DPCTL_SyclMemoryScopeToDPCTLType(memory_scope MemoryScope)
+{
+    switch (MemoryScope) {
+    case memory_scope::work_item:
+        return DPCTLMemoryScopeType::DPCTL_MEMORY_SCOPE_WORK_ITEM;
+    case memory_scope::sub_group:
+        return DPCTLMemoryScopeType::DPCTL_MEMORY_SCOPE_SUB_GROUP;
+    case memory_scope::work_group:
+        return DPCTLMemoryScopeType::DPCTL_MEMORY_SCOPE_WORK_GROUP;
+    case memory_scope::device:
+        return DPCTLMemoryScopeType::DPCTL_MEMORY_SCOPE_DEVICE;
+    case memory_scope::system:
+        return DPCTLMemoryScopeType::DPCTL_MEMORY_SCOPE_SYSTEM;
+    default:
+        return DPCTLMemoryScopeType::DPCTL_MEMORY_SCOPE_UNKNOWN;
+    }
+}
+
+DPCTLPartitionPropertyType DPCTL_SyclPartitionPropertyToDPCTLType(
+    info::partition_property PartitionProperty)
+{
+    switch (PartitionProperty) {
+    case info::partition_property::no_partition:
+        return DPCTLPartitionPropertyType::DPCTL_PARTITION_NO_PARTITION;
+    case info::partition_property::partition_equally:
+        return DPCTLPartitionPropertyType::DPCTL_PARTITION_EQUALLY;
+    case info::partition_property::partition_by_counts:
+        return DPCTLPartitionPropertyType::DPCTL_PARTITION_BY_COUNTS;
+    case info::partition_property::partition_by_affinity_domain:
+        return DPCTLPartitionPropertyType::DPCTL_PARTITION_BY_AFFINITY_DOMAIN;
+    default:
+        // TODO: investigate ext_intel_partition_by_cslice extension
+        return DPCTLPartitionPropertyType::DPCTL_PARTITION_UNKNOWN;
     }
 }
 

libsyclinterface/include/syclinterface/dpctl_sycl_enum_types.h

@@ -143,6 +143,7 @@ typedef enum
  */
 typedef enum
 {
+    DPCTL_PARTITION_AFFINITY_DOMAIN_UNKNOWN = 0,
     not_applicable,
     numa,
     L4_cache,
@@ -194,13 +195,15 @@ typedef enum
 
 typedef enum
 {
+    DPCTL_LOCAL_MEM_TYPE_UNKNOWN = 0,
     DPCTL_LOCAL_MEM_TYPE_NONE,
     DPCTL_LOCAL_MEM_TYPE_LOCAL,
     DPCTL_LOCAL_MEM_TYPE_GLOBAL
 } DPCTLLocalMemType;
 
 typedef enum
 {
+    DPCTL_PARTITION_UNKNOWN = 0,
     DPCTL_PARTITION_NO_PARTITION,
     DPCTL_PARTITION_EQUALLY,
     DPCTL_PARTITION_BY_COUNTS,
@@ -209,6 +212,7 @@ typedef enum
 
 typedef enum
 {
+    DPCTL_FP_UNKNOWN = 0,
     DPCTL_FP_DENORM,
     DPCTL_FP_INF_NAN,
     DPCTL_FP_ROUND_TO_NEAREST,
@@ -221,6 +225,7 @@ typedef enum
 
 typedef enum
 {
+    DPCTL_MEMORY_ORDER_UNKNOWN = 0,
     DPCTL_MEMORY_ORDER_RELAXED,
     DPCTL_MEMORY_ORDER_ACQUIRE,
     DPCTL_MEMORY_ORDER_RELEASE,
@@ -230,6 +235,7 @@ typedef enum
 
 typedef enum
 {
+    DPCTL_MEMORY_SCOPE_UNKNOWN = 0,
     DPCTL_MEMORY_SCOPE_WORK_ITEM,
     DPCTL_MEMORY_SCOPE_SUB_GROUP,
     DPCTL_MEMORY_SCOPE_WORK_GROUP,