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(file, line, func, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid()),
32 /** @brief shows an exception content and the associated stack if available */
33 void xbt_ex_display(xbt_ex_t* e)
35 simgrid::xbt::log_exception(xbt_log_priority_critical, "UNCAUGHT EXCEPTION", *e);
38 /** @brief returns a short name for the given exception category */
39 const char* xbt_ex_catname(xbt_errcat_t cat)
43 return "unknown error";
45 return "invalid argument";
47 return "out of bounds";
53 return "system error";
55 return "network error";
59 return "action canceled";
61 return "thread error";
65 return "tracing error";
71 return "INVALID ERROR";
73 return "INVALID ERROR";
79 void log_exception(e_xbt_log_priority_t prio, const char* context, std::exception const& exception)
82 auto name = simgrid::xbt::demangle(typeid(exception).name());
84 auto* with_context = dynamic_cast<const simgrid::Exception*>(&exception);
85 if (with_context != nullptr)
86 XBT_LOG(prio, "%s %s by %s/%d: %s", context, name.get(), with_context->throw_point().procname_.c_str(),
87 with_context->throw_point().pid_, exception.what());
89 XBT_LOG(prio, "%s %s: %s", context, name.get(), exception.what());
91 // Do we have a backtrace?
92 if (with_context != nullptr && not simgrid::config::get_value<bool>("exception/cutpath")) {
93 auto backtrace = with_context->resolve_backtrace();
94 XBT_LOG(prio, " -> %s", backtrace.c_str());
97 // Do we have a nested exception?
98 auto* with_nested = dynamic_cast<const std::nested_exception*>(&exception);
99 if (with_nested == nullptr || with_nested->nested_ptr() == nullptr)
102 with_nested->rethrow_nested();
104 catch (std::exception& nested_exception) {
105 log_exception(prio, "Caused by", nested_exception);
107 // We could catch nested_exception or WithContextException but we don't bother:
109 XBT_LOG(prio, "Caused by an unknown exception");
113 // Don't log exceptions we got when trying to log exception
117 static void show_backtrace(const simgrid::xbt::Backtrace& bt)
119 if (simgrid::config::get_value<bool>("exception/cutpath")) {
120 XBT_LOG(xbt_log_priority_critical, "Display of current backtrace disabled by --cfg=exception/cutpath.");
123 std::string res = bt.resolve();
124 XBT_LOG(xbt_log_priority_critical, "Current backtrace:");
125 XBT_LOG(xbt_log_priority_critical, " -> %s", res.c_str());
128 static std::terminate_handler previous_terminate_handler = nullptr;
130 static void handler()
132 // Avoid doing crazy things if we get an uncaught exception inside
133 // an uncaught exception
134 static std::atomic_flag lock = ATOMIC_FLAG_INIT;
135 if (lock.test_and_set()) {
136 XBT_ERROR("Handling an exception raised an exception. Bailing out.");
140 // Get the current backtrace and exception
141 auto e = std::current_exception();
142 simgrid::xbt::Backtrace bt = simgrid::xbt::Backtrace();
144 std::rethrow_exception(e);
147 // We manage C++ exception ourselves
148 catch (std::exception& e) {
149 log_exception(xbt_log_priority_critical, "Uncaught exception", e);
154 // We don't know how to manage other exceptions
156 // If there was another handler let's delegate to it
157 if (previous_terminate_handler)
158 previous_terminate_handler();
160 XBT_ERROR("Unknown uncaught exception");
168 void install_exception_handler()
170 static std::once_flag handler_flag;
171 std::call_once(handler_flag, [] {
172 previous_terminate_handler = std::set_terminate(handler);
176 void logException(e_xbt_log_priority_t priority, const char* context, std::exception const& exception)
178 log_exception(priority, context, exception);
180 void installExceptionHandler()
182 install_exception_handler();
186 } // namespace simgrid
188 void xbt_throw_impossible(const char* file, int line, const char* func)
190 std::stringstream ss;
191 ss << file << ":" << line << ":" << func << ": The Impossible Did Happen (yet again). Please report this bug.";
192 throw std::runtime_error(ss.str());
194 void xbt_throw_unimplemented(const char* file, int line, const char* func)
196 std::stringstream ss;
197 ss << file << ":" << line << ":" << func << ": Feature unimplemented yet. Please report this bug.";
198 throw std::runtime_error(ss.str());