X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ce8654a60e13d9355bb8c550a1d1e859d89d0626..d29713e57b4410b2a1dbd4bf17c9ef7e9ae2b5b3:/include/simgrid/Exception.hpp diff --git a/include/simgrid/Exception.hpp b/include/simgrid/Exception.hpp index 321b9568d9..b7ab71f179 100644 --- a/include/simgrid/Exception.hpp +++ b/include/simgrid/Exception.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2018-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2018-2020. 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. */ @@ -13,8 +13,10 @@ #include #include +#include #include +#include #include #include @@ -55,6 +57,25 @@ public: /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */ #define XBT_THROW_POINT \ ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid()) + +class XBT_PUBLIC ImpossibleError : public std::logic_error { +public: + explicit ImpossibleError(const std::string& arg) : std::logic_error(arg) {} + ~ImpossibleError(); +}; + +class XBT_PUBLIC InitializationError : public std::logic_error { +public: + explicit InitializationError(const std::string& arg) : std::logic_error(arg) {} + ~InitializationError(); +}; + +class XBT_PUBLIC UnimplementedError : public std::logic_error { +public: + explicit UnimplementedError(const std::string& arg) : std::logic_error(arg) {} + ~UnimplementedError(); +}; + } // namespace xbt /** Ancestor class of all SimGrid exception */ @@ -64,106 +85,160 @@ public: : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint)) { } + Exception(const Exception&) = default; + Exception(Exception&&) noexcept = default; + ~Exception(); // 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 waitall/waitany) */ + int value = 0; + private: xbt::ThrowPoint throwpoint_; }; -} // namespace simgrid - -/** 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(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 - - /** Category (what went wrong) */ - xbt_errcat_t category = unknown_error; - - /** Why did it went wrong */ - int value = 0; -}; - -namespace simgrid { - /** Exception raised when a timeout elapsed */ -class TimeoutError : public xbt_ex { +class TimeoutException : public Exception { public: - TimeoutError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : xbt_ex(std::move(throwpoint), std::move(message)) + TimeoutException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) + : Exception(std::move(throwpoint), std::move(message)) { - category = timeout_error; } + TimeoutException(const TimeoutException&) = default; + TimeoutException(TimeoutException&&) noexcept = default; + ~TimeoutException(); }; +XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::TimeoutException") typedef TimeoutException TimeoutError; + /** Exception raised when a host fails */ -class HostFailureException : public xbt_ex { +class HostFailureException : public Exception { public: HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : xbt_ex(std::move(throwpoint), std::move(message)) + : Exception(std::move(throwpoint), std::move(message)) { - category = host_error; } + HostFailureException(const HostFailureException&) = default; + HostFailureException(HostFailureException&&) noexcept = default; + ~HostFailureException(); }; /** Exception raised when a communication fails because of the network or because of the remote host */ -class NetworkFailureException : public xbt_ex { +class NetworkFailureException : public Exception { public: NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : xbt_ex(std::move(throwpoint), std::move(message)) + : Exception(std::move(throwpoint), std::move(message)) { - category = network_error; } + NetworkFailureException(const NetworkFailureException&) = default; + NetworkFailureException(NetworkFailureException&&) noexcept = default; + ~NetworkFailureException(); }; /** Exception raised when a storage fails */ -class StorageFailureException : public xbt_ex { +class StorageFailureException : public Exception { public: StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : xbt_ex(std::move(throwpoint), std::move(message)) + : Exception(std::move(throwpoint), std::move(message)) + { + } + StorageFailureException(const StorageFailureException&) = default; + StorageFailureException(StorageFailureException&&) noexcept = default; + ~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)) { - category = io_error; } + VmFailureException(const VmFailureException&) = default; + VmFailureException(VmFailureException&&) noexcept = default; + ~VmFailureException(); }; /** Exception raised when something got canceled before completion */ -class CancelException : public xbt_ex { +class CancelException : public Exception { public: CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) - : xbt_ex(std::move(throwpoint), std::move(message)) + : Exception(std::move(throwpoint), std::move(message)) + { + } + CancelException(const CancelException&) = default; + CancelException(CancelException&&) noexcept = default; + ~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)) + { + } + TracingError(const TracingError&) = default; + TracingError(TracingError&&) noexcept = default; + ~TracingError(); +}; + +/** Exception raised when something is going wrong during the parsing of XML files */ +class ParseError : public Exception { +public: + 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())) { - category = cancel_error; } + ParseError(const ParseError&) = default; + ParseError(ParseError&&) noexcept = default; + ~ParseError(); +}; + +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& try_block); + +private: + std::string msg_ = std::string("Actor killed."); }; } // namespace simgrid +XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") typedef simgrid::Exception xbt_ex; + #endif