include/xbt/asserts.h

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