1 /* ex - Exception Handling */
3 /* Copyright (c) 2005-2017. The SimGrid Team. All rights reserved. */
5 /* Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com> */
6 /* Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/> */
7 /* Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/> */
8 /* All rights reserved. */
10 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
11 /* It was heavily modified to fit the SimGrid framework. */
13 /* The OSSP version has the following copyright notice:
14 ** OSSP ex - Exception Handling
15 ** Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
16 ** Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
17 ** Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
19 ** This file is part of OSSP ex, an exception handling library
20 ** which can be found at http://www.ossp.org/pkg/lib/ex/.
22 ** Permission to use, copy, modify, and distribute this software for
23 ** any purpose with or without fee is hereby granted, provided that
24 ** the above copyright notice and this permission notice appear in all
27 ** THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
28 ** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
29 ** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30 ** IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
31 ** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
34 ** USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35 ** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
37 ** OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 /* The extensions made for the SimGrid project can either be distributed */
42 /* under the same license, or under the LGPL v2.1 */
47 #include <xbt/backtrace.hpp>
48 #include "src/internal_config.h" /* execinfo when available */
52 #include "xbt/log.hpp"
53 #include "xbt/backtrace.h"
54 #include "xbt/backtrace.hpp"
55 #include "src/xbt_modinter.h" /* backtrace initialization headers */
57 #include "simgrid/sg_config.h" /* Configuration mechanism of SimGrid */
59 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mechanism");
61 // Don't define ~xbt_ex() in ex.hpp. It is defined here to ensure that there is an unique definition of xt_ex in
62 // libsimgrid, but not in libsimgrid-java. Otherwise, sone tests are broken (seen with clang/libc++ on freebsd).
63 xbt_ex::~xbt_ex() = default;
65 void _xbt_throw(char* message, xbt_errcat_t errcat, int value, const char* file, int line, const char* func)
67 xbt_ex e(simgrid::xbt::ThrowPoint(file, line, func), message);
74 /** @brief shows an exception content and the associated stack if available */
75 void xbt_ex_display(xbt_ex_t * e)
77 simgrid::xbt::logException(xbt_log_priority_critical, "UNCAUGHT EXCEPTION", *e);
80 /** \brief returns a short name for the given exception category */
81 const char *xbt_ex_catname(xbt_errcat_t cat)
85 return "unknown error";
87 return "invalid argument";
89 return "out of bounds";
95 return "system error";
97 return "network error";
101 return "action canceled";
103 return "thread error";
105 return "host failed";
107 return "tracing error";
113 return "INVALID ERROR";
115 return "INVALID ERROR";
121 #include <xbt/ex.hpp>
123 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
125 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
130 xbt_test_add("basic nested control flow");
134 xbt_test_fail("M1: n=%d (!= 1)", n);
138 xbt_test_fail("M2: n=%d (!= 2)", n);
140 THROWF(unknown_error, 0, "something");
144 xbt_test_fail("M3: n=%d (!= 3)", n);
150 xbt_test_fail("M2: n=%d (!= 5)", n);
152 THROWF(unknown_error, 0, "something");
156 xbt_test_fail("M3: n=%d (!= 6)", n);
161 xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
165 xbt_test_fail("M4: n=%d (!= 7)", n);
169 xbt_test_fail("M5: n=%d (!= 8)", n);
172 XBT_TEST_UNIT("value", test_value, "exception value passing")
175 THROWF(unknown_error, 2, "toto");
178 xbt_test_add("exception value passing");
179 if (ex.category != unknown_error)
180 xbt_test_fail("category=%d (!= 1)", (int)ex.category);
182 xbt_test_fail("value=%d (!= 2)", ex.value);
183 if (strcmp(ex.what(), "toto"))
184 xbt_test_fail("message=%s (!= toto)", ex.what());
188 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
192 int XBT_ATTRIB_UNUSED r2;
196 r1 = r2 = v1 = v2 = 1234;
200 THROWF(unknown_error, 0, "toto");
203 xbt_test_add("variable preservation");
205 xbt_test_fail("r1=%d (!= 1234)", r1);
207 xbt_test_fail("v1=%d (!= 1234)", v1);
208 /* r2 is allowed to be destroyed because not volatile */
210 xbt_test_fail("v2=%d (!= 5678)", v2);
214 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
219 xbt_test_add("cleanup handling");
225 THROWF(1, 2, "blah");
229 xbt_test_fail("v1 = %d (!= 5678)", v1);
232 xbt_test_fail("v1 = %d (!= 5678)", v1);
233 if (not(ex.category == 1 && ex.value == 2 && not strcmp(ex.what(), "blah")))
234 xbt_test_fail("unexpected exception contents");
237 xbt_test_fail("xbt_ex_free not executed");
239 #endif /* SIMGRID_TEST */