Commit | Line | Data |
---|---|---|
1f9f5b4d 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 | ||
42 | #include <stdlib.h> | |
43 | #include <inttypes.h> | |
44 | #include "common/macros.h" | |
45 | ||
1f9f5b4d PP |
46 | /* |
47 | * Prints the details of an unsatisfied postcondition without | |
48 | * immediately aborting. You should use this within a function which | |
bdb288b3 PP |
49 | * checks postconditions, but which is called from a |
50 | * BT_ASSERT_POST() context, so that the function can still return | |
51 | * its result for BT_ASSERT_POST() to evaluate it. | |
1f9f5b4d PP |
52 | * |
53 | * Example: | |
54 | * | |
55 | * BT_ASSERT_POST_FUNC | |
56 | * static inline bool check_complex_postcond(...) | |
57 | * { | |
58 | * ... | |
59 | * | |
60 | * if (...) { | |
61 | * BT_ASSERT_POST_MSG("Unexpected status: ...", ...); | |
62 | * return false; | |
63 | * } | |
64 | * | |
65 | * ... | |
66 | * } | |
67 | * | |
68 | * ... | |
69 | * | |
70 | * BT_ASSERT_POST(check_complex_postcond(...), | |
bdb288b3 | 71 | * "Postcondition is not satisfied: ...", ...); |
1f9f5b4d | 72 | */ |
bdb288b3 | 73 | #define BT_ASSERT_POST_MSG(_fmt, ...) \ |
1f9f5b4d PP |
74 | do { \ |
75 | bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \ | |
76 | __LINE__, BT_LOG_FATAL, BT_LOG_TAG, \ | |
77 | (_fmt), ##__VA_ARGS__); \ | |
78 | } while (0) | |
79 | ||
80 | /* | |
bdb288b3 | 81 | * Asserts that the library postcondition `_cond` is satisfied. |
1f9f5b4d PP |
82 | * |
83 | * If `_cond` is false, log a fatal statement using `_fmt` and the | |
84 | * optional arguments (same usage as BT_LIB_LOGF()), and abort. | |
85 | * | |
86 | * To assert that a library precondition is satisfied (parameters from | |
87 | * the user), use BT_ASSERT_PRE(). | |
88 | * | |
89 | * To assert that an internal postcondition is satisfied, use | |
90 | * BT_ASSERT(). | |
91 | */ | |
bdb288b3 | 92 | #define BT_ASSERT_POST(_cond, _fmt, ...) \ |
1f9f5b4d PP |
93 | do { \ |
94 | if (!(_cond)) { \ | |
95 | BT_ASSERT_POST_MSG("Babeltrace 2 library postcondition not satisfied; error is:"); \ | |
bdb288b3 | 96 | BT_ASSERT_POST_MSG(_fmt, ##__VA_ARGS__); \ |
1f9f5b4d PP |
97 | BT_ASSERT_POST_MSG("Aborting..."); \ |
98 | abort(); \ | |
99 | } \ | |
100 | } while (0) | |
101 | ||
102 | /* | |
103 | * Marks a function as being only used within a BT_ASSERT_POST() | |
104 | * context. | |
105 | */ | |
bdb288b3 PP |
106 | #define BT_ASSERT_POST_FUNC |
107 | ||
108 | #ifdef BT_DEV_MODE | |
109 | /* Developer mode version of BT_ASSERT_POST_MSG(). */ | |
110 | # define BT_ASSERT_POST_DEV_MSG(_fmt, ...) \ | |
111 | BT_ASSERT_POST_MSG(_fmt, ##__VA_ARGS__) | |
112 | ||
113 | /* Developer mode version of BT_ASSERT_POST(). */ | |
114 | # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) \ | |
115 | BT_ASSERT_POST((_cond), _fmt, ##__VA_ARGS__) | |
116 | ||
117 | /* Developer mode version of `BT_ASSERT_POST_FUNC`. */ | |
118 | # define BT_ASSERT_POST_DEV_FUNC BT_ASSERT_POST_FUNC | |
1f9f5b4d | 119 | #else |
bdb288b3 PP |
120 | # define BT_ASSERT_POST_DEV_MSG(_fmt, ...) |
121 | # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0)) | |
122 | # define BT_ASSERT_POST_DEV_FUNC __attribute__((unused)) | |
1f9f5b4d PP |
123 | #endif /* BT_DEV_MODE */ |
124 | ||
ce53ba7a PP |
125 | #define BT_ASSERT_POST_SUPPORTED |
126 | ||
1f9f5b4d | 127 | #endif /* BABELTRACE_ASSERT_POST_INTERNAL_H */ |