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).
* 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 {
int line;
char *func; /**< to be freed only for remote exceptions */
/* Backtrace */
- void *bt[10];
+ void *bt[XBT_BACKTRACE_SIZE];
int used;
} xbt_ex_t;
/* 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) \
(ctx)->ctx_mctx = NULL; \
(ctx)->ctx_caught = 0; \
(ctx)->ctx_ex.msg = NULL; \
- (ctx)->ctx_ex.category = 0; \
+ (ctx)->ctx_ex.category = unknown_error; \
(ctx)->ctx_ex.value = 0; \
(ctx)->ctx_ex.host = NULL; \
(ctx)->ctx_ex.procname = NULL; \
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)
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.category = (xbt_errcat_t)(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);\
+ __xbt_ex_ctx()->ctx_ex.used = backtrace((void**)__xbt_ex_ctx()->ctx_ex.bt,XBT_BACKTRACE_SIZE);\
/* deal with the exception */ \
if (__xbt_ex_ctx()->ctx_mctx == NULL) \
__xbt_ex_terminate((xbt_ex_t *)&(__xbt_ex_ctx()->ctx_ex)); /* not catched */\
abort();/* nope, stupid GCC, we won't survive a THROW (this won't be reached) */ \
} 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);
