include/simgrid/Exception.hpp

   1 /* Copyright (c) 2018-2019. 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
  17 #include <atomic>
  18 #include <functional>
  19 #include <stdexcept>
  20 #include <string>
  21
  22 namespace simgrid {
  23 namespace xbt {
  24
  25 /** Contextual information about an execution location (file:line:func and backtrace, procname, pid)
  26  *
  27  *  Constitute the contextual information of where an exception was thrown
  28  *
  29  *  These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid)
  30  *  are best created with @ref XBT_THROW_POINT.
  31  *
  32  *  @ingroup XBT_ex
  33  */
  34 class ThrowPoint {
  35 public:
  36   ThrowPoint() = default;
  37   explicit ThrowPoint(const char* file, int line, const char* function, Backtrace&& bt, std::string&& actor_name,
  38                       int pid)
  39       : file_(file)
  40       , line_(line)
  41       , function_(function)
  42       , backtrace_(std::move(bt))
  43       , procname_(std::move(actor_name))
  44       , pid_(pid)
  45   {
  46   }
  47
  48   const char* file_     = nullptr;
  49   int line_             = 0;
  50   const char* function_ = nullptr;
  51   Backtrace backtrace_;
  52   std::string procname_ = ""; /**< Name of the process who thrown this */
  53   int pid_              = 0;  /**< PID of the process who thrown this */
  54 };
  55
  56 /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
  57 #define XBT_THROW_POINT                                                                                                \
  58   ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid())
  59
  60 class XBT_PUBLIC ImpossibleError : public std::logic_error {
  61 public:
  62   explicit ImpossibleError(const std::string& arg) : std::logic_error(arg) {}
  63   ~ImpossibleError();
  64 };
  65
  66 class XBT_PUBLIC UnimplementedError : public std::logic_error {
  67 public:
  68   explicit UnimplementedError(const std::string& arg) : std::logic_error(arg) {}
  69   ~UnimplementedError();
  70 };
  71
  72 } // namespace xbt
  73
  74 /** Ancestor class of all SimGrid exception */
  75 class Exception : public std::runtime_error {
  76 public:
  77   Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
  78       : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint))
  79   {
  80   }
  81
  82   /** Return the information about where the exception was thrown */
  83   xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
  84
  85   std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
  86
  87 private:
  88   xbt::ThrowPoint throwpoint_;
  89 };
  90
  91 } // namespace simgrid
  92
  93 /** A legacy exception
  94  *
  95  *  It is defined by a category and a value within that category (as well as
  96  *  an optional error message).
  97  *
  98  *  This used to be a structure for C exceptions but it has been retrofitted
  99  *  as a C++ exception and some of its data has been moved in the
 100  *  @ref WithContextException base class. We should deprecate it and replace it
 101  *  with either C++ different exceptions or `std::system_error` which already
 102  *  provides this (category + error code) logic.
 103  *  TODO ^^
 104  *
 105  *  @ingroup XBT_ex_c
 106  */
 107 class XBT_PUBLIC xbt_ex : public simgrid::Exception {
 108 public:
 109   /**
 110    *
 111    * @param throwpoint Throw point (use XBT_THROW_POINT)
 112    * @param message    Exception message
 113    */
 114   xbt_ex(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 115       : simgrid::Exception(std::move(throwpoint), std::move(message))
 116   {
 117   }
 118
 119   xbt_ex(const xbt_ex&) = default;
 120
 121   ~xbt_ex(); // DO NOT define it here -- see ex.cpp for a rationale
 122
 123   /** Category (what went wrong) */
 124   xbt_errcat_t category = unknown_error;
 125
 126   /** Why did it went wrong */
 127   int value = 0;
 128 };
 129
 130 namespace simgrid {
 131
 132 /** Exception raised when a timeout elapsed */
 133 class TimeoutError : public xbt_ex {
 134 public:
 135   TimeoutError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 136       : xbt_ex(std::move(throwpoint), std::move(message))
 137   {
 138     category = timeout_error;
 139   }
 140 };
 141
 142 /** Exception raised when a host fails */
 143 class HostFailureException : public xbt_ex {
 144 public:
 145   HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 146       : xbt_ex(std::move(throwpoint), std::move(message))
 147   {
 148     category = host_error;
 149   }
 150 };
 151
 152 /** Exception raised when a communication fails because of the network or because of the remote host */
 153 class NetworkFailureException : public xbt_ex {
 154 public:
 155   NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 156       : xbt_ex(std::move(throwpoint), std::move(message))
 157   {
 158     category = network_error;
 159   }
 160 };
 161
 162 /** Exception raised when a storage fails */
 163 class StorageFailureException : public xbt_ex {
 164 public:
 165   StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 166       : xbt_ex(std::move(throwpoint), std::move(message))
 167   {
 168     category = io_error;
 169   }
 170 };
 171
 172 /** Exception raised when a VM fails */
 173 class VmFailureException : public xbt_ex {
 174 public:
 175   VmFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 176       : xbt_ex(std::move(throwpoint), std::move(message))
 177   {
 178     category = vm_error;
 179   }
 180 };
 181
 182 /** Exception raised when something got canceled before completion */
 183 class CancelException : public xbt_ex {
 184 public:
 185   CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 186       : xbt_ex(std::move(throwpoint), std::move(message))
 187   {
 188     category = cancel_error;
 189   }
 190 };
 191
 192 class XBT_PUBLIC ForcefulKillException {
 193   /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
 194    *
 195    * This exception is thrown whenever the actor's host is turned off. The actor stack is properly unwinded to release
 196    * all objects allocated on the stack (RAII powa).
 197    *
 198    * You may want to catch this exception to perform some extra cleanups in your simulation, but YOUR ACTORS MUST NEVER
 199    * SURVIVE a ForcefulKillException, or your simulation will segfault.
 200    *
 201    * @verbatim
 202    * void* payload = malloc(512);
 203    *
 204    * try {
 205    *   simgrid::s4u::this_actor::execute(100000);
 206    * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
 207    *   free(malloc);
 208    *   throw; // I shall never survive on an host that was switched off
 209    * }
 210    * @endverbatim
 211    */
 212   /* Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
 213    * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
 214    */
 215 public:
 216   ForcefulKillException() = default;
 217   explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
 218   {
 219   }
 220   ~ForcefulKillException();
 221   const char* what() const noexcept { return msg_.c_str(); }
 222
 223   XBT_ATTRIB_NORETURN static void do_throw();
 224   static bool try_n_catch(const std::function<void()>& try_block);
 225
 226 private:
 227   std::string msg_ = std::string("Actor killed.");
 228 };
 229
 230 } // namespace simgrid
 231
 232 #endif