1 /* Copyright (c) 2018-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_EXCEPTIONS_HPP
7 #define SIMGRID_EXCEPTIONS_HPP
9 /** @file exception.hpp SimGrid-specific Exceptions
11 * Defines all possible exception that could occur in a SimGrid library.
14 #include <xbt/backtrace.hpp>
16 #include <xbt/string.hpp>
26 /** Contextual information about an execution location (file:line:func and backtrace, procname, pid)
28 * Constitute the contextual information of where an exception was thrown
30 * These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid)
31 * are best created with @ref XBT_THROW_POINT.
37 ThrowPoint() = default;
38 explicit ThrowPoint(const char* file, int line, const char* function, Backtrace&& bt, std::string&& actor_name,
43 , backtrace_(std::move(bt))
44 , procname_(std::move(actor_name))
49 const char* file_ = nullptr;
51 const char* function_ = nullptr;
53 std::string procname_ = ""; /**< Name of the process who thrown this */
54 int pid_ = 0; /**< PID of the process who thrown this */
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())
61 class XBT_PUBLIC ImpossibleError : public std::logic_error {
63 using std::logic_error::logic_error;
64 ~ImpossibleError() override;
67 class XBT_PUBLIC InitializationError : public std::logic_error {
69 using std::logic_error::logic_error;
70 ~InitializationError() override;
73 class XBT_PUBLIC UnimplementedError : public std::logic_error {
75 using std::logic_error::logic_error;
76 ~UnimplementedError() override;
81 /** Ancestor class of all SimGrid exception */
82 class Exception : public std::runtime_error {
84 Exception(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message)
85 : std::runtime_error(message), throwpoint_(std::move(throwpoint))
88 Exception(const Exception&) = default;
89 Exception(Exception&&) noexcept = default;
90 ~Exception() override; // DO NOT define it here -- see Exception.cpp for a rationale
92 /** Return the information about where the exception was thrown */
93 xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
95 /** Allow to carry a value (used by testany/waitany) */
96 int get_value() const { return value_; }
97 void set_value(int value) { value_ = value; }
99 std::string resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
101 virtual void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message) const
103 std::throw_with_nested(Exception(std::move(throwpoint), message));
107 xbt::ThrowPoint throwpoint_;
111 #define DECLARE_SIMGRID_EXCEPTION(AnyException, ...) \
112 class AnyException : public Exception { \
114 using Exception::Exception; \
116 ~AnyException() override; \
117 void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message) const override \
119 std::throw_with_nested(AnyException(std::move(throwpoint), message)); \
123 /** Exception raised when a timeout elapsed */
124 DECLARE_SIMGRID_EXCEPTION(TimeoutException);
126 using TimeoutError XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::TimeoutException") = TimeoutException;
128 /** Exception raised when a host fails */
129 DECLARE_SIMGRID_EXCEPTION(HostFailureException);
131 /** Exception raised when a communication fails because of the network or because of the remote host */
132 DECLARE_SIMGRID_EXCEPTION(NetworkFailureException);
134 /** Exception raised when a storage fails */
135 DECLARE_SIMGRID_EXCEPTION(StorageFailureException);
137 /** Exception raised when a VM fails */
138 DECLARE_SIMGRID_EXCEPTION(VmFailureException);
140 /** Exception raised when something got canceled before completion */
141 DECLARE_SIMGRID_EXCEPTION(CancelException);
143 /** Exception raised when something is going wrong during the simulation tracing */
144 DECLARE_SIMGRID_EXCEPTION(TracingError);
146 /** Exception raised when something is going wrong during the parsing of XML files */
147 #define PARSE_ERROR_CONSTRUCTOR \
148 ParseError(const std::string& file, int line, const std::string& msg) \
149 : Exception(XBT_THROW_POINT, xbt::string_printf("Parse error at %s:%d: %s", file.c_str(), line, msg.c_str())) \
153 DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR);
154 #undef PARSE_ERROR_CONSTRUCTOR
156 #undef DECLARE_SIMGRID_EXCEPTION
158 class XBT_PUBLIC ForcefulKillException {
159 /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
161 * This exception is thrown whenever the actor's host is turned off. The actor stack is properly unwinded to release
162 * all objects allocated on the stack (RAII powa).
164 * You may want to catch this exception to perform some extra cleanups in your simulation, but YOUR ACTORS MUST NEVER
165 * SURVIVE a ForcefulKillException, or your simulation will segfault.
168 * void* payload = malloc(512);
171 * simgrid::s4u::this_actor::execute(100000);
172 * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
174 * throw; // I shall never survive on a host that was switched off
178 /* Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
179 * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
182 ForcefulKillException() = default;
183 explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
186 ~ForcefulKillException();
187 const char* what() const noexcept { return msg_.c_str(); }
189 XBT_ATTRIB_NORETURN static void do_throw();
190 static bool try_n_catch(const std::function<void()>& try_block);
193 std::string msg_ = std::string("Actor killed.");
196 } // namespace simgrid
198 using xbt_ex XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") = simgrid::Exception;