[OpenCL] Implement urEventSetCallback and urContextSetExtendedDeleter.

Author: aarongreig

source/adapters/opencl/context.cpp

@@ -10,6 +10,10 @@
 
 #include "context.hpp"
 
+#include <mutex>
+#include <set>
+#include <unordered_map>
+
 ur_result_t cl_adapter::getDevicesFromContext(
     ur_context_handle_t hContext,
     std::unique_ptr<std::vector<cl_device_id>> &DevicesInCtx) {
@@ -130,8 +134,53 @@ UR_APIEXPORT ur_result_t UR_APICALL urContextCreateWithNativeHandle(
 }
 
 UR_APIEXPORT ur_result_t UR_APICALL urContextSetExtendedDeleter(
-    [[maybe_unused]] ur_context_handle_t hContext,
-    [[maybe_unused]] ur_context_extended_deleter_t pfnDeleter,
-    [[maybe_unused]] void *pUserData) {
-  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+    ur_context_handle_t hContext, ur_context_extended_deleter_t pfnDeleter,
+    void *pUserData) {
+  static std::unordered_map<ur_context_handle_t,
+                            std::set<ur_context_extended_deleter_t>>
+      ContextCallbackMap;
+  static std::mutex ContextCallbackMutex;
+
+  {
+    std::lock_guard<std::mutex> Lock(ContextCallbackMutex);
+    // Callbacks can only be registered once and we need to avoid double
+    // allocating.
+    if (ContextCallbackMap.count(hContext) &&
+        ContextCallbackMap[hContext].count(pfnDeleter)) {
+      return UR_RESULT_SUCCESS;
+    }
+
+    ContextCallbackMap[hContext].insert(pfnDeleter);
+  }
+
+  struct ContextCallback {
+    void execute() {
+      pfnDeleter(pUserData);
+      {
+        std::lock_guard<std::mutex> Lock(*CallbackMutex);
+        (*CallbackMap)[hContext].erase(pfnDeleter);
+        if ((*CallbackMap)[hContext].empty()) {
+          CallbackMap->erase(hContext);
+        }
+      }
+      delete this;
+    }
+    ur_context_handle_t hContext;
+    ur_context_extended_deleter_t pfnDeleter;
+    void *pUserData;
+    std::unordered_map<ur_context_handle_t,
+                       std::set<ur_context_extended_deleter_t>> *CallbackMap;
+    std::mutex *CallbackMutex;
+  };
+  auto Callback =
+      new ContextCallback({hContext, pfnDeleter, pUserData, &ContextCallbackMap,
+                           &ContextCallbackMutex});
+  auto ClCallback = [](cl_context, void *pUserData) {
+    auto *C = static_cast<ContextCallback *>(pUserData);
+    C->execute();
+  };
+  CL_RETURN_ON_FAILURE(clSetContextDestructorCallback(
+      cl_adapter::cast<cl_context>(hContext), ClCallback, Callback));
+
+  return UR_RESULT_SUCCESS;
 }

source/adapters/opencl/enqueue.cpp

@@ -350,9 +350,9 @@ UR_APIEXPORT ur_result_t UR_APICALL urEnqueueReadHostPipe(
     return mapCLErrorToUR(CLErr);
   }
 
-  clEnqueueReadHostPipeINTEL_fn FuncPtr = nullptr;
+  cl_ext::clEnqueueReadHostPipeINTEL_fn FuncPtr = nullptr;
   ur_result_t RetVal =
-      cl_ext::getExtFuncFromContext<clEnqueueReadHostPipeINTEL_fn>(
+      cl_ext::getExtFuncFromContext<cl_ext::clEnqueueReadHostPipeINTEL_fn>(
           CLContext, cl_ext::ExtFuncPtrCache->clEnqueueReadHostPipeINTELCache,
           cl_ext::EnqueueReadHostPipeName, &FuncPtr);
 
@@ -382,9 +382,9 @@ UR_APIEXPORT ur_result_t UR_APICALL urEnqueueWriteHostPipe(
     return mapCLErrorToUR(CLErr);
   }
 
-  clEnqueueWriteHostPipeINTEL_fn FuncPtr = nullptr;
+  cl_ext::clEnqueueWriteHostPipeINTEL_fn FuncPtr = nullptr;
   ur_result_t RetVal =
-      cl_ext::getExtFuncFromContext<clEnqueueWriteHostPipeINTEL_fn>(
+      cl_ext::getExtFuncFromContext<cl_ext::clEnqueueWriteHostPipeINTEL_fn>(
           CLContext, cl_ext::ExtFuncPtrCache->clEnqueueWriteHostPipeINTELCache,
           cl_ext::EnqueueWriteHostPipeName, &FuncPtr);
 

source/adapters/opencl/event.cpp

@@ -10,6 +10,10 @@
 
 #include "common.hpp"
 
+#include <mutex>
+#include <set>
+#include <unordered_map>
+
 cl_event_info convertUREventInfoToCL(const ur_event_info_t PropName) {
   switch (PropName) {
   case UR_EVENT_INFO_COMMAND_QUEUE:
@@ -128,9 +132,64 @@ UR_APIEXPORT ur_result_t UR_APICALL urEventGetProfilingInfo(
 UR_APIEXPORT ur_result_t UR_APICALL
 urEventSetCallback(ur_event_handle_t hEvent, ur_execution_info_t execStatus,
                    ur_event_callback_t pfnNotify, void *pUserData) {
-  std::ignore = hEvent;
-  std::ignore = execStatus;
-  std::ignore = pfnNotify;
-  std::ignore = pUserData;
-  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+  static std::unordered_map<ur_event_handle_t, std::set<ur_event_callback_t>>
+      EventCallbackMap;
+  static std::mutex EventCallbackMutex;
+
+  {
+    std::lock_guard<std::mutex> Lock(EventCallbackMutex);
+    // Callbacks can only be registered once and we need to avoid double
+    // allocating.
+    if (EventCallbackMap.count(hEvent) &&
+        EventCallbackMap[hEvent].count(pfnNotify)) {
+      return UR_RESULT_SUCCESS;
+    }
+
+    EventCallbackMap[hEvent].insert(pfnNotify);
+  }
+
+  cl_int CallbackType = 0;
+  switch (execStatus) {
+  case UR_EXECUTION_INFO_EXECUTION_INFO_SUBMITTED:
+    CallbackType = CL_SUBMITTED;
+    break;
+  case UR_EXECUTION_INFO_EXECUTION_INFO_RUNNING:
+    CallbackType = CL_RUNNING;
+    break;
+  case UR_EXECUTION_INFO_EXECUTION_INFO_COMPLETE:
+    CallbackType = CL_COMPLETE;
+    break;
+  default:
+    return UR_RESULT_ERROR_INVALID_ENUMERATION;
+  }
+
+  struct EventCallback {
+    void execute() {
+      pfnNotify(hEvent, execStatus, pUserData);
+      {
+        std::lock_guard<std::mutex> Lock(*CallbackMutex);
+        (*CallbackMap)[hEvent].erase(pfnNotify);
+        if ((*CallbackMap)[hEvent].empty()) {
+          CallbackMap->erase(hEvent);
+        }
+      }
+      delete this;
+    }
+    ur_event_handle_t hEvent;
+    ur_execution_info_t execStatus;
+    ur_event_callback_t pfnNotify;
+    void *pUserData;
+    std::unordered_map<ur_event_handle_t, std::set<ur_event_callback_t>>
+        *CallbackMap;
+    std::mutex *CallbackMutex;
+  };
+  auto Callback = new EventCallback({hEvent, execStatus, pfnNotify, pUserData,
+                                     &EventCallbackMap, &EventCallbackMutex});
+  auto ClCallback = [](cl_event, cl_int, void *pUserData) {
+    auto *C = static_cast<EventCallback *>(pUserData);
+    C->execute();
+  };
+  CL_RETURN_ON_FAILURE(clSetEventCallback(cl_adapter::cast<cl_event>(hEvent),
+                                          CallbackType, ClCallback, Callback));
+  return UR_RESULT_SUCCESS;
 }