-/* $Id$ */
+/* ex - Exception Handling */
-/* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
-
-/* Copyright (c) 2005-2006 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 */
#ifndef __XBT_EX_H__
#define __XBT_EX_H__
-#include <xbt/sysdep.h>
-#include <xbt/misc.h>
-
-/* do not include execinfo.h directly since it's not always available.
- Instead, copy the parts we need (and fake when it's not there) */
-extern int backtrace (void **__array, int __size);
-
-/* required ISO-C standard facilities */
-#include <errno.h>
-#include <stdio.h>
+#include "xbt/sysdep.h"
+#include "xbt/misc.h"
+#include "xbt/virtu.h"
+SG_BEGIN_DECL()
/*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/
#undef __EX_MAYDAY
-
#ifdef __EX_MAYDAY
-int gras_os_getpid(void);
+# include <stdio.h>
+#include <errno.h>
# define MAYDAY_SAVE(m) printf("%d %s:%d save %p\n", \
- gras_os_getpid(),__FILE__,__LINE__, \
+ (*xbt_getpid)(),__FILE__,__LINE__, \
(m)->jb \
),
# define MAYDAY_RESTORE(m) printf("%d %s:%d restore %p\n", \
- gras_os_getpid(),__FILE__,__LINE__, \
+ (*xbt_getpid)(),__FILE__,__LINE__, \
(m)->jb \
),
# define MAYDAY_CATCH(e) printf("%d %s:%d Catched '%s'\n", \
- gras_os_getpid(),__FILE__,__LINE__, \
+ (*xbt_getpid)(),__FILE__,__LINE__, \
e.msg \
),
#else
# define MAYDAY_RESTORE(m)
# define MAYDAY_CATCH(e)
#endif
-
/*-*-* end of debugging stuff *-*-*/
-
-
-/* the machine context */
#if defined(__EX_MCTX_MCSC__)
-#include <ucontext.h> /* POSIX.1 ucontext(3) */
+#include <ucontext.h> /* POSIX.1 ucontext(3) */
#define __ex_mctx_struct ucontext_t uc;
#define __ex_mctx_save(mctx) (getcontext(&(mctx)->uc) == 0)
-#define __ex_mctx_restored(mctx) /* noop */
+#define __ex_mctx_restored(mctx) /* noop */
#define __ex_mctx_restore(mctx) (void)setcontext(&(mctx)->uc)
-
#elif defined(__EX_MCTX_SSJLJ__)
-#include <setjmp.h> /* POSIX.1 sigjmp_buf(3) */
+#include <setjmp.h> /* POSIX.1 sigjmp_buf(3) */
#define __ex_mctx_struct sigjmp_buf jb;
#define __ex_mctx_save(mctx) (sigsetjmp((mctx)->jb, 1) == 0)
-#define __ex_mctx_restored(mctx) /* noop */
+#define __ex_mctx_restored(mctx) /* noop */
#define __ex_mctx_restore(mctx) (void)siglongjmp((mctx)->jb, 1)
-
#elif defined(__EX_MCTX_SJLJ__) || !defined(__EX_MCTX_CUSTOM__) || defined(__EX_MAYDAY)
-#include <setjmp.h> /* ISO-C jmp_buf(3) */
+#include <setjmp.h> /* ISO-C jmp_buf(3) */
#define __ex_mctx_struct jmp_buf jb;
#define __ex_mctx_save(mctx) ( MAYDAY_SAVE(mctx) setjmp((mctx)->jb) == 0)
-#define __ex_mctx_restored(mctx) /* noop */
+#define __ex_mctx_restored(mctx) /* noop */
#define __ex_mctx_restore(mctx) ( MAYDAY_RESTORE(mctx) (void)longjmp((mctx)->jb, 1))
#endif
-
/* declare the machine context type */
-typedef struct { __ex_mctx_struct } __ex_mctx_t;
+typedef struct {
+__ex_mctx_struct} __ex_mctx_t;
/** @addtogroup XBT_ex
* @brief A set of macros providing exception a la C++ in ANSI C (grounding feature)
*
* @section XBT_ex_base BASIC USAGE
*
- * \em TRY \b TRIED_BLOCK [\em CLEANUP \b CLEANUP_BLOCK] \em CATCH (variable) \b CATCH_BLOCK
+ * \em TRY \b TRIED_BLOCK [\em TRY_CLEANUP \b CLEANUP_BLOCK] \em CATCH (variable) \b CATCH_BLOCK
*
* This is the primary syntactical construct provided. It is modeled after the
* ISO-C++ try-catch clause and should sound familiar to most of you.
*
*
* In absence of exception, the control flow goes into the blocks TRIED_BLOCK
- * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored.
+ * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored.
*
* When an exception is thrown, the control flow goes through the following
* blocks: TRIED_BLOCK (up to the statement throwing the exception),
* @{
*/
-/* we need this symbol here, even if it breaks a bit the module separation */
-long int gras_os_getpid(void);
-
/** @brief different kind of errors */
typedef enum {
- unknown_error=0, /**< unknown error */
+ unknown_error = 0,/**< unknown error */
arg_error, /**< Invalid argument */
+ bound_error, /**< Out of bounds argument */
mismatch_error, /**< The provided ID does not match */
not_found_error, /**< The searched element was not found */
-
+
system_error, /**< a syscall did fail */
network_error, /**< error while sending/receiving data */
timeout_error, /**< not quick enough, dude */
- thread_error /**< error while [un]locking */
+ thread_error, /**< error while [un]locking */
+ host_error, /**< host failed */
+ tracing_error /**< error during the simulation tracing */
} xbt_errcat_t;
-const char * xbt_ex_catname(xbt_errcat_t cat);
+XBT_PUBLIC(const char *) xbt_ex_catname(xbt_errcat_t cat);
/** @brief Structure describing an exception */
typedef struct {
- char *msg; /**< human readable message */
- xbt_errcat_t category; /**< category like HTTP (what went wrong) */
- int value; /**< like errno (why did it went wrong) */
+ char *msg; /**< human readable message */
+ xbt_errcat_t category;
+ /**< category like HTTP (what went wrong) */
+ int value; /**< like errno (why did it went wrong) */
/* throw point */
- short int remote; /**< whether it was raised remotely */
+ short int remote;
+ /**< whether it was raised remotely */
char *host; /**< NULL locally thrown exceptions; full hostname if remote ones */
/* FIXME: host should be hostname:port[#thread] */
- char *procname; /**< Name of the process who thrown this */
- long int pid; /**< PID of the process who thrown this */
+ char *procname;
+ /**< Name of the process who thrown this */
+ int pid; /**< PID of the process who thrown this */
char *file; /**< Thrown point */
- int line; /**< Thrown point */
+ int line; /**< Thrown point */
char *func; /**< Thrown point */
/* Backtrace */
- int used;
- char **bt_strings; /* only filed on display (or before the network propagation) */
+ int used;
+ char **bt_strings; /* only filed on display (or before the network propagation) */
void *bt[XBT_BACKTRACE_SIZE];
} xbt_ex_t;
/* declare the context type (private) */
typedef struct {
- __ex_mctx_t *ctx_mctx; /* permanent machine context of enclosing try/catch */
- volatile int ctx_caught; /* temporary flag whether exception was caught */
- volatile xbt_ex_t ctx_ex; /* temporary exception storage */
+ __ex_mctx_t *ctx_mctx; /* permanent machine context of enclosing try/catch */
+ volatile int ctx_caught; /* temporary flag whether exception was caught */
+ volatile xbt_ex_t ctx_ex; /* temporary exception storage */
} ex_ctx_t;
/* the static and dynamic initializers for a context structure */
} while (0)
/* the exception context */
-typedef ex_ctx_t *(*ex_ctx_cb_t)(void);
-extern ex_ctx_cb_t __xbt_ex_ctx;
+typedef ex_ctx_t *(*ex_ctx_cb_t) (void);
+XBT_PUBLIC_DATA(ex_ctx_cb_t) __xbt_ex_ctx;
extern ex_ctx_t *__xbt_ex_ctx_default(void);
/* the termination handler */
-typedef void (*ex_term_cb_t)(xbt_ex_t *);
-extern ex_term_cb_t __xbt_ex_terminate;
-extern void __xbt_ex_terminate_default(xbt_ex_t *e);
+typedef void (*ex_term_cb_t) (xbt_ex_t *);
+XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate;
+extern void __xbt_ex_terminate_default(xbt_ex_t * e);
/** @brief Introduce a block where exception may be dealed with
* @hideinitializer
if (__ex_mctx_save(&__ex_mctx_me)) { \
if (1)
-/** @brief optional(!) block for cleanup
+/** @brief optional(!) block for cleanup
* @hideinitializer
*/
-#define CLEANUP \
+#define TRY_CLEANUP \
else { \
} \
__xbt_ex_ctx_ptr->ctx_caught = 0; \
# ifdef __cplusplus
# define XBT_EX_T_CPLUSPLUSCAST (xbt_ex_t&)
# else
-# define XBT_EX_T_CPLUSPLUSCAST
+# define XBT_EX_T_CPLUSPLUSCAST
# endif
#endif
__xbt_ex_terminate((xbt_ex_t *)&(e)); /* not catched */\
else \
__ex_mctx_restore(__xbt_ex_ctx()->ctx_mctx); /* catched somewhere */ \
- abort()/* nope, stupid GCC, we won't survive a THROW (this won't be reached) */
+ abort() /* nope, stupid GCC, we won't survive a THROW (this won't be reached) */
/** @brief Helper macro for THROWS0-6
* @hideinitializer
*
* If called from within a TRY/CATCH construct, this exception
* is copied into the CATCH relevant variable program control flow
- * is derouted to the CATCH (after the optional sg_cleanup).
+ * is derouted to the CATCH (after the optional sg_cleanup).
*
- * If no TRY/CATCH construct embeeds this call, the program calls
+ * If no TRY/CATCH construct embeds this call, the program calls
* abort(3).
*
* The THROW can be performed everywhere, including inside TRY,
*/
#define _THROW(c,v,m) \
- do { /* change this sequence into one block */ \
- /* build the exception */ \
- __xbt_ex_ctx()->ctx_ex.msg = (m); \
- __xbt_ex_ctx()->ctx_ex.category = (xbt_errcat_t)(c); \
- __xbt_ex_ctx()->ctx_ex.value = (v); \
- __xbt_ex_ctx()->ctx_ex.remote = 0; \
- __xbt_ex_ctx()->ctx_ex.host = (char*)NULL; \
- __xbt_ex_ctx()->ctx_ex.procname = (char*)xbt_procname(); \
- __xbt_ex_ctx()->ctx_ex.pid = gras_os_getpid(); \
- __xbt_ex_ctx()->ctx_ex.file = (char*)__FILE__; \
- __xbt_ex_ctx()->ctx_ex.line = __LINE__; \
- __xbt_ex_ctx()->ctx_ex.func = (char*)_XBT_FUNCTION; \
- __xbt_ex_ctx()->ctx_ex.used = backtrace((void**)__xbt_ex_ctx()->ctx_ex.bt,XBT_BACKTRACE_SIZE);\
- __xbt_ex_ctx()->ctx_ex.bt_strings = NULL; \
- DO_THROW(__xbt_ex_ctx()->ctx_ex);\
+ do { /* change this sequence into one block */ \
+ ex_ctx_t *_throw_ctx = __xbt_ex_ctx(); \
+ /* build the exception */ \
+ _throw_ctx->ctx_ex.msg = (m); \
+ _throw_ctx->ctx_ex.category = (xbt_errcat_t)(c); \
+ _throw_ctx->ctx_ex.value = (v); \
+ _throw_ctx->ctx_ex.remote = 0; \
+ _throw_ctx->ctx_ex.host = (char*)NULL; \
+ _throw_ctx->ctx_ex.procname = (char*)xbt_procname(); \
+ _throw_ctx->ctx_ex.pid = (*xbt_getpid)(); \
+ _throw_ctx->ctx_ex.file = (char*)__FILE__; \
+ _throw_ctx->ctx_ex.line = __LINE__; \
+ _throw_ctx->ctx_ex.func = (char*)_XBT_FUNCTION; \
+ _throw_ctx->ctx_ex.bt_strings = NULL; \
+ xbt_backtrace_current( (xbt_ex_t *) &(_throw_ctx->ctx_ex) ); \
+ DO_THROW(_throw_ctx->ctx_ex); \
} while (0)
+/* __xbt_ex_ctx()->ctx_ex.used = backtrace((void**)__xbt_ex_ctx()->ctx_ex.bt,XBT_BACKTRACE_SIZE); */
/** @brief Builds and throws an exception with a string taking no arguments
@hideinitializer */
#define THROW7(c,v,m,a1,a2,a3,a4,a5,a6,a7) _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5,a6,a7))
#define THROW_IMPOSSIBLE THROW0(unknown_error,0,"The Impossible Did Happen (yet again)")
-#define THROW_UNIMPLEMENTED THROW1(unknown_error,0,"Function %s unimplemented",__FUNCTION__)
+#define THROW_UNIMPLEMENTED THROW1(unknown_error,0,"Function %s unimplemented",_XBT_FUNCTION)
#ifndef NDEBUG
# define DIE_IMPOSSIBLE xbt_assert0(0,"The Impossible Did Happen (yet again)")
#define RETHROW5(msg,a,b,c,d,e) _XBT_PRE_RETHROW msg,a,b,c,d,e, _XBT_POST_RETHROW
/** @brief Exception destructor */
-void xbt_ex_free(xbt_ex_t e);
+XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e);
+
+/** @brief Shows a backtrace of the current location */
+XBT_PUBLIC(void) xbt_backtrace_display_current(void);
+/** @brief Captures a backtrace for further use */
+XBT_PUBLIC(void) xbt_backtrace_current(xbt_ex_t * e);
+/** @brief Display a previously captured backtrace */
+XBT_PUBLIC(void) xbt_backtrace_display(xbt_ex_t * e);
-void xbt_ex_display(xbt_ex_t *e);
-void xbt_backtrace_display(void);
+SG_END_DECL()
/** @} */
-#endif /* __XBT_EX_H__ */
-
+#endif /* __XBT_EX_H__ */
