Change the QueueManager API to require backend type.

Author: diptorupd

backends/include/dppl_sycl_context_interface.h

@@ -34,15 +34,38 @@
 
 DPPL_C_EXTERN_C_BEGIN
 
+/*!
+ * @brief Redefinition of DPC++'s backend types. We have this wrapper so that
+ * the sycl header is not exposed to Python extensions.
+ *
+ */
+typedef enum
+{
+    DPPL_OPENCL     = 1 << 16,
+    DPPL_HOST       = 1 << 15,
+    DPPL_LEVEL_ZERO = 1 << 14,
+    DPPL_CUDA       = 1 << 13
+} DPPLSyclBEType;
+
 /*!
  * @brief Returns true if this SYCL context is a host context.
  *
- * @param    CtxRef        A opaque pointer to a sycl::context.
+ * @param    CtxRef        An opaque pointer to a sycl::context.
  * @return   True if the SYCL context is a host context, else False.
  */
 DPPL_API
 bool DPPLContext_IsHost (__dppl_keep const DPPLSyclContextRef CtxRef);
 
+/*!
+ * @brief
+ *
+ * @param    CtxRef         An opaque pointer to a sycl::context.
+ * @return   {return}       My Param doc
+ */
+DPPL_API
+DPPLSyclBackendType
+DPPLContext_GetBackend (__dppl_keep const DPPLSyclContextRef CtxRef);
+
 /*!
  * @brief Delete the pointer after casting it to sycl::context
  *

backends/include/dppl_sycl_device_interface.h

@@ -42,13 +42,15 @@ DPPL_C_EXTERN_C_BEGIN
  */
 typedef enum
 {
-    DPPL_CPU,
-    DPPL_GPU,
-    DPPL_ACCELERATOR,
-    DPPL_CUSTOM,
-    DPPL_AUTOMATIC,
-    DPPL_HOST,
-    DPPL_ALL
+    DPPL_CPU         = 1 << 0,
+    DPPL_GPU         = 1 << 1,
+    DPPL_ACCELERATOR = 1 << 2,
+    DPPL_CUSTOM      = 1 << 3,
+    DPPL_AUTOMATIC   = 1 << 4,
+    DPPL_HOST        = 1 << 5,
+    DPPL_ALL         = 1 << 6
+    // IMP: before adding new values here look at DPPLSyclBEType enum. The
+    // values should not overlap.
 } DPPLSyclDeviceType;
 
 /*!

backends/include/dppl_sycl_queue_manager.h

@@ -35,6 +35,7 @@
 
 #include "dppl_data_types.h"
 #include "dppl_sycl_types.h"
+#include "dppl_sycl_context_interface.h"
 #include "dppl_sycl_device_interface.h"
 #include "Support/DllExport.h"
 #include "Support/ExternC.h"
@@ -63,7 +64,8 @@ __dppl_give DPPLSyclQueueRef DPPLQueueMgr_GetCurrentQueue ();
  * raised if no such device exists.
  */
 DPPL_API
-__dppl_give DPPLSyclQueueRef DPPLQueueMgr_GetQueue (DPPLSyclDeviceType DeviceTy,
+__dppl_give DPPLSyclQueueRef DPPLQueueMgr_GetQueue (DPPLSyclBEType BETy,
+                                                    DPPLSyclDeviceType DeviceTy,
                                                     size_t DNum);
 
 /*!
@@ -75,56 +77,59 @@ __dppl_give DPPLSyclQueueRef DPPLQueueMgr_GetQueue (DPPLSyclDeviceType DeviceTy,
 DPPL_API
 size_t DPPLQueueMgr_GetNumActivatedQueues ();
 
-/*!
- * @brief Get the number of GPU queues available on the system.
- *
- * @return The number of available GPU queues.
- */
-DPPL_API
-size_t DPPLQueueMgr_GetNumGPUQueues ();
 
 /*!
- * @brief Get the number of CPU queues available on the system.
+ * @brief Get the number of available queues for given backend and device type
+ * combination.
  *
- * @return The number of available CPU queues.
+ * @param    BETy           Type of Sycl backend.
+ * @param    DeviceTy       Type of Sycl device.
+ * @return   The number of available queues.
  */
 DPPL_API
-size_t DPPLQueueMgr_GetNumCPUQueues ();
+size_t DPPLQueueMgr_GetNumQueues (DPPLSyclBEType BETy,
+                                  DPPLSyclDeviceType DeviceTy);
 
 /*!
-* @brief Set the default DPPL queue to the sycl::queue for the given device.
+* @brief Set the default DPPL queue to the sycl::queue for the given backend
+* and device type combination.
 *
 * If no such device is found the a runtime_error exception is thrown.
 *
+* @param    BETy           Type of Sycl backend.
 * @param    DeviceTy       The type of Sycl device (sycl_device_type)
 * @param    DNum           Device id for the device (defaults to 0)
 */
 DPPL_API
-void DPPLQueueMgr_SetAsDefaultQueue (DPPLSyclDeviceType DeviceTy,
+void DPPLQueueMgr_SetAsDefaultQueue (DPPLSyclBEType BETy,
+                                     DPPLSyclDeviceType DeviceTy,
                                      size_t DNum);
 
 /*!
  * @brief Pushes a new sycl::queue object to the top of DPPL's thread-local
  * stack of a "activated" queues, and returns a copy of the queue to caller.
  *
- * DPPL maintains a thread-local stack of sycl::queue objects to facilitate
- * nested parallelism. The sycl::queue at the top of the stack is termed as the
- * currently activated queue, and is always the one returned by
+ * The DPPL queue manager maintains a thread-local stack of sycl::queue objects
+ * to facilitate nested parallelism. The sycl::queue at the top of the stack is
+ * termed as the currently activated queue, and is always the one returned by
  * DPPLQueueMgr_GetCurrentQueue(). DPPLPushSyclQueueToStack creates a new
  * sycl::queue corresponding to the specified device and pushes it to the top
  * of the stack. A copy of the sycl::queue is returned to the caller wrapped
  * inside the opaque DPPLSyclQueueRef pointer. A runtime_error exception is
  * thrown when a new sycl::queue could not be created for the specified device.
  *
+ * @param    BETy           Type of Sycl backend.
  * @param    DeviceTy       The type of Sycl device (sycl_device_type)
  * @param    DNum           Device id for the device (defaults to 0)
  *
  * @return A copy of the sycl::queue that was pushed to the top of DPPL's
- * stack of sycl::queue objects.
+ * stack of sycl::queue objects. Nullptr is returned if no such device exists.
  */
 DPPL_API
 __dppl_give DPPLSyclQueueRef
-DPPLQueueMgr_PushQueue (DPPLSyclDeviceType DeviceTy, size_t DNum);
+DPPLQueueMgr_PushQueue (DPPLSyclBEType BETy,
+                        DPPLSyclDeviceType DeviceTy,
+                        size_t DNum);
 
 /*!
  * @brief Pops the top of stack element from DPPL's stack of activated

backends/source/dppl_sycl_context_interface.cpp

@@ -46,3 +46,23 @@ void DPPLContext_Delete (__dppl_take DPPLSyclContextRef CtxRef)
 {
     delete unwrap(CtxRef);
 }
+
+DPPLSyclBackendType
+DPPLContext_GetBackend (__dppl_keep const DPPLSyclContextRef CtxRef)
+{
+    auto BE = unwrap(CtxRef)->get_platform().get_backend();
+
+    switch(BE)
+    {
+        case backend::host:
+            return DPPL_HOST;
+        case backend::opencl:
+            return DPPL_OPENCL;
+        case backend::level_zero:
+            return DPPL_LEVEL_ZERO;
+        case backend::cuda:
+            return DPPL_CUDA;
+        default:
+            return DPPL_UNKNOWN_BACKEND;
+    }
+}