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 "src/internal_config.h" /* execinfo when available */
50 #include "xbt/backtrace.h"
52 #include "xbt/synchro_core.h"
53 #include "src/xbt_modinter.h" /* backtrace initialization headers */
55 #include "src/xbt/ex_interface.h"
56 #include "simgrid/sg_config.h" /* Configuration mechanism of SimGrid */
58 #include "simgrid/simix.h" /* SIMIX_process_self_get_name() */
60 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mechanism");
64 /* Change raw libc symbols to file names and line numbers */
65 void xbt_setup_backtrace(xbt_backtrace_location_t** loc, std::size_t count,
68 void xbt_backtrace_display(xbt_backtrace_location_t* loc, std::size_t count)
71 std::vector<std::string> backtrace =
72 simgrid::xbt::resolveBacktrace(loc, count);
73 if (backtrace.empty()) {
74 fprintf(stderr, "(backtrace not set)\n");
77 fprintf(stderr, "Backtrace (displayed in process %s):\n", SIMIX_process_self_get_name());
78 for (std::string const& s : backtrace)
79 fprintf(stderr, "---> %s\n", s.c_str());
81 XBT_ERROR("No backtrace on this arch");
86 char* message, xbt_errcat_t errcat, int value,
87 const char* file, int line, const char* func)
96 e.procname = xbt_procname();
101 /** @brief shows an exception content and the associated stack if available */
102 void xbt_ex_display(xbt_ex_t * e)
104 char *thrower = NULL;
105 if (e->pid != xbt_getpid())
106 thrower = bprintf(" on process %d",e->pid);
108 std::fprintf(stderr, "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
110 "** Thrown by %s()%s\n",
111 xbt_binary_name, xbt_getpid(), xbt_ex_catname(e->category), e->value, e->what(),
112 e->procname.c_str(), thrower ? thrower : " in this process");
113 XBT_CRITICAL("%s", e->what());
116 if (xbt_initialized==0 || smx_cleaned) {
117 fprintf(stderr, "Ouch. SimGrid is not initialized yet, or already closing. No backtrace available.\n");
118 return; /* Not started yet or already closing. Trying to generate a backtrace would probably fail */
121 std::vector<std::string> backtrace = simgrid::xbt::resolveBacktrace(
122 e->bt.data(), e->bt.size());
124 #ifdef HAVE_BACKTRACE
125 if (!backtrace.empty()) {
126 /* We have everything to build neat backtraces */
128 try { // We don't want to have an exception while checking how to deal with the one we already have, do we?
129 cutpath = xbt_cfg_get_boolean("exception/cutpath");
135 std::fprintf(stderr, "\n");
136 for (std::string const& s : backtrace) {
138 // TODO, move this logic into solveBacktrace
140 // TODO, simplify this
141 char* p = xbt_strdup(s.c_str());
142 xbt_str_rtrim(p, ":0123456789");
143 char* filename = strrchr(p, '/')+1;
144 char* end_of_message = strrchr(p, ' ');
145 int length = strlen(p)-strlen(end_of_message);
146 char* dest = (char*) std::malloc(length);
147 std::memcpy(dest, &p[0], length);
149 std::fprintf(stderr, "%s %s\n", dest, filename);
154 std::fprintf(stderr, "%s\n", s.c_str());
159 std::fprintf(stderr, "\n"
160 "** In %s() at %s:%d\n"
161 "** (no backtrace available)\n", e->func, e->file, e->line);
164 /** \brief returns a short name for the given exception category */
165 const char *xbt_ex_catname(xbt_errcat_t cat)
169 return "unknown error";
171 return "invalid argument";
173 return "out of bounds";
176 case not_found_error:
179 return "system error";
181 return "network error";
185 return "action canceled";
187 return "thread error";
189 return "host failed";
191 return "tracing error";
197 return "INVALID ERROR";
204 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
206 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
211 xbt_test_add("basic nested control flow");
215 xbt_test_fail("M1: n=%d (!= 1)", n);
219 xbt_test_fail("M2: n=%d (!= 2)", n);
221 THROWF(unknown_error, 0, "something");
225 xbt_test_fail("M3: n=%d (!= 3)", n);
231 xbt_test_fail("M2: n=%d (!= 5)", n);
233 THROWF(unknown_error, 0, "something");
237 xbt_test_fail("M3: n=%d (!= 6)", n);
242 xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
246 xbt_test_fail("M4: n=%d (!= 7)", n);
250 xbt_test_fail("M5: n=%d (!= 8)", n);
253 XBT_TEST_UNIT("value", test_value, "exception value passing")
256 THROWF(unknown_error, 2, "toto");
259 xbt_test_add("exception value passing");
260 if (ex.category != unknown_error)
261 xbt_test_fail("category=%d (!= 1)", (int)ex.category);
263 xbt_test_fail("value=%d (!= 2)", ex.value);
264 if (strcmp(ex.what(), "toto"))
265 xbt_test_fail("message=%s (!= toto)", ex.what());
269 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
273 int XBT_ATTRIB_UNUSED r2;
277 r1 = r2 = v1 = v2 = 1234;
281 THROWF(unknown_error, 0, "toto");
284 xbt_test_add("variable preservation");
286 xbt_test_fail("r1=%d (!= 1234)", r1);
288 xbt_test_fail("v1=%d (!= 1234)", v1);
289 /* r2 is allowed to be destroyed because not volatile */
291 xbt_test_fail("v2=%d (!= 5678)", v2);
295 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
300 xbt_test_add("cleanup handling");
306 THROWF(1, 2, "blah");
310 xbt_test_fail("v1 = %d (!= 5678)", v1);
313 xbt_test_fail("v1 = %d (!= 5678)", v1);
314 if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.what(), "blah")))
315 xbt_test_fail("unexpected exception contents");
318 xbt_test_fail("xbt_ex_free not executed");
320 #endif /* SIMGRID_TEST */