1 /* Copyright (c) 2018-2020. 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 explicit ImpossibleError(const std::string& arg) : std::logic_error(arg) {}
67 class XBT_PUBLIC InitializationError : public std::logic_error {
69 explicit InitializationError(const std::string& arg) : std::logic_error(arg) {}
70 ~InitializationError();
73 class XBT_PUBLIC UnimplementedError : public std::logic_error {
75 explicit UnimplementedError(const std::string& arg) : std::logic_error(arg) {}
76 ~UnimplementedError();
81 /** Ancestor class of all SimGrid exception */
82 class Exception : public std::runtime_error {
84 Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
85 : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint))
88 ~Exception(); // DO NOT define it here -- see Exception.cpp for a rationale
90 /** Return the information about where the exception was thrown */
91 xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
93 std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
95 /** Allow to carry a value (used by waitall/waitany) */
99 xbt::ThrowPoint throwpoint_;
102 /** Exception raised when a timeout elapsed */
103 class TimeoutException : public Exception {
105 TimeoutException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
106 : Exception(std::move(throwpoint), std::move(message))
111 XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::TimeoutException") typedef TimeoutException TimeoutError;
113 /** Exception raised when a host fails */
114 class HostFailureException : public Exception {
116 HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
117 : Exception(std::move(throwpoint), std::move(message))
122 /** Exception raised when a communication fails because of the network or because of the remote host */
123 class NetworkFailureException : public Exception {
125 NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
126 : Exception(std::move(throwpoint), std::move(message))
131 /** Exception raised when a storage fails */
132 class StorageFailureException : public Exception {
134 StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
135 : Exception(std::move(throwpoint), std::move(message))
140 /** Exception raised when a VM fails */
141 class VmFailureException : public Exception {
143 VmFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
144 : Exception(std::move(throwpoint), std::move(message))
149 /** Exception raised when something got canceled before completion */
150 class CancelException : public Exception {
152 CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
153 : Exception(std::move(throwpoint), std::move(message))
158 /** Exception raised when something is going wrong during the simulation tracing */
159 class TracingError : public Exception {
161 TracingError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
162 : Exception(std::move(throwpoint), std::move(message))
167 /** Exception raised when something is going wrong during the parsing of XML files */
168 class ParseError : public Exception {
170 ParseError(const std::string& file, int line, const std::string& msg)
171 : Exception(XBT_THROW_POINT, xbt::string_printf("Parse error at %s:%d: %s", file.c_str(), line, msg.c_str()))
176 class XBT_PUBLIC ForcefulKillException {
177 /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
179 * This exception is thrown whenever the actor's host is turned off. The actor stack is properly unwinded to release
180 * all objects allocated on the stack (RAII powa).
182 * You may want to catch this exception to perform some extra cleanups in your simulation, but YOUR ACTORS MUST NEVER
183 * SURVIVE a ForcefulKillException, or your simulation will segfault.
186 * void* payload = malloc(512);
189 * simgrid::s4u::this_actor::execute(100000);
190 * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
192 * throw; // I shall never survive on an host that was switched off
196 /* Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
197 * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
200 ForcefulKillException() = default;
201 explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
204 ~ForcefulKillException();
205 const char* what() const noexcept { return msg_.c_str(); }
207 XBT_ATTRIB_NORETURN static void do_throw();
208 static bool try_n_catch(const std::function<void()>& try_block);
211 std::string msg_ = std::string("Actor killed.");
214 } // namespace simgrid
216 XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") typedef simgrid::Exception xbt_ex;