Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #302 from mpoquet/rename-s4u-synchro-examples
[simgrid.git] / include / xbt / asserts.h
1 /*  xbt/asserts.h -- assertion mechanism                                    */
2
3 /* Copyright (c) 2005-2018. 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 <xbt/ex.h>
12 #include <xbt/log.h>
13 #include <xbt/misc.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 /**
19  * @addtogroup XBT_error
20  * @brief Those are the SimGrid version of the good ol' assert macro.
21  *
22  * You can pass them a format message and arguments, just as if it where a printf.
23  * It is converted to a XBT_CRITICAL logging request.
24  * Be careful: the boolean expression that you want to test should not have side effects, because assertions are
25  * disabled at compile time if NDEBUG is set.
26  *
27  * @{
28  */
29 #ifdef NDEBUG
30 #define xbt_assert(...) ((void)0)
31 #else
32    /** @brief The condition which failed will be displayed.
33    @hideinitializer  */
34 #define xbt_assert(...) \
35   _XBT_IF_ONE_ARG(_xbt_assert_ARG1, _xbt_assert_ARGN, __VA_ARGS__)(__VA_ARGS__)
36 #define _xbt_assert_ARG1(cond) \
37   _xbt_assert_ARGN(cond, "Assertion %s failed", #cond)
38 #define _xbt_assert_ARGN(cond, ...)                                                                                    \
39   do {                                                                                                                 \
40     if (!(cond)) {                                                                                                     \
41       XBT_CCRITICAL(root, __VA_ARGS__);                                                                                \
42       if (!xbt_log_no_loc)                                                                                             \
43         xbt_backtrace_display_current();                                                                               \
44       abort();                                                                                                         \
45     }                                                                                                                  \
46   } while (0)
47 #endif
48
49 /** @} */
50 SG_END_DECL()
51 #endif                          /* XBT_ASSERTS_H */