stdlib/tst-strtod-round-skeleton.c

   1 /* Test for correct rounding of results of strtod and related
   2    functions.
   3    Copyright (C) 2012-2017 Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, see
  18    <http://www.gnu.org/licenses/>.  */
  19
  20 /* Defining _LIBC_TEST ensures long double math functions are
  21    declared in the headers.  */
  22 #define _LIBC_TEST 1
  23 #define __STDC_WANT_IEC_60559_TYPES_EXT__
  24 #include <fenv.h>
  25 #include <float.h>
  26 #include <math.h>
  27 #include <stdbool.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <math-tests.h>
  32
  33 #include "tst-strtod.h"
  34
  35 /* Non-standard macros expected to be externally defined:
  36
  37    L_(str): Pastes the appropriate modifier to a string literal str.
  38
  39    FNPFX: Expands to the correct prefix for the strtod equivalent
  40           of type CHAR. (e.g str or wcs).
  41
  42    CHAR: Expands to the string type being tested (e.g wchar_t or char).
  43
  44    STRM: Expands to a string literal suitable for printing CHAR* via
  45          printf (e.g "%s" or "%ls"). */
  46
  47 #define _CONCAT(a, b) a ## b
  48 #define CONCAT(a, b) _CONCAT (a, b)
  49
  50 #define STRTO(x) CONCAT (CONCAT (FNPFX, to), x)
  51
  52 #if LDBL_MANT_DIG == 106 && LDBL_MAX_EXP == 1024
  53 /* This is a stupid hack for IBM long double.  This test ignores
  54    inexact values for long double due to the limitations of the
  55    format.  This ensures rounding tests are ignored.  */
  56 # undef ROUNDING_TESTS_long_double
  57 # define ROUNDING_TESTS_long_double(x) 0
  58 #endif
  59
  60 /* Generator to create an FTYPE member variabled named FSUF
  61    used to populate struct member variables.  */
  62 #define FTYPE_MEMBER(FSUF, FTYPE, FTOSTR, LSUF, CSUF)  \
  63        FTYPE FSUF;
  64
  65 /* Likewise, but each member is of type bool.  */
  66 #define BOOL_MEMBER(FSUF, FTYPE, FTOSTR, LSUF, CSUF)  \
  67        bool FSUF;
  68
  69 #define STRUCT_FOREACH_FLOAT_FTYPE GEN_TEST_STRTOD_FOREACH (FTYPE_MEMBER)
  70 #define STRUCT_FOREACH_FLOAT_BOOL GEN_TEST_STRTOD_FOREACH (BOOL_MEMBER)
  71
  72 /* Define the long double choose (CHOOSE_ld) macro
  73    to select the appropriate generated long double
  74    value from the generated test data.  */
  75 #if LDBL_MANT_DIG == 53 && LDBL_MAX_EXP == 1024
  76 /* This is for the long double == double format.  */
  77 # define CHOOSE_ld(f,d,...) d
  78 #elif LDBL_MANT_DIG == 64 && LDBL_MAX_EXP == 16384 && LDBL_MIN_EXP == -16381
  79 /* This is for the Intel extended float format.  */
  80 # define CHOOSE_ld(f,d,ld64i,...) ld64i
  81 #elif LDBL_MANT_DIG == 64 && LDBL_MAX_EXP == 16384 && LDBL_MIN_EXP == -16382
  82 /* This is for the Motorola extended float format.  */
  83 # define CHOOSE_ld(f,d,ld64i,ld64m,...) ld64m
  84 #elif LDBL_MANT_DIG == 106 && LDBL_MAX_EXP == 1024
  85 /* This is for the IBM extended double format.  */
  86 # define CHOOSE_ld(f,d,ld64i,ld64m,ld106,...) ld106
  87 #elif LDBL_MANT_DIG == 113 && LDBL_MAX_EXP == 16384
  88 /* This is for the IEEE binary128 format.  */
  89 # define CHOOSE_ld(f,d,ld64i,ld64m,ld106,ld113,...) ld113
  90 #else
  91 # error "unknown long double format"
  92 #endif
  93
  94 /* Add type specific choosing macros below.  */
  95 #define CHOOSE_f(f,...) f
  96 #define CHOOSE_f32(f,...) f
  97 #define CHOOSE_d(f,d,...) d
  98 #define CHOOSE_f64(f,d,...) d
  99 #define CHOOSE_f32x(f,d,...) d
 100 #define CHOOSE_f128(f,d,ld64i,ld64m,ld106,ld113,...) ld113
 101 /* long double is special, and handled above.  _Float16 would require
 102    updates to the generator to generate appropriate expectations, and
 103    updates to the test inputs to cover difficult rounding cases for
 104    _Float16.  */
 105
 106 #if __HAVE_FLOAT64X
 107 # if FLT64X_MANT_DIG == 113 && FLT64X_MAX_EXP == 16384
 108 #  define CHOOSE_f64x(f,d,ld64i,ld64m,ld106,ld113,...) ld113
 109 # elif (FLT64X_MANT_DIG == 64                   \
 110         && FLT64X_MAX_EXP == 16384              \
 111         && FLT64X_MIN_EXP == -16381)
 112 #  define CHOOSE_f64x(f,d,ld64i,...) ld64i
 113 # else
 114 #  error "unknown _Float64x format"
 115 # endif
 116 #endif
 117
 118 /* Selector for expected result field of a given type.  */
 119 #define _ENTRY(FSUF, FTYPE, FTOSTR, LSUF, CSUF, ...)  \
 120   CONCAT (CHOOSE_ ## FSUF (__VA_ARGS__), LSUF),
 121 #define ENTRY(...) \
 122   GEN_TEST_STRTOD_FOREACH (_ENTRY, __VA_ARGS__)
 123
 124 /* Selector for boolean exact tag of expected results.  */
 125 #define _XNTRY(FSUF, FTYPE, FTOSTR, LSUF, CSUF, ...)  \
 126   CHOOSE_ ## FSUF (__VA_ARGS__),
 127 #define XNTRY(...) \
 128   GEN_TEST_STRTOD_FOREACH (_XNTRY, __VA_ARGS__)
 129
 130 /* This is hacky way around the seemingly unavoidable macro
 131    expansion of the INFINITY or HUGE_VAL like macros in the
 132    above.  It is assumed the compiler will implicitly convert
 133    the infinity correctly.  */
 134 #define INF INFINITY + 0.0
 135
 136 /* This macro is used in conjunction with the output from the
 137    gen-tst-strtod-round utility to select the appropriately
 138    rounded long double value for a given format.  */
 139 #define TEST(s,                                         \
 140              fx, fd, fn, fz, fu,                        \
 141              dx, dd, dn, dz, du,                        \
 142              ld64ix, ld64id, ld64in, ld64iz, ld64iu,    \
 143              ld64mx, ld64md, ld64mn, ld64mz, ld64mu,    \
 144              ld106x, ld106d, ld106n, ld106z, ld106u,    \
 145              ld113x, ld113d, ld113n, ld113z, ld113u)    \
 146   {                                                     \
 147     L_ (s),                                             \
 148     { XNTRY (fx, dx, ld64ix, ld64mx, ld106x, ld113x) }, \
 149     {                                                   \
 150     { ENTRY (fn, dn, ld64in, ld64mn, ld106n, ld113n) }, \
 151     { ENTRY (fd, dd, ld64id, ld64md, ld106d, ld113d) }, \
 152     { ENTRY (fz, dz, ld64iz, ld64mz, ld106z, ld113z) }, \
 153     { ENTRY (fu, du, ld64iu, ld64mu, ld106u, ld113u) }  \
 154     }                                                   \
 155   }
 156
 157 struct test_exactness
 158   {
 159   STRUCT_FOREACH_FLOAT_BOOL
 160   };
 161
 162 struct test_results
 163   {
 164   STRUCT_FOREACH_FLOAT_FTYPE
 165   };
 166
 167 struct test {
 168   const CHAR *s;
 169   struct test_exactness exact;
 170   struct test_results r[4];
 171 };
 172
 173 /* Include the generated test data.  */
 174 #include "tst-strtod-round-data.h"
 175
 176 #define STRX(x) #x
 177 #define STR(x) STRX (x)
 178 #define FNPFXS STR (FNPFX)
 179
 180 #ifndef FE_INEXACT
 181 # define FE_INEXACT 0
 182 #endif
 183
 184 #define GEN_ONE_TEST(FSUF, FTYPE, FTOSTR, LSUF, CSUF)           \
 185 {                                                               \
 186   feclearexcept (FE_INEXACT);                                   \
 187   FTYPE f = STRTO (FSUF) (s, NULL);                             \
 188   if (f != expected->FSUF                                       \
 189       || (copysign ## CSUF) (1.0 ## LSUF, f)                    \
 190          != (copysign ## CSUF) (1.0 ## LSUF, expected->FSUF))   \
 191     {                                                           \
 192       char efstr[FSTRLENMAX];                                   \
 193       char fstr[FSTRLENMAX];                                    \
 194       FTOSTR (efstr, FSTRLENMAX, "%a", expected->FSUF);         \
 195       FTOSTR (fstr, FSTRLENMAX, "%a", f);                       \
 196       printf (FNPFXS "to" #FSUF  " (" STRM ") returned %s not " \
 197               "%s (%s)\n", s, fstr, efstr, mode_name);          \
 198       if (ROUNDING_TESTS (FTYPE, rnd_mode) || exact->FSUF)      \
 199         result = 1;                                             \
 200       else                                                      \
 201         printf ("ignoring this inexact result\n");              \
 202     }                                                           \
 203   else if (FE_INEXACT != 0)                                     \
 204     {                                                           \
 205       bool inexact_raised = fetestexcept (FE_INEXACT) != 0;     \
 206       if (inexact_raised != !exact->FSUF)                       \
 207         {                                                       \
 208           printf (FNPFXS "to" #FSUF  " (" STRM ") inexact %d "  \
 209                   "not %d\n", s, inexact_raised, !exact->FSUF); \
 210           if (EXCEPTION_TESTS (FTYPE))                          \
 211             result = 1;                                         \
 212           else                                                  \
 213             printf ("ignoring this exception error\n");         \
 214         }                                                       \
 215     }                                                           \
 216 }
 217
 218 static int
 219 test_in_one_mode (const CHAR *s, const struct test_results *expected,
 220                   const struct test_exactness *exact, const char *mode_name,
 221                   int rnd_mode)
 222 {
 223   int result = 0;
 224   GEN_TEST_STRTOD_FOREACH (GEN_ONE_TEST)
 225   return result;
 226 }
 227
 228 static const struct fetestmodes
 229   {
 230   const char *mode_name;
 231   int rnd_mode;
 232   int rnd_i; /* Corresponding index into r array of struct test.  */
 233   } modes[] = {
 234     { "default rounding mode", FE_TONEAREST, 0 },
 235 #ifdef FE_DOWNWARD
 236     { "FE_DOWNWARD", FE_DOWNWARD, 1 },
 237 #endif
 238 #ifdef FE_TOWARDZERO
 239     { "FE_TOWARDZERO", FE_TOWARDZERO, 2 },
 240 #endif
 241 #ifdef FE_UPWARD
 242     { "FE_UPWARD", FE_UPWARD, 3 },
 243 #endif
 244     {}
 245 };
 246
 247 static int
 248 do_test (void)
 249 {
 250   int save_round_mode __attribute__ ((unused)) = fegetround ();
 251   int result = 0;
 252   for (size_t i = 0; i < sizeof (tests) / sizeof (tests[0]); i++)
 253     {
 254       result |= test_in_one_mode (tests[i].s, &tests[i].r[modes[0].rnd_i],
 255                                   &tests[i].exact, modes[0].mode_name,
 256                                   modes[0].rnd_mode);
 257       for (const struct fetestmodes *m = &modes[1]; m->mode_name != NULL; m++)
 258         {
 259           if (!fesetround (m->rnd_mode))
 260             {
 261               result |= test_in_one_mode (tests[i].s, &tests[i].r[m->rnd_i],
 262                                           &tests[i].exact, m->mode_name,
 263                                           m->rnd_mode);
 264               fesetround (save_round_mode);
 265             }
 266         }
 267     }
 268   return result;
 269 }
 270
 271 #define TEST_FUNCTION do_test ()
 272 #include "../test-skeleton.c"