Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix on hppa: there is no working backtrace() there
[simgrid.git] / src / xbt / ex.c
index 923df6a..48ab1de 100644 (file)
@@ -1,33 +1,15 @@
-/*
-**  OSSP ex - Exception Handling (modified to fit into SimGrid)
-**  Copyright (c) 2005 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/>
-**
-**  This file is part of OSSP ex, an exception handling library
-**  which can be found at http://www.ossp.org/pkg/lib/ex/.
-**
-**  Permission to use, copy, modify, and distribute this software for
-**  any purpose with or without fee is hereby granted, provided that
-**  the above copyright notice and this permission notice appear in all
-**  copies.
-**
-**  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
-**  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-**  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-**  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-**  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-**  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-**  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)
-*/
+/* $Id$ */
+
+/* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
+
+/*  Copyright (c) 2005-2006 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/>           */
+/*  All rights reserved.                                                    */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include <stdio.h>
 #include <stdlib.h>
@@ -39,6 +21,9 @@
 
 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
 
+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;
@@ -48,7 +33,7 @@ ex_ctx_t *__xbt_ex_ctx_default(void) {
 
 
 /** \brief show the backtrace of the current point (lovely while debuging) */
-void xbt_display_backtrace(void) {
+void xbt_backtrace_display(void) {
 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
   xbt_ex_t e;
   int i;
@@ -63,7 +48,7 @@ void xbt_display_backtrace(void) {
   e.remote=0;
   xbt_ex_free(e);
 #else 
-  fprintf(stderr,"No backtrace on this arch");
+  ERROR0("No backtrace on this arch");
 #endif
 }
 
@@ -87,7 +72,11 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
 
   /* 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++) {
@@ -106,7 +95,10 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
   e->bt_strings = xbt_new(char*,e->used);
   
   pipe = popen(cmd, "r");
-  //     xbt_assert(pipe);//,"Cannot fork addr2line to display the backtrace");
+  if (!pipe) {
+    CRITICAL0("Cannot fork addr2line to display the backtrace");
+    abort();
+  }
   for (i=0; i<e->used; i++) {
     fgets(line_func,1024,pipe);
     line_func[strlen(line_func)-1]='\0';
@@ -114,15 +106,14 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
     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);
+      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,offset_save;
+      long int addr,offset=0;
       char *p,*p2;
 
       char *subcmd;
@@ -133,28 +124,49 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
       maps_name=bprintf("/proc/%d/maps",(int)getpid());
       maps=fopen(maps_name,"r");
 
-      addr=strtol(addrs[i]+2, NULL,16);
+      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;
-       offset_save = offset;
-       offset=strtol(maps_buff,NULL,16);
-       if (offset > addr)
+       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);
 
-      /* 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.
+      if (!found) {
+       VERB0("Problem while reading the maps file. Following backtrace will be mangled.");
+       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.
       */
-      offset=offset_save;
       
       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 */ 
@@ -167,7 +179,12 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
       /* 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);
@@ -177,15 +194,10 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
 
       /* check whether the trick worked */
       if (strcmp("??",line_func)) {
-       e->bt_strings[i] = bprintf("**   At %s: %s (%s)", 
-                                  addrs[i], 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 */
-       p  = bprintf("%s",backtrace[i]);
-       p2 = strrchr(p,' ');
-       *p2= '\0';
-       e->bt_strings[i] = bprintf("**   At %s: ?? (%s)", addrs[i], p);
-       free(p);
+       e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace[i]);
       }
     }
     free(addrs[i]);
@@ -199,14 +211,22 @@ void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
 
 /** @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);
+
+  CRITICAL1("%s",e->msg);
   fprintf(stderr,
-         "** SimGrid: UNCAUGHT EXCEPTION on %s: category: %s; value: %d\n"
+         "** SimGrid: UNCAUGHT EXCEPTION received on %s(%ld): category: %s; value: %d\n"
          "** %s\n"
-         "** Thrown by %s%s%s",
-         gras_os_myname(),
+         "** Thrown by %s()%s\n",
+         gras_os_myname(),gras_os_getpid(),
          xbt_ex_catname(e->category), e->value, e->msg,
-         e->procname, (e->host?"@":""),(e->host?e->host:""));
+         e->procname,thrower?thrower:" in this process");
+
+  if (thrower)
+    free(thrower);
 
   if (!e->remote && !e->bt_strings)
     xbt_ex_setup_backtrace(e);
@@ -438,9 +458,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 */
@@ -450,7 +471,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);