src/xbt/ex.c

   1 /*
   2 **  OSSP ex - Exception Handling (modified to fit into SimGrid)
   3 **  Copyright (c) 2005 Martin Quinson
   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 **
   8 **  This file is part of OSSP ex, an exception handling library
   9 **  which can be found at http://www.ossp.org/pkg/lib/ex/.
  10 **
  11 **  Permission to use, copy, modify, and distribute this software for
  12 **  any purpose with or without fee is hereby granted, provided that
  13 **  the above copyright notice and this permission notice appear in all
  14 **  copies.
  15 **
  16 **  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  17 **  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18 **  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 **  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
  20 **  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 **  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 **  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23 **  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24 **  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25 **  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26 **  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 **  SUCH DAMAGE.
  28 **
  29 **  ex.c: exception handling (compiler part)
  30 */
  31
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34
  35 #include "portable.h" /* execinfo when available */
  36 #include "xbt/ex.h"
  37
  38 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
  39
  40 /* default __ex_ctx callback function */
  41 ex_ctx_t *__xbt_ex_ctx_default(void) {
  42     static ex_ctx_t ctx = XBT_CTX_INITIALIZER;
  43
  44     return &ctx;
  45 }
  46
  47 /** @brief shows an exception content and the associated stack if available */
  48 void xbt_ex_display(xbt_ex_t *e)  {
  49
  50   fprintf(stderr,
  51           "** SimGrid: UNCAUGHT EXCEPTION on %s: category: %s; value: %d\n"
  52           "** %s\n"
  53           "** Thrown by %s%s%s at %s:%d:%s\n",
  54           gras_os_myname(),
  55           xbt_ex_catname(e->category), e->value, e->msg,
  56           e->procname, (e->host?"@":""),(e->host?e->host:""),//localhost"),
  57           e->file,e->line,e->func);
  58
  59 #ifdef HAVE_EXECINFO_H
  60  {
  61   int i;
  62
  63   fprintf(stderr,"** Backtrace:\n");
  64   if (!e->bt_strings)
  65     e->bt_strings = backtrace_symbols (e->bt, e->used);
  66
  67   for (i = 0; i < e->used; i++)
  68      printf ("   %s\n", e->bt_strings[i]);
  69  }
  70 #endif
  71 }
  72
  73
  74 /* default __ex_terminate callback function */
  75 void __xbt_ex_terminate_default(xbt_ex_t *e)  {
  76   xbt_ex_display(e);
  77
  78   abort();
  79 }
  80
  81 /* the externally visible API */
  82 ex_ctx_cb_t  __xbt_ex_ctx       = &__xbt_ex_ctx_default;
  83 ex_term_cb_t __xbt_ex_terminate = &__xbt_ex_terminate_default;
  84
  85 void xbt_ex_free(xbt_ex_t e) {
  86   int i;
  87
  88   if (e.msg) free(e.msg);
  89   free(e.procname);
  90   if (e.host) {
  91     free(e.file);
  92     free(e.func);
  93     for (i=0; i<e.used; i++)
  94       free(e.bt_strings[i]);
  95     free(e.bt_strings);
  96     e.bt_strings=NULL;
  97   }
  98   /* locally, only one chunk of memory is allocated by the libc */
  99   if (e.bt_strings)
 100     free(e.bt_strings);
 101
 102 }
 103
 104 /** \brief returns a short name for the given exception category */
 105 const char * xbt_ex_catname(xbt_errcat_t cat) {
 106   switch (cat) {
 107   case unknown_error:   return  "unknown_err";
 108   case arg_error:       return "invalid_arg";
 109   case mismatch_error:  return "mismatch";
 110   case not_found_error: return "not found";
 111   case system_error:    return "system_err";
 112   case network_error:   return "network_err";
 113   case timeout_error:   return "timeout";
 114   case thread_error:    return "thread_err";
 115   default:              return "INVALID_ERR";
 116   }
 117 }
 118
 119 #ifndef HAVE_EXECINFO_H
 120 /* dummy implementation. We won't use the result, but ex.h needs it to be defined */
 121 int backtrace (void **__array, int __size) {
 122   return 0;
 123 }
 124
 125 #endif
 126
 127 #ifdef SIMGRID_TEST
 128 #include "xbt/ex.h"
 129
 130 XBT_TEST_SUITE("xbt_ex","Exception Handling");
 131
 132 XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") {
 133     xbt_ex_t ex;
 134     volatile int n=1;
 135
 136     xbt_test_add0("basic nested control flow");
 137
 138     TRY {
 139         if (n != 1)
 140             xbt_test_fail1("M1: n=%d (!= 1)", n);
 141         n++;
 142         TRY {
 143             if (n != 2)
 144                 xbt_test_fail1("M2: n=%d (!= 2)", n);
 145             n++;
 146             THROW0(unknown_error,0,"something");
 147         } CATCH (ex) {
 148             if (n != 3)
 149                 xbt_test_fail1("M3: n=%d (!= 1)", n);
 150             n++;
 151             RETHROW;
 152         }
 153         xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n);
 154     }
 155     CATCH(ex) {
 156         if (n != 4)
 157             xbt_test_fail1("M4: n=%d (!= 4)", n);
 158         n++;
 159         xbt_ex_free(ex);
 160     }
 161     if (n != 5)
 162         xbt_test_fail1("M5: n=%d (!= 5)", n);
 163 }
 164
 165 XBT_TEST_UNIT("value",test_value,"exception value passing") {
 166     xbt_ex_t ex;
 167
 168     TRY {
 169         THROW0(unknown_error, 2, "toto");
 170     } CATCH(ex) {
 171         xbt_test_add0("exception value passing");
 172         if (ex.category != unknown_error)
 173             xbt_test_fail1("category=%d (!= 1)", ex.category);
 174         if (ex.value != 2)
 175             xbt_test_fail1("value=%d (!= 2)", ex.value);
 176         if (strcmp(ex.msg,"toto"))
 177             xbt_test_fail1("message=%s (!= toto)", ex.msg);
 178         xbt_ex_free(ex);
 179     }
 180 }
 181
 182 XBT_TEST_UNIT("variables",test_variables,"variable value preservation") {
 183     xbt_ex_t ex;
 184     int r1, r2;
 185     volatile int v1, v2;
 186
 187     r1 = r2 = v1 = v2 = 1234;
 188     TRY {
 189         r2 = 5678;
 190         v2 = 5678;
 191         THROW0(unknown_error, 0, "toto");
 192     } CATCH(ex) {
 193         xbt_test_add0("variable preservation");
 194         if (r1 != 1234)
 195             xbt_test_fail1("r1=%d (!= 1234)", r1);
 196         if (v1 != 1234)
 197             xbt_test_fail1("v1=%d (!= 1234)", v1);
 198         /* r2 is allowed to be destroyed because not volatile */
 199         if (v2 != 5678)
 200             xbt_test_fail1("v2=%d (!= 5678)", v2);
 201         xbt_ex_free(ex);
 202     }
 203 }
 204
 205 XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") {
 206     xbt_ex_t ex;
 207     volatile int v1;
 208     int c;
 209
 210     xbt_test_add0("cleanup handling");
 211
 212     v1 = 1234;
 213     c = 0;
 214     TRY {
 215         v1 = 5678;
 216         THROW0(1, 2, "blah");
 217     } CLEANUP {
 218         if (v1 != 5678)
 219             xbt_test_fail1("v1 = %d (!= 5678)", v1);
 220         c = 1;
 221     } CATCH(ex) {
 222         if (v1 != 5678)
 223             xbt_test_fail1("v1 = %d (!= 5678)", v1);
 224         if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg,"blah")))
 225             xbt_test_fail0("unexpected exception contents");
 226         xbt_ex_free(ex);
 227     }
 228     if (!c)
 229         xbt_test_fail0("xbt_ex_free not executed");
 230 }
 231
 232
 233 /*
 234  * The following is the example included in the documentation. It's a good
 235  * idea to check its syntax even if we don't try to run it.
 236  * And actually, it allows to put comments in the code despite doxygen.
 237  */
 238 static char *mallocex(int size) {
 239   return NULL;
 240 }
 241 #define SMALLAMOUNT 10
 242 #define TOOBIG 100000000
 243
 244 #if 0 /* this contains syntax errors, actually */
 245 static void bad_example(void) {
 246   struct {char*first;} *globalcontext;
 247   ex_t ex;
 248
 249   /* BAD_EXAMPLE */
 250   TRY {
 251     char *cp1, *cp2, *cp3;
 252
 253     cp1 = mallocex(SMALLAMOUNT);
 254     globalcontext->first = cp1;
 255     cp2 = mallocex(TOOBIG);
 256     cp3 = mallocex(SMALLAMOUNT);
 257     strcpy(cp1, "foo");
 258     strcpy(cp2, "bar");
 259   } CLEANUP {
 260     if (cp3 != NULL) free(cp3);
 261     if (cp2 != NULL) free(cp2);
 262     if (cp1 != NULL) free(cp1);
 263   } CATCH(ex) {
 264     printf("cp3=%s", cp3);
 265     RETHROW;
 266   }
 267   /* end_of_bad_example */
 268 }
 269 #endif
 270
 271 static void good_example(void) {
 272   struct {char*first;} *globalcontext;
 273   xbt_ex_t ex;
 274
 275   /* GOOD_EXAMPLE */
 276   { /*01*/
 277     char * volatile /*03*/ cp1 = NULL /*02*/;
 278     char * volatile /*03*/ cp2 = NULL /*02*/;
 279     char * volatile /*03*/ cp3 = NULL /*02*/;
 280     TRY {
 281       cp1 = mallocex(SMALLAMOUNT);
 282       globalcontext->first = cp1;
 283       cp1 = NULL /*05 give away*/;
 284       cp2 = mallocex(TOOBIG);
 285       cp3 = mallocex(SMALLAMOUNT);
 286       strcpy(cp1, "foo");
 287       strcpy(cp2, "bar");
 288     } CLEANUP { /*04*/
 289       printf("cp3=%s", cp3 == NULL /*02*/ ? "" : cp3);
 290       if (cp3 != NULL)
 291         free(cp3);
 292       if (cp2 != NULL)
 293         free(cp2);
 294       /*05 cp1 was given away */
 295     } CATCH(ex) {
 296       /*05 global context untouched */
 297       RETHROW;
 298     }
 299   }
 300   /* end_of_good_example */
 301 }
 302 #endif /* SIMGRID_TEST */