Commit | Line | Data |
---|---|---|
d244c559 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 | /* | |
1633ef46 | 28 | * The macros in this header use macros defined in "lib/logging.h". |
ea5679f7 | 29 | * We don't want this header to automatically include |
1633ef46 PP |
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 | |
d244c559 PP |
32 | * also need to define it before including this header. |
33 | * | |
ea5679f7 PP |
34 | * This is a reminder that in order to use "lib/assert-pre.h", you also |
35 | * need to use logging explicitly. | |
d244c559 | 36 | */ |
8c6884d9 | 37 | |
ebb4875d | 38 | #ifndef BT_LIB_LOG_SUPPORTED |
1633ef46 | 39 | # error Include "lib/logging.h" before this header. |
d244c559 PP |
40 | #endif |
41 | ||
969c1d8a | 42 | #include <stdbool.h> |
d244c559 | 43 | #include <stdlib.h> |
3399ebd2 | 44 | #include <inttypes.h> |
24847fc7 | 45 | #include "common/common.h" |
85e7137b | 46 | #include "common/macros.h" |
d244c559 | 47 | |
d244c559 PP |
48 | /* |
49 | * Prints the details of an unsatisfied precondition without immediately | |
50 | * aborting. You should use this within a function which checks | |
51 | * preconditions, but which is called from a BT_ASSERT_PRE() context, so | |
52 | * that the function can still return its result for BT_ASSERT_PRE() to | |
53 | * evaluate it. | |
54 | * | |
55 | * Example: | |
56 | * | |
d244c559 PP |
57 | * static inline bool check_complex_precond(...) |
58 | * { | |
59 | * ... | |
60 | * | |
61 | * if (...) { | |
62 | * BT_ASSERT_PRE_MSG("Invalid object: ...", ...); | |
63 | * return false; | |
64 | * } | |
65 | * | |
66 | * ... | |
67 | * } | |
68 | * | |
69 | * ... | |
70 | * | |
71 | * BT_ASSERT_PRE(check_complex_precond(...), | |
72 | * "Precondition is not satisfied: ...", ...); | |
73 | */ | |
fa6cfec3 | 74 | #define BT_ASSERT_PRE_MSG(_fmt, ...) \ |
5cf009cd PP |
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 | /* | |
fa6cfec3 | 82 | * Asserts that the library precondition `_cond` is satisfied. |
5cf009cd PP |
83 | * |
84 | * If `_cond` is false, log a fatal statement using `_fmt` and the | |
85 | * optional arguments (same usage as BT_LIB_LOGF()), and abort. | |
86 | * | |
c6f84660 PP |
87 | * To assert that a library postcondition is satisfied (return from user |
88 | * code), use BT_ASSERT_POST(). | |
89 | * | |
90 | * To assert that an internal postcondition is satisfied, use | |
ec4a3354 | 91 | * BT_ASSERT() or BT_ASSERT_DBG(). |
5cf009cd | 92 | */ |
fa6cfec3 | 93 | #define BT_ASSERT_PRE(_cond, _fmt, ...) \ |
5cf009cd PP |
94 | do { \ |
95 | if (!(_cond)) { \ | |
96 | BT_ASSERT_PRE_MSG("Babeltrace 2 library precondition not satisfied; error is:"); \ | |
fa6cfec3 | 97 | BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__); \ |
5cf009cd | 98 | BT_ASSERT_PRE_MSG("Aborting..."); \ |
24847fc7 | 99 | bt_common_abort(); \ |
5cf009cd PP |
100 | } \ |
101 | } while (0) | |
102 | ||
103 | /* | |
fa6cfec3 PP |
104 | * Asserts that a given variable `_obj` named `_obj_name` (capitalized) |
105 | * is not `NULL`. | |
5cf009cd | 106 | */ |
fa6cfec3 | 107 | #define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name) \ |
8e01f2d9 | 108 | BT_ASSERT_PRE((_obj), "%s is NULL: ", _obj_name) |
d244c559 PP |
109 | |
110 | /* | |
fa6cfec3 PP |
111 | * Asserts that a given index `_index` is less than a given length |
112 | * `_length`. | |
d244c559 | 113 | */ |
fa6cfec3 PP |
114 | #define BT_ASSERT_PRE_VALID_INDEX(_index, _length) \ |
115 | BT_ASSERT_PRE((_index) < (_length), \ | |
116 | "Index is out of bounds: index=%" PRIu64 ", " \ | |
117 | "count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length)) | |
118 | ||
7c7324d3 SM |
119 | /* |
120 | * Asserts that the current thread has no error set. | |
121 | */ | |
122 | #define BT_ASSERT_PRE_NO_ERROR() \ | |
123 | do { \ | |
124 | const struct bt_error *err = bt_current_thread_take_error(); \ | |
125 | if (err) { \ | |
126 | bt_current_thread_move_error(err); \ | |
127 | } \ | |
128 | BT_ASSERT_PRE(!err, \ | |
129 | "API function called while current thread has an " \ | |
130 | "error: function=%s", __func__); \ | |
131 | } while (0) | |
132 | ||
fa6cfec3 PP |
133 | #ifdef BT_DEV_MODE |
134 | /* Developer mode version of BT_ASSERT_PRE_MSG(). */ | |
9701989e PP |
135 | # define BT_ASSERT_PRE_DEV_MSG(_fmt, ...) \ |
136 | BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__) | |
fa6cfec3 PP |
137 | |
138 | /* Developer mode version of BT_ASSERT_PRE(). */ | |
139 | # define BT_ASSERT_PRE_DEV(_cond, _fmt, ...) \ | |
9701989e | 140 | BT_ASSERT_PRE((_cond), _fmt, ##__VA_ARGS__) |
fa6cfec3 PP |
141 | |
142 | /* Developer mode version of BT_ASSERT_PRE_NON_NULL() */ | |
143 | # define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name) \ | |
144 | BT_ASSERT_PRE_NON_NULL((_obj), (_obj_name)) | |
d244c559 PP |
145 | |
146 | /* | |
c6f84660 PP |
147 | * Developer mode: asserts that a given object `_obj` named `_obj_name` |
148 | * (capitalized) is NOT frozen. This macro checks the `frozen` field of | |
149 | * `_obj`. | |
fa6cfec3 PP |
150 | * |
151 | * This currently only exists in developer mode because some freezing | |
152 | * functions can be called on the fast path, so they too are only | |
153 | * enabled in developer mode. | |
d244c559 | 154 | */ |
fa6cfec3 | 155 | # define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...) \ |
d244c559 PP |
156 | BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name, \ |
157 | ##__VA_ARGS__) | |
158 | ||
fa6cfec3 PP |
159 | /* Developer mode version of BT_ASSERT_PRE_VALID_INDEX() */ |
160 | # define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length) \ | |
161 | BT_ASSERT_PRE_VALID_INDEX((_index), (_length)) | |
162 | ||
7c7324d3 SM |
163 | /* Developer mode version of BT_ASSERT_PRE_NO_ERROR(). */ |
164 | # define BT_ASSERT_PRE_DEV_NO_ERROR() \ | |
165 | BT_ASSERT_PRE_NO_ERROR() | |
166 | ||
07f58535 PP |
167 | /* |
168 | * Marks a function as being only used within a BT_ASSERT_PRE_DEV() | |
169 | * context. | |
170 | */ | |
fa6cfec3 PP |
171 | # define BT_ASSERT_PRE_DEV_FUNC |
172 | #else | |
173 | # define BT_ASSERT_PRE_DEV_MSG(_fmt, ...) | |
174 | # define BT_ASSERT_PRE_DEV(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0)) | |
175 | # define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name) \ | |
176 | ((void) sizeof((void) (_obj), (void) (_obj_name), 0)) | |
177 | # define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...) \ | |
178 | ((void) sizeof((void) (_obj), (void) (_obj_name), 0)) | |
179 | # define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length) \ | |
180 | ((void) sizeof((void) (_index), (void) (_length), 0)) | |
7c7324d3 | 181 | # define BT_ASSERT_PRE_DEV_NO_ERROR() |
fa6cfec3 PP |
182 | # define BT_ASSERT_PRE_DEV_FUNC __attribute__((unused)) |
183 | #endif /* BT_DEV_MODE */ | |
ba9db19a | 184 | |
7d0140bc PP |
185 | #define BT_ASSERT_PRE_SUPPORTED |
186 | ||
d244c559 | 187 | #endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */ |