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
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
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/>. */
24 #ifndef GENERATOR_FILE
28 extern tree do_mpc_arg2 (tree, tree, tree, int, int (*)(mpc_ptr, mpc_srcptr, mpc_srcptr, mpc_rnd_t));
32 /* An expanded form of the represented number. */
34 /* Enumerate the special cases of numbers that we encounter. */
35 enum real_value_class {
42 #define SIGNIFICAND_BITS (128 + HOST_BITS_PER_LONG)
43 #define EXP_BITS (32 - 6)
44 #define MAX_EXP ((1 << (EXP_BITS - 1)) - 1)
45 #define SIGSZ (SIGNIFICAND_BITS / HOST_BITS_PER_LONG)
46 #define SIG_MSB ((unsigned long)1 << (HOST_BITS_PER_LONG - 1))
48 struct GTY(()) real_value {
49 /* Use the same underlying type for all bit-fields, so as to make
50 sure they're packed together, otherwise REAL_VALUE_TYPE_SIZE will
52 unsigned int /* ENUM_BITFIELD (real_value_class) */ cl : 2;
53 unsigned int decimal : 1;
54 unsigned int sign : 1;
55 unsigned int signalling : 1;
56 unsigned int canonical : 1;
57 unsigned int uexp : EXP_BITS;
58 unsigned long sig[SIGSZ];
61 #define REAL_EXP(REAL) \
62 ((int)((REAL)->uexp ^ (unsigned int)(1 << (EXP_BITS - 1))) \
63 - (1 << (EXP_BITS - 1)))
64 #define SET_REAL_EXP(REAL, EXP) \
65 ((REAL)->uexp = ((unsigned int)(EXP) & (unsigned int)((1 << EXP_BITS) - 1)))
67 /* Various headers condition prototypes on #ifdef REAL_VALUE_TYPE, so it
68 needs to be a macro. We do need to continue to have a structure tag
69 so that other headers can forward declare it. */
70 #define REAL_VALUE_TYPE struct real_value
72 /* We store a REAL_VALUE_TYPE into an rtx, and we do this by putting it in
73 consecutive "w" slots. Moreover, we've got to compute the number of "w"
74 slots at preprocessor time, which means we can't use sizeof. Guess. */
76 #define REAL_VALUE_TYPE_SIZE (SIGNIFICAND_BITS + 32)
78 (REAL_VALUE_TYPE_SIZE/HOST_BITS_PER_WIDE_INT \
79 + (REAL_VALUE_TYPE_SIZE%HOST_BITS_PER_WIDE_INT ? 1 : 0)) /* round up */
81 /* Verify the guess. */
82 extern char test_real_width
83 [sizeof(REAL_VALUE_TYPE) <= REAL_WIDTH*sizeof(HOST_WIDE_INT) ? 1 : -1];
85 /* Calculate the format for CONST_DOUBLE. We need as many slots as
86 are necessary to overlay a REAL_VALUE_TYPE on them. This could be
87 as many as four (32-bit HOST_WIDE_INT, 128-bit REAL_VALUE_TYPE).
89 A number of places assume that there are always at least two 'w'
90 slots in a CONST_DOUBLE, so we provide them even if one would suffice. */
93 # define CONST_DOUBLE_FORMAT "ww"
96 # define CONST_DOUBLE_FORMAT "ww"
99 # define CONST_DOUBLE_FORMAT "www"
102 # define CONST_DOUBLE_FORMAT "wwww"
105 # define CONST_DOUBLE_FORMAT "wwwww"
108 # define CONST_DOUBLE_FORMAT "wwwwww"
110 #error "REAL_WIDTH > 6 not supported"
119 /* Describes the properties of the specific target format in use. */
122 /* Move to and from the target bytes. */
123 void (*encode) (const struct real_format *, long *,
124 const REAL_VALUE_TYPE *);
125 void (*decode) (const struct real_format *, REAL_VALUE_TYPE *,
128 /* The radix of the exponent and digits of the significand. */
131 /* Size of the significand in digits of radix B. */
134 /* Size of the significant of a NaN, in digits of radix B. */
137 /* The minimum negative integer, x, such that b**(x-1) is normalized. */
140 /* The maximum integer, x, such that b**(x-1) is representable. */
143 /* The bit position of the sign bit, for determining whether a value
144 is positive/negative, or -1 for a complex encoding. */
147 /* The bit position of the sign bit, for changing the sign of a number,
148 or -1 for a complex encoding. */
151 /* Default rounding mode for operations on this format. */
152 bool round_towards_zero;
153 bool has_sign_dependent_rounding;
155 /* Properties of the format. */
159 bool has_signed_zero;
161 bool canonical_nan_lsbs_set;
165 /* The target format used for each floating point mode.
166 Float modes are followed by decimal float modes, with entries for
167 float modes indexed by (MODE - first float mode), and entries for
168 decimal float modes indexed by (MODE - first decimal float mode) +
169 the number of float modes. */
170 extern const struct real_format *
171 real_format_for_mode[MAX_MODE_FLOAT - MIN_MODE_FLOAT + 1
172 + MAX_MODE_DECIMAL_FLOAT - MIN_MODE_DECIMAL_FLOAT + 1];
174 #define REAL_MODE_FORMAT(MODE) \
175 (real_format_for_mode[DECIMAL_FLOAT_MODE_P (MODE) \
176 ? (((MODE) - MIN_MODE_DECIMAL_FLOAT) \
177 + (MAX_MODE_FLOAT - MIN_MODE_FLOAT + 1)) \
178 : ((MODE) - MIN_MODE_FLOAT)])
180 #define FLOAT_MODE_FORMAT(MODE) \
181 (REAL_MODE_FORMAT (SCALAR_FLOAT_MODE_P (MODE)? (MODE) \
182 : GET_MODE_INNER (MODE)))
184 /* The following macro determines whether the floating point format is
185 composite, i.e. may contain non-consecutive mantissa bits, in which
186 case compile-time FP overflow may not model run-time overflow. */
187 #define MODE_COMPOSITE_P(MODE) \
188 (FLOAT_MODE_P (MODE) \
189 && FLOAT_MODE_FORMAT (MODE)->pnan < FLOAT_MODE_FORMAT (MODE)->p)
191 /* Accessor macros for format properties. */
192 #define MODE_HAS_NANS(MODE) \
193 (FLOAT_MODE_P (MODE) && FLOAT_MODE_FORMAT (MODE)->has_nans)
194 #define MODE_HAS_INFINITIES(MODE) \
195 (FLOAT_MODE_P (MODE) && FLOAT_MODE_FORMAT (MODE)->has_inf)
196 #define MODE_HAS_SIGNED_ZEROS(MODE) \
197 (FLOAT_MODE_P (MODE) && FLOAT_MODE_FORMAT (MODE)->has_signed_zero)
198 #define MODE_HAS_SIGN_DEPENDENT_ROUNDING(MODE) \
199 (FLOAT_MODE_P (MODE) \
200 && FLOAT_MODE_FORMAT (MODE)->has_sign_dependent_rounding)
203 /* Declare functions in real.c. */
205 /* Binary or unary arithmetic on tree_code. */
206 extern bool real_arithmetic (REAL_VALUE_TYPE *, int, const REAL_VALUE_TYPE *,
207 const REAL_VALUE_TYPE *);
209 /* Compare reals by tree_code. */
210 extern bool real_compare (int, const REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *);
212 /* Determine whether a floating-point value X is infinite. */
213 extern bool real_isinf (const REAL_VALUE_TYPE *);
215 /* Determine whether a floating-point value X is a NaN. */
216 extern bool real_isnan (const REAL_VALUE_TYPE *);
218 /* Determine whether a floating-point value X is finite. */
219 extern bool real_isfinite (const REAL_VALUE_TYPE *);
221 /* Determine whether a floating-point value X is negative. */
222 extern bool real_isneg (const REAL_VALUE_TYPE *);
224 /* Determine whether a floating-point value X is minus zero. */
225 extern bool real_isnegzero (const REAL_VALUE_TYPE *);
227 /* Compare two floating-point objects for bitwise identity. */
228 extern bool real_identical (const REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *);
230 /* Extend or truncate to a new mode. */
231 extern void real_convert (REAL_VALUE_TYPE *, enum machine_mode,
232 const REAL_VALUE_TYPE *);
234 /* Return true if truncating to NEW is exact. */
235 extern bool exact_real_truncate (enum machine_mode, const REAL_VALUE_TYPE *);
237 /* Render R as a decimal floating point constant. */
238 extern void real_to_decimal (char *, const REAL_VALUE_TYPE *, size_t,
241 /* Render R as a decimal floating point constant, rounded so as to be
242 parsed back to the same value when interpreted in mode MODE. */
243 extern void real_to_decimal_for_mode (char *, const REAL_VALUE_TYPE *, size_t,
244 size_t, int, enum machine_mode);
246 /* Render R as a hexadecimal floating point constant. */
247 extern void real_to_hexadecimal (char *, const REAL_VALUE_TYPE *,
248 size_t, size_t, int);
250 /* Render R as an integer. */
251 extern HOST_WIDE_INT real_to_integer (const REAL_VALUE_TYPE *);
252 extern void real_to_integer2 (HOST_WIDE_INT *, HOST_WIDE_INT *,
253 const REAL_VALUE_TYPE *);
255 /* Initialize R from a decimal or hexadecimal string. Return -1 if
256 the value underflows, +1 if overflows, and 0 otherwise. */
257 extern int real_from_string (REAL_VALUE_TYPE *, const char *);
258 /* Wrapper to allow different internal representation for decimal floats. */
259 extern void real_from_string3 (REAL_VALUE_TYPE *, const char *, enum machine_mode);
261 /* Initialize R from an integer pair HIGH/LOW. */
262 extern void real_from_integer (REAL_VALUE_TYPE *, enum machine_mode,
263 unsigned HOST_WIDE_INT, HOST_WIDE_INT, int);
265 extern long real_to_target_fmt (long *, const REAL_VALUE_TYPE *,
266 const struct real_format *);
267 extern long real_to_target (long *, const REAL_VALUE_TYPE *, enum machine_mode);
269 extern void real_from_target_fmt (REAL_VALUE_TYPE *, const long *,
270 const struct real_format *);
271 extern void real_from_target (REAL_VALUE_TYPE *, const long *,
274 extern void real_inf (REAL_VALUE_TYPE *);
276 extern bool real_nan (REAL_VALUE_TYPE *, const char *, int, enum machine_mode);
278 extern void real_maxval (REAL_VALUE_TYPE *, int, enum machine_mode);
280 extern void real_2expN (REAL_VALUE_TYPE *, int, enum machine_mode);
282 extern unsigned int real_hash (const REAL_VALUE_TYPE *);
285 /* Target formats defined in real.c. */
286 extern const struct real_format ieee_single_format;
287 extern const struct real_format mips_single_format;
288 extern const struct real_format motorola_single_format;
289 extern const struct real_format spu_single_format;
290 extern const struct real_format ieee_double_format;
291 extern const struct real_format mips_double_format;
292 extern const struct real_format motorola_double_format;
293 extern const struct real_format ieee_extended_motorola_format;
294 extern const struct real_format ieee_extended_intel_96_format;
295 extern const struct real_format ieee_extended_intel_96_round_53_format;
296 extern const struct real_format ieee_extended_intel_128_format;
297 extern const struct real_format ibm_extended_format;
298 extern const struct real_format mips_extended_format;
299 extern const struct real_format ieee_quad_format;
300 extern const struct real_format mips_quad_format;
301 extern const struct real_format vax_f_format;
302 extern const struct real_format vax_d_format;
303 extern const struct real_format vax_g_format;
304 extern const struct real_format real_internal_format;
305 extern const struct real_format decimal_single_format;
306 extern const struct real_format decimal_double_format;
307 extern const struct real_format decimal_quad_format;
308 extern const struct real_format ieee_half_format;
309 extern const struct real_format arm_half_format;
312 /* ====================================================================== */
315 #define REAL_ARITHMETIC(value, code, d1, d2) \
316 real_arithmetic (&(value), code, &(d1), &(d2))
318 #define REAL_VALUES_IDENTICAL(x, y) real_identical (&(x), &(y))
319 #define REAL_VALUES_EQUAL(x, y) real_compare (EQ_EXPR, &(x), &(y))
320 #define REAL_VALUES_LESS(x, y) real_compare (LT_EXPR, &(x), &(y))
322 /* Determine whether a floating-point value X is infinite. */
323 #define REAL_VALUE_ISINF(x) real_isinf (&(x))
325 /* Determine whether a floating-point value X is a NaN. */
326 #define REAL_VALUE_ISNAN(x) real_isnan (&(x))
328 /* Determine whether a floating-point value X is negative. */
329 #define REAL_VALUE_NEGATIVE(x) real_isneg (&(x))
331 /* Determine whether a floating-point value X is minus zero. */
332 #define REAL_VALUE_MINUS_ZERO(x) real_isnegzero (&(x))
334 /* IN is a REAL_VALUE_TYPE. OUT is an array of longs. */
335 #define REAL_VALUE_TO_TARGET_LONG_DOUBLE(IN, OUT) \
336 real_to_target (OUT, &(IN), \
337 mode_for_size (LONG_DOUBLE_TYPE_SIZE, MODE_FLOAT, 0))
339 #define REAL_VALUE_TO_TARGET_DOUBLE(IN, OUT) \
340 real_to_target (OUT, &(IN), mode_for_size (64, MODE_FLOAT, 0))
342 /* IN is a REAL_VALUE_TYPE. OUT is a long. */
343 #define REAL_VALUE_TO_TARGET_SINGLE(IN, OUT) \
344 ((OUT) = real_to_target (NULL, &(IN), mode_for_size (32, MODE_FLOAT, 0)))
346 #define REAL_VALUE_FROM_INT(r, lo, hi, mode) \
347 real_from_integer (&(r), mode, lo, hi, 0)
349 #define REAL_VALUE_FROM_UNSIGNED_INT(r, lo, hi, mode) \
350 real_from_integer (&(r), mode, lo, hi, 1)
352 /* Real values to IEEE 754 decimal floats. */
354 /* IN is a REAL_VALUE_TYPE. OUT is an array of longs. */
355 #define REAL_VALUE_TO_TARGET_DECIMAL128(IN, OUT) \
356 real_to_target (OUT, &(IN), mode_for_size (128, MODE_DECIMAL_FLOAT, 0))
358 #define REAL_VALUE_TO_TARGET_DECIMAL64(IN, OUT) \
359 real_to_target (OUT, &(IN), mode_for_size (64, MODE_DECIMAL_FLOAT, 0))
361 /* IN is a REAL_VALUE_TYPE. OUT is a long. */
362 #define REAL_VALUE_TO_TARGET_DECIMAL32(IN, OUT) \
363 ((OUT) = real_to_target (NULL, &(IN), mode_for_size (32, MODE_DECIMAL_FLOAT, 0)))
365 extern REAL_VALUE_TYPE real_value_truncate (enum machine_mode,
368 #define REAL_VALUE_TO_INT(plow, phigh, r) \
369 real_to_integer2 (plow, phigh, &(r))
371 extern REAL_VALUE_TYPE real_arithmetic2 (int, const REAL_VALUE_TYPE *,
372 const REAL_VALUE_TYPE *);
374 #define REAL_VALUE_NEGATE(X) \
375 real_arithmetic2 (NEGATE_EXPR, &(X), NULL)
377 #define REAL_VALUE_ABS(X) \
378 real_arithmetic2 (ABS_EXPR, &(X), NULL)
380 extern int significand_size (enum machine_mode);
382 extern REAL_VALUE_TYPE real_from_string2 (const char *, enum machine_mode);
384 #define REAL_VALUE_ATOF(s, m) \
385 real_from_string2 (s, m)
387 #define CONST_DOUBLE_ATOF(s, m) \
388 CONST_DOUBLE_FROM_REAL_VALUE (real_from_string2 (s, m), m)
390 #define REAL_VALUE_FIX(r) \
391 real_to_integer (&(r))
393 /* ??? Not quite right. */
394 #define REAL_VALUE_UNSIGNED_FIX(r) \
395 real_to_integer (&(r))
397 /* ??? These were added for Paranoia support. */
399 /* Return floor log2(R). */
400 extern int real_exponent (const REAL_VALUE_TYPE *);
402 /* R = A * 2**EXP. */
403 extern void real_ldexp (REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *, int);
405 /* **** End of software floating point emulator interface macros **** */
407 /* Constant real values 0, 1, 2, -1 and 0.5. */
409 extern REAL_VALUE_TYPE dconst0;
410 extern REAL_VALUE_TYPE dconst1;
411 extern REAL_VALUE_TYPE dconst2;
412 extern REAL_VALUE_TYPE dconstm1;
413 extern REAL_VALUE_TYPE dconsthalf;
415 #define dconst_e() (*dconst_e_ptr ())
416 #define dconst_third() (*dconst_third_ptr ())
417 #define dconst_sqrt2() (*dconst_sqrt2_ptr ())
419 /* Function to return the real value special constant 'e'. */
420 extern const REAL_VALUE_TYPE * dconst_e_ptr (void);
422 /* Returns the special REAL_VALUE_TYPE corresponding to 1/3. */
423 extern const REAL_VALUE_TYPE * dconst_third_ptr (void);
425 /* Returns the special REAL_VALUE_TYPE corresponding to sqrt(2). */
426 extern const REAL_VALUE_TYPE * dconst_sqrt2_ptr (void);
428 /* Function to return a real value (not a tree node)
429 from a given integer constant. */
430 REAL_VALUE_TYPE real_value_from_int_cst (const_tree, const_tree);
432 /* Given a CONST_DOUBLE in FROM, store into TO the value it represents. */
433 #define REAL_VALUE_FROM_CONST_DOUBLE(to, from) \
434 ((to) = *CONST_DOUBLE_REAL_VALUE (from))
436 /* Return a CONST_DOUBLE with value R and mode M. */
437 #define CONST_DOUBLE_FROM_REAL_VALUE(r, m) \
438 const_double_from_real_value (r, m)
439 extern rtx const_double_from_real_value (REAL_VALUE_TYPE, enum machine_mode);
441 /* Replace R by 1/R in the given machine mode, if the result is exact. */
442 extern bool exact_real_inverse (enum machine_mode, REAL_VALUE_TYPE *);
444 /* Return true if arithmetic on values in IMODE that were promoted
445 from values in TMODE is equivalent to direct arithmetic on values
447 bool real_can_shorten_arithmetic (enum machine_mode, enum machine_mode);
449 /* In tree.c: wrap up a REAL_VALUE_TYPE in a tree node. */
450 extern tree build_real (tree, REAL_VALUE_TYPE);
452 /* Calculate R as the square root of X in the given machine mode. */
453 extern bool real_sqrt (REAL_VALUE_TYPE *, enum machine_mode,
454 const REAL_VALUE_TYPE *);
456 /* Calculate R as X raised to the integer exponent N in mode MODE. */
457 extern bool real_powi (REAL_VALUE_TYPE *, enum machine_mode,
458 const REAL_VALUE_TYPE *, HOST_WIDE_INT);
460 /* Standard round to integer value functions. */
461 extern void real_trunc (REAL_VALUE_TYPE *, enum machine_mode,
462 const REAL_VALUE_TYPE *);
463 extern void real_floor (REAL_VALUE_TYPE *, enum machine_mode,
464 const REAL_VALUE_TYPE *);
465 extern void real_ceil (REAL_VALUE_TYPE *, enum machine_mode,
466 const REAL_VALUE_TYPE *);
467 extern void real_round (REAL_VALUE_TYPE *, enum machine_mode,
468 const REAL_VALUE_TYPE *);
470 /* Set the sign of R to the sign of X. */
471 extern void real_copysign (REAL_VALUE_TYPE *, const REAL_VALUE_TYPE *);
473 #ifndef GENERATOR_FILE
474 /* Convert between MPFR and REAL_VALUE_TYPE. The caller is
475 responsible for initializing and clearing the MPFR parameter. */
477 extern void real_from_mpfr (REAL_VALUE_TYPE *, mpfr_srcptr, tree, mp_rnd_t);
478 extern void mpfr_from_real (mpfr_ptr, const REAL_VALUE_TYPE *, mp_rnd_t);
481 /* Check whether the real constant value given is an integer. */
482 extern bool real_isinteger (const REAL_VALUE_TYPE *c, enum machine_mode mode);
484 /* Write into BUF the maximum representable finite floating-point
485 number, (1 - b**-p) * b**emax for a given FP format FMT as a hex
486 float string. BUF must be large enough to contain the result. */
487 extern void get_max_float (const struct real_format *, char *, size_t);
488 #endif /* ! GCC_REAL_H */