1 #ifndef BABELTRACE_ASSERT_POST_INTERNAL_H
2 #define BABELTRACE_ASSERT_POST_INTERNAL_H
5 * Copyright (c) 2019 EfficiOS Inc. and Linux Foundation
6 * Copyright (c) 2019 Philippe Proulx <pproulx@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
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.
34 * This is a reminder that in order to use "lib/assert-post.h", you also
35 * need to use logging explicitly.
38 #ifndef BT_LIB_LOG_SUPPORTED
39 # error Include "lib/logging.h" before this header.
45 #include "common/macros.h"
46 #include "common/common.h"
49 * Prints the details of an unsatisfied postcondition without
50 * immediately aborting. You should use this within a function which
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.
58 * static inline bool check_complex_postcond(...)
63 * BT_ASSERT_POST_MSG("Unexpected status: ...", ...);
72 * BT_ASSERT_POST(check_complex_postcond(...),
73 * "Postcondition is not satisfied: ...", ...);
75 #define BT_ASSERT_POST_MSG(_fmt, ...) \
77 bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \
78 __LINE__, BT_LOG_FATAL, BT_LOG_TAG, \
79 (_fmt), ##__VA_ARGS__); \
83 * Asserts that the library postcondition `_cond` is satisfied.
85 * If `_cond` is false, log a fatal statement using `_fmt` and the
86 * optional arguments (same usage as BT_LIB_LOGF()), and abort.
88 * To assert that a library precondition is satisfied (parameters from
89 * the user), use BT_ASSERT_PRE().
91 * To assert that an internal postcondition is satisfied, use
92 * BT_ASSERT() or BT_ASSERT_DBG().
94 #define BT_ASSERT_POST(_cond, _fmt, ...) \
97 BT_ASSERT_POST_MSG("Babeltrace 2 library postcondition not satisfied; error is:"); \
98 BT_ASSERT_POST_MSG(_fmt, ##__VA_ARGS__); \
99 BT_ASSERT_POST_MSG("Aborting..."); \
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.
109 #define BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(_status) \
111 const struct bt_error *err = bt_current_thread_take_error(); \
113 bt_current_thread_move_error(err); \
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)); \
122 * Asserts that the current thread has no error.
124 #define BT_ASSERT_POST_NO_ERROR() \
125 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(0)
128 * Marks a function as being only used within a BT_ASSERT_POST()
131 #define BT_ASSERT_POST_FUNC
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__)
138 /* Developer mode version of BT_ASSERT_POST(). */
139 # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) \
140 BT_ASSERT_POST((_cond), _fmt, ##__VA_ARGS__)
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)
146 /* Developer mode version of `BT_ASSERT_POST_FUNC`. */
147 # define BT_ASSERT_POST_DEV_FUNC BT_ASSERT_POST_FUNC
149 # define BT_ASSERT_POST_DEV_MSG(_fmt, ...)
150 # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0))
151 # define BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(_status) \
152 ((void) sizeof((void) (_status), 0))
153 # define BT_ASSERT_POST_DEV_FUNC __attribute__((unused))
154 #endif /* BT_DEV_MODE */
156 #define BT_ASSERT_POST_SUPPORTED
158 #endif /* BABELTRACE_ASSERT_POST_INTERNAL_H */
This page took 0.035463 seconds and 4 git commands to generate.