annotate gcc/selftest.h @ 158:494b0b89df80 default tip

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 18:13:55 +0900
parents 1830386684a0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 /* A self-testing framework, for use by -fself-test.
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
2 Copyright (C) 2015-2020 Free Software Foundation, Inc.
111
kono
parents:
diff changeset
3
kono
parents:
diff changeset
4 This file is part of GCC.
kono
parents:
diff changeset
5
kono
parents:
diff changeset
6 GCC is free software; you can redistribute it and/or modify it under
kono
parents:
diff changeset
7 the terms of the GNU General Public License as published by the Free
kono
parents:
diff changeset
8 Software Foundation; either version 3, or (at your option) any later
kono
parents:
diff changeset
9 version.
kono
parents:
diff changeset
10
kono
parents:
diff changeset
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
kono
parents:
diff changeset
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
kono
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
kono
parents:
diff changeset
14 for more details.
kono
parents:
diff changeset
15
kono
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
kono
parents:
diff changeset
17 along with GCC; see the file COPYING3. If not see
kono
parents:
diff changeset
18 <http://www.gnu.org/licenses/>. */
kono
parents:
diff changeset
19
kono
parents:
diff changeset
20 #ifndef GCC_SELFTEST_H
kono
parents:
diff changeset
21 #define GCC_SELFTEST_H
kono
parents:
diff changeset
22
kono
parents:
diff changeset
23 /* The selftest code should entirely disappear in a production
kono
parents:
diff changeset
24 configuration, hence we guard all of it with #if CHECKING_P. */
kono
parents:
diff changeset
25
kono
parents:
diff changeset
26 #if CHECKING_P
kono
parents:
diff changeset
27
kono
parents:
diff changeset
28 namespace selftest {
kono
parents:
diff changeset
29
kono
parents:
diff changeset
30 /* A struct describing the source-location of a selftest, to make it
kono
parents:
diff changeset
31 easier to track down failing tests. */
kono
parents:
diff changeset
32
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
33 class location
111
kono
parents:
diff changeset
34 {
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
35 public:
111
kono
parents:
diff changeset
36 location (const char *file, int line, const char *function)
kono
parents:
diff changeset
37 : m_file (file), m_line (line), m_function (function) {}
kono
parents:
diff changeset
38
kono
parents:
diff changeset
39 const char *m_file;
kono
parents:
diff changeset
40 int m_line;
kono
parents:
diff changeset
41 const char *m_function;
kono
parents:
diff changeset
42 };
kono
parents:
diff changeset
43
kono
parents:
diff changeset
44 /* A macro for use in selftests and by the ASSERT_ macros below,
kono
parents:
diff changeset
45 constructing a selftest::location for the current source location. */
kono
parents:
diff changeset
46
kono
parents:
diff changeset
47 #define SELFTEST_LOCATION \
kono
parents:
diff changeset
48 (::selftest::location (__FILE__, __LINE__, __FUNCTION__))
kono
parents:
diff changeset
49
kono
parents:
diff changeset
50 /* The entrypoint for running all tests. */
kono
parents:
diff changeset
51
kono
parents:
diff changeset
52 extern void run_tests ();
kono
parents:
diff changeset
53
kono
parents:
diff changeset
54 /* Record the successful outcome of some aspect of the test. */
kono
parents:
diff changeset
55
kono
parents:
diff changeset
56 extern void pass (const location &loc, const char *msg);
kono
parents:
diff changeset
57
kono
parents:
diff changeset
58 /* Report the failed outcome of some aspect of the test and abort. */
kono
parents:
diff changeset
59
kono
parents:
diff changeset
60 extern void fail (const location &loc, const char *msg)
kono
parents:
diff changeset
61 ATTRIBUTE_NORETURN;
kono
parents:
diff changeset
62
kono
parents:
diff changeset
63 /* As "fail", but using printf-style formatted output. */
kono
parents:
diff changeset
64
kono
parents:
diff changeset
65 extern void fail_formatted (const location &loc, const char *fmt, ...)
kono
parents:
diff changeset
66 ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN;
kono
parents:
diff changeset
67
kono
parents:
diff changeset
68 /* Implementation detail of ASSERT_STREQ. */
kono
parents:
diff changeset
69
kono
parents:
diff changeset
70 extern void assert_streq (const location &loc,
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
71 const char *desc_val1, const char *desc_val2,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
72 const char *val1, const char *val2);
111
kono
parents:
diff changeset
73
kono
parents:
diff changeset
74 /* Implementation detail of ASSERT_STR_CONTAINS. */
kono
parents:
diff changeset
75
kono
parents:
diff changeset
76 extern void assert_str_contains (const location &loc,
kono
parents:
diff changeset
77 const char *desc_haystack,
kono
parents:
diff changeset
78 const char *desc_needle,
kono
parents:
diff changeset
79 const char *val_haystack,
kono
parents:
diff changeset
80 const char *val_needle);
kono
parents:
diff changeset
81
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
82 /* Implementation detail of ASSERT_STR_STARTSWITH. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
83
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
84 extern void assert_str_startswith (const location &loc,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
85 const char *desc_str,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
86 const char *desc_prefix,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
87 const char *val_str,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
88 const char *val_prefix);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
89
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
90
111
kono
parents:
diff changeset
91 /* A named temporary file for use in selftests.
kono
parents:
diff changeset
92 Usable for writing out files, and as the base class for
kono
parents:
diff changeset
93 temp_source_file.
kono
parents:
diff changeset
94 The file is unlinked in the destructor. */
kono
parents:
diff changeset
95
kono
parents:
diff changeset
96 class named_temp_file
kono
parents:
diff changeset
97 {
kono
parents:
diff changeset
98 public:
kono
parents:
diff changeset
99 named_temp_file (const char *suffix);
kono
parents:
diff changeset
100 ~named_temp_file ();
kono
parents:
diff changeset
101 const char *get_filename () const { return m_filename; }
kono
parents:
diff changeset
102
kono
parents:
diff changeset
103 private:
kono
parents:
diff changeset
104 char *m_filename;
kono
parents:
diff changeset
105 };
kono
parents:
diff changeset
106
kono
parents:
diff changeset
107 /* A class for writing out a temporary sourcefile for use in selftests
kono
parents:
diff changeset
108 of input handling. */
kono
parents:
diff changeset
109
kono
parents:
diff changeset
110 class temp_source_file : public named_temp_file
kono
parents:
diff changeset
111 {
kono
parents:
diff changeset
112 public:
kono
parents:
diff changeset
113 temp_source_file (const location &loc, const char *suffix,
kono
parents:
diff changeset
114 const char *content);
kono
parents:
diff changeset
115 };
kono
parents:
diff changeset
116
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
117 /* RAII-style class for avoiding introducing locale-specific differences
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
118 in strings containing localized quote marks, by temporarily overriding
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
119 the "open_quote" and "close_quote" globals to something hardcoded.
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
120
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
121 Specifically, the C locale's values are used:
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
122 - open_quote becomes "`"
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
123 - close_quote becomes "'"
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
124 for the lifetime of the object. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
125
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
126 class auto_fix_quotes
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
127 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
128 public:
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
129 auto_fix_quotes ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
130 ~auto_fix_quotes ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
132 private:
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
133 const char *m_saved_open_quote;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
134 const char *m_saved_close_quote;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
135 };
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
136
111
kono
parents:
diff changeset
137 /* Various selftests involving location-handling require constructing a
kono
parents:
diff changeset
138 line table and one or more line maps within it.
kono
parents:
diff changeset
139
kono
parents:
diff changeset
140 For maximum test coverage we want to run these tests with a variety
kono
parents:
diff changeset
141 of situations:
kono
parents:
diff changeset
142 - line_table->default_range_bits: some frontends use a non-zero value
kono
parents:
diff changeset
143 and others use zero
kono
parents:
diff changeset
144 - the fallback modes within line-map.c: there are various threshold
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
145 values for location_t beyond line-map.c changes
111
kono
parents:
diff changeset
146 behavior (disabling of the range-packing optimization, disabling
kono
parents:
diff changeset
147 of column-tracking). We can exercise these by starting the line_table
kono
parents:
diff changeset
148 at interesting values at or near these thresholds.
kono
parents:
diff changeset
149
kono
parents:
diff changeset
150 The following struct describes a particular case within our test
kono
parents:
diff changeset
151 matrix. */
kono
parents:
diff changeset
152
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
153 class line_table_case;
111
kono
parents:
diff changeset
154
kono
parents:
diff changeset
155 /* A class for overriding the global "line_table" within a selftest,
kono
parents:
diff changeset
156 restoring its value afterwards. At most one instance of this
kono
parents:
diff changeset
157 class can exist at once, due to the need to keep the old value
kono
parents:
diff changeset
158 of line_table as a GC root. */
kono
parents:
diff changeset
159
kono
parents:
diff changeset
160 class line_table_test
kono
parents:
diff changeset
161 {
kono
parents:
diff changeset
162 public:
kono
parents:
diff changeset
163 /* Default constructor. Override "line_table", using sane defaults
kono
parents:
diff changeset
164 for the temporary line_table. */
kono
parents:
diff changeset
165 line_table_test ();
kono
parents:
diff changeset
166
kono
parents:
diff changeset
167 /* Constructor. Override "line_table", using the case described by C. */
kono
parents:
diff changeset
168 line_table_test (const line_table_case &c);
kono
parents:
diff changeset
169
kono
parents:
diff changeset
170 /* Destructor. Restore the saved line_table. */
kono
parents:
diff changeset
171 ~line_table_test ();
kono
parents:
diff changeset
172 };
kono
parents:
diff changeset
173
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
174 /* Helper function for selftests that need a function decl. */
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
175
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
176 extern tree make_fndecl (tree return_type,
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
177 const char *name,
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
178 vec <tree> &param_types,
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
179 bool is_variadic = false);
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
180
111
kono
parents:
diff changeset
181 /* Run TESTCASE multiple times, once for each case in our test matrix. */
kono
parents:
diff changeset
182
kono
parents:
diff changeset
183 extern void
kono
parents:
diff changeset
184 for_each_line_table_case (void (*testcase) (const line_table_case &));
kono
parents:
diff changeset
185
kono
parents:
diff changeset
186 /* Read the contents of PATH into memory, returning a 0-terminated buffer
kono
parents:
diff changeset
187 that must be freed by the caller.
kono
parents:
diff changeset
188 Fail (and abort) if there are any problems, with LOC as the reported
kono
parents:
diff changeset
189 location of the failure. */
kono
parents:
diff changeset
190
kono
parents:
diff changeset
191 extern char *read_file (const location &loc, const char *path);
kono
parents:
diff changeset
192
kono
parents:
diff changeset
193 /* A helper function for writing tests that interact with the
kono
parents:
diff changeset
194 garbage collector. */
kono
parents:
diff changeset
195
kono
parents:
diff changeset
196 extern void forcibly_ggc_collect ();
kono
parents:
diff changeset
197
kono
parents:
diff changeset
198 /* Convert a path relative to SRCDIR/gcc/testsuite/selftests
kono
parents:
diff changeset
199 to a real path (either absolute, or relative to pwd).
kono
parents:
diff changeset
200 The result should be freed by the caller. */
kono
parents:
diff changeset
201
kono
parents:
diff changeset
202 extern char *locate_file (const char *path);
kono
parents:
diff changeset
203
kono
parents:
diff changeset
204 /* The path of SRCDIR/testsuite/selftests. */
kono
parents:
diff changeset
205
kono
parents:
diff changeset
206 extern const char *path_to_selftest_files;
kono
parents:
diff changeset
207
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
208 /* selftest::test_runner is an implementation detail of selftest::run_tests,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
209 exposed here to allow plugins to run their own suites of tests. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
210
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
211 class test_runner
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
212 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
213 public:
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
214 test_runner (const char *name);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
215 ~test_runner ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
216
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
217 private:
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
218 const char *m_name;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
219 long m_start_time;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
220 };
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
221
111
kono
parents:
diff changeset
222 /* Declarations for specific families of tests (by source file), in
kono
parents:
diff changeset
223 alphabetical order. */
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
224 extern void attribute_c_tests ();
111
kono
parents:
diff changeset
225 extern void bitmap_c_tests ();
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
226 extern void cgraph_c_tests ();
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
227 extern void convert_c_tests ();
111
kono
parents:
diff changeset
228 extern void diagnostic_c_tests ();
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
229 extern void diagnostic_format_json_cc_tests ();
111
kono
parents:
diff changeset
230 extern void diagnostic_show_locus_c_tests ();
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
231 extern void digraph_cc_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
232 extern void dumpfile_c_tests ();
111
kono
parents:
diff changeset
233 extern void edit_context_c_tests ();
kono
parents:
diff changeset
234 extern void et_forest_c_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
235 extern void fibonacci_heap_c_tests ();
111
kono
parents:
diff changeset
236 extern void fold_const_c_tests ();
kono
parents:
diff changeset
237 extern void function_tests_c_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
238 extern void ggc_tests_c_tests ();
111
kono
parents:
diff changeset
239 extern void gimple_c_tests ();
kono
parents:
diff changeset
240 extern void hash_map_tests_c_tests ();
kono
parents:
diff changeset
241 extern void hash_set_tests_c_tests ();
kono
parents:
diff changeset
242 extern void input_c_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
243 extern void json_cc_tests ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
244 extern void opt_problem_cc_tests ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
245 extern void optinfo_emit_json_cc_tests ();
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
246 extern void ordered_hash_map_tests_cc_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
247 extern void predict_c_tests ();
111
kono
parents:
diff changeset
248 extern void pretty_print_c_tests ();
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
249 extern void range_tests ();
111
kono
parents:
diff changeset
250 extern void read_rtl_function_c_tests ();
kono
parents:
diff changeset
251 extern void rtl_tests_c_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
252 extern void sbitmap_c_tests ();
111
kono
parents:
diff changeset
253 extern void selftest_c_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
254 extern void simplify_rtx_c_tests ();
111
kono
parents:
diff changeset
255 extern void spellcheck_c_tests ();
kono
parents:
diff changeset
256 extern void spellcheck_tree_c_tests ();
kono
parents:
diff changeset
257 extern void sreal_c_tests ();
kono
parents:
diff changeset
258 extern void store_merging_c_tests ();
kono
parents:
diff changeset
259 extern void tree_c_tests ();
kono
parents:
diff changeset
260 extern void tree_cfg_c_tests ();
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
261 extern void tree_diagnostic_path_cc_tests ();
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
262 extern void tristate_cc_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
263 extern void typed_splay_tree_c_tests ();
111
kono
parents:
diff changeset
264 extern void unique_ptr_tests_cc_tests ();
kono
parents:
diff changeset
265 extern void vec_c_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
266 extern void vec_perm_indices_c_tests ();
111
kono
parents:
diff changeset
267 extern void wide_int_cc_tests ();
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
268 extern void opt_proposer_c_tests ();
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
269 extern void dbgcnt_c_tests ();
111
kono
parents:
diff changeset
270
kono
parents:
diff changeset
271 extern int num_passes;
kono
parents:
diff changeset
272
kono
parents:
diff changeset
273 } /* end of namespace selftest. */
kono
parents:
diff changeset
274
kono
parents:
diff changeset
275 /* Macros for writing tests. */
kono
parents:
diff changeset
276
kono
parents:
diff changeset
277 /* Evaluate EXPR and coerce to bool, calling
kono
parents:
diff changeset
278 ::selftest::pass if it is true,
kono
parents:
diff changeset
279 ::selftest::fail if it false. */
kono
parents:
diff changeset
280
kono
parents:
diff changeset
281 #define ASSERT_TRUE(EXPR) \
kono
parents:
diff changeset
282 ASSERT_TRUE_AT (SELFTEST_LOCATION, (EXPR))
kono
parents:
diff changeset
283
kono
parents:
diff changeset
284 /* Like ASSERT_TRUE, but treat LOC as the effective location of the
kono
parents:
diff changeset
285 selftest. */
kono
parents:
diff changeset
286
kono
parents:
diff changeset
287 #define ASSERT_TRUE_AT(LOC, EXPR) \
kono
parents:
diff changeset
288 SELFTEST_BEGIN_STMT \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
289 const char *desc_ = "ASSERT_TRUE (" #EXPR ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
290 bool actual_ = (EXPR); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
291 if (actual_) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
292 ::selftest::pass ((LOC), desc_); \
111
kono
parents:
diff changeset
293 else \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
294 ::selftest::fail ((LOC), desc_); \
111
kono
parents:
diff changeset
295 SELFTEST_END_STMT
kono
parents:
diff changeset
296
kono
parents:
diff changeset
297 /* Evaluate EXPR and coerce to bool, calling
kono
parents:
diff changeset
298 ::selftest::pass if it is false,
kono
parents:
diff changeset
299 ::selftest::fail if it true. */
kono
parents:
diff changeset
300
kono
parents:
diff changeset
301 #define ASSERT_FALSE(EXPR) \
kono
parents:
diff changeset
302 ASSERT_FALSE_AT (SELFTEST_LOCATION, (EXPR))
kono
parents:
diff changeset
303
kono
parents:
diff changeset
304 /* Like ASSERT_FALSE, but treat LOC as the effective location of the
kono
parents:
diff changeset
305 selftest. */
kono
parents:
diff changeset
306
kono
parents:
diff changeset
307 #define ASSERT_FALSE_AT(LOC, EXPR) \
kono
parents:
diff changeset
308 SELFTEST_BEGIN_STMT \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
309 const char *desc_ = "ASSERT_FALSE (" #EXPR ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
310 bool actual_ = (EXPR); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
311 if (actual_) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
312 ::selftest::fail ((LOC), desc_); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
313 else \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
314 ::selftest::pass ((LOC), desc_); \
111
kono
parents:
diff changeset
315 SELFTEST_END_STMT
kono
parents:
diff changeset
316
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
317 /* Evaluate VAL1 and VAL2 and compare them with ==, calling
111
kono
parents:
diff changeset
318 ::selftest::pass if they are equal,
kono
parents:
diff changeset
319 ::selftest::fail if they are non-equal. */
kono
parents:
diff changeset
320
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
321 #define ASSERT_EQ(VAL1, VAL2) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
322 ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
111
kono
parents:
diff changeset
323
kono
parents:
diff changeset
324 /* Like ASSERT_EQ, but treat LOC as the effective location of the
kono
parents:
diff changeset
325 selftest. */
kono
parents:
diff changeset
326
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
327 #define ASSERT_EQ_AT(LOC, VAL1, VAL2) \
111
kono
parents:
diff changeset
328 SELFTEST_BEGIN_STMT \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
329 const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
330 if ((VAL1) == (VAL2)) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
331 ::selftest::pass ((LOC), desc_); \
111
kono
parents:
diff changeset
332 else \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
333 ::selftest::fail ((LOC), desc_); \
111
kono
parents:
diff changeset
334 SELFTEST_END_STMT
kono
parents:
diff changeset
335
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
336 /* Evaluate VAL1 and VAL2 and compare them with known_eq, calling
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
337 ::selftest::pass if they are always equal,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
338 ::selftest::fail if they might be non-equal. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
339
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
340 #define ASSERT_KNOWN_EQ(VAL1, VAL2) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
341 ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
342
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
343 /* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
344 selftest. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
345
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
346 #define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
347 SELFTEST_BEGIN_STMT \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
348 const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
349 if (known_eq (VAL1, VAL2)) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
350 ::selftest::pass ((LOC), desc); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
351 else \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
352 ::selftest::fail ((LOC), desc); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
353 SELFTEST_END_STMT
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
354
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
355 /* Evaluate VAL1 and VAL2 and compare them with !=, calling
111
kono
parents:
diff changeset
356 ::selftest::pass if they are non-equal,
kono
parents:
diff changeset
357 ::selftest::fail if they are equal. */
kono
parents:
diff changeset
358
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
359 #define ASSERT_NE(VAL1, VAL2) \
111
kono
parents:
diff changeset
360 SELFTEST_BEGIN_STMT \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
361 const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
362 if ((VAL1) != (VAL2)) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
363 ::selftest::pass (SELFTEST_LOCATION, desc_); \
111
kono
parents:
diff changeset
364 else \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
365 ::selftest::fail (SELFTEST_LOCATION, desc_); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
366 SELFTEST_END_STMT
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
367
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
368 /* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
369 ::selftest::pass if they might be non-equal,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
370 ::selftest::fail if they are known to be equal. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
371
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
372 #define ASSERT_MAYBE_NE(VAL1, VAL2) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
373 ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
374
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
375 /* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
376 selftest. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
377
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
378 #define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
379 SELFTEST_BEGIN_STMT \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
380 const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
381 if (maybe_ne (VAL1, VAL2)) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
382 ::selftest::pass ((LOC), desc); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
383 else \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
384 ::selftest::fail ((LOC), desc); \
111
kono
parents:
diff changeset
385 SELFTEST_END_STMT
kono
parents:
diff changeset
386
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
387 /* Evaluate LHS and RHS and compare them with >, calling
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
388 ::selftest::pass if LHS > RHS,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
389 ::selftest::fail otherwise. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
390
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
391 #define ASSERT_GT(LHS, RHS) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
392 ASSERT_GT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
393
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
394 /* Like ASSERT_GT, but treat LOC as the effective location of the
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
395 selftest. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
396
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
397 #define ASSERT_GT_AT(LOC, LHS, RHS) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
398 SELFTEST_BEGIN_STMT \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
399 const char *desc_ = "ASSERT_GT (" #LHS ", " #RHS ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
400 if ((LHS) > (RHS)) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
401 ::selftest::pass ((LOC), desc_); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
402 else \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
403 ::selftest::fail ((LOC), desc_); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
404 SELFTEST_END_STMT
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
405
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
406 /* Evaluate LHS and RHS and compare them with <, calling
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
407 ::selftest::pass if LHS < RHS,
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
408 ::selftest::fail otherwise. */
111
kono
parents:
diff changeset
409
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
410 #define ASSERT_LT(LHS, RHS) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
411 ASSERT_LT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
412
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
413 /* Like ASSERT_LT, but treat LOC as the effective location of the
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
414 selftest. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
415
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
416 #define ASSERT_LT_AT(LOC, LHS, RHS) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
417 SELFTEST_BEGIN_STMT \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
418 const char *desc_ = "ASSERT_LT (" #LHS ", " #RHS ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
419 if ((LHS) < (RHS)) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
420 ::selftest::pass ((LOC), desc_); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
421 else \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
422 ::selftest::fail ((LOC), desc_); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
423 SELFTEST_END_STMT
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
424
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
425 /* Evaluate VAL1 and VAL2 and compare them with strcmp, calling
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
426 ::selftest::pass if they are equal (and both are non-NULL),
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
427 ::selftest::fail if they are non-equal, or are both NULL. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
428
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
429 #define ASSERT_STREQ(VAL1, VAL2) \
111
kono
parents:
diff changeset
430 SELFTEST_BEGIN_STMT \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
431 ::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
432 (VAL1), (VAL2)); \
111
kono
parents:
diff changeset
433 SELFTEST_END_STMT
kono
parents:
diff changeset
434
kono
parents:
diff changeset
435 /* Like ASSERT_STREQ, but treat LOC as the effective location of the
kono
parents:
diff changeset
436 selftest. */
kono
parents:
diff changeset
437
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
438 #define ASSERT_STREQ_AT(LOC, VAL1, VAL2) \
111
kono
parents:
diff changeset
439 SELFTEST_BEGIN_STMT \
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
440 ::selftest::assert_streq ((LOC), #VAL1, #VAL2, \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
441 (VAL1), (VAL2)); \
111
kono
parents:
diff changeset
442 SELFTEST_END_STMT
kono
parents:
diff changeset
443
kono
parents:
diff changeset
444 /* Evaluate HAYSTACK and NEEDLE and use strstr to determine if NEEDLE
kono
parents:
diff changeset
445 is within HAYSTACK.
kono
parents:
diff changeset
446 ::selftest::pass if NEEDLE is found.
kono
parents:
diff changeset
447 ::selftest::fail if it is not found. */
kono
parents:
diff changeset
448
kono
parents:
diff changeset
449 #define ASSERT_STR_CONTAINS(HAYSTACK, NEEDLE) \
kono
parents:
diff changeset
450 SELFTEST_BEGIN_STMT \
kono
parents:
diff changeset
451 ::selftest::assert_str_contains (SELFTEST_LOCATION, #HAYSTACK, #NEEDLE, \
kono
parents:
diff changeset
452 (HAYSTACK), (NEEDLE)); \
kono
parents:
diff changeset
453 SELFTEST_END_STMT
kono
parents:
diff changeset
454
145
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
455 /* Like ASSERT_STR_CONTAINS, but treat LOC as the effective location of the
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
456 selftest. */
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
457
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
458 #define ASSERT_STR_CONTAINS_AT(LOC, HAYSTACK, NEEDLE) \
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
459 SELFTEST_BEGIN_STMT \
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
460 ::selftest::assert_str_contains (LOC, #HAYSTACK, #NEEDLE, \
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
461 (HAYSTACK), (NEEDLE)); \
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
462 SELFTEST_END_STMT
1830386684a0 gcc-9.2.0
anatofuz
parents: 131
diff changeset
463
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
464 /* Evaluate STR and PREFIX and determine if STR starts with PREFIX.
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
465 ::selftest::pass if STR does start with PREFIX.
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
466 ::selftest::fail if does not, or either is NULL. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
467
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
468 #define ASSERT_STR_STARTSWITH(STR, PREFIX) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
469 SELFTEST_BEGIN_STMT \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
470 ::selftest::assert_str_startswith (SELFTEST_LOCATION, #STR, #PREFIX, \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
471 (STR), (PREFIX)); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
472 SELFTEST_END_STMT
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
473
111
kono
parents:
diff changeset
474 /* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true,
kono
parents:
diff changeset
475 ::selftest::fail if it is false. */
kono
parents:
diff changeset
476
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
477 #define ASSERT_PRED1(PRED1, VAL1) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
478 SELFTEST_BEGIN_STMT \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
479 const char *desc_ = "ASSERT_PRED1 (" #PRED1 ", " #VAL1 ")"; \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
480 bool actual_ = (PRED1) (VAL1); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
481 if (actual_) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
482 ::selftest::pass (SELFTEST_LOCATION, desc_); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
483 else \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
484 ::selftest::fail (SELFTEST_LOCATION, desc_); \
111
kono
parents:
diff changeset
485 SELFTEST_END_STMT
kono
parents:
diff changeset
486
kono
parents:
diff changeset
487 #define SELFTEST_BEGIN_STMT do {
kono
parents:
diff changeset
488 #define SELFTEST_END_STMT } while (0)
kono
parents:
diff changeset
489
kono
parents:
diff changeset
490 #endif /* #if CHECKING_P */
kono
parents:
diff changeset
491
kono
parents:
diff changeset
492 #endif /* GCC_SELFTEST_H */