xref: /freebsd/lib/msun/tests/next_test.c (revision e2afbc45258f2fa4bdcf126e959ac660e76fc802)
1 /*-
2  * Copyright (c) 2005 David Schultz <das@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 /*
28  * Test the correctness of nextafter{,f,l} and nexttoward{,f,l}.
29  */
30 
31 #include <sys/cdefs.h>
32 #include <fenv.h>
33 #include <float.h>
34 #include <math.h>
35 #include <stdio.h>
36 #include <stdlib.h>
37 
38 #ifdef	__i386__
39 #include <ieeefp.h>
40 #endif
41 
42 #include "test-utils.h"
43 
44 #define	test(exp, ans, ex)	do {			\
45 	double __ans = (ans);				\
46 	feclearexcept(ALL_STD_EXCEPT);			\
47 	_testl(#exp, __LINE__, (exp), __ans, (ex));	\
48 } while (0)
49 #define	testf(exp, ans, ex)	do {			\
50 	float __ans = (ans);				\
51 	feclearexcept(ALL_STD_EXCEPT);			\
52 	_testl(#exp, __LINE__, (exp), __ans, (ex));	\
53 } while (0)
54 #define	testl(exp, ans, ex)	do {			\
55 	long double __ans = (ans);			\
56 	feclearexcept(ALL_STD_EXCEPT);			\
57 	_testl(#exp, __LINE__, (exp), __ans, (ex));	\
58 } while (0)
59 #define	testboth(arg1, arg2, ans, ex, prec)	do {			\
60 	test##prec(nextafter##prec((arg1), (arg2)), (ans), (ex));	\
61 	test##prec(nexttoward##prec((arg1), (arg2)), (ans), (ex));	\
62 } while (0)
63 #define	testall(arg1, arg2, ans, ex)	do {		\
64 	testboth((arg1), (arg2), (ans), (ex), );	\
65 	testboth((arg1), (arg2), (ans), (ex), f);	\
66 	testboth((arg1), (arg2), (ans), (ex), l);	\
67 } while (0)
68 
69 static void _testl(const char *, int, long double, long double, int);
70 static double idd(double);
71 static float idf(float);
72 
73 static const int ex_under = FE_UNDERFLOW | FE_INEXACT;	/* shorthand */
74 static const int ex_over = FE_OVERFLOW | FE_INEXACT;
75 static const long double ldbl_eps = LDBL_EPSILON;
76 
77 
78 
79 ATF_TC_WITHOUT_HEAD(zeros);
80 ATF_TC_BODY(zeros, tc)
81 {
82 #if defined(__aarch64__) || defined(__riscv)
83 	atf_tc_expect_fail("https://bugs.freebsd.org/290099");
84 #endif
85 	long double ldbl_small;
86 
87 #ifdef	__i386__
88 	fpsetprec(FP_PE);
89 #endif
90 	/*
91 	 * We can't use a compile-time constant here because gcc on
92 	 * FreeBSD/i386 assumes long doubles are truncated to the
93 	 * double format.
94 	 */
95 	ldbl_small = ldexpl(1.0, LDBL_MIN_EXP - LDBL_MANT_DIG);
96 
97 	/*
98 	 * Special cases involving zeroes.
99 	 */
100 #define	ztest(prec)							      \
101 	test##prec(copysign##prec(1.0, nextafter##prec(0.0, -0.0)), -1.0, 0); \
102 	test##prec(copysign##prec(1.0, nextafter##prec(-0.0, 0.0)), 1.0, 0);  \
103 	test##prec(copysign##prec(1.0, nexttoward##prec(0.0, -0.0)), -1.0, 0);\
104 	test##prec(copysign##prec(1.0, nexttoward##prec(-0.0, 0.0)), 1.0, 0)
105 
106 	ztest();
107 	ztest(f);
108 	ztest(l);
109 #undef	ztest
110 
111 #define	stest(next, eps, prec)					\
112 	test##prec(next(-0.0, 42.0), eps, ex_under);		\
113 	test##prec(next(0.0, -42.0), -eps, ex_under);		\
114 	test##prec(next(0.0, INFINITY), eps, ex_under);		\
115 	test##prec(next(-0.0, -INFINITY), -eps, ex_under)
116 
117 	stest(nextafter, 0x1p-1074, );
118 	stest(nextafterf, 0x1p-149f, f);
119 	stest(nextafterl, ldbl_small, l);
120 	stest(nexttoward, 0x1p-1074, );
121 	stest(nexttowardf, 0x1p-149f, f);
122 	stest(nexttowardl, ldbl_small, l);
123 #undef	stest
124 }
125 
126 ATF_TC_WITHOUT_HEAD(eq_and_nan);
127 ATF_TC_BODY(eq_and_nan, tc)
128 {
129 	/*
130 	 * `x == y' and NaN tests
131 	 */
132 	testall(42.0, 42.0, 42.0, 0);
133 	testall(-42.0, -42.0, -42.0, 0);
134 	testall(INFINITY, INFINITY, INFINITY, 0);
135 	testall(-INFINITY, -INFINITY, -INFINITY, 0);
136 	testall(NAN, 42.0, NAN, 0);
137 	testall(42.0, NAN, NAN, 0);
138 	testall(NAN, NAN, NAN, 0);
139 }
140 
141 ATF_TC_WITHOUT_HEAD(ordinary);
142 ATF_TC_BODY(ordinary, tc)
143 {
144 	/*
145 	 * Tests where x is an ordinary normalized number
146 	 */
147 	testboth(1.0, 2.0, 1.0 + DBL_EPSILON, 0, );
148 	testboth(1.0, -INFINITY, 1.0 - DBL_EPSILON / 2, 0, );
149 	testboth(1.0, 2.0, 1.0 + FLT_EPSILON, 0, f);
150 	testboth(1.0, -INFINITY, 1.0 - FLT_EPSILON / 2, 0, f);
151 	testboth(1.0, 2.0, 1.0 + ldbl_eps, 0, l);
152 	testboth(1.0, -INFINITY, 1.0 - ldbl_eps / 2, 0, l);
153 
154 	testboth(-1.0, 2.0, -1.0 + DBL_EPSILON / 2, 0, );
155 	testboth(-1.0, -INFINITY, -1.0 - DBL_EPSILON, 0, );
156 	testboth(-1.0, 2.0, -1.0 + FLT_EPSILON / 2, 0, f);
157 	testboth(-1.0, -INFINITY, -1.0 - FLT_EPSILON, 0, f);
158 	testboth(-1.0, 2.0, -1.0 + ldbl_eps / 2, 0, l);
159 	testboth(-1.0, -INFINITY, -1.0 - ldbl_eps, 0, l);
160 
161 	/* Cases where nextafter(...) != nexttoward(...) */
162 	test(nexttoward(1.0, 1.0 + ldbl_eps), 1.0 + DBL_EPSILON, 0);
163 	testf(nexttowardf(1.0, 1.0 + ldbl_eps), 1.0 + FLT_EPSILON, 0);
164 	testl(nexttowardl(1.0, 1.0 + ldbl_eps), 1.0 + ldbl_eps, 0);
165 }
166 
167 ATF_TC_WITHOUT_HEAD(boundaries);
168 ATF_TC_BODY(boundaries, tc)
169 {
170 #if defined(__aarch64__) || defined(__riscv)
171 	atf_tc_expect_fail("https://bugs.freebsd.org/290099");
172 #endif
173 	/*
174 	 * Tests at word boundaries, normalization boundaries, etc.
175 	 */
176 	testboth(0x1.87654ffffffffp+0, INFINITY, 0x1.87655p+0, 0, );
177 	testboth(0x1.87655p+0, -INFINITY, 0x1.87654ffffffffp+0, 0, );
178 	testboth(0x1.fffffffffffffp+0, INFINITY, 0x1p1, 0, );
179 	testboth(0x1p1, -INFINITY, 0x1.fffffffffffffp+0, 0, );
180 	testboth(0x0.fffffffffffffp-1022, INFINITY, 0x1p-1022, 0, );
181 	testboth(0x1p-1022, -INFINITY, 0x0.fffffffffffffp-1022, ex_under, );
182 
183 	testboth(0x1.fffffep0f, INFINITY, 0x1p1, 0, f);
184 	testboth(0x1p1, -INFINITY, 0x1.fffffep0f, 0, f);
185 	testboth(0x0.fffffep-126f, INFINITY, 0x1p-126f, 0, f);
186 	testboth(0x1p-126f, -INFINITY, 0x0.fffffep-126f, ex_under, f);
187 
188 #if LDBL_MANT_DIG == 53
189 	testboth(0x1.87654ffffffffp+0L, INFINITY, 0x1.87655p+0L, 0, l);
190 	testboth(0x1.87655p+0L, -INFINITY, 0x1.87654ffffffffp+0L, 0, l);
191 	testboth(0x1.fffffffffffffp+0L, INFINITY, 0x1p1L, 0, l);
192 	testboth(0x1p1L, -INFINITY, 0x1.fffffffffffffp+0L, 0, l);
193 	testboth(0x0.fffffffffffffp-1022L, INFINITY, 0x1p-1022L, 0, l);
194 	testboth(0x1p-1022L, -INFINITY, 0x0.fffffffffffffp-1022L, ex_under, l);
195 #elif LDBL_MANT_DIG == 64 && !defined(__i386)
196 	testboth(0x1.87654321fffffffep+0L, INFINITY, 0x1.87654322p+0L, 0, l);
197 	testboth(0x1.87654322p+0L, -INFINITY, 0x1.87654321fffffffep+0L, 0, l);
198 	testboth(0x1.fffffffffffffffep0L, INFINITY, 0x1p1L, 0, l);
199 	testboth(0x1p1L, -INFINITY, 0x1.fffffffffffffffep0L, 0, l);
200 	testboth(0x0.fffffffffffffffep-16382L, INFINITY, 0x1p-16382L, 0, l);
201 	testboth(0x1p-16382L, -INFINITY,
202 	    0x0.fffffffffffffffep-16382L, ex_under, l);
203 #elif LDBL_MANT_DIG == 113
204 	testboth(0x1.876543210987ffffffffffffffffp+0L, INFINITY,
205 	    0x1.876543210988p+0, 0, l);
206 	testboth(0x1.876543210988p+0L, -INFINITY,
207 	    0x1.876543210987ffffffffffffffffp+0L, 0, l);
208 	testboth(0x1.ffffffffffffffffffffffffffffp0L, INFINITY, 0x1p1L, 0, l);
209 	testboth(0x1p1L, -INFINITY, 0x1.ffffffffffffffffffffffffffffp0L, 0, l);
210 	testboth(0x0.ffffffffffffffffffffffffffffp-16382L, INFINITY,
211 	    0x1p-16382L, 0, l);
212 	testboth(0x1p-16382L, -INFINITY,
213 	    0x0.ffffffffffffffffffffffffffffp-16382L, ex_under, l);
214 #endif
215 }
216 
217 ATF_TC_WITHOUT_HEAD(overflow);
218 ATF_TC_BODY(overflow, tc)
219 {
220 #if defined(__aarch64__) || defined(__riscv)
221 	atf_tc_expect_fail("https://bugs.freebsd.org/290099");
222 #endif
223 	long double ldbl_max;
224 	/*
225 	 * We can't use a compile-time constant here because gcc on
226 	 * FreeBSD/i386 assumes long doubles are truncated to the
227 	 * double format.
228 	 */
229 	ldbl_max = ldexpl(1.0 - ldbl_eps / 2, LDBL_MAX_EXP);
230 
231 	/*
232 	 * Overflow tests
233 	 */
234 	test(idd(nextafter(DBL_MAX, INFINITY)), INFINITY, ex_over);
235 	test(idd(nextafter(INFINITY, 0.0)), DBL_MAX, 0);
236 	test(idd(nexttoward(DBL_MAX, DBL_MAX * 2.0L)), INFINITY, ex_over);
237 #if LDBL_MANT_DIG > 53
238 	test(idd(nexttoward(INFINITY, DBL_MAX * 2.0L)), DBL_MAX, 0);
239 #endif
240 
241 	testf(idf(nextafterf(FLT_MAX, INFINITY)), INFINITY, ex_over);
242 	testf(idf(nextafterf(INFINITY, 0.0)), FLT_MAX, 0);
243 	testf(idf(nexttowardf(FLT_MAX, FLT_MAX * 2.0)), INFINITY, ex_over);
244 	testf(idf(nexttowardf(INFINITY, FLT_MAX * 2.0)), FLT_MAX, 0);
245 
246 	testboth(ldbl_max, INFINITY, INFINITY, ex_over, l);
247 	testboth(INFINITY, 0.0, ldbl_max, 0, l);
248 }
249 
250 static void
251 _testl(const char *exp, int line, long double actual, long double expected,
252     int except)
253 {
254 	int actual_except;
255 
256 	actual_except = fetestexcept(ALL_STD_EXCEPT);
257 	if (!fpequal_cs(actual, expected, true)) {
258 		atf_tc_fail_check(__FILE__, line,
259 		    "%s returned %La, expecting %La\n", exp, actual, expected);
260 	}
261 	if (actual_except != except) {
262 		atf_tc_fail_check(__FILE__, line,
263 		    "%s raised 0x%x, expecting 0x%x\n", exp, actual_except,
264 		    except);
265 	}
266 }
267 
268 /*
269  * The idd() and idf() routines ensure that doubles and floats are
270  * converted to their respective types instead of stored in the FPU
271  * with extra precision.
272  */
273 static double
274 idd(double x)
275 {
276 	return (x);
277 }
278 
279 static float
280 idf(float x)
281 {
282 	return (x);
283 }
284 
285 ATF_TP_ADD_TCS(tp)
286 {
287 	ATF_TP_ADD_TC(tp, zeros);
288 	ATF_TP_ADD_TC(tp, ordinary);
289 	ATF_TP_ADD_TC(tp, eq_and_nan);
290 	ATF_TP_ADD_TC(tp, boundaries);
291 	ATF_TP_ADD_TC(tp, overflow);
292 
293 	return (atf_no_error());
294 }
295