1 /* Copyright (c) 2018. 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>
24 /** Contextual information about an execution location (file:line:func and backtrace, procname, pid)
26 * Constitute the contextual information of where an exception was thrown
28 * These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid)
29 * are best created with @ref XBT_THROW_POINT.
35 ThrowPoint() = default;
36 explicit ThrowPoint(const char* file, int line, const char* function, Backtrace bt, std::string actor_name, int pid)
37 : file_(file), line_(line), function_(function), backtrace_(bt), procname_(actor_name), pid_(pid)
41 const char* file_ = nullptr;
43 const char* function_ = nullptr;
45 std::string procname_ = ""; /**< Name of the process who thrown this */
46 int pid_ = 0; /**< PID of the process who thrown this */
49 /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
50 #define XBT_THROW_POINT \
51 ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::backtrace(), xbt_procname(), xbt_getpid())
54 /** Ancestor class of all SimGrid exception */
55 class Exception : public std::runtime_error {
57 Exception(simgrid::xbt::ThrowPoint throwpoint, std::string message)
58 : std::runtime_error(message), throwpoint_(throwpoint)
62 /** Return the information about where the exception was thrown */
63 xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
66 xbt::ThrowPoint throwpoint_;
69 } // namespace simgrid
71 /** A legacy exception
73 * It is defined by a category and a value within that category (as well as
74 * an optional error message).
76 * This used to be a structure for C exceptions but it has been retrofitted
77 * as a C++ exception and some of its data has been moved in the
78 * @ref WithContextException base class. We should deprecate it and replace it
79 * with either C++ different exceptions or `std::system_error` which already
80 * provides this (category + error code) logic.
84 class XBT_PUBLIC xbt_ex : public simgrid::Exception {
88 * @param throwpoint Throw point (use XBT_THROW_POINT)
89 * @param message Exception message
91 xbt_ex(simgrid::xbt::ThrowPoint throwpoint, std::string message) : simgrid::Exception(throwpoint, message) {}
93 ~xbt_ex(); // DO NOT define it here -- see ex.cpp for a rationale
95 /** Category (what went wrong) */
96 xbt_errcat_t category = unknown_error;
98 /** Why did it went wrong */
104 /** Exception raised when a timeout elapsed */
105 class TimeoutError : public xbt_ex {
107 TimeoutError(simgrid::xbt::ThrowPoint throwpoint, std::string message) : xbt_ex(throwpoint, message)
109 category = timeout_error;
113 /** Exception raised when an host fails */
114 class HostFailureException : public xbt_ex {
116 HostFailureException(simgrid::xbt::ThrowPoint throwpoint, std::string message) : xbt_ex(throwpoint, message)
118 category = host_error;
122 /** Exception raised when a communication fails because of the network */
123 class NetworkFailureException : public xbt_ex {
125 NetworkFailureException(simgrid::xbt::ThrowPoint throwpoint, std::string message) : xbt_ex(throwpoint, message)
127 category = network_error;
131 /** Exception raised when something got canceled before completion */
132 class CancelException : public xbt_ex {
135 } // namespace simgrid