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", context, name.get(), with_context->process_name().c_str(),
  39               with_context->pid(), exception.what());
  40     else
  41       XBT_LOG(prio, "%s %s: %s", context, name.get(), exception.what());
  42
  43     // Do we have a backtrace?
  44     if (with_context != nullptr && not simgrid::config::get_value<bool>("exception/cutpath")) {
  45       auto backtrace =
  46           simgrid::xbt::resolve_backtrace(with_context->backtrace().data(), with_context->backtrace().size());
  47       for (std::string const& s : backtrace)
  48         XBT_LOG(prio, "  -> %s", s.c_str());
  49     }
  50
  51     // Do we have a nested exception?
  52     auto* with_nested = dynamic_cast<const std::nested_exception*>(&exception);
  53     if (with_nested == nullptr ||  with_nested->nested_ptr() == nullptr)
  54       return;
  55     try {
  56       with_nested->rethrow_nested();
  57     }
  58     catch (std::exception& nested_exception) {
  59       log_exception(prio, "Caused by", nested_exception);
  60     }
  61     // We could catch nested_exception or WithContextException but we don't bother:
  62     catch (...) {
  63       XBT_LOG(prio, "Caused by an unknown exception");
  64     }
  65   }
  66   catch (...) {
  67     // Don't log exceptions we got when trying to log exception
  68   }
  69 }
  70
  71 static void showBacktrace(std::vector<xbt_backtrace_location_t>& bt)
  72 {
  73   if (simgrid::config::get_value<bool>("exception/cutpath")) {
  74     XBT_LOG(xbt_log_priority_critical, "Display of current backtrace disabled by --cfg=exception/cutpath.");
  75     return;
  76   }
  77   std::vector<std::string> res = resolve_backtrace(&bt[0], bt.size());
  78   XBT_LOG(xbt_log_priority_critical, "Current backtrace:");
  79   for (std::string const& s : res)
  80     XBT_LOG(xbt_log_priority_critical, "  -> %s", s.c_str());
  81 }
  82
  83 static std::terminate_handler previous_terminate_handler = nullptr;
  84
  85 static void handler()
  86 {
  87   // Avoid doing crazy things if we get an uncaught exception inside
  88   // an uncaught exception
  89   static std::atomic_flag lock = ATOMIC_FLAG_INIT;
  90   if (lock.test_and_set()) {
  91     XBT_ERROR("Handling an exception raised an exception. Bailing out.");
  92     std::abort();
  93   }
  94
  95   // Get the current backtrace and exception
  96   auto e = std::current_exception();
  97   auto bt = backtrace();
  98   try {
  99     std::rethrow_exception(e);
 100   }
 101
 102   // We manage C++ exception ourselves
 103   catch (std::exception& e) {
 104     log_exception(xbt_log_priority_critical, "Uncaught exception", e);
 105     showBacktrace(bt);
 106     std::abort();
 107   }
 108
 109   // We don't know how to manage other exceptions
 110   catch (...) {
 111     // If there was another handler let's delegate to it
 112     if (previous_terminate_handler)
 113       previous_terminate_handler();
 114     else {
 115       XBT_ERROR("Unknown uncaught exception");
 116       showBacktrace(bt);
 117       std::abort();
 118     }
 119   }
 120
 121 }
 122
 123 void install_exception_handler()
 124 {
 125   static std::once_flag handler_flag;
 126   std::call_once(handler_flag, [] {
 127     previous_terminate_handler = std::set_terminate(handler);
 128   });
 129 }
 130 // deprecated
 131 void logException(e_xbt_log_priority_t priority, const char* context, std::exception const& exception)
 132 {
 133   log_exception(priority, context, exception);
 134 }
 135 void installExceptionHandler()
 136 {
 137   install_exception_handler();
 138 }
 139
 140 } // namespace xbt
 141 }