1 /* ex - Exception Handling */
3 /* Copyright (c) 2005-2013. The SimGrid Team. */
4 /* Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com> */
5 /* Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/> */
6 /* Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/> */
7 /* All rights reserved. */
9 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
10 /* It was heavily modified to fit the SimGrid framework. */
12 /* The OSSP version has the following copyright notice:
13 ** OSSP ex - Exception Handling
14 ** Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
15 ** Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
16 ** Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
18 ** This file is part of OSSP ex, an exception handling library
19 ** which can be found at http://www.ossp.org/pkg/lib/ex/.
21 ** Permission to use, copy, modify, and distribute this software for
22 ** any purpose with or without fee is hereby granted, provided that
23 ** the above copyright notice and this permission notice appear in all
26 ** THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
27 ** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
28 ** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 ** IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
30 ** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
33 ** USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
34 ** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
35 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
36 ** OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 /* The extensions made for the SimGrid project can either be distributed */
41 /* under the same license, or under the LGPL v2.1 */
46 #include "portable.h" /* execinfo when available */
49 #include "xbt/synchro_core.h"
50 #include "xbt_modinter.h" /* backtrace initialization headers */
52 #include "xbt/ex_interface.h"
55 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
56 # define HAVE_BACKTRACE 1 /* Hello linux box */
59 #if defined(_XBT_WIN32) && defined(_M_IX86) && !defined(__GNUC__)
60 # define HAVE_BACKTRACE 1 /* Hello x86 windows box */
64 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mecanism");
66 XBT_EXPORT_NO_IMPORT(const xbt_running_ctx_t) __xbt_ex_ctx_initializer = XBT_RUNNING_CTX_INITIALIZER;
68 /* default __ex_ctx callback function */
69 xbt_running_ctx_t *__xbt_ex_ctx_default(void)
71 /* Don't scream: this is a default which is never used (so, yes,
72 there is one setjump container by running entity).
74 This default gets overriden in xbt/xbt_os_thread.c so that it works in
75 real life and in simulation when using threads to implement the simulation
76 processes (ie, with pthreads and on windows).
78 It also gets overriden in xbt/context.c when using ucontexts (as well as
79 in Java for now, but after the java overhaul, it will get cleaned out)
81 static xbt_running_ctx_t ctx = XBT_RUNNING_CTX_INITIALIZER;
86 /* Change raw libc symbols to file names and line numbers */
87 void xbt_ex_setup_backtrace(xbt_ex_t * e);
89 void xbt_backtrace_display(xbt_ex_t * e)
91 xbt_ex_setup_backtrace(e);
95 fprintf(stderr, "(backtrace not set)\n");
99 fprintf(stderr, "Backtrace (displayed in thread %p):\n",
100 (void *) xbt_thread_self());
101 for (i = 1; i < e->used; i++) /* no need to display "xbt_backtrace_display" */
102 fprintf(stderr, "---> %s\n", e->bt_strings[i] + 4);
105 /* don't fool xbt_ex_free with uninitialized msg field */
110 XBT_ERROR("No backtrace on this arch");
114 /** \brief show the backtrace of the current point (lovely while debuging) */
115 void xbt_backtrace_display_current(void)
118 xbt_backtrace_current(&e);
119 xbt_backtrace_display(&e);
122 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
123 # include "backtrace_linux.c"
124 #elif (defined(_XBT_WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
125 # include "backtrace_windows.c"
127 # include "backtrace_dummy.c"
130 /** @brief shows an exception content and the associated stack if available */
131 void xbt_ex_display(xbt_ex_t * e)
133 char *thrower = NULL;
136 "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
138 "** Thrown by %s()%s\n",
139 xbt_binary_name, xbt_getpid(),
140 xbt_ex_catname(e->category), e->value, e->msg,
141 e->procname, thrower ? thrower : " in this process");
142 XBT_CRITICAL("%s", e->msg);
146 xbt_ex_setup_backtrace(e);
148 #ifdef HAVE_BACKTRACE
149 if (e->used && e->bt_strings) {
150 /* We have everything to build neat backtraces */
153 fprintf(stderr, "\n");
154 for (i = 0; i < e->used; i++)
155 fprintf(stderr, "%s\n", e->bt_strings[i]);
162 "** In %s() at %s:%d\n"
163 "** (no backtrace available)\n",
164 e->func, e->file, e->line);
169 /* default __ex_terminate callback function */
170 void __xbt_ex_terminate_default(xbt_ex_t * e)
176 /* the externally visible API */
177 XBT_EXPORT_NO_IMPORT(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
178 XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate =
179 &__xbt_ex_terminate_default;
182 void xbt_ex_free(xbt_ex_t e)
189 for (i = 0; i < e.used; i++)
190 free(e.bt_strings[i]);
193 /* memset(e,0,sizeof(xbt_ex_t)); */
196 /** \brief returns a short name for the given exception category */
197 const char *xbt_ex_catname(xbt_errcat_t cat)
201 return "unknown error";
203 return "invalid argument";
205 return "out of bounds";
208 case not_found_error:
211 return "system error";
213 return "network error";
217 return "action canceled";
219 return "thread error";
221 return "host failed";
223 return "tracing error";
230 return "INVALID ERROR";
238 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
240 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
245 xbt_test_add("basic nested control flow");
249 xbt_test_fail("M1: n=%d (!= 1)", n);
253 xbt_test_fail("M2: n=%d (!= 2)", n);
255 THROWF(unknown_error, 0, "something");
259 xbt_test_fail("M3: n=%d (!= 3)", n);
266 xbt_test_fail("M2: n=%d (!= 5)", n);
268 THROWF(unknown_error, 0, "something");
272 xbt_test_fail("M3: n=%d (!= 6)", n);
277 xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
281 xbt_test_fail("M4: n=%d (!= 7)", n);
286 xbt_test_fail("M5: n=%d (!= 8)", n);
289 XBT_TEST_UNIT("value", test_value, "exception value passing")
294 THROWF(unknown_error, 2, "toto");
297 xbt_test_add("exception value passing");
298 if (ex.category != unknown_error)
299 xbt_test_fail("category=%d (!= 1)", (int)ex.category);
301 xbt_test_fail("value=%d (!= 2)", ex.value);
302 if (strcmp(ex.msg, "toto"))
303 xbt_test_fail("message=%s (!= toto)", ex.msg);
308 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
312 int _XBT_GNUC_UNUSED r2;
316 r1 = r2 = v1 = v2 = 1234;
320 THROWF(unknown_error, 0, "toto");
323 xbt_test_add("variable preservation");
325 xbt_test_fail("r1=%d (!= 1234)", r1);
327 xbt_test_fail("v1=%d (!= 1234)", v1);
328 /* r2 is allowed to be destroyed because not volatile */
330 xbt_test_fail("v2=%d (!= 5678)", v2);
335 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
341 xbt_test_add("cleanup handling");
347 THROWF(1, 2, "blah");
351 xbt_test_fail("v1 = %d (!= 5678)", v1);
356 xbt_test_fail("v1 = %d (!= 5678)", v1);
357 if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg, "blah")))
358 xbt_test_fail("unexpected exception contents");
362 xbt_test_fail("xbt_ex_free not executed");
367 * The following is the example included in the documentation. It's a good
368 * idea to check its syntax even if we don't try to run it.
369 * And actually, it allows to put comments in the code despite doxygen.
371 static char *mallocex(int size)
376 #define SMALLAMOUNT 10
377 #define TOOBIG 100000000
379 #if 0 /* this contains syntax errors, actually */
380 static void bad_example(void)
389 char *cp1, *cp2, *cp3;
391 cp1 = mallocex(SMALLAMOUNT);
392 globalcontext->first = cp1;
393 cp2 = mallocex(TOOBIG);
394 cp3 = mallocex(SMALLAMOUNT);
404 printf("cp3=%s", cp3);
407 /* end_of_bad_example */
414 static void good_example(void)
416 global_context_t *global_context = xbt_malloc(sizeof(global_context_t));
420 char *volatile /*03 */ cp1 = NULL /*02 */ ;
421 char *volatile /*03 */ cp2 = NULL /*02 */ ;
422 char *volatile /*03 */ cp3 = NULL /*02 */ ;
424 cp1 = mallocex(SMALLAMOUNT);
425 global_context->first = cp1;
426 cp1 = NULL /*05 give away */ ;
427 cp2 = mallocex(TOOBIG);
428 cp3 = mallocex(SMALLAMOUNT);
432 TRY_CLEANUP { /*04 */
433 printf("cp3=%s", cp3 == NULL /*02 */ ? "" : cp3);
436 /*05 cp1 was given away */
439 /*05 global context untouched */
443 /* end_of_good_example */
445 #endif /* SIMGRID_TEST */