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_modinter.h"       /* backtrace initialization headers */
  50
  51 #include "xbt/ex_interface.h"
  52
  53 #undef HAVE_BACKTRACE
  54 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
  55 # define HAVE_BACKTRACE 1       /* Hello linux box */
  56 #endif
  57
  58 #if defined(_XBT_WIN32) && defined(_M_IX86) && !defined(__GNUC__)
  59 # define HAVE_BACKTRACE 1       /* Hello x86 windows box */
  60 #endif
  61
  62
  63 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mecanism");
  64
  65 XBT_EXPORT_NO_IMPORT(const xbt_running_ctx_t) __xbt_ex_ctx_initializer = XBT_RUNNING_CTX_INITIALIZER;
  66
  67 /* default __ex_ctx callback function */
  68 xbt_running_ctx_t *__xbt_ex_ctx_default(void)
  69 {
  70   /* Don't scream: this is a default which is never used (so, yes,
  71      there is one setjump container by running entity).
  72
  73      This default gets overriden in xbt/xbt_os_thread.c so that it works in
  74      real life and in simulation when using threads to implement the simulation
  75      processes (ie, with pthreads and on windows).
  76
  77      It also gets overriden in xbt/context.c when using ucontextes (as well as
  78      in Java for now, but after the java overhaul, it will get cleaned out)
  79    */
  80   static xbt_running_ctx_t ctx = XBT_RUNNING_CTX_INITIALIZER;
  81
  82   return &ctx;
  83 }
  84
  85 /* Change raw libc symbols to file names and line numbers */
  86 void xbt_ex_setup_backtrace(xbt_ex_t * e);
  87
  88 void xbt_backtrace_display(xbt_ex_t * e)
  89 {
  90   xbt_ex_setup_backtrace(e);
  91
  92 #ifdef HAVE_BACKTRACE
  93   if (e->used == 0) {
  94     fprintf(stderr, "(backtrace not set)\n");
  95   } else {
  96     int i;
  97
  98     fprintf(stderr, "Backtrace (displayed in thread %p):\n",
  99             (void *) xbt_thread_self());
 100     for (i = 1; i < e->used; i++)       /* no need to display "xbt_backtrace_display" */
 101       fprintf(stderr, "---> %s\n", e->bt_strings[i] + 4);
 102   }
 103
 104   /* don't fool xbt_ex_free with uninitialized msg field */
 105   e->msg = NULL;
 106   xbt_ex_free(*e);
 107 #else
 108
 109   XBT_ERROR("No backtrace on this arch");
 110 #endif
 111 }
 112
 113 /** \brief show the backtrace of the current point (lovely while debuging) */
 114 void xbt_backtrace_display_current(void)
 115 {
 116   xbt_ex_t e;
 117   xbt_backtrace_current(&e);
 118   xbt_backtrace_display(&e);
 119 }
 120
 121 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
 122 # include "backtrace_linux.c"
 123 #elif (defined(_XBT_WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
 124 # include "backtrace_windows.c"
 125 #else
 126 # include "backtrace_dummy.c"
 127 #endif
 128
 129 /** @brief shows an exception content and the associated stack if available */
 130 void xbt_ex_display(xbt_ex_t * e)
 131 {
 132   char *thrower = NULL;
 133
 134   fprintf(stderr,
 135           "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
 136           "** %s\n"
 137           "** Thrown by %s()%s\n",
 138           xbt_binary_name, xbt_getpid(),
 139           xbt_ex_catname(e->category), e->value, e->msg,
 140           e->procname, thrower ? thrower : " in this process");
 141   XBT_CRITICAL("%s", e->msg);
 142   xbt_free(thrower);
 143
 144   if (!e->bt_strings)
 145     xbt_ex_setup_backtrace(e);
 146
 147 #ifdef HAVE_BACKTRACE
 148   if (e->used && e->bt_strings) {
 149     /* We have everything to build neat backtraces */
 150     int i;
 151
 152     fprintf(stderr, "\n");
 153     for (i = 0; i < e->used; i++)
 154       fprintf(stderr, "%s\n", e->bt_strings[i]);
 155
 156   } else
 157 #endif
 158   {
 159     fprintf(stderr,
 160             "\n"
 161             "**   In %s() at %s:%d\n"
 162             "**   (no backtrace available)\n",
 163             e->func, e->file, e->line);
 164   }
 165 }
 166
 167
 168 /* default __ex_terminate callback function */
 169 void __xbt_ex_terminate_default(xbt_ex_t * e)
 170 {
 171   xbt_ex_display(e);
 172   xbt_abort();
 173 }
 174
 175 /* the externally visible API */
 176 XBT_EXPORT_NO_IMPORT(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 177 XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate =
 178     &__xbt_ex_terminate_default;
 179
 180
 181 void xbt_ex_free(xbt_ex_t e)
 182 {
 183   int i;
 184
 185   free(e.msg);
 186
 187   if (e.bt_strings) {
 188     for (i = 0; i < e.used; i++)
 189       free(e.bt_strings[i]);
 190     free(e.bt_strings);
 191   }
 192   /* memset(e,0,sizeof(xbt_ex_t)); */
 193 }
 194
 195 /** \brief returns a short name for the given exception category */
 196 const char *xbt_ex_catname(xbt_errcat_t cat)
 197 {
 198   switch (cat) {
 199   case unknown_error:
 200     return "unknown error";
 201   case arg_error:
 202     return "invalid argument";
 203   case bound_error:
 204     return "out of bounds";
 205   case mismatch_error:
 206     return "mismatch";
 207   case not_found_error:
 208     return "not found";
 209   case system_error:
 210     return "system error";
 211   case network_error:
 212     return "network error";
 213   case timeout_error:
 214     return "timeout";
 215   case cancel_error:
 216     return "action canceled";
 217   case thread_error:
 218     return "thread error";
 219   case host_error:
 220     return "host failed";
 221   case tracing_error:
 222     return "tracing error";
 223   case io_error:
 224     return "io error";
 225   }
 226   return "INVALID ERROR";
 227 }
 228
 229
 230 #ifdef SIMGRID_TEST
 231 #include <stdio.h>
 232 #include "xbt/ex.h"
 233
 234 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
 235
 236 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
 237 {
 238   xbt_ex_t ex;
 239   volatile int n = 1;
 240
 241   xbt_test_add("basic nested control flow");
 242
 243   TRY {
 244     if (n != 1)
 245       xbt_test_fail("M1: n=%d (!= 1)", n);
 246     n++;
 247     TRY {
 248       if (n != 2)
 249         xbt_test_fail("M2: n=%d (!= 2)", n);
 250       n++;
 251       THROWF(unknown_error, 0, "something");
 252     }
 253     CATCH(ex) {
 254       if (n != 3)
 255         xbt_test_fail("M3: n=%d (!= 3)", n);
 256       n++;
 257       xbt_ex_free(ex);
 258     }
 259     n++;
 260     TRY {
 261       if (n != 5)
 262         xbt_test_fail("M2: n=%d (!= 5)", n);
 263       n++;
 264       THROWF(unknown_error, 0, "something");
 265     }
 266     CATCH_ANONYMOUS {
 267       if (n != 6)
 268         xbt_test_fail("M3: n=%d (!= 6)", n);
 269       n++;
 270       RETHROW;
 271       n++;
 272     }
 273     xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
 274   }
 275   CATCH(ex) {
 276     if (n != 7)
 277       xbt_test_fail("M4: n=%d (!= 7)", n);
 278     n++;
 279     xbt_ex_free(ex);
 280   }
 281   if (n != 8)
 282     xbt_test_fail("M5: n=%d (!= 8)", n);
 283 }
 284
 285 XBT_TEST_UNIT("value", test_value, "exception value passing")
 286 {
 287   xbt_ex_t ex;
 288
 289   TRY {
 290     THROWF(unknown_error, 2, "toto");
 291   }
 292   CATCH(ex) {
 293     xbt_test_add("exception value passing");
 294     if (ex.category != unknown_error)
 295       xbt_test_fail("category=%d (!= 1)", (int)ex.category);
 296     if (ex.value != 2)
 297       xbt_test_fail("value=%d (!= 2)", ex.value);
 298     if (strcmp(ex.msg, "toto"))
 299       xbt_test_fail("message=%s (!= toto)", ex.msg);
 300     xbt_ex_free(ex);
 301   }
 302 }
 303
 304 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
 305 {
 306   xbt_ex_t ex;
 307   int r1;
 308   int _XBT_GNUC_UNUSED r2;
 309   int v1;
 310   volatile int v2;
 311
 312   r1 = r2 = v1 = v2 = 1234;
 313   TRY {
 314     r2 = 5678;
 315     v2 = 5678;
 316     THROWF(unknown_error, 0, "toto");
 317   }
 318   CATCH(ex) {
 319     xbt_test_add("variable preservation");
 320     if (r1 != 1234)
 321       xbt_test_fail("r1=%d (!= 1234)", r1);
 322     if (v1 != 1234)
 323       xbt_test_fail("v1=%d (!= 1234)", v1);
 324     /* r2 is allowed to be destroyed because not volatile */
 325     if (v2 != 5678)
 326       xbt_test_fail("v2=%d (!= 5678)", v2);
 327     xbt_ex_free(ex);
 328   }
 329 }
 330
 331 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
 332 {
 333   xbt_ex_t ex;
 334   volatile int v1;
 335   int c;
 336
 337   xbt_test_add("cleanup handling");
 338
 339   v1 = 1234;
 340   c = 0;
 341   TRY {
 342     v1 = 5678;
 343     THROWF(1, 2, "blah");
 344   }
 345   TRY_CLEANUP {
 346     if (v1 != 5678)
 347       xbt_test_fail("v1 = %d (!= 5678)", v1);
 348     c = 1;
 349   }
 350   CATCH(ex) {
 351     if (v1 != 5678)
 352       xbt_test_fail("v1 = %d (!= 5678)", v1);
 353     if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg, "blah")))
 354       xbt_test_fail("unexpected exception contents");
 355     xbt_ex_free(ex);
 356   }
 357   if (!c)
 358     xbt_test_fail("xbt_ex_free not executed");
 359 }
 360
 361
 362 /*
 363  * The following is the example included in the documentation. It's a good
 364  * idea to check its syntax even if we don't try to run it.
 365  * And actually, it allows to put comments in the code despite doxygen.
 366  */
 367 static char *mallocex(int size)
 368 {
 369   return NULL;
 370 }
 371
 372 #define SMALLAMOUNT 10
 373 #define TOOBIG 100000000
 374
 375 #if 0                           /* this contains syntax errors, actually */
 376 static void bad_example(void)
 377 {
 378   struct {
 379     char *first;
 380   } *globalcontext;
 381   ex_t ex;
 382
 383   /* BAD_EXAMPLE */
 384   TRY {
 385     char *cp1, *cp2, *cp3;
 386
 387     cp1 = mallocex(SMALLAMOUNT);
 388     globalcontext->first = cp1;
 389     cp2 = mallocex(TOOBIG);
 390     cp3 = mallocex(SMALLAMOUNT);
 391     strcpy(cp1, "foo");
 392     strcpy(cp2, "bar");
 393   }
 394   TRY_CLEANUP {
 395     free(cp3);
 396     free(cp2);
 397     free(cp1);
 398   }
 399   CATCH_ANONYMOUS {
 400     printf("cp3=%s", cp3);
 401     RETHROW;
 402   }
 403   /* end_of_bad_example */
 404 }
 405 #endif
 406 typedef struct {
 407   char *first;
 408 } global_context_t;
 409
 410 static void good_example(void)
 411 {
 412   global_context_t *global_context = xbt_malloc(sizeof(global_context_t));
 413
 414   /* GOOD_EXAMPLE */
 415   {                             /*01 */
 416     char *volatile /*03 */ cp1 = NULL /*02 */ ;
 417     char *volatile /*03 */ cp2 = NULL /*02 */ ;
 418     char *volatile /*03 */ cp3 = NULL /*02 */ ;
 419     TRY {
 420       cp1 = mallocex(SMALLAMOUNT);
 421       global_context->first = cp1;
 422       cp1 = NULL /*05 give away */ ;
 423       cp2 = mallocex(TOOBIG);
 424       cp3 = mallocex(SMALLAMOUNT);
 425       strcpy(cp1, "foo");
 426       strcpy(cp2, "bar");
 427     }
 428     TRY_CLEANUP {               /*04 */
 429       printf("cp3=%s", cp3 == NULL /*02 */ ? "" : cp3);
 430       free(cp3);
 431       free(cp2);
 432       /*05 cp1 was given away */
 433     }
 434     CATCH_ANONYMOUS {
 435       /*05 global context untouched */
 436       RETHROW;
 437     }
 438   }
 439   /* end_of_good_example */
 440 }
 441 #endif                          /* SIMGRID_TEST */