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