Add a tool to automatically extract the test units from the source code of the librar...

[simgrid.git] / src / xbt / ex.c

diff --git a/src/xbt/ex.c b/src/xbt/ex.c
index 1f0c064..31209f5 100644 (file)
--- a/src/xbt/ex.c
+++ b/src/xbt/ex.c
@@ -31,8 +31,8 @@
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <execinfo.h>
 
+#include "portable.h" /* execinfo when available */
 #include "xbt/ex.h"
 
 /* default __ex_ctx callback function */
@@ -42,10 +42,8 @@ ex_ctx_t *__xbt_ex_ctx_default(void) {
     return &ctx;
 }
 
-/* default __ex_terminate callback function */
-void __xbt_ex_terminate_default(xbt_ex_t *e)  {
-  char **strings;
-  size_t i;
+/** @brief shows an exception content and the associated stack if available */
+void xbt_ex_display(xbt_ex_t *e)  {
 
   fprintf(stderr,
          "** SimGrid: UNCAUGHT EXCEPTION: category: %s; value: %d\n"
@@ -55,6 +53,11 @@ void __xbt_ex_terminate_default(xbt_ex_t *e)  {
          e->procname, (e->host?"@":""),(e->host?e->host:"localhost"),
          e->file,e->line,e->func);
 
+#ifdef HAVE_EXECINFO_H
+ {
+  char **strings;
+  int i;
+
   fprintf(stderr,"** Backtrace:\n");
   strings = backtrace_symbols (e->bt, e->used);
 
@@ -62,6 +65,15 @@ void __xbt_ex_terminate_default(xbt_ex_t *e)  {
      printf ("   %s\n", strings[i]);
 
   free (strings);
+ }
+#endif
+}
+
+
+/* default __ex_terminate callback function */
+void __xbt_ex_terminate_default(xbt_ex_t *e)  {
+  xbt_ex_display(e);
+
   abort();
 }
 
@@ -70,19 +82,135 @@ ex_ctx_cb_t  __xbt_ex_ctx       = &__xbt_ex_ctx_default;
 ex_term_cb_t __xbt_ex_terminate = &__xbt_ex_terminate_default;
 
 void xbt_ex_free(xbt_ex_t e) {
-  free(e.msg);
+  if (e.msg) free(e.msg);
+  free(e.procname);
 }
 
 /** \brief returns a short name for the given exception category */
 const char * xbt_ex_catname(xbt_errcat_t cat) {
   switch (cat) {
-  case unknown_error: return  "unknown_err";
-  case arg_error:      return "invalid_arg";
-  case mismatch_error: return "mismatch";
-  case system_error:   return "system_err";
-  case network_error:  return "network_err";
-  case timeout_error:  return "timeout";
-  case thread_error:   return "thread_err";
-  default:             return "INVALID_ERR";
+  case unknown_error:   return  "unknown_err";
+  case arg_error:       return "invalid_arg";
+  case mismatch_error:  return "mismatch";
+  case not_found_error: return "not found";
+  case system_error:    return "system_err";
+  case network_error:   return "network_err";
+  case timeout_error:   return "timeout";
+  case thread_error:    return "thread_err";
+  default:              return "INVALID_ERR";
   }
 }
+
+#ifndef HAVE_EXECINFO_H
+/* dummy implementation. We won't use the result, but ex.h needs it to be defined */
+int backtrace (void **__array, int __size) {
+  return 0;
+}
+
+#endif
+
+#ifdef SIMGRID_TEST
+#include "xbt/ex.h"
+
+XBT_TEST_SUITE("xbt_ex","Exception Handling");
+
+XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") {
+    xbt_ex_t ex;
+    volatile int n=1;
+
+    xbt_test_add0("basic nested control flow");
+
+    TRY {
+        if (n != 1)
+            xbt_test_fail1("M1: n=%d (!= 1)", n);
+        n++;
+        TRY {
+            if (n != 2)
+                xbt_test_fail1("M2: n=%d (!= 2)", n);
+            n++;
+            THROW0(unknown_error,0,"something");
+        } CATCH (ex) {
+            if (n != 3)
+                xbt_test_fail1("M3: n=%d (!= 1)", n);
+            n++;
+            RETHROW;
+        }
+        xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n);
+    }
+    CATCH(ex) {
+        if (n != 4)
+            xbt_test_fail1("M4: n=%d (!= 4)", n);
+        n++;
+        xbt_ex_free(ex);
+    }
+    if (n != 5)
+        xbt_test_fail1("M5: n=%d (!= 5)", n);
+}
+
+XBT_TEST_UNIT("value",test_value,"exception value passing") {
+    xbt_ex_t ex;
+
+    TRY {
+        THROW0(unknown_error, 2, "toto");
+    } CATCH(ex) {
+        xbt_test_add0("exception value passing");
+        if (ex.category != unknown_error)
+            xbt_test_fail1("category=%d (!= 1)", ex.category);
+        if (ex.value != 2)
+            xbt_test_fail1("value=%d (!= 2)", ex.value);
+        if (strcmp(ex.msg,"toto"))
+            xbt_test_fail1("message=%s (!= toto)", ex.msg);
+        xbt_ex_free(ex);
+    }
+}
+
+XBT_TEST_UNIT("variables",test_variables,"variable value preservation") {
+    xbt_ex_t ex;
+    int r1, r2;
+    volatile int v1, v2;
+
+    r1 = r2 = v1 = v2 = 1234;
+    TRY {
+        r2 = 5678;
+        v2 = 5678;
+        THROW0(unknown_error, 0, "toto");
+    } CATCH(ex) {
+        xbt_test_add0("variable preservation");
+        if (r1 != 1234)
+            xbt_test_fail1("r1=%d (!= 1234)", r1);
+        if (v1 != 1234)
+            xbt_test_fail1("v1=%d (!= 1234)", v1);
+        /* r2 is allowed to be destroyed because not volatile */
+        if (v2 != 5678)
+            xbt_test_fail1("v2=%d (!= 5678)", v2);
+        xbt_ex_free(ex);
+    }
+}
+
+XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") {
+    xbt_ex_t ex;
+    volatile int v1;
+    int c;
+
+    xbt_test_add0("cleanup handling");
+
+    v1 = 1234;
+    c = 0;
+    TRY {
+        v1 = 5678;
+        THROW0(1, 2, "blah");
+    } CLEANUP {
+        if (v1 != 5678)
+            xbt_test_fail1("v1 = %d (!= 5678)", v1);
+        c = 1;
+    } CATCH(ex) {
+        if (v1 != 5678)
+            xbt_test_fail1("v1 = %d (!= 5678)", v1);
+        if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg,"blah")))
+            xbt_test_fail0("unexpected exception contents");
+        xbt_ex_free(ex);
+    }
+    if (!c)
+        xbt_test_fail0("xbt_ex_free not executed");
+}
+#endif /* SIMGRID_TEST */