include/xbt/asserts.h

   1 /*  xbt/asserts.h -- assertion mechanism                                    */
   2
   3 /* Copyright (c) 2005-2007, 2009-2014. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef _XBT_ASSERTS_H
  10 #define _XBT_ASSERTS_H
  11
  12 #include "xbt/misc.h"
  13 #include "xbt/log.h"
  14 #include "xbt/ex.h"
  15
  16 SG_BEGIN_DECL()
  17 extern int xbt_log_no_loc; /* Do not show the backtrace on failed backtrace when doing our tests */
  18
  19 /**
  20  * @addtogroup XBT_error
  21  * @brief Those are the SimGrid version of the good ol' assert macro.
  22  *
  23  * You can pass them a format message and arguments, just as if it where a printf.
  24  * It is converted to a XBT_CRITICAL logging request.
  25  * Be careful: the boolean expression that you want to test should not have side effects, because assertions are
  26  * disabled at compile time if NDEBUG is set.
  27  *
  28  * @{
  29  */
  30 #ifdef NDEBUG
  31 #define xbt_assert(...) ((void)0)
  32 #else
  33    /** @brief The condition which failed will be displayed.
  34    @hideinitializer  */
  35 #define xbt_assert(...) \
  36   _XBT_IF_ONE_ARG(_xbt_assert_ARG1, _xbt_assert_ARGN, __VA_ARGS__)(__VA_ARGS__)
  37 #define _xbt_assert_ARG1(cond) \
  38   _xbt_assert_ARGN(cond, "Assertion %s failed", #cond)
  39 #define _xbt_assert_ARGN(cond, ...)                                                                                    \
  40   do {                                                                                                                 \
  41     if (!(cond)) {                                                                                                     \
  42       XBT_CCRITICAL(root, __VA_ARGS__);                                                                                \
  43       if (!xbt_log_no_loc)                                                                                             \
  44         xbt_backtrace_display_current();                                                                               \
  45       abort();                                                                                                         \
  46     }                                                                                                                  \
  47   } while (0)
  48 #endif
  49
  50 /** @} */
  51 SG_END_DECL()
  52 #endif                          /* _XBT_ASSERTS_H */