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