-/* Copyright (c) 2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2018-2019. 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. */
* Defines all possible exception that could occur in a SimGrid library.
*/
-#include <exception>
-#include <stdexcept>
-#include <string>
-#include <type_traits>
-#include <vector>
-
-#include <xbt/backtrace.h>
#include <xbt/backtrace.hpp>
-#include <xbt/base.h>
#include <xbt/ex.h>
-#include <xbt/log.h>
-#include <xbt/misc.h> // xbt_procname
-#include <xbt/virtu.h> // xbt_getpid
+
+#include <atomic>
+#include <functional>
+#include <stdexcept>
+#include <string>
namespace simgrid {
namespace xbt {
class ThrowPoint {
public:
ThrowPoint() = default;
- explicit ThrowPoint(const char* file, int line, const char* function, Backtrace bt, std::string actor_name, int pid)
- : file_(file), line_(line), function_(function), backtrace_(bt), procname_(actor_name), pid_(pid)
+ explicit ThrowPoint(const char* file, int line, const char* function, Backtrace&& bt, std::string&& actor_name,
+ int pid)
+ : file_(file)
+ , line_(line)
+ , function_(function)
+ , backtrace_(std::move(bt))
+ , procname_(std::move(actor_name))
+ , pid_(pid)
{
}
/** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
#define XBT_THROW_POINT \
- ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::backtrace(), xbt_procname(), xbt_getpid())
+ ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid())
} // namespace xbt
/** Ancestor class of all SimGrid exception */
class Exception : public std::runtime_error {
public:
- Exception(simgrid::xbt::ThrowPoint throwpoint, const char* message)
- : std::runtime_error(message), throwpoint_(throwpoint)
+ Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
+ : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint))
{
}
/** Return the information about where the exception was thrown */
xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
+ std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
+
private:
xbt::ThrowPoint throwpoint_;
};
* @ref WithContextException base class. We should deprecate it and replace it
* with either C++ different exceptions or `std::system_error` which already
* provides this (category + error code) logic.
+ * TODO ^^
*
* @ingroup XBT_ex_c
*/
* @param throwpoint Throw point (use XBT_THROW_POINT)
* @param message Exception message
*/
- xbt_ex(simgrid::xbt::ThrowPoint throwpoint, const char* message) : simgrid::Exception(throwpoint, message) {}
+ xbt_ex(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
+ : simgrid::Exception(std::move(throwpoint), std::move(message))
+ {
+ }
+
+ xbt_ex(const xbt_ex&) = default;
~xbt_ex(); // DO NOT define it here -- see ex.cpp for a rationale
/** Exception raised when a timeout elapsed */
class TimeoutError : public xbt_ex {
+public:
+ TimeoutError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
+ : xbt_ex(std::move(throwpoint), std::move(message))
+ {
+ category = timeout_error;
+ }
};
-/** Exception raised when an host fails */
+/** Exception raised when a host fails */
class HostFailureException : public xbt_ex {
public:
- HostFailureException(simgrid::xbt::ThrowPoint throwpoint, const char* message) : xbt_ex(throwpoint, message)
+ HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
+ : xbt_ex(std::move(throwpoint), std::move(message))
{
category = host_error;
}
};
-/** Exception raised when a communication fails because of the network */
+/** Exception raised when a communication fails because of the network or because of the remote host */
class NetworkFailureException : public xbt_ex {
+public:
+ NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
+ : xbt_ex(std::move(throwpoint), std::move(message))
+ {
+ category = network_error;
+ }
+};
+
+/** Exception raised when a storage fails */
+class StorageFailureException : public xbt_ex {
+public:
+ StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
+ : xbt_ex(std::move(throwpoint), std::move(message))
+ {
+ category = io_error;
+ }
};
/** Exception raised when something got canceled before completion */
class CancelException : public xbt_ex {
+public:
+ CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
+ : xbt_ex(std::move(throwpoint), std::move(message))
+ {
+ category = cancel_error;
+ }
};
+
+class XBT_PUBLIC ForcefulKillException {
+ /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
+ *
+ * This exception is thrown whenever the actor's host is turned off. The actor stack is properly unwinded to release
+ * all objects allocated on the stack (RAII powa).
+ *
+ * You may want to catch this exception to perform some extra cleanups in your simulation, but YOUR ACTORS MUST NEVER
+ * SURVIVE a ForcefulKillException, or your simulation will segfault.
+ *
+ * @verbatim
+ * void* payload = malloc(512);
+ *
+ * try {
+ * simgrid::s4u::this_actor::execute(100000);
+ * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
+ * free(malloc);
+ * throw; // I shall never survive on an host that was switched off
+ * }
+ * @endverbatim
+ */
+ /* Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
+ * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
+ */
+public:
+ ForcefulKillException() = default;
+ explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
+ {
+ }
+ ~ForcefulKillException();
+ const char* what() const noexcept { return msg_.c_str(); }
+
+ XBT_ATTRIB_NORETURN static void do_throw();
+ static bool try_n_catch(const std::function<void()>& try_block);
+
+private:
+ std::string msg_ = std::string("Actor killed.");
+};
+
} // namespace simgrid
#endif
