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 */
51 #include "xbt/synchro.h" /* xbt_thread_self */
53 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
54 #include "xbt/ex_interface.h"
57 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
58 # define HAVE_BACKTRACE 1 /* Hello linux box */
61 #if defined(_XBT_WIN32) && defined(_M_IX86) && !defined(__GNUC__)
62 # define HAVE_BACKTRACE 1 /* Hello x86 windows box */
66 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mecanism");
68 XBT_EXPORT_NO_IMPORT(const xbt_running_ctx_t) __xbt_ex_ctx_initializer = XBT_RUNNING_CTX_INITIALIZER;
70 /* default __ex_ctx callback function */
71 xbt_running_ctx_t *__xbt_ex_ctx_default(void)
73 /* Don't scream: this is a default which is never used (so, yes,
74 there is one setjump container by running entity).
76 This default gets overriden in xbt/xbt_os_thread.c so that it works in
77 real life and in simulation when using threads to implement the simulation
78 processes (ie, with pthreads and on windows).
80 It also gets overriden in xbt/context.c when using ucontextes (as well as
81 in Java for now, but after the java overhaul, it will get cleaned out)
83 static xbt_running_ctx_t ctx = XBT_RUNNING_CTX_INITIALIZER;
88 /* Change raw libc symbols to file names and line numbers */
89 void xbt_ex_setup_backtrace(xbt_ex_t * e);
91 void xbt_backtrace_display(xbt_ex_t * e)
93 xbt_ex_setup_backtrace(e);
97 fprintf(stderr, "(backtrace not set)\n");
101 fprintf(stderr, "Backtrace (displayed in thread %p):\n",
102 (void *) xbt_thread_self());
103 for (i = 1; i < e->used; i++) /* no need to display "xbt_backtrace_display" */
104 fprintf(stderr, "---> %s\n", e->bt_strings[i] + 4);
107 /* don't fool xbt_ex_free with uninitialized msg field */
113 XBT_ERROR("No backtrace on this arch");
117 /** \brief show the backtrace of the current point (lovely while debuging) */
118 void xbt_backtrace_display_current(void)
121 xbt_backtrace_current(&e);
122 xbt_backtrace_display(&e);
125 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
126 # include "backtrace_linux.c"
127 #elif (defined(_XBT_WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
128 # include "backtrace_windows.c"
130 # include "backtrace_dummy.c"
133 /** @brief shows an exception content and the associated stack if available */
134 void xbt_ex_display(xbt_ex_t * e)
136 char *thrower = NULL;
139 thrower = bprintf(" on host %s(%d)", e->host, e->pid);
142 "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
144 "** Thrown by %s()%s\n",
145 gras_os_myname(), xbt_getpid(),
146 xbt_ex_catname(e->category), e->value, e->msg,
147 e->procname, thrower ? thrower : " in this process");
148 XBT_CRITICAL("%s", e->msg);
151 if (!e->remote && !e->bt_strings)
152 xbt_ex_setup_backtrace(e);
154 #ifdef HAVE_BACKTRACE
155 if (e->used && e->bt_strings) {
156 /* We have everything to build neat backtraces */
159 fprintf(stderr, "\n");
160 for (i = 0; i < e->used; i++)
161 fprintf(stderr, "%s\n", e->bt_strings[i]);
168 "** In %s() at %s:%d\n"
169 "** (no backtrace available)\n",
170 e->func, e->file, e->line);
175 /* default __ex_terminate callback function */
176 void __xbt_ex_terminate_default(xbt_ex_t * e)
183 /* the externally visible API */
184 XBT_EXPORT_NO_IMPORT(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
185 XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate =
186 &__xbt_ex_terminate_default;
189 void xbt_ex_free(xbt_ex_t e)
202 for (i = 0; i < e.used; i++)
203 free(e.bt_strings[i]);
206 /* memset(e,0,sizeof(xbt_ex_t)); */
209 /** \brief returns a short name for the given exception category */
210 const char *xbt_ex_catname(xbt_errcat_t cat)
214 return "unknown error";
216 return "invalid argument";
218 return "out of bounds";
221 case not_found_error:
224 return "system error";
226 return "network error";
230 return "action canceled";
232 return "thread error";
234 return "host failed";
236 return "tracing error";
240 return "INVALID ERROR";
248 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
250 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
255 xbt_test_add("basic nested control flow");
259 xbt_test_fail("M1: n=%d (!= 1)", n);
263 xbt_test_fail("M2: n=%d (!= 2)", n);
265 THROWF(unknown_error, 0, "something");
269 xbt_test_fail("M3: n=%d (!= 3)", n);
276 xbt_test_fail("M2: n=%d (!= 5)", n);
278 THROWF(unknown_error, 0, "something");
282 xbt_test_fail("M3: n=%d (!= 6)", n);
287 xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
291 xbt_test_fail("M4: n=%d (!= 7)", n);
296 xbt_test_fail("M5: n=%d (!= 8)", n);
299 XBT_TEST_UNIT("value", test_value, "exception value passing")
304 THROWF(unknown_error, 2, "toto");
307 xbt_test_add("exception value passing");
308 if (ex.category != unknown_error)
309 xbt_test_fail("category=%d (!= 1)", (int)ex.category);
311 xbt_test_fail("value=%d (!= 2)", ex.value);
312 if (strcmp(ex.msg, "toto"))
313 xbt_test_fail("message=%s (!= toto)", ex.msg);
318 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
322 int _XBT_GNUC_UNUSED r2;
325 r1 = r2 = v1 = v2 = 1234;
329 THROWF(unknown_error, 0, "toto");
332 xbt_test_add("variable preservation");
334 xbt_test_fail("r1=%d (!= 1234)", r1);
336 xbt_test_fail("v1=%d (!= 1234)", v1);
337 /* r2 is allowed to be destroyed because not volatile */
339 xbt_test_fail("v2=%d (!= 5678)", v2);
344 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
350 xbt_test_add("cleanup handling");
356 THROWF(1, 2, "blah");
360 xbt_test_fail("v1 = %d (!= 5678)", v1);
365 xbt_test_fail("v1 = %d (!= 5678)", v1);
366 if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg, "blah")))
367 xbt_test_fail("unexpected exception contents");
371 xbt_test_fail("xbt_ex_free not executed");
376 * The following is the example included in the documentation. It's a good
377 * idea to check its syntax even if we don't try to run it.
378 * And actually, it allows to put comments in the code despite doxygen.
380 static char *mallocex(int size)
385 #define SMALLAMOUNT 10
386 #define TOOBIG 100000000
388 #if 0 /* this contains syntax errors, actually */
389 static void bad_example(void)
398 char *cp1, *cp2, *cp3;
400 cp1 = mallocex(SMALLAMOUNT);
401 globalcontext->first = cp1;
402 cp2 = mallocex(TOOBIG);
403 cp3 = mallocex(SMALLAMOUNT);
413 printf("cp3=%s", cp3);
416 /* end_of_bad_example */
423 static void good_example(void)
425 global_context_t *global_context = malloc(sizeof(global_context_t));
429 char *volatile /*03 */ cp1 = NULL /*02 */ ;
430 char *volatile /*03 */ cp2 = NULL /*02 */ ;
431 char *volatile /*03 */ cp3 = NULL /*02 */ ;
433 cp1 = mallocex(SMALLAMOUNT);
434 global_context->first = cp1;
435 cp1 = NULL /*05 give away */ ;
436 cp2 = mallocex(TOOBIG);
437 cp3 = mallocex(SMALLAMOUNT);
441 TRY_CLEANUP { /*04 */
442 printf("cp3=%s", cp3 == NULL /*02 */ ? "" : cp3);
445 /*05 cp1 was given away */
448 /*05 global context untouched */
452 /* end_of_good_example */
454 #endif /* SIMGRID_TEST */