X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/32892d0df7206a7c14ace5a13f985df1e0a9249a..510c97d4c651c63ef9851a7e1d9c328f62b5b00b:/include/simgrid/Exception.hpp diff --git a/include/simgrid/Exception.hpp b/include/simgrid/Exception.hpp index 66c12def16..a6d40e8bae 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-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. */ @@ -11,35 +11,81 @@ * Defines all possible exception that could occur in a SimGrid library. */ -#include -#include -#include - +#include #include +#include +#include +#include +#include + namespace simgrid { +namespace xbt { -/** Ancestor class of all SimGrid exception */ -class Exception : public std::runtime_error { +/** Contextual information about an execution location (file:line:func and backtrace, procname, pid) + * + * 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: - Exception() : std::runtime_error("") {} - Exception(const char* message) : std::runtime_error(message) {} -}; + 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_(std::move(actor_name)) + , pid_(pid) + { + } -/** Exception raised when a timeout elapsed */ -class timeout_error : public simgrid::Exception { + 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 */ }; -/** Exception raised when an host fails */ -class host_failure : public simgrid::Exception { +/** 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(); }; -/** Exception raised when a communication fails because of the network */ -class network_failure : public simgrid::Exception { +class XBT_PUBLIC UnimplementedError : public std::logic_error { +public: + explicit UnimplementedError(const std::string& arg) : std::logic_error(arg) {} + ~UnimplementedError(); }; -/** Exception raised when something got canceled before completion */ -class canceled_error : public simgrid::Exception { +} // 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(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_; }; } // namespace simgrid @@ -54,23 +100,24 @@ class canceled_error : public simgrid::Exception { * @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 */ -class XBT_PUBLIC xbt_ex : public simgrid::Exception, public simgrid::xbt::ContextedException { +class XBT_PUBLIC xbt_ex : public simgrid::Exception { public: - xbt_ex() : simgrid::Exception() {} - /** * * @param throwpoint Throw point (use XBT_THROW_POINT) * @param message Exception message */ - xbt_ex(simgrid::xbt::ThrowPoint throwpoint, const char* message) - : simgrid::Exception(message), simgrid::xbt::ContextedException(throwpoint, simgrid::xbt::backtrace()) + 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) */ @@ -80,4 +127,116 @@ public: int value = 0; }; +namespace simgrid { + +/** 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 a host fails */ +class HostFailureException : public xbt_ex { +public: + 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 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 a VM fails */ +class VmFailureException : public xbt_ex { +public: + VmFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) + : xbt_ex(std::move(throwpoint), std::move(message)) + { + category = vm_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; + } +}; + +/** Exception raised when something is going wrong during the simulation tracing */ +class TracingError : public xbt_ex { +public: + TracingError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) + : xbt_ex(std::move(throwpoint), std::move(message)) + { + category = tracing_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& try_block); + +private: + std::string msg_ = std::string("Actor killed."); +}; + +} // namespace simgrid + #endif