math/libm-test-support.h

   1 /* Support code for testing libm functions (common declarations).
   2    Copyright (C) 1997-2017 Free Software Foundation, Inc.
   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>
  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
  59 #define EXCEPTIONS_OK INVALID_EXCEPTION_OK+DIVIDE_BY_ZERO_EXCEPTION_OK
  60 /* Some special test flags, passed together with exceptions.  */
  61 #define IGNORE_ZERO_INF_SIGN            0x400
  62 #define TEST_NAN_SIGN                   0x800
  63 #define TEST_NAN_PAYLOAD                0x1000
  64 #define NO_TEST_INLINE                  0x2000
  65 #define XFAIL_TEST                      0x4000
  66 /* Indicate errno settings required or disallowed.  */
  67 #define ERRNO_UNCHANGED                 0x8000
  68 #define ERRNO_EDOM                      0x10000
  69 #define ERRNO_ERANGE                    0x20000
  70 /* Flags generated by gen-libm-test.pl, not entered here manually.  */
  71 #define IGNORE_RESULT                   0x40000
  72 #define NON_FINITE                      0x80000
  73 #define TEST_SNAN                       0x100000
  74 #define NO_TEST_MATHVEC                 0x200000
  75
  76 #define __CONCATX(a,b) __CONCAT(a,b)
  77
  78 #define TYPE_MIN __CONCATX (PREFIX, _MIN)
  79 #define TYPE_TRUE_MIN __CONCATX (PREFIX, _TRUE_MIN)
  80 #define TYPE_MAX __CONCATX (PREFIX, _MAX)
  81 #define MIN_EXP __CONCATX (PREFIX, _MIN_EXP)
  82 #define MAX_EXP __CONCATX (PREFIX, _MAX_EXP)
  83 #define MANT_DIG __CONCATX (PREFIX, _MANT_DIG)
  84
  85 /* Format specific test macros.  */
  86 #define TEST_COND_binary32 (MANT_DIG == 24      \
  87                             && MIN_EXP == -125  \
  88                             && MAX_EXP == 128)
  89
  90 #define TEST_COND_binary64 (MANT_DIG == 53      \
  91                             && MIN_EXP == -1021 \
  92                             && MAX_EXP == 1024)
  93
  94 #define TEST_COND_binary128 (MANT_DIG == 113            \
  95                              && MIN_EXP == -16381       \
  96                              && MAX_EXP == 16384)
  97
  98 #define TEST_COND_ibm128 (MANT_DIG == 106)
  99
 100 #define TEST_COND_intel96 (MANT_DIG == 64       \
 101                            && MIN_EXP == -16381 \
 102                            && MAX_EXP == 16384)
 103
 104 #define TEST_COND_m68k96 (MANT_DIG == 64        \
 105                           && MIN_EXP == -16382  \
 106                           && MAX_EXP == 16384)
 107
 108 /* The condition ibm128-libgcc is used instead of ibm128 to mark tests
 109    where in principle the glibc code is OK but the tests fail because
 110    of limitations of the libgcc support for that format (e.g. GCC bug
 111    59666, in non-default rounding modes).  */
 112 #define TEST_COND_ibm128_libgcc TEST_COND_ibm128
 113
 114 /* Mark a test as expected to fail for ibm128-libgcc.  This is used
 115    via XFAIL_ROUNDING_IBM128_LIBGCC, which gen-libm-test.pl transforms
 116    appropriately for each rounding mode.  */
 117 #define XFAIL_IBM128_LIBGCC (TEST_COND_ibm128_libgcc ? XFAIL_TEST : 0)
 118
 119 /* Number of bits in NaN payload.  */
 120 #if TEST_COND_ibm128
 121 # define PAYLOAD_DIG (DBL_MANT_DIG - 2)
 122 #else
 123 # define PAYLOAD_DIG (MANT_DIG - 2)
 124 #endif
 125
 126 /* Values underflowing only for float.  */
 127 #if TEST_COND_binary32
 128 # define UNDERFLOW_EXCEPTION_FLOAT      UNDERFLOW_EXCEPTION
 129 # define UNDERFLOW_EXCEPTION_OK_FLOAT   UNDERFLOW_EXCEPTION_OK
 130 #else
 131 # define UNDERFLOW_EXCEPTION_FLOAT      0
 132 # define UNDERFLOW_EXCEPTION_OK_FLOAT   0
 133 #endif
 134
 135 /* Values underflowing only for double or types with a larger least
 136    positive normal value.  */
 137 #if TEST_COND_binary32 || TEST_COND_binary64 || TEST_COND_ibm128
 138 # define UNDERFLOW_EXCEPTION_DOUBLE     UNDERFLOW_EXCEPTION
 139 # define UNDERFLOW_EXCEPTION_OK_DOUBLE  UNDERFLOW_EXCEPTION_OK
 140 #else
 141 # define UNDERFLOW_EXCEPTION_DOUBLE     0
 142 # define UNDERFLOW_EXCEPTION_OK_DOUBLE  0
 143 #endif
 144
 145 /* Values underflowing only for IBM long double or types with a larger least
 146    positive normal value.  */
 147 #if TEST_COND_binary32 || TEST_COND_ibm128
 148 # define UNDERFLOW_EXCEPTION_LDOUBLE_IBM        UNDERFLOW_EXCEPTION
 149 #else
 150 # define UNDERFLOW_EXCEPTION_LDOUBLE_IBM        0
 151 #endif
 152
 153 /* Values underflowing on architectures detecting tininess before
 154    rounding, but not on those detecting tininess after rounding.  */
 155 #define UNDERFLOW_EXCEPTION_BEFORE_ROUNDING     (TININESS_AFTER_ROUNDING \
 156                                                  ? 0                    \
 157                                                  : UNDERFLOW_EXCEPTION)
 158
 159 #if LONG_MAX == 0x7fffffff
 160 # define TEST_COND_long32       1
 161 # define TEST_COND_long64       0
 162 #else
 163 # define TEST_COND_long32       0
 164 # define TEST_COND_long64       1
 165 #endif
 166 #define TEST_COND_before_rounding       (!TININESS_AFTER_ROUNDING)
 167 #define TEST_COND_after_rounding        TININESS_AFTER_ROUNDING
 168
 169 int enable_test (int);
 170 void init_max_error (const char *, int);
 171 void print_max_error (const char *);
 172 void print_complex_max_error (const char *);
 173 void check_float (const char *, FLOAT, FLOAT, int);
 174 void check_complex (const char *, __complex__ FLOAT, __complex__ FLOAT, int);
 175 void check_int (const char *, int, int, int);
 176 void check_long (const char *, long int, long int, int);
 177 void check_bool (const char *, int, int, int);
 178 void check_longlong (const char *, long long int, long long int, int);
 179 void check_intmax_t (const char *, intmax_t, intmax_t, int);
 180 void check_uintmax_t (const char *, uintmax_t, uintmax_t, int);
 181 void libm_test_init (int, char **);
 182 int libm_test_finish (void);
 183
 184 #endif /* LIBM_TEST_SUPPORT_H.  */