X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6f48d1a65eeb69ebae17feb1d714db4a60764a51..4741217071fd45b1526b542ebd8bbc2ab2251728:/include/xbt/asserts.h diff --git a/include/xbt/asserts.h b/include/xbt/asserts.h index d3075fff04..e51ed8a2cf 100644 --- a/include/xbt/asserts.h +++ b/include/xbt/asserts.h @@ -1,43 +1,74 @@ -/* 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-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. */ -#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 "simgrid/modelchecker.h" +#include +#include +#include + +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(); -SG_BEGIN_DECL() /** * @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. + * + * In model-checking mode, a failed xbt_assert() is reported as a failed MC_assert(). */ -#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 +#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(); \ + if (MC_is_active()) \ + MC_assert(0); \ + abort(); \ + } \ + } while (0) /** @} */ -SG_END_DECL() -#endif /* _XBT_ASSERTS_H */ +SG_END_DECL +#endif /* XBT_ASSERTS_H */