src/xbt/ex.c

   1 /* $Id$ */
   2
   3 /* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
   4
   5 /*  Copyright (c) 2005-2006 Martin Quinson                                  */
   6 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
   7 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
   8 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
   9 /*  All rights reserved.                                                    */
  10
  11 /* This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the license (GNU LGPL) which comes with this package. */
  13
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16
  17 #include "portable.h" /* execinfo when available */
  18 #include "xbt/ex.h"
  19 #include "xbt/module.h" /* xbt_binary_name */
  20 #include "xbt/ex_interface.h"
  21
  22 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
  23
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex,xbt,"Exception mecanism");
  25
  26
  27 /* default __ex_ctx callback function */
  28 ex_ctx_t *__xbt_ex_ctx_default(void) {
  29     static ex_ctx_t ctx = XBT_CTX_INITIALIZER;
  30
  31     return &ctx;
  32 }
  33
  34
  35 /** \brief show the backtrace of the current point (lovely while debuging) */
  36 void xbt_backtrace_display(void) {
  37 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
  38   xbt_ex_t e;
  39   int i;
  40
  41   e.used     = backtrace((void**)e.bt,XBT_BACKTRACE_SIZE);
  42   e.bt_strings = NULL;
  43   xbt_ex_setup_backtrace(&e);
  44   for (i=1; i<e.used; i++) /* no need to display "xbt_display_backtrace" */
  45     fprintf(stderr,"%s\n",e.bt_strings[i]);
  46
  47   e.msg=NULL;
  48   e.remote=0;
  49   xbt_ex_free(e);
  50 #else
  51   ERROR0("No backtrace on this arch");
  52 #endif
  53 }
  54
  55 void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
  56 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
  57   int i;
  58   /* to get the backtrace from the libc */
  59   char **backtrace = backtrace_symbols (e->bt, e->used);
  60
  61   /* To build the commandline of addr2line */
  62   char *cmd = xbt_new(char,strlen(ADDR2LINE)+strlen(xbt_binary_name)+20*e->used);
  63   char *curr=cmd;
  64
  65   /* to extract the addresses from the backtrace */
  66   char **addrs=xbt_new(char*,e->used);
  67   char buff[256],*p;
  68
  69   /* To read the output of addr2line */
  70   FILE *pipe;
  71   char line_func[1024],line_pos[1024];
  72
  73   /* size (in char) of pointers on this arch */
  74   int addr_len=0;
  75
  76   /* build the commandline */
  77   curr += sprintf(curr,"%s -f -e %s ",ADDR2LINE,xbt_binary_name);
  78   for (i=0; i<e->used;i++) {
  79     /* retrieve this address */
  80     snprintf(buff,256,"%s",strchr(backtrace[i],'[')+1);
  81     p=strchr(buff,']');
  82     *p='\0';
  83     addrs[i]=bprintf("%s",buff);
  84
  85     /* Add it to the command line args */
  86     curr+=sprintf(curr,"%s ",addrs[i]);
  87   }
  88   addr_len = strlen(addrs[0]);
  89
  90   /* parse the output and build a new backtrace */
  91   e->bt_strings = xbt_new(char*,e->used);
  92
  93   pipe = popen(cmd, "r");
  94   if (!pipe) {
  95     CRITICAL0("Cannot fork addr2line to display the backtrace");
  96     abort();
  97   }
  98   for (i=0; i<e->used; i++) {
  99     fgets(line_func,1024,pipe);
 100     line_func[strlen(line_func)-1]='\0';
 101     fgets(line_pos,1024,pipe);
 102     line_pos[strlen(line_pos)-1]='\0';
 103
 104     if (strcmp("??",line_func)) {
 105       e->bt_strings[i] = bprintf("**   In %s() at %s (static symbol)", line_func,line_pos);
 106     } else {
 107       /* Damn. The symbol is in a dynamic library. Let's get wild */
 108       char *maps_name;
 109       FILE *maps;
 110       char maps_buff[512];
 111
 112       long int addr,offset=0;
 113       char *p,*p2;
 114
 115       char *subcmd;
 116       FILE *subpipe;
 117       int found=0;
 118
 119       /* let's look for the offset of this library in our addressing space */
 120       maps_name=bprintf("/proc/%d/maps",(int)getpid());
 121       maps=fopen(maps_name,"r");
 122
 123       sscanf(addrs[i],"%lx",&addr);
 124       sprintf(maps_buff,"%#lx",addr);
 125
 126       if (strcmp(addrs[i],maps_buff)) {
 127         CRITICAL2("Cannot parse backtrace address '%s' (addr=%#lx)",
 128                   addrs[i], addr);
 129       }
 130       DEBUG2("addr=%s (as string) =%#lx (as number)",addrs[i],addr);
 131
 132       while (!found) {
 133         long int first, last;
 134         if (fgets(maps_buff,512,maps) == NULL)
 135           break;
 136         if (i==0) {
 137           maps_buff[strlen(maps_buff) -1]='\0';
 138           DEBUG1("map line: %s", maps_buff);
 139         }
 140         sscanf(maps_buff,"%lx",&first);
 141         p=strchr(maps_buff,'-')+1;
 142         sscanf(p,"%lx",&last);
 143         if (first < addr && addr < last) {
 144           offset = first;
 145           found=1;
 146         }
 147         DEBUG4("%#lx %s [%#lx-%#lx]",
 148                addr, found? "in":"out of",first,last);
 149       }
 150       if (!found)
 151         CRITICAL0("Problem while reading the maps file");
 152
 153       fclose(maps);
 154       free(maps_name);
 155
 156       /* Ok, Found the offset of the maps line containing the searched symbol.
 157          We now need to substract this from the address we got from backtrace.
 158       */
 159
 160       free(addrs[i]);
 161       addrs[i] = bprintf("0x%0*lx",addr_len-2,addr-offset);
 162       DEBUG2("offset=%#lx new addr=%s",offset,addrs[i]);
 163
 164       /* Got it. We have our new address. Let's get the library path and we
 165          are set */
 166       p  = xbt_strdup(backtrace[i]);
 167       p2 = strrchr(p,'(');
 168       if (p2) *p2= '\0';
 169       p2 = strrchr(p,' ');
 170       if (p2) *p2= '\0';
 171
 172       /* Here we go, fire an addr2line up */
 173       subcmd = bprintf("%s -f -e %s %s",ADDR2LINE,p, addrs[i]);
 174       free(p);
 175       VERB1("Fire a new command: '%s'",subcmd);
 176       subpipe = popen(subcmd,"r");
 177       if (!subpipe) {
 178         CRITICAL0("Cannot fork addr2line to display the backtrace");
 179         abort();
 180       }
 181       fgets(line_func,1024,subpipe);
 182       line_func[strlen(line_func)-1]='\0';
 183       fgets(line_pos,1024,subpipe);
 184       line_pos[strlen(line_pos)-1]='\0';
 185       pclose(subpipe);
 186       free(subcmd);
 187
 188       /* check whether the trick worked */
 189       if (strcmp("??",line_func)) {
 190         e->bt_strings[i] = bprintf("**   In %s() at %s (dynamic symbol)", line_func,line_pos);
 191       } else {
 192         /* damn, nothing to do here. Let's print the raw address */
 193         e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace[i]);
 194       }
 195     }
 196     free(addrs[i]);
 197   }
 198   pclose(pipe);
 199   free(addrs);
 200   free(backtrace);
 201   free(cmd);
 202 #endif
 203 }
 204
 205 /** @brief shows an exception content and the associated stack if available */
 206 void xbt_ex_display(xbt_ex_t *e)  {
 207   char *thrower=NULL;
 208
 209   if (e->remote)
 210     bprintf(" on host %s(%ld)",e->host,e->pid);
 211
 212   CRITICAL1("%s",e->msg);
 213   fprintf(stderr,
 214           "** SimGrid: UNCAUGHT EXCEPTION received on %s(%ld): category: %s; value: %d\n"
 215           "** %s\n"
 216           "** Thrown by %s()%s\n",
 217           gras_os_myname(),gras_os_getpid(),
 218           xbt_ex_catname(e->category), e->value, e->msg,
 219           e->procname,thrower?thrower:" in this process");
 220
 221   if (thrower)
 222     free(thrower);
 223
 224   if (!e->remote && !e->bt_strings)
 225     xbt_ex_setup_backtrace(e);
 226
 227 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
 228   /* We have everything to build neat backtraces */
 229   {
 230     int i;
 231
 232     fprintf(stderr,"\n");
 233     for (i=0; i<e->used; i++)
 234       fprintf(stderr,"%s\n",e->bt_strings[i]);
 235
 236   }
 237 #else
 238   fprintf(stderr," at %s:%d:%s (no backtrace available on that arch)\n",
 239           e->file,e->line,e->func);
 240 #endif
 241   xbt_ex_free(*e);
 242 }
 243
 244
 245 /* default __ex_terminate callback function */
 246 void __xbt_ex_terminate_default(xbt_ex_t *e)  {
 247   xbt_ex_display(e);
 248
 249   abort();
 250 }
 251
 252 /* the externally visible API */
 253 ex_ctx_cb_t  __xbt_ex_ctx       = &__xbt_ex_ctx_default;
 254 ex_term_cb_t __xbt_ex_terminate = &__xbt_ex_terminate_default;
 255
 256 void xbt_ex_free(xbt_ex_t e) {
 257   int i;
 258
 259   if (e.msg) free(e.msg);
 260   if (e.remote) {
 261     free(e.procname);
 262     free(e.file);
 263     free(e.func);
 264     free(e.host);
 265   }
 266
 267   if (e.bt_strings) {
 268      for (i=0; i<e.used; i++)
 269        free((char*)e.bt_strings[i]);
 270      free((char **)e.bt_strings);
 271   }
 272 //  memset(e,0,sizeof(xbt_ex_t));
 273 }
 274
 275 /** \brief returns a short name for the given exception category */
 276 const char * xbt_ex_catname(xbt_errcat_t cat) {
 277   switch (cat) {
 278   case unknown_error:   return  "unknown_err";
 279   case arg_error:       return "invalid_arg";
 280   case mismatch_error:  return "mismatch";
 281   case not_found_error: return "not found";
 282   case system_error:    return "system_err";
 283   case network_error:   return "network_err";
 284   case timeout_error:   return "timeout";
 285   case thread_error:    return "thread_err";
 286   default:              return "INVALID_ERR";
 287   }
 288 }
 289
 290 #ifndef HAVE_EXECINFO_H
 291 /* dummy implementation. We won't use the result, but ex.h needs it to be defined */
 292 int backtrace (void **__array, int __size) {
 293   return 0;
 294 }
 295
 296 #endif
 297
 298 #ifdef SIMGRID_TEST
 299 #include "xbt/ex.h"
 300
 301 XBT_TEST_SUITE("xbt_ex","Exception Handling");
 302
 303 XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") {
 304     xbt_ex_t ex;
 305     volatile int n=1;
 306
 307     xbt_test_add0("basic nested control flow");
 308
 309     TRY {
 310         if (n != 1)
 311             xbt_test_fail1("M1: n=%d (!= 1)", n);
 312         n++;
 313         TRY {
 314             if (n != 2)
 315                 xbt_test_fail1("M2: n=%d (!= 2)", n);
 316             n++;
 317             THROW0(unknown_error,0,"something");
 318         } CATCH (ex) {
 319             if (n != 3)
 320                 xbt_test_fail1("M3: n=%d (!= 3)", n);
 321             n++;
 322             xbt_ex_free(ex);
 323         }
 324         n++;
 325         TRY {
 326             if (n != 5)
 327                 xbt_test_fail1("M2: n=%d (!= 5)", n);
 328             n++;
 329             THROW0(unknown_error,0,"something");
 330         } CATCH (ex) {
 331             if (n != 6)
 332                 xbt_test_fail1("M3: n=%d (!= 6)", n);
 333             n++;
 334             RETHROW;
 335             n++;
 336         }
 337         xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n);
 338     }
 339     CATCH(ex) {
 340         if (n != 7)
 341             xbt_test_fail1("M4: n=%d (!= 7)", n);
 342         n++;
 343         xbt_ex_free(ex);
 344     }
 345     if (n != 8)
 346         xbt_test_fail1("M5: n=%d (!= 8)", n);
 347 }
 348
 349 XBT_TEST_UNIT("value",test_value,"exception value passing") {
 350     xbt_ex_t ex;
 351
 352     TRY {
 353         THROW0(unknown_error, 2, "toto");
 354     } CATCH(ex) {
 355         xbt_test_add0("exception value passing");
 356         if (ex.category != unknown_error)
 357             xbt_test_fail1("category=%d (!= 1)", ex.category);
 358         if (ex.value != 2)
 359             xbt_test_fail1("value=%d (!= 2)", ex.value);
 360         if (strcmp(ex.msg,"toto"))
 361             xbt_test_fail1("message=%s (!= toto)", ex.msg);
 362         xbt_ex_free(ex);
 363     }
 364 }
 365
 366 XBT_TEST_UNIT("variables",test_variables,"variable value preservation") {
 367     xbt_ex_t ex;
 368     int r1, r2;
 369     volatile int v1, v2;
 370
 371     r1 = r2 = v1 = v2 = 1234;
 372     TRY {
 373         r2 = 5678;
 374         v2 = 5678;
 375         THROW0(unknown_error, 0, "toto");
 376     } CATCH(ex) {
 377         xbt_test_add0("variable preservation");
 378         if (r1 != 1234)
 379             xbt_test_fail1("r1=%d (!= 1234)", r1);
 380         if (v1 != 1234)
 381             xbt_test_fail1("v1=%d (!= 1234)", v1);
 382         /* r2 is allowed to be destroyed because not volatile */
 383         if (v2 != 5678)
 384             xbt_test_fail1("v2=%d (!= 5678)", v2);
 385         xbt_ex_free(ex);
 386     }
 387 }
 388
 389 XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") {
 390     xbt_ex_t ex;
 391     volatile int v1;
 392     int c;
 393
 394     xbt_test_add0("cleanup handling");
 395
 396     v1 = 1234;
 397     c = 0;
 398     TRY {
 399         v1 = 5678;
 400         THROW0(1, 2, "blah");
 401     } CLEANUP {
 402         if (v1 != 5678)
 403             xbt_test_fail1("v1 = %d (!= 5678)", v1);
 404         c = 1;
 405     } CATCH(ex) {
 406         if (v1 != 5678)
 407             xbt_test_fail1("v1 = %d (!= 5678)", v1);
 408         if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg,"blah")))
 409             xbt_test_fail0("unexpected exception contents");
 410         xbt_ex_free(ex);
 411     }
 412     if (!c)
 413         xbt_test_fail0("xbt_ex_free not executed");
 414 }
 415
 416
 417 /*
 418  * The following is the example included in the documentation. It's a good
 419  * idea to check its syntax even if we don't try to run it.
 420  * And actually, it allows to put comments in the code despite doxygen.
 421  */
 422 static char *mallocex(int size) {
 423   return NULL;
 424 }
 425 #define SMALLAMOUNT 10
 426 #define TOOBIG 100000000
 427
 428 #if 0 /* this contains syntax errors, actually */
 429 static void bad_example(void) {
 430   struct {char*first;} *globalcontext;
 431   ex_t ex;
 432
 433   /* BAD_EXAMPLE */
 434   TRY {
 435     char *cp1, *cp2, *cp3;
 436
 437     cp1 = mallocex(SMALLAMOUNT);
 438     globalcontext->first = cp1;
 439     cp2 = mallocex(TOOBIG);
 440     cp3 = mallocex(SMALLAMOUNT);
 441     strcpy(cp1, "foo");
 442     strcpy(cp2, "bar");
 443   } CLEANUP {
 444     if (cp3 != NULL) free(cp3);
 445     if (cp2 != NULL) free(cp2);
 446     if (cp1 != NULL) free(cp1);
 447   } CATCH(ex) {
 448     printf("cp3=%s", cp3);
 449     RETHROW;
 450   }
 451   /* end_of_bad_example */
 452 }
 453 #endif
 454
 455 static void good_example(void) {
 456   struct {char*first;} *globalcontext;
 457   xbt_ex_t ex;
 458
 459   /* GOOD_EXAMPLE */
 460   { /*01*/
 461     char * volatile /*03*/ cp1 = NULL /*02*/;
 462     char * volatile /*03*/ cp2 = NULL /*02*/;
 463     char * volatile /*03*/ cp3 = NULL /*02*/;
 464     TRY {
 465       cp1 = mallocex(SMALLAMOUNT);
 466       globalcontext->first = cp1;
 467       cp1 = NULL /*05 give away*/;
 468       cp2 = mallocex(TOOBIG);
 469       cp3 = mallocex(SMALLAMOUNT);
 470       strcpy(cp1, "foo");
 471       strcpy(cp2, "bar");
 472     } CLEANUP { /*04*/
 473       printf("cp3=%s", cp3 == NULL /*02*/ ? "" : cp3);
 474       if (cp3 != NULL)
 475         free(cp3);
 476       if (cp2 != NULL)
 477         free(cp2);
 478       /*05 cp1 was given away */
 479     } CATCH(ex) {
 480       /*05 global context untouched */
 481       RETHROW;
 482     }
 483   }
 484   /* end_of_good_example */
 485 }
 486 #endif /* SIMGRID_TEST */