include/xbt/asserts.h

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