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