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 #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   explicit ImpossibleError(const std::string& arg) : std::logic_error(arg) {}
  64   ~ImpossibleError();
  65 };
  66
  67 class XBT_PUBLIC UnimplementedError : public std::logic_error {
  68 public:
  69   explicit UnimplementedError(const std::string& arg) : std::logic_error(arg) {}
  70   ~UnimplementedError();
  71 };
  72
  73 } // namespace xbt
  74
  75 /** Ancestor class of all SimGrid exception */
  76 class Exception : public std::runtime_error {
  77 public:
  78   Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
  79       : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint))
  80   {
  81   }
  82   ~Exception(); // DO NOT define it here -- see Exception.cpp for a rationale
  83
  84   /** Return the information about where the exception was thrown */
  85   xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
  86
  87   std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
  88
  89   /** Allow to carry a value (used by waitall/waitany) */
  90   int value = 0;
  91
  92 private:
  93   xbt::ThrowPoint throwpoint_;
  94 };
  95
  96 /** Exception raised when a timeout elapsed */
  97 class TimeoutException : public Exception {
  98 public:
  99   TimeoutException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 100       : Exception(std::move(throwpoint), std::move(message))
 101   {
 102   }
 103 };
 104
 105 XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::TimeoutException") typedef TimeoutException TimeoutError;
 106
 107 /** Exception raised when a host fails */
 108 class HostFailureException : public Exception {
 109 public:
 110   HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 111       : Exception(std::move(throwpoint), std::move(message))
 112   {
 113   }
 114 };
 115
 116 /** Exception raised when a communication fails because of the network or because of the remote host */
 117 class NetworkFailureException : public Exception {
 118 public:
 119   NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 120       : Exception(std::move(throwpoint), std::move(message))
 121   {
 122   }
 123 };
 124
 125 /** Exception raised when a storage fails */
 126 class StorageFailureException : public Exception {
 127 public:
 128   StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 129       : Exception(std::move(throwpoint), std::move(message))
 130   {
 131   }
 132 };
 133
 134 /** Exception raised when a VM fails */
 135 class VmFailureException : public Exception {
 136 public:
 137   VmFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 138       : Exception(std::move(throwpoint), std::move(message))
 139   {
 140   }
 141 };
 142
 143 /** Exception raised when something got canceled before completion */
 144 class CancelException : public Exception {
 145 public:
 146   CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 147       : Exception(std::move(throwpoint), std::move(message))
 148   {
 149   }
 150 };
 151
 152 /** Exception raised when something is going wrong during the simulation tracing */
 153 class TracingError : public Exception {
 154 public:
 155   TracingError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
 156       : Exception(std::move(throwpoint), std::move(message))
 157   {
 158   }
 159 };
 160
 161 /** Exception raised when something is going wrong during the parsing of XML files */
 162 class ParseError : public Exception {
 163 public:
 164   ParseError(const std::string& file, int line, const std::string& msg)
 165       : Exception(XBT_THROW_POINT, xbt::string_printf("Parse error at %s:%d: %s", file.c_str(), line, msg.c_str()))
 166   {
 167   }
 168 };
 169
 170 class XBT_PUBLIC ForcefulKillException {
 171   /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
 172    *
 173    * This exception is thrown whenever the actor's host is turned off. The actor stack is properly unwinded to release
 174    * all objects allocated on the stack (RAII powa).
 175    *
 176    * You may want to catch this exception to perform some extra cleanups in your simulation, but YOUR ACTORS MUST NEVER
 177    * SURVIVE a ForcefulKillException, or your simulation will segfault.
 178    *
 179    * @verbatim
 180    * void* payload = malloc(512);
 181    *
 182    * try {
 183    *   simgrid::s4u::this_actor::execute(100000);
 184    * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
 185    *   free(malloc);
 186    *   throw; // I shall never survive on an host that was switched off
 187    * }
 188    * @endverbatim
 189    */
 190   /* Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
 191    * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
 192    */
 193 public:
 194   ForcefulKillException() = default;
 195   explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
 196   {
 197   }
 198   ~ForcefulKillException();
 199   const char* what() const noexcept { return msg_.c_str(); }
 200
 201   XBT_ATTRIB_NORETURN static void do_throw();
 202   static bool try_n_catch(const std::function<void()>& try_block);
 203
 204 private:
 205   std::string msg_ = std::string("Actor killed.");
 206 };
 207
 208 } // namespace simgrid
 209
 210 XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") typedef simgrid::Exception xbt_ex;
 211
 212 #endif