X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/837788ebd988892ad55ee58b2ff15c1c9c93a319..b9d8ff0f5f0819d9103795c70ed49534d695f8ba:/include/xbt/ex.h diff --git a/include/xbt/ex.h b/include/xbt/ex.h index 5405c36354..f23bd37e1d 100644 --- a/include/xbt/ex.h +++ b/include/xbt/ex.h @@ -1,6 +1,16 @@ -/* -** OSSP ex - Exception Handling (modified to fit into SimGrid) -** Copyright (c) 2005 Martin Quinson. +/* ex - Exception Handling */ + +/* Copyright (c) 2005-2010 The SimGrid team */ +/* Copyright (c) 2002-2004 Ralf S. Engelschall */ +/* Copyright (c) 2002-2004 The OSSP Project */ +/* Copyright (c) 2002-2004 Cable & Wireless */ +/* All rights reserved. */ + +/* This code is inspirated from the OSSP version (as retrieved back in 2004)*/ +/* It was heavily modified to fit the SimGrid framework. */ + +/* The OSSP version has the following copyright notice: +** OSSP ex - Exception Handling ** Copyright (c) 2002-2004 Ralf S. Engelschall ** Copyright (c) 2002-2004 The OSSP Project ** Copyright (c) 2002-2004 Cable & Wireless @@ -13,7 +23,7 @@ ** the above copyright notice and this permission notice appear in all ** copies. ** -** THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED +** THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED ** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF ** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ** IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR @@ -25,45 +35,68 @@ ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT ** OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF ** SUCH DAMAGE. -** -** ex.h: exception handling (pre-processor part) -*/ + */ + +/* The extensions made for the SimGrid project can either be distributed */ +/* under the same license, or under the LGPL v2.1 */ #ifndef __XBT_EX_H__ #define __XBT_EX_H__ -#include -#include +#include "xbt/sysdep.h" +#include "xbt/misc.h" +#include "xbt/virtu.h" -/* required ISO-C standard facilities */ -#include +SG_BEGIN_DECL() -/* the machine context */ +/*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/ +#undef __EX_MAYDAY +#ifdef __EX_MAYDAY +# include +#include +# define MAYDAY_SAVE(m) printf("%d %s:%d save %p\n", \ + xbt_getpid(), __FILE__, __LINE__, \ + (m)->jb \ + ), +# define MAYDAY_RESTORE(m) printf("%d %s:%d restore %p\n", \ + xbt_getpid(), __FILE__, __LINE__, \ + (m)->jb \ + ), +# 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) +# define MAYDAY_CATCH(e) +#endif +/*-*-* end of debugging stuff *-*-*/ #if defined(__EX_MCTX_MCSC__) -#include /* POSIX.1 ucontext(3) */ +#include /* POSIX.1 ucontext(3) */ #define __ex_mctx_struct ucontext_t uc; #define __ex_mctx_save(mctx) (getcontext(&(mctx)->uc) == 0) -#define __ex_mctx_restored(mctx) /* noop */ +#define __ex_mctx_restored(mctx) /* noop */ #define __ex_mctx_restore(mctx) (void)setcontext(&(mctx)->uc) - #elif defined(__EX_MCTX_SSJLJ__) -#include /* POSIX.1 sigjmp_buf(3) */ +#include /* POSIX.1 sigjmp_buf(3) */ #define __ex_mctx_struct sigjmp_buf jb; #define __ex_mctx_save(mctx) (sigsetjmp((mctx)->jb, 1) == 0) -#define __ex_mctx_restored(mctx) /* noop */ +#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__) -#include /* ISO-C jmp_buf(3) */ +#elif defined(__EX_MCTX_SJLJ__) || !defined(__EX_MCTX_CUSTOM__) || defined(__EX_MAYDAY) +#include /* ISO-C jmp_buf(3) */ #define __ex_mctx_struct jmp_buf jb; -#define __ex_mctx_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_save(mctx) ( MAYDAY_SAVE(mctx) setjmp((mctx)->jb) == 0) +#define __ex_mctx_restored(mctx) /* noop */ +#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; +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 @@ -81,16 +114,26 @@ 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. * - * @section Introduction + * \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). * - * @section Basic usage + * @section XBT_ex_base BASIC USAGE * - * \em xbt_try \b TRIED_BLOCK [\em xbt_cleanup \b CLEANUP_BLOCK] \em xbt_catch (variable) \b CATCH_BLOCK + * \em TRY \b TRIED_BLOCK [\em TRY_CLEANUP \b CLEANUP_BLOCK] \em CATCH (variable) \b CATCH_BLOCK * * This is the primary syntactical construct provided. It is modeled after the * ISO-C++ try-catch clause and should sound familiar to most of you. @@ -103,7 +146,7 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * * * In absence of exception, the control flow goes into the blocks TRIED_BLOCK - * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored. + * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored. * * When an exception is thrown, the control flow goes through the following * blocks: TRIED_BLOCK (up to the statement throwing the exception), @@ -113,71 +156,50 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * CATCH_BLOCK block. * * Some notes: - * - xbt_try, xbt_cleanup and xbt_catch cannot be used separately, they work + * - TRY, CLEANUP and CATCH cannot be used separately, they work * only in combination and form a language clause as a whole. * - In contrast to the syntax of other languages (such as C++ or Jave) there - * is only one xbt_catch block and not multiple ones (all exceptions are - * of the same C type xbt_t). - * - the variable of xbt_catch can naturally be reused in subsequent - * xbt_catch clauses. - * - it is possible to nest xbt_try clauses. + * is only one CATCH block and not multiple ones (all exceptions are + * of the same \em xbt_ex_t C type). + * - the variable of CATCH can naturally be reused in subsequent + * CATCH clauses. + * - it is possible to nest TRY clauses. * - * The xbt_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 + * + *
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).
+ * + * 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. - * - * The xbt_cleanup and xbt_catch blocks are regular ISO-C language statement - * blocks without any restrictions. You are even allowed to throw (and in the - * xbt_catch block to re-throw) exceptions. + * 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. + * + * The CLEANUP and CATCH blocks are regular ISO-C language statement + * blocks without any restrictions. You are even allowed to throw (and, in the + * CATCH block, to re-throw) exceptions. * - * There is one subtle detail you should remember about xbt_try blocks: - * Variables used in the xbt_cleanup or xbt_catch clauses must be declared with + * There is one subtle detail you should remember about TRY blocks: + * Variables used in the CLEANUP or CATCH clauses must be declared with * the storage class "volatile", otherwise they might contain outdated - * information if an exception it thrown. + * information if an exception is thrown. * * - * This is because you usually do not know which commands in the xbt_try + * This is because you usually do not know which commands in the TRY * were already successful before the exception was thrown (logically speaking) * and because the underlying ISO-C setjmp(3) facility applies those * restrictions (technically speaking). As a matter of fact, value changes - * between the xbt_try and the xbt_throw may be discarded if you forget the + * between the TRY and the THROW may be discarded if you forget the * "volatile" keyword. * - * @section Advanced usage - * - * @subsection xbt_defer DEFERING_BLOCK - * - * This directive executes DEFERING_BLOCK while deferring the throwing of - * exceptions, i.e., exceptions thrown within this block are remembered, but - * the control flow still continues until the end of the block. At its end, the - * first exception which occured within the block (if any) is rethrown (any - * subsequent exceptions are ignored). - * - * DEFERING_BLOCK is a regular ISO-C language statement block, but it is not - * allowed to jump into it via "goto" or longjmp(3) or out of it via "break", - * "return", "goto" or longjmp(3). It is however allowed to nest xbt_defer - * clauses. - * - * @subsection xbt_shield SHIELDED_BLOCK - * - * This directive executes SHIELDED_BLOCK while shielding it against the - * throwing of exceptions, i.e., any exception thrown from this block or its - * subroutines are silently ignored. - * - * SHIELDED_BLOCK is a regular ISO-C language statement block, but it is not - * allowed to jump into it via "goto" or longjmp(3) or out of it via "break", - * "return", "goto" or longjmp(3). It is however allowed to nest xbt_shield - * clauses. - * - * @subsection Retrieving the current execution condition - * - * \a xbt_catching, \a xbt_deferred and \a xbt_shielding return a boolean - * indicating whether the current scope is within a TRYIED_BLOCK, - * DEFERING_BLOCK and SHIELDED_BLOCK (respectively) - * - * \section PROGRAMMING PITFALLS + * \section XBT_ex_pitfalls PROGRAMMING PITFALLS * * Exception handling is a very elegant and efficient way of dealing with * exceptional situation. Nevertheless it requires additional discipline in @@ -185,153 +207,149 @@ 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): * - \verbatim -// BAD EXAMPLE -xbt_try { - char *cp1, *cp2, cp3; - - cp1 = mallocex(SMALLAMOUNT); - globalcontext->first = cp1; - cp2 = mallocex(TOOBIG); - cp3 = mallocex(SMALLAMOUNT); - strcpy(cp1, "foo"); - strcpy(cp2, "bar"); -} xbt_cleanup { - if (cp3 != NULL) free(cp3); - if (cp2 != NULL) free(cp2); - if (cp1 != NULL) free(cp1); -} xbt_catch(ex) { - printf("cp3=%s", cp3); - ex_rethrow; -}\endverbatim - + * \dontinclude ex.c + * \skip BAD_EXAMPLE + * \until end_of_bad_example + * * This example raises a few issues: - * -# \b variable scope\n - * Variables which are used in the xbt_cleanup or xbt_catch clauses must be - * declared before the xbt_try clause, otherwise they only exist inside the - * xbt_try block. In the example above, cp1, cp2 and cp3 only exist in the - * xbt_try block and are invisible from the xbt_cleanup and xbt_catch + * -# \b variable \b scope \n + * Variables which are used in the CLEANUP or CATCH clauses must be + * declared before the TRY clause, otherwise they only exist inside the + * TRY block. In the example above, cp1, cp2 and cp3 only exist in the + * TRY block and are invisible from the CLEANUP and CATCH * blocks. - * -# \b variable initialization \n - * Variables which are used in the xbt_cleanup or xbt_catch clauses must - * be initialized before the point of the first possible xbt_throw is - * reached. In the example above, xbt_cleanup would have trouble using cp3 + * -# \b variable \b initialization \n + * Variables which are used in the CLEANUP or CATCH clauses must + * be initialized before the point of the first possible THROW is + * reached. In the example above, CLEANUP would have trouble using cp3 * if mallocex() throws a exception when allocating a TOOBIG buffer. - * -# \b volatile variable \n - * Variables which are used in the xbt_cleanup or xbt_catch clauses MUST BE + * -# \b volatile \b variable \n + * Variables which are used in the CLEANUP or CATCH clauses MUST BE * DECLARED AS "volatile", otherwise they might contain outdated * information when an exception is thrown. - * -# \b clean before catch \n - * The xbt_cleanup clause is not only place before the xbt_catch clause in + * -# \b clean \b before \b catch \n + * The CLEANUP clause is not only place before the CATCH clause in * the source code, it also occures before in the control flow. So, - * resources being cleaned up cannot be used in the xbt_catch block. In the - * example, c3 gets freed before the printf placed in xbt_catch. - * -# \b variable uninitialization \n + * resources being cleaned up cannot be used in the CATCH block. In the + * example, c3 gets freed before the printf placed in CATCH. + * -# \b variable \b uninitialization \n * If resources are passed out of the scope of the - * xbt_try/xbt_cleanup/xbt_catch construct, they naturally shouldn't get - * cleaned up. The example above does free(3) cp1 in xbt_cleanup although + * TRY/CLEANUP/CATCH construct, they naturally shouldn't get + * cleaned up. The example above does free(3) cp1 in CLEANUP although * its value was affected to globalcontext->first, invalidating this * pointer. * The following is fixed version of the code (annotated with the pitfall items - * for reference): - \verbatim -// GOOD EXAMPLE -{ / *01* / - char * volatile / *03* / cp1 = NULL / *02* /; - char * volatile / *03* / cp2 = NULL / *02* /; - char * volatile / *03* / cp3 = NULL / *02* /; - try { - cp1 = mallocex(SMALLAMOUNT); - globalcontext->first = cp1; - cp1 = NULL / *05 give away* /; - cp2 = mallocex(TOOBIG); - cp3 = mallocex(SMALLAMOUNT); - strcpy(cp1, "foo"); - strcpy(cp2, "bar"); - } - clean { / *04* / - printf("cp3=%s", cp3 == NULL / *02* / ? "" : cp3); - if (cp3 != NULL) - free(cp3); - if (cp2 != NULL) - free(cp2); - / *05 cp1 was given away * / - } - catch(ex) { - / *05 global context untouched * / - rethrow; - } -}\endverbatim - + * for reference): + * + * \skip GOOD_EXAMPLE + * \until end_of_good_example * * @{ */ +/** @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 */ +} 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; to be freed */ - int 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 */ - char *host; /* NULL for localhost; hostname:port if remote */ - char *procname; - char *file; /**< to be freed only for remote exceptions */ - int line; - char *func; /**< to be freed only for remote exceptions */ -} ex_t; - -/* declare the context type (private) */ + 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 */ + /* Backtrace */ + int used; + char **bt_strings; /* only filed on display (or before the network propagation) */ + void *bt[XBT_BACKTRACE_SIZE]; +} xbt_ex_t; + +/* declare the running context type + * (that's where we get the process name for the logs and the exception storage) + * -- do not mess with it -- + */ typedef struct { - __ex_mctx_t *ctx_mctx; /* permanent machine context of enclosing try/catch */ - int ctx_deferred; /* permanent flag whether exception is deferred */ - int ctx_deferring;/* permanent counter of exception deferring level */ - int ctx_defer; /* temporary flag for exception deferring macro */ - int ctx_shielding;/* permanent counter of exception shielding level */ - int ctx_shield; /* temporary flag for exception shielding macro */ - int ctx_caught; /* temporary flag whether exception was caught */ - volatile ex_t ctx_ex; /* temporary exception storage */ -} ex_ctx_t; + __ex_mctx_t *ctx_mctx; /* permanent machine context of enclosing try/catch */ + volatile 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_CTX_INITIALIZER \ - { NULL, 0, 0, 0, 0, 0, 0, { /* content */ NULL, 0, 0, \ - /*throw point*/ NULL, NULL, NULL, 0, NULL } } -#define XBT_CTX_INITIALIZE(ctx) \ +#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_INITIALIZE(ctx) \ do { \ - (ctx)->ctx_mctx = NULL; \ - (ctx)->ctx_deferred = 0; \ - (ctx)->ctx_deferring = 0; \ - (ctx)->ctx_defer = 0; \ - (ctx)->ctx_shielding = 0; \ - (ctx)->ctx_shield = 0; \ - (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_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) /* the exception context */ -typedef ex_ctx_t *(*ex_ctx_cb_t)(void); -extern ex_ctx_cb_t __xbt_ex_ctx; -extern ex_ctx_t *__xbt_ex_ctx_default(void); +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); /* the termination handler */ -typedef void (*ex_term_cb_t)(ex_t *); -extern ex_term_cb_t __xbt_ex_terminate; -extern void __xbt_ex_terminate_default(ex_t *e); +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); /** @brief Introduce a block where exception may be dealed with * @hideinitializer */ -#define xbt_try \ +#define TRY \ { \ - ex_ctx_t *__xbt_ex_ctx_ptr = __xbt_ex_ctx(); \ + 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; \ @@ -340,15 +358,14 @@ extern void __xbt_ex_terminate_default(ex_t *e); if (__ex_mctx_save(&__ex_mctx_me)) { \ if (1) -/** @brief optional(!) block for cleanup +/** @brief optional(!) block for cleanup * @hideinitializer */ -#define xbt_cleanup \ +#define TRY_CLEANUP \ else { \ } \ __xbt_ex_ctx_ptr->ctx_caught = 0; \ - } \ - else { \ + } else { \ __ex_mctx_restored(&__ex_mctx_me); \ __xbt_ex_ctx_ptr->ctx_caught = 1; \ } \ @@ -357,16 +374,34 @@ extern void __xbt_ex_terminate_default(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 */ -#define xbt_catch(e) \ +#define CATCH(e) \ + DO_CATCH((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_running_ctx_fetch()->exception) + +/** @brief like CATCH(e) but without argument + * @hideinitializer + * + * Useful if you only want to rethrow the exception caught, and do not want to + * bother with an unused variable. + */ +#define CATCH_ANONYMOUS DO_CATCH(0) + +#define DO_CATCH(_xbt_do_catch_set_e) \ else { \ } \ if (!(__ex_cleanup)) \ __xbt_ex_ctx_ptr->ctx_caught = 0; \ - } \ - else { \ + } else { \ if (!(__ex_cleanup)) { \ __ex_mctx_restored(&__ex_mctx_me); \ __xbt_ex_ctx_ptr->ctx_caught = 1; \ @@ -374,106 +409,135 @@ extern void __xbt_ex_terminate_default(ex_t *e); } \ __xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \ } \ - if ( !(__xbt_ex_ctx()->ctx_caught) \ - || ((e) = __xbt_ex_ctx()->ctx_ex, 0)) { \ + if ( !(__xbt_running_ctx_fetch()->ctx_caught) \ + || ((void)(_xbt_do_catch_set_e), \ + MAYDAY_CATCH(__xbt_running_ctx_fetch()->exception) 0)) { \ } \ else -/** @brief Build an exception from the supplied arguments and throws it +#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) */ + +/** @brief Helper macro for THROW and THROWF * @hideinitializer * - * If called from within a sg_try/sg_catch construct, this exception - * is copied into the sg_catch relevant variable program control flow - * is derouted to the sg_catch (after the optional sg_cleanup). + * @param c: category code (integer) + * @param v: value (integer) + * @param m: message text * - * If no sg_try/sg_catch conctruct embeeds this call, the program calls + * If called from within a TRY/CATCH construct, this exception + * is copied into the CATCH relevant variable program control flow + * is derouted to the CATCH (after the optional sg_cleanup). + * + * If no TRY/CATCH construct embeds this call, the program calls * abort(3). * - * The sg_throw can be performed everywhere, including inside sg_try, - * sg_cleanup and sg_catch blocks. + * The THROW can be performed everywhere, including inside TRY, + * CLEANUP and CATCH blocks. */ -#define xbt_throw(c,v,m) \ - (( __xbt_ex_ctx()->ctx_shielding > 0 \ - || (__xbt_ex_ctx()->ctx_deferring > 0 && __xbt_ex_ctx()->ctx_deferred == 1)) ? 0 : \ - (__xbt_ex_ctx()->ctx_ex.msg = bprintf(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_deferred = 1, \ - (__xbt_ex_ctx()->ctx_deferring > 0 ? 0 : \ - (__xbt_ex_ctx()->ctx_mctx == NULL \ - ? (__xbt_ex_terminate((ex_t *)&(__xbt_ex_ctx()->ctx_ex)), -1) \ - : (__ex_mctx_restore(__xbt_ex_ctx()->ctx_mctx), 1) )))) + +#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); \ + } while (0) + +/** @brief Builds and throws an exception + @hideinitializer */ +#define THROW(c, v) _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 THROW_IMPOSSIBLE \ + THROWF(unknown_error, 0, "The Impossible Did Happen (yet again)") +#define THROW_UNIMPLEMENTED \ + THROWF(unknown_error, 0, "Function %s unimplemented",_XBT_FUNCTION) + +#ifndef NDEBUG +# define DIE_IMPOSSIBLE xbt_assert(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 */ -#define xbt_rethrow \ - (( __xbt_ex_ctx()->ctx_shielding > 0 \ - || __xbt_ex_ctx()->ctx_deferring > 0) ? 0 : \ - ( __xbt_ex_ctx()->ctx_mctx == NULL \ - ? (__xbt_ex_terminate((ex_t *)&(__xbt_ex_ctx()->ctx_ex)), -1) \ - : (__ex_mctx_restore(__xbt_ex_ctx()->ctx_mctx), 1) )) - -/** @brief shield an operation from exception handling - * @hideinitializer - */ -#define xbt_shield \ - for (__xbt_ex_ctx()->ctx_shielding++, \ - __xbt_ex_ctx()->ctx_shield = 1; \ - __xbt_ex_ctx()->ctx_shield == 1; \ - __xbt_ex_ctx()->ctx_shield = 0, \ - __xbt_ex_ctx()->ctx_shielding--) - -/** @brief defer immediate exception handling - * @hideinitializer - */ -#define xbt_defer \ - for (((__xbt_ex_ctx()->ctx_deferring)++ == 0 ? __xbt_ex_ctx()->ctx_deferred = 0 : 0), \ - __xbt_ex_ctx()->ctx_defer = 1; \ - __xbt_ex_ctx()->ctx_defer == 1; \ - __xbt_ex_ctx()->ctx_defer = 0, \ - ((--(__xbt_ex_ctx()->ctx_deferring) == 0 && __xbt_ex_ctx()->ctx_deferred == 1) ? xbt_rethrow : 0)) - -/** @brief exception handling tests - * @hideinitializer - */ -#define xbt_catching \ - (__xbt_ex_ctx()->ctx_mctx != NULL) -/** @brief exception handling tests - * @hideinitializer - */ -#define xbt_shielding \ - (__xbt_ex_ctx()->ctx_shielding > 0) -/** @brief exception handling tests +#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) + +/** @brief like THROWF, but adding some details to the message of an existing exception * @hideinitializer */ -#define xbt_deferring \ - (__xbt_ex_ctx()->ctx_deferring > 0) - -/* optional namespace mapping */ -#if defined(__EX_NS_UCCXX__) -#define Try xbt_try -#define Cleanup xbt_cleanup -#define Catch xbt_catch -#define Throw xbt_throw -#define Rethrow xbt_rethrow -#define Shield xbt_shield -#define Defer xbt_defer -#elif defined(__EX_NS_CXX__) || (!defined(__cplusplus) && !defined(__EX_NS_CUSTOM__)) -#define try xbt_try -#define cleanup xbt_cleanup -#define catch xbt_catch -#define throw xbt_throw -#define rethrow xbt_rethrow -#define shield xbt_shield -#define defer xbt_defer +#define RETHROWF(...) \ + do { \ + char *_xbt_ex_internal_msg = __xbt_running_ctx_fetch()->exception.msg; \ + __xbt_running_ctx_fetch()->exception.msg = bprintf(__VA_ARGS__, \ + _xbt_ex_internal_msg); \ + free(_xbt_ex_internal_msg); \ + RETHROW; \ + } while (0) + +/** @brief Exception destructor */ +XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e); + +/** @brief Shows a backtrace of the current location */ +XBT_PUBLIC(void) xbt_backtrace_display_current(void); +/** @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 +SG_END_DECL() + /** @} */ -#endif /* __XBT_EX_H__ */ - +#endif /* __XBT_EX_H__ */