Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
sanitize this function name before its API is frozen by a release ;)
[simgrid.git] / src / xbt / ex.c
index 4c4c6be..b92e0c1 100644 (file)
@@ -34,6 +34,8 @@
 
 #include "portable.h" /* execinfo when available */
 #include "xbt/ex.h"
+#include "xbt/module.h" /* xbt_binary_name */
+#include "xbt/ex_interface.h"
 
 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
 
@@ -44,30 +46,186 @@ ex_ctx_t *__xbt_ex_ctx_default(void) {
     return &ctx;
 }
 
+
+/** \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;
+
+  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]);
+
+  e.msg=NULL;
+  e.remote=0;
+  xbt_ex_free(e);
+#else 
+  fprintf(stderr,"No backtrace on this arch");
+#endif
+}
+
+void xbt_ex_setup_backtrace(xbt_ex_t *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; i<e->used;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; i<e->used; 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);
+#endif
+}    
+
 /** @brief shows an exception content and the associated stack if available */
 void xbt_ex_display(xbt_ex_t *e)  {
 
   fprintf(stderr,
          "** SimGrid: UNCAUGHT EXCEPTION on %s: category: %s; value: %d\n"
          "** %s\n"
-         "** Thrown by %s%s%s at %s:%d:%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:""),//localhost"),
-         e->file,e->line,e->func);
+         e->procname, (e->host?"@":""),(e->host?e->host:""));
 
-#ifdef HAVE_EXECINFO_H
- {
-  int i;
+  if (!e->remote && !e->bt_strings)
+    xbt_ex_setup_backtrace(e);
 
-  fprintf(stderr,"** Backtrace:\n");
-  if (!e->bt_strings)
-    e->bt_strings = backtrace_symbols (e->bt, e->used);
-
-  for (i = 0; i < e->used; i++)
-     printf ("   %s\n", e->bt_strings[i]);
- }
+#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
+  /* We have everything to build neat backtraces */
+  {
+    int i;
+    
+    fprintf(stderr,"\n");
+    for (i=0; i<e->used; 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);
 #endif
+  xbt_ex_free(*e);
 }
 
 
@@ -86,21 +244,19 @@ void xbt_ex_free(xbt_ex_t e) {
   int i;
 
   if (e.msg) free(e.msg);
-  free(e.procname);
   if (e.remote) {
+    free(e.procname);
     free(e.file);
     free(e.func);
-    if (e.bt_strings) /* FIXME: should never be NULL... */
-      for (i=0; i<e.used; i++) 
-       free(e.bt_strings[i]);
-    free(e.bt_strings);
-    e.bt_strings=NULL;
     free(e.host);
   }
-  /* locally, only one chunk of memory is allocated by the libc */
-  if (e.bt_strings)
-    free(e.bt_strings);
 
+  if (e.bt_strings) {  
+     for (i=0; i<e.used; i++) 
+       free((char*)e.bt_strings[i]);
+     free((char **)e.bt_strings);
+  }
+//  memset(e,0,sizeof(xbt_ex_t));
 }
 
 /** \brief returns a short name for the given exception category */
@@ -148,20 +304,33 @@ XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") {
             THROW0(unknown_error,0,"something");
         } CATCH (ex) {
             if (n != 3)
-                xbt_test_fail1("M3: n=%d (!= 1)", n);
+                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);
     }
     CATCH(ex) {
-        if (n != 4)
-            xbt_test_fail1("M4: n=%d (!= 4)", n);
+        if (n != 7)
+            xbt_test_fail1("M4: n=%d (!= 7)", n);
         n++;
         xbt_ex_free(ex);
     }
-    if (n != 5)
-        xbt_test_fail1("M5: n=%d (!= 5)", n);
+    if (n != 8)
+        xbt_test_fail1("M5: n=%d (!= 8)", n);
 }
 
 XBT_TEST_UNIT("value",test_value,"exception value passing") {