| 1 | #ifndef BABELTRACE_CTF_WRITER_ASSERT_PRE_INTERNAL_H |
| 2 | #define BABELTRACE_CTF_WRITER_ASSERT_PRE_INTERNAL_H |
| 3 | |
| 4 | /* |
| 5 | * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation |
| 6 | * Copyright (c) 2018 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 "logging/log.h". We |
| 29 | * don't want this header to automatically include "logging/log.h" |
| 30 | * because you need to manually define BT_LOG_TAG before including |
| 31 | * "logging/log.h" and it is unexpected that you also need to define it |
| 32 | * before including this header. |
| 33 | * |
| 34 | * This is a reminder that in order to use "ctf-writer/assert-pre.h", |
| 35 | * you also need to use logging explicitly. |
| 36 | */ |
| 37 | |
| 38 | #ifndef BT_LOG_SUPPORTED |
| 39 | # error Include "logging/log.h" before this header. |
| 40 | #endif |
| 41 | |
| 42 | #include <stdlib.h> |
| 43 | #include <inttypes.h> |
| 44 | #include "common/macros.h" |
| 45 | |
| 46 | #ifdef BT_DEV_MODE |
| 47 | /* |
| 48 | * Prints the details of an unsatisfied precondition without immediately |
| 49 | * aborting. You should use this within a function which checks |
| 50 | * preconditions, but which is called from a BT_CTF_ASSERT_PRE() |
| 51 | * context, so that the function can still return its result for |
| 52 | * BT_CTF_ASSERT_PRE() to evaluate it. |
| 53 | * |
| 54 | * Example: |
| 55 | * |
| 56 | * BT_CTF_ASSERT_PRE_FUNC |
| 57 | * static inline bool check_complex_precond(...) |
| 58 | * { |
| 59 | * ... |
| 60 | * |
| 61 | * if (...) { |
| 62 | * BT_CTF_ASSERT_PRE_MSG("Invalid object: ...", ...); |
| 63 | * return false; |
| 64 | * } |
| 65 | * |
| 66 | * ... |
| 67 | * } |
| 68 | * |
| 69 | * ... |
| 70 | * |
| 71 | * BT_CTF_ASSERT_PRE(check_complex_precond(...), |
| 72 | * "Precondition is not satisfied: ...", ...); |
| 73 | */ |
| 74 | # define BT_CTF_ASSERT_PRE_MSG(_fmt, ...) \ |
| 75 | do { \ |
| 76 | _bt_log_write_d(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \ |
| 77 | __LINE__, BT_LOG_FATAL, BT_LOG_TAG, (_fmt), \ |
| 78 | ##__VA_ARGS__); \ |
| 79 | } while (0) |
| 80 | |
| 81 | /* |
| 82 | * Asserts that the library precondition _cond is satisfied. |
| 83 | * |
| 84 | * If _cond is false, log a fatal statement using _fmt and the optional |
| 85 | * arguments using BT_LOGF(), and abort. |
| 86 | * |
| 87 | * To assert that a postcondition is satisfied or that some internal |
| 88 | * object/context/value is in the expected state, use BT_ASSERT(). |
| 89 | */ |
| 90 | # define BT_CTF_ASSERT_PRE(_cond, _fmt, ...) \ |
| 91 | do { \ |
| 92 | if (!(_cond)) { \ |
| 93 | BT_CTF_ASSERT_PRE_MSG("CTF writer precondition not satisfied; error is:"); \ |
| 94 | BT_CTF_ASSERT_PRE_MSG((_fmt), ##__VA_ARGS__); \ |
| 95 | BT_CTF_ASSERT_PRE_MSG("Aborting..."); \ |
| 96 | abort(); \ |
| 97 | } \ |
| 98 | } while (0) |
| 99 | |
| 100 | /* |
| 101 | * Marks a function as being only used within a BT_CTF_ASSERT_PRE() context. |
| 102 | */ |
| 103 | # define BT_CTF_ASSERT_PRE_FUNC |
| 104 | |
| 105 | /* |
| 106 | * Prints the details of an unsatisfied precondition without immediately |
| 107 | * aborting. You should use this within a function which checks |
| 108 | * preconditions, but which is called from a BT_CTF_ASSERT_PRE() context, so |
| 109 | * that the function can still return its result for BT_CTF_ASSERT_PRE() to |
| 110 | * evaluate it. |
| 111 | * |
| 112 | * Example: |
| 113 | * |
| 114 | * BT_CTF_ASSERT_PRE_FUNC |
| 115 | * static inline bool check_complex_precond(...) |
| 116 | * { |
| 117 | * ... |
| 118 | * |
| 119 | * if (...) { |
| 120 | * BT_CTF_ASSERT_PRE_MSG("Invalid object: ...", ...); |
| 121 | * return false; |
| 122 | * } |
| 123 | * |
| 124 | * ... |
| 125 | * } |
| 126 | * |
| 127 | * ... |
| 128 | * |
| 129 | * BT_CTF_ASSERT_PRE(check_complex_precond(...), |
| 130 | * "Precondition is not satisfied: ...", ...); |
| 131 | */ |
| 132 | #else |
| 133 | # define BT_CTF_ASSERT_PRE(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0)) |
| 134 | # define BT_CTF_ASSERT_PRE_FUNC __attribute__((unused)) |
| 135 | # define BT_CTF_ASSERT_PRE_MSG(_fmt, ...) |
| 136 | #endif /* BT_DEV_MODE */ |
| 137 | |
| 138 | /* |
| 139 | * Developer mode: asserts that a given variable is not NULL. |
| 140 | */ |
| 141 | #define BT_CTF_ASSERT_PRE_NON_NULL(_obj, _obj_name) \ |
| 142 | BT_CTF_ASSERT_PRE((_obj), "%s is NULL: ", _obj_name) |
| 143 | |
| 144 | /* |
| 145 | * Developer mode: asserts that a given object is NOT frozen. This macro |
| 146 | * checks the `frozen` field of _obj. |
| 147 | */ |
| 148 | #define BT_CTF_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...) \ |
| 149 | BT_CTF_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name, \ |
| 150 | ##__VA_ARGS__) |
| 151 | |
| 152 | /* |
| 153 | * Developer mode: asserts that a given index is less than a given size. |
| 154 | */ |
| 155 | #define BT_CTF_ASSERT_PRE_VALID_INDEX(_index, _length) \ |
| 156 | BT_CTF_ASSERT_PRE((_index) < (_length), \ |
| 157 | "Index is out of bounds: index=%" PRIu64 ", " \ |
| 158 | "count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length)) |
| 159 | |
| 160 | #endif /* BABELTRACE_CTF_WRITER_ASSERT_PRE_INTERNAL_H */ |