gcc/real.h

   1 /* Definitions of floating-point access for GNU compiler.
   2    Copyright (C) 1989, 1991, 1994, 1996, 1997, 1998, 1999,
   3    2000, 2002, 2003 Free Software Foundation, Inc.
   4
   5    This file is part of GCC.
   6
   7    GCC is free software; you can redistribute it and/or modify it under
   8    the terms of the GNU General Public License as published by the Free
   9    Software Foundation; either version 2, or (at your option) any later
  10    version.
  11
  12    GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13    WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15    for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GCC; see the file COPYING.  If not, write to the Free
  19    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20    02111-1307, USA.  */
  21
  22 #ifndef GCC_REAL_H
  23 #define GCC_REAL_H
  24
  25 #include "machmode.h"
  26
  27 /* An expanded form of the represented number.  */
  28
  29 /* Enumerate the special cases of numbers that we encounter.  */
  30 enum real_value_class {
  31   rvc_zero,
  32   rvc_normal,
  33   rvc_inf,
  34   rvc_nan
  35 };
  36
  37 #define SIGNIFICAND_BITS        (128 + HOST_BITS_PER_LONG)
  38 #define EXP_BITS                (32 - 4)
  39 #define MAX_EXP                 ((1 << (EXP_BITS - 1)) - 1)
  40 #define SIGSZ                   (SIGNIFICAND_BITS / HOST_BITS_PER_LONG)
  41 #define SIG_MSB                 ((unsigned long)1 << (HOST_BITS_PER_LONG - 1))
  42
  43 struct real_value GTY(())
  44 {
  45   ENUM_BITFIELD (real_value_class) class : 2;
  46   unsigned int sign : 1;
  47   unsigned int signalling : 1;
  48   signed int exp : EXP_BITS;
  49   unsigned long sig[SIGSZ];
  50 };
  51
  52 /* Various headers condition prototypes on #ifdef REAL_VALUE_TYPE, so it
  53    needs to be a macro.  We do need to continue to have a structure tag
  54    so that other headers can forward declare it.  */
  55 #define REAL_VALUE_TYPE struct real_value
  56
  57 /* We store a REAL_VALUE_TYPE into an rtx, and we do this by putting it in
  58    consecutive "w" slots.  Moreover, we've got to compute the number of "w"
  59    slots at preprocessor time, which means we can't use sizeof.  Guess.  */
  60
  61 #define REAL_VALUE_TYPE_SIZE (SIGNIFICAND_BITS + 32)
  62 #define REAL_WIDTH \
  63   (REAL_VALUE_TYPE_SIZE/HOST_BITS_PER_WIDE_INT \
  64    + (REAL_VALUE_TYPE_SIZE%HOST_BITS_PER_WIDE_INT ? 1 : 0)) /* round up */
  65
  66 /* Verify the guess.  */
  67 extern char test_real_width
  68   [sizeof(REAL_VALUE_TYPE) <= REAL_WIDTH*sizeof(HOST_WIDE_INT) ? 1 : -1];
  69
  70 /* Calculate the format for CONST_DOUBLE.  We need as many slots as
  71    are necessary to overlay a REAL_VALUE_TYPE on them.  This could be
  72    as many as four (32-bit HOST_WIDE_INT, 128-bit REAL_VALUE_TYPE).
  73
  74    A number of places assume that there are always at least two 'w'
  75    slots in a CONST_DOUBLE, so we provide them even if one would suffice.  */
  76
  77 #if REAL_WIDTH == 1
  78 # define CONST_DOUBLE_FORMAT     "ww"
  79 #else
  80 # if REAL_WIDTH == 2
  81 #  define CONST_DOUBLE_FORMAT    "ww"
  82 # else
  83 #  if REAL_WIDTH == 3
  84 #   define CONST_DOUBLE_FORMAT   "www"
  85 #  else
  86 #   if REAL_WIDTH == 4
  87 #    define CONST_DOUBLE_FORMAT  "wwww"
  88 #   else
  89 #    if REAL_WIDTH == 5
  90 #     define CONST_DOUBLE_FORMAT "wwwww"
  91 #    else
  92 #     if REAL_WIDTH == 6
  93 #      define CONST_DOUBLE_FORMAT "wwwwww"
  94 #     else
  95        #error "REAL_WIDTH > 6 not supported"
  96 #     endif
  97 #    endif
  98 #   endif
  99 #  endif
 100 # endif
 101 #endif
 102
 103
 104 /* Describes the properties of the specific target format in use.  */
 105 struct real_format
 106 {
 107   /* Move to and from the target bytes.  */
 108   void (*encode) PARAMS ((const struct real_format *, long *,
 109                           const REAL_VALUE_TYPE *));
 110   void (*decode) PARAMS ((const struct real_format *, REAL_VALUE_TYPE *,
 111                           const long *));
 112
 113   /* The radix of the exponent and digits of the significand.  */
 114   int b;
 115
 116   /* log2(b).  */
 117   int log2_b;
 118
 119   /* Size of the significand in digits of radix B.  */
 120   int p;
 121
 122   /* The minimum negative integer, x, such that b**(x-1) is normalized.  */
 123   int emin;
 124
 125   /* The maximum integer, x, such that b**(x-1) is representable.  */
 126   int emax;
 127
 128   /* The bit position of the sign bit, or -1 for a complex encoding.  */
 129   int signbit;
 130
 131   /* Properties of the format.  */
 132   bool has_nans;
 133   bool has_inf;
 134   bool has_denorm;
 135   bool has_signed_zero;
 136   bool qnan_msb_set;
 137 };
 138
 139
 140 /* The target format used for each floating floating point mode.
 141    Indexed by MODE - QFmode.  */
 142 extern const struct real_format *real_format_for_mode[TFmode - QFmode + 1];
 143
 144
 145 /* Declare functions in real.c.  */
 146
 147 /* Binary or unary arithmetic on tree_code.  */
 148 extern void real_arithmetic     PARAMS ((REAL_VALUE_TYPE *, int,
 149                                          const REAL_VALUE_TYPE *,
 150                                          const REAL_VALUE_TYPE *));
 151
 152 /* Compare reals by tree_code.  */
 153 extern bool real_compare        PARAMS ((int, const REAL_VALUE_TYPE *,
 154                                          const REAL_VALUE_TYPE *));
 155
 156 /* Determine whether a floating-point value X is infinite.  */
 157 extern bool real_isinf          PARAMS ((const REAL_VALUE_TYPE *));
 158
 159 /* Determine whether a floating-point value X is a NaN.  */
 160 extern bool real_isnan          PARAMS ((const REAL_VALUE_TYPE *));
 161
 162 /* Determine whether a floating-point value X is negative.  */
 163 extern bool real_isneg          PARAMS ((const REAL_VALUE_TYPE *));
 164
 165 /* Determine whether a floating-point value X is minus zero.  */
 166 extern bool real_isnegzero      PARAMS ((const REAL_VALUE_TYPE *));
 167
 168 /* Compare two floating-point objects for bitwise identity.  */
 169 extern bool real_identical      PARAMS ((const REAL_VALUE_TYPE *,
 170                                          const REAL_VALUE_TYPE *));
 171
 172 /* Extend or truncate to a new mode.  */
 173 extern void real_convert        PARAMS ((REAL_VALUE_TYPE *,
 174                                          enum machine_mode,
 175                                          const REAL_VALUE_TYPE *));
 176
 177 /* Return true if truncating to NEW is exact.  */
 178 extern bool exact_real_truncate PARAMS ((enum machine_mode,
 179                                          const REAL_VALUE_TYPE *));
 180
 181 /* Render R as a decimal floating point constant.  */
 182 extern void real_to_decimal     PARAMS ((char *, const REAL_VALUE_TYPE *,
 183                                          size_t, size_t, int));
 184
 185 /* Render R as a hexadecimal floating point constant.  */
 186 extern void real_to_hexadecimal PARAMS ((char *, const REAL_VALUE_TYPE *,
 187                                          size_t, size_t, int));
 188
 189 /* Render R as an integer.  */
 190 extern HOST_WIDE_INT real_to_integer PARAMS ((const REAL_VALUE_TYPE *));
 191 extern void real_to_integer2 PARAMS ((HOST_WIDE_INT *, HOST_WIDE_INT *,
 192                                       const REAL_VALUE_TYPE *));
 193
 194 /* Initialize R from a decimal or hexadecimal string.  */
 195 extern void real_from_string    PARAMS ((REAL_VALUE_TYPE *, const char *));
 196
 197 /* Initialize R from an integer pair HIGH/LOW.  */
 198 extern void real_from_integer   PARAMS ((REAL_VALUE_TYPE *,
 199                                          enum machine_mode,
 200                                          unsigned HOST_WIDE_INT,
 201                                          HOST_WIDE_INT, int));
 202
 203 extern long real_to_target_fmt  PARAMS ((long *, const REAL_VALUE_TYPE *,
 204                                          const struct real_format *));
 205 extern long real_to_target      PARAMS ((long *, const REAL_VALUE_TYPE *,
 206                                          enum machine_mode));
 207
 208 extern void real_from_target_fmt PARAMS ((REAL_VALUE_TYPE *, const long *,
 209                                           const struct real_format *));
 210 extern void real_from_target    PARAMS ((REAL_VALUE_TYPE *, const long *,
 211                                          enum machine_mode));
 212
 213 extern void real_inf            PARAMS ((REAL_VALUE_TYPE *));
 214
 215 extern bool real_nan            PARAMS ((REAL_VALUE_TYPE *, const char *,
 216                                          int, enum machine_mode));
 217
 218 extern void real_2expN          PARAMS ((REAL_VALUE_TYPE *, int));
 219
 220 extern unsigned int real_hash   PARAMS ((const REAL_VALUE_TYPE *));
 221
 222
 223 /* Target formats defined in real.c.  */
 224 extern const struct real_format ieee_single_format;
 225 extern const struct real_format ieee_double_format;
 226 extern const struct real_format ieee_extended_motorola_format;
 227 extern const struct real_format ieee_extended_intel_96_format;
 228 extern const struct real_format ieee_extended_intel_128_format;
 229 extern const struct real_format ibm_extended_format;
 230 extern const struct real_format ieee_quad_format;
 231 extern const struct real_format vax_f_format;
 232 extern const struct real_format vax_d_format;
 233 extern const struct real_format vax_g_format;
 234 extern const struct real_format i370_single_format;
 235 extern const struct real_format i370_double_format;
 236 extern const struct real_format c4x_single_format;
 237 extern const struct real_format c4x_extended_format;
 238 extern const struct real_format real_internal_format;
 239
 240
 241 /* ====================================================================== */
 242 /* Crap.  */
 243
 244 #define REAL_ARITHMETIC(value, code, d1, d2) \
 245   real_arithmetic (&(value), code, &(d1), &(d2))
 246
 247 #define REAL_VALUES_IDENTICAL(x, y)     real_identical (&(x), &(y))
 248 #define REAL_VALUES_EQUAL(x, y)         real_compare (EQ_EXPR, &(x), &(y))
 249 #define REAL_VALUES_LESS(x, y)          real_compare (LT_EXPR, &(x), &(y))
 250
 251 /* Determine whether a floating-point value X is infinite.  */
 252 #define REAL_VALUE_ISINF(x)             real_isinf (&(x))
 253
 254 /* Determine whether a floating-point value X is a NaN.  */
 255 #define REAL_VALUE_ISNAN(x)             real_isnan (&(x))
 256
 257 /* Determine whether a floating-point value X is negative.  */
 258 #define REAL_VALUE_NEGATIVE(x)          real_isneg (&(x))
 259
 260 /* Determine whether a floating-point value X is minus zero.  */
 261 #define REAL_VALUE_MINUS_ZERO(x)        real_isnegzero (&(x))
 262
 263 /* IN is a REAL_VALUE_TYPE.  OUT is an array of longs.  */
 264 #define REAL_VALUE_TO_TARGET_LONG_DOUBLE(IN, OUT)                       \
 265   real_to_target (OUT, &(IN),                                           \
 266                   mode_for_size (LONG_DOUBLE_TYPE_SIZE, MODE_FLOAT, 0))
 267
 268 #define REAL_VALUE_TO_TARGET_DOUBLE(IN, OUT) \
 269   real_to_target (OUT, &(IN), mode_for_size (64, MODE_FLOAT, 0))
 270
 271 /* IN is a REAL_VALUE_TYPE.  OUT is a long.  */
 272 #define REAL_VALUE_TO_TARGET_SINGLE(IN, OUT) \
 273   ((OUT) = real_to_target (NULL, &(IN), mode_for_size (32, MODE_FLOAT, 0)))
 274
 275 #define REAL_VALUE_FROM_INT(r, lo, hi, mode) \
 276   real_from_integer (&(r), mode, lo, hi, 0)
 277
 278 #define REAL_VALUE_FROM_UNSIGNED_INT(r, lo, hi, mode) \
 279   real_from_integer (&(r), mode, lo, hi, 1)
 280
 281 extern REAL_VALUE_TYPE real_value_truncate PARAMS ((enum machine_mode,
 282                                                     REAL_VALUE_TYPE));
 283
 284 #define REAL_VALUE_TO_INT(plow, phigh, r) \
 285   real_to_integer2 (plow, phigh, &(r))
 286
 287 extern REAL_VALUE_TYPE real_arithmetic2 PARAMS ((int, const REAL_VALUE_TYPE *,
 288                                                  const REAL_VALUE_TYPE *));
 289
 290 #define REAL_VALUE_NEGATE(X) \
 291   real_arithmetic2 (NEGATE_EXPR, &(X), NULL)
 292
 293 #define REAL_VALUE_ABS(X) \
 294   real_arithmetic2 (ABS_EXPR, &(X), NULL)
 295
 296 extern int significand_size PARAMS ((enum machine_mode));
 297
 298 extern REAL_VALUE_TYPE real_from_string2 PARAMS ((const char *,
 299                                                   enum machine_mode));
 300
 301 #define REAL_VALUE_ATOF(s, m) \
 302   real_from_string2 (s, m)
 303
 304 #define CONST_DOUBLE_ATOF(s, m) \
 305   CONST_DOUBLE_FROM_REAL_VALUE (real_from_string2 (s, m), m)
 306
 307 #define REAL_VALUE_FIX(r) \
 308   real_to_integer (&(r))
 309
 310 /* ??? Not quite right.  */
 311 #define REAL_VALUE_UNSIGNED_FIX(r) \
 312   real_to_integer (&(r))
 313
 314 /* ??? These were added for Paranoia support.  */
 315
 316 /* Return floor log2(R).  */
 317 extern int real_exponent        PARAMS ((const REAL_VALUE_TYPE *));
 318
 319 /* R = A * 2**EXP.  */
 320 extern void real_ldexp          PARAMS ((REAL_VALUE_TYPE *,
 321                                          const REAL_VALUE_TYPE *, int));
 322
 323 /* **** End of software floating point emulator interface macros **** */
 324 \f
 325 /* Constant real values 0, 1, 2, and -1.  */
 326
 327 extern REAL_VALUE_TYPE dconst0;
 328 extern REAL_VALUE_TYPE dconst1;
 329 extern REAL_VALUE_TYPE dconst2;
 330 extern REAL_VALUE_TYPE dconstm1;
 331
 332 /* Function to return a real value (not a tree node)
 333    from a given integer constant.  */
 334 REAL_VALUE_TYPE real_value_from_int_cst PARAMS ((union tree_node *,
 335                                                  union tree_node *));
 336
 337 /* Given a CONST_DOUBLE in FROM, store into TO the value it represents.  */
 338 #define REAL_VALUE_FROM_CONST_DOUBLE(to, from) \
 339   memcpy (&(to), &CONST_DOUBLE_LOW ((from)), sizeof (REAL_VALUE_TYPE))
 340
 341 /* Return a CONST_DOUBLE with value R and mode M.  */
 342 #define CONST_DOUBLE_FROM_REAL_VALUE(r, m) \
 343   const_double_from_real_value (r, m)
 344 extern rtx const_double_from_real_value PARAMS ((REAL_VALUE_TYPE,
 345                                                  enum machine_mode));
 346
 347 /* Replace R by 1/R in the given machine mode, if the result is exact.  */
 348 extern bool exact_real_inverse  PARAMS ((enum machine_mode, REAL_VALUE_TYPE *));
 349
 350 /* In tree.c: wrap up a REAL_VALUE_TYPE in a tree node.  */
 351 extern tree build_real                  PARAMS ((tree, REAL_VALUE_TYPE));
 352
 353 /* Calculate R as the square root of X in the given machine mode.  */
 354 extern bool real_sqrt                   PARAMS ((REAL_VALUE_TYPE *,
 355                                                  enum machine_mode,
 356                                                  const REAL_VALUE_TYPE *));
 357
 358 #endif /* ! GCC_REAL_H */