X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e40d8a3c090b9106352693e52ea61e63ecbbe93d..cc375ad134c19925e1e343bae932be21cf8a8caf:/src/xbt/ex.c diff --git a/src/xbt/ex.c b/src/xbt/ex.c index b92e0c1caa..ac2fa9b01b 100644 --- a/src/xbt/ex.c +++ b/src/xbt/ex.c @@ -1,6 +1,16 @@ -/* -** OSSP ex - Exception Handling (modified to fit into SimGrid) -** Copyright (c) 2005 Martin Quinson +/* ex - Exception Handling */ + +/* Copyright (c) 2005-2010 The SimGrid team */ +/* Copyright (c) 2002-2004 Ralf S. Engelschall */ +/* Copyright (c) 2002-2004 The OSSP Project */ +/* Copyright (c) 2002-2004 Cable & Wireless */ +/* All rights reserved. */ + +/* This code is inspirated from the OSSP version (as retrieved back in 2004)*/ +/* It was heavily modified to fit the SimGrid framework. */ + +/* The OSSP version has the following copyright notice: +** OSSP ex - Exception Handling ** Copyright (c) 2002-2004 Ralf S. Engelschall ** Copyright (c) 2002-2004 The OSSP Project ** Copyright (c) 2002-2004 Cable & Wireless @@ -13,7 +23,7 @@ ** the above copyright notice and this permission notice appear in all ** copies. ** -** THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED +** THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED ** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF ** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ** IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR @@ -25,449 +35,407 @@ ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT ** OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF ** SUCH DAMAGE. -** -** ex.c: exception handling (compiler part) -*/ + */ + +/* The extensions made for the SimGrid project can either be distributed */ +/* under the same license, or under the LGPL v2.1 */ #include #include -#include "portable.h" /* execinfo when available */ +#include "portable.h" /* execinfo when available */ #include "xbt/ex.h" -#include "xbt/module.h" /* xbt_binary_name */ +#include "xbt/str.h" +#include "xbt_modinter.h" /* backtrace initialization headers */ + #include "xbt/ex_interface.h" -#include "gras/Virtu/virtu_interface.h" /* gras_os_myname */ +#undef HAVE_BACKTRACE +#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE) +# define HAVE_BACKTRACE 1 /* Hello linux box */ +#endif + +#if defined(_XBT_WIN32) && defined(_M_IX86) && !defined(__GNUC__) +# define HAVE_BACKTRACE 1 /* Hello x86 windows box */ +#endif + + +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mecanism"); + +XBT_EXPORT_NO_IMPORT(const xbt_running_ctx_t) __xbt_ex_ctx_initializer = XBT_RUNNING_CTX_INITIALIZER; /* default __ex_ctx callback function */ -ex_ctx_t *__xbt_ex_ctx_default(void) { - static ex_ctx_t ctx = XBT_CTX_INITIALIZER; +xbt_running_ctx_t *__xbt_ex_ctx_default(void) +{ + /* Don't scream: this is a default which is never used (so, yes, + there is one setjump container by running entity). - return &ctx; + This default gets overriden in xbt/xbt_os_thread.c so that it works in + real life and in simulation when using threads to implement the simulation + processes (ie, with pthreads and on windows). + + It also gets overriden in xbt/context.c when using ucontextes (as well as + in Java for now, but after the java overhaul, it will get cleaned out) + */ + static xbt_running_ctx_t ctx = XBT_RUNNING_CTX_INITIALIZER; + + return &ctx; } +/* Change raw libc symbols to file names and line numbers */ +void xbt_ex_setup_backtrace(xbt_ex_t * e); -/** \brief show the backtrace of the current point (lovely while debuging) */ -void xbt_backtrace_display(void) { -#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE) - xbt_ex_t e; - int i; +void xbt_backtrace_display(xbt_ex_t * e) +{ + xbt_ex_setup_backtrace(e); + +#ifdef HAVE_BACKTRACE + if (e->used == 0) { + fprintf(stderr, "(backtrace not set)\n"); + } else { + int i; - e.used = backtrace((void**)e.bt,XBT_BACKTRACE_SIZE); - e.bt_strings = NULL; - xbt_ex_setup_backtrace(&e); - for (i=1; iused; i++) /* no need to display "xbt_backtrace_display" */ + fprintf(stderr, "---> %s\n", e->bt_strings[i] + 4); + } + + /* don't fool xbt_ex_free with uninitialized msg field */ + e->msg = NULL; + xbt_ex_free(*e); +#else + + XBT_ERROR("No backtrace on this arch"); #endif } -void xbt_ex_setup_backtrace(xbt_ex_t *e) { +/** \brief show the backtrace of the current point (lovely while debuging) */ +void xbt_backtrace_display_current(void) +{ + xbt_ex_t e; + xbt_backtrace_current(&e); + xbt_backtrace_display(&e); +} + #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE) - int i; - /* to get the backtrace from the libc */ - char **backtrace = backtrace_symbols (e->bt, e->used); - - /* To build the commandline of addr2line */ - char *cmd = xbt_new(char,strlen(ADDR2LINE)+strlen(xbt_binary_name)+20*e->used); - char *curr=cmd; - - /* to extract the addresses from the backtrace */ - char **addrs=xbt_new(char*,e->used); - char buff[256],*p; - - /* To read the output of addr2line */ - FILE *pipe; - char line_func[1024],line_pos[1024]; - - /* size (in char) of pointers on this arch */ - int addr_len=0; - - /* build the commandline */ - curr += sprintf(curr,"%s -f -e %s ",ADDR2LINE,xbt_binary_name); - for (i=0; iused;i++) { - /* retrieve this address */ - snprintf(buff,256,"%s",strchr(backtrace[i],'[')+1); - p=strchr(buff,']'); - *p='\0'; - addrs[i]=bprintf("%s",buff); - - /* Add it to the command line args */ - curr+=sprintf(curr,"%s ",addrs[i]); - } - addr_len = strlen(addrs[0]); - - /* parse the output and build a new backtrace */ - e->bt_strings = xbt_new(char*,e->used); - - pipe = popen(cmd, "r"); - // xbt_assert(pipe);//,"Cannot fork addr2line to display the backtrace"); - for (i=0; iused; i++) { - fgets(line_func,1024,pipe); - line_func[strlen(line_func)-1]='\0'; - fgets(line_pos,1024,pipe); - line_pos[strlen(line_pos)-1]='\0'; - - if (strcmp("??",line_func)) { - e->bt_strings[i] = bprintf("** At %s: %s (%s)", - addrs[i], line_func,line_pos); - } else { - /* Damn. The symbol is in a dynamic library. Let's get wild */ - char *maps_name; - FILE *maps; - char maps_buff[512]; - - long int addr,offset,offset_save; - char *p,*p2; - - char *subcmd; - FILE *subpipe; - int found=0; - - /* let's look for the offset of this library in our addressing space */ - maps_name=bprintf("/proc/%d/maps",(int)getpid()); - maps=fopen(maps_name,"r"); - - addr=strtol(addrs[i]+2, NULL,16); - - while (!found) { - if (fgets(maps_buff,512,maps) == NULL) - break; - offset_save = offset; - offset=strtol(maps_buff,NULL,16); - if (offset > addr) - found=1; - } - - fclose(maps); - free(maps_name); - - /* Ok, the maps line we just read is beyond the searched symbol. Got it, - the symbol is in previous map, which offset is in offset_save. - We now need to substract this from the address we got from backtrace. - */ - offset=offset_save; - - free(addrs[i]); - addrs[i] = bprintf("0x%0*lx",addr_len-2,addr-offset); - - /* Got it. We have our new address. Let's get the library path and we - are set */ - p = xbt_strdup(backtrace[i]); - p2 = strrchr(p,'('); - if (p2) *p2= '\0'; - p2 = strrchr(p,' '); - if (p2) *p2= '\0'; - - /* Here we go, fire an addr2line up */ - subcmd = bprintf("%s -f -e %s %s",ADDR2LINE,p, addrs[i]); - free(p); - subpipe = popen(subcmd,"r"); - fgets(line_func,1024,subpipe); - line_func[strlen(line_func)-1]='\0'; - fgets(line_pos,1024,subpipe); - line_pos[strlen(line_pos)-1]='\0'; - pclose(subpipe); - free(subcmd); - - /* check whether the trick worked */ - if (strcmp("??",line_func)) { - e->bt_strings[i] = bprintf("** At %s: %s (%s)", - addrs[i], line_func,line_pos); - } else { - /* damn, nothing to do here. Let's print the raw address */ - p = bprintf("%s",backtrace[i]); - p2 = strrchr(p,' '); - *p2= '\0'; - e->bt_strings[i] = bprintf("** At %s: ?? (%s)", addrs[i], p); - free(p); - } - } - free(addrs[i]); - } - pclose(pipe); - free(addrs); - free(backtrace); - free(cmd); +# include "backtrace_linux.c" +#elif (defined(_XBT_WIN32) && defined (_M_IX86)) && !defined(__GNUC__) +# include "backtrace_windows.c" +#else +# include "backtrace_dummy.c" #endif -} /** @brief shows an exception content and the associated stack if available */ -void xbt_ex_display(xbt_ex_t *e) { +void xbt_ex_display(xbt_ex_t * e) +{ + char *thrower = NULL; fprintf(stderr, - "** SimGrid: UNCAUGHT EXCEPTION on %s: category: %s; value: %d\n" - "** %s\n" - "** Thrown by %s%s%s", - gras_os_myname(), - xbt_ex_catname(e->category), e->value, e->msg, - e->procname, (e->host?"@":""),(e->host?e->host:"")); - - if (!e->remote && !e->bt_strings) + "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n" + "** %s\n" + "** Thrown by %s()%s\n", + xbt_binary_name, xbt_getpid(), + xbt_ex_catname(e->category), e->value, e->msg, + e->procname, thrower ? thrower : " in this process"); + XBT_CRITICAL("%s", e->msg); + xbt_free(thrower); + + if (!e->bt_strings) xbt_ex_setup_backtrace(e); -#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE) - /* We have everything to build neat backtraces */ - { +#ifdef HAVE_BACKTRACE + if (e->used && e->bt_strings) { + /* We have everything to build neat backtraces */ int i; - - fprintf(stderr,"\n"); - for (i=0; iused; i++) - fprintf(stderr,"%s\n",e->bt_strings[i]); - - } -#else - fprintf(stderr," at %s:%d:%s (no backtrace available on that arch)\n", - e->file,e->line,e->func); + + fprintf(stderr, "\n"); + for (i = 0; i < e->used; i++) + fprintf(stderr, "%s\n", e->bt_strings[i]); + + } else #endif - xbt_ex_free(*e); + { + fprintf(stderr, + "\n" + "** In %s() at %s:%d\n" + "** (no backtrace available)\n", + e->func, e->file, e->line); + } } /* default __ex_terminate callback function */ -void __xbt_ex_terminate_default(xbt_ex_t *e) { +void __xbt_ex_terminate_default(xbt_ex_t * e) +{ xbt_ex_display(e); - - abort(); + xbt_abort(); } /* the externally visible API */ -ex_ctx_cb_t __xbt_ex_ctx = &__xbt_ex_ctx_default; -ex_term_cb_t __xbt_ex_terminate = &__xbt_ex_terminate_default; +XBT_EXPORT_NO_IMPORT(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch = &__xbt_ex_ctx_default; +XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate = + &__xbt_ex_terminate_default; + -void xbt_ex_free(xbt_ex_t e) { +void xbt_ex_free(xbt_ex_t e) +{ int i; - if (e.msg) free(e.msg); - if (e.remote) { - free(e.procname); - free(e.file); - free(e.func); - free(e.host); - } + free(e.msg); - if (e.bt_strings) { - for (i=0; i #include "xbt/ex.h" -XBT_TEST_SUITE("xbt_ex","Exception Handling"); +XBT_TEST_SUITE("xbt_ex", "Exception Handling"); -XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") { - xbt_ex_t ex; - volatile int n=1; +XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow") +{ + xbt_ex_t ex; + volatile int n = 1; - xbt_test_add0("basic nested control flow"); + xbt_test_add("basic nested control flow"); + TRY { + if (n != 1) + xbt_test_fail("M1: n=%d (!= 1)", n); + n++; TRY { - if (n != 1) - xbt_test_fail1("M1: n=%d (!= 1)", n); - n++; - TRY { - if (n != 2) - xbt_test_fail1("M2: n=%d (!= 2)", n); - n++; - THROW0(unknown_error,0,"something"); - } CATCH (ex) { - if (n != 3) - xbt_test_fail1("M3: n=%d (!= 3)", n); - n++; - xbt_ex_free(ex); - } - n++; - TRY { - if (n != 5) - xbt_test_fail1("M2: n=%d (!= 5)", n); - n++; - THROW0(unknown_error,0,"something"); - } CATCH (ex) { - if (n != 6) - xbt_test_fail1("M3: n=%d (!= 6)", n); - n++; - RETHROW; - n++; - } - xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n); + if (n != 2) + xbt_test_fail("M2: n=%d (!= 2)", n); + n++; + THROWF(unknown_error, 0, "something"); } CATCH(ex) { - if (n != 7) - xbt_test_fail1("M4: n=%d (!= 7)", n); - n++; - xbt_ex_free(ex); + if (n != 3) + xbt_test_fail("M3: n=%d (!= 3)", n); + n++; + xbt_ex_free(ex); } - if (n != 8) - xbt_test_fail1("M5: n=%d (!= 8)", n); + n++; + TRY { + if (n != 5) + xbt_test_fail("M2: n=%d (!= 5)", n); + n++; + THROWF(unknown_error, 0, "something"); + } + CATCH_ANONYMOUS { + if (n != 6) + xbt_test_fail("M3: n=%d (!= 6)", n); + n++; + RETHROW; + n++; + } + xbt_test_fail("MX: n=%d (shouldn't reach this point)", n); + } + CATCH(ex) { + if (n != 7) + xbt_test_fail("M4: n=%d (!= 7)", n); + n++; + xbt_ex_free(ex); + } + if (n != 8) + xbt_test_fail("M5: n=%d (!= 8)", n); } -XBT_TEST_UNIT("value",test_value,"exception value passing") { - xbt_ex_t ex; +XBT_TEST_UNIT("value", test_value, "exception value passing") +{ + xbt_ex_t ex; - TRY { - THROW0(unknown_error, 2, "toto"); - } CATCH(ex) { - xbt_test_add0("exception value passing"); - if (ex.category != unknown_error) - xbt_test_fail1("category=%d (!= 1)", ex.category); - if (ex.value != 2) - xbt_test_fail1("value=%d (!= 2)", ex.value); - if (strcmp(ex.msg,"toto")) - xbt_test_fail1("message=%s (!= toto)", ex.msg); - xbt_ex_free(ex); - } + TRY { + THROWF(unknown_error, 2, "toto"); + } + CATCH(ex) { + xbt_test_add("exception value passing"); + if (ex.category != unknown_error) + xbt_test_fail("category=%d (!= 1)", (int)ex.category); + if (ex.value != 2) + xbt_test_fail("value=%d (!= 2)", ex.value); + if (strcmp(ex.msg, "toto")) + xbt_test_fail("message=%s (!= toto)", ex.msg); + xbt_ex_free(ex); + } } -XBT_TEST_UNIT("variables",test_variables,"variable value preservation") { - xbt_ex_t ex; - int r1, r2; - volatile int v1, v2; +XBT_TEST_UNIT("variables", test_variables, "variable value preservation") +{ + xbt_ex_t ex; + int r1; + int _XBT_GNUC_UNUSED r2; + int v1; + volatile int v2; - r1 = r2 = v1 = v2 = 1234; - TRY { - r2 = 5678; - v2 = 5678; - THROW0(unknown_error, 0, "toto"); - } CATCH(ex) { - xbt_test_add0("variable preservation"); - if (r1 != 1234) - xbt_test_fail1("r1=%d (!= 1234)", r1); - if (v1 != 1234) - xbt_test_fail1("v1=%d (!= 1234)", v1); - /* r2 is allowed to be destroyed because not volatile */ - if (v2 != 5678) - xbt_test_fail1("v2=%d (!= 5678)", v2); - xbt_ex_free(ex); - } + r1 = r2 = v1 = v2 = 1234; + TRY { + r2 = 5678; + v2 = 5678; + THROWF(unknown_error, 0, "toto"); + } + CATCH(ex) { + xbt_test_add("variable preservation"); + if (r1 != 1234) + xbt_test_fail("r1=%d (!= 1234)", r1); + if (v1 != 1234) + xbt_test_fail("v1=%d (!= 1234)", v1); + /* r2 is allowed to be destroyed because not volatile */ + if (v2 != 5678) + xbt_test_fail("v2=%d (!= 5678)", v2); + xbt_ex_free(ex); + } } -XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") { - xbt_ex_t ex; - volatile int v1; - int c; +XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling") +{ + xbt_ex_t ex; + volatile int v1; + int c; - xbt_test_add0("cleanup handling"); + xbt_test_add("cleanup handling"); - v1 = 1234; - c = 0; - TRY { - v1 = 5678; - THROW0(1, 2, "blah"); - } CLEANUP { - if (v1 != 5678) - xbt_test_fail1("v1 = %d (!= 5678)", v1); - c = 1; - } CATCH(ex) { - if (v1 != 5678) - xbt_test_fail1("v1 = %d (!= 5678)", v1); - if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg,"blah"))) - xbt_test_fail0("unexpected exception contents"); - xbt_ex_free(ex); - } - if (!c) - xbt_test_fail0("xbt_ex_free not executed"); + v1 = 1234; + c = 0; + TRY { + v1 = 5678; + THROWF(1, 2, "blah"); + } + TRY_CLEANUP { + if (v1 != 5678) + xbt_test_fail("v1 = %d (!= 5678)", v1); + c = 1; + } + CATCH(ex) { + if (v1 != 5678) + xbt_test_fail("v1 = %d (!= 5678)", v1); + if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg, "blah"))) + xbt_test_fail("unexpected exception contents"); + xbt_ex_free(ex); + } + if (!c) + xbt_test_fail("xbt_ex_free not executed"); } /* - * The following is the example included in the documentation. It's a good + * The following is the example included in the documentation. It's a good * idea to check its syntax even if we don't try to run it. * And actually, it allows to put comments in the code despite doxygen. - */ -static char *mallocex(int size) { + */ +static char *mallocex(int size) +{ return NULL; } + #define SMALLAMOUNT 10 #define TOOBIG 100000000 -#if 0 /* this contains syntax errors, actually */ -static void bad_example(void) { - struct {char*first;} *globalcontext; +#if 0 /* this contains syntax errors, actually */ +static void bad_example(void) +{ + struct { + char *first; + } *globalcontext; ex_t ex; /* BAD_EXAMPLE */ TRY { char *cp1, *cp2, *cp3; - + cp1 = mallocex(SMALLAMOUNT); globalcontext->first = cp1; cp2 = mallocex(TOOBIG); cp3 = mallocex(SMALLAMOUNT); strcpy(cp1, "foo"); strcpy(cp2, "bar"); - } CLEANUP { - if (cp3 != NULL) free(cp3); - if (cp2 != NULL) free(cp2); - if (cp1 != NULL) free(cp1); - } CATCH(ex) { + } + TRY_CLEANUP { + free(cp3); + free(cp2); + free(cp1); + } + CATCH_ANONYMOUS { printf("cp3=%s", cp3); RETHROW; } /* end_of_bad_example */ } #endif +typedef struct { + char *first; +} global_context_t; -static void good_example(void) { - struct {char*first;} *globalcontext; - xbt_ex_t ex; +static void good_example(void) +{ + global_context_t *global_context = xbt_malloc(sizeof(global_context_t)); /* GOOD_EXAMPLE */ - { /*01*/ - char * volatile /*03*/ cp1 = NULL /*02*/; - char * volatile /*03*/ cp2 = NULL /*02*/; - char * volatile /*03*/ cp3 = NULL /*02*/; + { /*01 */ + char *volatile /*03 */ cp1 = NULL /*02 */ ; + char *volatile /*03 */ cp2 = NULL /*02 */ ; + char *volatile /*03 */ cp3 = NULL /*02 */ ; TRY { cp1 = mallocex(SMALLAMOUNT); - globalcontext->first = cp1; - cp1 = NULL /*05 give away*/; + global_context->first = cp1; + cp1 = NULL /*05 give away */ ; cp2 = mallocex(TOOBIG); cp3 = mallocex(SMALLAMOUNT); strcpy(cp1, "foo"); strcpy(cp2, "bar"); - } CLEANUP { /*04*/ - printf("cp3=%s", cp3 == NULL /*02*/ ? "" : cp3); - if (cp3 != NULL) - free(cp3); - if (cp2 != NULL) - free(cp2); + } + TRY_CLEANUP { /*04 */ + printf("cp3=%s", cp3 == NULL /*02 */ ? "" : cp3); + free(cp3); + free(cp2); /*05 cp1 was given away */ - } CATCH(ex) { + } + CATCH_ANONYMOUS { /*05 global context untouched */ RETHROW; } } /* end_of_good_example */ } -#endif /* SIMGRID_TEST */ +#endif /* SIMGRID_TEST */