-/* Copyright (c) 2018-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2018-2023. 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. */
+/* This file defines all possible exception that could occur in a SimGrid library. */
+
#ifndef SIMGRID_EXCEPTIONS_HPP
#define SIMGRID_EXCEPTIONS_HPP
-/** @file exception.hpp SimGrid-specific Exceptions
- *
- * Defines all possible exception that could occur in a SimGrid library.
- */
-
#include <xbt/backtrace.hpp>
#include <xbt/ex.h>
#include <xbt/string.hpp>
* Constitute the contextual information of where an exception was thrown
*
* These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid)
- * are best created with @ref XBT_THROW_POINT.
- *
- * @ingroup XBT_ex
+ * are best created with the macro XBT_THROW_POINT.
*/
class ThrowPoint {
public:
/** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
#define XBT_THROW_POINT \
- ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid())
+ ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), sg_actor_self_get_name(), \
+ sg_actor_self_get_pid())
class XBT_PUBLIC ImpossibleError : public std::logic_error {
public:
- explicit ImpossibleError(const std::string& arg) : std::logic_error(arg) {}
+ 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) {}
+ 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) {}
+ using std::logic_error::logic_error;
~UnimplementedError() override;
};
/** 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(const Exception&) = default;
/** Return the information about where the exception was thrown */
xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
+ /** Allow to carry a value (used by testany/waitany) */
+ ssize_t get_value() const { return value_; }
+ void set_value(ssize_t value) { value_ = value; }
+
std::string resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
- /** Allow to carry a value (used by waitall/waitany) */
- int value = 0;
+ 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)); \
+ } \
}
- TimeoutException(const TimeoutException&) = default;
- TimeoutException(TimeoutException&&) noexcept = default;
- ~TimeoutException() override;
-};
-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))
- {
- }
- HostFailureException(const HostFailureException&) = default;
- HostFailureException(HostFailureException&&) noexcept = default;
- ~HostFailureException() override;
-};
+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))
- {
- }
- NetworkFailureException(const NetworkFailureException&) = default;
- NetworkFailureException(NetworkFailureException&&) noexcept = default;
- ~NetworkFailureException() override;
-};
+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))
- {
- }
- StorageFailureException(const StorageFailureException&) = default;
- StorageFailureException(StorageFailureException&&) noexcept = default;
- ~StorageFailureException() override;
-};
+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))
- {
- }
- VmFailureException(const VmFailureException&) = default;
- VmFailureException(VmFailureException&&) noexcept = default;
- ~VmFailureException() override;
-};
+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))
- {
- }
- CancelException(const CancelException&) = default;
- CancelException(CancelException&&) noexcept = default;
- ~CancelException() override;
-};
+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))
- {
- }
- TracingError(const TracingError&) = default;
- TracingError(TracingError&&) noexcept = default;
- ~TracingError() override;
-};
+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())) \
+ { \
}
- ParseError(const ParseError&) = default;
- ParseError(ParseError&&) noexcept = default;
- ~ParseError() override;
-};
+
+DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR);
+#undef PARSE_ERROR_CONSTRUCTOR
+
+/** Exception raised by xbt_enforce, when an assertion is not satisfied */
+DECLARE_SIMGRID_EXCEPTION(AssertionError);
+
+#undef DECLARE_SIMGRID_EXCEPTION
class XBT_PUBLIC ForcefulKillException {
/** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
*/
public:
ForcefulKillException() = default;
- explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
- {
- }
+ explicit ForcefulKillException(const std::string& msg) : msg_("Actor killed (" + msg + ").") {}
~ForcefulKillException();
const char* what() const noexcept { return msg_.c_str(); }
static bool try_n_catch(const std::function<void()>& try_block);
private:
- std::string msg_ = std::string("Actor killed.");
+ std::string msg_ = "Actor killed.";
};
} // namespace simgrid
-
-XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") typedef simgrid::Exception xbt_ex;
-
#endif
