X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c34ec0a9a237bf4befb762e35ab117731a8c3851..40ee10e13b61bfb28374d96ade010a262b5abd44:/include/simgrid/Exception.hpp diff --git a/include/simgrid/Exception.hpp b/include/simgrid/Exception.hpp index 7f3918f085..4b14e56cfe 100644 --- a/include/simgrid/Exception.hpp +++ b/include/simgrid/Exception.hpp @@ -1,16 +1,14 @@ -/* 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 exceptions 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 @@ -28,15 +26,13 @@ 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) + aid_t pid) : file_(file) , line_(line) , function_(function) @@ -51,23 +47,30 @@ public: 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 */ + aid_t 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__, 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: - explicit ImpossibleError(const std::string& arg) : std::logic_error(arg) {} - ~ImpossibleError(); + 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: - explicit UnimplementedError(const std::string& arg) : std::logic_error(arg) {} - ~UnimplementedError(); + using std::logic_error::logic_error; + ~UnimplementedError() override; }; } // namespace xbt @@ -75,105 +78,82 @@ public: /** Ancestor class of all SimGrid exception */ class Exception : public std::runtime_error { public: - Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint)) + Exception(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message) + : std::runtime_error(message), throwpoint_(std::move(throwpoint)) { } - ~Exception(); // DO NOT define it here -- see Exception.cpp for a rationale + 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(); } - /** Allow to carry a value (used by waitall/waitany) */ - int value = 0; + 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; }; -/** Exception raised when a timeout elapsed */ -class TimeoutException : public Exception { -public: - TimeoutException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : Exception(std::move(throwpoint), std::move(message)) - { +#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)); \ + } \ } -}; -XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::TimeoutException") typedef TimeoutException TimeoutError; +/** Exception raised when a timeout elapsed */ +DECLARE_SIMGRID_EXCEPTION(TimeoutException); /** Exception raised when a host fails */ -class HostFailureException : public Exception { -public: - HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : Exception(std::move(throwpoint), std::move(message)) - { - } -}; +DECLARE_SIMGRID_EXCEPTION(HostFailureException); /** Exception raised when a communication fails because of the network or because of the remote host */ -class NetworkFailureException : public Exception { -public: - NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : Exception(std::move(throwpoint), std::move(message)) - { - } -}; +DECLARE_SIMGRID_EXCEPTION(NetworkFailureException); /** Exception raised when a storage fails */ -class StorageFailureException : public Exception { -public: - StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : Exception(std::move(throwpoint), std::move(message)) - { - } -}; +DECLARE_SIMGRID_EXCEPTION(StorageFailureException); /** Exception raised when a VM fails */ -class VmFailureException : public Exception { -public: - VmFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : Exception(std::move(throwpoint), std::move(message)) - { - } -}; +DECLARE_SIMGRID_EXCEPTION(VmFailureException); /** Exception raised when something got canceled before completion */ -class CancelException : public Exception { -public: - CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : Exception(std::move(throwpoint), std::move(message)) - { - } -}; +DECLARE_SIMGRID_EXCEPTION(CancelException); /** Exception raised when something is going wrong during the simulation tracing */ -class TracingError : public Exception { -public: - TracingError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : Exception(std::move(throwpoint), std::move(message)) - { +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())) \ + { \ } -}; -class XBT_PUBLIC ParseError : public Exception, public std::invalid_argument { - int line_; - std::string file_; - std::string msg_; +DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR); +#undef PARSE_ERROR_CONSTRUCTOR -public: - ParseError(int line, std::string& file, std::string&& msg) - : Exception(XBT_THROW_POINT, std::move(msg)), std::invalid_argument(msg), line_(line), file_(file), msg_(msg) - { - } +/** Exception raised by xbt_enforce, when an assertion is not satisfied */ +DECLARE_SIMGRID_EXCEPTION(AssertionError); - const char* what() const noexcept override - { - return bprintf("Parse error at %s:%d: %s", file_.c_str(), line_, msg_.c_str()); - } -}; +#undef DECLARE_SIMGRID_EXCEPTION class XBT_PUBLIC ForcefulKillException { /** @brief Exception launched to kill an actor; DO NOT BLOCK IT! @@ -191,7 +171,7 @@ class XBT_PUBLIC ForcefulKillException { * 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 + * throw; // I shall never survive on a host that was switched off * } * @endverbatim */ @@ -200,21 +180,17 @@ class XBT_PUBLIC ForcefulKillException { */ public: ForcefulKillException() = default; - explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(").")) - { - } + explicit ForcefulKillException(const std::string& msg) : msg_("Actor killed (" + msg + ").") {} ~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& try_block); + XBT_ATTRIB_DEPRECATED_v338("Please manifest if you actually need this function") static bool try_n_catch( + const std::function& try_block); private: - std::string msg_ = std::string("Actor killed."); + std::string msg_ = "Actor killed."; }; } // namespace simgrid - -XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") typedef simgrid::Exception xbt_ex; - #endif