[babeltrace.git] / src / lib / assert-pre.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 "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-pre.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"

/*
 * 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(_fmt, ...)					\
	do {								\
		bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,		\
			__LINE__, BT_LOG_FATAL, BT_LOG_TAG,		\
			(_fmt), ##__VA_ARGS__);				\
	} while (0)

/*
 * Asserts that the library precondition `_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 postcondition is satisfied (return from user
 * code), use BT_ASSERT_POST().
 *
 * To assert that an internal postcondition is satisfied, use
 * BT_ASSERT().
 */
#define BT_ASSERT_PRE(_cond, _fmt, ...)				\
	do {								\
		if (!(_cond)) {						\
			BT_ASSERT_PRE_MSG("Babeltrace 2 library precondition not satisfied; error is:"); \
			BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__);	\
			BT_ASSERT_PRE_MSG("Aborting...");		\
			abort();					\
		}							\
	} while (0)

/*
 * Asserts that a given variable `_obj` named `_obj_name` (capitalized)
 * is not `NULL`.
 */
#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name)				\
	BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)

/*
 * Asserts that a given index `_index` is less than a given length
 * `_length`.
 */
#define BT_ASSERT_PRE_VALID_INDEX(_index, _length)			\
	BT_ASSERT_PRE((_index) < (_length),				\
		"Index is out of bounds: index=%" PRIu64 ", "		\
		"count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))

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

#ifdef BT_DEV_MODE
/* Developer mode version of BT_ASSERT_PRE_MSG(). */
# define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)					\
	BT_ASSERT_PRE_MSG(_fmt, #__VA_ARGS__)

/* Developer mode version of BT_ASSERT_PRE(). */
# define BT_ASSERT_PRE_DEV(_cond, _fmt, ...)				\
	BT_ASSERT_PRE((_cond), _fmt, #__VA_ARGS__)

/* Developer mode version of BT_ASSERT_PRE_NON_NULL() */
# define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name)			\
	BT_ASSERT_PRE_NON_NULL((_obj), (_obj_name))

/*
 * Developer mode: asserts that a given object `_obj` named `_obj_name`
 * (capitalized) is NOT frozen. This macro checks the `frozen` field of
 * `_obj`.
 *
 * This currently only exists in developer mode because some freezing
 * functions can be called on the fast path, so they too are only
 * enabled in developer mode.
 */
# define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...)		\
	BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name,	\
		##__VA_ARGS__)

/* Developer mode version of BT_ASSERT_PRE_VALID_INDEX() */
# define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length)			\
	BT_ASSERT_PRE_VALID_INDEX((_index), (_length))

/* Developer mode version of `BT_ASSERT_PRE_FUNC`. */
# define BT_ASSERT_PRE_DEV_FUNC
#else
# define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)
# define BT_ASSERT_PRE_DEV(_cond, _fmt, ...)	((void) sizeof((void) (_cond), 0))
# define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name)			\
	((void) sizeof((void) (_obj), (void) (_obj_name), 0))
# define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...)		\
	((void) sizeof((void) (_obj), (void) (_obj_name), 0))
# define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length)			\
	((void) sizeof((void) (_index), (void) (_length), 0))
# define BT_ASSERT_PRE_DEV_FUNC		__attribute__((unused))
#endif /* BT_DEV_MODE */

#define BT_ASSERT_PRE_SUPPORTED

#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	/*
c2d9d9cf	28	* The macros in this header use macros defined in "lib/logging.h".
f2371a94	29	* We don't want this header to automatically include
c2d9d9cf PP	30	* "lib/logging.h" because you need to manually define BT_LOG_TAG
c2d9d9cf PP	31	* before including "lib/logging.h" and it is unexpected that you
464ebc31 PP	32	* also need to define it before including this header.
464ebc31 PP	33	*
f2371a94 PP	34	* This is a reminder that in order to use "lib/assert-pre.h", you also
f2371a94 PP	35	* need to use logging explicitly.
464ebc31	36	*/
c5b9b441	37
7151fb67	38	#ifndef BT_LIB_LOG_SUPPORTED
c2d9d9cf	39	# error Include "lib/logging.h" before this header.
464ebc31 PP	40	#endif
	41
	42	#include <stdlib.h>
ff205f0b	43	#include <inttypes.h>
91d81473	44	#include "common/macros.h"
464ebc31	45
464ebc31 PP	46	/*
	47	* Prints the details of an unsatisfied precondition without immediately
	48	* aborting. You should use this within a function which checks
	49	* preconditions, but which is called from a BT_ASSERT_PRE() context, so
	50	* that the function can still return its result for BT_ASSERT_PRE() to
	51	* evaluate it.
	52	*
	53	* Example:
	54	*
	55	* BT_ASSERT_PRE_FUNC
	56	* static inline bool check_complex_precond(...)
	57	* {
	58	* ...
	59	*
	60	* if (...) {
	61	* BT_ASSERT_PRE_MSG("Invalid object: ...", ...);
	62	* return false;
	63	* }
	64	*
	65	* ...
	66	* }
	67	*
	68	* ...
	69	*
	70	* BT_ASSERT_PRE(check_complex_precond(...),
	71	* "Precondition is not satisfied: ...", ...);
	72	*/
bdb288b3	73	#define BT_ASSERT_PRE_MSG(_fmt, ...) \
34ae0d62 PP	74	do { \
	75	bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \
	76	__LINE__, BT_LOG_FATAL, BT_LOG_TAG, \
	77	(_fmt), ##__VA_ARGS__); \
	78	} while (0)
	79
	80	/*
bdb288b3	81	* Asserts that the library precondition `_cond` is satisfied.
34ae0d62 PP	82	*
	83	* If `_cond` is false, log a fatal statement using `_fmt` and the
	84	* optional arguments (same usage as BT_LIB_LOGF()), and abort.
	85	*
1f9f5b4d PP	86	* To assert that a library postcondition is satisfied (return from user
	87	* code), use BT_ASSERT_POST().
	88	*
	89	* To assert that an internal postcondition is satisfied, use
	90	* BT_ASSERT().
34ae0d62	91	*/
bdb288b3	92	#define BT_ASSERT_PRE(_cond, _fmt, ...) \
34ae0d62 PP	93	do { \
	94	if (!(_cond)) { \
	95	BT_ASSERT_PRE_MSG("Babeltrace 2 library precondition not satisfied; error is:"); \
bdb288b3	96	BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__); \
34ae0d62 PP	97	BT_ASSERT_PRE_MSG("Aborting..."); \
	98	abort(); \
	99	} \
	100	} while (0)
	101
	102	/*
bdb288b3 PP	103	* Asserts that a given variable `_obj` named `_obj_name` (capitalized)
bdb288b3 PP	104	* is not `NULL`.
34ae0d62	105	*/
bdb288b3 PP	106	#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name) \
bdb288b3 PP	107	BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
464ebc31 PP	108
464ebc31 PP	109	/*
bdb288b3 PP	110	* Asserts that a given index `_index` is less than a given length
bdb288b3 PP	111	* `_length`.
464ebc31	112	*/
bdb288b3 PP	113	#define BT_ASSERT_PRE_VALID_INDEX(_index, _length) \
	114	BT_ASSERT_PRE((_index) < (_length), \
	115	"Index is out of bounds: index=%" PRIu64 ", " \
	116	"count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
	117
	118	/*
	119	* Marks a function as being only used within a BT_ASSERT_PRE() context.
	120	*/
	121	#define BT_ASSERT_PRE_FUNC
	122
	123	#ifdef BT_DEV_MODE
	124	/* Developer mode version of BT_ASSERT_PRE_MSG(). */
	125	# define BT_ASSERT_PRE_DEV_MSG(_fmt, ...) \
	126	BT_ASSERT_PRE_MSG(_fmt, #__VA_ARGS__)
	127
	128	/* Developer mode version of BT_ASSERT_PRE(). */
	129	# define BT_ASSERT_PRE_DEV(_cond, _fmt, ...) \
	130	BT_ASSERT_PRE((_cond), _fmt, #__VA_ARGS__)
	131
	132	/* Developer mode version of BT_ASSERT_PRE_NON_NULL() */
	133	# define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name) \
	134	BT_ASSERT_PRE_NON_NULL((_obj), (_obj_name))
464ebc31 PP	135
464ebc31 PP	136	/*
1f9f5b4d PP	137	* Developer mode: asserts that a given object `_obj` named `_obj_name`
	138	* (capitalized) is NOT frozen. This macro checks the `frozen` field of
	139	* `_obj`.
bdb288b3 PP	140	*
	141	* This currently only exists in developer mode because some freezing
	142	* functions can be called on the fast path, so they too are only
	143	* enabled in developer mode.
464ebc31	144	*/
bdb288b3	145	# define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...) \
464ebc31 PP	146	BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name, \
	147	##__VA_ARGS__)
	148
bdb288b3 PP	149	/* Developer mode version of BT_ASSERT_PRE_VALID_INDEX() */
	150	# define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length) \
	151	BT_ASSERT_PRE_VALID_INDEX((_index), (_length))
	152
	153	/* Developer mode version of `BT_ASSERT_PRE_FUNC`. */
	154	# define BT_ASSERT_PRE_DEV_FUNC
	155	#else
	156	# define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)
	157	# define BT_ASSERT_PRE_DEV(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0))
	158	# define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name) \
	159	((void) sizeof((void) (_obj), (void) (_obj_name), 0))
	160	# define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...) \
	161	((void) sizeof((void) (_obj), (void) (_obj_name), 0))
	162	# define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length) \
	163	((void) sizeof((void) (_index), (void) (_length), 0))
	164	# define BT_ASSERT_PRE_DEV_FUNC __attribute__((unused))
	165	#endif /* BT_DEV_MODE */
c800eb37	166
ce53ba7a PP	167	#define BT_ASSERT_PRE_SUPPORTED
ce53ba7a PP	168
464ebc31	169	#endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */