include/simgrid/Exception.hpp

   1 /* Copyright (c) 2018-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_EXCEPTIONS_HPP
   7 #define SIMGRID_EXCEPTIONS_HPP
   8
   9 /** @file exception.hpp SimGrid-specific Exceptions
  10  *
  11  *  Defines all possible exception that could occur in a SimGrid library.
  12  */
  13
  14 #include <xbt/backtrace.hpp>
  15 #include <xbt/ex.h>
  16 #include <xbt/string.hpp>
  17
  18 #include <atomic>
  19 #include <functional>
  20 #include <stdexcept>
  21 #include <string>
  22
  23 namespace simgrid {
  24 namespace xbt {
  25
  26 /** Contextual information about an execution location (file:line:func and backtrace, procname, pid)
  27  *
  28  *  Constitute the contextual information of where an exception was thrown
  29  *
  30  *  These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid)
  31  *  are best created with @ref XBT_THROW_POINT.
  32  *
  33  *  @ingroup XBT_ex
  34  */
  35 class ThrowPoint {
  36 public:
  37   ThrowPoint() = default;
  38   explicit ThrowPoint(const char* file, int line, const char* function, Backtrace&& bt, std::string&& actor_name,
  39                       int pid)
  40       : file_(file)
  41       , line_(line)
  42       , function_(function)
  43       , backtrace_(std::move(bt))
  44       , procname_(std::move(actor_name))
  45       , pid_(pid)
  46   {
  47   }
  48
  49   const char* file_     = nullptr;
  50   int line_             = 0;
  51   const char* function_ = nullptr;
  52   Backtrace backtrace_;
  53   std::string procname_ = ""; /**< Name of the process who thrown this */
  54   int pid_              = 0;  /**< PID of the process who thrown this */
  55 };
  56
  57 /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
  58 #define XBT_THROW_POINT                                                                                                \
  59   ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid())
  60
  61 class XBT_PUBLIC ImpossibleError : public std::logic_error {
  62 public:
  63   using std::logic_error::logic_error;
  64   ~ImpossibleError() override;
  65 };
  66
  67 class XBT_PUBLIC InitializationError : public std::logic_error {
  68 public:
  69   using std::logic_error::logic_error;
  70   ~InitializationError() override;
  71 };
  72
  73 class XBT_PUBLIC UnimplementedError : public std::logic_error {
  74 public:
  75   using std::logic_error::logic_error;
  76   ~UnimplementedError() override;
  77 };
  78
  79 } // namespace xbt
  80
  81 /** Ancestor class of all SimGrid exception */
  82 class Exception : public std::runtime_error {
  83 public:
  84   Exception(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message)
  85       : std::runtime_error(message), throwpoint_(std::move(throwpoint))
  86   {
  87   }
  88   Exception(const Exception&)     = default;
  89   Exception(Exception&&) noexcept = default;
  90   ~Exception() override; // DO NOT define it here -- see Exception.cpp for a rationale
  91
  92   /** Return the information about where the exception was thrown */
  93   xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
  94
  95   /** Allow to carry a value (used by testany/waitany) */
  96   ssize_t get_value() const { return value_; }
  97   void set_value(ssize_t value) { value_ = value; }
  98
  99   std::string resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
 100
 101   XBT_ATTRIB_NORETURN virtual void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint,
 102                                                   const std::string& message) const
 103   {
 104     std::throw_with_nested(Exception(std::move(throwpoint), message));
 105   }
 106
 107 private:
 108   xbt::ThrowPoint throwpoint_;
 109   ssize_t value_ = 0;
 110 };
 111
 112 #define DECLARE_SIMGRID_EXCEPTION(AnyException, ...)                                                                   \
 113   class AnyException : public Exception {                                                                              \
 114   public:                                                                                                              \
 115     using Exception::Exception;                                                                                        \
 116     __VA_ARGS__                                                                                                        \
 117     ~AnyException() override;                                                                                          \
 118     XBT_ATTRIB_NORETURN void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint,                                     \
 119                                             const std::string& message) const override                                 \
 120     {                                                                                                                  \
 121       std::throw_with_nested(AnyException(std::move(throwpoint), message));                                            \
 122     }                                                                                                                  \
 123   }
 124
 125 /** Exception raised when a timeout elapsed */
 126 DECLARE_SIMGRID_EXCEPTION(TimeoutException);
 127
 128 /** Exception raised when a host fails */
 129 DECLARE_SIMGRID_EXCEPTION(HostFailureException);
 130
 131 /** Exception raised when a communication fails because of the network or because of the remote host */
 132 DECLARE_SIMGRID_EXCEPTION(NetworkFailureException);
 133
 134 /** Exception raised when a storage fails */
 135 DECLARE_SIMGRID_EXCEPTION(StorageFailureException);
 136
 137 /** Exception raised when a VM fails */
 138 DECLARE_SIMGRID_EXCEPTION(VmFailureException);
 139
 140 /** Exception raised when something got canceled before completion */
 141 DECLARE_SIMGRID_EXCEPTION(CancelException);
 142
 143 /** Exception raised when something is going wrong during the simulation tracing */
 144 DECLARE_SIMGRID_EXCEPTION(TracingError);
 145
 146 /** Exception raised when something is going wrong during the parsing of XML files */
 147 #define PARSE_ERROR_CONSTRUCTOR                                                                                        \
 148   ParseError(const std::string& file, int line, const std::string& msg)                                                \
 149       : Exception(XBT_THROW_POINT, xbt::string_printf("Parse error at %s:%d: %s", file.c_str(), line, msg.c_str()))    \
 150   {                                                                                                                    \
 151   }
 152
 153 DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR);
 154 #undef PARSE_ERROR_CONSTRUCTOR
 155
 156 #undef DECLARE_SIMGRID_EXCEPTION
 157
 158 class XBT_PUBLIC ForcefulKillException {
 159   /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
 160    *
 161    * This exception is thrown whenever the actor's host is turned off. The actor stack is properly unwinded to release
 162    * all objects allocated on the stack (RAII powa).
 163    *
 164    * You may want to catch this exception to perform some extra cleanups in your simulation, but YOUR ACTORS MUST NEVER
 165    * SURVIVE a ForcefulKillException, or your simulation will segfault.
 166    *
 167    * @verbatim
 168    * void* payload = malloc(512);
 169    *
 170    * try {
 171    *   simgrid::s4u::this_actor::execute(100000);
 172    * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
 173    *   free(malloc);
 174    *   throw; // I shall never survive on a host that was switched off
 175    * }
 176    * @endverbatim
 177    */
 178   /* Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
 179    * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
 180    */
 181 public:
 182   ForcefulKillException() = default;
 183   explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
 184   {
 185   }
 186   ~ForcefulKillException();
 187   const char* what() const noexcept { return msg_.c_str(); }
 188
 189   XBT_ATTRIB_NORETURN static void do_throw();
 190   static bool try_n_catch(const std::function<void()>& try_block);
 191
 192 private:
 193   std::string msg_ = std::string("Actor killed.");
 194 };
 195
 196 } // namespace simgrid
 197 #endif