X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4af5e3cccdee300382df9aa824a8691f8cdbbda5..0bfb3cdebf6d1a0105a7a738a602015ed583a39e:/include/xbt/ex.h diff --git a/include/xbt/ex.h b/include/xbt/ex.h index dfa3bad958..3d7228352b 100644 --- a/include/xbt/ex.h +++ b/include/xbt/ex.h @@ -14,33 +14,32 @@ #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); - -/* required ISO-C standard facilities */ -#include -#include +XBT_PUBLIC(int) backtrace (void **__array, int __size); /*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/ #undef __EX_MAYDAY #ifdef __EX_MAYDAY -int gras_os_getpid(void); +# include +#include + # define MAYDAY_SAVE(m) printf("%d %s:%d save %p\n", \ - gras_os_getpid(),__FILE__,__LINE__, \ + (*xbt_getpid)(),__FILE__,__LINE__, \ (m)->jb \ ), # define MAYDAY_RESTORE(m) printf("%d %s:%d restore %p\n", \ - gras_os_getpid(),__FILE__,__LINE__, \ + (*xbt_getpid)(),__FILE__,__LINE__, \ (m)->jb \ ), # define MAYDAY_CATCH(e) printf("%d %s:%d Catched '%s'\n", \ - gras_os_getpid(),__FILE__,__LINE__, \ + (*xbt_getpid)(),__FILE__,__LINE__, \ e.msg \ ), #else @@ -51,8 +50,6 @@ int gras_os_getpid(void); /*-*-* end of debugging stuff *-*-*/ - -/* the machine context */ #if defined(__EX_MCTX_MCSC__) #include /* POSIX.1 ucontext(3) */ #define __ex_mctx_struct ucontext_t uc; @@ -157,7 +154,14 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * 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. @@ -165,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 @@ -224,9 +228,6 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t; * @{ */ -/* we need this symbol here, even if it breaks a bit the module separation */ -long int gras_os_getpid(void); - /** @brief different kind of errors */ typedef enum { unknown_error=0, /**< unknown error */ @@ -237,25 +238,26 @@ 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_ex_catname(xbt_errcat_t cat); +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 */ - short int remote; /* whether it was raised remotely */ - char *host; /* NULL for localhost; hostname if remote */ + 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; - long int pid; - char *file; /**< to be freed only for remote exceptions */ - int line; - char *func; /**< to be freed only for remote exceptions */ + 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) */ @@ -304,12 +306,12 @@ typedef struct { /* 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 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 @@ -406,7 +408,7 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); __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 = gras_os_getpid(); \ + __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; \ @@ -441,7 +443,7 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); #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 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)") @@ -500,10 +502,10 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e); #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); +XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e); -void xbt_ex_display(xbt_ex_t *e); -void xbt_backtrace_display(void); +XBT_PUBLIC(void) xbt_ex_display(xbt_ex_t *e); +XBT_PUBLIC(void) xbt_backtrace_display(void); /** @} */ #endif /* __XBT_EX_H__ */