-/* xbt/asserts.h -- assertion mecanism */
+/* xbt/asserts.h -- assertion mechanism */
-/* Copyright (c) 2005-2007, 2009-2014. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2005-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#ifndef _XBT_ASSERTS_H
-#define _XBT_ASSERTS_H
+#ifndef XBT_ASSERTS_H
+#define XBT_ASSERTS_H
-#include "xbt/misc.h"
-#include "xbt/log.h"
-#include "xbt/ex.h"
+#include <stdlib.h>
+#include <xbt/base.h>
+#include <xbt/log.h>
-SG_BEGIN_DECL()
+SG_BEGIN_DECL
+XBT_PUBLIC_DATA int xbt_log_no_loc; /* Do not show the backtrace on failed backtrace when doing our tests */
+
+XBT_PUBLIC void xbt_backtrace_display_current();
/**
* @addtogroup XBT_error
+ *
+ * @{
+ */
+/** @brief Kill the program in silence */
+XBT_ATTRIB_NORETURN XBT_PUBLIC void xbt_abort(void);
+
+/**
+ * @brief Kill the program with an error message
+ * @param ... a format string and its arguments
+ *
+ * Things are so messed up that the only thing to do now, is to stop the program.
+ *
+ * The message is handled by a CRITICAL logging request, and may consist of a format string with arguments.
+ */
+#define xbt_die(...) \
+ do { \
+ XBT_CCRITICAL(root, __VA_ARGS__); \
+ xbt_abort(); \
+ } while (0)
+
+/**
* @brief Those are the SimGrid version of the good ol' assert macro.
*
- * You can pass them a format message and arguments, just as if it where a
- * printf.
+ * You can pass them a format message and arguments, just as if it where a printf.
* It is converted to a XBT_CRITICAL logging request.
- * Be careful: the boolean expression that you want to test should not have
- * side effects, because assertions are disabled at compile time if NDEBUG
- * is set.
+ * An execution backtrace is also displayed, unless the option --log=no_loc is given at run-time.
*
- * @{
+ * Unlike the standard assert, xbt_assert is never disabled, even if the macro NDEBUG is defined at compile time. So
+ * it's safe to have a condition with side effects.
*/
-#ifdef NDEBUG
-#define xbt_assert(...) ((void)0)
-#else
- /** @brief The condition which failed will be displayed.
- @hideinitializer */
+/** @brief The condition which failed will be displayed.
+ @hideinitializer */
#define xbt_assert(...) \
_XBT_IF_ONE_ARG(_xbt_assert_ARG1, _xbt_assert_ARGN, __VA_ARGS__)(__VA_ARGS__)
-#define _xbt_assert_ARG1(cond) \
- _xbt_assert_ARGN(cond, "Assertion %s failed", #cond)
-#define _xbt_assert_ARGN(cond, ...) \
- do { if (!(cond)) THROWF(0, 0, __VA_ARGS__); } while (0)
-#endif
-
-#ifdef XBT_USE_DEPRECATED
-
-#define xbt_assert0(...) xbt_assert(__VA_ARGS__)
-#define xbt_assert1(...) xbt_assert(__VA_ARGS__)
-#define xbt_assert2(...) xbt_assert(__VA_ARGS__)
-#define xbt_assert3(...) xbt_assert(__VA_ARGS__)
-#define xbt_assert4(...) xbt_assert(__VA_ARGS__)
-#define xbt_assert5(...) xbt_assert(__VA_ARGS__)
-#define xbt_assert6(...) xbt_assert(__VA_ARGS__)
-
-#endif
+#define _xbt_assert_ARG1(cond) _xbt_assert_ARGN((cond), "Assertion %s failed", #cond)
+#define _xbt_assert_ARGN(cond, ...) \
+ do { \
+ if (!(cond)) { \
+ XBT_CCRITICAL(root, __VA_ARGS__); \
+ if (!xbt_log_no_loc) \
+ xbt_backtrace_display_current(); \
+ abort(); \
+ } \
+ } while (0)
+
/** @} */
- SG_END_DECL()
-#endif /* _XBT_ASSERTS_H */
+SG_END_DECL
+#endif /* XBT_ASSERTS_H */