X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/29379a85ce9802fd3174f4237b57d240a704cb45..f552d294e06a8e76162f2ce6f31b9ce02801a33f:/include/simgrid/Exception.hpp diff --git a/include/simgrid/Exception.hpp b/include/simgrid/Exception.hpp index 37acd8ff53..a5b0cd9968 100644 --- a/include/simgrid/Exception.hpp +++ b/include/simgrid/Exception.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2018-2021. 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. */ @@ -11,141 +11,185 @@ * Defines all possible exception that could occur in a SimGrid library. */ -#include -#include -#include -#include -#include - -#include #include -#include #include -#include -#include // xbt_procname -#include // xbt_getpid +#include + +#include +#include +#include +#include namespace simgrid { namespace xbt { -/** The location of where an exception has been thrown +/** Contextual information about an execution location (file:line:func and backtrace, procname, pid) * - * This is a tuple (__FILE__, __LINE__, __func__), created with @ref XBT_THROW_POINT. + * Constitute the contextual information of where an exception was thrown + * + * These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid) + * are best created with @ref XBT_THROW_POINT. * * @ingroup XBT_ex */ class ThrowPoint { public: ThrowPoint() = default; - explicit ThrowPoint(const char* file, int line, const char* function) : file_(file), line_(line), function_(function) + 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) { } + const char* file_ = nullptr; int line_ = 0; const char* function_ = nullptr; + Backtrace backtrace_; + std::string procname_ = ""; /**< Name of the process who thrown this */ + int pid_ = 0; /**< PID of the process who thrown this */ }; /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */ -#define XBT_THROW_POINT ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__) +#define XBT_THROW_POINT \ + ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid()) -/** A base class for exceptions with context - * - * This is a base class for exceptions which store additional contextual - * information: backtrace, throw point, simulated process name, PID, etc. - */ -class XBT_PUBLIC ContextedException { +class XBT_PUBLIC ImpossibleError : public std::logic_error { public: - ContextedException() : backtrace_(simgrid::xbt::backtrace()), procname_(xbt_procname()), pid_(xbt_getpid()) {} - explicit ContextedException(Backtrace bt) : backtrace_(std::move(bt)), procname_(xbt_procname()), pid_(xbt_getpid()) - { - } - explicit ContextedException(ThrowPoint throwpoint, Backtrace bt) - : backtrace_(std::move(bt)), procname_(xbt_procname()), pid_(xbt_getpid()), throwpoint_(throwpoint) - { - } - virtual ~ContextedException(); - Backtrace const& backtrace() const { return backtrace_; } - int pid() const { return pid_; } - std::string const& process_name() const { return procname_; } - ThrowPoint& throw_point() { return throwpoint_; } - - // deprecated - XBT_ATTRIB_DEPRECATED_v323("Please use WithContextException::process_name()") std::string const& processName() const - { - return process_name(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use WithContextException::throw_point()") ThrowPoint& throwPoint() - { - return throw_point(); - } + using std::logic_error::logic_error; + ~ImpossibleError() override; +}; -private: - Backtrace backtrace_; - std::string procname_; /**< Name of the process who thrown this */ - int pid_; /**< PID of the process who thrown this */ - ThrowPoint throwpoint_; +class XBT_PUBLIC InitializationError : public std::logic_error { +public: + using std::logic_error::logic_error; + ~InitializationError() override; }; + +class XBT_PUBLIC UnimplementedError : public std::logic_error { +public: + using std::logic_error::logic_error; + ~UnimplementedError() override; +}; + } // namespace xbt /** Ancestor class of all SimGrid exception */ class Exception : public std::runtime_error { public: - Exception() : std::runtime_error("") {} - Exception(const char* message) : std::runtime_error(message) {} + Exception(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message) + : std::runtime_error(message), throwpoint_(std::move(throwpoint)) + { + } + Exception(const Exception&) = default; + Exception(Exception&&) noexcept = default; + ~Exception() override; // DO NOT define it here -- see Exception.cpp for a rationale + + /** Return the information about where the exception was thrown */ + xbt::ThrowPoint const& throw_point() const { return throwpoint_; } + + /** Allow to carry a value (used by testany/waitany) */ + ssize_t get_value() const { return value_; } + void set_value(ssize_t value) { value_ = value; } + + std::string resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); } + + virtual void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message) const + { + std::throw_with_nested(Exception(std::move(throwpoint), message)); + } + +private: + xbt::ThrowPoint throwpoint_; + ssize_t value_ = 0; }; +#define DECLARE_SIMGRID_EXCEPTION(AnyException, ...) \ + class AnyException : public Exception { \ + public: \ + using Exception::Exception; \ + __VA_ARGS__ \ + ~AnyException() override; \ + void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message) const override \ + { \ + std::throw_with_nested(AnyException(std::move(throwpoint), message)); \ + } \ + } + /** Exception raised when a timeout elapsed */ -class timeout_error : public simgrid::Exception { -}; +DECLARE_SIMGRID_EXCEPTION(TimeoutException); -/** Exception raised when an host fails */ -class host_failure : public simgrid::Exception { -}; +/** Exception raised when a host fails */ +DECLARE_SIMGRID_EXCEPTION(HostFailureException); -/** Exception raised when a communication fails because of the network */ -class network_failure : public simgrid::Exception { -}; +/** Exception raised when a communication fails because of the network or because of the remote host */ +DECLARE_SIMGRID_EXCEPTION(NetworkFailureException); + +/** Exception raised when a storage fails */ +DECLARE_SIMGRID_EXCEPTION(StorageFailureException); + +/** Exception raised when a VM fails */ +DECLARE_SIMGRID_EXCEPTION(VmFailureException); /** Exception raised when something got canceled before completion */ -class canceled_error : public simgrid::Exception { -}; +DECLARE_SIMGRID_EXCEPTION(CancelException); -} // namespace simgrid +/** Exception raised when something is going wrong during the simulation tracing */ +DECLARE_SIMGRID_EXCEPTION(TracingError); -/** A legacy exception - * - * It is defined by a category and a value within that category (as well as - * an optional error message). - * - * This used to be a structure for C exceptions but it has been retrofitted - * as a C++ exception and some of its data has been moved in the - * @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. - * - * @ingroup XBT_ex_c - */ -class XBT_PUBLIC xbt_ex : public simgrid::Exception, public simgrid::xbt::ContextedException { -public: - xbt_ex() : simgrid::Exception() {} +/** Exception raised when something is going wrong during the parsing of XML files */ +#define PARSE_ERROR_CONSTRUCTOR \ + ParseError(const std::string& file, int line, const std::string& msg) \ + : Exception(XBT_THROW_POINT, xbt::string_printf("Parse error at %s:%d: %s", file.c_str(), line, msg.c_str())) \ + { \ + } + +DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR); +#undef PARSE_ERROR_CONSTRUCTOR - /** +#undef DECLARE_SIMGRID_EXCEPTION + +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). * - * @param throwpoint Throw point (use XBT_THROW_POINT) - * @param message Exception message + * 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 a host that was switched off + * } + * @endverbatim */ - xbt_ex(simgrid::xbt::ThrowPoint throwpoint, const char* message) - : simgrid::Exception(message), simgrid::xbt::ContextedException(throwpoint, simgrid::xbt::backtrace()) + /* 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_ex(); // DO NOT define it here -- see ex.cpp for a rationale + XBT_ATTRIB_NORETURN static void do_throw(); + static bool try_n_catch(const std::function& try_block); - /** Category (what went wrong) */ - xbt_errcat_t category = unknown_error; - - /** Why did it went wrong */ - int value = 0; +private: + std::string msg_ = std::string("Actor killed."); }; +} // namespace simgrid #endif