-/*
-** OSSP ex - Exception Handling (modified to fit into SimGrid)
-** Copyright (c) 2005 Martin Quinson
-** 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.
-**
-** ex.c: exception handling (compiler part)
-*/
+/* $Id$ */
+
+/* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
+
+/* Copyright (c) 2005, 2006, 2007 Martin Quinson */
+/* 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. */
#include <stdio.h>
#include <stdlib.h>
#include "portable.h" /* execinfo when available */
#include "xbt/ex.h"
+#include "xbt/str.h"
#include "xbt/module.h" /* xbt_binary_name */
-#include "xbt/ex_interface.h"
+#include "xbt_modinter.h" /* backtrace initialization headers */
+#include "xbt/synchro.h" /* xbt_thread_self */
#include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
+#include "xbt/ex_interface.h"
+
+#undef HAVE_BACKTRACE
+#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
+# define HAVE_BACKTRACE 1 /* Hello linux box */
+#endif
+
+#if defined(WIN32) && defined(_M_IX86) && !defined(__GNUC__)
+# define HAVE_BACKTRACE 1 /* Hello x86 windows box */
+#endif
+
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex,xbt,"Exception mecanism");
/* default __ex_ctx callback function */
ex_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).
+
+ This default gets overriden in xbt/xbt_os_thread.c so that it works in
+ real life and in simulation when using threads to implement the simulation
+ processes (ie, with pthreads and on windows).
+
+ 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;
return &ctx;
}
-void xbt_ex_setup_backtrace(xbt_ex_t *e) {
-#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
+/* Change raw libc symbols to file names and line numbers */
+void xbt_ex_setup_backtrace(xbt_ex_t *e);
+
+void xbt_backtrace_current(xbt_ex_t *e) {
+#ifdef HAVE_BACKTRACE
+ xbt_ex_setup_backtrace(e);
+#endif
+}
+
+void xbt_backtrace_display(xbt_ex_t *e) {
+#ifdef HAVE_BACKTRACE
int i;
- /* to get the backtrace from the libc */
- char **backtrace = backtrace_symbols (e->bt, e->used);
-
- /* To build the commandline of addr2line */
- char *cmd = xbt_new(char,strlen(ADDR2LINE)+strlen(xbt_binary_name)+20*e->used);
- char *curr=cmd;
-
- /* to extract the addresses from the backtrace */
- char **addrs=xbt_new(char*,e->used);
- char buff[256],*p;
-
- /* To read the output of addr2line */
- FILE *pipe;
- char line_func[1024],line_pos[1024];
-
- /* build the commandline */
- curr += sprintf(curr,"%s -f -e %s ",ADDR2LINE,xbt_binary_name);
- for (i=0; i<e->used;i++) {
- /* retrieve this address */
- snprintf(buff,256,"%s",strchr(backtrace[i],'[')+1);
- p=strchr(buff,']');
- *p='\0';
- addrs[i]=bprintf("%s",buff);
-
- /* Add it to the command line args */
- curr+=sprintf(curr,"%s ",addrs[i]);
- }
-
- /* parse the output and build a new backtrace */
- e->bt_strings = xbt_new(char*,e->used);
-
- pipe = popen(cmd, "r");
- // xbt_assert(pipe);//,"Cannot fork addr2line to display the backtrace");
- for (i=0; i<e->used; i++) {
- fgets(line_func,1024,pipe);
- line_func[strlen(line_func)-1]='\0';
- fgets(line_pos,1024,pipe);
- line_pos[strlen(line_pos)-1]='\0';
-
- if (strcmp("??",line_func)) {
- e->bt_strings[i] = bprintf("** At %s: %s (%s)", addrs[i], line_func,line_pos);
- } else {
- char *p=bprintf("%s",backtrace[i]);
- char *pos=strrchr(p,' ');
- *pos = '\0';
- e->bt_strings[i] = bprintf("** At %s: ?? (%s)", addrs[i], p);
- free(p);
- }
- free(addrs[i]);
+
+ if (e->used == 0) {
+ fprintf(stderr,"(backtrace not set)\n");
+ } else {
+ fprintf(stderr,"Backtrace (displayed in thread %p):\n",
+ (void*)xbt_thread_self());
+ for (i=1; i<e->used; i++) /* no need to display "xbt_display_backtrace" */
+ fprintf(stderr,"---> %s\n",e->bt_strings[i] +4);
}
- free(addrs);
- free(backtrace);
- free(cmd);
+
+ /* don't fool xbt_ex_free with uninitialized msg field */
+ e->msg=NULL;
+ e->remote=0;
+ xbt_ex_free(*e);
+#else
+
+ ERROR0("No backtrace on this arch");
+#endif
+}
+
+/** \brief show the backtrace of the current point (lovely while debuging) */
+void xbt_backtrace_display_current(void) {
+ xbt_ex_t e;
+ xbt_backtrace_current(&e);
+ xbt_backtrace_display(&e);
+}
+
+#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
+# include "backtrace_linux.c"
+#elif (defined(WIN32) && defined (_M_IX86)) && !defined(__GNUC__)
+# include "backtrace_windows.c"
+#else
+# include "backtrace_dummy.c"
#endif
-}
/** @brief shows an exception content and the associated stack if available */
void xbt_ex_display(xbt_ex_t *e) {
+ char *thrower=NULL;
+
+ if (e->remote)
+ thrower = bprintf(" on host %s(%d)",e->host,e->pid);
fprintf(stderr,
- "** SimGrid: UNCAUGHT EXCEPTION on %s: category: %s; value: %d\n"
+ "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
"** %s\n"
- "** Thrown by %s%s%s",
- gras_os_myname(),
+ "** Thrown by %s()%s\n",
+ gras_os_myname(),(*xbt_getpid)(),
xbt_ex_catname(e->category), e->value, e->msg,
- e->procname, (e->host?"@":""),(e->host?e->host:""));
+ e->procname,thrower?thrower:" in this process");
+ CRITICAL1("%s",e->msg);
+
+ if (thrower)
+ free(thrower);
if (!e->remote && !e->bt_strings)
xbt_ex_setup_backtrace(e);
-#if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
+#ifdef HAVE_BACKTRACE
/* We have everything to build neat backtraces */
{
int i;
fprintf(stderr," at %s:%d:%s (no backtrace available on that arch)\n",
e->file,e->line,e->func);
#endif
- xbt_ex_free(e);
+ xbt_ex_free(*e);
}
}
/* the externally visible API */
-ex_ctx_cb_t __xbt_ex_ctx = &__xbt_ex_ctx_default;
-ex_term_cb_t __xbt_ex_terminate = &__xbt_ex_terminate_default;
+XBT_EXPORT_NO_IMPORT(ex_ctx_cb_t) __xbt_ex_ctx = &__xbt_ex_ctx_default;
+XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate = &__xbt_ex_terminate_default;
+
-void xbt_ex_free(xbt_ex_t *e) {
+void xbt_ex_free(xbt_ex_t e) {
int i;
- if (e->msg) free(e->msg);
- free(e->procname);
- if (e->remote) {
- free(e->file);
- free(e->func);
- free(e->host);
+ if (e.msg) free(e.msg);
+ if (e.remote) {
+ free(e.procname);
+ free(e.file);
+ free(e.func);
+ free(e.host);
}
- if (e->bt_strings) {
- for (i=0; i<e->used; i++)
- free(e->bt_strings[i]);
- free(e->bt_strings);
- e->bt_strings = NULL;
+
+ if (e.bt_strings) {
+ for (i=0; i<e.used; i++)
+ free((char*)e.bt_strings[i]);
+ free((char **)e.bt_strings);
}
-
+ /* memset(e,0,sizeof(xbt_ex_t)); */
}
/** \brief returns a short name for the given exception category */
}
}
-#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 <stdio.h>
#include "xbt/ex.h"
XBT_TEST_SUITE("xbt_ex","Exception Handling");
THROW0(unknown_error,0,"something");
} CATCH (ex) {
if (n != 3)
- xbt_test_fail1("M3: n=%d (!= 1)", n);
+ xbt_test_fail1("M3: n=%d (!= 3)", n);
+ n++;
+ xbt_ex_free(ex);
+ }
+ n++;
+ TRY {
+ if (n != 5)
+ xbt_test_fail1("M2: n=%d (!= 5)", n);
+ n++;
+ THROW0(unknown_error,0,"something");
+ } CATCH (ex) {
+ if (n != 6)
+ xbt_test_fail1("M3: n=%d (!= 6)", n);
n++;
RETHROW;
+ n++;
}
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);
+ if (n != 7)
+ xbt_test_fail1("M4: n=%d (!= 7)", n);
n++;
- xbt_ex_free(&ex);
+ xbt_ex_free(ex);
}
- if (n != 5)
- xbt_test_fail1("M5: n=%d (!= 5)", n);
+ if (n != 8)
+ xbt_test_fail1("M5: n=%d (!= 8)", n);
}
XBT_TEST_UNIT("value",test_value,"exception value passing") {
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_ex_free(ex);
}
}
/* r2 is allowed to be destroyed because not volatile */
if (v2 != 5678)
xbt_test_fail1("v2=%d (!= 5678)", v2);
- xbt_ex_free(&ex);
+ xbt_ex_free(ex);
}
}
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);
+ xbt_ex_free(ex);
}
if (!c)
xbt_test_fail0("xbt_ex_free not executed");
/* end_of_bad_example */
}
#endif
-
+typedef struct {char *first;} global_context_t;
+
static void good_example(void) {
- struct {char*first;} *globalcontext;
+ global_context_t *global_context=malloc(sizeof(global_context_t));
xbt_ex_t ex;
/* GOOD_EXAMPLE */
char * volatile /*03*/ cp3 = NULL /*02*/;
TRY {
cp1 = mallocex(SMALLAMOUNT);
- globalcontext->first = cp1;
+ global_context->first = cp1;
cp1 = NULL /*05 give away*/;
cp2 = mallocex(TOOBIG);
cp3 = mallocex(SMALLAMOUNT);
