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

/* A self-testing framework, for use by -fself-test.
   Copyright (C) 2015-2018 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.  */

struct location
{
  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.  */

struct 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 ();
};

/* 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_show_locus_c_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 predict_c_tests ();
extern void pretty_print_c_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 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 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
99b4f3a2	1	/* A self-testing framework, for use by -fself-test.
8e8f6434	2	Copyright (C) 2015-2018 Free Software Foundation, Inc.
99b4f3a2	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
d0982399	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
99b4f3a2	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
d0982399	55	extern void pass (const location &loc, const char *msg);
99b4f3a2	56
	57	/* Report the failed outcome of some aspect of the test and abort. */
	58
17437807	59	extern void fail (const location &loc, const char *msg)
17437807	60	ATTRIBUTE_NORETURN;
99b4f3a2	61
69ffa179	62	/* As "fail", but using printf-style formatted output. */
69ffa179	63
d0982399	64	extern void fail_formatted (const location &loc, const char *fmt, ...)
17437807	65	ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN;
69ffa179	66
	67	/* Implementation detail of ASSERT_STREQ. */
	68
d0982399	69	extern void assert_streq (const location &loc,
1f9995dc	70	const char desc_val1, const char desc_val2,
1f9995dc	71	const char val1, const char val2);
69ffa179	72
c3e800b9	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
6e8a18d1	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
b99fc6a1	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. */
9a02e392	94
b99fc6a1	95	class named_temp_file
9a02e392	96	{
9a02e392	97	public:
b99fc6a1	98	named_temp_file (const char *suffix);
b99fc6a1	99	~named_temp_file ();
9a02e392	100	const char *get_filename () const { return m_filename; }
	101
	102	private:
	103	char *m_filename;
	104	};
	105
b99fc6a1	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
00f7ba03	116	/* RAII-style class for avoiding introducing locale-specific differences
	117	in strings containing localized quote marks, by temporarily overriding
	118	the "open_quote" and "close_quote" globals to something hardcoded.
	119
	120	Specifically, the C locale's values are used:
	121	- open_quote becomes "`"
	122	- close_quote becomes "'"
	123	for the lifetime of the object. */
	124
	125	class auto_fix_quotes
	126	{
	127	public:
	128	auto_fix_quotes ();
	129	~auto_fix_quotes ();
	130
	131	private:
	132	const char *m_saved_open_quote;
	133	const char *m_saved_close_quote;
	134	};
	135
7ec388ed	136	/* Various selftests involving location-handling require constructing a
	137	line table and one or more line maps within it.
	138
	139	For maximum test coverage we want to run these tests with a variety
	140	of situations:
	141	- line_table->default_range_bits: some frontends use a non-zero value
	142	and others use zero
	143	- the fallback modes within line-map.c: there are various threshold
be1e7283	144	values for location_t beyond line-map.c changes
7ec388ed	145	behavior (disabling of the range-packing optimization, disabling
	146	of column-tracking). We can exercise these by starting the line_table
	147	at interesting values at or near these thresholds.
	148
	149	The following struct describes a particular case within our test
	150	matrix. */
	151
	152	struct line_table_case;
	153
	154	/* A class for overriding the global "line_table" within a selftest,
	155	restoring its value afterwards. At most one instance of this
	156	class can exist at once, due to the need to keep the old value
	157	of line_table as a GC root. */
	158
	159	class line_table_test
	160	{
	161	public:
	162	/* Default constructor. Override "line_table", using sane defaults
	163	for the temporary line_table. */
	164	line_table_test ();
	165
	166	/* Constructor. Override "line_table", using the case described by C. */
	167	line_table_test (const line_table_case &c);
	168
	169	/* Destructor. Restore the saved line_table. */
	170	~line_table_test ();
	171	};
	172
	173	/* Run TESTCASE multiple times, once for each case in our test matrix. */
	174
	175	extern void
	176	for_each_line_table_case (void (*testcase) (const line_table_case &));
	177
76a53b26	178	/* Read the contents of PATH into memory, returning a 0-terminated buffer
	179	that must be freed by the caller.
	180	Fail (and abort) if there are any problems, with LOC as the reported
	181	location of the failure. */
	182
	183	extern char read_file (const location &loc, const char path);
	184
09c2dc4c	185	/* A helper function for writing tests that interact with the
	186	garbage collector. */
	187
	188	extern void forcibly_ggc_collect ();
	189
c081d2fc	190	/* Convert a path relative to SRCDIR/gcc/testsuite/selftests
	191	to a real path (either absolute, or relative to pwd).
	192	The result should be freed by the caller. */
	193
	194	extern char locate_file (const char path);
	195
	196	/* The path of SRCDIR/testsuite/selftests. */
	197
	198	extern const char *path_to_selftest_files;
	199
d2c67796	200	/* selftest::test_runner is an implementation detail of selftest::run_tests,
	201	exposed here to allow plugins to run their own suites of tests. */
	202
	203	class test_runner
	204	{
	205	public:
	206	test_runner (const char *name);
	207	~test_runner ();
	208
	209	private:
	210	const char *m_name;
	211	long m_start_time;
	212	};
	213
99b4f3a2	214	/* Declarations for specific families of tests (by source file), in
99b4f3a2	215	alphabetical order. */
dab0e385	216	extern void attribute_c_tests ();
99b4f3a2	217	extern void bitmap_c_tests ();
564850b9	218	extern void cgraph_c_tests ();
d582d140	219	extern void convert_c_tests ();
6628b04d	220	extern void diagnostic_c_tests ();
99b4f3a2	221	extern void diagnostic_show_locus_c_tests ();
c309657f	222	extern void dumpfile_c_tests ();
fe066ce3	223	extern void edit_context_c_tests ();
99b4f3a2	224	extern void et_forest_c_tests ();
77ddb3e5	225	extern void fibonacci_heap_c_tests ();
773f4004	226	extern void fold_const_c_tests ();
99b4f3a2	227	extern void function_tests_c_tests ();
f61d7248	228	extern void ggc_tests_c_tests ();
773f4004	229	extern void gimple_c_tests ();
99b4f3a2	230	extern void hash_map_tests_c_tests ();
	231	extern void hash_set_tests_c_tests ();
	232	extern void input_c_tests ();
9dcf2a11	233	extern void json_cc_tests ();
ed9370cc	234	extern void opt_problem_cc_tests ();
9dcf2a11	235	extern void optinfo_emit_json_cc_tests ();
773f4004	236	extern void predict_c_tests ();
bccee643	237	extern void pretty_print_c_tests ();
836c1c68	238	extern void read_rtl_function_c_tests ();
99b4f3a2	239	extern void rtl_tests_c_tests ();
773f4004	240	extern void sbitmap_c_tests ();
363d8665	241	extern void selftest_c_tests ();
773f4004	242	extern void simplify_rtx_c_tests ();
99b4f3a2	243	extern void spellcheck_c_tests ();
819cba30	244	extern void spellcheck_tree_c_tests ();
f5b88ba1	245	extern void sreal_c_tests ();
3d9a2fb3	246	extern void store_merging_c_tests ();
99b4f3a2	247	extern void tree_c_tests ();
99b4f3a2	248	extern void tree_cfg_c_tests ();
773f4004	249	extern void typed_splay_tree_c_tests ();
b6b04a7b	250	extern void unique_ptr_tests_cc_tests ();
99b4f3a2	251	extern void vec_c_tests ();
f63c1cff	252	extern void vec_perm_indices_c_tests ();
773f4004	253	extern void wide_int_cc_tests ();
6e8a18d1	254	extern void opt_proposer_c_tests ();
99b4f3a2	255
	256	extern int num_passes;
	257
	258	} /* end of namespace selftest. */
	259
	260	/* Macros for writing tests. */
	261
	262	/* Evaluate EXPR and coerce to bool, calling
	263	::selftest::pass if it is true,
	264	::selftest::fail if it false. */
	265
	266	#define ASSERT_TRUE(EXPR) \
30678d42	267	ASSERT_TRUE_AT (SELFTEST_LOCATION, (EXPR))
	268
	269	/* Like ASSERT_TRUE, but treat LOC as the effective location of the
	270	selftest. */
	271
	272	#define ASSERT_TRUE_AT(LOC, EXPR) \
99b4f3a2	273	SELFTEST_BEGIN_STMT \
d7e88239	274	const char *desc_ = "ASSERT_TRUE (" #EXPR ")"; \
	275	bool actual_ = (EXPR); \
	276	if (actual_) \
	277	::selftest::pass ((LOC), desc_); \
99b4f3a2	278	else \
d7e88239	279	::selftest::fail ((LOC), desc_); \
99b4f3a2	280	SELFTEST_END_STMT
	281
	282	/* Evaluate EXPR and coerce to bool, calling
	283	::selftest::pass if it is false,
	284	::selftest::fail if it true. */
	285
	286	#define ASSERT_FALSE(EXPR) \
30678d42	287	ASSERT_FALSE_AT (SELFTEST_LOCATION, (EXPR))
	288
	289	/* Like ASSERT_FALSE, but treat LOC as the effective location of the
	290	selftest. */
	291
	292	#define ASSERT_FALSE_AT(LOC, EXPR) \
99b4f3a2	293	SELFTEST_BEGIN_STMT \
d7e88239	294	const char *desc_ = "ASSERT_FALSE (" #EXPR ")"; \
	295	bool actual_ = (EXPR); \
	296	if (actual_) \
	297	::selftest::fail ((LOC), desc_); \
	298	else \
	299	::selftest::pass ((LOC), desc_); \
99b4f3a2	300	SELFTEST_END_STMT
99b4f3a2	301
1f9995dc	302	/* Evaluate VAL1 and VAL2 and compare them with ==, calling
99b4f3a2	303	::selftest::pass if they are equal,
	304	::selftest::fail if they are non-equal. */
	305
1f9995dc	306	#define ASSERT_EQ(VAL1, VAL2) \
1f9995dc	307	ASSERT_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
b73690a4	308
	309	/* Like ASSERT_EQ, but treat LOC as the effective location of the
	310	selftest. */
	311
1f9995dc	312	#define ASSERT_EQ_AT(LOC, VAL1, VAL2) \
99b4f3a2	313	SELFTEST_BEGIN_STMT \
1f9995dc	314	const char *desc_ = "ASSERT_EQ (" #VAL1 ", " #VAL2 ")"; \
1f9995dc	315	if ((VAL1) == (VAL2)) \
d7e88239	316	::selftest::pass ((LOC), desc_); \
99b4f3a2	317	else \
d7e88239	318	::selftest::fail ((LOC), desc_); \
99b4f3a2	319	SELFTEST_END_STMT
99b4f3a2	320
1f9995dc	321	/* Evaluate VAL1 and VAL2 and compare them with known_eq, calling
466432a3	322	::selftest::pass if they are always equal,
	323	::selftest::fail if they might be non-equal. */
	324
1f9995dc	325	#define ASSERT_KNOWN_EQ(VAL1, VAL2) \
1f9995dc	326	ASSERT_KNOWN_EQ_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
466432a3	327
	328	/* Like ASSERT_KNOWN_EQ, but treat LOC as the effective location of the
	329	selftest. */
	330
1f9995dc	331	#define ASSERT_KNOWN_EQ_AT(LOC, VAL1, VAL2) \
466432a3	332	SELFTEST_BEGIN_STMT \
1f9995dc	333	const char *desc = "ASSERT_KNOWN_EQ (" #VAL1 ", " #VAL2 ")"; \
1f9995dc	334	if (known_eq (VAL1, VAL2)) \
466432a3	335	::selftest::pass ((LOC), desc); \
	336	else \
	337	::selftest::fail ((LOC), desc); \
	338	SELFTEST_END_STMT
	339
1f9995dc	340	/* Evaluate VAL1 and VAL2 and compare them with !=, calling
99b4f3a2	341	::selftest::pass if they are non-equal,
	342	::selftest::fail if they are equal. */
	343
1f9995dc	344	#define ASSERT_NE(VAL1, VAL2) \
99b4f3a2	345	SELFTEST_BEGIN_STMT \
1f9995dc	346	const char *desc_ = "ASSERT_NE (" #VAL1 ", " #VAL2 ")"; \
1f9995dc	347	if ((VAL1) != (VAL2)) \
d7e88239	348	::selftest::pass (SELFTEST_LOCATION, desc_); \
99b4f3a2	349	else \
d7e88239	350	::selftest::fail (SELFTEST_LOCATION, desc_); \
99b4f3a2	351	SELFTEST_END_STMT
99b4f3a2	352
1f9995dc	353	/* Evaluate VAL1 and VAL2 and compare them with maybe_ne, calling
466432a3	354	::selftest::pass if they might be non-equal,
	355	::selftest::fail if they are known to be equal. */
	356
1f9995dc	357	#define ASSERT_MAYBE_NE(VAL1, VAL2) \
1f9995dc	358	ASSERT_MAYBE_NE_AT ((SELFTEST_LOCATION), (VAL1), (VAL2))
466432a3	359
	360	/* Like ASSERT_MAYBE_NE, but treat LOC as the effective location of the
	361	selftest. */
	362
1f9995dc	363	#define ASSERT_MAYBE_NE_AT(LOC, VAL1, VAL2) \
466432a3	364	SELFTEST_BEGIN_STMT \
1f9995dc	365	const char *desc = "ASSERT_MAYBE_NE (" #VAL1 ", " #VAL2 ")"; \
1f9995dc	366	if (maybe_ne (VAL1, VAL2)) \
466432a3	367	::selftest::pass ((LOC), desc); \
	368	else \
	369	::selftest::fail ((LOC), desc); \
	370	SELFTEST_END_STMT
	371
d73881b0	372	/* Evaluate LHS and RHS and compare them with >, calling
	373	::selftest::pass if LHS > RHS,
	374	::selftest::fail otherwise. */
	375
	376	#define ASSERT_GT(LHS, RHS) \
	377	ASSERT_GT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
	378
	379	/* Like ASSERT_GT, but treat LOC as the effective location of the
	380	selftest. */
	381
	382	#define ASSERT_GT_AT(LOC, LHS, RHS) \
	383	SELFTEST_BEGIN_STMT \
	384	const char *desc_ = "ASSERT_GT (" #LHS ", " #RHS ")"; \
	385	if ((LHS) > (RHS)) \
	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_LT(LHS, RHS) \
	396	ASSERT_LT_AT ((SELFTEST_LOCATION), (LHS), (RHS))
	397
	398	/* Like ASSERT_LT, but treat LOC as the effective location of the
	399	selftest. */
	400
	401	#define ASSERT_LT_AT(LOC, LHS, RHS) \
	402	SELFTEST_BEGIN_STMT \
	403	const char *desc_ = "ASSERT_LT (" #LHS ", " #RHS ")"; \
	404	if ((LHS) < (RHS)) \
	405	::selftest::pass ((LOC), desc_); \
	406	else \
	407	::selftest::fail ((LOC), desc_); \
	408	SELFTEST_END_STMT
	409
1f9995dc	410	/* Evaluate VAL1 and VAL2 and compare them with strcmp, calling
	411	::selftest::pass if they are equal (and both are non-NULL),
	412	::selftest::fail if they are non-equal, or are both NULL. */
99b4f3a2	413
1f9995dc	414	#define ASSERT_STREQ(VAL1, VAL2) \
69ffa179	415	SELFTEST_BEGIN_STMT \
1f9995dc	416	::selftest::assert_streq (SELFTEST_LOCATION, #VAL1, #VAL2, \
1f9995dc	417	(VAL1), (VAL2)); \
d0982399	418	SELFTEST_END_STMT
d0982399	419
30678d42	420	/* Like ASSERT_STREQ, but treat LOC as the effective location of the
d0982399	421	selftest. */
d0982399	422
1f9995dc	423	#define ASSERT_STREQ_AT(LOC, VAL1, VAL2) \
d0982399	424	SELFTEST_BEGIN_STMT \
1f9995dc	425	::selftest::assert_streq ((LOC), #VAL1, #VAL2, \
1f9995dc	426	(VAL1), (VAL2)); \
99b4f3a2	427	SELFTEST_END_STMT
99b4f3a2	428
c3e800b9	429	/* Evaluate HAYSTACK and NEEDLE and use strstr to determine if NEEDLE
	430	is within HAYSTACK.
	431	::selftest::pass if NEEDLE is found.
	432	::selftest::fail if it is not found. */
	433
	434	#define ASSERT_STR_CONTAINS(HAYSTACK, NEEDLE) \
	435	SELFTEST_BEGIN_STMT \
	436	::selftest::assert_str_contains (SELFTEST_LOCATION, #HAYSTACK, #NEEDLE, \
	437	(HAYSTACK), (NEEDLE)); \
e43345c1	438	SELFTEST_END_STMT
	439
	440	/* Like ASSERT_STR_CONTAINS, but treat LOC as the effective location of the
	441	selftest. */
	442
	443	#define ASSERT_STR_CONTAINS_AT(LOC, HAYSTACK, NEEDLE) \
	444	SELFTEST_BEGIN_STMT \
	445	::selftest::assert_str_contains (LOC, #HAYSTACK, #NEEDLE, \
	446	(HAYSTACK), (NEEDLE)); \
c3e800b9	447	SELFTEST_END_STMT
c3e800b9	448
6e8a18d1	449	/* Evaluate STR and PREFIX and determine if STR starts with PREFIX.
	450	::selftest::pass if STR does start with PREFIX.
	451	::selftest::fail if does not, or either is NULL. */
	452
	453	#define ASSERT_STR_STARTSWITH(STR, PREFIX) \
	454	SELFTEST_BEGIN_STMT \
	455	::selftest::assert_str_startswith (SELFTEST_LOCATION, #STR, #PREFIX, \
	456	(STR), (PREFIX)); \
	457	SELFTEST_END_STMT
	458
99b4f3a2	459	/* Evaluate PRED1 (VAL1), calling ::selftest::pass if it is true,
	460	::selftest::fail if it is false. */
	461
d7e88239	462	#define ASSERT_PRED1(PRED1, VAL1) \
	463	SELFTEST_BEGIN_STMT \
	464	const char *desc_ = "ASSERT_PRED1 (" #PRED1 ", " #VAL1 ")"; \
	465	bool actual_ = (PRED1) (VAL1); \
	466	if (actual_) \
	467	::selftest::pass (SELFTEST_LOCATION, desc_); \
	468	else \
	469	::selftest::fail (SELFTEST_LOCATION, desc_); \
99b4f3a2	470	SELFTEST_END_STMT
	471
	472	#define SELFTEST_BEGIN_STMT do {
	473	#define SELFTEST_END_STMT } while (0)
	474
	475	#endif /* #if CHECKING_P */
	476
	477	#endif /* GCC_SELFTEST_H */