#include <xbt/misc.h>
#include <xbt/sysdep.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>
-//#define __EX_MCTX_MCSC__ 1
-#define __EX_MCTX_SSJLJ__ 1
/* the machine context */
#if defined(__EX_MCTX_MCSC__)
#include <ucontext.h> /* POSIX.1 ucontext(3) */
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)
+ *
+ * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref XBT_API]
+ * <tr><td><b>Prev</b> <td> [\ref XBT_syscall]
+ * <tr><td><b>Next</b> <td> [\ref XBT_log] </table></center>
*
* 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.
*
+ * @section XBT_ex_toc TABLE OF CONTENTS
+ *
+ * - \ref XBT_ex_intro
+ * - \ref XBT_ex_base
+ * - \ref XBT_ex_pitfalls
+ *
* @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).
* 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
*
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 {
/* the static and dynamic initializers for a context structure */
#define XBT_CTX_INITIALIZER \
- { NULL, 0, { /* content */ NULL, 0, 0, \
+ { 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 } }
#define XBT_CTX_INITIALIZE(ctx) \
/* 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) __attribute__((__noreturn__));
+extern void __xbt_ex_terminate_default(xbt_ex_t *e);
/** @brief Introduce a block where exception may be dealed with
* @hideinitializer
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
*/
__xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \
} \
if ( !(__xbt_ex_ctx()->ctx_caught) \
- || ((e) = __xbt_ex_ctx()->ctx_ex, 0)) { \
+ || ((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_ex_ctx()->ctx_ex, 0)) { \
} \
else
-/** @brief Build an exception from the supplied arguments and throws it
+/** @brief Helper macro for THROWS0-6
* @hideinitializer
*
* @param c: category code (integer)
* The THROW can be performed everywhere, including inside TRY,
* CLEANUP and CATCH blocks.
*/
-#include <execinfo.h>
+
#define _THROW(c,v,m) \
do { /* change this sequence into one block */ \
/* build the exception */ \
abort();/* nope, stupid GCC, we won't survive a THROW (this won't be reached) */ \
} while (0)
-#define THROW0(c,v,m) _THROW(c,v,bprintf(m))
+/** @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)")
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);
/** @} */
#endif /* __XBT_EX_H__ */
