Branch data Line data Source code
1 : : /* A self-testing framework, for use by -fself-test.
2 : : Copyright (C) 2015-2025 Free Software Foundation, Inc.
3 : :
4 : : This file is part of GCC.
5 : :
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.
10 : :
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.
15 : :
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/>. */
19 : :
20 : : #ifndef GCC_SELFTEST_H
21 : : #define GCC_SELFTEST_H
22 : :
23 : : /* The selftest code should entirely disappear in a production
24 : : configuration, hence we guard all of it with #if CHECKING_P. */
25 : :
26 : : #if CHECKING_P
27 : :
28 : : class file_cache;
29 : :
30 : : namespace selftest {
31 : :
32 : : /* A struct describing the source-location of a selftest, to make it
33 : : easier to track down failing tests. */
34 : :
35 : : class location
36 : : {
37 : : public:
38 : 30563045 : location (const char *file, int line, const char *function)
39 : 30550289 : : m_file (file), m_line (line), m_function (function) {}
40 : :
41 : : const char *m_file;
42 : : int m_line;
43 : : const char *m_function;
44 : : };
45 : :
46 : : /* A macro for use in selftests and by the ASSERT_ macros below,
47 : : constructing a selftest::location for the current source location. */
48 : :
49 : : #define SELFTEST_LOCATION \
50 : : (::selftest::location (__FILE__, __LINE__, __FUNCTION__))
51 : :
52 : : /* The entrypoint for running all tests. */
53 : :
54 : : extern void run_tests ();
55 : :
56 : : /* Record the successful outcome of some aspect of the test. */
57 : :
58 : : extern void pass (const location &loc, const char *msg);
59 : :
60 : : /* Report the failed outcome of some aspect of the test and abort. */
61 : :
62 : : extern void fail (const location &loc, const char *msg)
63 : : ATTRIBUTE_NORETURN;
64 : :
65 : : /* As "fail", but using printf-style formatted output. */
66 : :
67 : : extern void fail_formatted (const location &loc, const char *fmt, ...)
68 : : ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN;
69 : :
70 : : /* Implementation detail of ASSERT_STREQ. */
71 : :
72 : : extern void assert_streq (const location &loc,
73 : : const char *desc_val1, const char *desc_val2,
74 : : const char *val1, const char *val2);
75 : :
76 : : /* Implementation detail of ASSERT_STR_CONTAINS. */
77 : :
78 : : extern void assert_str_contains (const location &loc,
79 : : const char *desc_haystack,
80 : : const char *desc_needle,
81 : : const char *val_haystack,
82 : : const char *val_needle);
83 : :
84 : : /* Implementation detail of ASSERT_STR_STARTSWITH. */
85 : :
86 : : extern void assert_str_startswith (const location &loc,
87 : : const char *desc_str,
88 : : const char *desc_prefix,
89 : : const char *val_str,
90 : : const char *val_prefix);
91 : :
92 : :
93 : : /* A named temporary file for use in selftests.
94 : : Usable for writing out files, and as the base class for
95 : : temp_source_file.
96 : : The file is unlinked in the destructor.
97 : : If the file_cache is non-null, the filename is evicted from
98 : : the file_cache when the named_temp_file is destroyed. */
99 : :
100 : : class named_temp_file
101 : : {
102 : : public:
103 : : named_temp_file (const char *suffix, file_cache *fc = nullptr);
104 : : ~named_temp_file ();
105 : 33128 : const char *get_filename () const { return m_filename; }
106 : :
107 : : private:
108 : : char *m_filename;
109 : : file_cache *m_file_cache;
110 : : };
111 : :
112 : : /* A class for writing out a temporary sourcefile for use in selftests
113 : : of input handling. */
114 : :
115 : 5516 : class temp_source_file : public named_temp_file
116 : : {
117 : : public:
118 : : temp_source_file (const location &loc, const char *suffix,
119 : : const char *content, file_cache *fc = nullptr);
120 : : temp_source_file (const location &loc, const char *suffix,
121 : : const char *content, size_t sz);
122 : : };
123 : :
124 : : /* RAII-style class for avoiding introducing locale-specific differences
125 : : in strings containing localized quote marks, by temporarily overriding
126 : : the "open_quote" and "close_quote" globals to something hardcoded.
127 : :
128 : : Specifically, the C locale's values are used:
129 : : - open_quote becomes "`"
130 : : - close_quote becomes "'"
131 : : for the lifetime of the object. */
132 : :
133 : : class auto_fix_quotes
134 : : {
135 : : public:
136 : : auto_fix_quotes ();
137 : : ~auto_fix_quotes ();
138 : :
139 : : private:
140 : : const char *m_saved_open_quote;
141 : : const char *m_saved_close_quote;
142 : : };
143 : :
144 : : /* Various selftests involving location-handling require constructing a
145 : : line table and one or more line maps within it.
146 : :
147 : : For maximum test coverage we want to run these tests with a variety
148 : : of situations:
149 : : - line_table->default_range_bits: some frontends use a non-zero value
150 : : and others use zero
151 : : - the fallback modes within line-map.cc: there are various threshold
152 : : values for location_t beyond line-map.cc changes
153 : : behavior (disabling of the range-packing optimization, disabling
154 : : of column-tracking). We can exercise these by starting the line_table
155 : : at interesting values at or near these thresholds.
156 : :
157 : : The following struct describes a particular case within our test
158 : : matrix. */
159 : :
160 : : class line_table_case;
161 : :
162 : : /* A class for overriding the global "line_table" within a selftest,
163 : : restoring its value afterwards. At most one instance of this
164 : : class can exist at once, due to the need to keep the old value
165 : : of line_table as a GC root. */
166 : :
167 : : class line_table_test
168 : : {
169 : : public:
170 : : /* Default constructor. Override "line_table", using sane defaults
171 : : for the temporary line_table. */
172 : : line_table_test ();
173 : :
174 : : /* Constructor. Override "line_table", using the case described by C. */
175 : : line_table_test (const line_table_case &c);
176 : :
177 : : /* Destructor. Restore the saved line_table. */
178 : : ~line_table_test ();
179 : : };
180 : :
181 : : /* Run TESTCASE multiple times, once for each case in our test matrix. */
182 : :
183 : : extern void
184 : : for_each_line_table_case (void (*testcase) (const line_table_case &));
185 : :
186 : : /* Read the contents of PATH into memory, returning a 0-terminated buffer
187 : : that must be freed by the caller.
188 : : Fail (and abort) if there are any problems, with LOC as the reported
189 : : location of the failure. */
190 : :
191 : : extern char *read_file (const location &loc, const char *path);
192 : :
193 : : /* Convert a path relative to SRCDIR/gcc/testsuite/selftests
194 : : to a real path (either absolute, or relative to pwd).
195 : : The result should be freed by the caller. */
196 : :
197 : : extern char *locate_file (const char *path);
198 : :
199 : : /* The path of SRCDIR/testsuite/selftests. */
200 : :
201 : : extern const char *path_to_selftest_files;
202 : :
203 : : /* selftest::test_runner is an implementation detail of selftest::run_tests,
204 : : exposed here to allow plugins to run their own suites of tests. */
205 : :
206 : : class test_runner
207 : : {
208 : : public:
209 : : test_runner (const char *name);
210 : : ~test_runner ();
211 : :
212 : : private:
213 : : const char *m_name;
214 : : long m_start_time;
215 : : };
216 : :
217 : : /* Declarations for specific families of tests (by source file), in
218 : : alphabetical order. */
219 : : extern void attribs_cc_tests ();
220 : : extern void bitmap_cc_tests ();
221 : : extern void cgraph_cc_tests ();
222 : : extern void convert_cc_tests ();
223 : : extern void dbgcnt_cc_tests ();
224 : : extern void diagnostic_color_cc_tests ();
225 : : extern void diagnostic_format_html_cc_tests ();
226 : : extern void diagnostic_format_json_cc_tests ();
227 : : extern void diagnostic_format_sarif_cc_tests ();
228 : : extern void diagnostic_path_output_cc_tests ();
229 : : extern void diagnostic_show_locus_cc_tests ();
230 : : extern void digraph_cc_tests ();
231 : : extern void dumpfile_cc_tests ();
232 : : extern void edit_context_cc_tests ();
233 : : extern void et_forest_cc_tests ();
234 : : extern void fibonacci_heap_cc_tests ();
235 : : extern void fold_const_cc_tests ();
236 : : extern void function_tests_cc_tests ();
237 : : extern void gcc_attribute_urlifier_cc_tests ();
238 : : extern void gcc_urlifier_cc_tests ();
239 : : extern void ggc_tests_cc_tests ();
240 : : extern void gimple_cc_tests ();
241 : : extern void gimple_range_tests ();
242 : : extern void hash_map_tests_cc_tests ();
243 : : extern void hash_set_tests_cc_tests ();
244 : : extern void input_cc_tests ();
245 : : extern void ipa_modref_tree_cc_tests ();
246 : : extern void json_cc_tests ();
247 : : extern void json_parser_cc_tests ();
248 : : extern void lazy_diagnostic_path_cc_tests ();
249 : : extern void opt_suggestions_cc_tests ();
250 : : extern void optinfo_emit_json_cc_tests ();
251 : : extern void opts_cc_tests ();
252 : : extern void opts_diagnostic_cc_tests ();
253 : : extern void ordered_hash_map_tests_cc_tests ();
254 : : extern void path_coverage_cc_tests ();
255 : : extern void predict_cc_tests ();
256 : : extern void pretty_print_cc_tests ();
257 : : extern void range_op_tests ();
258 : : extern void range_tests ();
259 : : extern void read_rtl_function_cc_tests ();
260 : : extern void relation_tests ();
261 : : extern void rtl_tests_cc_tests ();
262 : : extern void sbitmap_cc_tests ();
263 : : extern void selftest_cc_tests ();
264 : : extern void selftest_logical_location_cc_tests ();
265 : : extern void simple_diagnostic_path_cc_tests ();
266 : : extern void simplify_rtx_cc_tests ();
267 : : extern void spellcheck_cc_tests ();
268 : : extern void spellcheck_tree_cc_tests ();
269 : : extern void splay_tree_cc_tests ();
270 : : extern void sreal_cc_tests ();
271 : : extern void store_merging_cc_tests ();
272 : : extern void tree_cc_tests ();
273 : : extern void tree_cfg_cc_tests ();
274 : : extern void tristate_cc_tests ();
275 : : extern void typed_splay_tree_cc_tests ();
276 : : extern void vec_cc_tests ();
277 : : extern void vec_perm_indices_cc_tests ();
278 : : extern void wide_int_cc_tests ();
279 : : extern void xml_cc_tests ();
280 : :
281 : : extern int num_passes;
282 : :
283 : : } /* end of namespace selftest. */
284 : :
285 : : /* Macros for writing tests. */
286 : :
287 : : /* Evaluate EXPR and coerce to bool, calling
288 : : ::selftest::pass if it is true,
289 : : ::selftest::fail if it false. */
290 : :
291 : : #define ASSERT_TRUE(EXPR) \
292 : : ASSERT_TRUE_AT (SELFTEST_LOCATION, (EXPR))
293 : :
294 : : /* Like ASSERT_TRUE, but treat LOC as the effective location of the
295 : : selftest. */
296 : :
297 : : #define ASSERT_TRUE_AT(LOC, EXPR) \
298 : : SELFTEST_BEGIN_STMT \
299 : : const char *desc_ = "ASSERT_TRUE (" #EXPR ")"; \
300 : : bool actual_ = (EXPR); \
301 : : if (actual_) \
302 : : ::selftest::pass ((LOC), desc_); \
303 : : else \
304 : : ::selftest::fail ((LOC), desc_); \
305 : : SELFTEST_END_STMT
306 : :
307 : : /* Evaluate EXPR and coerce to bool, calling
308 : : ::selftest::pass if it is false,
309 : : ::selftest::fail if it true. */
310 : :
311 : : #define ASSERT_FALSE(EXPR) \
312 : : ASSERT_FALSE_AT (SELFTEST_LOCATION, (EXPR))
313 : :
314 : : /* Like ASSERT_FALSE, but treat LOC as the effective location of the
315 : : selftest. */
316 : :
317 : : #define ASSERT_FALSE_AT(LOC, EXPR) \
318 : : SELFTEST_BEGIN_STMT \
319 : : const char *desc_ = "ASSERT_FALSE (" #EXPR ")"; \
320 : : bool actual_ = (EXPR); \
321 : : if (actual_) \
322 : : ::selftest::fail ((LOC), desc_); \
323 : : else \
324 : : ::selftest::pass ((LOC), desc_); \
325 : : SELFTEST_END_STMT
326 : :
327 : : /* Evaluate VAL1 and VAL2 and compare them with ==, calling
328 : : ::selftest::pass if they are equal,
329 : : ::selftest::fail if they are non-equal. */
330 : :
331 : : #define ASSERT_EQ(VAL1, VAL2) \
332 : : ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
333 : :
334 : : /* Like ASSERT_EQ, but treat LOC as the effective location of the
335 : : selftest. */
336 : :
337 : : #define ASSERT_EQ_AT(LOC, VAL1, VAL2) \
338 : : SELFTEST_BEGIN_STMT \
339 : : const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \
340 : : if ((VAL1) == (VAL2)) \
341 : : ::selftest::pass ((LOC), desc_); \
342 : : else \
343 : : ::selftest::fail ((LOC), desc_); \
344 : : SELFTEST_END_STMT
345 : :
346 : : /* Evaluate VAL1 and VAL2 and compare them, calling
347 : : ::selftest::pass if they are within ABS_ERROR of each other,
348 : : ::selftest::fail if they are not. */
349 : :
350 : : #define ASSERT_NEAR(VAL1, VAL2, ABS_ERROR) \
351 : : ASSERT_NEAR_AT ((SELFTEST_LOCATION), (VAL1), (VAL2), (ABS_ERROR))
352 : :
353 : : /* Like ASSERT_NEAR, but treat LOC as the effective location of the
354 : : selftest. */
355 : :
356 : : #define ASSERT_NEAR_AT(LOC, VAL1, VAL2, ABS_ERROR) \
357 : : SELFTEST_BEGIN_STMT \
358 : : const char *desc_ = "ASSERT_NEAR (" #VAL1 ", " #VAL2 ", " #ABS_ERROR ")"; \
359 : : double error = fabs ((VAL1) - (VAL2)); \
360 : : if (error < (ABS_ERROR)) \
361 : : ::selftest::pass ((LOC), desc_); \
362 : : else \
363 : : ::selftest::fail ((LOC), desc_); \
364 : : SELFTEST_END_STMT
365 : :
366 : : /* Evaluate VAL1 and VAL2 and compare them with known_eq, calling
367 : : ::selftest::pass if they are always equal,
368 : : ::selftest::fail if they might be non-equal. */
369 : :
370 : : #define ASSERT_KNOWN_EQ(VAL1, VAL2) \
371 : : ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
372 : :
373 : : /* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the
374 : : selftest. */
375 : :
376 : : #define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2) \
377 : : SELFTEST_BEGIN_STMT \
378 : : const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")"; \
379 : : if (known_eq (VAL1, VAL2)) \
380 : : ::selftest::pass ((LOC), desc); \
381 : : else \
382 : : ::selftest::fail ((LOC), desc); \
383 : : SELFTEST_END_STMT
384 : :
385 : : /* Evaluate VAL1 and VAL2 and compare them with !=, calling
386 : : ::selftest::pass if they are non-equal,
387 : : ::selftest::fail if they are equal. */
388 : :
389 : : #define ASSERT_NE(VAL1, VAL2) \
390 : : SELFTEST_BEGIN_STMT \
391 : : const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \
392 : : if ((VAL1) != (VAL2)) \
393 : : ::selftest::pass (SELFTEST_LOCATION, desc_); \
394 : : else \
395 : : ::selftest::fail (SELFTEST_LOCATION, desc_); \
396 : : SELFTEST_END_STMT
397 : :
398 : : /* Like ASSERT_NE, but treat LOC as the effective location of the
399 : : selftest. */
400 : :
401 : : #define ASSERT_NE_AT(LOC, VAL1, VAL2) \
402 : : SELFTEST_BEGIN_STMT \
403 : : const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \
404 : : if ((VAL1) != (VAL2)) \
405 : : ::selftest::pass ((LOC), desc_); \
406 : : else \
407 : : ::selftest::fail ((LOC), desc_); \
408 : : SELFTEST_END_STMT
409 : :
410 : : /* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling
411 : : ::selftest::pass if they might be non-equal,
412 : : ::selftest::fail if they are known to be equal. */
413 : :
414 : : #define ASSERT_MAYBE_NE(VAL1, VAL2) \
415 : : ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
416 : :
417 : : /* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the
418 : : selftest. */
419 : :
420 : : #define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2) \
421 : : SELFTEST_BEGIN_STMT \
422 : : const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")"; \
423 : : if (maybe_ne (VAL1, VAL2)) \
424 : : ::selftest::pass ((LOC), desc); \
425 : : else \
426 : : ::selftest::fail ((LOC), desc); \
427 : : SELFTEST_END_STMT
428 : :
429 : : /* Evaluate LHS and RHS and compare them with >, calling
430 : : ::selftest::pass if LHS > RHS,
431 : : ::selftest::fail otherwise. */
432 : :
433 : : #define ASSERT_GT(LHS, RHS) \
434 : : ASSERT_GT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
435 : :
436 : : /* Like ASSERT_GT, but treat LOC as the effective location of the
437 : : selftest. */
438 : :
439 : : #define ASSERT_GT_AT(LOC, LHS, RHS) \
440 : : SELFTEST_BEGIN_STMT \
441 : : const char *desc_ = "ASSERT_GT (" #LHS ", " #RHS ")"; \
442 : : if ((LHS) > (RHS)) \
443 : : ::selftest::pass ((LOC), desc_); \
444 : : else \
445 : : ::selftest::fail ((LOC), desc_); \
446 : : SELFTEST_END_STMT
447 : :
448 : : /* Evaluate LHS and RHS and compare them with <, calling
449 : : ::selftest::pass if LHS < RHS,
450 : : ::selftest::fail otherwise. */
451 : :
452 : : #define ASSERT_LT(LHS, RHS) \
453 : : ASSERT_LT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
454 : :
455 : : /* Like ASSERT_LT, but treat LOC as the effective location of the
456 : : selftest. */
457 : :
458 : : #define ASSERT_LT_AT(LOC, LHS, RHS) \
459 : : SELFTEST_BEGIN_STMT \
460 : : const char *desc_ = "ASSERT_LT (" #LHS ", " #RHS ")"; \
461 : : if ((LHS) < (RHS)) \
462 : : ::selftest::pass ((LOC), desc_); \
463 : : else \
464 : : ::selftest::fail ((LOC), desc_); \
465 : : SELFTEST_END_STMT
466 : :
467 : : /* Evaluate VAL1 and VAL2 and compare them with strcmp, calling
468 : : ::selftest::pass if they are equal (and both are non-NULL),
469 : : ::selftest::fail if they are non-equal, or are both NULL. */
470 : :
471 : : #define ASSERT_STREQ(VAL1, VAL2) \
472 : : SELFTEST_BEGIN_STMT \
473 : : ::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \
474 : : (VAL1), (VAL2)); \
475 : : SELFTEST_END_STMT
476 : :
477 : : /* Like ASSERT_STREQ, but treat LOC as the effective location of the
478 : : selftest. */
479 : :
480 : : #define ASSERT_STREQ_AT(LOC, VAL1, VAL2) \
481 : : SELFTEST_BEGIN_STMT \
482 : : ::selftest::assert_streq ((LOC), #VAL1, #VAL2, \
483 : : (VAL1), (VAL2)); \
484 : : SELFTEST_END_STMT
485 : :
486 : : /* Evaluate HAYSTACK and NEEDLE and use strstr to determine if NEEDLE
487 : : is within HAYSTACK.
488 : : ::selftest::pass if NEEDLE is found.
489 : : ::selftest::fail if it is not found. */
490 : :
491 : : #define ASSERT_STR_CONTAINS(HAYSTACK, NEEDLE) \
492 : : SELFTEST_BEGIN_STMT \
493 : : ::selftest::assert_str_contains (SELFTEST_LOCATION, #HAYSTACK, #NEEDLE, \
494 : : (HAYSTACK), (NEEDLE)); \
495 : : SELFTEST_END_STMT
496 : :
497 : : /* Like ASSERT_STR_CONTAINS, but treat LOC as the effective location of the
498 : : selftest. */
499 : :
500 : : #define ASSERT_STR_CONTAINS_AT(LOC, HAYSTACK, NEEDLE) \
501 : : SELFTEST_BEGIN_STMT \
502 : : ::selftest::assert_str_contains (LOC, #HAYSTACK, #NEEDLE, \
503 : : (HAYSTACK), (NEEDLE)); \
504 : : SELFTEST_END_STMT
505 : :
506 : : /* Evaluate STR and PREFIX and determine if STR starts with PREFIX.
507 : : ::selftest::pass if STR does start with PREFIX.
508 : : ::selftest::fail if does not, or either is NULL. */
509 : :
510 : : #define ASSERT_STR_STARTSWITH(STR, PREFIX) \
511 : : SELFTEST_BEGIN_STMT \
512 : : ::selftest::assert_str_startswith (SELFTEST_LOCATION, #STR, #PREFIX, \
513 : : (STR), (PREFIX)); \
514 : : SELFTEST_END_STMT
515 : :
516 : : /* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true,
517 : : ::selftest::fail if it is false. */
518 : :
519 : : #define ASSERT_PRED1(PRED1, VAL1) \
520 : : SELFTEST_BEGIN_STMT \
521 : : const char *desc_ = "ASSERT_PRED1 (" #PRED1 ", " #VAL1 ")"; \
522 : : bool actual_ = (PRED1) (VAL1); \
523 : : if (actual_) \
524 : : ::selftest::pass (SELFTEST_LOCATION, desc_); \
525 : : else \
526 : : ::selftest::fail (SELFTEST_LOCATION, desc_); \
527 : : SELFTEST_END_STMT
528 : :
529 : : #define SELFTEST_BEGIN_STMT do {
530 : : #define SELFTEST_END_STMT } while (0)
531 : :
532 : : #endif /* #if CHECKING_P */
533 : :
534 : : #endif /* GCC_SELFTEST_H */
|
