[SYCL] Improve sycl::event::get_profiling_info exception message if default constructed (#6476)

The default constructed sycl::event would emit a misleading message when querying profiling information. The message would assume a queue is attached to such sycl::event, even if it's not the case. Added a condition to handle such case, and emit a more proper message, and updated appropriate unit test.

Author: raaiq1

sycl/source/detail/event_impl.cpp

@@ -281,10 +281,18 @@ void event_impl::cleanupCommand(
 }
 
 void event_impl::checkProfilingPreconditions() const {
-  if (!MIsProfilingEnabled) {
+  std::weak_ptr<queue_impl> EmptyPtr;
+
+  if (!EmptyPtr.owner_before(MQueue) && !MQueue.owner_before(EmptyPtr)) {
     throw sycl::exception(make_error_code(sycl::errc::invalid),
-                          "get_profiling_info() can't be used without set "
-                          "'enable_profiling' queue property");
+                          "Profiling information is unavailable as the event "
+                          "has no associated queue.");
+  }
+  if (!MIsProfilingEnabled) {
+    throw sycl::exception(
+        make_error_code(sycl::errc::invalid),
+        "Profiling information is unavailable as the queue associated with "
+        "the event does not have the 'enable_profiling' property.");
   }
 }
 

sycl/unittests/queue/GetProfilingInfo.cpp

@@ -163,8 +163,10 @@ TEST(GetProfilingInfo, command_exception_check) {
       (void)submit_time;
       FAIL();
     } catch (sycl::exception &e) {
-      EXPECT_STREQ(e.what(), "get_profiling_info() can't be used without set "
-                             "'enable_profiling' queue property");
+      EXPECT_STREQ(
+          e.what(),
+          "Profiling information is unavailable as the queue associated with "
+          "the event does not have the 'enable_profiling' property.");
     }
   }
   {
@@ -180,8 +182,10 @@ TEST(GetProfilingInfo, command_exception_check) {
       FAIL();
     } catch (sycl::exception const &e) {
       std::cerr << e.what() << std::endl;
-      EXPECT_STREQ(e.what(), "get_profiling_info() can't be used without set "
-                             "'enable_profiling' queue property");
+      EXPECT_STREQ(
+          e.what(),
+          "Profiling information is unavailable as the queue associated with "
+          "the event does not have the 'enable_profiling' property.");
     }
   }
   {
@@ -195,12 +199,45 @@ TEST(GetProfilingInfo, command_exception_check) {
       (void)end_time;
       FAIL();
     } catch (sycl::exception const &e) {
-      EXPECT_STREQ(e.what(), "get_profiling_info() can't be used without set "
-                             "'enable_profiling' queue property");
+      EXPECT_STREQ(
+          e.what(),
+          "Profiling information is unavailable as the queue associated with "
+          "the event does not have the 'enable_profiling' property.");
     }
   }
 }
 
+TEST(GetProfilingInfo, exception_check_no_queue) {
+  sycl::event E;
+  try {
+    auto info =
+        E.get_profiling_info<sycl::info::event_profiling::command_submit>();
+    (void)info;
+    FAIL();
+  } catch (sycl::exception const &e) {
+    EXPECT_STREQ(e.what(), "Profiling information is unavailable as the event "
+                           "has no associated queue.");
+  }
+  try {
+    auto info =
+        E.get_profiling_info<sycl::info::event_profiling::command_start>();
+    (void)info;
+    FAIL();
+  } catch (sycl::exception const &e) {
+    EXPECT_STREQ(e.what(), "Profiling information is unavailable as the event "
+                           "has no associated queue.");
+  }
+  try {
+    auto info =
+        E.get_profiling_info<sycl::info::event_profiling::command_end>();
+    (void)info;
+    FAIL();
+  } catch (sycl::exception const &e) {
+    EXPECT_STREQ(e.what(), "Profiling information is unavailable as the event "
+                           "has no associated queue.");
+  }
+}
+
 TEST(GetProfilingInfo, check_if_now_dead_queue_property_set) {
   sycl::platform Plt{sycl::default_selector{}};
   if (Plt.is_host()) {
@@ -302,8 +339,10 @@ TEST(GetProfilingInfo, check_if_now_dead_queue_property_not_set) {
       (void)submit_time;
       FAIL();
     } catch (sycl::exception &e) {
-      EXPECT_STREQ(e.what(), "get_profiling_info() can't be used without set "
-                             "'enable_profiling' queue property");
+      EXPECT_STREQ(
+          e.what(),
+          "Profiling information is unavailable as the queue associated with "
+          "the event does not have the 'enable_profiling' property.");
     }
   }
   {
@@ -314,8 +353,10 @@ TEST(GetProfilingInfo, check_if_now_dead_queue_property_not_set) {
       (void)start_time;
       FAIL();
     } catch (sycl::exception &e) {
-      EXPECT_STREQ(e.what(), "get_profiling_info() can't be used without set "
-                             "'enable_profiling' queue property");
+      EXPECT_STREQ(
+          e.what(),
+          "Profiling information is unavailable as the queue associated with "
+          "the event does not have the 'enable_profiling' property.");
     }
   }
   {
@@ -325,8 +366,10 @@ TEST(GetProfilingInfo, check_if_now_dead_queue_property_not_set) {
       (void)end_time;
       FAIL();
     } catch (sycl::exception &e) {
-      EXPECT_STREQ(e.what(), "get_profiling_info() can't be used without set "
-                             "'enable_profiling' queue property");
+      EXPECT_STREQ(
+          e.what(),
+          "Profiling information is unavailable as the queue associated with "
+          "the event does not have the 'enable_profiling' property.");
     }
   }
   // The test passes without this, but keep it still, just in case.