OSDN Git Service

PR middle-end/40500
[pf3gnuchains/gcc-fork.git] / 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, 2004, 2005, 2007, 2008 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 3, 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 COPYING3.  If not see
19    <http://www.gnu.org/licenses/>.  */
20
21 #ifndef GCC_REAL_H
22 #define GCC_REAL_H
23
24 #ifndef GENERATOR_FILE
25 #include <gmp.h>
26 #include <mpfr.h>
27 #ifdef HAVE_mpc
28 #include <mpc.h>
29 # ifdef HAVE_mpc
30 extern tree do_mpc_arg2 (tree, tree, tree, int, int (*)(mpc_ptr, mpc_srcptr, mpc_srcptr, mpc_rnd_t));
31 # endif
32 # if MPC_VERSION >= MPC_VERSION_NUM(0,6,1)
33 #  define HAVE_mpc_pow
34 # endif
35 #endif
36 #endif
37 #include "machmode.h"
38
39 /* An expanded form of the represented number.  */
40
41 /* Enumerate the special cases of numbers that we encounter.  */
42 enum real_value_class {
43   rvc_zero,
44   rvc_normal,
45   rvc_inf,
46   rvc_nan
47 };
48
49 #define SIGNIFICAND_BITS        (128 + HOST_BITS_PER_LONG)
50 #define EXP_BITS                (32 - 6)
51 #define MAX_EXP                 ((1 << (EXP_BITS - 1)) - 1)
52 #define SIGSZ                   (SIGNIFICAND_BITS / HOST_BITS_PER_LONG)
53 #define SIG_MSB                 ((unsigned long)1 << (HOST_BITS_PER_LONG - 1))
54
55 struct GTY(()) real_value {
56   /* Use the same underlying type for all bit-fields, so as to make
57      sure they're packed together, otherwise REAL_VALUE_TYPE_SIZE will
58      be miscomputed.  */
59   unsigned int /* ENUM_BITFIELD (real_value_class) */ cl : 2;
60   unsigned int decimal : 1;
61   unsigned int sign : 1;
62   unsigned int signalling : 1;
63   unsigned int canonical : 1;
64   unsigned int uexp : EXP_BITS;
65   unsigned long sig[SIGSZ];
66 };
67
68 #define REAL_EXP(REAL) \
69   ((int)((REAL)->uexp ^ (unsigned int)(1 << (EXP_BITS - 1))) \
70    - (1 << (EXP_BITS - 1)))
71 #define SET_REAL_EXP(REAL, EXP) \
72   ((REAL)->uexp = ((unsigned int)(EXP) & (unsigned int)((1 << EXP_BITS) - 1)))
73
74 /* Various headers condition prototypes on #ifdef REAL_VALUE_TYPE, so it
75    needs to be a macro.  We do need to continue to have a structure tag
76    so that other headers can forward declare it.  */
77 #define REAL_VALUE_TYPE struct real_value
78
79 /* We store a REAL_VALUE_TYPE into an rtx, and we do this by putting it in
80    consecutive "w" slots.  Moreover, we've got to compute the number of "w"
81    slots at preprocessor time, which means we can't use sizeof.  Guess.  */
82
83 #define REAL_VALUE_TYPE_SIZE (SIGNIFICAND_BITS + 32)
84 #define REAL_WIDTH \
85   (REAL_VALUE_TYPE_SIZE/HOST_BITS_PER_WIDE_INT \
86    + (REAL_VALUE_TYPE_SIZE%HOST_BITS_PER_WIDE_INT ? 1 : 0)) /* round up */
87
88 /* Verify the guess.  */
89 extern char test_real_width
90   [sizeof(REAL_VALUE_TYPE) <= REAL_WIDTH*sizeof(HOST_WIDE_INT) ? 1 : -1];
91
92 /* Calculate the format for CONST_DOUBLE.  We need as many slots as
93    are necessary to overlay a REAL_VALUE_TYPE on them.  This could be
94    as many as four (32-bit HOST_WIDE_INT, 128-bit REAL_VALUE_TYPE).
95
96    A number of places assume that there are always at least two 'w'
97    slots in a CONST_DOUBLE, so we provide them even if one would suffice.  */
98
99 #if REAL_WIDTH == 1
100 # define CONST_DOUBLE_FORMAT     "ww"
101 #else
102 # if REAL_WIDTH == 2
103 #  define CONST_DOUBLE_FORMAT    "ww"
104 # else
105 #  if REAL_WIDTH == 3
106 #   define CONST_DOUBLE_FORMAT   "www"
107 #  else
108 #   if REAL_WIDTH == 4
109 #    define CONST_DOUBLE_FORMAT  "wwww"
110 #   else
111 #    if REAL_WIDTH == 5
112 #     define CONST_DOUBLE_FORMAT "wwwww"
113 #    else
114 #     if REAL_WIDTH == 6
115 #      define CONST_DOUBLE_FORMAT "wwwwww"
116 #     else
117        #error "REAL_WIDTH > 6 not supported"
118 #     endif
119 #    endif
120 #   endif
121 #  endif
122 # endif
123 #endif
124
125
126 /* Describes the properties of the specific target format in use.  */
127 struct real_format
128 {
129   /* Move to and from the target bytes.  */
130   void (*encode) (const struct real_format *, long *,
131                   const REAL_VALUE_TYPE *);
132   void (*decode) (const struct real_format *, REAL_VALUE_TYPE *,
133                   const long *);
134
135   /* The radix of the exponent and digits of the significand.  */
136   int b;
137
138   /* Size of the significand in digits of radix B.  */
139   int p;
140
141   /* Size of the significant of a NaN, in digits of radix B.  */
142   int pnan;
143
144   /* The minimum negative integer, x, such that b**(x-1) is normalized.  */
145   int emin;
146
147   /* The maximum integer, x, such that b**(x-1) is representable.  */
148   int emax;
149
150   /* The bit position of the sign bit, for determining whether a value
151      is positive/negative, or -1 for a complex encoding.  */
152   int signbit_ro;
153
154   /* The bit position of the sign bit, for changing the sign of a number,
155      or -1 for a complex encoding.  */
156   int signbit_rw;
157
158   /* Default rounding mode for operations on this format.  */
159   bool round_towards_zero;
160   bool has_sign_dependent_rounding;
161
162   /* Properties of the format.  */
163   bool has_nans;
164   bool has_inf;
165   bool has_denorm;
166   bool has_signed_zero;
167   bool qnan_msb_set;
168   bool canonical_nan_lsbs_set;
169 };
170
171
172 /* The target format used for each floating point mode.
173    Float modes are followed by decimal float modes, with entries for
174    float modes indexed by (MODE - first float mode), and entries for
175    decimal float modes indexed by (MODE - first decimal float mode) +
176    the number of float modes.  */
177 extern const struct real_format *
178   real_format_for_mode[MAX_MODE_FLOAT - MIN_MODE_FLOAT + 1
179                        + MAX_MODE_DECIMAL_FLOAT - MIN_MODE_DECIMAL_FLOAT + 1];
180
181 #define REAL_MODE_FORMAT(MODE)                                          \
182   (real_format_for_mode[DECIMAL_FLOAT_MODE_P (MODE)                     \
183                         ? (((MODE) - MIN_MODE_DECIMAL_FLOAT)            \
184                            + (MAX_MODE_FLOAT - MIN_MODE_FLOAT + 1))     \
185                         : ((MODE) - MIN_MODE_FLOAT)])
186
187 #define FLOAT_MODE_FORMAT(MODE) \
188   (REAL_MODE_FORMAT (SCALAR_FLOAT_MODE_P (MODE)? (MODE) \
189                                                : GET_MODE_INNER (MODE)))
190
191 /* The following macro determines whether the floating point format is
192    composite, i.e. may contain non-consecutive mantissa bits, in which
193    case compile-time FP overflow may not model run-time overflow.  */
194 #define MODE_COMPOSITE_P(MODE) \
195   (FLOAT_MODE_P (MODE) \
196    && FLOAT_MODE_FORMAT (MODE)->pnan < FLOAT_MODE_FORMAT (MODE)->p)
197
198 /* Accessor macros for format properties.  */
199 #define MODE_HAS_NANS(MODE) \
200   (FLOAT_MODE_P (MODE) && FLOAT_MODE_FORMAT (MODE)->has_nans)
201 #define MODE_HAS_INFINITIES(MODE) \
202   (FLOAT_MODE_P (MODE) && FLOAT_MODE_FORMAT (MODE)->has_inf)
203 #define MODE_HAS_SIGNED_ZEROS(MODE) \
204   (FLOAT_MODE_P (MODE) && FLOAT_MODE_FORMAT (MODE)->has_signed_zero)
205 #define MODE_HAS_SIGN_DEPENDENT_ROUNDING(MODE) \
206   (FLOAT_MODE_P (MODE) \
207    && FLOAT_MODE_FORMAT (MODE)->has_sign_dependent_rounding)
208
209
210 /* Declare functions in real.c.  */
211
212 /* Binary or unary arithmetic on tree_code.  */
213 extern bool real_arithmetic (REAL_VALUE_TYPE *, int, const REAL_VALUE_TYPE *,
214                              const REAL_VALUE_TYPE *);
215
216 /* Compare reals by tree_code.  */
217 extern bool real_compare (int, const REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *);
218
219 /* Determine whether a floating-point value X is infinite.  */
220 extern bool real_isinf (const REAL_VALUE_TYPE *);
221
222 /* Determine whether a floating-point value X is a NaN.  */
223 extern bool real_isnan (const REAL_VALUE_TYPE *);
224
225 /* Determine whether a floating-point value X is finite.  */
226 extern bool real_isfinite (const REAL_VALUE_TYPE *);
227
228 /* Determine whether a floating-point value X is negative.  */
229 extern bool real_isneg (const REAL_VALUE_TYPE *);
230
231 /* Determine whether a floating-point value X is minus zero.  */
232 extern bool real_isnegzero (const REAL_VALUE_TYPE *);
233
234 /* Compare two floating-point objects for bitwise identity.  */
235 extern bool real_identical (const REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *);
236
237 /* Extend or truncate to a new mode.  */
238 extern void real_convert (REAL_VALUE_TYPE *, enum machine_mode,
239                           const REAL_VALUE_TYPE *);
240
241 /* Return true if truncating to NEW is exact.  */
242 extern bool exact_real_truncate (enum machine_mode, const REAL_VALUE_TYPE *);
243
244 /* Render R as a decimal floating point constant.  */
245 extern void real_to_decimal (char *, const REAL_VALUE_TYPE *, size_t,
246                              size_t, int);
247
248 /* Render R as a decimal floating point constant, rounded so as to be
249    parsed back to the same value when interpreted in mode MODE.  */
250 extern void real_to_decimal_for_mode (char *, const REAL_VALUE_TYPE *, size_t,
251                                       size_t, int, enum machine_mode);
252
253 /* Render R as a hexadecimal floating point constant.  */
254 extern void real_to_hexadecimal (char *, const REAL_VALUE_TYPE *,
255                                  size_t, size_t, int);
256
257 /* Render R as an integer.  */
258 extern HOST_WIDE_INT real_to_integer (const REAL_VALUE_TYPE *);
259 extern void real_to_integer2 (HOST_WIDE_INT *, HOST_WIDE_INT *,
260                               const REAL_VALUE_TYPE *);
261
262 /* Initialize R from a decimal or hexadecimal string.  Return -1 if
263    the value underflows, +1 if overflows, and 0 otherwise.  */
264 extern int real_from_string (REAL_VALUE_TYPE *, const char *);
265 /* Wrapper to allow different internal representation for decimal floats. */
266 extern void real_from_string3 (REAL_VALUE_TYPE *, const char *, enum machine_mode);
267
268 /* Initialize R from an integer pair HIGH/LOW.  */
269 extern void real_from_integer (REAL_VALUE_TYPE *, enum machine_mode,
270                                unsigned HOST_WIDE_INT, HOST_WIDE_INT, int);
271
272 extern long real_to_target_fmt (long *, const REAL_VALUE_TYPE *,
273                                 const struct real_format *);
274 extern long real_to_target (long *, const REAL_VALUE_TYPE *, enum machine_mode);
275
276 extern void real_from_target_fmt (REAL_VALUE_TYPE *, const long *,
277                                   const struct real_format *);
278 extern void real_from_target (REAL_VALUE_TYPE *, const long *,
279                               enum machine_mode);
280
281 extern void real_inf (REAL_VALUE_TYPE *);
282
283 extern bool real_nan (REAL_VALUE_TYPE *, const char *, int, enum machine_mode);
284
285 extern void real_maxval (REAL_VALUE_TYPE *, int, enum machine_mode);
286
287 extern void real_2expN (REAL_VALUE_TYPE *, int, enum machine_mode);
288
289 extern unsigned int real_hash (const REAL_VALUE_TYPE *);
290
291
292 /* Target formats defined in real.c.  */
293 extern const struct real_format ieee_single_format;
294 extern const struct real_format mips_single_format;
295 extern const struct real_format motorola_single_format;
296 extern const struct real_format spu_single_format;
297 extern const struct real_format ieee_double_format;
298 extern const struct real_format mips_double_format;
299 extern const struct real_format motorola_double_format;
300 extern const struct real_format ieee_extended_motorola_format;
301 extern const struct real_format ieee_extended_intel_96_format;
302 extern const struct real_format ieee_extended_intel_96_round_53_format;
303 extern const struct real_format ieee_extended_intel_128_format;
304 extern const struct real_format ibm_extended_format;
305 extern const struct real_format mips_extended_format;
306 extern const struct real_format ieee_quad_format;
307 extern const struct real_format mips_quad_format;
308 extern const struct real_format vax_f_format;
309 extern const struct real_format vax_d_format;
310 extern const struct real_format vax_g_format;
311 extern const struct real_format real_internal_format;
312 extern const struct real_format decimal_single_format;
313 extern const struct real_format decimal_double_format;
314 extern const struct real_format decimal_quad_format;
315 extern const struct real_format ieee_half_format;
316 extern const struct real_format arm_half_format;
317
318
319 /* ====================================================================== */
320 /* Crap.  */
321
322 #define REAL_ARITHMETIC(value, code, d1, d2) \
323   real_arithmetic (&(value), code, &(d1), &(d2))
324
325 #define REAL_VALUES_IDENTICAL(x, y)     real_identical (&(x), &(y))
326 #define REAL_VALUES_EQUAL(x, y)         real_compare (EQ_EXPR, &(x), &(y))
327 #define REAL_VALUES_LESS(x, y)          real_compare (LT_EXPR, &(x), &(y))
328
329 /* Determine whether a floating-point value X is infinite.  */
330 #define REAL_VALUE_ISINF(x)             real_isinf (&(x))
331
332 /* Determine whether a floating-point value X is a NaN.  */
333 #define REAL_VALUE_ISNAN(x)             real_isnan (&(x))
334
335 /* Determine whether a floating-point value X is negative.  */
336 #define REAL_VALUE_NEGATIVE(x)          real_isneg (&(x))
337
338 /* Determine whether a floating-point value X is minus zero.  */
339 #define REAL_VALUE_MINUS_ZERO(x)        real_isnegzero (&(x))
340
341 /* IN is a REAL_VALUE_TYPE.  OUT is an array of longs.  */
342 #define REAL_VALUE_TO_TARGET_LONG_DOUBLE(IN, OUT)                       \
343   real_to_target (OUT, &(IN),                                           \
344                   mode_for_size (LONG_DOUBLE_TYPE_SIZE, MODE_FLOAT, 0))
345
346 #define REAL_VALUE_TO_TARGET_DOUBLE(IN, OUT) \
347   real_to_target (OUT, &(IN), mode_for_size (64, MODE_FLOAT, 0))
348
349 /* IN is a REAL_VALUE_TYPE.  OUT is a long.  */
350 #define REAL_VALUE_TO_TARGET_SINGLE(IN, OUT) \
351   ((OUT) = real_to_target (NULL, &(IN), mode_for_size (32, MODE_FLOAT, 0)))
352
353 #define REAL_VALUE_FROM_INT(r, lo, hi, mode) \
354   real_from_integer (&(r), mode, lo, hi, 0)
355
356 #define REAL_VALUE_FROM_UNSIGNED_INT(r, lo, hi, mode) \
357   real_from_integer (&(r), mode, lo, hi, 1)
358
359 /* Real values to IEEE 754 decimal floats.  */
360
361 /* IN is a REAL_VALUE_TYPE.  OUT is an array of longs.  */
362 #define REAL_VALUE_TO_TARGET_DECIMAL128(IN, OUT) \
363   real_to_target (OUT, &(IN), mode_for_size (128, MODE_DECIMAL_FLOAT, 0))
364
365 #define REAL_VALUE_TO_TARGET_DECIMAL64(IN, OUT) \
366   real_to_target (OUT, &(IN), mode_for_size (64, MODE_DECIMAL_FLOAT, 0))
367
368 /* IN is a REAL_VALUE_TYPE.  OUT is a long.  */
369 #define REAL_VALUE_TO_TARGET_DECIMAL32(IN, OUT) \
370   ((OUT) = real_to_target (NULL, &(IN), mode_for_size (32, MODE_DECIMAL_FLOAT, 0)))
371
372 extern REAL_VALUE_TYPE real_value_truncate (enum machine_mode,
373                                             REAL_VALUE_TYPE);
374
375 #define REAL_VALUE_TO_INT(plow, phigh, r) \
376   real_to_integer2 (plow, phigh, &(r))
377
378 extern REAL_VALUE_TYPE real_arithmetic2 (int, const REAL_VALUE_TYPE *,
379                                          const REAL_VALUE_TYPE *);
380
381 #define REAL_VALUE_NEGATE(X) \
382   real_arithmetic2 (NEGATE_EXPR, &(X), NULL)
383
384 #define REAL_VALUE_ABS(X) \
385   real_arithmetic2 (ABS_EXPR, &(X), NULL)
386
387 extern int significand_size (enum machine_mode);
388
389 extern REAL_VALUE_TYPE real_from_string2 (const char *, enum machine_mode);
390
391 #define REAL_VALUE_ATOF(s, m) \
392   real_from_string2 (s, m)
393
394 #define CONST_DOUBLE_ATOF(s, m) \
395   CONST_DOUBLE_FROM_REAL_VALUE (real_from_string2 (s, m), m)
396
397 #define REAL_VALUE_FIX(r) \
398   real_to_integer (&(r))
399
400 /* ??? Not quite right.  */
401 #define REAL_VALUE_UNSIGNED_FIX(r) \
402   real_to_integer (&(r))
403
404 /* ??? These were added for Paranoia support.  */
405
406 /* Return floor log2(R).  */
407 extern int real_exponent (const REAL_VALUE_TYPE *);
408
409 /* R = A * 2**EXP.  */
410 extern void real_ldexp (REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *, int);
411
412 /* **** End of software floating point emulator interface macros **** */
413 \f
414 /* Constant real values 0, 1, 2, -1 and 0.5.  */
415
416 extern REAL_VALUE_TYPE dconst0;
417 extern REAL_VALUE_TYPE dconst1;
418 extern REAL_VALUE_TYPE dconst2;
419 extern REAL_VALUE_TYPE dconstm1;
420 extern REAL_VALUE_TYPE dconsthalf;
421
422 #define dconst_e()  (*dconst_e_ptr ())
423 #define dconst_third()  (*dconst_third_ptr ())
424 #define dconst_sqrt2()  (*dconst_sqrt2_ptr ())
425
426 /* Function to return the real value special constant 'e'.  */
427 extern const REAL_VALUE_TYPE * dconst_e_ptr (void);
428
429 /* Returns the special REAL_VALUE_TYPE corresponding to 1/3.  */
430 extern const REAL_VALUE_TYPE * dconst_third_ptr (void);
431
432 /* Returns the special REAL_VALUE_TYPE corresponding to sqrt(2).  */
433 extern const REAL_VALUE_TYPE * dconst_sqrt2_ptr (void);
434
435 /* Function to return a real value (not a tree node)
436    from a given integer constant.  */
437 REAL_VALUE_TYPE real_value_from_int_cst (const_tree, const_tree);
438
439 /* Given a CONST_DOUBLE in FROM, store into TO the value it represents.  */
440 #define REAL_VALUE_FROM_CONST_DOUBLE(to, from) \
441   ((to) = *CONST_DOUBLE_REAL_VALUE (from))
442
443 /* Return a CONST_DOUBLE with value R and mode M.  */
444 #define CONST_DOUBLE_FROM_REAL_VALUE(r, m) \
445   const_double_from_real_value (r, m)
446 extern rtx const_double_from_real_value (REAL_VALUE_TYPE, enum machine_mode);
447
448 /* Replace R by 1/R in the given machine mode, if the result is exact.  */
449 extern bool exact_real_inverse (enum machine_mode, REAL_VALUE_TYPE *);
450
451 /* Return true if arithmetic on values in IMODE that were promoted
452    from values in TMODE is equivalent to direct arithmetic on values
453    in TMODE.  */
454 bool real_can_shorten_arithmetic (enum machine_mode, enum machine_mode);
455
456 /* In tree.c: wrap up a REAL_VALUE_TYPE in a tree node.  */
457 extern tree build_real (tree, REAL_VALUE_TYPE);
458
459 /* Calculate R as the square root of X in the given machine mode.  */
460 extern bool real_sqrt (REAL_VALUE_TYPE *, enum machine_mode,
461                        const REAL_VALUE_TYPE *);
462
463 /* Calculate R as X raised to the integer exponent N in mode MODE.  */
464 extern bool real_powi (REAL_VALUE_TYPE *, enum machine_mode,
465                        const REAL_VALUE_TYPE *, HOST_WIDE_INT);
466
467 /* Standard round to integer value functions.  */
468 extern void real_trunc (REAL_VALUE_TYPE *, enum machine_mode,
469                         const REAL_VALUE_TYPE *);
470 extern void real_floor (REAL_VALUE_TYPE *, enum machine_mode,
471                         const REAL_VALUE_TYPE *);
472 extern void real_ceil (REAL_VALUE_TYPE *, enum machine_mode,
473                        const REAL_VALUE_TYPE *);
474 extern void real_round (REAL_VALUE_TYPE *, enum machine_mode,
475                         const REAL_VALUE_TYPE *);
476
477 /* Set the sign of R to the sign of X.  */
478 extern void real_copysign (REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *);
479
480 #ifndef GENERATOR_FILE
481 /* Convert between MPFR and REAL_VALUE_TYPE.  The caller is
482    responsible for initializing and clearing the MPFR parameter.  */
483
484 extern void real_from_mpfr (REAL_VALUE_TYPE *, mpfr_srcptr, tree, mp_rnd_t);
485 extern void mpfr_from_real (mpfr_ptr, const REAL_VALUE_TYPE *, mp_rnd_t);
486 #endif
487
488 /* Check whether the real constant value given is an integer.  */
489 extern bool real_isinteger (const REAL_VALUE_TYPE *c, enum machine_mode mode);
490
491 /* Write into BUF the maximum representable finite floating-point
492    number, (1 - b**-p) * b**emax for a given FP format FMT as a hex
493    float string.  BUF must be large enough to contain the result.  */
494 extern void get_max_float (const struct real_format *, char *, size_t);
495 #endif /* ! GCC_REAL_H */