src/xbt/ex.c

   1 /* ex - Exception Handling                                                  */
   2
   3 /*  Copyright (c) 2005-2010 The SimGrid team                                */
   4 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
   5 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
   6 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
   7 /*  All rights reserved.                                                    */
   8
   9 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
  10 /* It was heavily modified to fit the SimGrid framework.                    */
  11
  12 /* The OSSP version has the following copyright notice:
  13 **  OSSP ex - Exception Handling
  14 **  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
  15 **  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
  16 **  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
  17 **
  18 **  This file is part of OSSP ex, an exception handling library
  19 **  which can be found at http://www.ossp.org/pkg/lib/ex/.
  20 **
  21 **  Permission to use, copy, modify, and distribute this software for
  22 **  any purpose with or without fee is hereby granted, provided that
  23 **  the above copyright notice and this permission notice appear in all
  24 **  copies.
  25 **
  26 **  THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
  27 **  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  28 **  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 **  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
  30 **  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31 **  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32 **  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  33 **  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  34 **  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  35 **  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  36 **  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37 **  SUCH DAMAGE.
  38  */
  39
  40 /* The extensions made for the SimGrid project can either be distributed    */
  41 /* under the same license, or under the LGPL v2.1                           */
  42
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45
  46 #include "portable.h"           /* execinfo when available */
  47 #include "xbt/ex.h"
  48 #include "xbt/str.h"
  49 #include "xbt/module.h"         /* xbt_binary_name */
  50 #include "xbt_modinter.h"       /* backtrace initialization headers */
  51 #include "xbt/synchro.h"        /* xbt_thread_self */
  52
  53 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
  54 #include "xbt/ex_interface.h"
  55
  56 #undef HAVE_BACKTRACE
  57 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
  58 # define HAVE_BACKTRACE 1       /* Hello linux box */
  59 #endif
  60
  61 #if defined(_XBT_WIN32) && defined(_M_IX86) && !defined(__GNUC__)
  62 # define HAVE_BACKTRACE 1       /* Hello x86 windows box */
  63 #endif
  64
  65
  66 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mecanism");
  67
  68 XBT_EXPORT_NO_IMPORT(const xbt_running_ctx_t) __xbt_ex_ctx_initializer = XBT_RUNNING_CTX_INITIALIZER;
  69
  70 /* default __ex_ctx callback function */
  71 xbt_running_ctx_t *__xbt_ex_ctx_default(void)
  72 {
  73   /* Don't scream: this is a default which is never used (so, yes,
  74      there is one setjump container by running entity).
  75
  76      This default gets overriden in xbt/xbt_os_thread.c so that it works in
  77      real life and in simulation when using threads to implement the simulation
  78      processes (ie, with pthreads and on windows).
  79
  80      It also gets overriden in xbt/context.c when using ucontextes (as well as
  81      in Java for now, but after the java overhaul, it will get cleaned out)
  82    */
  83   static xbt_running_ctx_t ctx = XBT_RUNNING_CTX_INITIALIZER;
  84
  85   return &ctx;
  86 }
  87
  88 /* Change raw libc symbols to file names and line numbers */
  89 void xbt_ex_setup_backtrace(xbt_ex_t * e);
  90
  91 void xbt_backtrace_display(xbt_ex_t * e)
  92 {
  93   xbt_ex_setup_backtrace(e);
  94
  95 #ifdef HAVE_BACKTRACE
  96   if (e->used == 0) {
  97     fprintf(stderr, "(backtrace not set)\n");
  98   } else {
  99     int i;
 100
 101     fprintf(stderr, "Backtrace (displayed in thread %p):\n",
 102             (void *) xbt_thread_self());
 103     for (i = 1; i < e->used; i++)       /* no need to display "xbt_backtrace_display" */
 104       fprintf(stderr, "---> %s\n", e->bt_strings[i] + 4);
 105   }
 106
 107   /* don't fool xbt_ex_free with uninitialized msg field */
 108   e->msg = NULL;
 109   e->remote = 0;
 110   xbt_ex_free(*e);
 111 #else
 112
 113   XBT_ERROR("No backtrace on this arch");
 114 #endif
 115 }
 116
 117 /** \brief show the backtrace of the current point (lovely while debuging) */
 118 void xbt_backtrace_display_current(void)
 119 {
 120   xbt_ex_t e;
 121   xbt_backtrace_current(&e);
 122   xbt_backtrace_display(&e);
 123 }
 124
 125 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
 126 # include "backtrace_linux.c"
 127 #elif (defined(_XBT_WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
 128 # include "backtrace_windows.c"
 129 #else
 130 # include "backtrace_dummy.c"
 131 #endif
 132
 133 /** @brief shows an exception content and the associated stack if available */
 134 void xbt_ex_display(xbt_ex_t * e)
 135 {
 136   char *thrower = NULL;
 137
 138   if (e->remote)
 139     thrower = bprintf(" on host %s(%d)", e->host, e->pid);
 140
 141   fprintf(stderr,
 142           "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
 143           "** %s\n"
 144           "** Thrown by %s()%s\n",
 145           gras_os_myname(), xbt_getpid(),
 146           xbt_ex_catname(e->category), e->value, e->msg,
 147           e->procname, thrower ? thrower : " in this process");
 148   XBT_CRITICAL("%s", e->msg);
 149   xbt_free(thrower);
 150
 151   if (!e->remote && !e->bt_strings)
 152     xbt_ex_setup_backtrace(e);
 153
 154 #ifdef HAVE_BACKTRACE
 155   if (e->used && e->bt_strings) {
 156     /* We have everything to build neat backtraces */
 157     int i;
 158
 159     fprintf(stderr, "\n");
 160     for (i = 0; i < e->used; i++)
 161       fprintf(stderr, "%s\n", e->bt_strings[i]);
 162
 163   } else
 164 #endif
 165   {
 166     fprintf(stderr,
 167             "\n"
 168             "**   In %s() at %s:%d\n"
 169             "**   (no backtrace available)\n",
 170             e->func, e->file, e->line);
 171   }
 172 }
 173
 174
 175 /* default __ex_terminate callback function */
 176 void __xbt_ex_terminate_default(xbt_ex_t * e)
 177 {
 178   xbt_ex_display(e);
 179
 180   abort();
 181 }
 182
 183 /* the externally visible API */
 184 XBT_EXPORT_NO_IMPORT(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 185 XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate =
 186     &__xbt_ex_terminate_default;
 187
 188
 189 void xbt_ex_free(xbt_ex_t e)
 190 {
 191   int i;
 192
 193   free(e.msg);
 194   if (e.remote) {
 195     free(e.procname);
 196     free(e.file);
 197     free(e.func);
 198     free(e.host);
 199   }
 200
 201   if (e.bt_strings) {
 202     for (i = 0; i < e.used; i++)
 203       free(e.bt_strings[i]);
 204     free(e.bt_strings);
 205   }
 206   /* memset(e,0,sizeof(xbt_ex_t)); */
 207 }
 208
 209 /** \brief returns a short name for the given exception category */
 210 const char *xbt_ex_catname(xbt_errcat_t cat)
 211 {
 212   switch (cat) {
 213   case unknown_error:
 214     return "unknown_err";
 215   case arg_error:
 216     return "invalid_arg";
 217   case mismatch_error:
 218     return "mismatch";
 219   case not_found_error:
 220     return "not found";
 221   case system_error:
 222     return "system_err";
 223   case network_error:
 224     return "network_err";
 225   case timeout_error:
 226     return "timeout";
 227   case thread_error:
 228     return "thread_err";
 229   default:
 230     return "INVALID_ERR";
 231   }
 232 }
 233
 234
 235 #ifdef SIMGRID_TEST
 236 #include <stdio.h>
 237 #include "xbt/ex.h"
 238
 239 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
 240
 241 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
 242 {
 243   xbt_ex_t ex;
 244   volatile int n = 1;
 245
 246   xbt_test_add("basic nested control flow");
 247
 248   TRY {
 249     if (n != 1)
 250       xbt_test_fail("M1: n=%d (!= 1)", n);
 251     n++;
 252     TRY {
 253       if (n != 2)
 254         xbt_test_fail("M2: n=%d (!= 2)", n);
 255       n++;
 256       THROWF(unknown_error, 0, "something");
 257     }
 258     CATCH(ex) {
 259       if (n != 3)
 260         xbt_test_fail("M3: n=%d (!= 3)", n);
 261       n++;
 262       xbt_ex_free(ex);
 263     }
 264     n++;
 265     TRY {
 266       if (n != 5)
 267         xbt_test_fail("M2: n=%d (!= 5)", n);
 268       n++;
 269       THROWF(unknown_error, 0, "something");
 270     }
 271     CATCH_ANONYMOUS {
 272       if (n != 6)
 273         xbt_test_fail("M3: n=%d (!= 6)", n);
 274       n++;
 275       RETHROW;
 276       n++;
 277     }
 278     xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
 279   }
 280   CATCH(ex) {
 281     if (n != 7)
 282       xbt_test_fail("M4: n=%d (!= 7)", n);
 283     n++;
 284     xbt_ex_free(ex);
 285   }
 286   if (n != 8)
 287     xbt_test_fail("M5: n=%d (!= 8)", n);
 288 }
 289
 290 XBT_TEST_UNIT("value", test_value, "exception value passing")
 291 {
 292   xbt_ex_t ex;
 293
 294   TRY {
 295     THROWF(unknown_error, 2, "toto");
 296   }
 297   CATCH(ex) {
 298     xbt_test_add("exception value passing");
 299     if (ex.category != unknown_error)
 300       xbt_test_fail("category=%d (!= 1)", ex.category);
 301     if (ex.value != 2)
 302       xbt_test_fail("value=%d (!= 2)", ex.value);
 303     if (strcmp(ex.msg, "toto"))
 304       xbt_test_fail("message=%s (!= toto)", ex.msg);
 305     xbt_ex_free(ex);
 306   }
 307 }
 308
 309 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
 310 {
 311   xbt_ex_t ex;
 312   int r1, r2;
 313   volatile int v1, v2;
 314
 315   r1 = r2 = v1 = v2 = 1234;
 316   TRY {
 317     r2 = 5678;
 318     v2 = 5678;
 319     THROWF(unknown_error, 0, "toto");
 320   }
 321   CATCH(ex) {
 322     xbt_test_add("variable preservation");
 323     if (r1 != 1234)
 324       xbt_test_fail("r1=%d (!= 1234)", r1);
 325     if (v1 != 1234)
 326       xbt_test_fail("v1=%d (!= 1234)", v1);
 327     /* r2 is allowed to be destroyed because not volatile */
 328     if (v2 != 5678)
 329       xbt_test_fail("v2=%d (!= 5678)", v2);
 330     xbt_ex_free(ex);
 331   }
 332 }
 333
 334 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
 335 {
 336   xbt_ex_t ex;
 337   volatile int v1;
 338   int c;
 339
 340   xbt_test_add("cleanup handling");
 341
 342   v1 = 1234;
 343   c = 0;
 344   TRY {
 345     v1 = 5678;
 346     THROWF(1, 2, "blah");
 347   }
 348   TRY_CLEANUP {
 349     if (v1 != 5678)
 350       xbt_test_fail("v1 = %d (!= 5678)", v1);
 351     c = 1;
 352   }
 353   CATCH(ex) {
 354     if (v1 != 5678)
 355       xbt_test_fail("v1 = %d (!= 5678)", v1);
 356     if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg, "blah")))
 357       xbt_test_fail("unexpected exception contents");
 358     xbt_ex_free(ex);
 359   }
 360   if (!c)
 361     xbt_test_fail("xbt_ex_free not executed");
 362 }
 363
 364
 365 /*
 366  * The following is the example included in the documentation. It's a good
 367  * idea to check its syntax even if we don't try to run it.
 368  * And actually, it allows to put comments in the code despite doxygen.
 369  */
 370 static char *mallocex(int size)
 371 {
 372   return NULL;
 373 }
 374
 375 #define SMALLAMOUNT 10
 376 #define TOOBIG 100000000
 377
 378 #if 0                           /* this contains syntax errors, actually */
 379 static void bad_example(void)
 380 {
 381   struct {
 382     char *first;
 383   } *globalcontext;
 384   ex_t ex;
 385
 386   /* BAD_EXAMPLE */
 387   TRY {
 388     char *cp1, *cp2, *cp3;
 389
 390     cp1 = mallocex(SMALLAMOUNT);
 391     globalcontext->first = cp1;
 392     cp2 = mallocex(TOOBIG);
 393     cp3 = mallocex(SMALLAMOUNT);
 394     strcpy(cp1, "foo");
 395     strcpy(cp2, "bar");
 396   }
 397   TRY_CLEANUP {
 398     free(cp3);
 399     free(cp2);
 400     free(cp1);
 401   }
 402   CATCH_ANONYMOUS {
 403     printf("cp3=%s", cp3);
 404     RETHROW;
 405   }
 406   /* end_of_bad_example */
 407 }
 408 #endif
 409 typedef struct {
 410   char *first;
 411 } global_context_t;
 412
 413 static void good_example(void)
 414 {
 415   global_context_t *global_context = malloc(sizeof(global_context_t));
 416
 417   /* GOOD_EXAMPLE */
 418   {                             /*01 */
 419     char *volatile /*03 */ cp1 = NULL /*02 */ ;
 420     char *volatile /*03 */ cp2 = NULL /*02 */ ;
 421     char *volatile /*03 */ cp3 = NULL /*02 */ ;
 422     TRY {
 423       cp1 = mallocex(SMALLAMOUNT);
 424       global_context->first = cp1;
 425       cp1 = NULL /*05 give away */ ;
 426       cp2 = mallocex(TOOBIG);
 427       cp3 = mallocex(SMALLAMOUNT);
 428       strcpy(cp1, "foo");
 429       strcpy(cp2, "bar");
 430     }
 431     TRY_CLEANUP {               /*04 */
 432       printf("cp3=%s", cp3 == NULL /*02 */ ? "" : cp3);
 433       free(cp3);
 434       free(cp2);
 435       /*05 cp1 was given away */
 436     }
 437     CATCH_ANONYMOUS {
 438       /*05 global context untouched */
 439       RETHROW;
 440     }
 441   }
 442   /* end_of_good_example */
 443 }
 444 #endif                          /* SIMGRID_TEST */