[babeltrace.git] / src / common / assert.h

#ifndef BABELTRACE_ASSERT_INTERNAL_H
#define BABELTRACE_ASSERT_INTERNAL_H

/*
 * Copyright (c) 2018-2019 EfficiOS Inc. and Linux Foundation
 * Copyright (c) 2018-2019 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <assert.h>
#include <glib.h>

#include "common/macros.h"

BT_HIDDEN
extern void bt_common_assert_failed(const char *file, int line,
		const char *func, const char *assertion)
		__attribute__((noreturn));

/*
 * Internal assertion (to detect logic errors on which the library user
 * has no influence). Use BT_ASSERT_PRE*() or BT_ASSERT_POST*() to check
 * preconditions or postconditions which must be directly or indirectly
 * satisfied by the library user.
 *
 * BT_ASSERT() is enabled in both debug and non-debug modes.
 */
#define BT_ASSERT(_cond)                                                       \
	do {                                                                   \
		if (!(_cond)) {                                                \
			bt_common_assert_failed(__FILE__, __LINE__, __func__,  \
				G_STRINGIFY(_cond));                           \
		}                                                              \
	} while (0)

/*
 * Marks a function as being only used within a BT_ASSERT() context.
 */
#define BT_ASSERT_FUNC

#ifdef BT_DEBUG_MODE

/*
 * Debug mode internal assertion.
 */
#define BT_ASSERT_DBG(_cond)	BT_ASSERT(_cond)

/*
 * Marks a function as being only used within a BT_ASSERT_DBG() context.
 */
#define BT_ASSERT_DBG_FUNC

#else /* BT_DEBUG_MODE */

/*
 * When `BT_DEBUG_MODE` is _not_ defined, define BT_ASSERT_DBG() macro
 * to the following to trick the compiler into thinking that the
 * variable passed as condition to the assertion is used. This is to
 * prevent set-but-not-used warnings from the compiler when assertions
 * are disabled. The sizeof() operator also makes sure that the `_cond`
 * expression is not evaluated, thus preventing unwanted side effects.
 *
 * In-depth explanation:
 * https://stackoverflow.com/questions/37411809/how-to-elegantly-fix-this-unused-variable-warning/37412551#37412551
 */
# define BT_ASSERT_DBG(_cond)	((void) sizeof((void) (_cond), 0))
# define BT_ASSERT_DBG_FUNC	__attribute__((unused))

#endif /* BT_DEBUG_MODE */

#endif /* BABELTRACE_ASSERT_INTERNAL_H */
Commit	Line	Data
d244c559 PP	1	#ifndef BABELTRACE_ASSERT_INTERNAL_H
	2	#define BABELTRACE_ASSERT_INTERNAL_H
	3
	4	/*
ec4a3354 PP	5	* Copyright (c) 2018-2019 EfficiOS Inc. and Linux Foundation
ec4a3354 PP	6	* Copyright (c) 2018-2019 Philippe Proulx <pproulx@efficios.com>
d244c559 PP	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
	27	#include <assert.h>
85e7137b MJ	28	#include <glib.h>
	29
	30	#include "common/macros.h"
d244c559	31
83ab55b8	32	BT_HIDDEN
1bf777d7	33	extern void bt_common_assert_failed(const char *file, int line,
ec4a3354 PP	34	const char func, const char assertion)
ec4a3354 PP	35	__attribute__((noreturn));
1bf777d7	36
d244c559 PP	37	/*
d244c559 PP	38	* Internal assertion (to detect logic errors on which the library user
ec4a3354	39	* has no influence). Use BT_ASSERT_PRE() or BT_ASSERT_POST() to check
c6f84660 PP	40	* preconditions or postconditions which must be directly or indirectly
c6f84660 PP	41	* satisfied by the library user.
ec4a3354 PP	42	*
ec4a3354 PP	43	* BT_ASSERT() is enabled in both debug and non-debug modes.
d244c559	44	*/
1bf777d7 SM	45	#define BT_ASSERT(_cond) \
	46	do { \
	47	if (!(_cond)) { \
	48	bt_common_assert_failed(__FILE__, __LINE__, __func__, \
85e7137b	49	G_STRINGIFY(_cond)); \
1bf777d7 SM	50	} \
1bf777d7 SM	51	} while (0)
d244c559 PP	52
	53	/*
	54	* Marks a function as being only used within a BT_ASSERT() context.
	55	*/
ec4a3354 PP	56	#define BT_ASSERT_FUNC
	57
	58	#ifdef BT_DEBUG_MODE
	59
	60	/*
	61	* Debug mode internal assertion.
	62	*/
	63	#define BT_ASSERT_DBG(_cond) BT_ASSERT(_cond)
	64
71e89489	65	/*
ec4a3354 PP	66	* Marks a function as being only used within a BT_ASSERT_DBG() context.
	67	*/
	68	#define BT_ASSERT_DBG_FUNC
	69
	70	#else /* BT_DEBUG_MODE */
	71
	72	/*
	73	* When `BT_DEBUG_MODE` is _not_ defined, define BT_ASSERT_DBG() macro
	74	* to the following to trick the compiler into thinking that the
	75	* variable passed as condition to the assertion is used. This is to
	76	* prevent set-but-not-used warnings from the compiler when assertions
	77	* are disabled. The sizeof() operator also makes sure that the `_cond`
	78	* expression is not evaluated, thus preventing unwanted side effects.
71e89489	79	*
ec4a3354 PP	80	* In-depth explanation:
ec4a3354 PP	81	* https://stackoverflow.com/questions/37411809/how-to-elegantly-fix-this-unused-variable-warning/37412551#37412551
71e89489	82	*/
ec4a3354 PP	83	# define BT_ASSERT_DBG(_cond) ((void) sizeof((void) (_cond), 0))
	84	# define BT_ASSERT_DBG_FUNC __attribute__((unused))
	85
d244c559 PP	86	#endif /* BT_DEBUG_MODE */
	87
	88	#endif /* BABELTRACE_ASSERT_INTERNAL_H */