1 /* A self-testing framework, for use by -fself-test. 2 Copyright (C) 2015-2022 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 namespace selftest { 29 30 /* A struct describing the source-location of a selftest, to make it 31 easier to track down failing tests. */ 32 33 class location 34 { 35 public: location(const char * file,int line,const char * function)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 52 extern void run_tests (); 53 54 /* Record the successful outcome of some aspect of the test. */ 55 56 extern void pass (const location &loc, const char *msg); 57 58 /* Report the failed outcome of some aspect of the test and abort. */ 59 60 extern void fail (const location &loc, const char *msg) 61 ATTRIBUTE_NORETURN; 62 63 /* As "fail", but using printf-style formatted output. */ 64 65 extern void fail_formatted (const location &loc, const char *fmt, ...) 66 ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN; 67 68 /* Implementation detail of ASSERT_STREQ. */ 69 70 extern 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 76 extern 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 84 extern 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 96 class named_temp_file 97 { 98 public: 99 named_temp_file (const char *suffix); 100 ~named_temp_file (); get_filename()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 110 class 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 128 class 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 155 class 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 162 class 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 178 extern tree make_fndecl (tree return_type, 179 const char *name, 180 vec <tree> ¶m_types, 181 bool is_variadic = false); 182 183 /* Run TESTCASE multiple times, once for each case in our test matrix. */ 184 185 extern void 186 for_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 193 extern 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 199 extern char *locate_file (const char *path); 200 201 /* The path of SRCDIR/testsuite/selftests. */ 202 203 extern 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 208 class 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. */ 221 extern void attribs_cc_tests (); 222 extern void bitmap_cc_tests (); 223 extern void cgraph_cc_tests (); 224 extern void convert_cc_tests (); 225 extern void diagnostic_format_json_cc_tests (); 226 extern void diagnostic_show_locus_cc_tests (); 227 extern void digraph_cc_tests (); 228 extern void dumpfile_cc_tests (); 229 extern void edit_context_cc_tests (); 230 extern void et_forest_cc_tests (); 231 extern void fibonacci_heap_cc_tests (); 232 extern void fold_const_cc_tests (); 233 extern void function_tests_cc_tests (); 234 extern void ggc_tests_cc_tests (); 235 extern void gimple_cc_tests (); 236 extern void hash_map_tests_cc_tests (); 237 extern void hash_set_tests_cc_tests (); 238 extern void input_cc_tests (); 239 extern void json_cc_tests (); 240 extern void optinfo_emit_json_cc_tests (); 241 extern void opts_cc_tests (); 242 extern void ordered_hash_map_tests_cc_tests (); 243 extern void predict_cc_tests (); 244 extern void pretty_print_cc_tests (); 245 extern void range_tests (); 246 extern void range_op_tests (); 247 extern void gimple_range_tests (); 248 extern void read_rtl_function_cc_tests (); 249 extern void rtl_tests_cc_tests (); 250 extern void sbitmap_cc_tests (); 251 extern void selftest_cc_tests (); 252 extern void simplify_rtx_cc_tests (); 253 extern void spellcheck_cc_tests (); 254 extern void spellcheck_tree_cc_tests (); 255 extern void splay_tree_cc_tests (); 256 extern void sreal_cc_tests (); 257 extern void store_merging_cc_tests (); 258 extern void tree_cc_tests (); 259 extern void tree_cfg_cc_tests (); 260 extern void tree_diagnostic_path_cc_tests (); 261 extern void tristate_cc_tests (); 262 extern void typed_splay_tree_cc_tests (); 263 extern void vec_cc_tests (); 264 extern void vec_perm_indices_cc_tests (); 265 extern void wide_int_cc_tests (); 266 extern void opt_suggestions_cc_tests (); 267 extern void dbgcnt_cc_tests (); 268 extern void ipa_modref_tree_cc_tests (); 269 270 extern int num_passes; 271 272 } /* end of namespace selftest. */ 273 274 /* Macros for writing tests. */ 275 276 /* Evaluate EXPR and coerce to bool, calling 277 ::selftest::pass if it is true, 278 ::selftest::fail if it false. */ 279 280 #define ASSERT_TRUE(EXPR) \ 281 ASSERT_TRUE_AT (SELFTEST_LOCATION, (EXPR)) 282 283 /* Like ASSERT_TRUE, but treat LOC as the effective location of the 284 selftest. */ 285 286 #define ASSERT_TRUE_AT(LOC, EXPR) \ 287 SELFTEST_BEGIN_STMT \ 288 const char *desc_ = "ASSERT_TRUE (" #EXPR ")"; \ 289 bool actual_ = (EXPR); \ 290 if (actual_) \ 291 ::selftest::pass ((LOC), desc_); \ 292 else \ 293 ::selftest::fail ((LOC), desc_); \ 294 SELFTEST_END_STMT 295 296 /* Evaluate EXPR and coerce to bool, calling 297 ::selftest::pass if it is false, 298 ::selftest::fail if it true. */ 299 300 #define ASSERT_FALSE(EXPR) \ 301 ASSERT_FALSE_AT (SELFTEST_LOCATION, (EXPR)) 302 303 /* Like ASSERT_FALSE, but treat LOC as the effective location of the 304 selftest. */ 305 306 #define ASSERT_FALSE_AT(LOC, EXPR) \ 307 SELFTEST_BEGIN_STMT \ 308 const char *desc_ = "ASSERT_FALSE (" #EXPR ")"; \ 309 bool actual_ = (EXPR); \ 310 if (actual_) \ 311 ::selftest::fail ((LOC), desc_); \ 312 else \ 313 ::selftest::pass ((LOC), desc_); \ 314 SELFTEST_END_STMT 315 316 /* Evaluate VAL1 and VAL2 and compare them with ==, calling 317 ::selftest::pass if they are equal, 318 ::selftest::fail if they are non-equal. */ 319 320 #define ASSERT_EQ(VAL1, VAL2) \ 321 ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2)) 322 323 /* Like ASSERT_EQ, but treat LOC as the effective location of the 324 selftest. */ 325 326 #define ASSERT_EQ_AT(LOC, VAL1, VAL2) \ 327 SELFTEST_BEGIN_STMT \ 328 const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \ 329 if ((VAL1) == (VAL2)) \ 330 ::selftest::pass ((LOC), desc_); \ 331 else \ 332 ::selftest::fail ((LOC), desc_); \ 333 SELFTEST_END_STMT 334 335 /* Evaluate VAL1 and VAL2 and compare them with known_eq, calling 336 ::selftest::pass if they are always equal, 337 ::selftest::fail if they might be non-equal. */ 338 339 #define ASSERT_KNOWN_EQ(VAL1, VAL2) \ 340 ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2)) 341 342 /* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the 343 selftest. */ 344 345 #define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2) \ 346 SELFTEST_BEGIN_STMT \ 347 const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")"; \ 348 if (known_eq (VAL1, VAL2)) \ 349 ::selftest::pass ((LOC), desc); \ 350 else \ 351 ::selftest::fail ((LOC), desc); \ 352 SELFTEST_END_STMT 353 354 /* Evaluate VAL1 and VAL2 and compare them with !=, calling 355 ::selftest::pass if they are non-equal, 356 ::selftest::fail if they are equal. */ 357 358 #define ASSERT_NE(VAL1, VAL2) \ 359 SELFTEST_BEGIN_STMT \ 360 const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \ 361 if ((VAL1) != (VAL2)) \ 362 ::selftest::pass (SELFTEST_LOCATION, desc_); \ 363 else \ 364 ::selftest::fail (SELFTEST_LOCATION, desc_); \ 365 SELFTEST_END_STMT 366 367 /* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling 368 ::selftest::pass if they might be non-equal, 369 ::selftest::fail if they are known to be equal. */ 370 371 #define ASSERT_MAYBE_NE(VAL1, VAL2) \ 372 ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2)) 373 374 /* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the 375 selftest. */ 376 377 #define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2) \ 378 SELFTEST_BEGIN_STMT \ 379 const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")"; \ 380 if (maybe_ne (VAL1, VAL2)) \ 381 ::selftest::pass ((LOC), desc); \ 382 else \ 383 ::selftest::fail ((LOC), desc); \ 384 SELFTEST_END_STMT 385 386 /* Evaluate LHS and RHS and compare them with >, calling 387 ::selftest::pass if LHS > RHS, 388 ::selftest::fail otherwise. */ 389 390 #define ASSERT_GT(LHS, RHS) \ 391 ASSERT_GT_AT ((SELFTEST_LOCATION), (LHS), (RHS)) 392 393 /* Like ASSERT_GT, but treat LOC as the effective location of the 394 selftest. */ 395 396 #define ASSERT_GT_AT(LOC, LHS, RHS) \ 397 SELFTEST_BEGIN_STMT \ 398 const char *desc_ = "ASSERT_GT (" #LHS ", " #RHS ")"; \ 399 if ((LHS) > (RHS)) \ 400 ::selftest::pass ((LOC), desc_); \ 401 else \ 402 ::selftest::fail ((LOC), desc_); \ 403 SELFTEST_END_STMT 404 405 /* Evaluate LHS and RHS and compare them with <, calling 406 ::selftest::pass if LHS < RHS, 407 ::selftest::fail otherwise. */ 408 409 #define ASSERT_LT(LHS, RHS) \ 410 ASSERT_LT_AT ((SELFTEST_LOCATION), (LHS), (RHS)) 411 412 /* Like ASSERT_LT, but treat LOC as the effective location of the 413 selftest. */ 414 415 #define ASSERT_LT_AT(LOC, LHS, RHS) \ 416 SELFTEST_BEGIN_STMT \ 417 const char *desc_ = "ASSERT_LT (" #LHS ", " #RHS ")"; \ 418 if ((LHS) < (RHS)) \ 419 ::selftest::pass ((LOC), desc_); \ 420 else \ 421 ::selftest::fail ((LOC), desc_); \ 422 SELFTEST_END_STMT 423 424 /* Evaluate VAL1 and VAL2 and compare them with strcmp, calling 425 ::selftest::pass if they are equal (and both are non-NULL), 426 ::selftest::fail if they are non-equal, or are both NULL. */ 427 428 #define ASSERT_STREQ(VAL1, VAL2) \ 429 SELFTEST_BEGIN_STMT \ 430 ::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \ 431 (VAL1), (VAL2)); \ 432 SELFTEST_END_STMT 433 434 /* Like ASSERT_STREQ, but treat LOC as the effective location of the 435 selftest. */ 436 437 #define ASSERT_STREQ_AT(LOC, VAL1, VAL2) \ 438 SELFTEST_BEGIN_STMT \ 439 ::selftest::assert_streq ((LOC), #VAL1, #VAL2, \ 440 (VAL1), (VAL2)); \ 441 SELFTEST_END_STMT 442 443 /* Evaluate HAYSTACK and NEEDLE and use strstr to determine if NEEDLE 444 is within HAYSTACK. 445 ::selftest::pass if NEEDLE is found. 446 ::selftest::fail if it is not found. */ 447 448 #define ASSERT_STR_CONTAINS(HAYSTACK, NEEDLE) \ 449 SELFTEST_BEGIN_STMT \ 450 ::selftest::assert_str_contains (SELFTEST_LOCATION, #HAYSTACK, #NEEDLE, \ 451 (HAYSTACK), (NEEDLE)); \ 452 SELFTEST_END_STMT 453 454 /* Like ASSERT_STR_CONTAINS, but treat LOC as the effective location of the 455 selftest. */ 456 457 #define ASSERT_STR_CONTAINS_AT(LOC, HAYSTACK, NEEDLE) \ 458 SELFTEST_BEGIN_STMT \ 459 ::selftest::assert_str_contains (LOC, #HAYSTACK, #NEEDLE, \ 460 (HAYSTACK), (NEEDLE)); \ 461 SELFTEST_END_STMT 462 463 /* Evaluate STR and PREFIX and determine if STR starts with PREFIX. 464 ::selftest::pass if STR does start with PREFIX. 465 ::selftest::fail if does not, or either is NULL. */ 466 467 #define ASSERT_STR_STARTSWITH(STR, PREFIX) \ 468 SELFTEST_BEGIN_STMT \ 469 ::selftest::assert_str_startswith (SELFTEST_LOCATION, #STR, #PREFIX, \ 470 (STR), (PREFIX)); \ 471 SELFTEST_END_STMT 472 473 /* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true, 474 ::selftest::fail if it is false. */ 475 476 #define ASSERT_PRED1(PRED1, VAL1) \ 477 SELFTEST_BEGIN_STMT \ 478 const char *desc_ = "ASSERT_PRED1 (" #PRED1 ", " #VAL1 ")"; \ 479 bool actual_ = (PRED1) (VAL1); \ 480 if (actual_) \ 481 ::selftest::pass (SELFTEST_LOCATION, desc_); \ 482 else \ 483 ::selftest::fail (SELFTEST_LOCATION, desc_); \ 484 SELFTEST_END_STMT 485 486 #define SELFTEST_BEGIN_STMT do { 487 #define SELFTEST_END_STMT } while (0) 488 489 #endif /* #if CHECKING_P */ 490 491 #endif /* GCC_SELFTEST_H */ 492