1 /* ex - Exception Handling */
3 /* Copyright (c) 2005-2015. The SimGrid Team.
4 * All rights reserved. */
6 /* Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com> */
7 /* Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/> */
8 /* Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/> */
9 /* All rights reserved. */
11 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
12 /* It was heavily modified to fit the SimGrid framework. */
14 /* The OSSP version has the following copyright notice:
15 ** OSSP ex - Exception Handling
16 ** Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
17 ** Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
18 ** Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
20 ** This file is part of OSSP ex, an exception handling library
21 ** which can be found at http://www.ossp.org/pkg/lib/ex/.
23 ** Permission to use, copy, modify, and distribute this software for
24 ** any purpose with or without fee is hereby granted, provided that
25 ** the above copyright notice and this permission notice appear in all
28 ** THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
29 ** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30 ** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31 ** IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
32 ** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
35 ** USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
36 ** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
37 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
38 ** OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 /* The extensions made for the SimGrid project can either be distributed */
43 /* under the same license, or under the LGPL v2.1 */
48 #include <xbt/backtrace.hpp>
49 #include "src/internal_config.h" /* execinfo when available */
53 #include "xbt/log.hpp"
54 #include "xbt/backtrace.h"
55 #include "xbt/backtrace.hpp"
57 #include "src/xbt_modinter.h" /* backtrace initialization headers */
59 #include "src/xbt/ex_interface.h"
60 #include "simgrid/sg_config.h" /* Configuration mechanism of SimGrid */
62 #include "simgrid/simix.h" /* SIMIX_process_self_get_name() */
65 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mechanism");
69 /* Change raw libc symbols to file names and line numbers */
70 void xbt_setup_backtrace(xbt_backtrace_location_t** loc, std::size_t count,
73 void xbt_backtrace_display(xbt_backtrace_location_t* loc, std::size_t count)
76 std::vector<std::string> backtrace =
77 simgrid::xbt::resolveBacktrace(loc, count);
78 if (backtrace.empty()) {
79 fprintf(stderr, "(backtrace not set)\n");
82 fprintf(stderr, "Backtrace (displayed in process %s):\n", SIMIX_process_self_get_name());
83 for (std::string const& s : backtrace)
84 fprintf(stderr, "---> %s\n", s.c_str());
86 XBT_ERROR("No backtrace on this arch");
91 char* message, xbt_errcat_t errcat, int value,
92 const char* file, int line, const char* func)
94 xbt_ex e(simgrid::xbt::ThrowPoint(file, line, func), message);
101 /** @brief shows an exception content and the associated stack if available */
102 void xbt_ex_display(xbt_ex_t * e)
104 simgrid::xbt::logException(xbt_log_priority_critical, "UNCAUGHT EXCEPTION", *e);
107 /** \brief returns a short name for the given exception category */
108 const char *xbt_ex_catname(xbt_errcat_t cat)
112 return "unknown error";
114 return "invalid argument";
116 return "out of bounds";
119 case not_found_error:
122 return "system error";
124 return "network error";
128 return "action canceled";
130 return "thread error";
132 return "host failed";
134 return "tracing error";
140 return "INVALID ERROR";
146 #include <xbt/ex.hpp>
148 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
150 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
155 xbt_test_add("basic nested control flow");
159 xbt_test_fail("M1: n=%d (!= 1)", n);
163 xbt_test_fail("M2: n=%d (!= 2)", n);
165 THROWF(unknown_error, 0, "something");
169 xbt_test_fail("M3: n=%d (!= 3)", n);
175 xbt_test_fail("M2: n=%d (!= 5)", n);
177 THROWF(unknown_error, 0, "something");
181 xbt_test_fail("M3: n=%d (!= 6)", n);
186 xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
190 xbt_test_fail("M4: n=%d (!= 7)", n);
194 xbt_test_fail("M5: n=%d (!= 8)", n);
197 XBT_TEST_UNIT("value", test_value, "exception value passing")
200 THROWF(unknown_error, 2, "toto");
203 xbt_test_add("exception value passing");
204 if (ex.category != unknown_error)
205 xbt_test_fail("category=%d (!= 1)", (int)ex.category);
207 xbt_test_fail("value=%d (!= 2)", ex.value);
208 if (strcmp(ex.what(), "toto"))
209 xbt_test_fail("message=%s (!= toto)", ex.what());
213 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
217 int XBT_ATTRIB_UNUSED r2;
221 r1 = r2 = v1 = v2 = 1234;
225 THROWF(unknown_error, 0, "toto");
228 xbt_test_add("variable preservation");
230 xbt_test_fail("r1=%d (!= 1234)", r1);
232 xbt_test_fail("v1=%d (!= 1234)", v1);
233 /* r2 is allowed to be destroyed because not volatile */
235 xbt_test_fail("v2=%d (!= 5678)", v2);
239 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
244 xbt_test_add("cleanup handling");
250 THROWF(1, 2, "blah");
254 xbt_test_fail("v1 = %d (!= 5678)", v1);
257 xbt_test_fail("v1 = %d (!= 5678)", v1);
258 if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.what(), "blah")))
259 xbt_test_fail("unexpected exception contents");
262 xbt_test_fail("xbt_ex_free not executed");
264 #endif /* SIMGRID_TEST */