xref: /freebsd/lib/libc/tests/stdio/printfloat_test.c (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*-
2  * Copyright (c) 2002-2009 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 for printf() floating point formats.
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include <err.h>
35 #include <fenv.h>
36 #include <float.h>
37 #include <locale.h>
38 #include <math.h>
39 #include <stdio.h>
40 #include <stdarg.h>
41 #include <stdint.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include <wchar.h>
45 
46 #include <atf-c.h>
47 
48 static void
49 smash_stack(void)
50 {
51 	static uint32_t junk = 0xdeadbeef;
52 	uint32_t buf[512];
53 	size_t i;
54 
55 	for (i = 0; i < sizeof(buf) / sizeof(buf[0]); i++)
56 		buf[i] = junk;
57 }
58 
59 #define	testfmt(result, fmt, ...)       \
60 	_testfmt((result), #__VA_ARGS__, fmt, __VA_ARGS__)
61 static void
62 _testfmt(const char *result, const char *argstr, const char *fmt,...)
63 {
64 #define	BUF	100
65 	wchar_t ws[BUF], wfmt[BUF], wresult[BUF];
66 	char s[BUF];
67 	va_list ap, ap2;
68 
69 	va_start(ap, fmt);
70 	va_copy(ap2, ap);
71 	smash_stack();
72 	vsnprintf(s, sizeof(s), fmt, ap);
73 	ATF_CHECK_MSG(strcmp(result, s) == 0,
74 	    "printf(\"%s\", %s) ==> [%s], expected [%s]",
75 	    fmt, argstr, s, result);
76 
77 	smash_stack();
78 	mbstowcs(ws, s, BUF - 1);
79 	mbstowcs(wfmt, fmt, BUF - 1);
80 	mbstowcs(wresult, result, BUF - 1);
81 	vswprintf(ws, sizeof(ws) / sizeof(ws[0]), wfmt, ap2);
82 	ATF_CHECK_MSG(wcscmp(wresult, ws) == 0,
83 	    "wprintf(\"%ls\", %s) ==> [%ls], expected [%ls]",
84 	    wfmt, argstr, ws, wresult);
85 
86 	va_end(ap);
87 	va_end(ap2);
88 }
89 
90 ATF_TC_WITHOUT_HEAD(float_within_limits);
91 ATF_TC_BODY(float_within_limits, tc)
92 {
93 
94 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
95 
96 	/* Basic tests of decimal output functionality. */
97 	testfmt(" 1.000000E+00", "%13E", 1.0);
98 	testfmt("     1.000000", "%13f", 1.0);
99 	testfmt("            1", "%13G", 1.0);
100 	testfmt(" 1.000000E+00", "%13LE", 1.0L);
101 	testfmt("     1.000000", "%13Lf", 1.0L);
102 	testfmt("            1", "%13LG", 1.0L);
103 
104 	testfmt("2.718282", "%.*f", -2, 2.7182818);
105 
106 	testfmt("1.234568e+06", "%e", 1234567.8);
107 	testfmt("1234567.800000", "%f", 1234567.8);
108 	testfmt("1.23457E+06", "%G", 1234567.8);
109 	testfmt("1.234568e+06", "%Le", 1234567.8L);
110 	testfmt("1234567.800000", "%Lf", 1234567.8L);
111 	testfmt("1.23457E+06", "%LG", 1234567.8L);
112 
113 #if (LDBL_MANT_DIG > DBL_MANT_DIG) && !defined(__i386__)
114 	testfmt("123456789.864210", "%Lf", 123456789.8642097531L);
115 	testfmt("-1.23457E+08", "%LG", -123456789.8642097531L);
116 	testfmt("123456789.8642097531", "%.10Lf", 123456789.8642097531L);
117 	testfmt(" 3.141592653589793238e-4000", "%L27.18Le",
118 	    3.14159265358979323846e-4000L);
119 #endif
120 }
121 
122 ATF_TC_WITHOUT_HEAD(infinities_and_nans);
123 ATF_TC_BODY(infinities_and_nans, tc)
124 {
125 
126 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
127 
128 	testfmt("nan", "%e", NAN);
129 	testfmt("NAN", "%F", NAN);
130 	testfmt("nan", "%g", NAN);
131 	testfmt("NAN", "%LE", (long double)NAN);
132 	testfmt("  nan", "%05e", NAN);
133 
134 	testfmt("INF", "%E", HUGE_VAL);
135 	testfmt("-inf", "%f", -HUGE_VAL);
136 	testfmt("+inf", "%+g", HUGE_VAL);
137 	testfmt(" inf", "%4.2Le", HUGE_VALL);
138 	testfmt("-inf", "%Lf", -HUGE_VALL);
139 	testfmt("  inf", "%05e", HUGE_VAL);
140 	testfmt(" -inf", "%05e", -HUGE_VAL);
141 }
142 
143 ATF_TC_WITHOUT_HEAD(padding);
144 ATF_TC_BODY(padding, tc)
145 {
146 
147 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
148 
149 	testfmt("0.000000e+00", "%e", 0.0);
150 	testfmt("0.000000", "%F", (double)0.0);
151 	testfmt("0", "%G", 0.0);
152 	testfmt("  0", "%3.0Lg", 0.0L);
153 	testfmt("    0", "%5.0f", 0.001);
154 }
155 
156 ATF_TC_WITHOUT_HEAD(precision_specifiers);
157 ATF_TC_BODY(precision_specifiers, tc)
158 {
159 
160 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
161 
162 	testfmt("1.0123e+00", "%.4e", 1.0123456789);
163 	testfmt("1.0123", "%.4f", 1.0123456789);
164 	testfmt("1.012", "%.4g", 1.0123456789);
165 	testfmt("1.2346e-02", "%.4e", 0.0123456789);
166 	testfmt("0.0123", "%.4f", 0.0123456789);
167 	testfmt("0.01235", "%.4g", 0.0123456789);
168 }
169 
170 ATF_TC_WITHOUT_HEAD(thousands_separator_and_other_locale_tests);
171 ATF_TC_BODY(thousands_separator_and_other_locale_tests, tc)
172 {
173 
174 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
175 
176 	testfmt("12345678.0625", "%'.04f", 12345678.0625);
177 	testfmt("0012345678.0625", "%'015.4F", 12345678.0625);
178 
179 	ATF_REQUIRE(setlocale(LC_NUMERIC, "hi_IN.ISCII-DEV")); /* grouping == 2;3 */
180 	testfmt("1,23,45,678.0625", "%'.4f", 12345678.0625);
181 	testfmt("01,23,45,678.0625", "%'017.4F", 12345678.0625);
182 	testfmt(" 9,000", "%'6.0f", 9000.0);
183 	testfmt("9,000.0", "%'.1f", 9000.0);
184 
185 	ATF_REQUIRE(setlocale(LC_NUMERIC, "ru_RU.ISO8859-5")); /* decimalpoint==, */
186 	testfmt("3,1415", "%g", 3.1415);
187 
188 	/* thousands=. decimalpoint=, grouping=3;3 */
189 	ATF_REQUIRE(setlocale(LC_NUMERIC, "el_GR.ISO8859-7")); /* decimalpoint==, */
190 	testfmt("1.234,00", "%'.2f", 1234.00);
191 	testfmt("123.456,789", "%'.3f", 123456.789);
192 
193 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
194 	testfmt("12345678.062500", "%'f", 12345678.0625);
195 	testfmt("9000.000000", "%'f", 9000.0);
196 }
197 
198 ATF_TC_WITHOUT_HEAD(signed_conversions);
199 ATF_TC_BODY(signed_conversions, tc)
200 {
201 
202 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
203 
204 	testfmt("+2.500000e-01", "%+e", 0.25);
205 	testfmt("+0.000000", "%+F", 0.0);
206 	testfmt("-1", "%+g", -1.0);
207 
208 	testfmt("-1.000000e+00", "% e", -1.0);
209 	testfmt("+1.000000", "% +f", 1.0);
210 	testfmt(" 1", "% g", 1.0);
211 	testfmt(" 0", "% g", 0.0);
212 }
213 
214 ATF_TC_WITHOUT_HEAD(alternate_form);
215 ATF_TC_BODY(alternate_form, tc)
216 {
217 
218 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
219 
220 	testfmt("1.250e+00", "%#.3e", 1.25);
221 	testfmt("123.000000", "%#f", 123.0);
222 	testfmt(" 12345.", "%#7.5g", 12345.0);
223 	testfmt(" 1.00000", "%#8g", 1.0);
224 	testfmt("0.0", "%#.2g", 0.0);
225 }
226 
227 ATF_TC_WITHOUT_HEAD(padding_and_decimal_point_placement);
228 ATF_TC_BODY(padding_and_decimal_point_placement, tc)
229 {
230 
231 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
232 
233 	testfmt("03.2E+00", "%08.1E", 3.25);
234 	testfmt("003.25", "%06.2F", 3.25);
235 	testfmt("0003.25", "%07.4G", 3.25);
236 
237 	testfmt("3.14159e-05", "%g", 3.14159e-5);
238 	testfmt("0.000314159", "%g", 3.14159e-4);
239 	testfmt("3.14159e+06", "%g", 3.14159e6);
240 	testfmt("314159", "%g", 3.14159e5);
241 	testfmt("314159.", "%#g", 3.14159e5);
242 
243 	testfmt(" 9.000000e+03", "%13e", 9000.0);
244 	testfmt(" 9000.000000", "%12f", 9000.0);
245 	testfmt(" 9000", "%5g", 9000.0);
246 	testfmt(" 900000.", "%#8g", 900000.0);
247 	testfmt(" 9e+06", "%6g", 9000000.0);
248 	testfmt(" 9.000000e-04", "%13e", 0.0009);
249 	testfmt(" 0.000900", "%9f", 0.0009);
250 	testfmt(" 0.0009", "%7g", 0.0009);
251 	testfmt(" 9e-05", "%6g", 0.00009);
252 	testfmt(" 9.00000e-05", "%#12g", 0.00009);
253 	testfmt(" 9.e-05", "%#7.1g", 0.00009);
254 
255 	testfmt(" 0.0", "%4.1f", 0.0);
256 	testfmt("90.0", "%4.1f", 90.0);
257 	testfmt(" 100", "%4.0f", 100.0);
258 	testfmt("9.0e+01", "%4.1e", 90.0);
259 	testfmt("1e+02", "%4.0e", 100.0);
260 }
261 
262 ATF_TC_WITHOUT_HEAD(decimal_rounding);
263 ATF_TC_BODY(decimal_rounding, tc)
264 {
265 
266 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
267 
268 	fesetround(FE_DOWNWARD);
269 	testfmt("4.437", "%.3f", 4.4375);
270 	testfmt("-4.438", "%.3f", -4.4375);
271 	testfmt("4.437", "%.3Lf", 4.4375L);
272 	testfmt("-4.438", "%.3Lf", -4.4375L);
273 
274 	fesetround(FE_UPWARD);
275 	testfmt("4.438", "%.3f", 4.4375);
276 	testfmt("-4.437", "%.3f", -4.4375);
277 	testfmt("4.438", "%.3Lf", 4.4375L);
278 	testfmt("-4.437", "%.3Lf", -4.4375L);
279 
280 	fesetround(FE_TOWARDZERO);
281 	testfmt("4.437", "%.3f", 4.4375);
282 	testfmt("-4.437", "%.3f", -4.4375);
283 	testfmt("4.437", "%.3Lf", 4.4375L);
284 	testfmt("-4.437", "%.3Lf", -4.4375L);
285 
286 	fesetround(FE_TONEAREST);
287 	testfmt("4.438", "%.3f", 4.4375);
288 	testfmt("-4.438", "%.3f", -4.4375);
289 	testfmt("4.438", "%.3Lf", 4.4375L);
290 	testfmt("-4.438", "%.3Lf", -4.4375L);
291 }
292 
293 ATF_TC_WITHOUT_HEAD(hexadecimal_floating_point);
294 ATF_TC_BODY(hexadecimal_floating_point, tc)
295 {
296 
297 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
298 
299 	/*
300 	 * Hexadecimal floating point (%a, %A) tests.  Some of these
301 	 * are only valid if the implementation converts to hex digits
302 	 * on nibble boundaries.
303 	 */
304 	testfmt("0x0p+0", "%a", 0x0.0p0);
305 	testfmt("0X0.P+0", "%#LA", 0x0.0p0L);
306 	testfmt("inf", "%La", (long double)INFINITY);
307 	testfmt("+INF", "%+A", INFINITY);
308 	testfmt("nan", "%La", (long double)NAN);
309 	testfmt("NAN", "%A", NAN);
310 
311 	testfmt(" 0x1.23p+0", "%10a", 0x1.23p0);
312 	testfmt(" 0x1.23p-500", "%12a", 0x1.23p-500);
313 	testfmt(" 0x1.2p+40", "%10.1a", 0x1.23p40);
314 	testfmt(" 0X1.230000000000000000000000P-4", "%32.24A", 0x1.23p-4);
315 	testfmt("0x1p-1074", "%a", 0x1p-1074);
316 	testfmt("0x1.2345p-1024", "%a", 0x1.2345p-1024);
317 
318 #if (LDBL_MANT_DIG == 64)
319 	testfmt("0x1.921fb54442d18468p+1", "%La", 0x3.243f6a8885a308dp0L);
320 	testfmt("0x1p-16445", "%La", 0x1p-16445L);
321 	testfmt("0x1.30ecap-16381", "%La", 0x9.8765p-16384L);
322 #elif (LDBL_MANT_DIG == 113)
323 	testfmt("0x1.921fb54442d18469898cc51701b8p+1", "%La",
324 	    0x3.243f6a8885a308d313198a2e037p0L);
325 	testfmt("0x1p-16494", "%La", 0x1p-16494L);
326 	testfmt("0x1.2345p-16384", "%La", 0x1.2345p-16384L);
327 #else
328 	testfmt("0x1.921fb54442d18p+1", "%La", 0x3.243f6a8885a31p0L);
329 	testfmt("0x1p-1074", "%La", 0x1p-1074L);
330 	testfmt("0x1.30ecap-1021", "%La", 0x9.8765p-1024L);
331 #endif
332 }
333 
334 ATF_TC_WITHOUT_HEAD(hexadecimal_rounding);
335 ATF_TC_BODY(hexadecimal_rounding, tc)
336 {
337 
338 	ATF_REQUIRE(setlocale(LC_NUMERIC, "C"));
339 
340 	fesetround(FE_TOWARDZERO);
341 	testfmt("0X1.23456789ABCP+0", "%.11A", 0x1.23456789abcdep0);
342 	testfmt("-0x1.23456p+0", "%.5a", -0x1.23456789abcdep0);
343 	testfmt("0x1.23456p+0", "%.5a", 0x1.23456789abcdep0);
344 	testfmt("0x1.234567p+0", "%.6a", 0x1.23456789abcdep0);
345 	testfmt("-0x1.234566p+0", "%.6a", -0x1.23456689abcdep0);
346 
347 	fesetround(FE_DOWNWARD);
348 	testfmt("0X1.23456789ABCP+0", "%.11A", 0x1.23456789abcdep0);
349 	testfmt("-0x1.23457p+0", "%.5a", -0x1.23456789abcdep0);
350 	testfmt("0x1.23456p+0", "%.5a", 0x1.23456789abcdep0);
351 	testfmt("0x1.234567p+0", "%.6a", 0x1.23456789abcdep0);
352 	testfmt("-0x1.234567p+0", "%.6a", -0x1.23456689abcdep0);
353 
354 	fesetround(FE_UPWARD);
355 	testfmt("0X1.23456789ABDP+0", "%.11A", 0x1.23456789abcdep0);
356 	testfmt("-0x1.23456p+0", "%.5a", -0x1.23456789abcdep0);
357 	testfmt("0x1.23457p+0", "%.5a", 0x1.23456789abcdep0);
358 	testfmt("0x1.234568p+0", "%.6a", 0x1.23456789abcdep0);
359 	testfmt("-0x1.234566p+0", "%.6a", -0x1.23456689abcdep0);
360 
361 	fesetround(FE_TONEAREST);
362 	testfmt("0x1.23456789abcdep+4", "%a", 0x1.23456789abcdep4);
363 	testfmt("0X1.23456789ABDP+0", "%.11A", 0x1.23456789abcdep0);
364 	testfmt("-0x1.23456p+0", "%.5a", -0x1.23456789abcdep0);
365 	testfmt("0x1.23456p+0", "%.5a", 0x1.23456789abcdep0);
366 	testfmt("0x1.234568p+0", "%.6a", 0x1.23456789abcdep0);
367 	testfmt("-0x1.234567p+0", "%.6a", -0x1.23456689abcdep0);
368 	testfmt("0x1.00p-1029", "%.2a", 0x1.fffp-1030);
369 	testfmt("0x1.00p-1026", "%.2a", 0xf.fffp-1030);
370 	testfmt("0x1.83p+0", "%.2a", 1.51);
371 }
372 
373 ATF_TC_WITHOUT_HEAD(subnormal_double);
374 ATF_TC_BODY(subnormal_double, tc)
375 {
376 	/* Regression test for https://bugs.freebsd.org/253847 */
377 	double positive = __DBL_DENORM_MIN__;
378 	testfmt("4.9406564584124654418e-324", "%20.20g", positive);
379 	testfmt("4.9406564584124654418E-324", "%20.20G", positive);
380 	testfmt("0x1p-1074", "%a", positive);
381 	testfmt("0X1P-1074", "%A", positive);
382 	double negative = -__DBL_DENORM_MIN__;
383 	testfmt("-4.9406564584124654418e-324", "%20.20g", negative);
384 	testfmt("-4.9406564584124654418E-324", "%20.20G", negative);
385 	testfmt("-0x1p-1074", "%a", negative);
386 	testfmt("-0X1P-1074", "%A", negative);
387 }
388 
389 ATF_TC_WITHOUT_HEAD(subnormal_float);
390 ATF_TC_BODY(subnormal_float, tc)
391 {
392 	float positive = __FLT_DENORM_MIN__;
393 	testfmt("1.4012984643248170709e-45", "%20.20g", positive);
394 	testfmt("1.4012984643248170709E-45", "%20.20G", positive);
395 	testfmt("0x1p-149", "%a", positive);
396 	testfmt("0X1P-149", "%A", positive);
397 	float negative = -__FLT_DENORM_MIN__;
398 	testfmt("-1.4012984643248170709e-45", "%20.20g", negative);
399 	testfmt("-1.4012984643248170709E-45", "%20.20G", negative);
400 	testfmt("-0x1p-149", "%a", negative);
401 	testfmt("-0X1P-149", "%A", negative);
402 }
403 
404 ATF_TP_ADD_TCS(tp)
405 {
406 
407 	ATF_TP_ADD_TC(tp, float_within_limits);
408 	ATF_TP_ADD_TC(tp, infinities_and_nans);
409 	ATF_TP_ADD_TC(tp, padding);
410 	ATF_TP_ADD_TC(tp, precision_specifiers);
411 	ATF_TP_ADD_TC(tp, thousands_separator_and_other_locale_tests);
412 	ATF_TP_ADD_TC(tp, signed_conversions);
413 	ATF_TP_ADD_TC(tp, alternate_form);
414 	ATF_TP_ADD_TC(tp, padding_and_decimal_point_placement);
415 	ATF_TP_ADD_TC(tp, decimal_rounding);
416 	ATF_TP_ADD_TC(tp, hexadecimal_floating_point);
417 	ATF_TP_ADD_TC(tp, hexadecimal_rounding);
418 	ATF_TP_ADD_TC(tp, subnormal_double);
419 	ATF_TP_ADD_TC(tp, subnormal_float);
420 
421 	return (atf_no_error());
422 }
423