include/simgrid/Exception.hpp

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