Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Reduce scope for variable (and shadow it by later declarations).
[simgrid.git] / src / xbt / exception.cpp
index 230e330..bccfd6d 100644 (file)
-/* Copyright (c) 2005-2016. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2005-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include <cstdlib>
+#include "simgrid/Exception.hpp"
+#include "src/kernel/context/Context.hpp"
+#include <xbt/config.hpp>
+#include <xbt/log.hpp>
 
-#include <atomic>
-#include <exception>
-#include <string>
-#include <typeinfo>
-#include <vector>
-#include <memory>
 #include <mutex>
+#include <sstream>
 
-#include <xbt/backtrace.hpp>
-#include <xbt/exception.hpp>
-#include <xbt/log.h>
-#include <xbt/log.hpp>
-
-extern "C" {
 XBT_LOG_EXTERNAL_CATEGORY(xbt);
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_exception, xbt, "Exceptions");
+
+void _xbt_throw(char* message, int value, const char* file, int line, const char* func)
+{
+  simgrid::Exception e(
+      simgrid::xbt::ThrowPoint(file, line, func, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid()),
+      message ? message : "");
+  xbt_free(message);
+  e.value    = value;
+  throw e;
 }
 
 namespace simgrid {
 namespace xbt {
 
-WithContextException::~WithContextException() {}
+ImpossibleError::~ImpossibleError()         = default;
+InitializationError::~InitializationError() = default;
+UnimplementedError::~UnimplementedError()   = default;
 
-void logException(
-  e_xbt_log_priority_t prio,
-  const char* context, std::exception const& exception)
+void log_exception(e_xbt_log_priority_t prio, const char* context, std::exception const& exception)
 {
   try {
     auto name = simgrid::xbt::demangle(typeid(exception).name());
 
-    auto with_context =
-      dynamic_cast<const simgrid::xbt::WithContextException*>(&exception);
-    if (with_context != nullptr)
-      XBT_LOG(prio, "%s %s by %s/%d: %s",
-        context, name.get(),
-        with_context->processName().c_str(), with_context->pid(),
-        exception.what());
-    else
-      XBT_LOG(prio, "%s %s: %s", context, name.get(), exception.what());
-
-    // Do we have a backtrace?
+    auto* with_context = dynamic_cast<const simgrid::Exception*>(&exception);
     if (with_context != nullptr) {
-      auto backtrace = simgrid::xbt::resolveBacktrace(
-        with_context->backtrace().data(), with_context->backtrace().size());
-      for (std::string const& s : backtrace)
-        XBT_LOG(prio, "  -> %s", s.c_str());
+      XBT_LOG(prio, "%s %s by %s/%d: %s", context, name.get(), with_context->throw_point().procname_.c_str(),
+              with_context->throw_point().pid_, exception.what());
+      // Do we have a backtrace?
+      if (not simgrid::config::get_value<bool>("exception/cutpath")) {
+        auto backtrace = with_context->resolve_backtrace();
+        XBT_LOG(prio, "  -> %s", backtrace.c_str());
+      }
+    } else {
+      XBT_LOG(prio, "%s %s: %s", context, name.get(), exception.what());
     }
+  } catch (...) {
+    // Don't log exceptions we got when trying to log exception
+    XBT_LOG(prio, "Ignoring exception caught while while trying to log an exception!");
+  }
 
+  try {
     // Do we have a nested exception?
-    auto with_nested = dynamic_cast<const std::nested_exception*>(&exception);
-    if (with_nested == nullptr ||  with_nested->nested_ptr() == nullptr)
-      return;
-    try {
+    auto* with_nested = dynamic_cast<const std::nested_exception*>(&exception);
+    if (with_nested != nullptr && with_nested->nested_ptr() != nullptr)
       with_nested->rethrow_nested();
-    }
-    catch (std::exception& nested_exception) {
-      logException(prio, "Caused by", nested_exception);
-    }
+  } catch (const std::exception& nested_exception) {
+    log_exception(prio, "Caused by", nested_exception);
+  } catch (...) {
     // We could catch nested_exception or WithContextException but we don't bother:
-    catch (...) {
-      XBT_LOG(prio, "Caused by an unknown exception");
-    }
-  }
-  catch (...) {
-    // Don't log exceptions we got when trying to log exception
+    XBT_LOG(prio, "Caused by an unknown exception");
   }
 }
 
-static void showBacktrace(std::vector<xbt_backtrace_location_t>& bt)
+static void show_backtrace(const simgrid::xbt::Backtrace& bt)
 {
-  std::vector<std::string> res = resolveBacktrace(&bt[0], bt.size());
-  XBT_LOG(xbt_log_priority_critical, "Current backtrace:");
-  for (std::string const& s : res)
-    XBT_LOG(xbt_log_priority_critical, "  -> %s", s.c_str());
+  if (simgrid::config::get_value<bool>("exception/cutpath")) {
+    XBT_CRITICAL("Display of current backtrace disabled by --cfg=exception/cutpath.");
+    return;
+  }
+  std::string res = bt.resolve();
+  XBT_CRITICAL("Current backtrace:");
+  XBT_CRITICAL("  -> %s", res.c_str());
 }
 
 static std::terminate_handler previous_terminate_handler = nullptr;
 
 static void handler()
 {
-  // Avoid doing crazy things if we get an uncaught exception inside
-  // an uncaught exception
+  // Avoid doing crazy things if we get an uncaught exception inside an uncaught exception
   static std::atomic_flag lock = ATOMIC_FLAG_INIT;
   if (lock.test_and_set()) {
-    XBT_ERROR("Multiple uncaught exceptions");
+    XBT_ERROR("Handling an exception raised an exception. Bailing out.");
     std::abort();
   }
 
   // Get the current backtrace and exception
-  auto e = std::current_exception();
-  auto bt = backtrace();
+  simgrid::xbt::Backtrace bt = simgrid::xbt::Backtrace();
   try {
-    std::rethrow_exception(e);
+    std::rethrow_exception(std::current_exception());
+  }
+
+  // Parse error are handled differently, as the call stack does not matter, only the file location
+  catch (const simgrid::ParseError& e) {
+    XBT_ERROR("%s", e.what());
+    XBT_ERROR("Exiting now.");
+    std::abort();
   }
 
   // We manage C++ exception ourselves
-  catch (std::exception& e) {
-    logException(xbt_log_priority_critical, "Uncaught exception", e);
-    showBacktrace(bt);
+  catch (const std::exception& e) {
+    log_exception(xbt_log_priority_critical, "Uncaught exception", e);
+    show_backtrace(bt);
     std::abort();
   }
 
+  catch (const simgrid::ForcefulKillException&) {
+    XBT_ERROR("Received a ForcefulKillException at the top-level exception handler. Maybe a Java->C++ call that is not "
+              "protected in a try/catch?");
+    show_backtrace(bt);
+  }
+
   // We don't know how to manage other exceptions
   catch (...) {
     // If there was another handler let's delegate to it
@@ -115,14 +121,14 @@ static void handler()
       previous_terminate_handler();
     else {
       XBT_ERROR("Unknown uncaught exception");
-      showBacktrace(bt);
+      show_backtrace(bt);
       std::abort();
     }
   }
-
+  XBT_INFO("BAM");
 }
 
-void installExceptionHandler()
+void install_exception_handler()
 {
   static std::once_flag handler_flag;
   std::call_once(handler_flag, [] {
@@ -130,10 +136,19 @@ void installExceptionHandler()
   });
 }
 
-}
-}
+} // namespace xbt
+} // namespace simgrid
 
-void xbt_set_terminate()
+void xbt_throw_impossible(const char* file, int line, const char* func)
+{
+  std::stringstream ss;
+  ss << file << ":" << line << ":" << func
+     << ": The Impossible Did Happen (yet again). Please report this bug (after reading https://xkcd.com/2200 :)";
+  throw simgrid::xbt::ImpossibleError(ss.str());
+}
+void xbt_throw_unimplemented(const char* file, int line, const char* func)
 {
-  simgrid::xbt::installExceptionHandler();
+  std::stringstream ss;
+  ss << file << ":" << line << ":" << func << ": Feature unimplemented yet. Please report this bug.";
+  throw simgrid::xbt::UnimplementedError(ss.str());
 }