#ifndef __XBT_EX_H__
#define __XBT_EX_H__
-#include <xbt/misc.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) */
#include <errno.h>
#include <stdio.h>
+
+/*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/
+#undef __EX_MAYDAY
+
+#ifdef __EX_MAYDAY
+int gras_os_getpid(void);
+# define MAYDAY_SAVE(m) printf("%d %s:%d save %p\n", \
+ gras_os_getpid(),__FILE__,__LINE__, \
+ (m)->jb \
+ ),
+# define MAYDAY_RESTORE(m) printf("%d %s:%d restore %p\n", \
+ gras_os_getpid(),__FILE__,__LINE__, \
+ (m)->jb \
+ ),
+# define MAYDAY_CATCH(e) printf("%d %s:%d Catched '%s'\n", \
+ gras_os_getpid(),__FILE__,__LINE__, \
+ e.msg \
+ ),
+#else
+# define MAYDAY_SAVE(m)
+# 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) */
#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__)
+#elif defined(__EX_MCTX_SJLJ__) || !defined(__EX_MCTX_CUSTOM__) || defined(__EX_MAYDAY)
#include <setjmp.h> /* ISO-C jmp_buf(3) */
#define __ex_mctx_struct jmp_buf jb;
-#define __ex_mctx_save(mctx) (setjmp((mctx)->jb) == 0)
+#define __ex_mctx_save(mctx) ( MAYDAY_SAVE(mctx) setjmp((mctx)->jb) == 0)
#define __ex_mctx_restored(mctx) /* noop */
-#define __ex_mctx_restore(mctx) (void)longjmp((mctx)->jb, 1)
+#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;
-
+
/** @addtogroup XBT_ex
+ * @brief A set of macros providing exception a la C++ in ANSI C (grounding feature)
*
* This module is a small ISO-C++ style exception handling library
* for use in the ISO-C language. It allows you to use the paradigm
* These features are brought to you by a modified version of the libex
* library, one of the numerous masterpiece of Ralf S. Engelschall.
*
+ * \htmlonly <div class="toc">\endhtmlonly
+ *
+ * @section XBT_ex_toc TABLE OF CONTENTS
+ *
+ * - \ref XBT_ex_intro
+ * - \ref XBT_ex_base
+ * - \ref XBT_ex_pitfalls
+ *
+ * \htmlonly </div> \endhtmlonly
+ *
* @section XBT_ex_intro DESCRIPTION
*
- * In SimGrid, exceptions is a triple <\a msg , \a category , \a value>
+ * In SimGrid, an exception is a triple <\a msg , \a category , \a value>
* where \a msg is a human-readable text describing the exceptional
* condition, \a code an integer describing what went wrong and \a value
* providing a sort of sub-category. (this is different in the original libex).
* CATCH clauses.
* - it is possible to nest TRY clauses.
*
- * The TRY block is a regular ISO-C language statement block, but it is not
+ * The TRY block is a regular ISO-C language statement block, but
+ *
+ * <center><b>it is not
* allowed to jump into it via "goto" or longjmp(3) or out of it via "break",
- * "return", "goto" or longjmp(3) because there is some hidden setup and
+ * "return", "goto" or longjmp(3)</b>.</center>
+ *
+ * This is because there is some hidden setup and
* cleanup that needs to be done regardless of whether an exception is
* caught. Bypassing these steps will break the exception handling facility.
*
* following code which shows some pitfalls and contains many errors (assuming
* a mallocex() function which throws an exception if malloc(3) fails):
*
- * \dontinclude ex_test.c
+ * \dontinclude ex.c
* \skip BAD_EXAMPLE
* \until end_of_bad_example
*
* @{
*/
+/** @brief different kind of errors */
typedef enum {
unknown_error=0, /**< unknown error */
arg_error, /**< Invalid argument */
thread_error /**< error while [un]locking */
} xbt_errcat_t;
-const char *xbt_errcat_name(xbt_errcat_t errcode);
+const char * xbt_ex_catname(xbt_errcat_t cat);
/** @brief Structure describing an exception */
typedef struct {
xbt_errcat_t category; /**< category like HTTP (what went wrong) */
int value; /**< like errno (why did it went wrong) */
/* throw point */
- char *host; /* NULL for localhost; hostname:port if remote */
+ short int remote; /* whether it was raised remotely */
+ char *host; /* NULL for localhost; hostname if remote */
+ /* FIXME: host should be hostname:port[#thread] */
char *procname;
char *file; /**< to be freed only for remote exceptions */
int line;
char *func; /**< to be freed only for remote exceptions */
/* Backtrace */
- void *bt[10];
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 */
- int ctx_caught; /* temporary flag whether exception was caught */
- volatile xbt_ex_t ctx_ex; /* temporary exception storage */
+ 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 */
#define XBT_CTX_INITIALIZER \
{ NULL, 0, { /* content */ NULL, unknown_error, 0, \
- /* throw point*/ NULL, NULL, NULL, 0, NULL,\
- /* backtrace */ {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL},0 } }
+ /* throw point*/ 0,NULL, NULL, NULL, 0, NULL,\
+ /* backtrace */ 0,NULL,{NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL} } }
#define XBT_CTX_INITIALIZE(ctx) \
do { \
- (ctx)->ctx_mctx = NULL; \
- (ctx)->ctx_caught = 0; \
- (ctx)->ctx_ex.msg = NULL; \
- (ctx)->ctx_ex.category = 0; \
- (ctx)->ctx_ex.value = 0; \
- (ctx)->ctx_ex.host = NULL; \
- (ctx)->ctx_ex.procname = NULL; \
- (ctx)->ctx_ex.file = NULL; \
- (ctx)->ctx_ex.line = 0; \
- (ctx)->ctx_ex.func = NULL; \
- (ctx)->ctx_ex.bt[0] = NULL; \
- (ctx)->ctx_ex.bt[1] = NULL; \
- (ctx)->ctx_ex.bt[2] = NULL; \
- (ctx)->ctx_ex.bt[3] = NULL; \
- (ctx)->ctx_ex.bt[4] = NULL; \
- (ctx)->ctx_ex.bt[5] = NULL; \
- (ctx)->ctx_ex.bt[6] = NULL; \
- (ctx)->ctx_ex.bt[7] = NULL; \
- (ctx)->ctx_ex.bt[8] = NULL; \
- (ctx)->ctx_ex.bt[9] = NULL; \
- (ctx)->ctx_ex.used = 0; \
+ (ctx)->ctx_mctx = NULL; \
+ (ctx)->ctx_caught = 0; \
+ (ctx)->ctx_ex.msg = NULL; \
+ (ctx)->ctx_ex.category = 0; \
+ (ctx)->ctx_ex.value = 0; \
+ (ctx)->ctx_ex.remote = 0; \
+ (ctx)->ctx_ex.host = NULL; \
+ (ctx)->ctx_ex.procname = NULL; \
+ (ctx)->ctx_ex.file = NULL; \
+ (ctx)->ctx_ex.line = 0; \
+ (ctx)->ctx_ex.func = NULL; \
+ (ctx)->ctx_ex.bt[0] = NULL; \
+ (ctx)->ctx_ex.bt[1] = NULL; \
+ (ctx)->ctx_ex.bt[2] = NULL; \
+ (ctx)->ctx_ex.bt[3] = NULL; \
+ (ctx)->ctx_ex.bt[4] = NULL; \
+ (ctx)->ctx_ex.bt[5] = NULL; \
+ (ctx)->ctx_ex.bt[6] = NULL; \
+ (ctx)->ctx_ex.bt[7] = NULL; \
+ (ctx)->ctx_ex.bt[8] = NULL; \
+ (ctx)->ctx_ex.bt[9] = NULL; \
+ (ctx)->ctx_ex.used = 0; \
+ (ctx)->ctx_ex.bt_strings = NULL; \
} while (0)
/* the exception context */
if (1) { \
if (1)
+#ifndef DOXYGEN_SKIP
+# ifdef __cplusplus
+# define XBT_EX_T_CPLUSPLUSCAST (xbt_ex_t&)
+# else
+# define XBT_EX_T_CPLUSPLUSCAST
+# endif
+#endif
+
/** @brief the block for catching (ie, deal with) an exception
* @hideinitializer
*/
-#ifdef __cplusplus
-# define XBT_EX_T_CPLUSPLUSCAST (xbt_ex_t&)
-#else
-# define XBT_EX_T_CPLUSPLUSCAST
-#endif
-
#define CATCH(e) \
else { \
} \
__xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \
} \
if ( !(__xbt_ex_ctx()->ctx_caught) \
- || ((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_ex_ctx()->ctx_ex, 0)) { \
+ || ((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_ex_ctx()->ctx_ex, MAYDAY_CATCH(e) 0)) { \
} \
else
-/** @brief Build an exception from the supplied arguments and throws it
+#define DO_THROW(e) \
+ /* deal with the exception */ \
+ if (__xbt_ex_ctx()->ctx_mctx == NULL) \
+ __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) */
+
+/** @brief Helper macro for THROWS0-6
* @hideinitializer
*
* @param c: category code (integer)
*/
#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 = (c); \
- __xbt_ex_ctx()->ctx_ex.value = (v); \
- __xbt_ex_ctx()->ctx_ex.host = (char*)NULL; \
- __xbt_ex_ctx()->ctx_ex.procname = strdup(xbt_procname()); \
- __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,10);\
- /* deal with the exception */ \
- if (__xbt_ex_ctx()->ctx_mctx == NULL) \
- __xbt_ex_terminate((xbt_ex_t *)&(__xbt_ex_ctx()->ctx_ex)); /* 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) */ \
+ 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.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);\
} while (0)
+/** @brief Builds and throws an exception with a string taking no arguments
+ @hideinitializer */
#define THROW0(c,v,m) _THROW(c,v,(m?bprintf(m):NULL))
+/** @brief Builds and throws an exception with a string taking one argument
+ @hideinitializer */
#define THROW1(c,v,m,a1) _THROW(c,v,bprintf(m,a1))
+/** @brief Builds and throws an exception with a string taking two arguments
+ @hideinitializer */
#define THROW2(c,v,m,a1,a2) _THROW(c,v,bprintf(m,a1,a2))
+/** @brief Builds and throws an exception with a string taking three arguments
+ @hideinitializer */
#define THROW3(c,v,m,a1,a2,a3) _THROW(c,v,bprintf(m,a1,a2,a3))
+/** @brief Builds and throws an exception with a string taking four arguments
+ @hideinitializer */
#define THROW4(c,v,m,a1,a2,a3,a4) _THROW(c,v,bprintf(m,a1,a2,a3,a4))
+/** @brief Builds and throws an exception with a string taking five arguments
+ @hideinitializer */
#define THROW5(c,v,m,a1,a2,a3,a4,a5) _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5))
+/** @brief Builds and throws an exception with a string taking six arguments
+ @hideinitializer */
#define THROW6(c,v,m,a1,a2,a3,a4,a5,a6) _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5,a6))
#define THROW_IMPOSSIBLE THROW0(unknown_error,0,"The Impossible Did Happen (yet again)")
-#define DIE_IMPOSSIBLE xbt_assert0(0,"The Impossible Did Happen (yet again)")
#define THROW_UNIMPLEMENTED THROW1(unknown_error,0,"Function %s unimplemented",__FUNCTION__)
+#ifndef NDEBUG
+# define DIE_IMPOSSIBLE xbt_assert0(0,"The Impossible Did Happen (yet again)")
+#else
+# define DIE_IMPOSSIBLE exit(1);
+#endif
+
/** @brief re-throwing of an already caught exception (ie, pass it to the upper catch block)
* @hideinitializer
*/
abort();\
} while(0)
-/** @brief like RETHROW, but adding some details to the message
- * @hideinitializer
- */
-
+#ifndef DOXYGEN_SKIP
#define _XBT_PRE_RETHROW \
do { \
char *_xbt_ex_internal_msg = __xbt_ex_ctx()->ctx_ex.msg; \
free(_xbt_ex_internal_msg); \
RETHROW; \
} while (0)
+#endif
+/** @brief like THROW0, but adding some details to the message of an existing exception
+ * @hideinitializer
+ */
#define RETHROW0(msg) _XBT_PRE_RETHROW msg, _XBT_POST_RETHROW
+/** @brief like THROW1, but adding some details to the message of an existing exception
+ * @hideinitializer
+ */
#define RETHROW1(msg,a) _XBT_PRE_RETHROW msg,a, _XBT_POST_RETHROW
+/** @brief like THROW2, but adding some details to the message of an existing exception
+ * @hideinitializer
+ */
#define RETHROW2(msg,a,b) _XBT_PRE_RETHROW msg,a,b, _XBT_POST_RETHROW
+/** @brief like THROW3, but adding some details to the message of an existing exception
+ * @hideinitializer
+ */
#define RETHROW3(msg,a,b,c) _XBT_PRE_RETHROW msg,a,b,c, _XBT_POST_RETHROW
+/** @brief like THROW4, but adding some details to the message of an existing exception
+ * @hideinitializer
+ */
#define RETHROW4(msg,a,b,c,d) _XBT_PRE_RETHROW msg,a,b,c, _XBT_POST_RETHROW
+/** @brief like THROW5, but adding some details to the message of an existing exception
+ * @hideinitializer
+ */
#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);
-const char * xbt_ex_catname(xbt_errcat_t cat);
void xbt_ex_display(xbt_ex_t *e);
+void xbt_backtrace_display(void);
/** @} */
#endif /* __XBT_EX_H__ */
