freebsd-skq/lib/msun/tests/test-utils.h
Alex Richardson b424e0038a Improve test messages for msun tests
Also print the mismatched values when numbers compare not equal.

Reviewed By:	dim
Differential Revision: https://reviews.freebsd.org/D29091
2021-03-22 11:55:06 +00:00

204 lines
6.3 KiB
C

/*-
* Copyright (c) 2005-2013 David Schultz <das@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _TEST_UTILS_H_
#define _TEST_UTILS_H_
#include <complex.h>
#include <fenv.h>
#include <float.h>
#include <atf-c.h>
/*
* Implementations are permitted to define additional exception flags
* not specified in the standard, so it is not necessarily true that
* FE_ALL_EXCEPT == ALL_STD_EXCEPT.
*/
#define ALL_STD_EXCEPT (FE_DIVBYZERO | FE_INEXACT | FE_INVALID | \
FE_OVERFLOW | FE_UNDERFLOW)
#define OPT_INVALID (ALL_STD_EXCEPT & ~FE_INVALID)
#define OPT_INEXACT (ALL_STD_EXCEPT & ~FE_INEXACT)
#define FLT_ULP() ldexpl(1.0, 1 - FLT_MANT_DIG)
#define DBL_ULP() ldexpl(1.0, 1 - DBL_MANT_DIG)
#define LDBL_ULP() ldexpl(1.0, 1 - LDBL_MANT_DIG)
/*
* Flags that control the behavior of various fpequal* functions.
* XXX This is messy due to merging various notions of "close enough"
* that are best suited for different functions.
*
* CS_REAL
* CS_IMAG
* CS_BOTH
* (cfpequal_cs, fpequal_tol, cfpequal_tol) Whether to check the sign of
* the real part of the result, the imaginary part, or both.
*
* FPE_ABS_ZERO
* (fpequal_tol, cfpequal_tol) If set, treats the tolerance as an absolute
* tolerance when the expected value is 0. This is useful when there is
* round-off error in the input, e.g., cos(Pi/2) ~= 0.
*/
#define CS_REAL 0x01
#define CS_IMAG 0x02
#define CS_BOTH (CS_REAL | CS_IMAG)
#define FPE_ABS_ZERO 0x04
#ifdef DEBUG
#define debug(...) printf(__VA_ARGS__)
#else
#define debug(...) (void)0
#endif
/*
* XXX The ancient version of gcc in the base system doesn't support CMPLXL,
* but we can fake it most of the time.
*/
#ifndef CMPLXL
static inline long double complex
CMPLXL(long double x, long double y)
{
long double complex z;
__real__ z = x;
__imag__ z = y;
return (z);
}
#endif
/*
* The compiler-rt fp128 builtins do not update FP exceptions.
* See https://llvm.org/PR34126
*/
static int cfpequal(long double complex, long double complex) __used;
/*
* Determine whether x and y are equal, with two special rules:
* +0.0 != -0.0
* NaN == NaN
* If checksign is false, we compare the absolute values instead.
*/
static inline int
fpequal_cs(long double x, long double y, bool checksign)
{
if (isnan(x) && isnan(y))
return (1);
if (checksign)
return (x == y && !signbit(x) == !signbit(y));
else
return (fabsl(x) == fabsl(y));
}
static inline int
fpequal_tol(long double x, long double y, long double tol,
unsigned int flags)
{
fenv_t env;
int ret;
if (isnan(x) && isnan(y))
return (1);
if (!signbit(x) != !signbit(y) && (flags & CS_BOTH))
return (0);
if (x == y)
return (1);
if (tol == 0)
return (0);
/* Hard case: need to check the tolerance. */
feholdexcept(&env);
/*
* For our purposes here, if y=0, we interpret tol as an absolute
* tolerance. This is to account for roundoff in the input, e.g.,
* cos(Pi/2) ~= 0.
*/
if ((flags & FPE_ABS_ZERO) && y == 0.0)
ret = fabsl(x - y) <= fabsl(tol);
else
ret = fabsl(x - y) <= fabsl(y * tol);
fesetenv(&env);
return (ret);
}
#define CHECK_FPEQUAL(x, y) CHECK_FPEQUAL_CS(x, y, true)
#define CHECK_FPEQUAL_CS(x, y, checksign) do { \
long double _x = x; \
long double _y = y; \
ATF_CHECK_MSG(fpequal_cs(_x, _y, checksign), \
"%s (%.25Lg) ~= %s (%.25Lg)", #x, _x, #y, _y); \
} while (0)
#define CHECK_FPEQUAL_TOL(x, y, tol, flags) do { \
long double _x = x; \
long double _y = y; \
bool eq = fpequal_tol(_x, _y, tol, flags); \
long double _diff = eq ? 0.0L : fabsl(_x - _y); \
ATF_CHECK_MSG(eq, "%s (%.25Lg) ~= %s (%.25Lg), diff=%Lg, maxdiff=%Lg,", \
#x, _x, #y, _y, _diff, fabsl(_y * tol)); \
} while (0)
static inline int
cfpequal(long double complex d1, long double complex d2)
{
return (fpequal_cs(creall(d1), creall(d2), true) &&
fpequal_cs(cimagl(d1), cimagl(d2), true));
}
#define CHECK_CFPEQUAL_CS(x, y, checksign) do { \
long double _x = x; \
long double _y = y; \
bool equal_cs = \
fpequal_cs(creal(_x), creal(_y), (checksign & CS_REAL) != 0) && \
fpequal_cs(cimag(_x), cimag(_y), (checksign & CS_IMAG) != 0); \
ATF_CHECK_MSG(equal_cs, "%s (%Lg + %Lg I) ~= %s (%Lg + %Lg I)", \
#x, creall(_x), cimagl(_x), #y, creall(_y), cimagl(_y)); \
} while (0)
#define CHECK_CFPEQUAL_TOL(x, y, tol, flags) do { \
long double _x = x; \
long double _y = y; \
bool equal_tol = (fpequal_tol(creal(_x), creal(_y), tol, flags) && \
fpequal_tol(cimag(_x), cimag(_y), tol, flags)); \
ATF_CHECK_MSG(equal_tol, "%s (%Lg + %Lg I) ~= %s (%Lg + %Lg I)", \
#x, creall(_x), cimagl(_x), #y, creall(_y), cimagl(_y)); \
} while (0)
#define CHECK_FP_EXCEPTIONS(excepts, exceptmask) \
ATF_CHECK_EQ_MSG((excepts), fetestexcept(exceptmask), \
"unexpected exception flags: got %#x not %#x", \
fetestexcept(exceptmask), (excepts))
#define CHECK_FP_EXCEPTIONS_MSG(excepts, exceptmask, fmt, ...) \
ATF_CHECK_EQ_MSG((excepts), fetestexcept(exceptmask), \
"unexpected exception flags: got %#x not %#x " fmt, \
fetestexcept(exceptmask), (excepts), __VA_ARGS__)
#endif /* _TEST_UTILS_H_ */