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