1 /* ex - Exception Handling */
3 /* Copyright (c) 2005-2010 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/module.h" /* xbt_binary_name */
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 ucontextes (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 */
111 XBT_ERROR("No backtrace on this arch");
115 /** \brief show the backtrace of the current point (lovely while debuging) */
116 void xbt_backtrace_display_current(void)
119 xbt_backtrace_current(&e);
120 xbt_backtrace_display(&e);
123 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
124 # include "backtrace_linux.c"
125 #elif (defined(_XBT_WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
126 # include "backtrace_windows.c"
128 # include "backtrace_dummy.c"
131 /** @brief shows an exception content and the associated stack if available */
132 void xbt_ex_display(xbt_ex_t * e)
134 char *thrower = NULL;
137 thrower = bprintf(" on host %s(%d)", e->host, e->pid);
140 "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
142 "** Thrown by %s()%s\n",
143 xbt_os_procname(), xbt_getpid(),
144 xbt_ex_catname(e->category), e->value, e->msg,
145 e->procname, thrower ? thrower : " in this process");
146 XBT_CRITICAL("%s", e->msg);
149 if (!e->remote && !e->bt_strings)
150 xbt_ex_setup_backtrace(e);
152 #ifdef HAVE_BACKTRACE
153 if (e->used && e->bt_strings) {
154 /* We have everything to build neat backtraces */
157 fprintf(stderr, "\n");
158 for (i = 0; i < e->used; i++)
159 fprintf(stderr, "%s\n", e->bt_strings[i]);
166 "** In %s() at %s:%d\n"
167 "** (no backtrace available)\n",
168 e->func, e->file, e->line);
173 /* default __ex_terminate callback function */
174 void __xbt_ex_terminate_default(xbt_ex_t * e)
180 /* the externally visible API */
181 XBT_EXPORT_NO_IMPORT(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
182 XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate =
183 &__xbt_ex_terminate_default;
186 void xbt_ex_free(xbt_ex_t e)
199 for (i = 0; i < e.used; i++)
200 free(e.bt_strings[i]);
203 /* memset(e,0,sizeof(xbt_ex_t)); */
206 /** \brief returns a short name for the given exception category */
207 const char *xbt_ex_catname(xbt_errcat_t cat)
211 return "unknown error";
213 return "invalid argument";
215 return "out of bounds";
218 case not_found_error:
221 return "system error";
223 return "network error";
227 return "action canceled";
229 return "thread error";
231 return "host failed";
233 return "tracing error";
237 return "INVALID ERROR";
245 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
247 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
252 xbt_test_add("basic nested control flow");
256 xbt_test_fail("M1: n=%d (!= 1)", n);
260 xbt_test_fail("M2: n=%d (!= 2)", n);
262 THROWF(unknown_error, 0, "something");
266 xbt_test_fail("M3: n=%d (!= 3)", n);
273 xbt_test_fail("M2: n=%d (!= 5)", n);
275 THROWF(unknown_error, 0, "something");
279 xbt_test_fail("M3: n=%d (!= 6)", n);
284 xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
288 xbt_test_fail("M4: n=%d (!= 7)", n);
293 xbt_test_fail("M5: n=%d (!= 8)", n);
296 XBT_TEST_UNIT("value", test_value, "exception value passing")
301 THROWF(unknown_error, 2, "toto");
304 xbt_test_add("exception value passing");
305 if (ex.category != unknown_error)
306 xbt_test_fail("category=%d (!= 1)", (int)ex.category);
308 xbt_test_fail("value=%d (!= 2)", ex.value);
309 if (strcmp(ex.msg, "toto"))
310 xbt_test_fail("message=%s (!= toto)", ex.msg);
315 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
319 int _XBT_GNUC_UNUSED r2;
322 r1 = r2 = v1 = v2 = 1234;
326 THROWF(unknown_error, 0, "toto");
329 xbt_test_add("variable preservation");
331 xbt_test_fail("r1=%d (!= 1234)", r1);
333 xbt_test_fail("v1=%d (!= 1234)", v1);
334 /* r2 is allowed to be destroyed because not volatile */
336 xbt_test_fail("v2=%d (!= 5678)", v2);
341 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
347 xbt_test_add("cleanup handling");
353 THROWF(1, 2, "blah");
357 xbt_test_fail("v1 = %d (!= 5678)", v1);
362 xbt_test_fail("v1 = %d (!= 5678)", v1);
363 if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg, "blah")))
364 xbt_test_fail("unexpected exception contents");
368 xbt_test_fail("xbt_ex_free not executed");
373 * The following is the example included in the documentation. It's a good
374 * idea to check its syntax even if we don't try to run it.
375 * And actually, it allows to put comments in the code despite doxygen.
377 static char *mallocex(int size)
382 #define SMALLAMOUNT 10
383 #define TOOBIG 100000000
385 #if 0 /* this contains syntax errors, actually */
386 static void bad_example(void)
395 char *cp1, *cp2, *cp3;
397 cp1 = mallocex(SMALLAMOUNT);
398 globalcontext->first = cp1;
399 cp2 = mallocex(TOOBIG);
400 cp3 = mallocex(SMALLAMOUNT);
410 printf("cp3=%s", cp3);
413 /* end_of_bad_example */
420 static void good_example(void)
422 global_context_t *global_context = malloc(sizeof(global_context_t));
426 char *volatile /*03 */ cp1 = NULL /*02 */ ;
427 char *volatile /*03 */ cp2 = NULL /*02 */ ;
428 char *volatile /*03 */ cp3 = NULL /*02 */ ;
430 cp1 = mallocex(SMALLAMOUNT);
431 global_context->first = cp1;
432 cp1 = NULL /*05 give away */ ;
433 cp2 = mallocex(TOOBIG);
434 cp3 = mallocex(SMALLAMOUNT);
438 TRY_CLEANUP { /*04 */
439 printf("cp3=%s", cp3 == NULL /*02 */ ? "" : cp3);
442 /*05 cp1 was given away */
445 /*05 global context untouched */
449 /* end_of_good_example */
451 #endif /* SIMGRID_TEST */