include/xbt/ex.h

   1 /* ex - Exception Handling                                                  */
   2
   3 /*  Copyright (c) 2005-2010 The SimGrid team                                */
   4 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
   5 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
   6 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
   7 /*  All rights reserved.                                                    */
   8
   9 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
  10 /* It was heavily modified to fit the SimGrid framework.                    */
  11
  12 /* The OSSP version has the following copyright notice:
  13 **  OSSP ex - Exception Handling
  14 **  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
  15 **  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
  16 **  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
  17 **
  18 **  This file is part of OSSP ex, an exception handling library
  19 **  which can be found at http://www.ossp.org/pkg/lib/ex/.
  20 **
  21 **  Permission to use, copy, modify, and distribute this software for
  22 **  any purpose with or without fee is hereby granted, provided that
  23 **  the above copyright notice and this permission notice appear in all
  24 **  copies.
  25 **
  26 **  THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
  27 **  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  28 **  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 **  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
  30 **  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31 **  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32 **  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  33 **  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  34 **  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  35 **  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  36 **  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37 **  SUCH DAMAGE.
  38  */
  39
  40 /* The extensions made for the SimGrid project can either be distributed    */
  41 /* under the same license, or under the LGPL v2.1                           */
  42
  43 #ifndef __XBT_EX_H__
  44 #define __XBT_EX_H__
  45
  46 #include "xbt/sysdep.h"
  47 #include "xbt/misc.h"
  48 #include "xbt/virtu.h"
  49
  50 SG_BEGIN_DECL()
  51
  52 /*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/
  53 #undef __EX_MAYDAY
  54 #ifdef __EX_MAYDAY
  55 # include <stdio.h>
  56 #include <errno.h>
  57 #  define MAYDAY_SAVE(m)    printf("%d %s:%d save %p\n",                \
  58                                    xbt_getpid(), __FILE__, __LINE__,    \
  59                                    (m)->jb                              \
  60                                   ),
  61 #  define MAYDAY_RESTORE(m) printf("%d %s:%d restore %p\n",             \
  62                                    xbt_getpid(), __FILE__, __LINE__,    \
  63                                    (m)->jb                              \
  64                                   ),
  65 #  define MAYDAY_CATCH(e)   printf("%d %s:%d Catched '%s'\n",           \
  66                                    xbt_getpid(), __FILE__, __LINE__,    \
  67                                    (e).msg                              \
  68           ),
  69 #else
  70 #  define MAYDAY_SAVE(m)
  71 #  define MAYDAY_RESTORE(m)
  72 #  define MAYDAY_CATCH(e)
  73 #endif
  74 /*-*-* end of debugging stuff *-*-*/
  75 #if defined(__EX_MCTX_MCSC__)
  76 #include <ucontext.h>           /* POSIX.1 ucontext(3) */
  77 #define __ex_mctx_struct         ucontext_t uc;
  78 #define __ex_mctx_save(mctx)     (getcontext(&(mctx)->uc) == 0)
  79 #define __ex_mctx_restored(mctx)        /* noop */
  80 #define __ex_mctx_restore(mctx)  (void)setcontext(&(mctx)->uc)
  81 #elif defined(__EX_MCTX_SSJLJ__)
  82 #include <setjmp.h>             /* POSIX.1 sigjmp_buf(3) */
  83 #define __ex_mctx_struct         sigjmp_buf jb;
  84 #define __ex_mctx_save(mctx)     (sigsetjmp((mctx)->jb, 1) == 0)
  85 #define __ex_mctx_restored(mctx)        /* noop */
  86 #define __ex_mctx_restore(mctx)  (void)siglongjmp((mctx)->jb, 1)
  87 #elif defined(__EX_MCTX_SJLJ__) || !defined(__EX_MCTX_CUSTOM__) || defined(__EX_MAYDAY)
  88 #include <setjmp.h>             /* ISO-C jmp_buf(3) */
  89 #define __ex_mctx_struct         jmp_buf jb;
  90 #define __ex_mctx_save(mctx)     ( MAYDAY_SAVE(mctx) setjmp((mctx)->jb) == 0)
  91 #define __ex_mctx_restored(mctx)        /* noop */
  92 #define __ex_mctx_restore(mctx)  ( MAYDAY_RESTORE(mctx) (void)longjmp((mctx)->jb, 1))
  93 #endif
  94 /* declare the machine context type */
  95 typedef struct {
  96 __ex_mctx_struct} __ex_mctx_t;
  97
  98 /** @addtogroup XBT_ex
  99  *  @brief A set of macros providing exception a la C++ in ANSI C (grounding feature)
 100  *
 101  * This module is a small ISO-C++ style exception handling library
 102  * for use in the ISO-C language. It allows you to use the paradigm
 103  * of throwing and catching exceptions in order to reduce the amount
 104  * of error handling code without hindering program robustness.
 105  *
 106  * This is achieved by directly transferring exceptional return codes
 107  * (and the program control flow) from the location where the exception
 108  * is raised (throw point) to the location where it is handled (catch
 109  * point) -- usually from a deeply nested sub-routine to a parent
 110  * routine. All intermediate routines no longer have to make sure that
 111  * the exceptional return codes from sub-routines are correctly passed
 112  * back to the parent.
 113  *
 114  * These features are brought to you by a modified version of the libex
 115  * library, one of the numerous masterpiece of Ralf S. Engelschall.
 116  *
 117  * \htmlonly <div class="toc">\endhtmlonly
 118  *
 119  * @section XBT_ex_toc TABLE OF CONTENTS
 120  *
 121  *  - \ref XBT_ex_intro
 122  *  - \ref XBT_ex_base
 123  *  - \ref XBT_ex_pitfalls
 124  *
 125  * \htmlonly </div> \endhtmlonly
 126  *
 127  * @section XBT_ex_intro DESCRIPTION
 128  *
 129  * In SimGrid, an exception is a triple <\a msg , \a category , \a value>
 130  * where \a msg is a human-readable text describing the exceptional
 131  * condition, \a code an integer describing what went wrong and \a value
 132  * providing a sort of sub-category. (this is different in the original libex).
 133  *
 134  * @section XBT_ex_base BASIC USAGE
 135  *
 136  * \em TRY \b TRIED_BLOCK [\em TRY_CLEANUP \b CLEANUP_BLOCK] \em CATCH (variable) \b CATCH_BLOCK
 137  *
 138  * This is the primary syntactical construct provided. It is modeled after the
 139  * ISO-C++ try-catch clause and should sound familiar to most of you.
 140  *
 141  * Any exception thrown directly from the TRIED_BLOCK block or from called
 142  * subroutines is caught. Cleanups which must be done after this block
 143  * (whenever an exception arised or not) should be placed into the optionnal
 144  * CLEANUP_BLOCK. The code dealing with the exceptions when they arise should
 145  * be placed into the (mandatory) CATCH_BLOCK.
 146  *
 147  *
 148  * In absence of exception, the control flow goes into the blocks TRIED_BLOCK
 149  * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored.
 150  *
 151  * When an exception is thrown, the control flow goes through the following
 152  * blocks: TRIED_BLOCK (up to the statement throwing the exception),
 153  * CLEANUP_BLOCK (if any) and CATCH_BLOCK. The exception is stored in a
 154  * variable for inspection inside the CATCH_BLOCK. This variable must be
 155  * declared in the outter scope, but its value is only valid within the
 156  * CATCH_BLOCK block.
 157  *
 158  * Some notes:
 159  *  - TRY, CLEANUP and CATCH cannot be used separately, they work
 160  *    only in combination and form a language clause as a whole.
 161  *  - In contrast to the syntax of other languages (such as C++ or Jave) there
 162  *    is only one CATCH block and not multiple ones (all exceptions are
 163  *    of the same \em xbt_ex_t C type).
 164  *  - the variable of CATCH can naturally be reused in subsequent
 165  *    CATCH clauses.
 166  *  - it is possible to nest TRY clauses.
 167  *
 168  * The TRY block is a regular ISO-C language statement block, but
 169  *
 170  * <center><b>it is not
 171  * allowed to jump into it via "goto" or longjmp(3) or out of it via "break",
 172  * "return", "goto" or longjmp(3)</b>.</center>
 173  *
 174  * This is because there is some hidden setup and
 175  * cleanup that needs to be done regardless of whether an exception is
 176  * caught. Bypassing these steps will break the exception handling facility.
 177  * The symptom are likely to be a segfault at the next exception raising point,
 178  * ie far away from the point where you did the mistake. If you suspect
 179  * that kind of error in your code, have a look at the little script
 180  * <tt>tools/xbt_exception_checker</tt> in the CVS. It extracts all the TRY
 181  * blocks from a set of C files you give it and display them (and only
 182  * them) on the standard output. You can then grep for the forbidden
 183  * keywords on that output.
 184  *
 185  * The CLEANUP and CATCH blocks are regular ISO-C language statement
 186  * blocks without any restrictions. You are even allowed to throw (and, in the
 187  * CATCH block, to re-throw) exceptions.
 188  *
 189  * There is one subtle detail you should remember about TRY blocks:
 190  * Variables used in the CLEANUP or CATCH clauses must be declared with
 191  * the storage class "volatile", otherwise they might contain outdated
 192  * information if an exception is thrown.
 193  *
 194  *
 195  * This is because you usually do not know which commands in the TRY
 196  * were already successful before the exception was thrown (logically speaking)
 197  * and because the underlying ISO-C setjmp(3) facility applies those
 198  * restrictions (technically speaking). As a matter of fact, value changes
 199  * between the TRY and the THROW may be discarded if you forget the
 200  * "volatile" keyword.
 201  *
 202  * \section XBT_ex_pitfalls PROGRAMMING PITFALLS
 203  *
 204  * Exception handling is a very elegant and efficient way of dealing with
 205  * exceptional situation. Nevertheless it requires additional discipline in
 206  * programming and there are a few pitfalls one must be aware of. Look the
 207  * following code which shows some pitfalls and contains many errors (assuming
 208  * a mallocex() function which throws an exception if malloc(3) fails):
 209  *
 210  * \dontinclude ex.c
 211  * \skip BAD_EXAMPLE
 212  * \until end_of_bad_example
 213  *
 214  * This example raises a few issues:
 215  *  -# \b variable \b scope \n
 216  *     Variables which are used in the CLEANUP or CATCH clauses must be
 217  *     declared before the TRY clause, otherwise they only exist inside the
 218  *     TRY block. In the example above, cp1, cp2 and cp3 only exist in the
 219  *     TRY block and are invisible from the CLEANUP and CATCH
 220  *     blocks.
 221  *  -# \b variable \b initialization \n
 222  *     Variables which are used in the CLEANUP or CATCH clauses must
 223  *     be initialized before the point of the first possible THROW is
 224  *     reached. In the example above, CLEANUP would have trouble using cp3
 225  *     if mallocex() throws a exception when allocating a TOOBIG buffer.
 226  *  -# \b volatile \b variable \n
 227  *     Variables which are used in the CLEANUP or CATCH clauses MUST BE
 228  *     DECLARED AS "volatile", otherwise they might contain outdated
 229  *     information when an exception is thrown.
 230  *  -# \b clean \b before \b catch \n
 231  *     The CLEANUP clause is not only place before the CATCH clause in
 232  *     the source code, it also occures before in the control flow. So,
 233  *     resources being cleaned up cannot be used in the CATCH block. In the
 234  *     example, c3 gets freed before the printf placed in CATCH.
 235  *  -# \b variable \b uninitialization \n
 236  *     If resources are passed out of the scope of the
 237  *     TRY/CLEANUP/CATCH construct, they naturally shouldn't get
 238  *     cleaned up. The example above does free(3) cp1 in CLEANUP although
 239  *     its value was affected to globalcontext->first, invalidating this
 240  *     pointer.
 241
 242  * The following is fixed version of the code (annotated with the pitfall items
 243  * for reference):
 244  *
 245  * \skip GOOD_EXAMPLE
 246  * \until end_of_good_example
 247  *
 248  * @{
 249  */
 250
 251 /** @brief different kind of errors */
 252 typedef enum {
 253   unknown_error = 0,/**< unknown error */
 254   arg_error,        /**< Invalid argument */
 255   bound_error,      /**< Out of bounds argument */
 256   mismatch_error,   /**< The provided ID does not match */
 257   not_found_error,  /**< The searched element was not found */
 258
 259   system_error,   /**< a syscall did fail */
 260   network_error,  /**< error while sending/receiving data */
 261   timeout_error,  /**< not quick enough, dude */
 262   cancel_error,   /**< an action was canceled */
 263   thread_error,    /**< error while [un]locking */
 264   host_error,                            /**< host failed */
 265   tracing_error,   /**< error during the simulation tracing */
 266   io_error          /**< disk or file error */
 267 } xbt_errcat_t;
 268
 269 XBT_PUBLIC(const char *) xbt_ex_catname(xbt_errcat_t cat);
 270
 271 /** @brief Structure describing an exception */
 272 typedef struct {
 273   char *msg;             /**< human readable message */
 274   xbt_errcat_t category;
 275                          /**< category like HTTP (what went wrong) */
 276   int value;             /**< like errno (why did it went wrong) */
 277   /* throw point */
 278   short int remote;
 279                     /**< whether it was raised remotely */
 280   char *host;     /**< NULL locally thrown exceptions; full hostname if remote ones */
 281   /* FIXME: host should be hostname:port[#thread] */
 282   char *procname;
 283                   /**< Name of the process who thrown this */
 284   int pid;        /**< PID of the process who thrown this */
 285   char *file;     /**< Thrown point */
 286   int line;       /**< Thrown point */
 287   char *func;     /**< Thrown point */
 288   /* Backtrace */
 289   int used;
 290   char **bt_strings;            /* only filed on display (or before the network propagation) */
 291   void *bt[XBT_BACKTRACE_SIZE];
 292 } xbt_ex_t;
 293
 294 /* declare the running context type
 295  * (that's where we get the process name for the logs and the exception storage)
 296  *  -- do not mess with it --
 297  */
 298 typedef struct {
 299   __ex_mctx_t *ctx_mctx;        /* permanent machine context of enclosing try/catch */
 300   int ctx_caught;               /* temporary flag whether exception was caught */
 301   volatile xbt_ex_t exception;  /* temporary exception storage */
 302 } xbt_running_ctx_t;
 303
 304 /* the static and dynamic initializers for a context structure */
 305 #define XBT_RUNNING_CTX_INITIALIZER \
 306     { NULL, 0, { /* content */ NULL, unknown_error, 0, \
 307                  /* throw point*/ 0,NULL, NULL,0, NULL, 0, NULL,\
 308                  /* backtrace */ 0, NULL, /* bt[] */ } }
 309
 310 XBT_PUBLIC_DATA(const xbt_running_ctx_t) __xbt_ex_ctx_initializer;
 311 #define XBT_RUNNING_CTX_INITIALIZE(ctx) (*(ctx) = __xbt_ex_ctx_initializer)
 312
 313 /* the exception context */
 314 typedef xbt_running_ctx_t *(*xbt_running_ctx_fetcher_t) (void);
 315 XBT_PUBLIC_DATA(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch;
 316 XBT_PUBLIC( xbt_running_ctx_t *)__xbt_ex_ctx_default(void);
 317
 318 /* the termination handler */
 319 typedef void (*ex_term_cb_t) (xbt_ex_t *);
 320 XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate;
 321 XBT_PUBLIC( void )__xbt_ex_terminate_default(xbt_ex_t * e);
 322
 323 /** @brief Introduce a block where exception may be dealed with
 324  *  @hideinitializer
 325  */
 326 #define TRY \
 327     { \
 328         xbt_running_ctx_t *__xbt_ex_ctx_ptr = __xbt_running_ctx_fetch(); \
 329         int __ex_cleanup = 0; \
 330         __ex_mctx_t *__ex_mctx_en; \
 331         __ex_mctx_t __ex_mctx_me; \
 332         __ex_mctx_en = __xbt_ex_ctx_ptr->ctx_mctx; \
 333         __xbt_ex_ctx_ptr->ctx_mctx = &__ex_mctx_me; \
 334         if (__ex_mctx_save(&__ex_mctx_me)) { \
 335             if (1)
 336
 337 /** @brief optional(!) block for cleanup
 338  *  @hideinitializer
 339  */
 340 #define TRY_CLEANUP \
 341             else { \
 342             } \
 343             __xbt_ex_ctx_ptr->ctx_caught = 0; \
 344         } else { \
 345             __ex_mctx_restored(&__ex_mctx_me); \
 346             __xbt_ex_ctx_ptr->ctx_caught = 1; \
 347         } \
 348         __xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \
 349         __ex_cleanup = 1; \
 350         if (1) { \
 351             if (1)
 352
 353 #ifndef DOXYGEN_SKIP
 354 #  ifdef __cplusplus
 355 #    define XBT_EX_T_CPLUSPLUSCAST (xbt_ex_t&)
 356 #  else
 357 #    define XBT_EX_T_CPLUSPLUSCAST
 358 #  endif
 359 #endif
 360
 361 /** @brief the block for catching (ie, deal with) an exception
 362  *  @hideinitializer
 363  */
 364 #define CATCH(e) \
 365   DO_CATCH((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_running_ctx_fetch()->exception)
 366
 367 /** @brief like CATCH(e) but without argument
 368  *  @hideinitializer
 369  *
 370  *  Useful if you only want to rethrow the exception caught, and do not want to
 371  *  bother with an unused variable.
 372  */
 373 #define CATCH_ANONYMOUS DO_CATCH(0)
 374
 375 #define DO_CATCH(_xbt_do_catch_set_e) \
 376             else { \
 377             } \
 378             if (!(__ex_cleanup)) \
 379                 __xbt_ex_ctx_ptr->ctx_caught = 0; \
 380         } else { \
 381             if (!(__ex_cleanup)) { \
 382                 __ex_mctx_restored(&__ex_mctx_me); \
 383                 __xbt_ex_ctx_ptr->ctx_caught = 1; \
 384             } \
 385         } \
 386         __xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \
 387     } \
 388     if (   !(__xbt_running_ctx_fetch()->ctx_caught) \
 389         || ((void)(_xbt_do_catch_set_e),                             \
 390             MAYDAY_CATCH(__xbt_running_ctx_fetch()->exception) 0)) {    \
 391     } \
 392     else
 393
 394 #define DO_THROW(running_ctx)                                           \
 395   do { /* deal with the exception */                                    \
 396     xbt_running_ctx_t *ctx = (running_ctx);                             \
 397     if (ctx->ctx_mctx == NULL)                                          \
 398       __xbt_ex_terminate((xbt_ex_t*)&(ctx->exception)); /* not catched */ \
 399     else                                                                \
 400       __ex_mctx_restore(ctx->ctx_mctx); /* catched somewhere */         \
 401     abort();  /* nope, stupid GCC, we won't survive a THROW */          \
 402               /* (this won't be reached) */                             \
 403   } while(0)
 404
 405 /** @brief Helper macro for THROW and THROWF
 406  *  @hideinitializer
 407  *
 408  *  @param _throw_ctx: the throwing context in which we should construct the exception
 409  *  @param c: category code (integer)
 410  *  @param v: value (integer)
 411  *  @param m: message text
 412  *
 413  * If called from within a TRY/CATCH construct, this exception
 414  * is copied into the CATCH relevant variable program control flow
 415  * is derouted to the CATCH (after the optional sg_cleanup).
 416  *
 417  * If no TRY/CATCH construct embeds this call, the program calls
 418  * abort(3).
 419  *
 420  * The THROW can be performed everywhere, including inside TRY,
 421  * CLEANUP and CATCH blocks.
 422  */
 423
 424 #define THROW_PREPARE(_throw_ctx, c, v, m)                              \
 425   /* build the exception */                                             \
 426   _throw_ctx->exception.msg      = (m);                                 \
 427   _throw_ctx->exception.category = (xbt_errcat_t)(c);                   \
 428   _throw_ctx->exception.value    = (v);                                 \
 429   _throw_ctx->exception.remote   = 0;                                   \
 430   _throw_ctx->exception.host     = (char*)NULL;                         \
 431   _throw_ctx->exception.procname = (char*)xbt_procname();               \
 432   _throw_ctx->exception.pid      = xbt_getpid();                        \
 433   _throw_ctx->exception.file     = (char*)__FILE__;                     \
 434   _throw_ctx->exception.line     = __LINE__;                            \
 435   _throw_ctx->exception.func     = (char*)_XBT_FUNCTION;                \
 436   _throw_ctx->exception.bt_strings = NULL;                              \
 437   xbt_backtrace_current((xbt_ex_t *)&(_throw_ctx->exception));
 438
 439 #define _THROW(c, v, m)                                        \
 440   do { /* change this sequence into one block */               \
 441     xbt_running_ctx_t *_throw_ctx = __xbt_running_ctx_fetch(); \
 442     THROW_PREPARE(_throw_ctx, c, v, m);                        \
 443     DO_THROW(_throw_ctx);                                      \
 444   } while (0)
 445
 446 /** @brief Builds and throws an exception
 447     @hideinitializer */
 448 #define THROW(c, v)             _THROW(c, v, NULL)
 449
 450 /** @brief Builds and throws an exception with a printf-like formatted message
 451     @hideinitializer */
 452 #define THROWF(c, v, ...)       _THROW(c, v, bprintf(__VA_ARGS__))
 453
 454 #define THROW_IMPOSSIBLE \
 455   THROWF(unknown_error, 0, "The Impossible Did Happen (yet again)")
 456 #define THROW_UNIMPLEMENTED \
 457   THROWF(unknown_error, 0, "Function %s unimplemented",_XBT_FUNCTION)
 458
 459 #ifndef NDEBUG
 460 #  define DIE_IMPOSSIBLE       xbt_assert(0,"The Impossible Did Happen (yet again)")
 461 #else
 462 #  define DIE_IMPOSSIBLE       exit(1);
 463 #endif
 464
 465 /** @brief re-throwing of an already caught exception (ie, pass it to the upper catch block)
 466  *  @hideinitializer
 467  */
 468 #define RETHROW DO_THROW(__xbt_running_ctx_fetch())
 469
 470 /** @brief like THROWF, but adding some details to the message of an existing exception
 471  *  @hideinitializer
 472  */
 473 #define RETHROWF(...)                                                   \
 474   do {                                                                  \
 475     char *_xbt_ex_internal_msg = __xbt_running_ctx_fetch()->exception.msg; \
 476     __xbt_running_ctx_fetch()->exception.msg = bprintf(__VA_ARGS__,     \
 477                                                        _xbt_ex_internal_msg); \
 478     free(_xbt_ex_internal_msg);                                         \
 479     RETHROW;                                                            \
 480   } while (0)
 481
 482 /** @brief Exception destructor */
 483 XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e);
 484
 485 /** @brief Shows a backtrace of the current location */
 486 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
 487 /** @brief reimplementation of glibc backtrace based directly on gcc library, without implicit malloc  */
 488 XBT_PUBLIC(int)xbt_backtrace_no_malloc(void**bt, int size);
 489 /** @brief Captures a backtrace for further use */
 490 XBT_PUBLIC(void) xbt_backtrace_current(xbt_ex_t * e);
 491 /** @brief Display a previously captured backtrace */
 492 XBT_PUBLIC(void) xbt_backtrace_display(xbt_ex_t * e);
 493
 494 #ifdef XBT_USE_DEPRECATED
 495
 496 /* Kept for backward compatibility. */
 497
 498 #define THROW0(c, v, m) \
 499   do { if (m) THROWF(c, v, m); else THROW(c, v); } while (0)
 500 #define THROW1(c, v, ...)       THROWF(c, v, __VA_ARGS__)
 501 #define THROW2(c, v, ...)       THROWF(c, v, __VA_ARGS__)
 502 #define THROW3(c, v, ...)       THROWF(c, v, __VA_ARGS__)
 503 #define THROW4(c, v, ...)       THROWF(c, v, __VA_ARGS__)
 504 #define THROW5(c, v, ...)       THROWF(c, v, __VA_ARGS__)
 505 #define THROW6(c, v, ...)       THROWF(c, v, __VA_ARGS__)
 506 #define THROW7(c, v, ...)       THROWF(c, v, __VA_ARGS__)
 507
 508 #define RETHROW0(...)           RETHROWF(__VA_ARGS__)
 509 #define RETHROW1(...)           RETHROWF(__VA_ARGS__)
 510 #define RETHROW2(...)           RETHROWF(__VA_ARGS__)
 511 #define RETHROW3(...)           RETHROWF(__VA_ARGS__)
 512 #define RETHROW4(...)           RETHROWF(__VA_ARGS__)
 513 #define RETHROW5(...)           RETHROWF(__VA_ARGS__)
 514
 515 #endif
 516
 517 SG_END_DECL()
 518
 519 /** @} */
 520 #endif                          /* __XBT_EX_H__ */