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