X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/29379a85ce9802fd3174f4237b57d240a704cb45..8816765fafedb6fe7a30a663d1fd2eb3955c06f5:/include/simgrid/Exception.hpp diff --git a/include/simgrid/Exception.hpp b/include/simgrid/Exception.hpp index 37acd8ff53..0e2ce75440 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,103 +11,67 @@ * 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 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) + * + * Constitute the contextual information of where an exception was thrown * - * This is a tuple (__FILE__, __LINE__, __func__), created with @ref XBT_THROW_POINT. + * 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__) - -/** 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 { -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(); - } - -private: - Backtrace backtrace_; - std::string procname_; /**< Name of the process who thrown this */ - int pid_; /**< PID of the process who thrown this */ - ThrowPoint throwpoint_; -}; +#define XBT_THROW_POINT \ + ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, std::move(simgrid::xbt::Backtrace()), xbt_procname(), \ + xbt_getpid()) } // 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 raised when a timeout elapsed */ -class timeout_error : public simgrid::Exception { -}; + Exception(simgrid::xbt::ThrowPoint throwpoint, std::string message) + : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint)) + { + } -/** Exception raised when an host fails */ -class host_failure : public simgrid::Exception { -}; + /** Return the information about where the exception was thrown */ + xbt::ThrowPoint const& throw_point() const { return throwpoint_; } -/** Exception raised when a communication fails because of the network */ -class network_failure : public simgrid::Exception { -}; + std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); } -/** Exception raised when something got canceled before completion */ -class canceled_error : public simgrid::Exception { +private: + xbt::ThrowPoint throwpoint_; }; } // namespace simgrid @@ -125,20 +89,20 @@ class canceled_error : public simgrid::Exception { * * @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) */ @@ -148,4 +112,58 @@ 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 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; + } +}; + +} // namespace simgrid + #endif