[babeltrace.git] / src / lib / assert-post.h

#ifndef BABELTRACE_ASSERT_POST_INTERNAL_H
#define BABELTRACE_ASSERT_POST_INTERNAL_H

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

/*
 * The macros in this header use macros defined in "lib/logging.h".
 * We don't want this header to automatically include
 * "lib/logging.h" because you need to manually define BT_LOG_TAG
 * before including "lib/logging.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 "lib/assert-post.h", you also
 * need to use logging explicitly.
 */

#ifndef BT_LIB_LOG_SUPPORTED
# error Include "lib/logging.h" before this header.
#endif

#include <stdlib.h>
#include <inttypes.h>
#include "common/macros.h"

#ifdef BT_DEV_MODE
/*
 * Prints the details of an unsatisfied postcondition without
 * immediately aborting. You should use this within a function which
 * checks postconditions, but which is called from a BT_ASSERT_POST()
 * context, so that the function can still return its result for
 * BT_ASSERT_POST() to evaluate it.
 *
 * Example:
 *
 *     BT_ASSERT_POST_FUNC
 *     static inline bool check_complex_postcond(...)
 *     {
 *         ...
 *
 *         if (...) {
 *             BT_ASSERT_POST_MSG("Unexpected status: ...", ...);
 *             return false;
 *         }
 *
 *         ...
 *     }
 *
 *     ...
 *
 *     BT_ASSERT_POST(check_complex_postcond(...),
 *                   "Postcondition is not satisfied: ...", ...);
 */
# define BT_ASSERT_POST_MSG(_fmt, ...)					\
	do {								\
		bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,		\
			__LINE__, BT_LOG_FATAL, BT_LOG_TAG,		\
			(_fmt), ##__VA_ARGS__);				\
	} while (0)

/*
 * Developer mode: asserts that the library postcondition `_cond` is
 * satisfied.
 *
 * If `_cond` is false, log a fatal statement using `_fmt` and the
 * optional arguments (same usage as BT_LIB_LOGF()), and abort.
 *
 * To assert that a library precondition is satisfied (parameters from
 * the user), use BT_ASSERT_PRE().
 *
 * To assert that an internal postcondition is satisfied, use
 * BT_ASSERT().
 */
# define BT_ASSERT_POST(_cond, _fmt, ...)				\
	do {								\
		if (!(_cond)) {						\
			BT_ASSERT_POST_MSG("Babeltrace 2 library postcondition not satisfied; error is:"); \
			BT_ASSERT_POST_MSG((_fmt), ##__VA_ARGS__);	\
			BT_ASSERT_POST_MSG("Aborting...");		\
			abort();					\
		}							\
	} while (0)

/*
 * Marks a function as being only used within a BT_ASSERT_POST()
 * context.
 */
# define BT_ASSERT_POST_FUNC
#else
# define BT_ASSERT_POST(_cond, _fmt, ...)	((void) sizeof((void) (_cond), 0))
# define BT_ASSERT_POST_FUNC	__attribute__((unused))
# define BT_ASSERT_POST_MSG(_fmt, ...)
#endif /* BT_DEV_MODE */

#endif /* BABELTRACE_ASSERT_POST_INTERNAL_H */
Commit	Line	Data
1f9f5b4d PP	1	#ifndef BABELTRACE_ASSERT_POST_INTERNAL_H
	2	#define BABELTRACE_ASSERT_POST_INTERNAL_H
	3
	4	/*
	5	* Copyright (c) 2019 EfficiOS Inc. and Linux Foundation
	6	* Copyright (c) 2019 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 "lib/logging.h".
	29	* We don't want this header to automatically include
	30	* "lib/logging.h" because you need to manually define BT_LOG_TAG
	31	* before including "lib/logging.h" and it is unexpected that you
	32	* also need to define it before including this header.
	33	*
	34	* This is a reminder that in order to use "lib/assert-post.h", you also
	35	* need to use logging explicitly.
	36	*/
	37
	38	#ifndef BT_LIB_LOG_SUPPORTED
	39	# error Include "lib/logging.h" before this header.
	40	#endif
	41
	42	#include <stdlib.h>
	43	#include <inttypes.h>
	44	#include "common/macros.h"
	45
	46	#ifdef BT_DEV_MODE
	47	/*
	48	* Prints the details of an unsatisfied postcondition without
	49	* immediately aborting. You should use this within a function which
	50	* checks postconditions, but which is called from a BT_ASSERT_POST()
	51	* context, so that the function can still return its result for
	52	* BT_ASSERT_POST() to evaluate it.
	53	*
	54	* Example:
	55	*
	56	* BT_ASSERT_POST_FUNC
	57	* static inline bool check_complex_postcond(...)
	58	* {
	59	* ...
	60	*
	61	* if (...) {
	62	* BT_ASSERT_POST_MSG("Unexpected status: ...", ...);
	63	* return false;
	64	* }
65	*
66	* ...
67	* }
68	*
69	* ...
70	*
71	* BT_ASSERT_POST(check_complex_postcond(...),
72	* "Postcondition is not satisfied: ...", ...);
73	*/
74	# define BT_ASSERT_POST_MSG(_fmt, ...) \
75	do { \
76	bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \
77	__LINE__, BT_LOG_FATAL, BT_LOG_TAG, \
78	(_fmt), ##__VA_ARGS__); \
79	} while (0)
80
81	/*
82	* Developer mode: asserts that the library postcondition `_cond` is
83	* satisfied.
84	*
85	* If `_cond` is false, log a fatal statement using `_fmt` and the
86	* optional arguments (same usage as BT_LIB_LOGF()), and abort.
87	*
88	* To assert that a library precondition is satisfied (parameters from
89	* the user), use BT_ASSERT_PRE().
90	*
91	* To assert that an internal postcondition is satisfied, use
92	* BT_ASSERT().
93	*/
94	# define BT_ASSERT_POST(_cond, _fmt, ...) \
95	do { \
96	if (!(_cond)) { \
97	BT_ASSERT_POST_MSG("Babeltrace 2 library postcondition not satisfied; error is:"); \
98	BT_ASSERT_POST_MSG((_fmt), ##__VA_ARGS__); \
99	BT_ASSERT_POST_MSG("Aborting..."); \
100	abort(); \
101	} \
102	} while (0)
103
104	/*
105	* Marks a function as being only used within a BT_ASSERT_POST()
106	* context.
107	*/
108	# define BT_ASSERT_POST_FUNC
109	#else
110	# define BT_ASSERT_POST(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0))
111	# define BT_ASSERT_POST_FUNC __attribute__((unused))
112	# define BT_ASSERT_POST_MSG(_fmt, ...)
113	#endif /* BT_DEV_MODE */
114
115	#endif /* BABELTRACE_ASSERT_POST_INTERNAL_H */