[babeltrace.git] / include / babeltrace / assert-pre-internal.h

#ifndef BABELTRACE_ASSERT_PRE_INTERNAL_H
#define BABELTRACE_ASSERT_PRE_INTERNAL_H

/*
 * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
 * Copyright (c) 2018 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.
 */

/*
 * The macros in this header use macros defined in
 * <babeltrace/lib-logging-internal.h>. We don't want this header to
 * automatically include <babeltrace/lib-logging-internal.h> because you
 * need to manually define BT_LOG_TAG before including
 * <babeltrace/lib-logging-internal.h> and it is unexpected that you
 * also need to define it before including this header.
 *
 * This is a reminder that in order to use
 * <babeltrace/assert-internal.hpp>, you also need to use logging
 * explicitly.
 */
#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
# error Include <babeltrace/lib-logging-internal.h> before this header.
#endif

#include <stdlib.h>

#ifdef BT_DEV_MODE
/*
 * Asserts that the library precondition _cond is satisfied.
 *
 * If _cond is false, log a fatal statement using _fmt and the optional
 * arguments using BT_LIB_LOGF(), and abort.
 *
 * To assert that a postcondition is satisfied or that some internal
 * object/context/value is in the expected state, use BT_ASSERT().
 */
# define BT_ASSERT_PRE(_cond, _fmt, ...)				\
	do {								\
		if (!(_cond)) {						\
			BT_LOGF_STR("Library precondition not satisfied:"); \
			BT_LIB_LOGF((_fmt), ##__VA_ARGS__);		\
			BT_LOGF_STR("Aborting...");			\
			abort();					\
		}							\
	} while (0)

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

/*
 * Prints the details of an unsatisfied precondition without immediately
 * aborting. You should use this within a function which checks
 * preconditions, but which is called from a BT_ASSERT_PRE() context, so
 * that the function can still return its result for BT_ASSERT_PRE() to
 * evaluate it.
 *
 * Example:
 *
 *     BT_ASSERT_PRE_FUNC
 *     static inline bool check_complex_precond(...)
 *     {
 *         ...
 *
 *         if (...) {
 *             BT_ASSERT_PRE_MSG("Invalid object: ...", ...);
 *             return false;
 *         }
 *
 *         ...
 *     }
 *
 *     ...
 *
 *     BT_ASSERT_PRE(check_complex_precond(...),
 *                   "Precondition is not satisfied: ...", ...);
 */
# define BT_ASSERT_PRE_MSG	BT_LIB_LOGF
#else
# define BT_ASSERT_PRE(_cond, _fmt, ...)
# define BT_ASSERT_PRE_FUNC	__attribute__((unused))
# define BT_ASSERT_PRE_MSG(_fmt, ...)
#endif /* BT_DEV_MODE */

/*
 * Developer mode: asserts that a given variable is not NULL.
 */
#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name)				\
	BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)

/*
 * Developer mode: asserts that a given object is NOT frozen. This macro
 * checks the `frozen` field of _obj.
 */
#define BT_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...)			\
	BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name,	\
		##__VA_ARGS__)

#endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */
Commit	Line	Data
464ebc31 PP	1	#ifndef BABELTRACE_ASSERT_PRE_INTERNAL_H
	2	#define BABELTRACE_ASSERT_PRE_INTERNAL_H
	3
	4	/*
	5	* Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
	6	* Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
	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	/*
	28	* The macros in this header use macros defined in
	29	* <babeltrace/lib-logging-internal.h>. We don't want this header to
	30	* automatically include <babeltrace/lib-logging-internal.h> because you
	31	* need to manually define BT_LOG_TAG before including
	32	* <babeltrace/lib-logging-internal.h> and it is unexpected that you
	33	* also need to define it before including this header.
	34	*
	35	* This is a reminder that in order to use
	36	* <babeltrace/assert-internal.hpp>, you also need to use logging
	37	* explicitly.
	38	*/
	39	#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
	40	# error Include <babeltrace/lib-logging-internal.h> before this header.
	41	#endif
	42
	43	#include <stdlib.h>
	44
	45	#ifdef BT_DEV_MODE
	46	/*
	47	* Asserts that the library precondition _cond is satisfied.
	48	*
	49	* If _cond is false, log a fatal statement using _fmt and the optional
	50	* arguments using BT_LIB_LOGF(), and abort.
	51	*
	52	* To assert that a postcondition is satisfied or that some internal
	53	* object/context/value is in the expected state, use BT_ASSERT().
	54	*/
	55	# define BT_ASSERT_PRE(_cond, _fmt, ...) \
	56	do { \
	57	if (!(_cond)) { \
	58	BT_LOGF_STR("Library precondition not satisfied:"); \
	59	BT_LIB_LOGF((_fmt), ##__VA_ARGS__); \
	60	BT_LOGF_STR("Aborting..."); \
	61	abort(); \
	62	} \
	63	} while (0)
	64
65	/*
66	* Marks a function as being only used within a BT_ASSERT_PRE() context.
67	*/
68	# define BT_ASSERT_PRE_FUNC
69
70	/*
71	* Prints the details of an unsatisfied precondition without immediately
72	* aborting. You should use this within a function which checks
73	* preconditions, but which is called from a BT_ASSERT_PRE() context, so
74	* that the function can still return its result for BT_ASSERT_PRE() to
75	* evaluate it.
76	*
77	* Example:
78	*
79	* BT_ASSERT_PRE_FUNC
80	* static inline bool check_complex_precond(...)
81	* {
82	* ...
83	*
84	* if (...) {
85	* BT_ASSERT_PRE_MSG("Invalid object: ...", ...);
86	* return false;
87	* }
88	*
89	* ...
90	* }
91	*
92	* ...
93	*
94	* BT_ASSERT_PRE(check_complex_precond(...),
95	* "Precondition is not satisfied: ...", ...);
96	*/
97	# define BT_ASSERT_PRE_MSG BT_LIB_LOGF
98	#else
99	# define BT_ASSERT_PRE(_cond, _fmt, ...)
100	# define BT_ASSERT_PRE_FUNC __attribute__((unused))
101	# define BT_ASSERT_PRE_MSG(_fmt, ...)
102	#endif /* BT_DEV_MODE */
103
104	/*
105	* Developer mode: asserts that a given variable is not NULL.
106	*/
107	#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name) \
108	BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
109
110	/*
111	* Developer mode: asserts that a given object is NOT frozen. This macro
112	* checks the `frozen` field of _obj.
113	*/
114	#define BT_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...) \
115	BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name, \
116	##__VA_ARGS__)
117
118	#endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */