Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fight against multiple 'extern' specification
[simgrid.git] / src / xbt / ex.c
index e4c522c..adfc14a 100644 (file)
@@ -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 <rse@engelschall.com>       */
 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
 #include "portable.h" /* execinfo when available */
 #include "xbt/ex.h"
 #include "xbt/module.h" /* xbt_binary_name */
-#include "xbt/ex_interface.h"
+#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");
 
-
 /* default __ex_ctx callback function */
 ex_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).
+
+     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) {
+void xbt_backtrace_current(xbt_ex_t *e) {
 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
-  xbt_ex_t e;
-  int i;
+  e->used     = backtrace((void**)e->bt,XBT_BACKTRACE_SIZE);
+  e->bt_strings = NULL;
+  xbt_ex_setup_backtrace(e);
+#endif
+}
 
-  e.used     = backtrace((void**)e.bt,XBT_BACKTRACE_SIZE);
-  e.bt_strings = NULL;
-  xbt_ex_setup_backtrace(&e);
-  for (i=1; i<e.used; i++) /* no need to display "xbt_display_backtrace" */
-    fprintf(stderr,"%s\n",e.bt_strings[i]);
+void xbt_backtrace_display(xbt_ex_t *e) {
+#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
+  int i;
 
-  e.msg=NULL;
-  e.remote=0;
-  xbt_ex_free(e);
+  if (e->used == 0) {
+     fprintf(stderr,"(backtrace not set)\n");
+  } else {     
+     fprintf(stderr,"Backtrace (displayed in thread %p):\n",
+            (void*)xbt_thread_self());
+     for (i=1; i<e->used; 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
 }
 
+/** \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);
+}
+
+extern char **environ; /* the environment, as specified by the opengroup */
 
 void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
@@ -60,8 +90,7 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
   char **backtrace = backtrace_symbols (e->bt, e->used);
   
   /* To build the commandline of addr2line */
-  char *cmd = xbt_new(char,strlen(ADDR2LINE)+25+strlen(xbt_binary_name)+32*e->used);
-  char *curr=cmd;
+  char *cmd, *curr;
   
   /* to extract the addresses from the backtrace */
   char **addrs=xbt_new(char*,e->used);
@@ -74,24 +103,68 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
   /* size (in char) of pointers on this arch */
   int addr_len=0;
 
+  /* To search for the right executable path when not trivial */
+  struct stat stat_buf;
+  char *binary_name = NULL;
+   
   /* Some arches only have stubs of backtrace, no implementation (hppa comes to mind) */
   if (!e->used)
      return;
    
   /* build the commandline */
-  curr += sprintf(curr,"%s -f -e %s ",ADDR2LINE,xbt_binary_name);
+  if (stat(xbt_binary_name,&stat_buf)) {
+    /* Damn. binary not in current dir. We'll have to dig the PATH to find it */
+    int i;
+    for (i=0; environ[i]; i++) {
+      if (!strncmp("PATH=",environ[i], 5)) {   
+       xbt_dynar_t path=xbt_str_split(environ[i] + 5, ":");
+       int cpt;
+       char *data;
+       xbt_dynar_foreach(path, cpt, data) {
+         if (binary_name)
+           free(binary_name);
+         binary_name = bprintf("%s/%s",data,xbt_binary_name);
+         if (!stat(binary_name,&stat_buf)) {
+           /* Found. */
+           DEBUG1("Looked in the PATH for the binary. Found %s",binary_name);
+           xbt_dynar_free(&path);
+           break;
+         } 
+       }
+       if (stat(binary_name,&stat_buf)) {
+         /* not found */
+         e->used = 1;
+         e->bt_strings = xbt_new(char*,1);
+         e->bt_strings[0] = bprintf("(binary '%s' not found the path)",xbt_binary_name);
+         return;
+       }
+       xbt_dynar_free(&path);
+       break;
+      }        
+    }
+  } else {
+    binary_name = xbt_strdup(xbt_binary_name);
+  }      
+  cmd = curr = xbt_new(char,strlen(ADDR2LINE)+25+strlen(binary_name)+32*e->used);
+   
+  curr += sprintf(curr,"%s -f -e %s ",ADDR2LINE,binary_name);
+  free(binary_name);
+   
   for (i=0; i<e->used;i++) {
     /* retrieve this address */
     DEBUG2("Retrieving address number %d from '%s'", i, backtrace[i]);
     snprintf(buff,256,"%s",strchr(backtrace[i],'[')+1);
     p=strchr(buff,']');
     *p='\0';
-    addrs[i]=bprintf("%s", buff);
+    if (strcmp(buff,"(nil)"))
+       addrs[i]=bprintf("%s", buff);
+    else
+       addrs[i]=bprintf("0x0");
     DEBUG3("Set up a new address: %d, '%s'(%p)", i, addrs[i], addrs[i]);
      
     /* 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 */
@@ -112,8 +185,8 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
     line_pos[strlen(line_pos)-1]='\0';
 
     if (strcmp("??",line_func)) {
-       DEBUG2("Found static symbol %s() at %s", line_func, line_pos);
-      e->bt_strings[i] = bprintf("**   In %s() at %s (static symbol)", line_func,line_pos);
+      DEBUG2("Found static symbol %s() at %s", line_func, line_pos);
+      e->bt_strings[i] = bprintf("**   In %s() at %s", line_func,line_pos);
     } else {
       /* Damn. The symbol is in a dynamic library. Let's get wild */
       char *maps_name;
@@ -155,8 +228,10 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
          offset = first;
          found=1;
        }
-       DEBUG4("%#lx %s [%#lx-%#lx]",
-              addr, found? "in":"out of",first,last);
+       if (found) {          
+          DEBUG3("%#lx in [%#lx-%#lx]", addr, first,last);
+          DEBUG0("Symbol found, map lines not further displayed (even if looking for next ones)");
+       }
       }
       fclose(maps);
       free(maps_name);
@@ -179,38 +254,62 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
       /* 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';
+      if (p[0]=='[') {
+        /* library path not displayed in the map file either... */
+        free(p);
+        sprintf(line_func,"??");
+      } else {
+        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();
+        /* 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);
       }
-      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)) {
        DEBUG2("Found dynamic symbol %s() at %s", line_func, line_pos);
-       e->bt_strings[i] = bprintf("**   In %s() at %s (dynamic symbol)", line_func,line_pos);
+       e->bt_strings[i] = bprintf("**   In %s() at %s", line_func,line_pos);
       } else {
        /* damn, nothing to do here. Let's print the raw address */
        DEBUG1("Dynamic symbol not found. Raw address = %s", backtrace[i]);
-       e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace[i]);
+       e->bt_strings[i] = bprintf("**   In ?? at %s", backtrace[i]);
       }
+      
     }
     free(addrs[i]);
+     
+    /* Mask the bottom of the stack */    
+    if (!strncmp("main",line_func,strlen("main"))) {
+       int j;
+       for (j=i+1; j<e->used; j++)
+        free(addrs[j]);
+       e->used = i+1;
+    }
+     
+    if (!strncmp("__context_wrapper",line_func,strlen("__context_wrapper"))) {
+       int j;
+       for (j=i+1; j<e->used; j++)
+        free(addrs[j]);
+       e->used = i;
+    }
+     
+    
   }
   pclose(pipe);
   free(addrs);
@@ -224,16 +323,16 @@ void xbt_ex_display(xbt_ex_t *e)  {
   char *thrower=NULL;
 
   if (e->remote)
-    bprintf(" on host %s(%ld)",e->host,e->pid);
+    bprintf(" on host %s(%d)",e->host,e->pid);
 
-  CRITICAL1("%s",e->msg);
   fprintf(stderr,
-         "** SimGrid: UNCAUGHT EXCEPTION received on %s(%ld): category: %s; value: %d\n"
+         "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
          "** %s\n"
          "** Thrown by %s()%s\n",
-         gras_os_myname(),gras_os_getpid(),
+         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);
@@ -267,8 +366,9 @@ void __xbt_ex_terminate_default(xbt_ex_t *e)  {
 }
 
 /* the externally visible API */
-XBT_PUBLIC(ex_ctx_cb_t)  __xbt_ex_ctx       = &__xbt_ex_ctx_default;
-XBT_PUBLIC(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;
@@ -313,6 +413,7 @@ int backtrace (void **__array, int __size) {
 #endif
 
 #ifdef SIMGRID_TEST
+#include <stdio.h>
 #include "xbt/ex.h"
 
 XBT_TEST_SUITE("xbt_ex","Exception Handling");