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
|
/* Functionality for reporting test results.
Copyright (C) 2016-2021 Free Software Foundation, Inc.
This file is part of the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
<https://www.gnu.org/licenses/>. */
#ifndef SUPPORT_CHECK_H
#define SUPPORT_CHECK_H
#include <sys/cdefs.h>
#include <stddef.h>
__BEGIN_DECLS
/* Record a test failure, print the failure message to standard output
and return 1. */
#define FAIL_RET(...) \
return support_print_failure_impl (__FILE__, __LINE__, __VA_ARGS__)
/* Print the failure message and terminate the process with STATUS.
Record a the process as failed if STATUS is neither EXIT_SUCCESS
nor EXIT_UNSUPPORTED. */
#define FAIL_EXIT(status, ...) \
support_exit_failure_impl (status, __FILE__, __LINE__, __VA_ARGS__)
/* Record a test failure, print the failure message and terminate with
exit status 1. */
#define FAIL_EXIT1(...) \
support_exit_failure_impl (1, __FILE__, __LINE__, __VA_ARGS__)
/* Print failure message and terminate with as unsupported test (exit
status of 77). */
#define FAIL_UNSUPPORTED(...) \
support_exit_failure_impl (77, __FILE__, __LINE__, __VA_ARGS__)
/* Record a test failure (but continue executing) if EXPR evaluates to
false. */
#define TEST_VERIFY(expr) \
({ \
if (expr) \
; \
else \
support_test_verify_impl (__FILE__, __LINE__, #expr); \
})
/* Record a test failure and exit if EXPR evaluates to false. */
#define TEST_VERIFY_EXIT(expr) \
({ \
if (expr) \
; \
else \
support_test_verify_exit_impl \
(1, __FILE__, __LINE__, #expr); \
})
int support_print_failure_impl (const char *file, int line,
const char *format, ...)
__attribute__ ((nonnull (1), format (printf, 3, 4)));
void support_exit_failure_impl (int exit_status,
const char *file, int line,
const char *format, ...)
__attribute__ ((noreturn, nonnull (2), format (printf, 4, 5)));
void support_test_verify_impl (const char *file, int line,
const char *expr);
void support_test_verify_exit_impl (int status, const char *file, int line,
const char *expr)
__attribute__ ((noreturn));
/* Record a test failure. This function returns and does not
terminate the process. The failure counter is stored in a shared
memory mapping, so that failures reported in child processes are
visible to the parent process and test driver. This function
depends on initialization by an ELF constructor, so it can only be
invoked after the test driver has run. Note that this function
does not support reporting failures from a DSO. */
void support_record_failure (void);
/* Static assertion, under a common name for both C++ and C11. */
#ifdef __cplusplus
# define support_static_assert static_assert
#else
# define support_static_assert _Static_assert
#endif
/* Compare the two integers LEFT and RIGHT and report failure if they
are different. */
#define TEST_COMPARE(left, right) \
({ \
/* + applies the integer promotions, for bitfield support. */ \
typedef __typeof__ (+ (left)) __left_type; \
typedef __typeof__ (+ (right)) __right_type; \
__left_type __left_value = (left); \
__right_type __right_value = (right); \
int __left_is_positive = __left_value > 0; \
int __right_is_positive = __right_value > 0; \
/* Prevent use with floating-point types. */ \
support_static_assert ((__left_type) 1.0 == (__left_type) 1.5, \
"left value has floating-point type"); \
support_static_assert ((__right_type) 1.0 == (__right_type) 1.5, \
"right value has floating-point type"); \
/* Prevent accidental use with larger-than-long long types. */ \
support_static_assert (sizeof (__left_value) <= sizeof (long long), \
"left value fits into long long"); \
support_static_assert (sizeof (__right_value) <= sizeof (long long), \
"right value fits into long long"); \
/* Compare the value. */ \
if (__left_value != __right_value \
|| __left_is_positive != __right_is_positive) \
/* Pass the sign for printing the correct value. */ \
support_test_compare_failure \
(__FILE__, __LINE__, \
#left, __left_value, __left_is_positive, sizeof (__left_type), \
#right, __right_value, __right_is_positive, sizeof (__right_type)); \
})
/* Internal implementation of TEST_COMPARE. LEFT_POSITIVE and
RIGHT_POSITIVE are used to store the sign separately, so that both
unsigned long long and long long arguments fit into LEFT_VALUE and
RIGHT_VALUE, and the function can still print the original value.
LEFT_SIZE and RIGHT_SIZE specify the size of the argument in bytes,
for hexadecimal formatting. */
void support_test_compare_failure (const char *file, int line,
const char *left_expr,
long long left_value,
int left_positive,
int left_size,
const char *right_expr,
long long right_value,
int right_positive,
int right_size);
/* Compare [LEFT, LEFT + LEFT_LENGTH) with [RIGHT, RIGHT +
RIGHT_LENGTH) and report a test failure if the arrays are
different. LEFT_LENGTH and RIGHT_LENGTH are measured in bytes. If
the length is null, the corresponding pointer is ignored (i.e., it
can be NULL). The blobs should be reasonably short because on
mismatch, both are printed. */
#define TEST_COMPARE_BLOB(left, left_length, right, right_length) \
(support_test_compare_blob (left, left_length, right, right_length, \
__FILE__, __LINE__, \
#left, #left_length, #right, #right_length))
void support_test_compare_blob (const void *left,
unsigned long int left_length,
const void *right,
unsigned long int right_length,
const char *file, int line,
const char *left_exp, const char *left_len_exp,
const char *right_exp,
const char *right_len_exp);
/* Compare the strings LEFT and RIGHT and report a test failure if
they are different. Also report failure if one of the arguments is
a null pointer and the other is not. The strings should be
reasonably short because on mismatch, both are printed. */
#define TEST_COMPARE_STRING(left, right) \
(support_test_compare_string (left, right, __FILE__, __LINE__, \
#left, #right))
/* Compare the wide strings LEFT and RIGHT and report a test failure
if they are different. Also report failure if one of the arguments
is a null pointer and the other is not. The strings should be
reasonably short because on mismatch, both are printed. */
#define TEST_COMPARE_STRING_WIDE(left, right) \
(support_test_compare_string_wide (left, right, __FILE__, __LINE__, \
#left, #right))
void support_test_compare_string (const char *left, const char *right,
const char *file, int line,
const char *left_expr,
const char *right_expr);
void support_test_compare_string_wide (const wchar_t *left,
const wchar_t *right,
const char *file, int line,
const char *left_expr,
const char *right_expr);
/* Internal function called by the test driver. */
int support_report_failure (int status)
__attribute__ ((weak, warn_unused_result));
/* Internal function used to test the failure recording framework. */
void support_record_failure_reset (void);
/* Returns true or false depending on whether there have been test
failures or not. */
int support_record_failure_is_failed (void);
__END_DECLS
#endif /* SUPPORT_CHECK_H */
|
