src/common/assert.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (c) 2018-2019 EfficiOS Inc. and Linux Foundation
   5  * Copyright (c) 2018-2019 Philippe Proulx <pproulx@efficios.com>
   6  */
   7
   8 #ifndef BABELTRACE_ASSERT_INTERNAL_H
   9 #define BABELTRACE_ASSERT_INTERNAL_H
  10
  11 #include <assert.h>
  12 #include <glib.h>
  13
  14 #include "common/macros.h"
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 BT_HIDDEN
  21 extern void bt_common_assert_failed(const char *file, int line,
  22                 const char *func, const char *assertion)
  23                 __attribute__((noreturn));
  24
  25 /*
  26  * Internal assertion (to detect logic errors on which the library user
  27  * has no influence). Use BT_ASSERT_PRE*() or BT_ASSERT_POST*() to check
  28  * preconditions or postconditions which must be directly or indirectly
  29  * satisfied by the library user.
  30  *
  31  * BT_ASSERT() is enabled in both debug and non-debug modes.
  32  */
  33 #define BT_ASSERT(_cond)                                                       \
  34         do {                                                                   \
  35                 if (!(_cond)) {                                                \
  36                         bt_common_assert_failed(__FILE__, __LINE__, __func__,  \
  37                                 G_STRINGIFY(_cond));                           \
  38                 }                                                              \
  39         } while (0)
  40
  41 /*
  42  * Marks a function as being only used within a BT_ASSERT() context.
  43  */
  44 #define BT_ASSERT_FUNC
  45
  46 #ifdef BT_DEBUG_MODE
  47
  48 /*
  49  * Debug mode internal assertion.
  50  */
  51 #define BT_ASSERT_DBG(_cond)    BT_ASSERT(_cond)
  52
  53 /*
  54  * Marks a function as being only used within a BT_ASSERT_DBG() context.
  55  */
  56 #define BT_ASSERT_DBG_FUNC
  57
  58 #else /* BT_DEBUG_MODE */
  59 # define BT_ASSERT_DBG(_cond)   BT_USE_EXPR(_cond)
  60 # define BT_ASSERT_DBG_FUNC     __attribute__((unused))
  61 #endif /* BT_DEBUG_MODE */
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif
  66
  67 #endif /* BABELTRACE_ASSERT_INTERNAL_H */