Add timespan calculation

Author: davschneller

AbstractAPI.h

@@ -100,6 +100,7 @@ struct AbstractAPI {
   virtual bool isEventCompleted(void* eventPtr) = 0;
   virtual void recordEventOnHost(void* eventPtr) = 0;
   virtual void recordEventOnStream(void* eventPtr, void* streamPtr) = 0;
+  virtual double timespanEvents(void* eventPtrStart, void* eventPtrEnd) = 0;
 
   virtual bool isUnifiedMemoryDefault() = 0;
 

interfaces/cuda/CudaWrappedAPI.h

@@ -91,6 +91,7 @@ class ConcreteAPI : public AbstractAPI {
   bool isEventCompleted(void* eventPtr) override;
   void recordEventOnHost(void* eventPtr) override;
   void recordEventOnStream(void* eventPtr, void* streamPtr) override;
+  double timespanEvents(void* eventPtrStart, void* eventPtrEnd) override;
 
   void initialize() override;
   void finalize() override;

interfaces/cuda/Events.cu

@@ -25,6 +25,14 @@ void* ConcreteAPI::createEvent(bool withTiming) {
   return static_cast<void*>(event);
 }
 
+double ConcreteAPI::timespanEvents(void* eventPtrStart, void* eventPtrEnd) {
+  float time{};
+  cudaEvent_t start = reinterpret_cast<cudaEvent_t>(eventPtrStart);
+  cudaEvent_t end = reinterpret_cast<cudaEvent_t>(eventPtrEnd);
+  APIWRAP(cudaEventElapsedTime(&time, start, end));
+  return static_cast<double>(time) / 1000.0;
+}
+
 void ConcreteAPI::destroyEvent(void* eventPtr) {
   cudaEvent_t event = static_cast<cudaEvent_t>(eventPtr);
   APIWRAP(cudaEventDestroy(event));

interfaces/hip/Events.cpp

@@ -25,6 +25,14 @@ void* ConcreteAPI::createEvent(bool withTiming) {
   return static_cast<void*>(event);
 }
 
+double ConcreteAPI::timespanEvents(void* eventPtrStart, void* eventPtrEnd) {
+  float time{};
+  hipEvent_t start = reinterpret_cast<hipEvent_t>(eventPtrStart);
+  hipEvent_t end = reinterpret_cast<hipEvent_t>(eventPtrEnd);
+  APIWRAP(hipEventElapsedTime(&time, start, end));
+  return static_cast<double>(time) / 1000.0;
+}
+
 void ConcreteAPI::destroyEvent(void* eventPtr) {
   hipEvent_t event = static_cast<hipEvent_t>(eventPtr);
   APIWRAP(hipEventDestroy(event));

interfaces/hip/HipWrappedAPI.h

@@ -91,6 +91,7 @@ class ConcreteAPI : public AbstractAPI {
   bool isEventCompleted(void* eventPtr) override;
   void recordEventOnHost(void* eventPtr) override;
   void recordEventOnStream(void* eventPtr, void* streamPtr) override;
+  double timespanEvents(void* eventPtrStart, void* eventPtrEnd) override;
 
   void initialize() override;
   void finalize() override;

interfaces/sycl/Events.cpp

@@ -27,6 +27,22 @@ void* ConcreteAPI::createEvent(bool withTiming) {
   return new Event();
 }
 
+double ConcreteAPI::timespanEvents(void* eventPtrStart, void* eventPtrEnd) {
+  auto* start = static_cast<Event*>(eventPtrStart);
+  auto* end = static_cast<Event*>(eventPtrEnd);
+
+  if (!(start->syclEvent.has_value() && end->syclEvent.has_value())) {
+    logError() << "Invalid events given for timing calculation.";
+  }
+
+  const auto startTime = start->syclEvent.value().get_profiling_info<sycl::info::event_profiling::command_end>();
+  const auto endTime = end->syclEvent.value().get_profiling_info<sycl::info::event_profiling::command_end>();
+
+  // cf. https://oneapi-src.github.io/SYCLomatic/dev_guide/reference/diagnostic_ref/dpct1012.html
+
+  return static_cast<double>(endTime - startTime) / 1'000'000'000.0;
+}
+
 void ConcreteAPI::destroyEvent(void* eventPtr) {
   auto* event = static_cast<Event*>(eventPtr);
   delete event;
@@ -63,6 +79,10 @@ void ConcreteAPI::syncStreamWithEvent(void* streamPtr, void* eventPtr) {
   auto* queue = static_cast<sycl::queue*>(streamPtr);
   auto* event = static_cast<Event*>(eventPtr);
 
+  if (!event->syclEvent.has_value()) {
+    logError() << "Event not yet recorded; no synchronization possible.";
+  }
+
   queue->submit([&](sycl::handler& h) {
     DEVICE_SYCL_EMPTY_OPERATION_WITH_EVENT(h, event->syclEvent.value());
   });

interfaces/sycl/SyclWrappedAPI.h

@@ -125,6 +125,7 @@ class ConcreteAPI : public AbstractAPI {
   bool isEventCompleted(void* eventPtr) override;
   void recordEventOnHost(void* eventPtr) override;
   void recordEventOnStream(void* eventPtr, void* streamPtr) override;
+  double timespanEvents(void* eventPtrStart, void* eventPtrEnd) override;
 
   void initialize() override;
   void finalize() override;