X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6903f88b9cd26bb3c24c698fb04ec187f69a105a..4725d7a4bc5ac1fdae3e86222cdc23eaaf6fb226:/src/xbt/ex.c diff --git a/src/xbt/ex.c b/src/xbt/ex.c index 907d73ed30..7c0714fcf8 100644 --- a/src/xbt/ex.c +++ b/src/xbt/ex.c @@ -2,7 +2,7 @@ /* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */ -/* Copyright (c) 2005-2006 Martin Quinson */ +/* Copyright (c) 2005, 2006, 2007 Martin Quinson */ /* Copyright (c) 2002-2004 Ralf S. Engelschall */ /* Copyright (c) 2002-2004 The OSSP Project */ /* Copyright (c) 2002-2004 Cable & Wireless */ @@ -16,206 +16,101 @@ #include "portable.h" /* execinfo when available */ #include "xbt/ex.h" +#include "xbt/str.h" #include "xbt/module.h" /* xbt_binary_name */ -#include "xbt/ex_interface.h" +#include "xbt_modinter.h" /* backtrace initialization headers */ +#include "xbt/synchro.h" /* xbt_thread_self */ #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */ +#include "xbt/ex_interface.h" -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex,xbt,"Exception mecanism"); +#undef HAVE_BACKTRACE +#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE) +# define HAVE_BACKTRACE 1 /* Hello linux box */ +#endif +#if defined(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"); /* default __ex_ctx callback function */ ex_ctx_t *__xbt_ex_ctx_default(void) { - static ex_ctx_t ctx = XBT_CTX_INITIALIZER; + /* 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 ex_ctx_t ctx = XBT_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_display_backtrace" */ + fprintf(stderr,"---> %s\n",e->bt_strings[i] +4); + } + + /* don't fool xbt_ex_free with uninitialized msg field */ + e->msg=NULL; + e->remote=0; + xbt_ex_free(*e); +#else + + ERROR0("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"); - if (!pipe) { - CRITICAL0("Cannot fork addr2line to display the backtrace"); - abort(); - } - 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("** In %s() at %s (static symbol)", 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=0; - 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"); - - sscanf(addrs[i],"%lx",&addr); - sprintf(maps_buff,"%#lx",addr); - - if (strcmp(addrs[i],maps_buff)) { - CRITICAL2("Cannot parse backtrace address '%s' (addr=%#lx)", - addrs[i], addr); - } - DEBUG2("addr=%s (as string) =%#lx (as number)",addrs[i],addr); - - while (!found) { - long int first, last; - if (fgets(maps_buff,512,maps) == NULL) - break; - if (i==0) { - maps_buff[strlen(maps_buff) -1]='\0'; - DEBUG1("map line: %s", maps_buff); - } - sscanf(maps_buff,"%lx",&first); - p=strchr(maps_buff,'-')+1; - sscanf(p,"%lx",&last); - if (first < addr && addr < last) { - offset = first; - found=1; - } - DEBUG4("%#lx %s [%#lx-%#lx]", - addr, found? "in":"out of",first,last); - } - if (!found) - CRITICAL0("Problem while reading the maps file"); - - fclose(maps); - free(maps_name); - - /* Ok, Found the offset of the maps line containing the searched symbol. - We now need to substract this from the address we got from backtrace. - */ - - free(addrs[i]); - addrs[i] = bprintf("0x%0*lx",addr_len-2,addr-offset); - DEBUG2("offset=%#lx new addr=%s",offset,addrs[i]); - - /* 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); - VERB1("Fire a new command: '%s'",subcmd); - subpipe = popen(subcmd,"r"); - if (!subpipe) { - CRITICAL0("Cannot fork addr2line to display the backtrace"); - abort(); - } - 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("** In %s() at %s (dynamic symbol)", line_func,line_pos); - } else { - /* damn, nothing to do here. Let's print the raw address */ - e->bt_strings[i] = bprintf("** In ?? (%s)", backtrace[i]); - } - } - free(addrs[i]); - } - pclose(pipe); - free(addrs); - free(backtrace); - free(cmd); +# include "backtrace_linux.c" +#elif (defined(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) { char *thrower=NULL; if (e->remote) - bprintf(" on host %s(%ld)",e->host,e->pid); + thrower = bprintf(" on host %s(%d)",e->host,e->pid); fprintf(stderr, - "** SimGrid: UNCAUGHT EXCEPTION received on %s(%ld): category: %s; value: %d\n" - "** %s\n" - "** Thrown by %s()%s", - gras_os_myname(),gras_os_getpid(), - xbt_ex_catname(e->category), e->value, e->msg, - e->procname,thrower?thrower:" in this process"); + "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n" + "** %s\n" + "** Thrown by %s()%s\n", + gras_os_myname(),(*xbt_getpid)(), + xbt_ex_catname(e->category), e->value, e->msg, + e->procname,thrower?thrower:" in this process"); + CRITICAL1("%s",e->msg); if (thrower) free(thrower); @@ -223,19 +118,19 @@ void xbt_ex_display(xbt_ex_t *e) { if (!e->remote && !e->bt_strings) xbt_ex_setup_backtrace(e); -#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE) +#ifdef HAVE_BACKTRACE /* 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," at %s:%d:%s (no backtrace available on that arch)\n", + e->file,e->line,e->func); #endif xbt_ex_free(*e); } @@ -249,8 +144,9 @@ void __xbt_ex_terminate_default(xbt_ex_t *e) { } /* 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(ex_ctx_cb_t) __xbt_ex_ctx = &__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) { int i; @@ -263,161 +159,155 @@ void xbt_ex_free(xbt_ex_t e) { free(e.host); } - if (e.bt_strings) { - for (i=0; i #include "xbt/ex.h" 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_ex_t ex; + volatile int n=1; - xbt_test_add0("basic nested control flow"); + xbt_test_add0("basic nested control flow"); + TRY { + if (n != 1) + xbt_test_fail1("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_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); } - CATCH(ex) { - if (n != 7) - xbt_test_fail1("M4: n=%d (!= 7)", 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++; } - if (n != 8) - xbt_test_fail1("M5: n=%d (!= 8)", n); + xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n); + } + CATCH(ex) { + if (n != 7) + xbt_test_fail1("M4: n=%d (!= 7)", n); + n++; + xbt_ex_free(ex); + } + if (n != 8) + xbt_test_fail1("M5: n=%d (!= 8)", n); } XBT_TEST_UNIT("value",test_value,"exception value passing") { - xbt_ex_t ex; + 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 { + 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); + } } XBT_TEST_UNIT("variables",test_variables,"variable value preservation") { - xbt_ex_t ex; - int r1, r2; - volatile int v1, v2; + xbt_ex_t ex; + int r1, r2; + volatile int v1, 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; + 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); + } } XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") { - xbt_ex_t ex; - volatile int v1; - int c; + xbt_ex_t ex; + volatile int v1; + int c; - xbt_test_add0("cleanup handling"); + xbt_test_add0("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; + 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"); } /* - * 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) { return NULL; } @@ -432,7 +322,7 @@ static void bad_example(void) { /* BAD_EXAMPLE */ TRY { char *cp1, *cp2, *cp3; - + cp1 = mallocex(SMALLAMOUNT); globalcontext->first = cp1; cp2 = mallocex(TOOBIG); @@ -450,9 +340,10 @@ static void bad_example(void) { /* end_of_bad_example */ } #endif +typedef struct {char *first;} global_context_t; static void good_example(void) { - struct {char*first;} *globalcontext; + global_context_t *global_context=malloc(sizeof(global_context_t)); xbt_ex_t ex; /* GOOD_EXAMPLE */ @@ -462,7 +353,7 @@ static void good_example(void) { char * volatile /*03*/ cp3 = NULL /*02*/; TRY { cp1 = mallocex(SMALLAMOUNT); - globalcontext->first = cp1; + global_context->first = cp1; cp1 = NULL /*05 give away*/; cp2 = mallocex(TOOBIG); cp3 = mallocex(SMALLAMOUNT); @@ -471,9 +362,9 @@ static void good_example(void) { } CLEANUP { /*04*/ printf("cp3=%s", cp3 == NULL /*02*/ ? "" : cp3); if (cp3 != NULL) - free(cp3); + free(cp3); if (cp2 != NULL) - free(cp2); + free(cp2); /*05 cp1 was given away */ } CATCH(ex) { /*05 global context untouched */