2 * SPDX-License-Identifier: MIT
4 * Copyright (c) 2018-2019 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2018-2019 Philippe Proulx <pproulx@efficios.com>
8 #ifndef BABELTRACE_ASSERT_INTERNAL_H
9 #define BABELTRACE_ASSERT_INTERNAL_H
14 #include "common/macros.h"
17 extern void bt_common_assert_failed(const char *file
, int line
,
18 const char *func
, const char *assertion
)
19 __attribute__((noreturn
));
22 * Internal assertion (to detect logic errors on which the library user
23 * has no influence). Use BT_ASSERT_PRE*() or BT_ASSERT_POST*() to check
24 * preconditions or postconditions which must be directly or indirectly
25 * satisfied by the library user.
27 * BT_ASSERT() is enabled in both debug and non-debug modes.
29 #define BT_ASSERT(_cond) \
32 bt_common_assert_failed(__FILE__, __LINE__, __func__, \
33 G_STRINGIFY(_cond)); \
38 * Marks a function as being only used within a BT_ASSERT() context.
40 #define BT_ASSERT_FUNC
45 * Debug mode internal assertion.
47 #define BT_ASSERT_DBG(_cond) BT_ASSERT(_cond)
50 * Marks a function as being only used within a BT_ASSERT_DBG() context.
52 #define BT_ASSERT_DBG_FUNC
54 #else /* BT_DEBUG_MODE */
57 * When `BT_DEBUG_MODE` is _not_ defined, define BT_ASSERT_DBG() macro
58 * to the following to trick the compiler into thinking that the
59 * variable passed as condition to the assertion is used. This is to
60 * prevent set-but-not-used warnings from the compiler when assertions
61 * are disabled. The sizeof() operator also makes sure that the `_cond`
62 * expression is not evaluated, thus preventing unwanted side effects.
64 * In-depth explanation:
65 * https://stackoverflow.com/questions/37411809/how-to-elegantly-fix-this-unused-variable-warning/37412551#37412551
67 # define BT_ASSERT_DBG(_cond) ((void) sizeof((void) (_cond), 0))
68 # define BT_ASSERT_DBG_FUNC __attribute__((unused))
70 #endif /* BT_DEBUG_MODE */
72 #endif /* BABELTRACE_ASSERT_INTERNAL_H */
This page took 0.036652 seconds and 4 git commands to generate.