Commit | Line | Data |
---|---|---|
c6f84660 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 | ||
969c1d8a | 42 | #include <stdbool.h> |
c6f84660 PP |
43 | #include <stdlib.h> |
44 | #include <inttypes.h> | |
45 | #include "common/macros.h" | |
24847fc7 | 46 | #include "common/common.h" |
c6f84660 | 47 | |
c6f84660 PP |
48 | /* |
49 | * Prints the details of an unsatisfied postcondition without | |
50 | * immediately aborting. You should use this within a function which | |
fa6cfec3 PP |
51 | * checks postconditions, but which is called from a |
52 | * BT_ASSERT_POST() context, so that the function can still return | |
53 | * its result for BT_ASSERT_POST() to evaluate it. | |
c6f84660 PP |
54 | * |
55 | * Example: | |
56 | * | |
57 | * BT_ASSERT_POST_FUNC | |
58 | * static inline bool check_complex_postcond(...) | |
59 | * { | |
60 | * ... | |
61 | * | |
62 | * if (...) { | |
63 | * BT_ASSERT_POST_MSG("Unexpected status: ...", ...); | |
64 | * return false; | |
65 | * } | |
66 | * | |
67 | * ... | |
68 | * } | |
69 | * | |
70 | * ... | |
71 | * | |
72 | * BT_ASSERT_POST(check_complex_postcond(...), | |
fa6cfec3 | 73 | * "Postcondition is not satisfied: ...", ...); |
c6f84660 | 74 | */ |
fa6cfec3 | 75 | #define BT_ASSERT_POST_MSG(_fmt, ...) \ |
c6f84660 PP |
76 | do { \ |
77 | bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \ | |
78 | __LINE__, BT_LOG_FATAL, BT_LOG_TAG, \ | |
79 | (_fmt), ##__VA_ARGS__); \ | |
80 | } while (0) | |
81 | ||
82 | /* | |
fa6cfec3 | 83 | * Asserts that the library postcondition `_cond` is satisfied. |
c6f84660 PP |
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 | |
ec4a3354 | 92 | * BT_ASSERT() or BT_ASSERT_DBG(). |
c6f84660 | 93 | */ |
fa6cfec3 | 94 | #define BT_ASSERT_POST(_cond, _fmt, ...) \ |
c6f84660 PP |
95 | do { \ |
96 | if (!(_cond)) { \ | |
97 | BT_ASSERT_POST_MSG("Babeltrace 2 library postcondition not satisfied; error is:"); \ | |
fa6cfec3 | 98 | BT_ASSERT_POST_MSG(_fmt, ##__VA_ARGS__); \ |
c6f84660 | 99 | BT_ASSERT_POST_MSG("Aborting..."); \ |
24847fc7 | 100 | bt_common_abort(); \ |
c6f84660 PP |
101 | } \ |
102 | } while (0) | |
103 | ||
d6f6a5aa SM |
104 | /* |
105 | * Asserts that if there's an error on the current thread, an error status code | |
106 | * was returned. Puts back the error in place (if there is one) such that if | |
107 | * the assertion hits, it will be possible to inspect it with a debugger. | |
108 | */ | |
109 | #define BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(_status) \ | |
110 | do { \ | |
111 | const struct bt_error *err = bt_current_thread_take_error(); \ | |
112 | if (err) { \ | |
113 | bt_current_thread_move_error(err); \ | |
114 | } \ | |
115 | BT_ASSERT_POST(_status < 0 || !err, \ | |
116 | "Current thread has an error, but user function " \ | |
117 | "returned a non-error status: status=%s", \ | |
118 | bt_common_func_status_string(_status)); \ | |
119 | } while (0) | |
120 | ||
121 | /* | |
122 | * Asserts that the current thread has no error. | |
123 | */ | |
124 | #define BT_ASSERT_POST_NO_ERROR() \ | |
125 | BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(0) | |
126 | ||
c6f84660 PP |
127 | /* |
128 | * Marks a function as being only used within a BT_ASSERT_POST() | |
129 | * context. | |
130 | */ | |
fa6cfec3 PP |
131 | #define BT_ASSERT_POST_FUNC |
132 | ||
133 | #ifdef BT_DEV_MODE | |
134 | /* Developer mode version of BT_ASSERT_POST_MSG(). */ | |
135 | # define BT_ASSERT_POST_DEV_MSG(_fmt, ...) \ | |
136 | BT_ASSERT_POST_MSG(_fmt, ##__VA_ARGS__) | |
137 | ||
138 | /* Developer mode version of BT_ASSERT_POST(). */ | |
139 | # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) \ | |
140 | BT_ASSERT_POST((_cond), _fmt, ##__VA_ARGS__) | |
141 | ||
d6f6a5aa SM |
142 | /* Developer mode version of BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(). */ |
143 | # define BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(_status) \ | |
144 | BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(_status) | |
145 | ||
fa6cfec3 PP |
146 | /* Developer mode version of `BT_ASSERT_POST_FUNC`. */ |
147 | # define BT_ASSERT_POST_DEV_FUNC BT_ASSERT_POST_FUNC | |
c6f84660 | 148 | #else |
fa6cfec3 PP |
149 | # define BT_ASSERT_POST_DEV_MSG(_fmt, ...) |
150 | # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0)) | |
d6f6a5aa SM |
151 | # define BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(_status) \ |
152 | ((void) sizeof((void) (_status), 0)) | |
fa6cfec3 | 153 | # define BT_ASSERT_POST_DEV_FUNC __attribute__((unused)) |
c6f84660 PP |
154 | #endif /* BT_DEV_MODE */ |
155 | ||
7d0140bc PP |
156 | #define BT_ASSERT_POST_SUPPORTED |
157 | ||
c6f84660 | 158 | #endif /* BABELTRACE_ASSERT_POST_INTERNAL_H */ |