lib: add internal BT_LIB_LOG*_APPEND_CAUSE() macros
[babeltrace.git] / src / lib / assert-pre.h
CommitLineData
464ebc31
PP
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/*
c2d9d9cf 28 * The macros in this header use macros defined in "lib/logging.h".
f2371a94 29 * We don't want this header to automatically include
c2d9d9cf
PP
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
464ebc31
PP
32 * also need to define it before including this header.
33 *
f2371a94
PP
34 * This is a reminder that in order to use "lib/assert-pre.h", you also
35 * need to use logging explicitly.
464ebc31 36 */
c5b9b441 37
7151fb67 38#ifndef BT_LIB_LOG_SUPPORTED
c2d9d9cf 39# error Include "lib/logging.h" before this header.
464ebc31
PP
40#endif
41
42#include <stdlib.h>
ff205f0b 43#include <inttypes.h>
91d81473 44#include "common/macros.h"
464ebc31
PP
45
46#ifdef BT_DEV_MODE
464ebc31
PP
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 * BT_ASSERT_PRE_FUNC
57 * static inline bool check_complex_precond(...)
58 * {
59 * ...
60 *
61 * if (...) {
62 * BT_ASSERT_PRE_MSG("Invalid object: ...", ...);
63 * return false;
64 * }
65 *
66 * ...
67 * }
68 *
69 * ...
70 *
71 * BT_ASSERT_PRE(check_complex_precond(...),
72 * "Precondition is not satisfied: ...", ...);
73 */
34ae0d62
PP
74# define BT_ASSERT_PRE_MSG(_fmt, ...) \
75 do { \
76 bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \
77 __LINE__, BT_LOG_FATAL, BT_LOG_TAG, \
78 (_fmt), ##__VA_ARGS__); \
79 } while (0)
80
81/*
1f9f5b4d
PP
82 * Developer mode: asserts that the library precondition `_cond` is
83 * satisfied.
34ae0d62
PP
84 *
85 * If `_cond` is false, log a fatal statement using `_fmt` and the
86 * optional arguments (same usage as BT_LIB_LOGF()), and abort.
87 *
1f9f5b4d
PP
88 * To assert that a library postcondition is satisfied (return from user
89 * code), use BT_ASSERT_POST().
90 *
91 * To assert that an internal postcondition is satisfied, use
92 * BT_ASSERT().
34ae0d62
PP
93 */
94# define BT_ASSERT_PRE(_cond, _fmt, ...) \
95 do { \
96 if (!(_cond)) { \
97 BT_ASSERT_PRE_MSG("Babeltrace 2 library precondition not satisfied; error is:"); \
98 BT_ASSERT_PRE_MSG((_fmt), ##__VA_ARGS__); \
99 BT_ASSERT_PRE_MSG("Aborting..."); \
100 abort(); \
101 } \
102 } while (0)
103
104/*
105 * Marks a function as being only used within a BT_ASSERT_PRE() context.
106 */
107# define BT_ASSERT_PRE_FUNC
464ebc31 108#else
ebbc3f14 109# define BT_ASSERT_PRE(_cond, _fmt, ...) ((void) sizeof((void) (_cond), 0))
91d81473 110# define BT_ASSERT_PRE_FUNC __attribute__((unused))
464ebc31
PP
111# define BT_ASSERT_PRE_MSG(_fmt, ...)
112#endif /* BT_DEV_MODE */
113
114/*
1f9f5b4d
PP
115 * Developer mode: asserts that a given variable `_obj` named
116 * `_obj_name` (capitalized) is not `NULL`.
464ebc31
PP
117 */
118#define BT_ASSERT_PRE_NON_NULL(_obj, _obj_name) \
119 BT_ASSERT_PRE((_obj) != NULL, "%s is NULL: ", _obj_name)
120
121/*
1f9f5b4d
PP
122 * Developer mode: asserts that a given object `_obj` named `_obj_name`
123 * (capitalized) is NOT frozen. This macro checks the `frozen` field of
124 * `_obj`.
464ebc31
PP
125 */
126#define BT_ASSERT_PRE_HOT(_obj, _obj_name, _fmt, ...) \
127 BT_ASSERT_PRE(!(_obj)->frozen, "%s is frozen" _fmt, _obj_name, \
128 ##__VA_ARGS__)
129
c800eb37 130/*
1f9f5b4d
PP
131 * Developer mode: asserts that a given index `_index` is less than a
132 * given length `_length`.
c800eb37
PP
133 */
134#define BT_ASSERT_PRE_VALID_INDEX(_index, _length) \
135 BT_ASSERT_PRE((_index) < (_length), \
136 "Index is out of bounds: index=%" PRIu64 ", " \
137 "count=%" PRIu64, (uint64_t) (_index), (uint64_t) (_length))
138
ce53ba7a
PP
139#define BT_ASSERT_PRE_SUPPORTED
140
464ebc31 141#endif /* BABELTRACE_ASSERT_PRE_INTERNAL_H */
This page took 0.047694 seconds and 4 git commands to generate.