assert.h
3.21 KB
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
* Copyright (C) 2015 INRIA
* Copyright (C) 2016 Freie Universität Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @addtogroup core_util
*
* @{
* @file
* @brief POSIX.1-2008 compliant version of the assert macro
*
* @author Oliver Hahm <oliver.hahm@inria.fr>
* @author René Kijewski <rene.kijewski@fu-berlin.de>
* @author Martine Lenders <m.lenders@fu-berlin.de>
*/
#ifndef ASSERT_H
#define ASSERT_H
#include "panic.h"
#ifdef __cplusplus
extern "C" {
#endif
#ifdef DOXYGEN
/**
* @brief Activate verbose output for @ref assert() when defined.
*
* Without this macro defined the @ref assert() macro will just print the
* address of the code line the assertion failed in. With the macro defined
* the macro will also print the file, the code line and the function this macro
* failed in.
*
* To define just add it to your `CFLAGS` in your application's Makefile:
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.mk}
* CFLAGS += -DDEBUG_ASSERT_VERBOSE
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
#define DEBUG_ASSERT_VERBOSE
#endif
#ifndef RIOT_FILE_RELATIVE
#define RIOT_FILE_RELATIVE (__FILE__)
#endif
/**
* @brief the string that is passed to panic in case of a failing assertion
*/
extern const char assert_crash_message[];
#ifdef NDEBUG
#define assert(ignore)((void) 0)
#elif defined(DEBUG_ASSERT_VERBOSE)
/**
* @brief Function to handle failed assertion
*
* @note This function was introduced for memory size optimization
*
* @warning this function **NEVER** returns!
*
* @param[in] file The file name of the file the assertion failed in
* @param[in] line The code line of @p file the assertion failed in
*/
NORETURN void _assert_failure(const char *file, unsigned line);
/**
* @brief abort the program if assertion is false
*
* If the macro NDEBUG was defined at the moment <assert.h> was last included,
* the macro assert() generates no code, and hence does nothing at all.
*
* Otherwise, the macro assert() prints an error message to standard error and
* terminates the application by calling core_panic().
*
* The purpose of this macro is to help programmers find bugs in their
* programs.
*
* With @ref DEBUG_ASSERT_VERBOSE defined this will print also the file, the
* line and the function this assertion failed in.
*
* If `NDEBUG` and @ref DEBUG_ASSERT_VERBOSE are not defined, a failed assertion
* generates output similar to:
*
* 0x89abcdef
* *** RIOT kernel panic:
* FAILED ASSERTION.
*
* ...
*
* Where 0x89abcdef is an address. This address can be used with tools like
* `addr2line` (or e.g. `arm-none-eabi-addr2line` for ARM-based code), `objdump`,
* or `gdb` (with the command `info line *(0x89abcdef)`) to identify the line
* the assertion failed in.
*
* @see http://pubs.opengroup.org/onlinepubs/9699919799/functions/assert.html
*/
#define assert(cond) \
if (!(cond)) { \
_assert_failure(RIOT_FILE_RELATIVE, __LINE__); \
}
#else
#define assert(cond) ((cond) ? (void)0 : core_panic(PANIC_ASSERT_FAIL, assert_crash_message))
#endif
#ifdef __cplusplus
}
#endif
#endif /* ASSERT_H */
/** @} */