include/xbt/asserts.h

   1 /*  xbt/asserts.h -- assertion mechanism                                    */
   2
   3 /* Copyright (c) 2005-2022. 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 "simgrid/modelchecker.h"
  12 #include <stdlib.h>
  13 #include <xbt/base.h>
  14 #include <xbt/log.h>
  15
  16 SG_BEGIN_DECL
  17 XBT_PUBLIC_DATA int xbt_log_no_loc; /* Do not show the backtrace on failed backtrace when doing our tests */
  18
  19 XBT_PUBLIC void xbt_backtrace_display_current();
  20
  21 /**
  22  * @addtogroup XBT_error
  23  *
  24  * @{
  25  */
  26 /** @brief Kill the program in silence */
  27 XBT_ATTRIB_NORETURN XBT_PUBLIC void xbt_abort(void);
  28
  29 /**
  30  * @brief Kill the program with an error message
  31  * @param ... a format string and its arguments
  32  *
  33  * Things are so messed up that the only thing to do now, is to stop the program.
  34  *
  35  * The message is handled by a CRITICAL logging request, and may consist of a format string with arguments.
  36  */
  37 #define xbt_die(...)                                                                                                   \
  38   do {                                                                                                                 \
  39     XBT_CCRITICAL(root, __VA_ARGS__);                                                                                  \
  40     xbt_abort();                                                                                                       \
  41   } while (0)
  42
  43 /**
  44  * @brief Those are the SimGrid version of the good ol' assert macro.
  45  *
  46  * You can pass them a format message and arguments, just as if it where a printf.
  47  * It is converted to a XBT_CRITICAL logging request.
  48  * An execution backtrace is also displayed, unless the option --log=no_loc is given at run-time.
  49  *
  50  * Unlike the standard assert, xbt_assert is never disabled, even if the macro NDEBUG is defined at compile time.  So
  51  * it's safe to have a condition with side effects.
  52  *
  53  * In model-checking mode, a failed xbt_assert() is reported as a failed MC_assert().
  54  */
  55 /** @brief The condition which failed will be displayed.
  56     @hideinitializer  */
  57 #define xbt_assert(...) \
  58   _XBT_IF_ONE_ARG(_xbt_assert_ARG1, _xbt_assert_ARGN, __VA_ARGS__)(__VA_ARGS__)
  59 #define _xbt_assert_ARG1(cond) _xbt_assert_ARGN((cond), "Assertion %s failed", #cond)
  60 #define _xbt_assert_ARGN(cond, ...)                                                                                    \
  61   do {                                                                                                                 \
  62     if (!(cond)) {                                                                                                     \
  63       XBT_CCRITICAL(root, __VA_ARGS__);                                                                                \
  64       if (!xbt_log_no_loc)                                                                                             \
  65         xbt_backtrace_display_current();                                                                               \
  66       if (MC_is_active())                                                                                              \
  67         MC_assert(0);                                                                                                  \
  68       abort();                                                                                                         \
  69     }                                                                                                                  \
  70   } while (0)
  71
  72 /** @} */
  73 SG_END_DECL
  74 #endif                          /* XBT_ASSERTS_H */