Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Implement s4u_enforce
[simgrid.git] / include / simgrid / Exception.hpp
index 613ca5a..d56a371 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2018-2022. 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. */
@@ -60,20 +60,20 @@ public:
 
 class XBT_PUBLIC ImpossibleError : public std::logic_error {
 public:
-  explicit ImpossibleError(const std::string& arg) : std::logic_error(arg) {}
-  ~ImpossibleError();
+  using std::logic_error::logic_error;
+  ~ImpossibleError() override;
 };
 
 class XBT_PUBLIC InitializationError : public std::logic_error {
 public:
-  explicit InitializationError(const std::string& arg) : std::logic_error(arg) {}
-  ~InitializationError();
+  using std::logic_error::logic_error;
+  ~InitializationError() override;
 };
 
 class XBT_PUBLIC UnimplementedError : public std::logic_error {
 public:
-  explicit UnimplementedError(const std::string& arg) : std::logic_error(arg) {}
-  ~UnimplementedError();
+  using std::logic_error::logic_error;
+  ~UnimplementedError() override;
 };
 
 } // namespace xbt
@@ -81,97 +81,89 @@ public:
 /** Ancestor class of all SimGrid exception */
 class Exception : public std::runtime_error {
 public:
-  Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint))
+  Exception(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message)
+      : std::runtime_error(message), throwpoint_(std::move(throwpoint))
   {
   }
-  ~Exception(); // DO NOT define it here -- see Exception.cpp for a rationale
+  Exception(const Exception&)     = default;
+  Exception(Exception&&) noexcept = default;
+  ~Exception() override; // DO NOT define it here -- see Exception.cpp for a rationale
 
   /** Return the information about where the exception was thrown */
   xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
 
-  std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
+  /** Allow to carry a value (used by testany/waitany) */
+  ssize_t get_value() const { return value_; }
+  void set_value(ssize_t value) { value_ = value; }
 
-  /** Allow to carry a value (used by waitall/waitany) */
-  int value = 0;
+  std::string resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
+
+  XBT_ATTRIB_NORETURN virtual void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint,
+                                                  const std::string& message) const
+  {
+    std::throw_with_nested(Exception(std::move(throwpoint), message));
+  }
 
 private:
   xbt::ThrowPoint throwpoint_;
+  ssize_t value_ = 0;
 };
 
-/** Exception raised when a timeout elapsed */
-class TimeoutException : public Exception {
-public:
-  TimeoutException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : Exception(std::move(throwpoint), std::move(message))
-  {
+#define DECLARE_SIMGRID_EXCEPTION(AnyException, ...)                                                                   \
+  class AnyException : public Exception {                                                                              \
+  public:                                                                                                              \
+    using Exception::Exception;                                                                                        \
+    __VA_ARGS__                                                                                                        \
+    ~AnyException() override;                                                                                          \
+    XBT_ATTRIB_NORETURN void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint,                                     \
+                                            const std::string& message) const override                                 \
+    {                                                                                                                  \
+      std::throw_with_nested(AnyException(std::move(throwpoint), message));                                            \
+    }                                                                                                                  \
   }
-};
 
-XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::TimeoutException") typedef TimeoutException TimeoutError;
+/** Exception raised when a timeout elapsed */
+DECLARE_SIMGRID_EXCEPTION(TimeoutException);
 
 /** Exception raised when a host fails */
-class HostFailureException : public Exception {
-public:
-  HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : Exception(std::move(throwpoint), std::move(message))
-  {
-  }
-};
+DECLARE_SIMGRID_EXCEPTION(HostFailureException);
 
 /** Exception raised when a communication fails because of the network or because of the remote host */
-class NetworkFailureException : public Exception {
-public:
-  NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : Exception(std::move(throwpoint), std::move(message))
-  {
-  }
-};
+DECLARE_SIMGRID_EXCEPTION(NetworkFailureException);
 
 /** Exception raised when a storage fails */
-class StorageFailureException : public Exception {
-public:
-  StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : Exception(std::move(throwpoint), std::move(message))
-  {
-  }
-};
+DECLARE_SIMGRID_EXCEPTION(StorageFailureException);
 
 /** Exception raised when a VM fails */
-class VmFailureException : public Exception {
-public:
-  VmFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : Exception(std::move(throwpoint), std::move(message))
-  {
-  }
-};
+DECLARE_SIMGRID_EXCEPTION(VmFailureException);
 
 /** Exception raised when something got canceled before completion */
-class CancelException : public Exception {
-public:
-  CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : Exception(std::move(throwpoint), std::move(message))
-  {
-  }
-};
+DECLARE_SIMGRID_EXCEPTION(CancelException);
 
 /** Exception raised when something is going wrong during the simulation tracing */
-class TracingError : public Exception {
-public:
-  TracingError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : Exception(std::move(throwpoint), std::move(message))
-  {
-  }
-};
+DECLARE_SIMGRID_EXCEPTION(TracingError);
 
 /** Exception raised when something is going wrong during the parsing of XML files */
-class ParseError : public Exception {
-public:
-  ParseError(const std::string& file, int line, const std::string& msg)
-      : Exception(XBT_THROW_POINT, xbt::string_printf("Parse error at %s:%d: %s", file.c_str(), line, msg.c_str()))
-  {
+#define PARSE_ERROR_CONSTRUCTOR                                                                                        \
+  ParseError(const std::string& file, int line, const std::string& msg)                                                \
+      : Exception(XBT_THROW_POINT, xbt::string_printf("Parse error at %s:%d: %s", file.c_str(), line, msg.c_str()))    \
+  {                                                                                                                    \
   }
-};
+
+DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR);
+#undef PARSE_ERROR_CONSTRUCTOR
+
+/** Exception raised by s4u_enforce, when an assertion is not satisfied */
+#define ASSERTION_ERROR_CONSTRUCTOR                                                                                    \
+  template<typename... Args> AssertionError(const char * f, Args... args)                                              \
+      : Exception(XBT_THROW_POINT, xbt::string_printf(f, args...))    \
+  {                                                                                                                    \
+  }
+
+DECLARE_SIMGRID_EXCEPTION(AssertionError, ASSERTION_ERROR_CONSTRUCTOR);
+#undef ASSERTION_ERROR_CONSTRUCTOR
+
+#undef DECLARE_SIMGRID_EXCEPTION
 
 class XBT_PUBLIC ForcefulKillException {
   /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
@@ -189,7 +181,7 @@ class XBT_PUBLIC ForcefulKillException {
    *   simgrid::s4u::this_actor::execute(100000);
    * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
    *   free(malloc);
-   *   throw; // I shall never survive on an host that was switched off
+   *   throw; // I shall never survive on a host that was switched off
    * }
    * @endverbatim
    */
@@ -212,7 +204,4 @@ private:
 };
 
 } // namespace simgrid
-
-XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") typedef simgrid::Exception xbt_ex;
-
 #endif