X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/88fad0aaff9eb463f048bfdfe4ad6218aba44ddb..5e3b14a56a1e8f4a63b868ec4283608acf5c2937:/include/xbt/asserts.h diff --git a/include/xbt/asserts.h b/include/xbt/asserts.h index 5e78a3bfe2..f0d023f883 100644 --- a/include/xbt/asserts.h +++ b/include/xbt/asserts.h @@ -1,6 +1,6 @@ /* xbt/asserts.h -- assertion mechanism */ -/* Copyright (c) 2005-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2005-2022. 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. */ @@ -8,33 +8,52 @@ #ifndef XBT_ASSERTS_H #define XBT_ASSERTS_H -#include +#include +#include #include -#include -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. * 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_ARG1(cond) _xbt_assert_ARGN((cond), "Assertion %s failed", #cond) #define _xbt_assert_ARGN(cond, ...) \ do { \ if (!(cond)) { \ @@ -44,8 +63,7 @@ XBT_PUBLIC_DATA int xbt_log_no_loc; /* Do not show the backtrace on failed backt abort(); \ } \ } while (0) -#endif /** @} */ -SG_END_DECL() +SG_END_DECL #endif /* XBT_ASSERTS_H */