X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1b30f00857843f1cee60814ed519ff82e8ef4787..fb2c06ad23be8a12b22bdc8e77c63f4d7c61a1bb:/include/xbt/ex.h diff --git a/include/xbt/ex.h b/include/xbt/ex.h index 619d16beac..50a4ef737d 100644 --- a/include/xbt/ex.h +++ b/include/xbt/ex.h @@ -1,15 +1,44 @@ -/* $Id$ */ +/* ex - Exception Handling */ -/* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */ - -/* Copyright (c) 2005-2006 Martin Quinson */ +/* 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 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. */ +/* 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 +** +** 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. + */ + +/* 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__ @@ -22,11 +51,9 @@ SG_BEGIN_DECL() /*-*-* 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 \ @@ -44,23 +71,19 @@ SG_BEGIN_DECL() # 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; #define __ex_mctx_save(mctx) (getcontext(&(mctx)->uc) == 0) #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) */ #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_restore(mctx) (void)siglongjmp((mctx)->jb, 1) - #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; @@ -68,7 +91,6 @@ SG_BEGIN_DECL() #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; @@ -111,7 +133,7 @@ __ex_mctx_struct} __ex_mctx_t; * * @section XBT_ex_base BASIC USAGE * - * \em TRY \b TRIED_BLOCK [\em CLEANUP \b CLEANUP_BLOCK] \em 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. @@ -124,7 +146,7 @@ __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), @@ -237,6 +259,7 @@ typedef enum { 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 */ @@ -245,84 +268,87 @@ typedef enum { 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; +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) */ - /* throw point */ - short int remote; + 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; + 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 context type (private) */ - typedef struct { - __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 ctx_ex; /* temporary exception storage */ - } ex_ctx_t; + 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 */ + 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 \ +#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_CTX_INITIALIZE(ctx) \ +#define XBT_RUNNING_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.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; \ + (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); -XBT_PUBLIC_DATA(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) (xbt_ex_t *); +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); +extern void __xbt_ex_terminate_default(xbt_ex_t * e); /** @brief Introduce a block where exception may be dealed with * @hideinitializer */ #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; \ @@ -331,10 +357,10 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate; if (__ex_mctx_save(&__ex_mctx_me)) { \ if (1) -/** @brief optional(!) block for cleanup +/** @brief optional(!) block for cleanup * @hideinitializer */ -#define CLEANUP \ +#define TRY_CLEANUP \ else { \ } \ __xbt_ex_ctx_ptr->ctx_caught = 0; \ @@ -371,18 +397,18 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate; } \ __xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \ } \ - if ( !(__xbt_ex_ctx()->ctx_caught) \ - || ((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_ex_ctx()->ctx_ex, MAYDAY_CATCH(e) 0)) { \ + if ( !(__xbt_running_ctx_fetch()->ctx_caught) \ + || ((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_running_ctx_fetch()->exception, MAYDAY_CATCH(e) 0)) { \ } \ else -#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) */ +#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 THROWS0-6 * @hideinitializer @@ -393,9 +419,9 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate; * * 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). + * is derouted to the CATCH (after the optional sg_cleanup). * - * If no TRY/CATCH construct embeeds this call, the program calls + * If no TRY/CATCH construct embeds this call, the program calls * abort(3). * * The THROW can be performed everywhere, including inside TRY, @@ -403,24 +429,23 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate; */ #define _THROW(c,v,m) \ - do { /* change this sequence into one block */ \ - ex_ctx_t *_throw_ctx = __xbt_ex_ctx(); \ - /* build the exception */ \ - _throw_ctx->ctx_ex.msg = (m); \ - _throw_ctx->ctx_ex.category = (xbt_errcat_t)(c); \ - _throw_ctx->ctx_ex.value = (v); \ - _throw_ctx->ctx_ex.remote = 0; \ - _throw_ctx->ctx_ex.host = (char*)NULL; \ - _throw_ctx->ctx_ex.procname = (char*)xbt_procname(); \ - _throw_ctx->ctx_ex.pid = (*xbt_getpid)(); \ - _throw_ctx->ctx_ex.file = (char*)__FILE__; \ - _throw_ctx->ctx_ex.line = __LINE__; \ - _throw_ctx->ctx_ex.func = (char*)_XBT_FUNCTION; \ - _throw_ctx->ctx_ex.bt_strings = NULL; \ - xbt_backtrace_current( (xbt_ex_t *) &(_throw_ctx->ctx_ex) ); \ - DO_THROW(_throw_ctx->ctx_ex); \ + 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) -/* __xbt_ex_ctx()->ctx_ex.used = backtrace((void**)__xbt_ex_ctx()->ctx_ex.bt,XBT_BACKTRACE_SIZE); */ /** @brief Builds and throws an exception with a string taking no arguments @hideinitializer */ @@ -461,10 +486,11 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate; */ #define RETHROW \ do { \ - if (__xbt_ex_ctx()->ctx_mctx == NULL) \ - __xbt_ex_terminate((xbt_ex_t *)&(__xbt_ex_ctx()->ctx_ex)); \ + 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(__xbt_ex_ctx()->ctx_mctx); \ + __ex_mctx_restore(ctx->ctx_mctx); \ abort();\ } while(0) @@ -472,8 +498,8 @@ XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate; #ifndef DOXYGEN_SKIP #define _XBT_PRE_RETHROW \ do { \ - char *_xbt_ex_internal_msg = __xbt_ex_ctx()->ctx_ex.msg; \ - __xbt_ex_ctx()->ctx_ex.msg = bprintf( + char *_xbt_ex_internal_msg = __xbt_running_ctx_fetch()->exception.msg; \ + __xbt_running_ctx_fetch()->exception.msg = bprintf( #define _XBT_POST_RETHROW \ _xbt_ex_internal_msg); \ free(_xbt_ex_internal_msg); \ @@ -519,4 +545,4 @@ XBT_PUBLIC(void) xbt_backtrace_display(xbt_ex_t * e); SG_END_DECL() /** @} */ -#endif /* __XBT_EX_H__ */ +#endif /* __XBT_EX_H__ */