Demonstrate how the new error handler is supposed to be used.

Author: Diptorup Deb

dpctl-capi/include/dpctl_sycl_device_interface.h

@@ -31,12 +31,18 @@
 #include "Support/ExternC.h"
 #include "Support/MemOwnershipAttrs.h"
 #include "dpctl_data_types.h"
+#include "dpctl_exec_state.h"
 #include "dpctl_sycl_device_manager.h"
 #include "dpctl_sycl_enum_types.h"
 #include "dpctl_sycl_types.h"
 
 DPCTL_C_EXTERN_C_BEGIN
 
+#define DEPRACATION_NOTICE                                                     \
+    "The function is deprecated to change the naming convention and "          \
+    "support the new DpctlExecState argument to improve error "                \
+    "handling and reporting."
+
 /**
  * @defgroup DeviceInterface Device class C wrapper
  */
@@ -49,20 +55,33 @@ DPCTL_C_EXTERN_C_BEGIN
  * DPCTLSyclDeviceRef object.
  * @ingroup DeviceInterface
  */
+DPCTL_API __dpctl_give DPCTLSyclDeviceRef
+DPCTLDevice_Copy(__dpctl_keep const DPCTLSyclDeviceRef DRef)
+    __attribute__((deprecated(DEPRACATION_NOTICE, "dpctl_device_copy")));
+
+/*!
+ * @brief Returns a copy of the DPCTLSyclDeviceRef object.
+ *
+ * @param    ES             The execution state object used for error handling.
+ * @param    DRef           DPCTLSyclDeviceRef object to be copied.
+ * @return   A new DPCTLSyclDeviceRef created by copying the passed in
+ * DPCTLSyclDeviceRef object.
+ * @ingroup DeviceInterface
+ */
 DPCTL_API
 __dpctl_give DPCTLSyclDeviceRef
-DPCTLDevice_Copy(__dpctl_keep const DPCTLSyclDeviceRef DRef);
+dpctl_device_copy(__dpctl_keep const DPCTLSyclDeviceRef DRef,
+                  __dpctl_keep const DpctlExecState ES);
 
 /*!
- * @brief Returns a new DPCTLSyclDeviceRef opaque object wrapping a SYCL device
- * instance as a host device.
+ * @brief Returns a new DPCTLSyclDeviceRef opaque object wrapping a SYCL
+ * device instance as a host device.
  *
- * @return   An opaque pointer to a ``sycl::device`` created as an instance of
- * the host device.
+ * @return   An opaque pointer to a ``sycl::device`` created as an instance
+ * of the host device.
  * @ingroup DeviceInterface
  */
-DPCTL_API
-__dpctl_give DPCTLSyclDeviceRef DPCTLDevice_Create(void);
+DPCTL_API __dpctl_give DPCTLSyclDeviceRef DPCTLDevice_Create(void);
 
 /*!
  * @brief Returns a new DPCTLSyclDeviceRef opaque object created using the

dpctl-capi/source/dpctl_sycl_device_interface.cpp

@@ -25,6 +25,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "dpctl_sycl_device_interface.h"
+#include "../helper/include/dpctl_error_handlers.h"
 #include "../helper/include/dpctl_string_utils.hpp"
 #include "../helper/include/dpctl_utils_helper.h"
 #include "Support/CBindingWrapping.h"
@@ -44,23 +45,33 @@ DEFINE_SIMPLE_CONVERSION_FUNCTIONS(device_selector, DPCTLSyclDeviceSelectorRef)
 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(platform, DPCTLSyclPlatformRef)
 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(std::vector<DPCTLSyclDeviceRef>,
                                    DPCTLDeviceVectorRef)
-
 } /* end of anonymous namespace */
 
 __dpctl_give DPCTLSyclDeviceRef
 DPCTLDevice_Copy(__dpctl_keep const DPCTLSyclDeviceRef DRef)
 {
+    return dpctl_device_copy(DRef, nullptr);
+}
+
+__dpctl_give DPCTLSyclDeviceRef
+dpctl_device_copy(__dpctl_keep const DPCTLSyclDeviceRef DRef,
+                  __dpctl_keep const DpctlExecState ES)
+{
+    auto handler = ES ? dpctl_exec_state_get_error_handler(ES)
+                      : &DefaultErrorHandler::handler;
+
     auto Device = unwrap(DRef);
+
     if (!Device) {
-        std::cerr << "Cannot copy DPCTLSyclDeviceRef as input is a nullptr\n";
+        handler(-1, "Cannot copy DPCTLSyclDeviceRef as input is a nullptr.",
+                __FILE__, __func__, __LINE__);
         return nullptr;
     }
     try {
         auto CopiedDevice = new device(*Device);
         return wrap(CopiedDevice);
     } catch (std::bad_alloc const &ba) {
-        // \todo log error
-        std::cerr << ba.what() << '\n';
+        handler(-1, ba.what(), __FILE__, __func__, __LINE__);
         return nullptr;
     }
 }