X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/18830ad59a14b63f78de5f8c6864ec894b00f18e..96f27c279bcb5dd32cf0e8af04bd273240d298ef:/include/xbt/ex.h diff --git a/include/xbt/ex.h b/include/xbt/ex.h index 446dfc97ec..156c820300 100644 --- a/include/xbt/ex.h +++ b/include/xbt/ex.h @@ -1,6 +1,8 @@ /* ex - Exception Handling */ -/* Copyright (c) 2005-2010 The SimGrid team */ +/* Copyright (c) 2005-2015. The SimGrid Team. + * All rights reserved. */ + /* Copyright (c) 2002-2004 Ralf S. Engelschall */ /* Copyright (c) 2002-2004 The OSSP Project */ /* Copyright (c) 2002-2004 Cable & Wireless */ @@ -65,7 +67,7 @@ SG_BEGIN_DECL() # define MAYDAY_CATCH(e) printf("%d %s:%d Catched '%s'\n", \ xbt_getpid(), __FILE__, __LINE__, \ (e).msg \ - ), + ), #else # define MAYDAY_SAVE(m) # define MAYDAY_RESTORE(m) @@ -140,7 +142,7 @@ __ex_mctx_struct} __ex_mctx_t; * * Any exception thrown directly from the TRIED_BLOCK block or from called * subroutines is caught. Cleanups which must be done after this block - * (whenever an exception arised or not) should be placed into the optionnal + * (whenever an exception arose or not) should be placed into the optionnal * CLEANUP_BLOCK. The code dealing with the exceptions when they arise should * be placed into the (mandatory) CATCH_BLOCK. * @@ -175,12 +177,8 @@ __ex_mctx_struct} __ex_mctx_t; * cleanup that needs to be done regardless of whether an exception is * caught. Bypassing these steps will break the exception handling facility. * The symptom are likely to be a segfault at the next exception raising point, - * ie far away from the point where you did the mistake. If you suspect - * that kind of error in your code, have a look at the little script - * tools/xbt_exception_checker in the CVS. It extracts all the TRY - * blocks from a set of C files you give it and display them (and only - * them) on the standard output. You can then grep for the forbidden - * keywords on that output. + * ie far away from the point where you did the mistake. Finding the problem can + * reveal challenging, unfortunately. * * The CLEANUP and CATCH blocks are regular ISO-C language statement * blocks without any restrictions. You are even allowed to throw (and, in the @@ -250,41 +248,35 @@ __ex_mctx_struct} __ex_mctx_t; /** @brief different kind of errors */ typedef enum { - 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 */ - cancel_error, /**< an action was canceled */ - thread_error, /**< error while [un]locking */ - host_error, /**< host failed */ - tracing_error, /**< error during the simulation tracing */ - io_error /**< disk or file 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 */ + cancel_error, /**< an action was canceled */ + thread_error, /**< error while [un]locking */ + host_error, /**< host failed */ + tracing_error, /**< error during the simulation tracing */ + io_error, /**< disk or file error */ + vm_error /**< vm error */ } xbt_errcat_t; 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 */ - 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 */ - int pid; /**< PID of the process who thrown this */ - char *file; /**< Thrown point */ - int line; /**< Thrown point */ - char *func; /**< Thrown point */ + 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 */ + char *func; /**< Thrown point */ /* Backtrace */ int used; char **bt_strings; /* only filed on display (or before the network propagation) */ @@ -295,54 +287,44 @@ typedef struct { * (that's where we get the process name for the logs and the exception storage) * -- do not mess with it -- */ -typedef struct { +typedef struct xbt_running_ctx_t { __ex_mctx_t *ctx_mctx; /* permanent machine context of enclosing try/catch */ - volatile int ctx_caught; /* temporary flag whether exception was caught */ + int ctx_caught; /* temporary flag whether exception was caught */ volatile xbt_ex_t exception; /* temporary exception storage */ } xbt_running_ctx_t; /* the static and dynamic initializers for a context structure */ -#define XBT_RUNNING_CTX_INITIALIZER \ - { NULL, 0, { /* content */ NULL, unknown_error, 0, \ - /* throw point*/ 0,NULL, NULL,0, NULL, 0, NULL,\ - /* backtrace */ 0,NULL,{NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL} } } +#define XBT_RUNNING_CTX_INITIALIZER \ + { NULL, 0, { /* content */ NULL, unknown_error, 0, \ + /* throw point*/ NULL, 0, NULL, 0, NULL, \ + /* backtrace */ 0, NULL, /* bt[] */ } } + +XBT_PUBLIC_DATA(const xbt_running_ctx_t) __xbt_ex_ctx_initializer; + +// #define XBT_RUNNING_CTX_INITIALIZE(ctx) (*(ctx) = __xbt_ex_ctx_initializer) + #define XBT_RUNNING_CTX_INITIALIZE(ctx) \ - do { \ - (ctx)->ctx_mctx = NULL; \ - (ctx)->ctx_caught = 0; \ - (ctx)->exception.msg = NULL; \ - (ctx)->exception.category = 0; \ - (ctx)->exception.value = 0; \ - (ctx)->exception.remote = 0; \ - (ctx)->exception.host = NULL; \ - (ctx)->exception.procname = NULL; \ - (ctx)->exception.pid = 0; \ - (ctx)->exception.file = NULL; \ - (ctx)->exception.line = 0; \ - (ctx)->exception.func = NULL; \ - (ctx)->exception.bt[0] = NULL; \ - (ctx)->exception.bt[1] = NULL; \ - (ctx)->exception.bt[2] = NULL; \ - (ctx)->exception.bt[3] = NULL; \ - (ctx)->exception.bt[4] = NULL; \ - (ctx)->exception.bt[5] = NULL; \ - (ctx)->exception.bt[6] = NULL; \ - (ctx)->exception.bt[7] = NULL; \ - (ctx)->exception.bt[8] = NULL; \ - (ctx)->exception.bt[9] = NULL; \ - (ctx)->exception.used = 0; \ - (ctx)->exception.bt_strings = NULL; \ - } while (0) + (ctx)->ctx_mctx = NULL; \ + (ctx)->ctx_caught = 0; \ + (ctx)->exception.msg = NULL; \ + (ctx)->exception.category = unknown_error; \ + (ctx)->exception.value = 0; \ + (ctx)->exception.procname = NULL; \ + (ctx)->exception.pid = 0; \ + (ctx)->exception.file = NULL; \ + (ctx)->exception.line = 0; \ + (ctx)->exception.used = 0; \ + (ctx)->exception.bt_strings = NULL; /* the exception context */ typedef xbt_running_ctx_t *(*xbt_running_ctx_fetcher_t) (void); XBT_PUBLIC_DATA(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch; -extern xbt_running_ctx_t *__xbt_ex_ctx_default(void); +XBT_PUBLIC( xbt_running_ctx_t *)__xbt_ex_ctx_default(void); /* the termination handler */ 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); +XBT_PUBLIC( void )__xbt_ex_terminate_default(xbt_ex_t * e); /** @brief Introduce a block where exception may be dealed with * @hideinitializer @@ -351,9 +333,8 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e); { \ xbt_running_ctx_t *__xbt_ex_ctx_ptr = __xbt_running_ctx_fetch(); \ int __ex_cleanup = 0; \ - __ex_mctx_t *__ex_mctx_en; \ __ex_mctx_t __ex_mctx_me; \ - __ex_mctx_en = __xbt_ex_ctx_ptr->ctx_mctx; \ + __ex_mctx_t * __ex_mctx_en = __xbt_ex_ctx_ptr->ctx_mctx; \ __xbt_ex_ctx_ptr->ctx_mctx = &__ex_mctx_me; \ if (__ex_mctx_save(&__ex_mctx_me)) { \ if (1) @@ -415,17 +396,21 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e); } \ else -#define DO_THROW(running_ctx) \ - /* deal with the exception */ \ - if (running_ctx->ctx_mctx == NULL) \ - __xbt_ex_terminate((xbt_ex_t*)&(running_ctx->exception)); /* not catched */ \ - else \ - __ex_mctx_restore(running_ctx->ctx_mctx); /* catched somewhere */ \ - abort() /* nope, stupid GCC, we won't survive a THROW (this won't be reached) */ +#define DO_THROW(running_ctx) \ + do { /* deal with the exception */ \ + xbt_running_ctx_t *ctx = (running_ctx); \ + if (ctx->ctx_mctx == NULL) \ + __xbt_ex_terminate((xbt_ex_t*)&(ctx->exception)); /* not catched */ \ + else \ + __ex_mctx_restore(ctx->ctx_mctx); /* catched somewhere */ \ + abort(); /* nope, stupid GCC, we won't survive a THROW */ \ + /* (this won't be reached) */ \ + } while(0) /** @brief Helper macro for THROW and THROWF * @hideinitializer * + * @param _throw_ctx: the throwing context in which we should construct the exception * @param c: category code (integer) * @param v: value (integer) * @param m: message text @@ -441,56 +426,47 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e); * CLEANUP and CATCH blocks. */ -#define _THROW(c,v,m) \ - do { /* change this sequence into one block */ \ - xbt_running_ctx_t *_throw_ctx = __xbt_running_ctx_fetch(); \ - /* build the exception */ \ - _throw_ctx->exception.msg = (m); \ - _throw_ctx->exception.category = (xbt_errcat_t)(c); \ - _throw_ctx->exception.value = (v); \ - _throw_ctx->exception.remote = 0; \ - _throw_ctx->exception.host = (char*)NULL; \ - _throw_ctx->exception.procname = (char*)xbt_procname(); \ - _throw_ctx->exception.pid = xbt_getpid(); \ - _throw_ctx->exception.file = (char*)__FILE__; \ - _throw_ctx->exception.line = __LINE__; \ - _throw_ctx->exception.func = (char*)_XBT_FUNCTION; \ - _throw_ctx->exception.bt_strings = NULL; \ - xbt_backtrace_current( (xbt_ex_t *) &(_throw_ctx->exception) ); \ - DO_THROW(_throw_ctx); \ +#define THROW_PREPARE(_throw_ctx, c, v, m) \ + /* build the exception */ \ + _throw_ctx->exception.msg = (m); \ + _throw_ctx->exception.category = (xbt_errcat_t)(c); \ + _throw_ctx->exception.value = (v); \ + _throw_ctx->exception.procname = (char*)xbt_procname(); \ + _throw_ctx->exception.pid = xbt_getpid(); \ + _throw_ctx->exception.file = (char*)__FILE__; \ + _throw_ctx->exception.line = __LINE__; \ + _throw_ctx->exception.func = (char*)__func__; \ + _throw_ctx->exception.bt_strings = NULL; \ + xbt_backtrace_current((xbt_ex_t *)&(_throw_ctx->exception)); + +#define _XBT_THROW(c, v, m) \ + do { /* change this sequence into one block */ \ + xbt_running_ctx_t *_throw_ctx = __xbt_running_ctx_fetch(); \ + THROW_PREPARE(_throw_ctx, c, v, m); \ + DO_THROW(_throw_ctx); \ } while (0) /** @brief Builds and throws an exception @hideinitializer */ -#define THROW(c, v) _THROW(c, v, NULL) +#define THROW(c, v) _XBT_THROW(c, v, NULL) /** @brief Builds and throws an exception with a printf-like formatted message @hideinitializer */ -#define THROWF(c, v, ...) _THROW(c, v, bprintf(__VA_ARGS__)) +#define THROWF(c, v, ...) _XBT_THROW(c, v, bprintf(__VA_ARGS__)) #define THROW_IMPOSSIBLE \ THROWF(unknown_error, 0, "The Impossible Did Happen (yet again)") #define THROW_UNIMPLEMENTED \ - THROWF(unknown_error, 0, "Function %s unimplemented",_XBT_FUNCTION) + THROWF(unknown_error, 0, "Function %s unimplemented",__func__) +#define THROW_DEADCODE \ + THROWF(unknown_error, 0, "Function %s was supposed to be DEADCODE, but it's not",__func__) -#ifndef NDEBUG -# define DIE_IMPOSSIBLE xbt_assert(0,"The Impossible Did Happen (yet again)") -#else -# define DIE_IMPOSSIBLE exit(1); -#endif +#define DIE_IMPOSSIBLE xbt_die("The Impossible Did Happen (yet again)") /** @brief re-throwing of an already caught exception (ie, pass it to the upper catch block) * @hideinitializer */ -#define RETHROW \ - do { \ - xbt_running_ctx_t *ctx = __xbt_running_ctx_fetch(); \ - if (ctx->ctx_mctx == NULL) \ - __xbt_ex_terminate((xbt_ex_t*)&(ctx->exception)); \ - else \ - __ex_mctx_restore(ctx->ctx_mctx); \ - abort();\ - } while(0) +#define RETHROW DO_THROW(__xbt_running_ctx_fetch()) /** @brief like THROWF, but adding some details to the message of an existing exception * @hideinitializer @@ -506,40 +482,21 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e); /** @brief Exception destructor */ XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e); +/** @brief The display made by an exception that is not catched */ +XBT_PUBLIC(void) xbt_ex_display(xbt_ex_t * e); /** @brief Shows a backtrace of the current location */ XBT_PUBLIC(void) xbt_backtrace_display_current(void); /** @brief reimplementation of glibc backtrace based directly on gcc library, without implicit malloc */ -XBT_PUBLIC(int)xbt_backtrace_no_malloc(void**bt, int size); +XBT_PUBLIC(int) xbt_backtrace_no_malloc(void**bt, int size); /** @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); - -#ifdef XBT_USE_DEPRECATED - -/* Kept for backward compatibility. */ - -#define THROW0(c, v, m) \ - do { if (m) THROWF(c, v, m); else THROW(c, v); } while (0) -#define THROW1(c, v, ...) THROWF(c, v, __VA_ARGS__) -#define THROW2(c, v, ...) THROWF(c, v, __VA_ARGS__) -#define THROW3(c, v, ...) THROWF(c, v, __VA_ARGS__) -#define THROW4(c, v, ...) THROWF(c, v, __VA_ARGS__) -#define THROW5(c, v, ...) THROWF(c, v, __VA_ARGS__) -#define THROW6(c, v, ...) THROWF(c, v, __VA_ARGS__) -#define THROW7(c, v, ...) THROWF(c, v, __VA_ARGS__) - -#define RETHROW0(...) RETHROWF(__VA_ARGS__) -#define RETHROW1(...) RETHROWF(__VA_ARGS__) -#define RETHROW2(...) RETHROWF(__VA_ARGS__) -#define RETHROW3(...) RETHROWF(__VA_ARGS__) -#define RETHROW4(...) RETHROWF(__VA_ARGS__) -#define RETHROW5(...) RETHROWF(__VA_ARGS__) - -#endif +/** @brief Get current backtrace with libunwind */ +XBT_PUBLIC(int) xbt_libunwind_backtrace(void *bt[XBT_BACKTRACE_SIZE], int size); SG_END_DECL() -/** @} */ +/** @} */ #endif /* __XBT_EX_H__ */