Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Separate the dummy implementation of the backtraces into its own file (backtrace_dumm...
[simgrid.git] / src / xbt / ex.c
index 9ec447f..365c922 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/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)
+# 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) {
+  /* 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) {
-#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
-  xbt_ex_t e;
-  int i;
+void xbt_backtrace_current(xbt_ex_t *e) {
+#ifdef HAVE_BACKTRACE
+  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) {
+#ifdef HAVE_BACKTRACE
+  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);
+}
 
-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)+25+strlen(xbt_binary_name)+32*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;
-
-  /* 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);
-  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);
-    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 */
-  e->bt_strings = xbt_new(char*,e->used);
-  
-  VERB1("Fire a first command: '%s'", cmd);
-  pipe = popen(cmd, "r");
-  if (!pipe) {
-    CRITICAL0("Cannot fork addr2line to display the backtrace");
-    abort();
-  }
-
-  for (i=0; i<e->used; i++) {
-    DEBUG2("Looking for symbol %d, addr = '%s'", i, addrs[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)) {
-       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);
-    } 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);
-      }
-      fclose(maps);
-      free(maps_name);
-
-      if (!found) {
-       VERB0("Problem while reading the maps file. Following backtrace will be mangled.");
-       DEBUG1("No dynamic. Static symbol: %s", backtrace[i]);
-       e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace[i]);
-       continue;
-      }
-
-      /* 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)) {
-       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);
-      } 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]);
-      }
-    }
-    free(addrs[i]);
-  }
-  pclose(pipe);
-  free(addrs);
-  free(backtrace);
-  free(cmd);
+# include "backtrace_linux.c"
+#elif (defined(WIN32) && defined (_M_IX86))
+# 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);
 
-  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);
@@ -241,7 +122,7 @@ 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;
@@ -267,8 +148,8 @@ void __xbt_ex_terminate_default(xbt_ex_t *e)  {
 }
 
 /* the externally visible API */
-ex_ctx_cb_t XBT_DECLARE_DATA  __xbt_ex_ctx       = &__xbt_ex_ctx_default;
-ex_term_cb_t XBT_DECLARE_DATA __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) {
@@ -305,15 +186,9 @@ const char * xbt_ex_catname(xbt_errcat_t cat) {
   }
 }
 
-#ifndef HAVE_EXECINFO_H
-/* dummy implementation. We won't use the result, but ex.h needs it to be defined */
-int backtrace (void **__array, int __size) {
-  return 0;
-}
-
-#endif
 
 #ifdef SIMGRID_TEST
+#include <stdio.h>
 #include "xbt/ex.h"
 
 XBT_TEST_SUITE("xbt_ex","Exception Handling");