src/xbt/ex.cpp

   1 /* ex - Exception Handling                                                  */
   2
   3 /* Copyright (c) 2005-2017. The SimGrid Team. All rights reserved.          */
   4
   5 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
   6 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
   7 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
   8 /*  All rights reserved.                                                    */
   9
  10 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
  11 /* It was heavily modified to fit the SimGrid framework.                    */
  12
  13 /* The OSSP version has the following copyright notice:
  14 **  OSSP ex - Exception Handling
  15 **  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
  16 **  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
  17 **  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
  18 **
  19 **  This file is part of OSSP ex, an exception handling library
  20 **  which can be found at http://www.ossp.org/pkg/lib/ex/.
  21 **
  22 **  Permission to use, copy, modify, and distribute this software for
  23 **  any purpose with or without fee is hereby granted, provided that
  24 **  the above copyright notice and this permission notice appear in all
  25 **  copies.
  26 **
  27 **  THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
  28 **  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  29 **  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  30 **  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
  31 **  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32 **  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33 **  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  34 **  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35 **  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  36 **  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37 **  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38 **  SUCH DAMAGE.
  39  */
  40
  41 /* The extensions made for the SimGrid project can either be distributed    */
  42 /* under the same license, or under the LGPL v2.1                           */
  43
  44 #include <cstdio>
  45 #include <cstdlib>
  46
  47 #include <xbt/backtrace.hpp>
  48 #include "src/internal_config.h"           /* execinfo when available */
  49 #include "xbt/ex.h"
  50 #include <xbt/ex.hpp>
  51 #include "xbt/log.h"
  52 #include "xbt/log.hpp"
  53 #include "xbt/backtrace.h"
  54 #include "xbt/backtrace.hpp"
  55 #include "xbt/str.h"
  56 #include "src/xbt_modinter.h"       /* backtrace initialization headers */
  57
  58 #include "simgrid/sg_config.h"  /* Configuration mechanism of SimGrid */
  59
  60 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mechanism");
  61
  62 // Don't define ~xbt_ex() in ex.hpp.  It is defined here to ensure that there is an unique definition of xt_ex in
  63 // libsimgrid, but not in libsimgrid-java.  Otherwise, sone tests are broken (seen with clang/libc++ on freebsd).
  64 xbt_ex::~xbt_ex() = default;
  65
  66 void _xbt_throw(char* message, xbt_errcat_t errcat, int value, const char* file, int line, const char* func)
  67 {
  68   xbt_ex e(simgrid::xbt::ThrowPoint(file, line, func), message);
  69   free(message);
  70   e.category = errcat;
  71   e.value = value;
  72   throw e;
  73 }
  74
  75 /** @brief shows an exception content and the associated stack if available */
  76 void xbt_ex_display(xbt_ex_t * e)
  77 {
  78   simgrid::xbt::logException(xbt_log_priority_critical, "UNCAUGHT EXCEPTION", *e);
  79 }
  80
  81 /** \brief returns a short name for the given exception category */
  82 const char *xbt_ex_catname(xbt_errcat_t cat)
  83 {
  84   switch (cat) {
  85   case unknown_error:
  86     return "unknown error";
  87   case arg_error:
  88     return "invalid argument";
  89   case bound_error:
  90     return "out of bounds";
  91   case mismatch_error:
  92     return "mismatch";
  93   case not_found_error:
  94     return "not found";
  95   case system_error:
  96     return "system error";
  97   case network_error:
  98     return "network error";
  99   case timeout_error:
 100     return "timeout";
 101   case cancel_error:
 102     return "action canceled";
 103   case thread_error:
 104     return "thread error";
 105   case host_error:
 106     return "host failed";
 107   case tracing_error:
 108     return "tracing error";
 109   case io_error:
 110     return "io error";
 111   case vm_error:
 112     return "vm error";
 113   default:
 114     return "INVALID ERROR";
 115   }
 116   return "INVALID ERROR";
 117 }
 118
 119 #ifdef SIMGRID_TEST
 120 #include "xbt/ex.h"
 121 #include <cstdio>
 122 #include <xbt/ex.hpp>
 123
 124 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
 125
 126 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
 127 {
 128   xbt_ex_t ex;
 129   int n = 1;
 130
 131   xbt_test_add("basic nested control flow");
 132
 133   try {
 134     if (n != 1)
 135       xbt_test_fail("M1: n=%d (!= 1)", n);
 136     n++;
 137     try {
 138       if (n != 2)
 139         xbt_test_fail("M2: n=%d (!= 2)", n);
 140       n++;
 141       THROWF(unknown_error, 0, "something");
 142     }
 143     catch (xbt_ex& ex) {
 144       if (n != 3)
 145         xbt_test_fail("M3: n=%d (!= 3)", n);
 146       n++;
 147     }
 148     n++;
 149     try {
 150       if (n != 5)
 151         xbt_test_fail("M2: n=%d (!= 5)", n);
 152       n++;
 153       THROWF(unknown_error, 0, "something");
 154     }
 155     catch(xbt_ex& ex){
 156       if (n != 6)
 157         xbt_test_fail("M3: n=%d (!= 6)", n);
 158       n++;
 159       throw;
 160       n++;
 161     }
 162     xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
 163   }
 164   catch(xbt_ex& e) {
 165     if (n != 7)
 166       xbt_test_fail("M4: n=%d (!= 7)", n);
 167     n++;
 168   }
 169   if (n != 8)
 170     xbt_test_fail("M5: n=%d (!= 8)", n);
 171 }
 172
 173 XBT_TEST_UNIT("value", test_value, "exception value passing")
 174 {
 175   try {
 176     THROWF(unknown_error, 2, "toto");
 177   }
 178   catch (xbt_ex& ex) {
 179     xbt_test_add("exception value passing");
 180     if (ex.category != unknown_error)
 181       xbt_test_fail("category=%d (!= 1)", (int)ex.category);
 182     if (ex.value != 2)
 183       xbt_test_fail("value=%d (!= 2)", ex.value);
 184     if (strcmp(ex.what(), "toto"))
 185       xbt_test_fail("message=%s (!= toto)", ex.what());
 186   }
 187 }
 188
 189 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
 190 {
 191   xbt_ex_t ex;
 192   int r1;
 193   int XBT_ATTRIB_UNUSED r2;
 194   int v1;
 195   int v2;
 196
 197   r1 = r2 = v1 = v2 = 1234;
 198   try {
 199     r2 = 5678;
 200     v2 = 5678;
 201     THROWF(unknown_error, 0, "toto");
 202   }
 203   catch(xbt_ex& e) {
 204     xbt_test_add("variable preservation");
 205     if (r1 != 1234)
 206       xbt_test_fail("r1=%d (!= 1234)", r1);
 207     if (v1 != 1234)
 208       xbt_test_fail("v1=%d (!= 1234)", v1);
 209     /* r2 is allowed to be destroyed because not volatile */
 210     if (v2 != 5678)
 211       xbt_test_fail("v2=%d (!= 5678)", v2);
 212   }
 213 }
 214
 215 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
 216 {
 217   int v1;
 218   int c;
 219
 220   xbt_test_add("cleanup handling");
 221
 222   v1 = 1234;
 223   c = 0;
 224   try {
 225     v1 = 5678;
 226     THROWF(1, 2, "blah");
 227   }
 228   catch (xbt_ex& ex) {
 229     if (v1 != 5678)
 230       xbt_test_fail("v1 = %d (!= 5678)", v1);
 231     c = 1;
 232     if (v1 != 5678)
 233       xbt_test_fail("v1 = %d (!= 5678)", v1);
 234     if (not(ex.category == 1 && ex.value == 2 && not strcmp(ex.what(), "blah")))
 235       xbt_test_fail("unexpected exception contents");
 236   }
 237   if (not c)
 238     xbt_test_fail("xbt_ex_free not executed");
 239 }
 240 #endif                          /* SIMGRID_TEST */