-/* $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 <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. */
+/* 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 <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.
+ */
+
+/* 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__
/*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/
#undef __EX_MAYDAY
-
#ifdef __EX_MAYDAY
# include <stdio.h>
#include <errno.h>
-
# define MAYDAY_SAVE(m) printf("%d %s:%d save %p\n", \
(*xbt_getpid)(),__FILE__,__LINE__, \
(m)->jb \
# define MAYDAY_RESTORE(m)
# define MAYDAY_CATCH(e)
#endif
-
/*-*-* end of debugging stuff *-*-*/
-
#if defined(__EX_MCTX_MCSC__)
#include <ucontext.h> /* 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 <setjmp.h> /* 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 <setjmp.h> /* ISO-C jmp_buf(3) */
#define __ex_mctx_struct jmp_buf jb;
#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;
*
* @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.
*
*
* 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),
network_error, /**< error while sending/receiving data */
timeout_error, /**< not quick enough, dude */
thread_error, /**< error while [un]locking */
- host_error /**< host failed */
+ host_error, /**< host failed */
+ tracing_error /**< error during the simulation tracing */
} 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 */
- 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;
+ 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;
+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;
/* the static and dynamic initializers for a context structure */
#define XBT_CTX_INITIALIZER \
} while (0)
/* the exception context */
- typedef ex_ctx_t *(*ex_ctx_cb_t) (void);
+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);
+extern ex_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
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; \
*
* 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,
SG_END_DECL()
/** @} */
-#endif /* __XBT_EX_H__ */
+#endif /* __XBT_EX_H__ */
