[SYCL] Fix USM event clearing when calling queue::wait()

Clear the USM events from the queue upon calls to wait() so that they
are not waited for multiple times.

Signed-off-by: Sergey Semenov <[email protected]>

Author: sergey-semenov

sycl/source/detail/queue_impl.cpp

@@ -188,7 +188,9 @@ void queue_impl::wait(const detail::code_location &CodeLoc) {
   for (event &Event : MUSMEvents) {
     Event.wait();
   }
+
   MEvents.clear();
+  MUSMEvents.clear();
 
 #ifdef XPTI_ENABLE_INSTRUMENTATION
   instrumentationEpilog(TelemetryEvent, Name, StreamID, IId);

sycl/unittests/CMakeLists.txt

@@ -57,5 +57,6 @@ endfunction()
 add_subdirectory(misc)
 add_subdirectory(pi)
 add_subdirectory(program)
+add_subdirectory(queue)
 add_subdirectory(scheduler)
 add_subdirectory(thread_safety)

sycl/unittests/queue/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_sycl_unittest(QueueTests OBJECT
+  wait.cpp
+)

sycl/unittests/queue/wait.cpp

@@ -0,0 +1,77 @@
+#include <CL/sycl.hpp>
+#include <detail/context_impl.hpp>
+#include <gtest/gtest.h>
+#include <helpers/PiMock.hpp>
+
+using namespace cl::sycl;
+
+struct TestCtx {
+  TestCtx(context &Ctx) : Ctx{Ctx} {};
+
+  context &Ctx;
+  int NEventsWaitedFor = 0;
+};
+
+std::unique_ptr<TestCtx> TestContext;
+
+pi_result redefinedUSMEnqueueMemset(pi_queue queue, void *ptr, pi_int32 value,
+                                    size_t count,
+                                    pi_uint32 num_events_in_waitlist,
+                                    const pi_event *events_waitlist,
+                                    pi_event *event) {
+  // Provide a dummy non-nullptr value
+  *event = reinterpret_cast<pi_event>(1);
+  return PI_SUCCESS;
+}
+
+pi_result redefinedEventsWait(pi_uint32 num_events,
+                              const pi_event *event_list) {
+  ++TestContext->NEventsWaitedFor;
+  return PI_SUCCESS;
+}
+
+pi_result redefinedEventGetInfo(pi_event event, pi_event_info param_name,
+                                size_t param_value_size, void *param_value,
+                                size_t *param_value_size_ret) {
+  EXPECT_EQ(param_name, PI_EVENT_INFO_CONTEXT)
+      << "Unexpected event info requested";
+  auto *Result = reinterpret_cast<RT::PiContext *>(param_value);
+  RT::PiContext PiCtx =
+      detail::getSyclObjImpl(TestContext->Ctx)->getHandleRef();
+  *Result = PiCtx;
+  return PI_SUCCESS;
+}
+
+pi_result redefinedEventRetain(pi_event event) { return PI_SUCCESS; }
+
+pi_result redefinedEventRelease(pi_event event) { return PI_SUCCESS; }
+
+// Check that the USM events are cleared from the queue upon call to wait(),
+// so that they are not waited for multiple times.
+TEST(QueueWaitTest, USMEventClear) {
+  platform Plt{default_selector()};
+  if (Plt.is_host()) {
+    std::cout << "Not run on host - no PI events created in that case"
+              << std::endl;
+    return;
+  }
+
+  unittest::PiMock Mock{Plt};
+  Mock.redefine<detail::PiApiKind::piextUSMEnqueueMemset>(
+      redefinedUSMEnqueueMemset);
+  Mock.redefine<detail::PiApiKind::piEventsWait>(redefinedEventsWait);
+  Mock.redefine<detail::PiApiKind::piEventGetInfo>(redefinedEventGetInfo);
+  Mock.redefine<detail::PiApiKind::piEventRetain>(redefinedEventRetain);
+  Mock.redefine<detail::PiApiKind::piEventRelease>(redefinedEventRelease);
+
+  context Ctx{Plt};
+  TestContext.reset(new TestCtx(Ctx));
+  queue Q{Ctx, default_selector()};
+
+  unsigned char *HostAlloc = (unsigned char *)malloc_host(1, Ctx);
+  Q.memset(HostAlloc, 42, 1);
+  Q.wait();
+  ASSERT_EQ(TestContext->NEventsWaitedFor, 1);
+  Q.wait();
+  ASSERT_EQ(TestContext->NEventsWaitedFor, 1);
+}