X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1e7fc6623021c8649b97baa60b63c8463d02a9a3..ac9b849c157154d379961e139bf8e1a436eb0bc1:/include/xbt/ex.h diff --git a/include/xbt/ex.h b/include/xbt/ex.h index cd66c738ab..1b92377d8d 100644 --- a/include/xbt/ex.h +++ b/include/xbt/ex.h @@ -32,8 +32,8 @@ #ifndef __XBT_EX_H__ #define __XBT_EX_H__ -#include #include +#include /* 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) */ @@ -70,6 +70,7 @@ extern int backtrace (void **__array, int __size); 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 @@ -87,9 +88,19 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * These features are brought to you by a modified version of the libex * library, one of the numerous masterpiece of Ralf S. Engelschall. * + * \htmlonly
\endhtmlonly + * + * @section XBT_ex_toc TABLE OF CONTENTS + * + * - \ref XBT_ex_intro + * - \ref XBT_ex_base + * - \ref XBT_ex_pitfalls + * + * \htmlonly
\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). @@ -159,7 +170,7 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * 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 * @@ -200,6 +211,7 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * @{ */ +/** @brief different kind of errors */ typedef enum { unknown_error=0, /**< unknown error */ arg_error, /**< Invalid argument */ @@ -212,7 +224,7 @@ typedef enum { 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 { @@ -220,14 +232,16 @@ 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 */ + 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) */ @@ -241,30 +255,31 @@ typedef struct { #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 } } + /* 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.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 */ @@ -307,15 +322,17 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); 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 { \ } \ @@ -334,7 +351,15 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); } \ 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) @@ -356,34 +381,48 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); 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);\ - /* 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) */ \ + __xbt_ex_ctx()->ctx_ex.used = backtrace((void**)__xbt_ex_ctx()->ctx_ex.bt,XBT_BACKTRACE_SIZE);\ + 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 */ @@ -396,11 +435,8 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); 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; \ @@ -410,16 +446,35 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); 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);