-/*
-** OSSP ex - Exception Handling (modified to fit into SimGrid)
-** Copyright (c) 2005 Martin Quinson.
-** Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
-** Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
-** Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
-**
-** 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 <rse@engelschall.com> */
+/* Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/> */
+/* Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/> */
+/* 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 <xbt/sysdep.h>
-#include <xbt/misc.h>
+#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 <errno.h>
-#include <stdio.h>
+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 <stdio.h>
+#include <errno.h>
+
# 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
/*-*-* end of debugging stuff *-*-*/
-
-/* the machine context */
#if defined(__EX_MCTX_MCSC__)
#include <ucontext.h> /* POSIX.1 ucontext(3) */
#define __ex_mctx_struct ucontext_t uc;
* 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
+ * <tt>tools/xbt_exception_checker</tt> 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 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
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;
- 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) */
/* the static and dynamic initializers for a context structure */
#define XBT_CTX_INITIALIZER \
{ NULL, 0, { /* content */ NULL, unknown_error, 0, \
- /* throw point*/ 0,NULL, NULL, NULL, 0, NULL,\
+ /* 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_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; \
/* 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
__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; \
/** @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 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)")
/** @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, _XBT_POST_RETHROW
+#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
+#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_display_backtrace(void);
+XBT_PUBLIC(void) xbt_ex_display(xbt_ex_t *e);
+XBT_PUBLIC(void) xbt_backtrace_display(void);
/** @} */
#endif /* __XBT_EX_H__ */
