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

source code of gcc/selftest.h