1 /* A self-testing framework, for use by -fself-test. 2 Copyright (C) 2015-2021 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 }; 116 117 /* RAII-style class for avoiding introducing locale-specific differences 118 in strings containing localized quote marks, by temporarily overriding 119 the "open_quote" and "close_quote" globals to something hardcoded. 120 121 Specifically, the C locale's values are used: 122 - open_quote becomes "`" 123 - close_quote becomes "'" 124 for the lifetime of the object. */ 125 126 class auto_fix_quotes 127 { 128 public: 129 auto_fix_quotes (); 130 ~auto_fix_quotes (); 131 132 private: 133 const char *m_saved_open_quote; 134 const char *m_saved_close_quote; 135 }; 136 137 /* Various selftests involving location-handling require constructing a 138 line table and one or more line maps within it. 139 140 For maximum test coverage we want to run these tests with a variety 141 of situations: 142 - line_table->default_range_bits: some frontends use a non-zero value 143 and others use zero 144 - the fallback modes within line-map.c: there are various threshold 145 values for location_t beyond line-map.c changes 146 behavior (disabling of the range-packing optimization, disabling 147 of column-tracking). We can exercise these by starting the line_table 148 at interesting values at or near these thresholds. 149 150 The following struct describes a particular case within our test 151 matrix. */ 152 153 class line_table_case; 154 155 /* A class for overriding the global "line_table" within a selftest, 156 restoring its value afterwards. At most one instance of this 157 class can exist at once, due to the need to keep the old value 158 of line_table as a GC root. */ 159 160 class line_table_test 161 { 162 public: 163 /* Default constructor. Override "line_table", using sane defaults 164 for the temporary line_table. */ 165 line_table_test (); 166 167 /* Constructor. Override "line_table", using the case described by C. */ 168 line_table_test (const line_table_case &c); 169 170 /* Destructor. Restore the saved line_table. */ 171 ~line_table_test (); 172 }; 173 174 /* Helper function for selftests that need a function decl. */ 175 176 extern tree make_fndecl (tree return_type, 177 const char *name, 178 vec <tree> ¶m_types, 179 bool is_variadic = false); 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 /* A helper function for writing tests that interact with the 194 garbage collector. */ 195 196 extern void forcibly_ggc_collect (); 197 198 /* Convert a path relative to SRCDIR/gcc/testsuite/selftests 199 to a real path (either absolute, or relative to pwd). 200 The result should be freed by the caller. */ 201 202 extern char *locate_file (const char *path); 203 204 /* The path of SRCDIR/testsuite/selftests. */ 205 206 extern const char *path_to_selftest_files; 207 208 /* selftest::test_runner is an implementation detail of selftest::run_tests, 209 exposed here to allow plugins to run their own suites of tests. */ 210 211 class test_runner 212 { 213 public: 214 test_runner (const char *name); 215 ~test_runner (); 216 217 private: 218 const char *m_name; 219 long m_start_time; 220 }; 221 222 /* Declarations for specific families of tests (by source file), in 223 alphabetical order. */ 224 extern void attribute_c_tests (); 225 extern void bitmap_c_tests (); 226 extern void cgraph_c_tests (); 227 extern void convert_c_tests (); 228 extern void diagnostic_c_tests (); 229 extern void diagnostic_format_json_cc_tests (); 230 extern void diagnostic_show_locus_c_tests (); 231 extern void digraph_cc_tests (); 232 extern void dumpfile_c_tests (); 233 extern void edit_context_c_tests (); 234 extern void et_forest_c_tests (); 235 extern void fibonacci_heap_c_tests (); 236 extern void fold_const_c_tests (); 237 extern void function_tests_c_tests (); 238 extern void ggc_tests_c_tests (); 239 extern void gimple_c_tests (); 240 extern void hash_map_tests_c_tests (); 241 extern void hash_set_tests_c_tests (); 242 extern void input_c_tests (); 243 extern void json_cc_tests (); 244 extern void opt_problem_cc_tests (); 245 extern void optinfo_emit_json_cc_tests (); 246 extern void opts_c_tests (); 247 extern void ordered_hash_map_tests_cc_tests (); 248 extern void predict_c_tests (); 249 extern void pretty_print_c_tests (); 250 extern void range_tests (); 251 extern void range_op_tests (); 252 extern void read_rtl_function_c_tests (); 253 extern void rtl_tests_c_tests (); 254 extern void sbitmap_c_tests (); 255 extern void selftest_c_tests (); 256 extern void simplify_rtx_c_tests (); 257 extern void spellcheck_c_tests (); 258 extern void spellcheck_tree_c_tests (); 259 extern void splay_tree_cc_tests (); 260 extern void sreal_c_tests (); 261 extern void store_merging_c_tests (); 262 extern void tree_c_tests (); 263 extern void tree_cfg_c_tests (); 264 extern void tree_diagnostic_path_cc_tests (); 265 extern void tristate_cc_tests (); 266 extern void typed_splay_tree_c_tests (); 267 extern void unique_ptr_tests_cc_tests (); 268 extern void vec_c_tests (); 269 extern void vec_perm_indices_c_tests (); 270 extern void wide_int_cc_tests (); 271 extern void opt_proposer_c_tests (); 272 extern void dbgcnt_c_tests (); 273 extern void ipa_modref_tree_c_tests (); 274 275 extern int num_passes; 276 277 } /* end of namespace selftest. */ 278 279 /* Macros for writing tests. */ 280 281 /* Evaluate EXPR and coerce to bool, calling 282 ::selftest::pass if it is true, 283 ::selftest::fail if it false. */ 284 285 #define ASSERT_TRUE(EXPR) \ 286 ASSERT_TRUE_AT (SELFTEST_LOCATION, (EXPR)) 287 288 /* Like ASSERT_TRUE, but treat LOC as the effective location of the 289 selftest. */ 290 291 #define ASSERT_TRUE_AT(LOC, EXPR) \ 292 SELFTEST_BEGIN_STMT \ 293 const char *desc_ = "ASSERT_TRUE (" #EXPR ")"; \ 294 bool actual_ = (EXPR); \ 295 if (actual_) \ 296 ::selftest::pass ((LOC), desc_); \ 297 else \ 298 ::selftest::fail ((LOC), desc_); \ 299 SELFTEST_END_STMT 300 301 /* Evaluate EXPR and coerce to bool, calling 302 ::selftest::pass if it is false, 303 ::selftest::fail if it true. */ 304 305 #define ASSERT_FALSE(EXPR) \ 306 ASSERT_FALSE_AT (SELFTEST_LOCATION, (EXPR)) 307 308 /* Like ASSERT_FALSE, but treat LOC as the effective location of the 309 selftest. */ 310 311 #define ASSERT_FALSE_AT(LOC, EXPR) \ 312 SELFTEST_BEGIN_STMT \ 313 const char *desc_ = "ASSERT_FALSE (" #EXPR ")"; \ 314 bool actual_ = (EXPR); \ 315 if (actual_) \ 316 ::selftest::fail ((LOC), desc_); \ 317 else \ 318 ::selftest::pass ((LOC), desc_); \ 319 SELFTEST_END_STMT 320 321 /* Evaluate VAL1 and VAL2 and compare them with ==, calling 322 ::selftest::pass if they are equal, 323 ::selftest::fail if they are non-equal. */ 324 325 #define ASSERT_EQ(VAL1, VAL2) \ 326 ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2)) 327 328 /* Like ASSERT_EQ, but treat LOC as the effective location of the 329 selftest. */ 330 331 #define ASSERT_EQ_AT(LOC, VAL1, VAL2) \ 332 SELFTEST_BEGIN_STMT \ 333 const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \ 334 if ((VAL1) == (VAL2)) \ 335 ::selftest::pass ((LOC), desc_); \ 336 else \ 337 ::selftest::fail ((LOC), desc_); \ 338 SELFTEST_END_STMT 339 340 /* Evaluate VAL1 and VAL2 and compare them with known_eq, calling 341 ::selftest::pass if they are always equal, 342 ::selftest::fail if they might be non-equal. */ 343 344 #define ASSERT_KNOWN_EQ(VAL1, VAL2) \ 345 ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2)) 346 347 /* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the 348 selftest. */ 349 350 #define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2) \ 351 SELFTEST_BEGIN_STMT \ 352 const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")"; \ 353 if (known_eq (VAL1, VAL2)) \ 354 ::selftest::pass ((LOC), desc); \ 355 else \ 356 ::selftest::fail ((LOC), desc); \ 357 SELFTEST_END_STMT 358 359 /* Evaluate VAL1 and VAL2 and compare them with !=, calling 360 ::selftest::pass if they are non-equal, 361 ::selftest::fail if they are equal. */ 362 363 #define ASSERT_NE(VAL1, VAL2) \ 364 SELFTEST_BEGIN_STMT \ 365 const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \ 366 if ((VAL1) != (VAL2)) \ 367 ::selftest::pass (SELFTEST_LOCATION, desc_); \ 368 else \ 369 ::selftest::fail (SELFTEST_LOCATION, desc_); \ 370 SELFTEST_END_STMT 371 372 /* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling 373 ::selftest::pass if they might be non-equal, 374 ::selftest::fail if they are known to be equal. */ 375 376 #define ASSERT_MAYBE_NE(VAL1, VAL2) \ 377 ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2)) 378 379 /* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the 380 selftest. */ 381 382 #define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2) \ 383 SELFTEST_BEGIN_STMT \ 384 const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")"; \ 385 if (maybe_ne (VAL1, VAL2)) \ 386 ::selftest::pass ((LOC), desc); \ 387 else \ 388 ::selftest::fail ((LOC), desc); \ 389 SELFTEST_END_STMT 390 391 /* Evaluate LHS and RHS and compare them with >, calling 392 ::selftest::pass if LHS > RHS, 393 ::selftest::fail otherwise. */ 394 395 #define ASSERT_GT(LHS, RHS) \ 396 ASSERT_GT_AT ((SELFTEST_LOCATION), (LHS), (RHS)) 397 398 /* Like ASSERT_GT, but treat LOC as the effective location of the 399 selftest. */ 400 401 #define ASSERT_GT_AT(LOC, LHS, RHS) \ 402 SELFTEST_BEGIN_STMT \ 403 const char *desc_ = "ASSERT_GT (" #LHS ", " #RHS ")"; \ 404 if ((LHS) > (RHS)) \ 405 ::selftest::pass ((LOC), desc_); \ 406 else \ 407 ::selftest::fail ((LOC), desc_); \ 408 SELFTEST_END_STMT 409 410 /* Evaluate LHS and RHS and compare them with <, calling 411 ::selftest::pass if LHS < RHS, 412 ::selftest::fail otherwise. */ 413 414 #define ASSERT_LT(LHS, RHS) \ 415 ASSERT_LT_AT ((SELFTEST_LOCATION), (LHS), (RHS)) 416 417 /* Like ASSERT_LT, but treat LOC as the effective location of the 418 selftest. */ 419 420 #define ASSERT_LT_AT(LOC, LHS, RHS) \ 421 SELFTEST_BEGIN_STMT \ 422 const char *desc_ = "ASSERT_LT (" #LHS ", " #RHS ")"; \ 423 if ((LHS) < (RHS)) \ 424 ::selftest::pass ((LOC), desc_); \ 425 else \ 426 ::selftest::fail ((LOC), desc_); \ 427 SELFTEST_END_STMT 428 429 /* Evaluate VAL1 and VAL2 and compare them with strcmp, calling 430 ::selftest::pass if they are equal (and both are non-NULL), 431 ::selftest::fail if they are non-equal, or are both NULL. */ 432 433 #define ASSERT_STREQ(VAL1, VAL2) \ 434 SELFTEST_BEGIN_STMT \ 435 ::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \ 436 (VAL1), (VAL2)); \ 437 SELFTEST_END_STMT 438 439 /* Like ASSERT_STREQ, but treat LOC as the effective location of the 440 selftest. */ 441 442 #define ASSERT_STREQ_AT(LOC, VAL1, VAL2) \ 443 SELFTEST_BEGIN_STMT \ 444 ::selftest::assert_streq ((LOC), #VAL1, #VAL2, \ 445 (VAL1), (VAL2)); \ 446 SELFTEST_END_STMT 447 448 /* Evaluate HAYSTACK and NEEDLE and use strstr to determine if NEEDLE 449 is within HAYSTACK. 450 ::selftest::pass if NEEDLE is found. 451 ::selftest::fail if it is not found. */ 452 453 #define ASSERT_STR_CONTAINS(HAYSTACK, NEEDLE) \ 454 SELFTEST_BEGIN_STMT \ 455 ::selftest::assert_str_contains (SELFTEST_LOCATION, #HAYSTACK, #NEEDLE, \ 456 (HAYSTACK), (NEEDLE)); \ 457 SELFTEST_END_STMT 458 459 /* Like ASSERT_STR_CONTAINS, but treat LOC as the effective location of the 460 selftest. */ 461 462 #define ASSERT_STR_CONTAINS_AT(LOC, HAYSTACK, NEEDLE) \ 463 SELFTEST_BEGIN_STMT \ 464 ::selftest::assert_str_contains (LOC, #HAYSTACK, #NEEDLE, \ 465 (HAYSTACK), (NEEDLE)); \ 466 SELFTEST_END_STMT 467 468 /* Evaluate STR and PREFIX and determine if STR starts with PREFIX. 469 ::selftest::pass if STR does start with PREFIX. 470 ::selftest::fail if does not, or either is NULL. */ 471 472 #define ASSERT_STR_STARTSWITH(STR, PREFIX) \ 473 SELFTEST_BEGIN_STMT \ 474 ::selftest::assert_str_startswith (SELFTEST_LOCATION, #STR, #PREFIX, \ 475 (STR), (PREFIX)); \ 476 SELFTEST_END_STMT 477 478 /* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true, 479 ::selftest::fail if it is false. */ 480 481 #define ASSERT_PRED1(PRED1, VAL1) \ 482 SELFTEST_BEGIN_STMT \ 483 const char *desc_ = "ASSERT_PRED1 (" #PRED1 ", " #VAL1 ")"; \ 484 bool actual_ = (PRED1) (VAL1); \ 485 if (actual_) \ 486 ::selftest::pass (SELFTEST_LOCATION, desc_); \ 487 else \ 488 ::selftest::fail (SELFTEST_LOCATION, desc_); \ 489 SELFTEST_END_STMT 490 491 #define SELFTEST_BEGIN_STMT do { 492 #define SELFTEST_END_STMT } while (0) 493 494 #endif /* #if CHECKING_P */ 495 496 #endif /* GCC_SELFTEST_H */ 497