annotate gcc/selftest.h @ 131:84e7813d76e9

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