| 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 <stdbool.h> |
| 43 | #include <stdlib.h> |
| 44 | #include <inttypes.h> |
| 45 | #include "common/macros.h" |
| 46 | #include "common/common.h" |
| 47 | |
| 48 | /* |
| 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. |
| 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(...), |
| 73 | * "Postcondition is not satisfied: ...", ...); |
| 74 | */ |
| 75 | #define BT_ASSERT_POST_MSG(_fmt, ...) \ |
| 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 | /* |
| 83 | * Asserts that the library postcondition `_cond` is satisfied. |
| 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 |
| 92 | * BT_ASSERT() or BT_ASSERT_DBG(). |
| 93 | */ |
| 94 | #define BT_ASSERT_POST(_cond, _fmt, ...) \ |
| 95 | do { \ |
| 96 | if (!(_cond)) { \ |
| 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..."); \ |
| 100 | bt_common_abort(); \ |
| 101 | } \ |
| 102 | } while (0) |
| 103 | |
| 104 | /* |
| 105 | * Marks a function as being only used within a BT_ASSERT_POST() |
| 106 | * context. |
| 107 | */ |
| 108 | #define BT_ASSERT_POST_FUNC |
| 109 | |
| 110 | #ifdef BT_DEV_MODE |
| 111 | /* Developer mode version of BT_ASSERT_POST_MSG(). */ |
| 112 | # define BT_ASSERT_POST_DEV_MSG(_fmt, ...) \ |
| 113 | BT_ASSERT_POST_MSG(_fmt, ##__VA_ARGS__) |
| 114 | |
| 115 | /* Developer mode version of BT_ASSERT_POST(). */ |
| 116 | # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) \ |
| 117 | BT_ASSERT_POST((_cond), _fmt, ##__VA_ARGS__) |
| 118 | |
| 119 | /* Developer mode version of `BT_ASSERT_POST_FUNC`. */ |
| 120 | # define BT_ASSERT_POST_DEV_FUNC BT_ASSERT_POST_FUNC |
| 121 | #else |
| 122 | # define BT_ASSERT_POST_DEV_MSG(_fmt, ...) |
| 123 | # define BT_ASSERT_POST_DEV(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0)) |
| 124 | # define BT_ASSERT_POST_DEV_FUNC __attribute__((unused)) |
| 125 | #endif /* BT_DEV_MODE */ |
| 126 | |
| 127 | #define BT_ASSERT_POST_SUPPORTED |
| 128 | |
| 129 | #endif /* BABELTRACE_ASSERT_POST_INTERNAL_H */ |