[SYCL] Implement more verbose error handling. (#4013)

This ensures that no exception is silently ignored by sycl. This
also includes API names and error codes in the error messages.

Signed-off-by: rehana begam <[email protected]>

Author: rbegam

sycl/source/detail/global_handler.cpp

@@ -90,7 +90,7 @@ void shutdown() {
       // some parameters in the plugin tear-down process.
       // Currently, it is not used.
       void *PluginParameter = nullptr;
-      Plugin.call_nocheck<PiApiKind::piTearDown>(PluginParameter);
+      Plugin.call<PiApiKind::piTearDown>(PluginParameter);
       Plugin.unload();
     }
     GlobalHandler::instance().MPlugins.Inst.reset(nullptr);

sycl/source/detail/memory_manager.cpp

@@ -230,6 +230,11 @@ void *MemoryManager::allocateMemSubBuffer(ContextImplPtr TargetContext,
         "Specified offset of the sub-buffer being constructed is not a "
         "multiple of the memory base address alignment",
         PI_INVALID_VALUE);
+
+  if (Error != PI_SUCCESS) {
+    Plugin.reportPiError(Error, "allocateMemSubBuffer()");
+  }
+
   return NewMem;
 }
 

sycl/source/detail/pi.cpp

@@ -141,8 +141,8 @@ void contextSetExtendedDeleter(const cl::sycl::context &context,
   auto impl = getSyclObjImpl(context);
   auto contextHandle = reinterpret_cast<pi_context>(impl->getHandleRef());
   auto plugin = impl->getPlugin();
-  plugin.call_nocheck<PiApiKind::piextContextSetExtendedDeleter>(
-      contextHandle, func, user_data);
+  plugin.call<PiApiKind::piextContextSetExtendedDeleter>(contextHandle, func,
+                                                         user_data);
 }
 
 std::string platformInfoToString(pi_platform_info info) {

sycl/source/detail/plugin.hpp

@@ -56,6 +56,15 @@ class plugin {
     __SYCL_CHECK_OCL_CODE_THROW(pi_result, Exception);
   }
 
+  void reportPiError(RT::PiResult pi_result, const char *context) const {
+    if (pi_result != PI_SUCCESS) {
+      throw cl::sycl::runtime_error(
+          std::string(context) + " API failed with error: " +
+              cl::sycl::detail::codeToString(pi_result),
+          pi_result);
+    }
+  }
+
   /// Calls the PiApi, traces the call, and returns the result.
   ///
   /// Usage:
@@ -66,6 +75,7 @@ class plugin {
   /// \endcode
   ///
   /// \sa plugin::checkPiResult
+
   template <PiApiKind PiApiOffset, typename... ArgsT>
   RT::PiResult call_nocheck(ArgsT... Args) const {
     RT::PiFuncInfo<PiApiOffset> PiCallInfo;

sycl/source/detail/program_impl.cpp

@@ -360,6 +360,10 @@ void program_impl::create_cl_program_with_source(const std::string &Source) {
         "program::compile_with_source is not supported by the selected backend",
         PI_INVALID_OPERATION);
   }
+
+  if (Err != PI_SUCCESS) {
+    Plugin.reportPiError(Err, "create_cl_program_with_source()");
+  }
 }
 
 void program_impl::compile(const std::string &Options) {

sycl/source/detail/program_manager/program_manager.cpp

@@ -1502,10 +1502,11 @@ ProgramManager::link(const std::vector<device_image_plain> &DeviceImages,
       /*user_data=*/nullptr, &LinkedProg);
 
   if (Error != PI_SUCCESS) {
-    const std::string ErrorMsg =
-        LinkedProg ? getProgramBuildLog(LinkedProg, ContextImpl)
-                   : "Online link operation failed";
-    throw sycl::exception(make_error_code(errc::build), ErrorMsg);
+    if (LinkedProg) {
+      const string_class ErrorMsg = getProgramBuildLog(LinkedProg, ContextImpl);
+      throw sycl::exception(make_error_code(errc::build), ErrorMsg);
+    }
+    Plugin.reportPiError(Error, "link()");
   }
 
   std::vector<kernel_id> KernelIDs;

sycl/source/detail/queue_impl.hpp

@@ -263,7 +263,7 @@ class queue_impl {
 
     // If creating out-of-order queue failed and this property is not
     // supported (for example, on FPGA), it will return
-    // CL_INVALID_QUEUE_PROPERTIES and will try to create in-order queue.
+    // PI_INVALID_QUEUE_PROPERTIES and will try to create in-order queue.
     if (MSupportOOO && Error == PI_INVALID_QUEUE_PROPERTIES) {
       MSupportOOO = false;
       Queue = createQueue(QueueOrder::Ordered);

sycl/source/detail/usm/usm_impl.cpp

@@ -351,7 +351,7 @@ alloc get_pointer_type(const void *Ptr, const context &Ctxt) {
     return alloc::unknown;
   // otherwise PI_SUCCESS is expected
   if (Err != PI_SUCCESS) {
-    throw runtime_error("Error querying USM pointer: ", Err);
+    Plugin.reportPiError(Err, "get_pointer_type()");
   }
 
   alloc ResultAlloc;