Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Need to include surf/surf_routing.h now.
[simgrid.git] / src / xbt / ex.c
index 2182083..5087b0c 100644 (file)
@@ -1,15 +1,44 @@
-/* $Id$ */
+/* ex - Exception Handling                                                  */
 
-/* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
-
-/*  Copyright (c) 2005, 2006, 2007 Martin Quinson                           */
+/*  Copyright (c) 2005-2010 The SimGrid team                                */
 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
 /*  All rights reserved.                                                    */
 
-/* This program is free software; you can redistribute it and/or modify it
- * under the terms of the license (GNU LGPL) which comes with this package. */
+/* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
+/* It was heavily modified to fit the SimGrid framework.                    */
+
+/* The OSSP version has the following copyright notice:
+**  OSSP ex - Exception Handling
+**  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
+**  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
+**  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
+**
+**  This file is part of OSSP ex, an exception handling library
+**  which can be found at http://www.ossp.org/pkg/lib/ex/.
+**
+**  Permission to use, copy, modify, and distribute this software for
+**  any purpose with or without fee is hereby granted, provided that
+**  the above copyright notice and this permission notice appear in all
+**  copies.
+**
+**  THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
+**  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+**  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+**  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
+**  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+**  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+**  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+**  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+**  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+**  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+**  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+**  SUCH DAMAGE.
+ */
+
+/* The extensions made for the SimGrid project can either be distributed    */
+/* under the same license, or under the LGPL v2.1                           */
 
 #include <stdio.h>
 #include <stdlib.h>
@@ -29,7 +58,7 @@
 # define HAVE_BACKTRACE 1       /* Hello linux box */
 #endif
 
-#if defined(WIN32) && defined(_M_IX86) && !defined(__GNUC__)
+#if defined(_XBT_WIN32) && defined(_M_IX86) && !defined(__GNUC__)
 # define HAVE_BACKTRACE 1       /* Hello x86 windows box */
 #endif
 
@@ -37,7 +66,7 @@
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mecanism");
 
 /* default __ex_ctx callback function */
-ex_ctx_t *__xbt_ex_ctx_default(void)
+xbt_running_ctx_t *__xbt_ex_ctx_default(void)
 {
   /* Don't scream: this is a default which is never used (so, yes,
      there is one setjump container by running entity).
@@ -49,7 +78,7 @@ ex_ctx_t *__xbt_ex_ctx_default(void)
      It also gets overriden in xbt/context.c when using ucontextes (as well as
      in Java for now, but after the java overhaul, it will get cleaned out)
    */
-  static ex_ctx_t ctx = XBT_CTX_INITIALIZER;
+  static xbt_running_ctx_t ctx = XBT_RUNNING_CTX_INITIALIZER;
 
   return &ctx;
 }
@@ -79,7 +108,7 @@ void xbt_backtrace_display(xbt_ex_t * e)
   xbt_ex_free(*e);
 #else
 
-  ERROR0("No backtrace on this arch");
+  XBT_ERROR("No backtrace on this arch");
 #endif
 }
 
@@ -93,7 +122,7 @@ void xbt_backtrace_display_current(void)
 
 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
 # include "backtrace_linux.c"
-#elif (defined(WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
+#elif (defined(_XBT_WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
 # include "backtrace_windows.c"
 #else
 # include "backtrace_dummy.c"
@@ -114,7 +143,7 @@ void xbt_ex_display(xbt_ex_t * e)
           gras_os_myname(), (*xbt_getpid) (),
           xbt_ex_catname(e->category), e->value, e->msg,
           e->procname, thrower ? thrower : " in this process");
-  CRITICAL1("%s", e->msg);
+  XBT_CRITICAL("%s", e->msg);
 
   if (!e->remote && !e->bt_strings)
     xbt_ex_setup_backtrace(e);
@@ -124,6 +153,10 @@ void xbt_ex_display(xbt_ex_t * e)
   {
     int i;
 
+    if (!xbt_binary_name) {
+      fprintf(stderr, "variable 'xbt_binary_name' set to NULL. Cannot compute the backtrace\n");
+      return;
+    }
     fprintf(stderr, "\n");
     for (i = 0; i < e->used; i++)
       fprintf(stderr, "%s\n", e->bt_strings[i]);
@@ -145,12 +178,12 @@ void __xbt_ex_terminate_default(xbt_ex_t * e)
 }
 
 /* the externally visible API */
-XBT_EXPORT_NO_IMPORT(ex_ctx_cb_t) __xbt_ex_ctx = &__xbt_ex_ctx_default;
+XBT_EXPORT_NO_IMPORT(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate =
-  &__xbt_ex_terminate_default;
+    &__xbt_ex_terminate_default;
 
 
-     void xbt_ex_free(xbt_ex_t e)
+void xbt_ex_free(xbt_ex_t e)
 {
   int i;
 
@@ -208,48 +241,48 @@ 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");
+  xbt_test_add("basic nested control flow");
 
   TRY {
     if (n != 1)
-      xbt_test_fail1("M1: n=%d (!= 1)", n);
+      xbt_test_fail("M1: n=%d (!= 1)", n);
     n++;
     TRY {
       if (n != 2)
-        xbt_test_fail1("M2: n=%d (!= 2)", n);
+        xbt_test_fail("M2: n=%d (!= 2)", n);
       n++;
-      THROW0(unknown_error, 0, "something");
+      THROWF(unknown_error, 0, "something");
     }
     CATCH(ex) {
       if (n != 3)
-        xbt_test_fail1("M3: n=%d (!= 3)", n);
+        xbt_test_fail("M3: n=%d (!= 3)", n);
       n++;
       xbt_ex_free(ex);
     }
     n++;
     TRY {
       if (n != 5)
-        xbt_test_fail1("M2: n=%d (!= 5)", n);
+        xbt_test_fail("M2: n=%d (!= 5)", n);
       n++;
-      THROW0(unknown_error, 0, "something");
+      THROWF(unknown_error, 0, "something");
     }
     CATCH(ex) {
       if (n != 6)
-        xbt_test_fail1("M3: n=%d (!= 6)", n);
+        xbt_test_fail("M3: n=%d (!= 6)", n);
       n++;
       RETHROW;
       n++;
     }
-    xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n);
+    xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
   }
   CATCH(ex) {
     if (n != 7)
-      xbt_test_fail1("M4: n=%d (!= 7)", n);
+      xbt_test_fail("M4: n=%d (!= 7)", n);
     n++;
     xbt_ex_free(ex);
   }
   if (n != 8)
-    xbt_test_fail1("M5: n=%d (!= 8)", n);
+    xbt_test_fail("M5: n=%d (!= 8)", n);
 }
 
 XBT_TEST_UNIT("value", test_value, "exception value passing")
@@ -257,16 +290,16 @@ XBT_TEST_UNIT("value", test_value, "exception value passing")
   xbt_ex_t ex;
 
   TRY {
-    THROW0(unknown_error, 2, "toto");
+    THROWF(unknown_error, 2, "toto");
   }
   CATCH(ex) {
-    xbt_test_add0("exception value passing");
+    xbt_test_add("exception value passing");
     if (ex.category != unknown_error)
-      xbt_test_fail1("category=%d (!= 1)", ex.category);
+      xbt_test_fail("category=%d (!= 1)", ex.category);
     if (ex.value != 2)
-      xbt_test_fail1("value=%d (!= 2)", ex.value);
+      xbt_test_fail("value=%d (!= 2)", ex.value);
     if (strcmp(ex.msg, "toto"))
-      xbt_test_fail1("message=%s (!= toto)", ex.msg);
+      xbt_test_fail("message=%s (!= toto)", ex.msg);
     xbt_ex_free(ex);
   }
 }
@@ -281,16 +314,16 @@ XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
   TRY {
     r2 = 5678;
     v2 = 5678;
-    THROW0(unknown_error, 0, "toto");
+    THROWF(unknown_error, 0, "toto");
   } CATCH(ex) {
-    xbt_test_add0("variable preservation");
+    xbt_test_add("variable preservation");
     if (r1 != 1234)
-      xbt_test_fail1("r1=%d (!= 1234)", r1);
+      xbt_test_fail("r1=%d (!= 1234)", r1);
     if (v1 != 1234)
-      xbt_test_fail1("v1=%d (!= 1234)", v1);
+      xbt_test_fail("v1=%d (!= 1234)", v1);
     /* r2 is allowed to be destroyed because not volatile */
     if (v2 != 5678)
-      xbt_test_fail1("v2=%d (!= 5678)", v2);
+      xbt_test_fail("v2=%d (!= 5678)", v2);
     xbt_ex_free(ex);
   }
 }
@@ -301,27 +334,27 @@ XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
   volatile int v1;
   int c;
 
-  xbt_test_add0("cleanup handling");
+  xbt_test_add("cleanup handling");
 
   v1 = 1234;
   c = 0;
   TRY {
     v1 = 5678;
-    THROW0(1, 2, "blah");
-  } CLEANUP {
+    THROWF(1, 2, "blah");
+  } TRY_CLEANUP {
     if (v1 != 5678)
-      xbt_test_fail1("v1 = %d (!= 5678)", v1);
+      xbt_test_fail("v1 = %d (!= 5678)", v1);
     c = 1;
   }
   CATCH(ex) {
     if (v1 != 5678)
-      xbt_test_fail1("v1 = %d (!= 5678)", v1);
+      xbt_test_fail("v1 = %d (!= 5678)", v1);
     if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg, "blah")))
-      xbt_test_fail0("unexpected exception contents");
+      xbt_test_fail("unexpected exception contents");
     xbt_ex_free(ex);
   }
   if (!c)
-    xbt_test_fail0("xbt_ex_free not executed");
+    xbt_test_fail("xbt_ex_free not executed");
 }
 
 
@@ -356,7 +389,7 @@ static void bad_example(void)
     cp3 = mallocex(SMALLAMOUNT);
     strcpy(cp1, "foo");
     strcpy(cp2, "bar");
-  } CLEANUP {
+  } TRY_CLEANUP {
     if (cp3 != NULL)
       free(cp3);
     if (cp2 != NULL)
@@ -393,7 +426,7 @@ static void good_example(void)
       cp3 = mallocex(SMALLAMOUNT);
       strcpy(cp1, "foo");
       strcpy(cp2, "bar");
-    } CLEANUP {                 /*04 */
+    } TRY_CLEANUP {             /*04 */
       printf("cp3=%s", cp3 == NULL /*02 */ ? "" : cp3);
       if (cp3 != NULL)
         free(cp3);
@@ -408,4 +441,4 @@ static void good_example(void)
   }
   /* end_of_good_example */
 }
-#endif /* SIMGRID_TEST */
+#endif                          /* SIMGRID_TEST */