1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* ntp_assert.h - design by contract stuff
*
* Copyright Internet Systems Consortium, Inc. ("ISC")
* Copyright Internet Software Consortium.
* Copyright the NTPsec project contributors
* SPDX-License-Identifier: ISC
*
* example:
*
* int foo(char *a) {
* int result;
* int value;
*
* REQUIRE(a != NULL);
* ...
* bar(&value);
* INSIST(value > 2);
* ...
*
* ENSURE(result != 12);
* return result;
* }
*
* open question: when would we use INVARIANT()?
*
*/
#ifndef GUARD_NTP_ASSERT_H
#define GUARD_NTP_ASSERT_H
#include <stdbool.h>
#if defined(__FLEXELINT__)
#include <assert.h>
#define REQUIRE(x) assert(x)
#define INSIST(x) assert(x)
#define INVARIANT(x) assert(x)
#define ENSURE(x) assert(x)
# else /* not FlexeLint */
/*% isc assertion type */
typedef enum {
assertiontype_require,
assertiontype_ensure,
assertiontype_insist,
assertiontype_invariant
} assertiontype_t;
/* our assertion catcher */
extern void assertion_failed(const char *, int, assertiontype_t, const char *)
__attribute__ ((__noreturn__));
#define REQUIRE(cond) \
((void) ((cond) || (assertion_failed(__FILE__, __LINE__, \
assertiontype_require, #cond), 0)))
#define ENSURE(cond) \
((void) ((cond) || (assertion_failed(__FILE__, __LINE__, \
assertiontype_ensure, #cond), 0)))
#define INSIST(cond) \
((void) ((cond) || (assertion_failed(__FILE__, __LINE__, \
assertiontype_insist, #cond), 0)))
#define INVARIANT(cond) \
((void) ((cond) || (assertion_failed(__FILE__, __LINE__, \
assertiontype_invariant, #cond), 0)))
# endif /* not FlexeLint */
#if defined(USEBACKTRACE) && \
(defined(HAVE_BACKTRACE_SYMBOLS_FD) || defined (HAVE__UNWIND_BACKTRACE))
/* doing backtrace */
extern void backtrace_log(void);
#else
/* not doing backtrace */
# define BACKTRACE_DISABLED 1
#endif /* ! USEBACKTRACE */
#endif /* GUARD_NTP_ASSERT_H */
|
