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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Simple unit test library
*
* Copyright (c) 2013 Google, Inc
*/
#ifndef __TEST_UT_H
#define __TEST_UT_H
#include <linux/err.h>
struct unit_test_state;
/**
* ut_fail() - Record failure of a unit test
*
* @uts: Test state
* @fname: Filename where the error occurred
* @line: Line number where the error occurred
* @func: Function name where the error occurred
* @cond: The condition that failed
*/
void ut_fail(struct unit_test_state *uts, const char *fname, int line,
const char *func, const char *cond);
/**
* ut_failf() - Record failure of a unit test
*
* @uts: Test state
* @fname: Filename where the error occurred
* @line: Line number where the error occurred
* @func: Function name where the error occurred
* @cond: The condition that failed
* @fmt: printf() format string for the error, followed by args
*/
void ut_failf(struct unit_test_state *uts, const char *fname, int line,
const char *func, const char *cond, const char *fmt, ...)
__attribute__ ((format (__printf__, 6, 7)));
/**
* ut_check_console_line() - Check the next console line against expectations
*
* This creates a string and then checks it against the next line of console
* output obtained with console_record_readline().
*
* After the function returns, uts->expect_str holds the expected string and
* uts->actual_str holds the actual string read from the console.
*
* @uts: Test state
* @fmt: printf() format string for the error, followed by args
* @return 0 if OK, other value on error
*/
int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...)
__attribute__ ((format (__printf__, 2, 3)));
/**
* ut_check_console_end() - Check there is no more console output
*
* After the function returns, uts->actual_str holds the actual string read
* from the console
*
* @uts: Test state
* @return 0 if OK (console has no output), other value on error
*/
int ut_check_console_end(struct unit_test_state *uts);
/**
* ut_check_console_dump() - Check that next lines have a print_buffer() dump
*
* This only supports a byte dump.
*
* @total_bytes: Size of the expected dump in bytes`
* @return 0 if OK (looks like a dump and the length matches), other value on
* error
*/
int ut_check_console_dump(struct unit_test_state *uts, int total_bytes);
/* Assert that a condition is non-zero */
#define ut_assert(cond) \
if (!(cond)) { \
ut_fail(uts, __FILE__, __LINE__, __func__, #cond); \
return CMD_RET_FAILURE; \
}
/* Assert that a condition is non-zero, with printf() string */
#define ut_assertf(cond, fmt, args...) \
if (!(cond)) { \
ut_failf(uts, __FILE__, __LINE__, __func__, #cond, \
fmt, ##args); \
return CMD_RET_FAILURE; \
}
/* Assert that two int expressions are equal */
#define ut_asserteq(expr1, expr2) { \
unsigned int _val1 = (expr1), _val2 = (expr2); \
\
if (_val1 != _val2) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
#expr1 " == " #expr2, \
"Expected %#x (%d), got %#x (%d)", \
_val1, _val1, _val2, _val2); \
return CMD_RET_FAILURE; \
} \
}
/* Assert that two string expressions are equal */
#define ut_asserteq_str(expr1, expr2) { \
const char *_val1 = (expr1), *_val2 = (expr2); \
\
if (strcmp(_val1, _val2)) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
#expr1 " = " #expr2, \
"Expected \"%s\", got \"%s\"", _val1, _val2); \
return CMD_RET_FAILURE; \
} \
}
/* Assert that two memory areas are equal */
#define ut_asserteq_mem(expr1, expr2, len) { \
const u8 *_val1 = (u8 *)(expr1), *_val2 = (u8 *)(expr2); \
const uint __len = len; \
\
if (memcmp(_val1, _val2, __len)) { \
char __buf1[64 + 1] = "\0"; \
char __buf2[64 + 1] = "\0"; \
bin2hex(__buf1, _val1, min(__len, (uint)32)); \
bin2hex(__buf2, _val2, min(__len, (uint)32)); \
ut_failf(uts, __FILE__, __LINE__, __func__, \
#expr1 " = " #expr2, \
"Expected \"%s\", got \"%s\"", \
__buf1, __buf2); \
return CMD_RET_FAILURE; \
} \
}
/* Assert that two pointers are equal */
#define ut_asserteq_ptr(expr1, expr2) { \
const void *_val1 = (expr1), *_val2 = (expr2); \
\
if (_val1 != _val2) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
#expr1 " = " #expr2, \
"Expected %p, got %p", _val1, _val2); \
return CMD_RET_FAILURE; \
} \
}
/* Assert that a pointer is NULL */
#define ut_assertnull(expr) { \
const void *_val = (expr); \
\
if (_val) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
#expr " != NULL", \
"Expected NULL, got %p", _val); \
return CMD_RET_FAILURE; \
} \
}
/* Assert that a pointer is not NULL */
#define ut_assertnonnull(expr) { \
const void *_val = (expr); \
\
if (!_val) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
#expr " = NULL", \
"Expected non-null, got NULL"); \
return CMD_RET_FAILURE; \
} \
}
/* Assert that a pointer is not an error pointer */
#define ut_assertok_ptr(expr) { \
const void *_val = (expr); \
\
if (IS_ERR(_val)) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
#expr " = NULL", \
"Expected pointer, got error %ld", \
PTR_ERR(_val)); \
return CMD_RET_FAILURE; \
} \
}
/* Assert that an operation succeeds (returns 0) */
#define ut_assertok(cond) ut_asserteq(0, cond)
/* Assert that the next console output line matches */
#define ut_assert_nextline(fmt, args...) \
if (ut_check_console_line(uts, fmt, ##args)) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
"console", "\nExpected '%s',\n got '%s'", \
uts->expect_str, uts->actual_str); \
return CMD_RET_FAILURE; \
} \
/* Assert that there is no more console output */
#define ut_assert_console_end() \
if (ut_check_console_end(uts)) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
"console", "Expected no more output, got '%s'",\
uts->actual_str); \
return CMD_RET_FAILURE; \
} \
/* Assert that the next lines are print_buffer() dump at an address */
#define ut_assert_nextlines_are_dump(total_bytes) \
if (ut_check_console_dump(uts, total_bytes)) { \
ut_failf(uts, __FILE__, __LINE__, __func__, \
"console", \
"Expected dump of length %x bytes, got '%s'", \
total_bytes, uts->actual_str); \
return CMD_RET_FAILURE; \
} \
/**
* ut_check_free() - Return the number of bytes free in the malloc() pool
*
* @return bytes free
*/
ulong ut_check_free(void);
/**
* ut_check_delta() - Return the number of bytes allocated/freed
*
* @last: Last value from ut_check_free
* @return free memory delta from @last; positive means more memory has been
* allocated, negative means less has been allocated (i.e. some is freed)
*/
long ut_check_delta(ulong last);
#endif
|
