Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Add attribute "noreturn" to non-returning functions.
[simgrid.git] / include / simgrid / Exception.hpp
1 /* Copyright (c) 2018-2019. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef SIMGRID_EXCEPTIONS_HPP
7 #define SIMGRID_EXCEPTIONS_HPP
8
9 /** @file exception.hpp SimGrid-specific Exceptions
10  *
11  *  Defines all possible exception that could occur in a SimGrid library.
12  */
13
14 #include <xbt/backtrace.hpp>
15 #include <xbt/ex.h>
16
17 #include <atomic>
18 #include <functional>
19 #include <stdexcept>
20 #include <string>
21
22 namespace simgrid {
23 namespace xbt {
24
25 /** Contextual information about an execution location (file:line:func and backtrace, procname, pid)
26  *
27  *  Constitute the contextual information of where an exception was thrown
28  *
29  *  These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid)
30  *  are best created with @ref XBT_THROW_POINT.
31  *
32  *  @ingroup XBT_ex
33  */
34 class ThrowPoint {
35 public:
36   ThrowPoint() = default;
37   explicit ThrowPoint(const char* file, int line, const char* function, Backtrace&& bt, std::string&& actor_name,
38                       int pid)
39       : file_(file)
40       , line_(line)
41       , function_(function)
42       , backtrace_(std::move(bt))
43       , procname_(std::move(actor_name))
44       , pid_(pid)
45   {
46   }
47
48   const char* file_     = nullptr;
49   int line_             = 0;
50   const char* function_ = nullptr;
51   Backtrace backtrace_;
52   std::string procname_ = ""; /**< Name of the process who thrown this */
53   int pid_              = 0;  /**< PID of the process who thrown this */
54 };
55
56 /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
57 #define XBT_THROW_POINT                                                                                                \
58   ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid())
59 } // namespace xbt
60
61 /** Ancestor class of all SimGrid exception */
62 class Exception : public std::runtime_error {
63 public:
64   Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
65       : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint))
66   {
67   }
68
69   /** Return the information about where the exception was thrown */
70   xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
71
72   std::string const resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
73
74 private:
75   xbt::ThrowPoint throwpoint_;
76 };
77
78 } // namespace simgrid
79
80 /** A legacy exception
81  *
82  *  It is defined by a category and a value within that category (as well as
83  *  an optional error message).
84  *
85  *  This used to be a structure for C exceptions but it has been retrofitted
86  *  as a C++ exception and some of its data has been moved in the
87  *  @ref WithContextException base class. We should deprecate it and replace it
88  *  with either C++ different exceptions or `std::system_error` which already
89  *  provides this (category + error code) logic.
90  *
91  *  @ingroup XBT_ex_c
92  */
93 class XBT_PUBLIC xbt_ex : public simgrid::Exception {
94 public:
95   /**
96    *
97    * @param throwpoint Throw point (use XBT_THROW_POINT)
98    * @param message    Exception message
99    */
100   xbt_ex(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
101       : simgrid::Exception(std::move(throwpoint), std::move(message))
102   {
103   }
104
105   xbt_ex(const xbt_ex&) = default;
106
107   ~xbt_ex(); // DO NOT define it here -- see ex.cpp for a rationale
108
109   /** Category (what went wrong) */
110   xbt_errcat_t category = unknown_error;
111
112   /** Why did it went wrong */
113   int value = 0;
114 };
115
116 namespace simgrid {
117
118 /** Exception raised when a timeout elapsed */
119 class TimeoutError : public xbt_ex {
120 public:
121   TimeoutError(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
122       : xbt_ex(std::move(throwpoint), std::move(message))
123   {
124     category = timeout_error;
125   }
126 };
127
128 /** Exception raised when a host fails */
129 class HostFailureException : public xbt_ex {
130 public:
131   HostFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
132       : xbt_ex(std::move(throwpoint), std::move(message))
133   {
134     category = host_error;
135   }
136 };
137
138 /** Exception raised when a communication fails because of the network or because of the remote host */
139 class NetworkFailureException : public xbt_ex {
140 public:
141   NetworkFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
142       : xbt_ex(std::move(throwpoint), std::move(message))
143   {
144     category = network_error;
145   }
146 };
147
148 /** Exception raised when a storage fails */
149 class StorageFailureException : public xbt_ex {
150 public:
151   StorageFailureException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
152       : xbt_ex(std::move(throwpoint), std::move(message))
153   {
154     category = io_error;
155   }
156 };
157
158 /** Exception raised when something got canceled before completion */
159 class CancelException : public xbt_ex {
160 public:
161   CancelException(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
162       : xbt_ex(std::move(throwpoint), std::move(message))
163   {
164     category = cancel_error;
165   }
166 };
167
168 class XBT_PUBLIC ForcefulKillException {
169   /** @brief Exception launched to kill an actor; DO NOT BLOCK IT!
170    *
171    * This exception is thrown whenever the actor's host is turned off. The actor stack is properly unwinded to release
172    * all objects allocated on the stack (RAII powa).
173    *
174    * You may want to catch this exception to perform some extra cleanups in your simulation, but YOUR ACTORS MUST NEVER
175    * SURVIVE a ForcefulKillException, or your simulation will segfault.
176    *
177    * @verbatim
178    * void* payload = malloc(512);
179    *
180    * try {
181    *   simgrid::s4u::this_actor::execute(100000);
182    * } catch (simgrid::kernel::context::ForcefulKillException& e) { // oops, my host just turned off
183    *   free(malloc);
184    *   throw; // I shall never survive on an host that was switched off
185    * }
186    * @endverbatim
187    */
188   /* Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
189    * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
190    */
191 public:
192   ForcefulKillException() = default;
193   explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
194   {
195   }
196   ~ForcefulKillException();
197   const char* what() const noexcept { return msg_.c_str(); }
198
199   XBT_ATTRIB_NORETURN static void do_throw();
200   static bool try_n_catch(const std::function<void()>& try_block);
201
202 private:
203   std::string msg_ = std::string("Actor killed.");
204 };
205
206 } // namespace simgrid
207
208 #endif