src/ctf-writer/assert-pre.h

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