include/babeltrace/assert-pre-internal.h

   1 #ifndef BABELTRACE_ASSERT_PRE_INTERNAL_H
   2 #define BABELTRACE_ASSERT_PRE_INTERNAL_H
   3
   4 #include <babeltrace/babeltrace-internal.h>
   5
   6 /*
   7  * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
   8  * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 /*
  30  * The macros in this header use macros defined in
  31  * <babeltrace/lib-logging-internal.h>. We don't want this header to
  32  * automatically include <babeltrace/lib-logging-internal.h> because you
  33  * need to manually define BT_LOG_TAG before including
  34  * <babeltrace/lib-logging-internal.h> and it is unexpected that you
  35  * also need to define it before including this header.
  36  *
  37  * This is a reminder that in order to use
  38  * <babeltrace/assert-pre-internal.h>, you also need to use logging
  39  * explicitly.
  40  */
  41 #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
  42 # error Include <babeltrace/lib-logging-internal.h> before this header.
  43 #endif
  44
  45 #include <stdlib.h>
  46
  47 #ifdef BT_DEV_MODE
  48 /*
  49  * Asserts that the library precondition _cond is satisfied.
  50  *
  51  * If _cond is false, log a fatal statement using _fmt and the optional
  52  * arguments using BT_LIB_LOGF(), and abort.
  53  *
  54  * To assert that a postcondition is satisfied or that some internal
  55  * object/context/value is in the expected state, use BT_ASSERT().
  56  */
  57 # define BT_ASSERT_PRE(_cond, _fmt, ...)                                \
  58         do {                                                            \
  59                 if (!(_cond)) {                                         \
  60                         BT_LOGF_STR("Library precondition not satisfied:"); \
  61                         BT_LIB_LOGF((_fmt), ##__VA_ARGS__);             \
  62                         BT_LOGF_STR("Aborting...");                     \
  63                         abort();                                        \
  64                 }                                                       \
  65         } while (0)
  66
  67 /*
  68  * Marks a function as being only used within a BT_ASSERT_PRE() context.
  69  */
  70 # define BT_ASSERT_PRE_FUNC
  71
  72 /*
  73  * Prints the details of an unsatisfied precondition without immediately
  74  * aborting. You should use this within a function which checks
  75  * preconditions, but which is called from a BT_ASSERT_PRE() context, so
  76  * that the function can still return its result for BT_ASSERT_PRE() to
  77  * evaluate it.
  78  *
  79  * Example:
  80  *
  81  *     BT_ASSERT_PRE_FUNC
  82  *     static inline bool check_complex_precond(...)
  83  *     {
  84  *         ...
  85  *
  86  *         if (...) {
  87  *             BT_ASSERT_PRE_MSG("Invalid object: ...", ...);
  88  *             return false;
  89  *         }
  90  *
  91  *         ...
  92  *     }
  93  *
  94  *     ...
  95  *
  96  *     BT_ASSERT_PRE(check_complex_precond(...),
  97  *                   "Precondition is not satisfied: ...", ...);
  98  */
  99 # define BT_ASSERT_PRE_MSG      BT_LIB_LOGF
 100 #else
 101 # define BT_ASSERT_PRE(_cond, _fmt, ...)
 102 # define BT_ASSERT_PRE_FUNC     BT_UNUSED
 103 # define BT_ASSERT_PRE_MSG(_fmt, ...)
 104 #endif /* BT_DEV_MODE */
 105
 106 /*
 107  * Developer mode: asserts that a given variable is not NULL.
 108  */
 109 #define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name)                         \
 110         BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
 111
 112 /*
 113  * Developer mode: asserts that a given object is NOT frozen. This macro
 114  * checks the `frozen` field of _obj.
 115  */
 116 #define BT_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...)                   \
 117         BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name,  \
 118                 ##__VA_ARGS__)
 119
 120 #endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */