src/lib/assert-pre.h

   1 #ifndef BABELTRACE_ASSERT_PRE_INTERNAL_H
   2 #define BABELTRACE_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 "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-pre.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/common.h"
  46 #include "common/macros.h"
  47
  48 /*
  49  * Prints the details of an unsatisfied precondition without immediately
  50  * aborting. You should use this within a function which checks
  51  * preconditions, but which is called from a BT_ASSERT_PRE() context, so
  52  * that the function can still return its result for BT_ASSERT_PRE() to
  53  * evaluate it.
  54  *
  55  * Example:
  56  *
  57  *     static inline bool check_complex_precond(...)
  58  *     {
  59  *         ...
  60  *
  61  *         if (...) {
  62  *             BT_ASSERT_PRE_MSG("Invalid object: ...", ...);
  63  *             return false;
  64  *         }
  65  *
  66  *         ...
  67  *     }
  68  *
  69  *     ...
  70  *
  71  *     BT_ASSERT_PRE(check_complex_precond(...),
  72  *                   "Precondition is not satisfied: ...", ...);
  73  */
  74 #define BT_ASSERT_PRE_MSG(_fmt, ...)                                    \
  75         do {                                                            \
  76                 bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,           \
  77                         __LINE__, BT_LOG_FATAL, BT_LOG_TAG,             \
  78                         (_fmt), ##__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
  85  * optional arguments (same usage as BT_LIB_LOGF()), and abort.
  86  *
  87  * To assert that a library postcondition is satisfied (return from user
  88  * code), use BT_ASSERT_POST().
  89  *
  90  * To assert that an internal postcondition is satisfied, use
  91  * BT_ASSERT() or BT_ASSERT_DBG().
  92  */
  93 #define BT_ASSERT_PRE(_cond, _fmt, ...)                         \
  94         do {                                                            \
  95                 if (!(_cond)) {                                         \
  96                         BT_ASSERT_PRE_MSG("Babeltrace 2 library precondition not satisfied; error is:"); \
  97                         BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__); \
  98                         BT_ASSERT_PRE_MSG("Aborting...");               \
  99                         bt_common_abort();                                      \
 100                 }                                                       \
 101         } while (0)
 102
 103 /*
 104  * Asserts that a given variable `_obj` named `_obj_name` (capitalized)
 105  * is not `NULL`.
 106  */
 107 #define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name)                         \
 108         BT_ASSERT_PRE((_obj), "%s is NULL: ", _obj_name)
 109
 110 /*
 111  * Asserts that a given index `_index` is less than a given length
 112  * `_length`.
 113  */
 114 #define BT_ASSERT_PRE_VALID_INDEX(_index, _length)                      \
 115         BT_ASSERT_PRE((_index) < (_length),                             \
 116                 "Index is out of bounds: index=%" PRIu64 ", "           \
 117                 "count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
 118
 119 #ifdef BT_DEV_MODE
 120 /* Developer mode version of BT_ASSERT_PRE_MSG(). */
 121 # define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)                               \
 122         BT_ASSERT_PRE_MSG(_fmt, ##__VA_ARGS__)
 123
 124 /* Developer mode version of BT_ASSERT_PRE(). */
 125 # define BT_ASSERT_PRE_DEV(_cond, _fmt, ...)                            \
 126         BT_ASSERT_PRE((_cond), _fmt, ##__VA_ARGS__)
 127
 128 /* Developer mode version of BT_ASSERT_PRE_NON_NULL() */
 129 # define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name)                    \
 130         BT_ASSERT_PRE_NON_NULL((_obj), (_obj_name))
 131
 132 /*
 133  * Developer mode: asserts that a given object `_obj` named `_obj_name`
 134  * (capitalized) is NOT frozen. This macro checks the `frozen` field of
 135  * `_obj`.
 136  *
 137  * This currently only exists in developer mode because some freezing
 138  * functions can be called on the fast path, so they too are only
 139  * enabled in developer mode.
 140  */
 141 # define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...)              \
 142         BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name,  \
 143                 ##__VA_ARGS__)
 144
 145 /* Developer mode version of BT_ASSERT_PRE_VALID_INDEX() */
 146 # define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length)                 \
 147         BT_ASSERT_PRE_VALID_INDEX((_index), (_length))
 148
 149 /*
 150  * Marks a function as being only used within a BT_ASSERT_PRE_DEV()
 151  * context.
 152  */
 153 # define BT_ASSERT_PRE_DEV_FUNC
 154 #else
 155 # define BT_ASSERT_PRE_DEV_MSG(_fmt, ...)
 156 # define BT_ASSERT_PRE_DEV(_cond, _fmt, ...)    ((void) sizeof((void) (_cond), 0))
 157 # define BT_ASSERT_PRE_DEV_NON_NULL(_obj, _obj_name)                    \
 158         ((void) sizeof((void) (_obj), (void) (_obj_name), 0))
 159 # define BT_ASSERT_PRE_DEV_HOT(_obj, _obj_name, _fmt, ...)              \
 160         ((void) sizeof((void) (_obj), (void) (_obj_name), 0))
 161 # define BT_ASSERT_PRE_DEV_VALID_INDEX(_index, _length)                 \
 162         ((void) sizeof((void) (_index), (void) (_length), 0))
 163 # define BT_ASSERT_PRE_DEV_FUNC         __attribute__((unused))
 164 #endif /* BT_DEV_MODE */
 165
 166 #define BT_ASSERT_PRE_SUPPORTED
 167
 168 #endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */