X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b8df87e176f27b25534f27d7e240defa32ca35bc..2ad536e710c5936ff8e525e4bbb5e7046f292aac:/include/simgrid/Exception.hpp diff --git a/include/simgrid/Exception.hpp b/include/simgrid/Exception.hpp index 675d959f66..f4d151f83e 100644 --- a/include/simgrid/Exception.hpp +++ b/include/simgrid/Exception.hpp @@ -1,20 +1,19 @@ -/* Copyright (c) 2018-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2018-2023. 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. */ +/* This file defines all possible exception that could occur in a SimGrid library. */ + #ifndef SIMGRID_EXCEPTIONS_HPP #define SIMGRID_EXCEPTIONS_HPP -/** @file exception.hpp SimGrid-specific Exceptions - * - * Defines all possible exception that could occur in a SimGrid library. - */ - #include #include +#include #include +#include #include #include @@ -26,15 +25,19 @@ namespace xbt { * 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 + * are best created with the macro XBT_THROW_POINT. */ 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_(std::move(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) { } @@ -48,95 +51,144 @@ public: /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */ #define XBT_THROW_POINT \ - ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, std::move(simgrid::xbt::Backtrace()), xbt_procname(), \ - xbt_getpid()) + ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), sg_actor_self_get_name(), \ + sg_actor_self_get_pid()) + +class XBT_PUBLIC ImpossibleError : public std::logic_error { +public: + using std::logic_error::logic_error; + ~ImpossibleError() override; +}; + +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(simgrid::xbt::ThrowPoint throwpoint, std::string message) - : std::runtime_error(message), throwpoint_(throwpoint) + 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_; } - std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); } + /** 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(); } + + XBT_ATTRIB_NORETURN 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; }; -} // namespace simgrid +#define DECLARE_SIMGRID_EXCEPTION(AnyException, ...) \ + class AnyException : public Exception { \ + public: \ + using Exception::Exception; \ + __VA_ARGS__ \ + ~AnyException() override; \ + XBT_ATTRIB_NORETURN void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint, \ + const std::string& message) const override \ + { \ + std::throw_with_nested(AnyException(std::move(throwpoint), message)); \ + } \ + } -/** 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: - /** - * - * @param throwpoint Throw point (use XBT_THROW_POINT) - * @param message Exception message - */ - xbt_ex(simgrid::xbt::ThrowPoint throwpoint, std::string message) : simgrid::Exception(throwpoint, message) {} - - xbt_ex(const xbt_ex&) = default; +/** Exception raised when a timeout elapsed */ +DECLARE_SIMGRID_EXCEPTION(TimeoutException); - ~xbt_ex(); // DO NOT define it here -- see ex.cpp for a rationale +/** Exception raised when a host fails */ +DECLARE_SIMGRID_EXCEPTION(HostFailureException); - /** Category (what went wrong) */ - xbt_errcat_t category = unknown_error; +/** Exception raised when a communication fails because of the network or because of the remote host */ +DECLARE_SIMGRID_EXCEPTION(NetworkFailureException); - /** Why did it went wrong */ - int value = 0; -}; +/** Exception raised when a storage fails */ +DECLARE_SIMGRID_EXCEPTION(StorageFailureException); -namespace simgrid { +/** Exception raised when a VM fails */ +DECLARE_SIMGRID_EXCEPTION(VmFailureException); -/** Exception raised when a timeout elapsed */ -class TimeoutError : public xbt_ex { -public: - TimeoutError(simgrid::xbt::ThrowPoint throwpoint, std::string message) : xbt_ex(throwpoint, message) - { - category = timeout_error; - } -}; +/** Exception raised when something got canceled before completion */ +DECLARE_SIMGRID_EXCEPTION(CancelException); -/** Exception raised when a host fails */ -class HostFailureException : public xbt_ex { -public: - HostFailureException(simgrid::xbt::ThrowPoint throwpoint, std::string message) : xbt_ex(throwpoint, message) - { - category = host_error; +/** Exception raised when something is going wrong during the simulation tracing */ +DECLARE_SIMGRID_EXCEPTION(TracingError); + +/** 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())) \ + { \ } -}; -/** Exception raised when a communication fails because of the network */ -class NetworkFailureException : public xbt_ex { +DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR); +#undef PARSE_ERROR_CONSTRUCTOR + +/** Exception raised by xbt_enforce, when an assertion is not satisfied */ +DECLARE_SIMGRID_EXCEPTION(AssertionError); + +#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). + * + * 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 + */ + /* 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: - NetworkFailureException(simgrid::xbt::ThrowPoint throwpoint, std::string message) : xbt_ex(throwpoint, message) - { - category = network_error; - } -}; + ForcefulKillException() = default; + explicit ForcefulKillException(const std::string& msg) : msg_("Actor killed (" + msg + ").") {} + ~ForcefulKillException(); + const char* what() const noexcept { return msg_.c_str(); } -/** Exception raised when something got canceled before completion */ -class CancelException : public xbt_ex { + XBT_ATTRIB_NORETURN static void do_throw(); + static bool try_n_catch(const std::function& try_block); + +private: + std::string msg_ = "Actor killed."; }; } // namespace simgrid - #endif