1 /* Copyright (c) 2005-2018. The SimGrid Team. All rights reserved. */
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. */
6 #include "simgrid/Exception.hpp"
7 #include <xbt/config.hpp>
13 XBT_LOG_EXTERNAL_CATEGORY(xbt);
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_exception, xbt, "Exceptions");
16 // DO NOT define ~xbt_ex() in exception.hpp.
17 // Defining it here ensures that xbt_ex is defined only in libsimgrid, but not in libsimgrid-java.
18 // Doing otherwise naturally breaks things (at least on freebsd with clang).
20 xbt_ex::~xbt_ex() = default;
22 void _xbt_throw(char* message, xbt_errcat_t errcat, int value, const char* file, int line, const char* func)
24 xbt_ex e(simgrid::xbt::ThrowPoint(XBT_THROW_POINT), message);
31 /** @brief shows an exception content and the associated stack if available */
32 void xbt_ex_display(xbt_ex_t* e)
34 simgrid::xbt::log_exception(xbt_log_priority_critical, "UNCAUGHT EXCEPTION", *e);
37 /** @brief returns a short name for the given exception category */
38 const char* xbt_ex_catname(xbt_errcat_t cat)
42 return "unknown error";
44 return "invalid argument";
46 return "out of bounds";
52 return "system error";
54 return "network error";
58 return "action canceled";
60 return "thread error";
64 return "tracing error";
70 return "INVALID ERROR";
72 return "INVALID ERROR";
78 void log_exception(e_xbt_log_priority_t prio, const char* context, std::exception const& exception)
81 auto name = simgrid::xbt::demangle(typeid(exception).name());
83 auto* with_context = dynamic_cast<const simgrid::Exception*>(&exception);
84 if (with_context != nullptr)
85 XBT_LOG(prio, "%s %s by %s/%d: %s", context, name.get(), with_context->throw_point().procname_.c_str(),
86 with_context->throw_point().pid_, exception.what());
88 XBT_LOG(prio, "%s %s: %s", context, name.get(), exception.what());
90 // Do we have a backtrace?
91 if (with_context != nullptr && not simgrid::config::get_value<bool>("exception/cutpath")) {
92 auto backtrace = simgrid::xbt::resolve_backtrace(with_context->throw_point().backtrace_.data(),
93 with_context->throw_point().backtrace_.size());
94 for (std::string const& s : backtrace)
95 XBT_LOG(prio, " -> %s", s.c_str());
98 // Do we have a nested exception?
99 auto* with_nested = dynamic_cast<const std::nested_exception*>(&exception);
100 if (with_nested == nullptr || with_nested->nested_ptr() == nullptr)
103 with_nested->rethrow_nested();
105 catch (std::exception& nested_exception) {
106 log_exception(prio, "Caused by", nested_exception);
108 // We could catch nested_exception or WithContextException but we don't bother:
110 XBT_LOG(prio, "Caused by an unknown exception");
114 // Don't log exceptions we got when trying to log exception
118 static void showBacktrace(std::vector<xbt_backtrace_location_t>& bt)
120 if (simgrid::config::get_value<bool>("exception/cutpath")) {
121 XBT_LOG(xbt_log_priority_critical, "Display of current backtrace disabled by --cfg=exception/cutpath.");
124 std::vector<std::string> res = resolve_backtrace(&bt[0], bt.size());
125 XBT_LOG(xbt_log_priority_critical, "Current backtrace:");
126 for (std::string const& s : res)
127 XBT_LOG(xbt_log_priority_critical, " -> %s", s.c_str());
130 static std::terminate_handler previous_terminate_handler = nullptr;
132 static void handler()
134 // Avoid doing crazy things if we get an uncaught exception inside
135 // an uncaught exception
136 static std::atomic_flag lock = ATOMIC_FLAG_INIT;
137 if (lock.test_and_set()) {
138 XBT_ERROR("Handling an exception raised an exception. Bailing out.");
142 // Get the current backtrace and exception
143 auto e = std::current_exception();
144 auto bt = backtrace();
146 std::rethrow_exception(e);
149 // We manage C++ exception ourselves
150 catch (std::exception& e) {
151 log_exception(xbt_log_priority_critical, "Uncaught exception", e);
156 // We don't know how to manage other exceptions
158 // If there was another handler let's delegate to it
159 if (previous_terminate_handler)
160 previous_terminate_handler();
162 XBT_ERROR("Unknown uncaught exception");
170 void install_exception_handler()
172 static std::once_flag handler_flag;
173 std::call_once(handler_flag, [] {
174 previous_terminate_handler = std::set_terminate(handler);
178 void logException(e_xbt_log_priority_t priority, const char* context, std::exception const& exception)
180 log_exception(priority, context, exception);
182 void installExceptionHandler()
184 install_exception_handler();
188 } // namespace simgrid
190 void xbt_throw_impossible(const char* file, int line, const char* func)
192 std::stringstream ss;
193 ss << file << ":" << line << ":" << func << ": The Impossible Did Happen (yet again). Please report this bug.";
194 throw std::runtime_error(ss.str());
196 void xbt_throw_unimplemented(const char* file, int line, const char* func)
198 std::stringstream ss;
199 ss << file << ":" << line << ":" << func << ": Feature unimplemented yet. Please report this bug.";
200 throw std::runtime_error(ss.str());