gcc/selftest.h

   1 /* A self-testing framework, for use by -fself-test.
   2    Copyright (C) 2015-2018 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 struct location
  34 {
  35   location (const char *file, int line, const char *function)
  36     : m_file (file), m_line (line), m_function (function) {}
  37
  38   const char *m_file;
  39   int m_line;
  40   const char *m_function;
  41 };
  42
  43 /* A macro for use in selftests and by the ASSERT_ macros below,
  44    constructing a selftest::location for the current source location.  */
  45
  46 #define SELFTEST_LOCATION \
  47   (::selftest::location (__FILE__, __LINE__, __FUNCTION__))
  48
  49 /* The entrypoint for running all tests.  */
  50
  51 extern void run_tests ();
  52
  53 /* Record the successful outcome of some aspect of the test.  */
  54
  55 extern void pass (const location &loc, const char *msg);
  56
  57 /* Report the failed outcome of some aspect of the test and abort.  */
  58
  59 extern void fail (const location &loc, const char *msg)
  60   ATTRIBUTE_NORETURN;
  61
  62 /* As "fail", but using printf-style formatted output.  */
  63
  64 extern void fail_formatted (const location &loc, const char *fmt, ...)
  65   ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN;
  66
  67 /* Implementation detail of ASSERT_STREQ.  */
  68
  69 extern void assert_streq (const location &loc,
  70                           const char *desc_val1, const char *desc_val2,
  71                           const char *val1, const char *val2);
  72
  73 /* Implementation detail of ASSERT_STR_CONTAINS.  */
  74
  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);
  80
  81 /* Implementation detail of ASSERT_STR_STARTSWITH.  */
  82
  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);
  88
  89
  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.  */
  94
  95 class named_temp_file
  96 {
  97  public:
  98   named_temp_file (const char *suffix);
  99   ~named_temp_file ();
 100   const char *get_filename () const { return m_filename; }
 101
 102  private:
 103   char *m_filename;
 104 };
 105
 106 /* A class for writing out a temporary sourcefile for use in selftests
 107    of input handling.  */
 108
 109 class temp_source_file : public named_temp_file
 110 {
 111  public:
 112   temp_source_file (const location &loc, const char *suffix,
 113                     const char *content);
 114 };
 115
 116 /* Various selftests involving location-handling require constructing a
 117    line table and one or more line maps within it.
 118
 119    For maximum test coverage we want to run these tests with a variety
 120    of situations:
 121    - line_table->default_range_bits: some frontends use a non-zero value
 122    and others use zero
 123    - the fallback modes within line-map.c: there are various threshold
 124    values for source_location/location_t beyond line-map.c changes
 125    behavior (disabling of the range-packing optimization, disabling
 126    of column-tracking).  We can exercise these by starting the line_table
 127    at interesting values at or near these thresholds.
 128
 129    The following struct describes a particular case within our test
 130    matrix.  */
 131
 132 struct line_table_case;
 133
 134 /* A class for overriding the global "line_table" within a selftest,
 135    restoring its value afterwards.  At most one instance of this
 136    class can exist at once, due to the need to keep the old value
 137    of line_table as a GC root.  */
 138
 139 class line_table_test
 140 {
 141  public:
 142   /* Default constructor.  Override "line_table", using sane defaults
 143      for the temporary line_table.  */
 144   line_table_test ();
 145
 146   /* Constructor.  Override "line_table", using the case described by C.  */
 147   line_table_test (const line_table_case &c);
 148
 149   /* Destructor.  Restore the saved line_table.  */
 150   ~line_table_test ();
 151 };
 152
 153 /* Run TESTCASE multiple times, once for each case in our test matrix.  */
 154
 155 extern void
 156 for_each_line_table_case (void (*testcase) (const line_table_case &));
 157
 158 /* Read the contents of PATH into memory, returning a 0-terminated buffer
 159    that must be freed by the caller.
 160    Fail (and abort) if there are any problems, with LOC as the reported
 161    location of the failure.  */
 162
 163 extern char *read_file (const location &loc, const char *path);
 164
 165 /* A helper function for writing tests that interact with the
 166    garbage collector.  */
 167
 168 extern void forcibly_ggc_collect ();
 169
 170 /* Convert a path relative to SRCDIR/gcc/testsuite/selftests
 171    to a real path (either absolute, or relative to pwd).
 172    The result should be freed by the caller.  */
 173
 174 extern char *locate_file (const char *path);
 175
 176 /* The path of SRCDIR/testsuite/selftests.  */
 177
 178 extern const char *path_to_selftest_files;
 179
 180 /* selftest::test_runner is an implementation detail of selftest::run_tests,
 181    exposed here to allow plugins to run their own suites of tests.  */
 182
 183 class test_runner
 184 {
 185  public:
 186   test_runner (const char *name);
 187   ~test_runner ();
 188
 189  private:
 190   const char *m_name;
 191   long m_start_time;
 192 };
 193
 194 /* Declarations for specific families of tests (by source file), in
 195    alphabetical order.  */
 196 extern void attribute_c_tests ();
 197 extern void bitmap_c_tests ();
 198 extern void diagnostic_c_tests ();
 199 extern void diagnostic_show_locus_c_tests ();
 200 extern void dumpfile_c_tests ();
 201 extern void edit_context_c_tests ();
 202 extern void et_forest_c_tests ();
 203 extern void fibonacci_heap_c_tests ();
 204 extern void fold_const_c_tests ();
 205 extern void function_tests_c_tests ();
 206 extern void ggc_tests_c_tests ();
 207 extern void gimple_c_tests ();
 208 extern void hash_map_tests_c_tests ();
 209 extern void hash_set_tests_c_tests ();
 210 extern void input_c_tests ();
 211 extern void predict_c_tests ();
 212 extern void pretty_print_c_tests ();
 213 extern void read_rtl_function_c_tests ();
 214 extern void rtl_tests_c_tests ();
 215 extern void sbitmap_c_tests ();
 216 extern void selftest_c_tests ();
 217 extern void simplify_rtx_c_tests ();
 218 extern void spellcheck_c_tests ();
 219 extern void spellcheck_tree_c_tests ();
 220 extern void sreal_c_tests ();
 221 extern void store_merging_c_tests ();
 222 extern void tree_c_tests ();
 223 extern void tree_cfg_c_tests ();
 224 extern void typed_splay_tree_c_tests ();
 225 extern void unique_ptr_tests_cc_tests ();
 226 extern void vec_c_tests ();
 227 extern void vec_perm_indices_c_tests ();
 228 extern void wide_int_cc_tests ();
 229 extern void opt_proposer_c_tests ();
 230
 231 extern int num_passes;
 232
 233 } /* end of namespace selftest.  */
 234
 235 /* Macros for writing tests.  */
 236
 237 /* Evaluate EXPR and coerce to bool, calling
 238    ::selftest::pass if it is true,
 239    ::selftest::fail if it false.  */
 240
 241 #define ASSERT_TRUE(EXPR)                               \
 242   ASSERT_TRUE_AT (SELFTEST_LOCATION, (EXPR))
 243
 244 /* Like ASSERT_TRUE, but treat LOC as the effective location of the
 245    selftest.  */
 246
 247 #define ASSERT_TRUE_AT(LOC, EXPR)                       \
 248   SELFTEST_BEGIN_STMT                                   \
 249   const char *desc_ = "ASSERT_TRUE (" #EXPR ")";        \
 250   bool actual_ = (EXPR);                                \
 251   if (actual_)                                          \
 252     ::selftest::pass ((LOC), desc_);                    \
 253   else                                                  \
 254     ::selftest::fail ((LOC), desc_);                    \
 255   SELFTEST_END_STMT
 256
 257 /* Evaluate EXPR and coerce to bool, calling
 258    ::selftest::pass if it is false,
 259    ::selftest::fail if it true.  */
 260
 261 #define ASSERT_FALSE(EXPR)                                      \
 262   ASSERT_FALSE_AT (SELFTEST_LOCATION, (EXPR))
 263
 264 /* Like ASSERT_FALSE, but treat LOC as the effective location of the
 265    selftest.  */
 266
 267 #define ASSERT_FALSE_AT(LOC, EXPR)                              \
 268   SELFTEST_BEGIN_STMT                                           \
 269   const char *desc_ = "ASSERT_FALSE (" #EXPR ")";               \
 270   bool actual_ = (EXPR);                                        \
 271   if (actual_)                                                  \
 272     ::selftest::fail ((LOC), desc_);                            \
 273   else                                                          \
 274     ::selftest::pass ((LOC), desc_);                            \
 275   SELFTEST_END_STMT
 276
 277 /* Evaluate VAL1 and VAL2 and compare them with ==, calling
 278    ::selftest::pass if they are equal,
 279    ::selftest::fail if they are non-equal.  */
 280
 281 #define ASSERT_EQ(VAL1, VAL2) \
 282   ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
 283
 284 /* Like ASSERT_EQ, but treat LOC as the effective location of the
 285    selftest.  */
 286
 287 #define ASSERT_EQ_AT(LOC, VAL1, VAL2)                  \
 288   SELFTEST_BEGIN_STMT                                          \
 289   const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \
 290   if ((VAL1) == (VAL2))                                \
 291     ::selftest::pass ((LOC), desc_);                           \
 292   else                                                         \
 293     ::selftest::fail ((LOC), desc_);                           \
 294   SELFTEST_END_STMT
 295
 296 /* Evaluate VAL1 and VAL2 and compare them with known_eq, calling
 297    ::selftest::pass if they are always equal,
 298    ::selftest::fail if they might be non-equal.  */
 299
 300 #define ASSERT_KNOWN_EQ(VAL1, VAL2) \
 301   ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
 302
 303 /* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the
 304    selftest.  */
 305
 306 #define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2)                     \
 307   SELFTEST_BEGIN_STMT                                                   \
 308   const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")";  \
 309   if (known_eq (VAL1, VAL2))                                    \
 310     ::selftest::pass ((LOC), desc);                                     \
 311   else                                                                  \
 312     ::selftest::fail ((LOC), desc);                                     \
 313   SELFTEST_END_STMT
 314
 315 /* Evaluate VAL1 and VAL2 and compare them with !=, calling
 316    ::selftest::pass if they are non-equal,
 317    ::selftest::fail if they are equal.  */
 318
 319 #define ASSERT_NE(VAL1, VAL2)                          \
 320   SELFTEST_BEGIN_STMT                                          \
 321   const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \
 322   if ((VAL1) != (VAL2))                                \
 323     ::selftest::pass (SELFTEST_LOCATION, desc_);               \
 324   else                                                         \
 325     ::selftest::fail (SELFTEST_LOCATION, desc_);               \
 326   SELFTEST_END_STMT
 327
 328 /* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling
 329    ::selftest::pass if they might be non-equal,
 330    ::selftest::fail if they are known to be equal.  */
 331
 332 #define ASSERT_MAYBE_NE(VAL1, VAL2) \
 333   ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
 334
 335 /* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the
 336    selftest.  */
 337
 338 #define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2)                     \
 339   SELFTEST_BEGIN_STMT                                                   \
 340   const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")";  \
 341   if (maybe_ne (VAL1, VAL2))                                    \
 342     ::selftest::pass ((LOC), desc);                                     \
 343   else                                                                  \
 344     ::selftest::fail ((LOC), desc);                                     \
 345   SELFTEST_END_STMT
 346
 347 /* Evaluate LHS and RHS and compare them with >, calling
 348    ::selftest::pass if LHS > RHS,
 349    ::selftest::fail otherwise.  */
 350
 351 #define ASSERT_GT(LHS, RHS)                             \
 352   ASSERT_GT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
 353
 354 /* Like ASSERT_GT, but treat LOC as the effective location of the
 355    selftest.  */
 356
 357 #define ASSERT_GT_AT(LOC, LHS, RHS)                    \
 358   SELFTEST_BEGIN_STMT                                          \
 359   const char *desc_ = "ASSERT_GT (" #LHS ", " #RHS ")";        \
 360   if ((LHS) > (RHS))                                           \
 361     ::selftest::pass ((LOC), desc_);                           \
 362   else                                                         \
 363     ::selftest::fail ((LOC), desc_);                           \
 364   SELFTEST_END_STMT
 365
 366 /* Evaluate LHS and RHS and compare them with <, calling
 367    ::selftest::pass if LHS < RHS,
 368    ::selftest::fail otherwise.  */
 369
 370 #define ASSERT_LT(LHS, RHS)                             \
 371   ASSERT_LT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
 372
 373 /* Like ASSERT_LT, but treat LOC as the effective location of the
 374    selftest.  */
 375
 376 #define ASSERT_LT_AT(LOC, LHS, RHS)                    \
 377   SELFTEST_BEGIN_STMT                                          \
 378   const char *desc_ = "ASSERT_LT (" #LHS ", " #RHS ")";        \
 379   if ((LHS) < (RHS))                                           \
 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 strcmp, calling
 386    ::selftest::pass if they are equal (and both are non-NULL),
 387    ::selftest::fail if they are non-equal, or are both NULL.  */
 388
 389 #define ASSERT_STREQ(VAL1, VAL2)                                    \
 390   SELFTEST_BEGIN_STMT                                               \
 391   ::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \
 392                             (VAL1), (VAL2));                \
 393   SELFTEST_END_STMT
 394
 395 /* Like ASSERT_STREQ, but treat LOC as the effective location of the
 396    selftest.  */
 397
 398 #define ASSERT_STREQ_AT(LOC, VAL1, VAL2)                            \
 399   SELFTEST_BEGIN_STMT                                               \
 400   ::selftest::assert_streq ((LOC), #VAL1, #VAL2,                    \
 401                             (VAL1), (VAL2));                \
 402   SELFTEST_END_STMT
 403
 404 /* Evaluate HAYSTACK and NEEDLE and use strstr to determine if NEEDLE
 405    is within HAYSTACK.
 406    ::selftest::pass if NEEDLE is found.
 407    ::selftest::fail if it is not found.  */
 408
 409 #define ASSERT_STR_CONTAINS(HAYSTACK, NEEDLE)                           \
 410   SELFTEST_BEGIN_STMT                                                   \
 411   ::selftest::assert_str_contains (SELFTEST_LOCATION, #HAYSTACK, #NEEDLE, \
 412                                    (HAYSTACK), (NEEDLE));               \
 413   SELFTEST_END_STMT
 414
 415 /* Evaluate STR and PREFIX and determine if STR starts with PREFIX.
 416      ::selftest::pass if STR does start with PREFIX.
 417      ::selftest::fail if does not, or either is NULL.  */
 418
 419 #define ASSERT_STR_STARTSWITH(STR, PREFIX)                                  \
 420   SELFTEST_BEGIN_STMT                                                       \
 421   ::selftest::assert_str_startswith (SELFTEST_LOCATION, #STR, #PREFIX,      \
 422                                      (STR), (PREFIX));                      \
 423   SELFTEST_END_STMT
 424
 425 /* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true,
 426    ::selftest::fail if it is false.  */
 427
 428 #define ASSERT_PRED1(PRED1, VAL1)                               \
 429   SELFTEST_BEGIN_STMT                                           \
 430   const char *desc_ = "ASSERT_PRED1 (" #PRED1 ", " #VAL1 ")";   \
 431   bool actual_ = (PRED1) (VAL1);                                \
 432   if (actual_)                                                  \
 433     ::selftest::pass (SELFTEST_LOCATION, desc_);                \
 434   else                                                          \
 435     ::selftest::fail (SELFTEST_LOCATION, desc_);                \
 436   SELFTEST_END_STMT
 437
 438 #define SELFTEST_BEGIN_STMT do {
 439 #define SELFTEST_END_STMT   } while (0)
 440
 441 #endif /* #if CHECKING_P */
 442
 443 #endif /* GCC_SELFTEST_H */