1 /* xbt/asserts.h -- assertion mechanism */
3 /* Copyright (c) 2005-2022. The SimGrid Team. All rights reserved. */
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. */
16 XBT_PUBLIC_DATA int xbt_log_no_loc; /* Do not show the backtrace on failed backtrace when doing our tests */
18 XBT_PUBLIC void xbt_backtrace_display_current();
21 * @addtogroup XBT_error
25 /** @brief Kill the program in silence */
26 XBT_ATTRIB_NORETURN XBT_PUBLIC void xbt_abort(void);
29 * @brief Kill the program with an error message
30 * @param ... a format string and its arguments
32 * Things are so messed up that the only thing to do now, is to stop the program.
34 * The message is handled by a CRITICAL logging request, and may consist of a format string with arguments.
36 #define xbt_die(...) \
38 XBT_CCRITICAL(root, __VA_ARGS__); \
43 * @brief Those are the SimGrid version of the good ol' assert macro.
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.
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.
52 /** @brief The condition which failed will be displayed.
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, ...) \
60 XBT_CCRITICAL(root, __VA_ARGS__); \
61 if (!xbt_log_no_loc) \
62 xbt_backtrace_display_current(); \
69 #endif /* XBT_ASSERTS_H */