X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9f11ef1761a86b1b1353e30f22430f08aed6181f..0bfb3cdebf6d1a0105a7a738a602015ed583a39e:/include/xbt/ex.h diff --git a/include/xbt/ex.h b/include/xbt/ex.h index 14ebbe7b51..3d7228352b 100644 --- a/include/xbt/ex.h +++ b/include/xbt/ex.h @@ -1,51 +1,55 @@ -/* -** OSSP ex - Exception Handling (modified to fit into SimGrid) -** Copyright (c) 2005 Martin Quinson. -** Copyright (c) 2002-2004 Ralf S. Engelschall -** Copyright (c) 2002-2004 The OSSP Project -** Copyright (c) 2002-2004 Cable & Wireless -** -** This file is part of OSSP ex, an exception handling library -** which can be found at http://www.ossp.org/pkg/lib/ex/. -** -** Permission to use, copy, modify, and distribute this software for -** any purpose with or without fee is hereby granted, provided that -** the above copyright notice and this permission notice appear in all -** copies. -** -** 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 -** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -** USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -** 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) -*/ +/* $Id$ */ + +/* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */ + +/* Copyright (c) 2005-2006 Martin Quinson */ +/* Copyright (c) 2002-2004 Ralf S. Engelschall */ +/* Copyright (c) 2002-2004 The OSSP Project */ +/* Copyright (c) 2002-2004 Cable & Wireless */ +/* All rights reserved. */ + +/* This program is free software; you can redistribute it and/or modify it + * under the terms of the license (GNU LGPL) which comes with this package. */ #ifndef __XBT_EX_H__ #define __XBT_EX_H__ -#include -#include +#include "xbt/sysdep.h" +#include "xbt/misc.h" +#include "xbt/virtu.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); +XBT_PUBLIC(int) backtrace (void **__array, int __size); -/* required ISO-C standard facilities */ + +/*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/ +#undef __EX_MAYDAY + +#ifdef __EX_MAYDAY +# include #include -#include -//#define __EX_MCTX_MCSC__ 1 -//#define __EX_MCTX_SSJLJ__ 1 -/* the machine context */ +# 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) */ #define __ex_mctx_struct ucontext_t uc; @@ -60,18 +64,19 @@ extern int backtrace (void **__array, int __size); #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__) +#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_save(mctx) ( MAYDAY_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_restore(mctx) ( MAYDAY_RESTORE(mctx) (void)longjmp((mctx)->jb, 1)) #endif /* declare the machine context type */ 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 @@ -89,9 +94,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). @@ -130,12 +145,23 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * CATCH clauses. * - it is possible to nest TRY clauses. * - * The 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 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. @@ -143,7 +169,7 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * 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 TRY @@ -161,7 +187,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 * @@ -202,6 +228,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 */ @@ -211,73 +238,81 @@ typedef enum { system_error, /**< a syscall did fail */ network_error, /**< error while sending/receiving data */ timeout_error, /**< not quick enough, dude */ - thread_error /**< error while [un]locking */ + thread_error, /**< error while [un]locking */ + host_error /**< host failed */ } xbt_errcat_t; -const char *xbt_errcat_name(xbt_errcat_t errcode); +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 */ + 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 */ + 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 */ - 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) */ typedef struct { __ex_mctx_t *ctx_mctx; /* permanent machine context of enclosing try/catch */ - int ctx_caught; /* temporary flag whether exception was caught */ - volatile xbt_ex_t ctx_ex; /* temporary exception storage */ + volatile int ctx_caught; /* temporary flag whether exception was caught */ + volatile xbt_ex_t ctx_ex; /* temporary exception storage */ } ex_ctx_t; /* the static and dynamic initializers for a context structure */ #define XBT_CTX_INITIALIZER \ - { NULL, 0, { /* content */ NULL, 0, 0, \ - /* throw point*/ NULL, NULL, NULL, 0, NULL,\ - /* backtrace */ {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL},0 } } + { 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_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.remote = 0; \ + (ctx)->ctx_ex.host = NULL; \ + (ctx)->ctx_ex.procname = NULL; \ + (ctx)->ctx_ex.pid = 0; \ + (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 */ typedef ex_ctx_t *(*ex_ctx_cb_t)(void); -extern ex_ctx_cb_t __xbt_ex_ctx; +extern XBT_PUBLIC_DATA(ex_ctx_cb_t) __xbt_ex_ctx; extern ex_ctx_t *__xbt_ex_ctx_default(void); /* 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 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 @@ -309,6 +344,14 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e) __attribute__((__noreturn__ 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 */ @@ -326,11 +369,19 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e) __attribute__((__noreturn__ __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, MAYDAY_CATCH(e) 0)) { \ } \ 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) @@ -349,36 +400,56 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e) __attribute__((__noreturn__ */ #define _THROW(c,v,m) \ - 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.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) */ \ + do { /* change this sequence into one block */ \ + /* build the exception */ \ + __xbt_ex_ctx()->ctx_ex.msg = (m); \ + __xbt_ex_ctx()->ctx_ex.category = (xbt_errcat_t)(c); \ + __xbt_ex_ctx()->ctx_ex.value = (v); \ + __xbt_ex_ctx()->ctx_ex.remote = 0; \ + __xbt_ex_ctx()->ctx_ex.host = (char*)NULL; \ + __xbt_ex_ctx()->ctx_ex.procname = (char*)xbt_procname(); \ + __xbt_ex_ctx()->ctx_ex.pid = (*xbt_getpid)(); \ + __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,XBT_BACKTRACE_SIZE);\ + __xbt_ex_ctx()->ctx_ex.bt_strings = NULL; \ + DO_THROW(__xbt_ex_ctx()->ctx_ex);\ } 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)) +/** @brief Builds and throws an exception with a string taking seven arguments + @hideinitializer */ +#define THROW7(c,v,m,a1,a2,a3,a4,a5,a6,a7) _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5,a6,a7)) #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__) +#define THROW_UNIMPLEMENTED THROW1(unknown_error,0,"Function %s unimplemented",_XBT_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 @@ -392,11 +463,8 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e) __attribute__((__noreturn__ 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; \ @@ -406,16 +474,38 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e) __attribute__((__noreturn__ 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 -#define RETHROW4(msg,a,b,c,d) _XBT_PRE_RETHROW msg,a,b,c, _XBT_POST_RETHROW -#define RETHROW5(msg,a,b,c,d,e) _XBT_PRE_RETHROW msg,a,b,c,d,e _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,d, _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 */ +XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e); -void xbt_ex_free(xbt_ex_t e); -const char * xbt_ex_catname(xbt_errcat_t cat); +XBT_PUBLIC(void) xbt_ex_display(xbt_ex_t *e); +XBT_PUBLIC(void) xbt_backtrace_display(void); /** @} */ #endif /* __XBT_EX_H__ */