[thirdparty/glibc.git] / math / libm-test-support.h

/* Support code for testing libm functions (common declarations).
   Copyright (C) 1997-2018 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

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

   The GNU C Library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, see
   <http://www.gnu.org/licenses/>.  */

#ifndef LIBM_TEST_SUPPORT_H
#define LIBM_TEST_SUPPORT_H 1

#include <complex.h>
#include <math.h>
#include <float.h>
#include <fenv.h>
#include <limits.h>

#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <tininess.h>
#include <math-tests.h>
#include <nan-high-order-bit.h>

extern const int flag_test_errno;
extern const int flag_test_exceptions;
extern const int flag_test_finite;
extern const int flag_test_inline;
extern const int flag_test_mathvec;
extern const char test_msg[];
extern const char qtype_str[];
extern const char doc[];

/* Possible exceptions */
#define NO_EXCEPTION			0x0
#define INVALID_EXCEPTION		0x1
#define DIVIDE_BY_ZERO_EXCEPTION	0x2
#define OVERFLOW_EXCEPTION		0x4
#define UNDERFLOW_EXCEPTION		0x8
#define INEXACT_EXCEPTION		0x10
/* The next flags signals that those exceptions are allowed but not required.   */
#define INVALID_EXCEPTION_OK		0x20
#define DIVIDE_BY_ZERO_EXCEPTION_OK	0x40
#define OVERFLOW_EXCEPTION_OK		0x80
#define UNDERFLOW_EXCEPTION_OK		0x100
/* For "inexact" exceptions, the default is allowed but not required
   unless INEXACT_EXCEPTION or NO_INEXACT_EXCEPTION is specified.  */
#define NO_INEXACT_EXCEPTION		0x200
/* Some special test flags, passed together with exceptions.  */
#define IGNORE_ZERO_INF_SIGN		0x400
#define TEST_NAN_SIGN			0x800
#define TEST_NAN_PAYLOAD		0x1000
#define NO_TEST_INLINE			0x2000
#define XFAIL_TEST			0x4000
/* Indicate errno settings required or disallowed.  */
#define ERRNO_UNCHANGED			0x8000
#define ERRNO_EDOM			0x10000
#define ERRNO_ERANGE			0x20000
/* Flags generated by gen-libm-test.pl, not entered here manually.  */
#define IGNORE_RESULT			0x40000
#define NON_FINITE			0x80000
#define TEST_SNAN			0x100000
#define NO_TEST_MATHVEC			0x200000

#define __CONCATX(a,b) __CONCAT(a,b)

#define TYPE_MIN __CONCATX (PREFIX, _MIN)
#define TYPE_TRUE_MIN __CONCATX (PREFIX, _TRUE_MIN)
#define TYPE_MAX __CONCATX (PREFIX, _MAX)
#define MIN_EXP __CONCATX (PREFIX, _MIN_EXP)
#define MAX_EXP __CONCATX (PREFIX, _MAX_EXP)
#define MANT_DIG __CONCATX (PREFIX, _MANT_DIG)

/* Format specific test macros.  */
#define TEST_COND_binary32 (MANT_DIG == 24	\
			    && MIN_EXP == -125	\
			    && MAX_EXP == 128)

#define TEST_COND_binary64 (MANT_DIG == 53	\
			    && MIN_EXP == -1021	\
			    && MAX_EXP == 1024)

#define TEST_COND_binary128 (MANT_DIG == 113		\
			     && MIN_EXP == -16381	\
			     && MAX_EXP == 16384)

#define TEST_COND_ibm128 (MANT_DIG == 106)

#define TEST_COND_intel96 (MANT_DIG == 64	\
			   && MIN_EXP == -16381	\
			   && MAX_EXP == 16384)

#define TEST_COND_m68k96 (MANT_DIG == 64	\
			  && MIN_EXP == -16382	\
			  && MAX_EXP == 16384)

/* The condition ibm128-libgcc is used instead of ibm128 to mark tests
   where in principle the glibc code is OK but the tests fail because
   of limitations of the libgcc support for that format (e.g. GCC bug
   59666, in non-default rounding modes).  */
#define TEST_COND_ibm128_libgcc TEST_COND_ibm128

/* Mark a test as expected to fail for ibm128-libgcc.  This is used
   via XFAIL_ROUNDING_IBM128_LIBGCC, which gen-libm-test.pl transforms
   appropriately for each rounding mode.  */
#define XFAIL_IBM128_LIBGCC (TEST_COND_ibm128_libgcc ? XFAIL_TEST : 0)

/* On some architectures, glibc can be built with compilers that do
   not have suitable built-in functions for setting the payload of a
   _Float128 NaN.  */
#if ((defined __x86_64__ || defined __i386__ || defined __ia64__)	\
     && !__GNUC_PREREQ (7, 0))
# define XFAIL_FLOAT128_PAYLOAD (TEST_COND_binary128 ? XFAIL_TEST : 0)
#else
# define XFAIL_FLOAT128_PAYLOAD 0
#endif

/* Number of bits in NaN payload.  */
#if TEST_COND_ibm128
# define PAYLOAD_DIG (DBL_MANT_DIG - 2)
#else
# define PAYLOAD_DIG (MANT_DIG - 2)
#endif

/* Values underflowing on architectures detecting tininess before
   rounding, but not on those detecting tininess after rounding.  */
#define UNDERFLOW_EXCEPTION_BEFORE_ROUNDING	(TININESS_AFTER_ROUNDING \
						 ? 0			\
						 : UNDERFLOW_EXCEPTION)

#if LONG_MAX == 0x7fffffff
# define TEST_COND_long32	1
# define TEST_COND_long64	0
#else
# define TEST_COND_long32	0
# define TEST_COND_long64	1
#endif
#define TEST_COND_before_rounding	(!TININESS_AFTER_ROUNDING)
#define TEST_COND_after_rounding	TININESS_AFTER_ROUNDING

int enable_test (int);
void init_max_error (const char *, int);
void print_max_error (const char *);
void print_complex_max_error (const char *);
void check_float (const char *, FLOAT, FLOAT, int);
void check_complex (const char *, CFLOAT, CFLOAT, int);
void check_int (const char *, int, int, int);
void check_long (const char *, long int, long int, int);
void check_bool (const char *, int, int, int);
void check_longlong (const char *, long long int, long long int, int);
void check_intmax_t (const char *, intmax_t, intmax_t, int);
void check_uintmax_t (const char *, uintmax_t, uintmax_t, int);
void libm_test_init (int, char **);
int libm_test_finish (void);

#endif /* LIBM_TEST_SUPPORT_H.  */
Commit	Line	Data
3b2f6032	1	/* Support code for testing libm functions (common declarations).
688903eb	2	Copyright (C) 1997-2018 Free Software Foundation, Inc.
3b2f6032 JM	3	This file is part of the GNU C Library.
	4
	5	The GNU C Library is free software; you can redistribute it and/or
	6	modify it under the terms of the GNU Lesser General Public
	7	License as published by the Free Software Foundation; either
	8	version 2.1 of the License, or (at your option) any later version.
	9
	10	The GNU C Library is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	13	Lesser General Public License for more details.
	14
	15	You should have received a copy of the GNU Lesser General Public
	16	License along with the GNU C Library; if not, see
	17	<http://www.gnu.org/licenses/>. */
	18
	19	#ifndef LIBM_TEST_SUPPORT_H
	20	#define LIBM_TEST_SUPPORT_H 1
	21
	22	#include <complex.h>
	23	#include <math.h>
	24	#include <float.h>
	25	#include <fenv.h>
	26	#include <limits.h>
	27
	28	#include <stdlib.h>
	29	#include <stdint.h>
	30	#include <stdio.h>
	31	#include <tininess.h>
	32	#include <math-tests.h>
3b2f6032 JM	33	#include <nan-high-order-bit.h>
	34
	35	extern const int flag_test_errno;
	36	extern const int flag_test_exceptions;
	37	extern const int flag_test_finite;
	38	extern const int flag_test_inline;
	39	extern const int flag_test_mathvec;
	40	extern const char test_msg[];
	41	extern const char qtype_str[];
	42	extern const char doc[];
	43
	44	/* Possible exceptions */
	45	#define NO_EXCEPTION 0x0
	46	#define INVALID_EXCEPTION 0x1
	47	#define DIVIDE_BY_ZERO_EXCEPTION 0x2
	48	#define OVERFLOW_EXCEPTION 0x4
	49	#define UNDERFLOW_EXCEPTION 0x8
	50	#define INEXACT_EXCEPTION 0x10
	51	/* The next flags signals that those exceptions are allowed but not required. */
	52	#define INVALID_EXCEPTION_OK 0x20
	53	#define DIVIDE_BY_ZERO_EXCEPTION_OK 0x40
	54	#define OVERFLOW_EXCEPTION_OK 0x80
	55	#define UNDERFLOW_EXCEPTION_OK 0x100
	56	/* For "inexact" exceptions, the default is allowed but not required
	57	unless INEXACT_EXCEPTION or NO_INEXACT_EXCEPTION is specified. */
	58	#define NO_INEXACT_EXCEPTION 0x200
3b2f6032 JM	59	/* Some special test flags, passed together with exceptions. */
	60	#define IGNORE_ZERO_INF_SIGN 0x400
	61	#define TEST_NAN_SIGN 0x800
	62	#define TEST_NAN_PAYLOAD 0x1000
	63	#define NO_TEST_INLINE 0x2000
	64	#define XFAIL_TEST 0x4000
	65	/* Indicate errno settings required or disallowed. */
	66	#define ERRNO_UNCHANGED 0x8000
	67	#define ERRNO_EDOM 0x10000
	68	#define ERRNO_ERANGE 0x20000
	69	/* Flags generated by gen-libm-test.pl, not entered here manually. */
	70	#define IGNORE_RESULT 0x40000
	71	#define NON_FINITE 0x80000
	72	#define TEST_SNAN 0x100000
	73	#define NO_TEST_MATHVEC 0x200000
	74
	75	#define __CONCATX(a,b) __CONCAT(a,b)
	76
	77	#define TYPE_MIN __CONCATX (PREFIX, _MIN)
	78	#define TYPE_TRUE_MIN __CONCATX (PREFIX, _TRUE_MIN)
	79	#define TYPE_MAX __CONCATX (PREFIX, _MAX)
	80	#define MIN_EXP __CONCATX (PREFIX, _MIN_EXP)
	81	#define MAX_EXP __CONCATX (PREFIX, _MAX_EXP)
	82	#define MANT_DIG __CONCATX (PREFIX, _MANT_DIG)
	83
	84	/* Format specific test macros. */
	85	#define TEST_COND_binary32 (MANT_DIG == 24 \
	86	&& MIN_EXP == -125 \
	87	&& MAX_EXP == 128)
	88
	89	#define TEST_COND_binary64 (MANT_DIG == 53 \
	90	&& MIN_EXP == -1021 \
	91	&& MAX_EXP == 1024)
	92
	93	#define TEST_COND_binary128 (MANT_DIG == 113 \
	94	&& MIN_EXP == -16381 \
	95	&& MAX_EXP == 16384)
	96
	97	#define TEST_COND_ibm128 (MANT_DIG == 106)
	98
	99	#define TEST_COND_intel96 (MANT_DIG == 64 \
	100	&& MIN_EXP == -16381 \
	101	&& MAX_EXP == 16384)
	102
	103	#define TEST_COND_m68k96 (MANT_DIG == 64 \
	104	&& MIN_EXP == -16382 \
	105	&& MAX_EXP == 16384)
	106
	107	/* The condition ibm128-libgcc is used instead of ibm128 to mark tests
	108	where in principle the glibc code is OK but the tests fail because
	109	of limitations of the libgcc support for that format (e.g. GCC bug
	110	59666, in non-default rounding modes). */
	111	#define TEST_COND_ibm128_libgcc TEST_COND_ibm128
	112
	113	/* Mark a test as expected to fail for ibm128-libgcc. This is used
	114	via XFAIL_ROUNDING_IBM128_LIBGCC, which gen-libm-test.pl transforms
	115	appropriately for each rounding mode. */
	116	#define XFAIL_IBM128_LIBGCC (TEST_COND_ibm128_libgcc ? XFAIL_TEST : 0)
	117
c86ed71d JM	118	/* On some architectures, glibc can be built with compilers that do
	119	not have suitable built-in functions for setting the payload of a
	120	_Float128 NaN. */
034e7380 JM	121	#if ((defined __x86_64__ \|\| defined __i386__ \|\| defined __ia64__) \
034e7380 JM	122	&& !__GNUC_PREREQ (7, 0))
c86ed71d JM	123	# define XFAIL_FLOAT128_PAYLOAD (TEST_COND_binary128 ? XFAIL_TEST : 0)
	124	#else
	125	# define XFAIL_FLOAT128_PAYLOAD 0
	126	#endif
	127
3b2f6032 JM	128	/* Number of bits in NaN payload. */
	129	#if TEST_COND_ibm128
	130	# define PAYLOAD_DIG (DBL_MANT_DIG - 2)
	131	#else
	132	# define PAYLOAD_DIG (MANT_DIG - 2)
	133	#endif
	134
3b2f6032 JM	135	/* Values underflowing on architectures detecting tininess before
	136	rounding, but not on those detecting tininess after rounding. */
	137	#define UNDERFLOW_EXCEPTION_BEFORE_ROUNDING (TININESS_AFTER_ROUNDING \
	138	? 0 \
	139	: UNDERFLOW_EXCEPTION)
	140
	141	#if LONG_MAX == 0x7fffffff
	142	# define TEST_COND_long32 1
	143	# define TEST_COND_long64 0
	144	#else
	145	# define TEST_COND_long32 0
	146	# define TEST_COND_long64 1
	147	#endif
	148	#define TEST_COND_before_rounding (!TININESS_AFTER_ROUNDING)
	149	#define TEST_COND_after_rounding TININESS_AFTER_ROUNDING
	150
	151	int enable_test (int);
	152	void init_max_error (const char *, int);
	153	void print_max_error (const char *);
	154	void print_complex_max_error (const char *);
	155	void check_float (const char *, FLOAT, FLOAT, int);
3c023dbf	156	void check_complex (const char *, CFLOAT, CFLOAT, int);
3b2f6032 JM	157	void check_int (const char *, int, int, int);
	158	void check_long (const char *, long int, long int, int);
	159	void check_bool (const char *, int, int, int);
	160	void check_longlong (const char *, long long int, long long int, int);
	161	void check_intmax_t (const char *, intmax_t, intmax_t, int);
	162	void check_uintmax_t (const char *, uintmax_t, uintmax_t, int);
	163	void libm_test_init (int, char **);
	164	int libm_test_finish (void);
	165
	166	#endif /* LIBM_TEST_SUPPORT_H. */