[thirdparty/gcc.git] / gcc / selftest.h

/* A self-testing framework, for use by -fself-test.
   Copyright (C) 2015-2020 Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */

#ifndef GCC_SELFTEST_H
#define GCC_SELFTEST_H

/* The selftest code should entirely disappear in a production
   configuration, hence we guard all of it with #if CHECKING_P.  */

#if CHECKING_P

namespace selftest {

/* A struct describing the source-location of a selftest, to make it
   easier to track down failing tests.  */

class location
{
public:
  location (const char *file, int line, const char *function)
    : m_file (file), m_line (line), m_function (function) {}

  const char *m_file;
  int m_line;
  const char *m_function;
};

/* A macro for use in selftests and by the ASSERT_ macros below,
   constructing a selftest::location for the current source location.  */

#define SELFTEST_LOCATION \
  (::selftest::location (__FILE__, __LINE__, __FUNCTION__))

/* The entrypoint for running all tests.  */

extern void run_tests ();

/* Record the successful outcome of some aspect of the test.  */

extern void pass (const location &loc, const char *msg);

/* Report the failed outcome of some aspect of the test and abort.  */

extern void fail (const location &loc, const char *msg)
  ATTRIBUTE_NORETURN;

/* As "fail", but using printf-style formatted output.  */

extern void fail_formatted (const location &loc, const char *fmt, ...)
  ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN;

/* Implementation detail of ASSERT_STREQ.  */

extern void assert_streq (const location &loc,
			  const char *desc_val1, const char *desc_val2,
			  const char *val1, const char *val2);

/* Implementation detail of ASSERT_STR_CONTAINS.  */

extern void assert_str_contains (const location &loc,
				 const char *desc_haystack,
				 const char *desc_needle,
				 const char *val_haystack,
				 const char *val_needle);

/* Implementation detail of ASSERT_STR_STARTSWITH.  */

extern void assert_str_startswith (const location &loc,
				   const char *desc_str,
				   const char *desc_prefix,
				   const char *val_str,
				   const char *val_prefix);


/* A named temporary file for use in selftests.
   Usable for writing out files, and as the base class for
   temp_source_file.
   The file is unlinked in the destructor.  */

class named_temp_file
{
 public:
  named_temp_file (const char *suffix);
  ~named_temp_file ();
  const char *get_filename () const { return m_filename; }

 private:
  char *m_filename;
};

/* A class for writing out a temporary sourcefile for use in selftests
   of input handling.  */

class temp_source_file : public named_temp_file
{
 public:
  temp_source_file (const location &loc, const char *suffix,
		    const char *content);
};

/* RAII-style class for avoiding introducing locale-specific differences
   in strings containing localized quote marks, by temporarily overriding
   the "open_quote" and "close_quote" globals to something hardcoded.

   Specifically, the C locale's values are used:
   - open_quote becomes "`"
   - close_quote becomes "'"
   for the lifetime of the object.  */

class auto_fix_quotes
{
 public:
  auto_fix_quotes ();
  ~auto_fix_quotes ();

 private:
  const char *m_saved_open_quote;
  const char *m_saved_close_quote;
};

/* Various selftests involving location-handling require constructing a
   line table and one or more line maps within it.

   For maximum test coverage we want to run these tests with a variety
   of situations:
   - line_table->default_range_bits: some frontends use a non-zero value
   and others use zero
   - the fallback modes within line-map.c: there are various threshold
   values for location_t beyond line-map.c changes
   behavior (disabling of the range-packing optimization, disabling
   of column-tracking).  We can exercise these by starting the line_table
   at interesting values at or near these thresholds.

   The following struct describes a particular case within our test
   matrix.  */

class line_table_case;

/* A class for overriding the global "line_table" within a selftest,
   restoring its value afterwards.  At most one instance of this
   class can exist at once, due to the need to keep the old value
   of line_table as a GC root.  */

class line_table_test
{
 public:
  /* Default constructor.  Override "line_table", using sane defaults
     for the temporary line_table.  */
  line_table_test ();

  /* Constructor.  Override "line_table", using the case described by C.  */
  line_table_test (const line_table_case &c);

  /* Destructor.  Restore the saved line_table.  */
  ~line_table_test ();
};

/* Helper function for selftests that need a function decl.  */

extern tree make_fndecl (tree return_type,
			 const char *name,
			 vec <tree> &param_types,
			 bool is_variadic = false);

/* Run TESTCASE multiple times, once for each case in our test matrix.  */

extern void
for_each_line_table_case (void (*testcase) (const line_table_case &));

/* Read the contents of PATH into memory, returning a 0-terminated buffer
   that must be freed by the caller.
   Fail (and abort) if there are any problems, with LOC as the reported
   location of the failure.  */

extern char *read_file (const location &loc, const char *path);

/* A helper function for writing tests that interact with the
   garbage collector.  */

extern void forcibly_ggc_collect ();

/* Convert a path relative to SRCDIR/gcc/testsuite/selftests
   to a real path (either absolute, or relative to pwd).
   The result should be freed by the caller.  */

extern char *locate_file (const char *path);

/* The path of SRCDIR/testsuite/selftests.  */

extern const char *path_to_selftest_files;

/* selftest::test_runner is an implementation detail of selftest::run_tests,
   exposed here to allow plugins to run their own suites of tests.  */

class test_runner
{
 public:
  test_runner (const char *name);
  ~test_runner ();

 private:
  const char *m_name;
  long m_start_time;
};

/* Declarations for specific families of tests (by source file), in
   alphabetical order.  */
extern void attribute_c_tests ();
extern void bitmap_c_tests ();
extern void cgraph_c_tests ();
extern void convert_c_tests ();
extern void diagnostic_c_tests ();
extern void diagnostic_format_json_cc_tests ();
extern void diagnostic_show_locus_c_tests ();
extern void digraph_cc_tests ();
extern void dumpfile_c_tests ();
extern void edit_context_c_tests ();
extern void et_forest_c_tests ();
extern void fibonacci_heap_c_tests ();
extern void fold_const_c_tests ();
extern void function_tests_c_tests ();
extern void ggc_tests_c_tests ();
extern void gimple_c_tests ();
extern void hash_map_tests_c_tests ();
extern void hash_set_tests_c_tests ();
extern void input_c_tests ();
extern void json_cc_tests ();
extern void opt_problem_cc_tests ();
extern void optinfo_emit_json_cc_tests ();
extern void opts_c_tests ();
extern void ordered_hash_map_tests_cc_tests ();
extern void predict_c_tests ();
extern void pretty_print_c_tests ();
extern void range_tests ();
extern void read_rtl_function_c_tests ();
extern void rtl_tests_c_tests ();
extern void sbitmap_c_tests ();
extern void selftest_c_tests ();
extern void simplify_rtx_c_tests ();
extern void spellcheck_c_tests ();
extern void spellcheck_tree_c_tests ();
extern void sreal_c_tests ();
extern void store_merging_c_tests ();
extern void tree_c_tests ();
extern void tree_cfg_c_tests ();
extern void tree_diagnostic_path_cc_tests ();
extern void tristate_cc_tests ();
extern void typed_splay_tree_c_tests ();
extern void unique_ptr_tests_cc_tests ();
extern void vec_c_tests ();
extern void vec_perm_indices_c_tests ();
extern void wide_int_cc_tests ();
extern void opt_proposer_c_tests ();
extern void dbgcnt_c_tests ();

extern int num_passes;

} /* end of namespace selftest.  */

/* Macros for writing tests.  */

/* Evaluate EXPR and coerce to bool, calling
   ::selftest::pass if it is true,
   ::selftest::fail if it false.  */

#define ASSERT_TRUE(EXPR)				\
  ASSERT_TRUE_AT (SELFTEST_LOCATION, (EXPR))

/* Like ASSERT_TRUE, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_TRUE_AT(LOC, EXPR)			\
  SELFTEST_BEGIN_STMT					\
  const char *desc_ = "ASSERT_TRUE (" #EXPR ")";	\
  bool actual_ = (EXPR);				\
  if (actual_)						\
    ::selftest::pass ((LOC), desc_);			\
  else							\
    ::selftest::fail ((LOC), desc_);			\
  SELFTEST_END_STMT

/* Evaluate EXPR and coerce to bool, calling
   ::selftest::pass if it is false,
   ::selftest::fail if it true.  */

#define ASSERT_FALSE(EXPR)					\
  ASSERT_FALSE_AT (SELFTEST_LOCATION, (EXPR))

/* Like ASSERT_FALSE, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_FALSE_AT(LOC, EXPR)				\
  SELFTEST_BEGIN_STMT						\
  const char *desc_ = "ASSERT_FALSE (" #EXPR ")";		\
  bool actual_ = (EXPR);					\
  if (actual_)							\
    ::selftest::fail ((LOC), desc_);				\
  else								\
    ::selftest::pass ((LOC), desc_);				\
  SELFTEST_END_STMT

/* Evaluate VAL1 and VAL2 and compare them with ==, calling
   ::selftest::pass if they are equal,
   ::selftest::fail if they are non-equal.  */

#define ASSERT_EQ(VAL1, VAL2) \
  ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))

/* Like ASSERT_EQ, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_EQ_AT(LOC, VAL1, VAL2)		       \
  SELFTEST_BEGIN_STMT					       \
  const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \
  if ((VAL1) == (VAL2))				       \
    ::selftest::pass ((LOC), desc_);			       \
  else							       \
    ::selftest::fail ((LOC), desc_);			       \
  SELFTEST_END_STMT

/* Evaluate VAL1 and VAL2 and compare them with known_eq, calling
   ::selftest::pass if they are always equal,
   ::selftest::fail if they might be non-equal.  */

#define ASSERT_KNOWN_EQ(VAL1, VAL2) \
  ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))

/* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2)			\
  SELFTEST_BEGIN_STMT							\
  const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")";	\
  if (known_eq (VAL1, VAL2))					\
    ::selftest::pass ((LOC), desc);					\
  else									\
    ::selftest::fail ((LOC), desc);					\
  SELFTEST_END_STMT

/* Evaluate VAL1 and VAL2 and compare them with !=, calling
   ::selftest::pass if they are non-equal,
   ::selftest::fail if they are equal.  */

#define ASSERT_NE(VAL1, VAL2)			       \
  SELFTEST_BEGIN_STMT					       \
  const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \
  if ((VAL1) != (VAL2))				       \
    ::selftest::pass (SELFTEST_LOCATION, desc_);	       \
  else							       \
    ::selftest::fail (SELFTEST_LOCATION, desc_);	       \
  SELFTEST_END_STMT

/* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling
   ::selftest::pass if they might be non-equal,
   ::selftest::fail if they are known to be equal.  */

#define ASSERT_MAYBE_NE(VAL1, VAL2) \
  ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))

/* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2)			\
  SELFTEST_BEGIN_STMT							\
  const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")";	\
  if (maybe_ne (VAL1, VAL2))					\
    ::selftest::pass ((LOC), desc);					\
  else									\
    ::selftest::fail ((LOC), desc);					\
  SELFTEST_END_STMT

/* Evaluate LHS and RHS and compare them with >, calling
   ::selftest::pass if LHS > RHS,
   ::selftest::fail otherwise.  */

#define ASSERT_GT(LHS, RHS)				\
  ASSERT_GT_AT ((SELFTEST_LOCATION), (LHS), (RHS))

/* Like ASSERT_GT, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_GT_AT(LOC, LHS, RHS)		       \
  SELFTEST_BEGIN_STMT					       \
  const char *desc_ = "ASSERT_GT (" #LHS ", " #RHS ")";	       \
  if ((LHS) > (RHS))					       \
    ::selftest::pass ((LOC), desc_);			       \
  else							       \
    ::selftest::fail ((LOC), desc_);			       \
  SELFTEST_END_STMT

/* Evaluate LHS and RHS and compare them with <, calling
   ::selftest::pass if LHS < RHS,
   ::selftest::fail otherwise.  */

#define ASSERT_LT(LHS, RHS)				\
  ASSERT_LT_AT ((SELFTEST_LOCATION), (LHS), (RHS))

/* Like ASSERT_LT, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_LT_AT(LOC, LHS, RHS)		       \
  SELFTEST_BEGIN_STMT					       \
  const char *desc_ = "ASSERT_LT (" #LHS ", " #RHS ")";	       \
  if ((LHS) < (RHS))					       \
    ::selftest::pass ((LOC), desc_);			       \
  else							       \
    ::selftest::fail ((LOC), desc_);			       \
  SELFTEST_END_STMT

/* Evaluate VAL1 and VAL2 and compare them with strcmp, calling
   ::selftest::pass if they are equal (and both are non-NULL),
   ::selftest::fail if they are non-equal, or are both NULL.  */

#define ASSERT_STREQ(VAL1, VAL2)				    \
  SELFTEST_BEGIN_STMT						    \
  ::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \
			    (VAL1), (VAL2));		    \
  SELFTEST_END_STMT

/* Like ASSERT_STREQ, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_STREQ_AT(LOC, VAL1, VAL2)			    \
  SELFTEST_BEGIN_STMT						    \
  ::selftest::assert_streq ((LOC), #VAL1, #VAL2,		    \
			    (VAL1), (VAL2));		    \
  SELFTEST_END_STMT

/* Evaluate HAYSTACK and NEEDLE and use strstr to determine if NEEDLE
   is within HAYSTACK.
   ::selftest::pass if NEEDLE is found.
   ::selftest::fail if it is not found.  */

#define ASSERT_STR_CONTAINS(HAYSTACK, NEEDLE)				\
  SELFTEST_BEGIN_STMT							\
  ::selftest::assert_str_contains (SELFTEST_LOCATION, #HAYSTACK, #NEEDLE, \
				   (HAYSTACK), (NEEDLE));		\
  SELFTEST_END_STMT

/* Like ASSERT_STR_CONTAINS, but treat LOC as the effective location of the
   selftest.  */

#define ASSERT_STR_CONTAINS_AT(LOC, HAYSTACK, NEEDLE)			\
  SELFTEST_BEGIN_STMT							\
  ::selftest::assert_str_contains (LOC, #HAYSTACK, #NEEDLE,		\
				   (HAYSTACK), (NEEDLE));		\
  SELFTEST_END_STMT

/* Evaluate STR and PREFIX and determine if STR starts with PREFIX.
     ::selftest::pass if STR does start with PREFIX.
     ::selftest::fail if does not, or either is NULL.  */

#define ASSERT_STR_STARTSWITH(STR, PREFIX)				    \
  SELFTEST_BEGIN_STMT							    \
  ::selftest::assert_str_startswith (SELFTEST_LOCATION, #STR, #PREFIX,	    \
				     (STR), (PREFIX));			    \
  SELFTEST_END_STMT

/* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true,
   ::selftest::fail if it is false.  */

#define ASSERT_PRED1(PRED1, VAL1)				\
  SELFTEST_BEGIN_STMT						\
  const char *desc_ = "ASSERT_PRED1 (" #PRED1 ", " #VAL1 ")";	\
  bool actual_ = (PRED1) (VAL1);				\
  if (actual_)							\
    ::selftest::pass (SELFTEST_LOCATION, desc_);		\
  else								\
    ::selftest::fail (SELFTEST_LOCATION, desc_);		\
  SELFTEST_END_STMT

#define SELFTEST_BEGIN_STMT do {
#define SELFTEST_END_STMT   } while (0)

#endif /* #if CHECKING_P */

#endif /* GCC_SELFTEST_H */
Commit	Line	Data
d9b950dd	1	/* A self-testing framework, for use by -fself-test.
8d9254fc	2	Copyright (C) 2015-2020 Free Software Foundation, Inc.
d9b950dd DM	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
09765e3a DM	30	/* A struct describing the source-location of a selftest, to make it
	31	easier to track down failing tests. */
	32
6c1dae73	33	class location
09765e3a	34	{
6c1dae73	35	public:
09765e3a DM	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
d9b950dd DM	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
09765e3a	56	extern void pass (const location &loc, const char *msg);
d9b950dd DM	57
	58	/* Report the failed outcome of some aspect of the test and abort. */
	59
6ac852d1 DM	60	extern void fail (const location &loc, const char *msg)
6ac852d1 DM	61	ATTRIBUTE_NORETURN;
d9b950dd	62
755fa666 DM	63	/* As "fail", but using printf-style formatted output. */
755fa666 DM	64
09765e3a	65	extern void fail_formatted (const location &loc, const char *fmt, ...)
6ac852d1	66	ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN;
755fa666 DM	67
	68	/* Implementation detail of ASSERT_STREQ. */
	69
09765e3a	70	extern void assert_streq (const location &loc,
47ae164c DM	71	const char desc_val1, const char desc_val2,
47ae164c DM	72	const char val1, const char val2);
755fa666	73
9f589786 DM	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
d86c7648 ML	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
4ecfc453 DM	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. */
eb3a5bcc	95
4ecfc453	96	class named_temp_file
eb3a5bcc DM	97	{
eb3a5bcc DM	98	public:
4ecfc453 DM	99	named_temp_file (const char *suffix);
4ecfc453 DM	100	~named_temp_file ();
eb3a5bcc DM	101	const char *get_filename () const { return m_filename; }
	102
	103	private:
	104	char *m_filename;
	105	};
	106
4ecfc453 DM	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
dbf96d49 DM	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
f87e22c5 DM	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
620e594b	145	values for location_t beyond line-map.c changes
f87e22c5 DM	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
99b1c316	153	class line_table_case;
f87e22c5 DM	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
0230c897 DM	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> &param_types,
	179	bool is_variadic = false);
	180
f87e22c5 DM	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
7d37ffee DM	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
6c3b5bf0 DM	193	/* A helper function for writing tests that interact with the
	194	garbage collector. */
	195
	196	extern void forcibly_ggc_collect ();
	197
ecfc21ff DM	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
421b29d6 DM	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
d9b950dd DM	222	/* Declarations for specific families of tests (by source file), in
d9b950dd DM	223	alphabetical order. */
5d9ae53d	224	extern void attribute_c_tests ();
d9b950dd	225	extern void bitmap_c_tests ();
212755ff	226	extern void cgraph_c_tests ();
dfd7fdca	227	extern void convert_c_tests ();
a93eac6a	228	extern void diagnostic_c_tests ();
30d3ba51	229	extern void diagnostic_format_json_cc_tests ();
d9b950dd	230	extern void diagnostic_show_locus_c_tests ();
757bf1df	231	extern void digraph_cc_tests ();
4f5b9c80	232	extern void dumpfile_c_tests ();
c65236d6	233	extern void edit_context_c_tests ();
d9b950dd	234	extern void et_forest_c_tests ();
ba1a7a0f	235	extern void fibonacci_heap_c_tests ();
2099cb2d	236	extern void fold_const_c_tests ();
d9b950dd	237	extern void function_tests_c_tests ();
8c4294b2	238	extern void ggc_tests_c_tests ();
2099cb2d	239	extern void gimple_c_tests ();
d9b950dd DM	240	extern void hash_map_tests_c_tests ();
	241	extern void hash_set_tests_c_tests ();
	242	extern void input_c_tests ();
4a4412b9	243	extern void json_cc_tests ();
f4ebbd24	244	extern void opt_problem_cc_tests ();
4a4412b9	245	extern void optinfo_emit_json_cc_tests ();
fa29cf0c	246	extern void opts_c_tests ();
757bf1df	247	extern void ordered_hash_map_tests_cc_tests ();
2099cb2d	248	extern void predict_c_tests ();
4ccab56d	249	extern void pretty_print_c_tests ();
f1471317	250	extern void range_tests ();
51b86113	251	extern void read_rtl_function_c_tests ();
d9b950dd	252	extern void rtl_tests_c_tests ();
2099cb2d	253	extern void sbitmap_c_tests ();
5714dbda	254	extern void selftest_c_tests ();
2099cb2d	255	extern void simplify_rtx_c_tests ();
d9b950dd	256	extern void spellcheck_c_tests ();
f254671f	257	extern void spellcheck_tree_c_tests ();
dcbdb17a	258	extern void sreal_c_tests ();
c22d8787	259	extern void store_merging_c_tests ();
d9b950dd DM	260	extern void tree_c_tests ();
d9b950dd DM	261	extern void tree_cfg_c_tests ();
4bc1899b	262	extern void tree_diagnostic_path_cc_tests ();
757bf1df	263	extern void tristate_cc_tests ();
2099cb2d	264	extern void typed_splay_tree_c_tests ();
46d2b77d	265	extern void unique_ptr_tests_cc_tests ();
d9b950dd	266	extern void vec_c_tests ();
1a1c441d	267	extern void vec_perm_indices_c_tests ();
2099cb2d	268	extern void wide_int_cc_tests ();
d86c7648	269	extern void opt_proposer_c_tests ();
5024c8bb	270	extern void dbgcnt_c_tests ();
d9b950dd DM	271
	272	extern 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) \
d4f7837c DM	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) \
d9b950dd	289	SELFTEST_BEGIN_STMT \
a0e7e36e RS	290	const char *desc_ = "ASSERT_TRUE (" #EXPR ")"; \
	291	bool actual_ = (EXPR); \
	292	if (actual_) \
	293	::selftest::pass ((LOC), desc_); \
d9b950dd	294	else \
a0e7e36e	295	::selftest::fail ((LOC), desc_); \
d9b950dd DM	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) \
d4f7837c DM	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) \
d9b950dd	309	SELFTEST_BEGIN_STMT \
a0e7e36e RS	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_); \
d9b950dd DM	316	SELFTEST_END_STMT
d9b950dd DM	317
47ae164c	318	/* Evaluate VAL1 and VAL2 and compare them with ==, calling
d9b950dd DM	319	::selftest::pass if they are equal,
	320	::selftest::fail if they are non-equal. */
	321
47ae164c DM	322	#define ASSERT_EQ(VAL1, VAL2) \
47ae164c DM	323	ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
741d3be5 DM	324
	325	/* Like ASSERT_EQ, but treat LOC as the effective location of the
	326	selftest. */
	327
47ae164c	328	#define ASSERT_EQ_AT(LOC, VAL1, VAL2) \
d9b950dd	329	SELFTEST_BEGIN_STMT \
47ae164c DM	330	const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \
47ae164c DM	331	if ((VAL1) == (VAL2)) \
a0e7e36e	332	::selftest::pass ((LOC), desc_); \
d9b950dd	333	else \
a0e7e36e	334	::selftest::fail ((LOC), desc_); \
d9b950dd DM	335	SELFTEST_END_STMT
d9b950dd DM	336
47ae164c	337	/* Evaluate VAL1 and VAL2 and compare them with known_eq, calling
e535b963 RS	338	::selftest::pass if they are always equal,
	339	::selftest::fail if they might be non-equal. */
	340
47ae164c DM	341	#define ASSERT_KNOWN_EQ(VAL1, VAL2) \
47ae164c DM	342	ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
e535b963 RS	343
	344	/* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the
	345	selftest. */
	346
47ae164c	347	#define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2) \
e535b963	348	SELFTEST_BEGIN_STMT \
47ae164c DM	349	const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")"; \
47ae164c DM	350	if (known_eq (VAL1, VAL2)) \
e535b963 RS	351	::selftest::pass ((LOC), desc); \
	352	else \
	353	::selftest::fail ((LOC), desc); \
	354	SELFTEST_END_STMT
	355
47ae164c	356	/* Evaluate VAL1 and VAL2 and compare them with !=, calling
d9b950dd DM	357	::selftest::pass if they are non-equal,
	358	::selftest::fail if they are equal. */
	359
47ae164c	360	#define ASSERT_NE(VAL1, VAL2) \
d9b950dd	361	SELFTEST_BEGIN_STMT \
47ae164c DM	362	const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \
47ae164c DM	363	if ((VAL1) != (VAL2)) \
a0e7e36e	364	::selftest::pass (SELFTEST_LOCATION, desc_); \
d9b950dd	365	else \
a0e7e36e	366	::selftest::fail (SELFTEST_LOCATION, desc_); \
d9b950dd DM	367	SELFTEST_END_STMT
d9b950dd DM	368
47ae164c	369	/* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling
e535b963 RS	370	::selftest::pass if they might be non-equal,
	371	::selftest::fail if they are known to be equal. */
	372
47ae164c DM	373	#define ASSERT_MAYBE_NE(VAL1, VAL2) \
47ae164c DM	374	ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
e535b963 RS	375
	376	/* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the
	377	selftest. */
	378
47ae164c	379	#define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2) \
e535b963	380	SELFTEST_BEGIN_STMT \
47ae164c DM	381	const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")"; \
47ae164c DM	382	if (maybe_ne (VAL1, VAL2)) \
e535b963 RS	383	::selftest::pass ((LOC), desc); \
	384	else \
	385	::selftest::fail ((LOC), desc); \
	386	SELFTEST_END_STMT
	387
082284da DM	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
47ae164c DM	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. */
d9b950dd	429
47ae164c	430	#define ASSERT_STREQ(VAL1, VAL2) \
755fa666	431	SELFTEST_BEGIN_STMT \
47ae164c DM	432	::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \
47ae164c DM	433	(VAL1), (VAL2)); \
09765e3a DM	434	SELFTEST_END_STMT
09765e3a DM	435
d4f7837c	436	/* Like ASSERT_STREQ, but treat LOC as the effective location of the
09765e3a DM	437	selftest. */
09765e3a DM	438
47ae164c	439	#define ASSERT_STREQ_AT(LOC, VAL1, VAL2) \
09765e3a	440	SELFTEST_BEGIN_STMT \
47ae164c DM	441	::selftest::assert_streq ((LOC), #VAL1, #VAL2, \
47ae164c DM	442	(VAL1), (VAL2)); \
d9b950dd DM	443	SELFTEST_END_STMT
d9b950dd DM	444
9f589786 DM	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)); \
3da39f52 DM	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)); \
9f589786 DM	463	SELFTEST_END_STMT
9f589786 DM	464
d86c7648 ML	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
d9b950dd DM	475	/* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true,
	476	::selftest::fail if it is false. */
	477
a0e7e36e RS	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_); \
d9b950dd DM	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 */