Cleanup: remove private babeltrace.h
[babeltrace.git] / src / lib / assert-pre.h
CommitLineData
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
578e048b
MJ
29 * <lib/lib-logging.h>. We don't want this header to
30 * automatically include <lib/lib-logging.h> because you
464ebc31 31 * need to manually define BT_LOG_TAG before including
578e048b 32 * <lib/lib-logging.h> and it is unexpected that you
464ebc31
PP
33 * also need to define it before including this header.
34 *
35 * This is a reminder that in order to use
578e048b 36 * <lib/assert-pre.h>, you also need to use logging
464ebc31
PP
37 * explicitly.
38 */
c5b9b441 39
464ebc31 40#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
578e048b 41# error Include <lib/lib-logging.h> before this header.
464ebc31
PP
42#endif
43
44#include <stdlib.h>
ff205f0b 45#include <inttypes.h>
91d81473 46#include "common/macros.h"
464ebc31
PP
47
48#ifdef BT_DEV_MODE
49/*
50 * Asserts that the library precondition _cond is satisfied.
51 *
52 * If _cond is false, log a fatal statement using _fmt and the optional
53 * arguments using BT_LIB_LOGF(), and abort.
54 *
55 * To assert that a postcondition is satisfied or that some internal
56 * object/context/value is in the expected state, use BT_ASSERT().
57 */
58# define BT_ASSERT_PRE(_cond, _fmt, ...) \
59 do { \
60 if (!(_cond)) { \
e3adcdfa 61 BT_LOGF_STR("Library precondition not satisfied; error is:"); \
464ebc31
PP
62 BT_LIB_LOGF((_fmt), ##__VA_ARGS__); \
63 BT_LOGF_STR("Aborting..."); \
64 abort(); \
65 } \
66 } while (0)
67
68/*
69 * Marks a function as being only used within a BT_ASSERT_PRE() context.
70 */
71# define BT_ASSERT_PRE_FUNC
72
73/*
74 * Prints the details of an unsatisfied precondition without immediately
75 * aborting. You should use this within a function which checks
76 * preconditions, but which is called from a BT_ASSERT_PRE() context, so
77 * that the function can still return its result for BT_ASSERT_PRE() to
78 * evaluate it.
79 *
80 * Example:
81 *
82 * BT_ASSERT_PRE_FUNC
83 * static inline bool check_complex_precond(...)
84 * {
85 * ...
86 *
87 * if (...) {
88 * BT_ASSERT_PRE_MSG("Invalid object: ...", ...);
89 * return false;
90 * }
91 *
92 * ...
93 * }
94 *
95 * ...
96 *
97 * BT_ASSERT_PRE(check_complex_precond(...),
98 * "Precondition is not satisfied: ...", ...);
99 */
100# define BT_ASSERT_PRE_MSG BT_LIB_LOGF
101#else
ebbc3f14 102# define BT_ASSERT_PRE(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0))
91d81473 103# define BT_ASSERT_PRE_FUNC __attribute__((unused))
464ebc31
PP
104# define BT_ASSERT_PRE_MSG(_fmt, ...)
105#endif /* BT_DEV_MODE */
106
107/*
108 * Developer mode: asserts that a given variable is not NULL.
109 */
110#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name) \
111 BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
112
113/*
114 * Developer mode: asserts that a given object is NOT frozen. This macro
115 * checks the `frozen` field of _obj.
116 */
117#define BT_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...) \
118 BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name, \
119 ##__VA_ARGS__)
120
c800eb37
PP
121/*
122 * Developer mode: asserts that a given index is less than a given size.
123 */
124#define BT_ASSERT_PRE_VALID_INDEX(_index, _length) \
125 BT_ASSERT_PRE((_index) < (_length), \
126 "Index is out of bounds: index=%" PRIu64 ", " \
127 "count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
128
464ebc31 129#endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */
This page took 0.047771 seconds and 4 git commands to generate.