src/xbt/exception.cpp

   1 /* Copyright (c) 2005-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <cstdlib>
   7
   8 #include <atomic>
   9 #include <exception>
  10 #include <string>
  11 #include <typeinfo>
  12 #include <vector>
  13 #include <memory>
  14 #include <mutex>
  15
  16 #include <xbt/backtrace.hpp>
  17 #include <xbt/config.hpp>
  18 #include <xbt/ex.hpp>
  19 #include <xbt/exception.hpp>
  20 #include <xbt/log.h>
  21 #include <xbt/log.hpp>
  22
  23 XBT_LOG_EXTERNAL_CATEGORY(xbt);
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_exception, xbt, "Exceptions");
  25
  26 namespace simgrid {
  27 namespace xbt {
  28
  29 WithContextException::~WithContextException() = default;
  30
  31 void log_exception(e_xbt_log_priority_t prio, const char* context, std::exception const& exception)
  32 {
  33   try {
  34     auto name = simgrid::xbt::demangle(typeid(exception).name());
  35
  36     auto* with_context = dynamic_cast<const simgrid::xbt::WithContextException*>(&exception);
  37     if (with_context != nullptr)
  38       XBT_LOG(prio, "%s %s by %s/%d: %s",
  39         context, name.get(),
  40         with_context->processName().c_str(), with_context->pid(),
  41         exception.what());
  42     else
  43       XBT_LOG(prio, "%s %s: %s", context, name.get(), exception.what());
  44
  45     // Do we have a backtrace?
  46     if (with_context != nullptr && not simgrid::config::get_value<bool>("exception/cutpath")) {
  47       auto backtrace = simgrid::xbt::resolveBacktrace(
  48         with_context->backtrace().data(), with_context->backtrace().size());
  49       for (std::string const& s : backtrace)
  50         XBT_LOG(prio, "  -> %s", s.c_str());
  51     }
  52
  53     // Do we have a nested exception?
  54     auto* with_nested = dynamic_cast<const std::nested_exception*>(&exception);
  55     if (with_nested == nullptr ||  with_nested->nested_ptr() == nullptr)
  56       return;
  57     try {
  58       with_nested->rethrow_nested();
  59     }
  60     catch (std::exception& nested_exception) {
  61       log_exception(prio, "Caused by", nested_exception);
  62     }
  63     // We could catch nested_exception or WithContextException but we don't bother:
  64     catch (...) {
  65       XBT_LOG(prio, "Caused by an unknown exception");
  66     }
  67   }
  68   catch (...) {
  69     // Don't log exceptions we got when trying to log exception
  70   }
  71 }
  72
  73 static void showBacktrace(std::vector<xbt_backtrace_location_t>& bt)
  74 {
  75   if (simgrid::config::get_value<bool>("exception/cutpath")) {
  76     XBT_LOG(xbt_log_priority_critical, "Display of current backtrace disabled by --cfg=exception/cutpath.");
  77     return;
  78   }
  79   std::vector<std::string> res = resolveBacktrace(&bt[0], bt.size());
  80   XBT_LOG(xbt_log_priority_critical, "Current backtrace:");
  81   for (std::string const& s : res)
  82     XBT_LOG(xbt_log_priority_critical, "  -> %s", s.c_str());
  83 }
  84
  85 static std::terminate_handler previous_terminate_handler = nullptr;
  86
  87 static void handler()
  88 {
  89   // Avoid doing crazy things if we get an uncaught exception inside
  90   // an uncaught exception
  91   static std::atomic_flag lock = ATOMIC_FLAG_INIT;
  92   if (lock.test_and_set()) {
  93     XBT_ERROR("Handling an exception raised an exception. Bailing out.");
  94     std::abort();
  95   }
  96
  97   // Get the current backtrace and exception
  98   auto e = std::current_exception();
  99   auto bt = backtrace();
 100   try {
 101     std::rethrow_exception(e);
 102   }
 103
 104   // We manage C++ exception ourselves
 105   catch (std::exception& e) {
 106     log_exception(xbt_log_priority_critical, "Uncaught exception", e);
 107     showBacktrace(bt);
 108     std::abort();
 109   }
 110
 111   // We don't know how to manage other exceptions
 112   catch (...) {
 113     // If there was another handler let's delegate to it
 114     if (previous_terminate_handler)
 115       previous_terminate_handler();
 116     else {
 117       XBT_ERROR("Unknown uncaught exception");
 118       showBacktrace(bt);
 119       std::abort();
 120     }
 121   }
 122
 123 }
 124
 125 void install_exception_handler()
 126 {
 127   static std::once_flag handler_flag;
 128   std::call_once(handler_flag, [] {
 129     previous_terminate_handler = std::set_terminate(handler);
 130   });
 131 }
 132 // deprecated
 133 void logException(e_xbt_log_priority_t priority, const char* context, std::exception const& exception)
 134 {
 135   log_exception(priority, context, exception);
 136 }
 137 void installExceptionHandler()
 138 {
 139   install_exception_handler();
 140 }
 141
 142 } // namespace xbt
 143 }