1 /* IEEE floating point support routines, for GDB, the GNU Debugger.
2 Copyright (C) 1991-2019 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
20 /* This is needed to pick up the NAN macro on some systems. */
35 /* On some platforms, <float.h> provides DBL_QNAN. */
41 #include "libiberty.h"
42 #include "floatformat.h"
46 #define INFINITY HUGE_VAL
48 #define INFINITY (1.0 / 0.0)
56 #define NAN (0.0 / 0.0)
60 static int mant_bits_set (const struct floatformat *, const unsigned char *);
61 static unsigned long get_field (const unsigned char *,
62 enum floatformat_byteorders,
66 static int floatformat_always_valid (const struct floatformat *fmt,
70 floatformat_always_valid (const struct floatformat *fmt ATTRIBUTE_UNUSED,
71 const void *from ATTRIBUTE_UNUSED)
76 /* The odds that CHAR_BIT will be anything but 8 are low enough that I'm not
77 going to bother with trying to muck around with whether it is defined in
78 a system header, what we do if not, etc. */
79 #define FLOATFORMAT_CHAR_BIT 8
81 /* floatformats for IEEE half, single and double, big and little endian. */
82 const struct floatformat floatformat_ieee_half_big =
84 floatformat_big, 16, 0, 1, 5, 15, 31, 6, 10,
85 floatformat_intbit_no,
86 "floatformat_ieee_half_big",
87 floatformat_always_valid,
90 const struct floatformat floatformat_ieee_half_little =
92 floatformat_little, 16, 0, 1, 5, 15, 31, 6, 10,
93 floatformat_intbit_no,
94 "floatformat_ieee_half_little",
95 floatformat_always_valid,
98 const struct floatformat floatformat_ieee_single_big =
100 floatformat_big, 32, 0, 1, 8, 127, 255, 9, 23,
101 floatformat_intbit_no,
102 "floatformat_ieee_single_big",
103 floatformat_always_valid,
106 const struct floatformat floatformat_ieee_single_little =
108 floatformat_little, 32, 0, 1, 8, 127, 255, 9, 23,
109 floatformat_intbit_no,
110 "floatformat_ieee_single_little",
111 floatformat_always_valid,
114 const struct floatformat floatformat_ieee_double_big =
116 floatformat_big, 64, 0, 1, 11, 1023, 2047, 12, 52,
117 floatformat_intbit_no,
118 "floatformat_ieee_double_big",
119 floatformat_always_valid,
122 const struct floatformat floatformat_ieee_double_little =
124 floatformat_little, 64, 0, 1, 11, 1023, 2047, 12, 52,
125 floatformat_intbit_no,
126 "floatformat_ieee_double_little",
127 floatformat_always_valid,
131 /* floatformat for IEEE double, little endian byte order, with big endian word
132 ordering, as on the ARM. */
134 const struct floatformat floatformat_ieee_double_littlebyte_bigword =
136 floatformat_littlebyte_bigword, 64, 0, 1, 11, 1023, 2047, 12, 52,
137 floatformat_intbit_no,
138 "floatformat_ieee_double_littlebyte_bigword",
139 floatformat_always_valid,
143 /* floatformat for VAX. Not quite IEEE, but close enough. */
145 const struct floatformat floatformat_vax_f =
147 floatformat_vax, 32, 0, 1, 8, 129, 0, 9, 23,
148 floatformat_intbit_no,
150 floatformat_always_valid,
153 const struct floatformat floatformat_vax_d =
155 floatformat_vax, 64, 0, 1, 8, 129, 0, 9, 55,
156 floatformat_intbit_no,
158 floatformat_always_valid,
161 const struct floatformat floatformat_vax_g =
163 floatformat_vax, 64, 0, 1, 11, 1025, 0, 12, 52,
164 floatformat_intbit_no,
166 floatformat_always_valid,
170 static int floatformat_i387_ext_is_valid (const struct floatformat *fmt,
174 floatformat_i387_ext_is_valid (const struct floatformat *fmt, const void *from)
176 /* In the i387 double-extended format, if the exponent is all ones,
177 then the integer bit must be set. If the exponent is neither 0
178 nor ~0, the intbit must also be set. Only if the exponent is
179 zero can it be zero, and then it must be zero. */
180 unsigned long exponent, int_bit;
181 const unsigned char *ufrom = (const unsigned char *) from;
183 exponent = get_field (ufrom, fmt->byteorder, fmt->totalsize,
184 fmt->exp_start, fmt->exp_len);
185 int_bit = get_field (ufrom, fmt->byteorder, fmt->totalsize,
188 if ((exponent == 0) != (int_bit == 0))
194 const struct floatformat floatformat_i387_ext =
196 floatformat_little, 80, 0, 1, 15, 0x3fff, 0x7fff, 16, 64,
197 floatformat_intbit_yes,
198 "floatformat_i387_ext",
199 floatformat_i387_ext_is_valid,
202 const struct floatformat floatformat_m68881_ext =
204 /* Note that the bits from 16 to 31 are unused. */
205 floatformat_big, 96, 0, 1, 15, 0x3fff, 0x7fff, 32, 64,
206 floatformat_intbit_yes,
207 "floatformat_m68881_ext",
208 floatformat_always_valid,
211 const struct floatformat floatformat_i960_ext =
213 /* Note that the bits from 0 to 15 are unused. */
214 floatformat_little, 96, 16, 17, 15, 0x3fff, 0x7fff, 32, 64,
215 floatformat_intbit_yes,
216 "floatformat_i960_ext",
217 floatformat_always_valid,
220 const struct floatformat floatformat_m88110_ext =
222 floatformat_big, 80, 0, 1, 15, 0x3fff, 0x7fff, 16, 64,
223 floatformat_intbit_yes,
224 "floatformat_m88110_ext",
225 floatformat_always_valid,
228 const struct floatformat floatformat_m88110_harris_ext =
230 /* Harris uses raw format 128 bytes long, but the number is just an ieee
231 double, and the last 64 bits are wasted. */
232 floatformat_big,128, 0, 1, 11, 0x3ff, 0x7ff, 12, 52,
233 floatformat_intbit_no,
234 "floatformat_m88110_ext_harris",
235 floatformat_always_valid,
238 const struct floatformat floatformat_arm_ext_big =
240 /* Bits 1 to 16 are unused. */
241 floatformat_big, 96, 0, 17, 15, 0x3fff, 0x7fff, 32, 64,
242 floatformat_intbit_yes,
243 "floatformat_arm_ext_big",
244 floatformat_always_valid,
247 const struct floatformat floatformat_arm_ext_littlebyte_bigword =
249 /* Bits 1 to 16 are unused. */
250 floatformat_littlebyte_bigword, 96, 0, 17, 15, 0x3fff, 0x7fff, 32, 64,
251 floatformat_intbit_yes,
252 "floatformat_arm_ext_littlebyte_bigword",
253 floatformat_always_valid,
256 const struct floatformat floatformat_ia64_spill_big =
258 floatformat_big, 128, 0, 1, 17, 65535, 0x1ffff, 18, 64,
259 floatformat_intbit_yes,
260 "floatformat_ia64_spill_big",
261 floatformat_always_valid,
264 const struct floatformat floatformat_ia64_spill_little =
266 floatformat_little, 128, 0, 1, 17, 65535, 0x1ffff, 18, 64,
267 floatformat_intbit_yes,
268 "floatformat_ia64_spill_little",
269 floatformat_always_valid,
272 const struct floatformat floatformat_ia64_quad_big =
274 floatformat_big, 128, 0, 1, 15, 16383, 0x7fff, 16, 112,
275 floatformat_intbit_no,
276 "floatformat_ia64_quad_big",
277 floatformat_always_valid,
280 const struct floatformat floatformat_ia64_quad_little =
282 floatformat_little, 128, 0, 1, 15, 16383, 0x7fff, 16, 112,
283 floatformat_intbit_no,
284 "floatformat_ia64_quad_little",
285 floatformat_always_valid,
290 floatformat_ibm_long_double_is_valid (const struct floatformat *fmt,
293 const unsigned char *ufrom = (const unsigned char *) from;
294 const struct floatformat *hfmt = fmt->split_half;
295 long top_exp, bot_exp;
298 top_exp = get_field (ufrom, hfmt->byteorder, hfmt->totalsize,
299 hfmt->exp_start, hfmt->exp_len);
300 bot_exp = get_field (ufrom + 8, hfmt->byteorder, hfmt->totalsize,
301 hfmt->exp_start, hfmt->exp_len);
303 if ((unsigned long) top_exp == hfmt->exp_nan)
304 top_nan = mant_bits_set (hfmt, ufrom);
306 /* A NaN is valid with any low part. */
310 /* An infinity, zero or denormal requires low part 0 (positive or
312 if ((unsigned long) top_exp == hfmt->exp_nan || top_exp == 0)
317 return !mant_bits_set (hfmt, ufrom + 8);
320 /* The top part is now a finite normal value. The long double value
321 is the sum of the two parts, and the top part must equal the
322 result of rounding the long double value to nearest double. Thus
323 the bottom part must be <= 0.5ulp of the top part in absolute
324 value, and if it is < 0.5ulp then the long double is definitely
326 if (bot_exp < top_exp - 53)
328 if (bot_exp > top_exp - 53 && bot_exp != 0)
332 /* The bottom part is 0 or denormal. Determine which, and if
333 denormal the first two set bits. */
334 int first_bit = -1, second_bit = -1, cur_bit;
335 for (cur_bit = 0; (unsigned int) cur_bit < hfmt->man_len; cur_bit++)
336 if (get_field (ufrom + 8, hfmt->byteorder, hfmt->totalsize,
337 hfmt->man_start + cur_bit, 1))
343 second_bit = cur_bit;
347 /* Bottom part 0 is OK. */
350 /* The real exponent of the bottom part is -first_bit. */
351 if (-first_bit < top_exp - 53)
353 if (-first_bit > top_exp - 53)
355 /* The bottom part is at least 0.5ulp of the top part. For this
356 to be OK, the bottom part must be exactly 0.5ulp (i.e. no
357 more bits set) and the top part must have last bit 0. */
358 if (second_bit != -1)
360 return !get_field (ufrom, hfmt->byteorder, hfmt->totalsize,
361 hfmt->man_start + hfmt->man_len - 1, 1);
365 /* The bottom part is at least 0.5ulp of the top part. For this
366 to be OK, it must be exactly 0.5ulp (i.e. no explicit bits
367 set) and the top part must have last bit 0. */
368 if (get_field (ufrom, hfmt->byteorder, hfmt->totalsize,
369 hfmt->man_start + hfmt->man_len - 1, 1))
371 return !mant_bits_set (hfmt, ufrom + 8);
375 const struct floatformat floatformat_ibm_long_double_big =
377 floatformat_big, 128, 0, 1, 11, 1023, 2047, 12, 52,
378 floatformat_intbit_no,
379 "floatformat_ibm_long_double_big",
380 floatformat_ibm_long_double_is_valid,
381 &floatformat_ieee_double_big
384 const struct floatformat floatformat_ibm_long_double_little =
386 floatformat_little, 128, 0, 1, 11, 1023, 2047, 12, 52,
387 floatformat_intbit_no,
388 "floatformat_ibm_long_double_little",
389 floatformat_ibm_long_double_is_valid,
390 &floatformat_ieee_double_little
395 #define min(a, b) ((a) < (b) ? (a) : (b))
398 /* Return 1 if any bits are explicitly set in the mantissa of UFROM,
399 format FMT, 0 otherwise. */
401 mant_bits_set (const struct floatformat *fmt, const unsigned char *ufrom)
403 unsigned int mant_bits, mant_off;
406 mant_off = fmt->man_start;
407 mant_bits_left = fmt->man_len;
408 while (mant_bits_left > 0)
410 mant_bits = min (mant_bits_left, 32);
412 if (get_field (ufrom, fmt->byteorder, fmt->totalsize,
413 mant_off, mant_bits) != 0)
416 mant_off += mant_bits;
417 mant_bits_left -= mant_bits;
422 /* Extract a field which starts at START and is LEN bits long. DATA and
423 TOTAL_LEN are the thing we are extracting it from, in byteorder ORDER. */
425 get_field (const unsigned char *data, enum floatformat_byteorders order,
426 unsigned int total_len, unsigned int start, unsigned int len)
428 unsigned long result = 0;
429 unsigned int cur_byte;
430 int lo_bit, hi_bit, cur_bitshift = 0;
431 int nextbyte = (order == floatformat_little) ? 1 : -1;
433 /* Start is in big-endian bit order! Fix that first. */
434 start = total_len - (start + len);
436 /* Start at the least significant part of the field. */
437 if (order == floatformat_little)
438 cur_byte = start / FLOATFORMAT_CHAR_BIT;
440 cur_byte = (total_len - start - 1) / FLOATFORMAT_CHAR_BIT;
442 lo_bit = start % FLOATFORMAT_CHAR_BIT;
443 hi_bit = min (lo_bit + len, FLOATFORMAT_CHAR_BIT);
447 unsigned int shifted = *(data + cur_byte) >> lo_bit;
448 unsigned int bits = hi_bit - lo_bit;
449 unsigned int mask = (1 << bits) - 1;
450 result |= (shifted & mask) << cur_bitshift;
452 cur_bitshift += bits;
453 cur_byte += nextbyte;
455 hi_bit = min (len, FLOATFORMAT_CHAR_BIT);
462 /* Convert from FMT to a double.
463 FROM is the address of the extended float.
464 Store the double in *TO. */
467 floatformat_to_double (const struct floatformat *fmt,
468 const void *from, double *to)
470 const unsigned char *ufrom = (const unsigned char *) from;
474 unsigned int mant_bits, mant_off;
477 /* Split values are not handled specially, since the top half has
478 the correctly rounded double value (in the only supported case of
481 exponent = get_field (ufrom, fmt->byteorder, fmt->totalsize,
482 fmt->exp_start, fmt->exp_len);
484 /* If the exponent indicates a NaN, we don't have information to
485 decide what to do. So we handle it like IEEE, except that we
486 don't try to preserve the type of NaN. FIXME. */
487 if ((unsigned long) exponent == fmt->exp_nan)
489 int nan = mant_bits_set (fmt, ufrom);
491 /* On certain systems (such as GNU/Linux), the use of the
492 INFINITY macro below may generate a warning that can not be
493 silenced due to a bug in GCC (PR preprocessor/11931). The
494 preprocessor fails to recognise the __extension__ keyword in
495 conjunction with the GNU/C99 extension for hexadecimal
496 floating point constants and will issue a warning when
497 compiling with -pedantic. */
503 if (get_field (ufrom, fmt->byteorder, fmt->totalsize, fmt->sign_start, 1))
511 mant_bits_left = fmt->man_len;
512 mant_off = fmt->man_start;
515 /* Build the result algebraically. Might go infinite, underflow, etc;
518 /* For denorms use minimum exponent. */
520 exponent = 1 - fmt->exp_bias;
523 exponent -= fmt->exp_bias;
525 /* If this format uses a hidden bit, explicitly add it in now.
526 Otherwise, increment the exponent by one to account for the
529 if (fmt->intbit == floatformat_intbit_no)
530 dto = ldexp (1.0, exponent);
535 while (mant_bits_left > 0)
537 mant_bits = min (mant_bits_left, 32);
539 mant = get_field (ufrom, fmt->byteorder, fmt->totalsize,
540 mant_off, mant_bits);
542 dto += ldexp ((double) mant, exponent - mant_bits);
543 exponent -= mant_bits;
544 mant_off += mant_bits;
545 mant_bits_left -= mant_bits;
548 /* Negate it if negative. */
549 if (get_field (ufrom, fmt->byteorder, fmt->totalsize, fmt->sign_start, 1))
554 static void put_field (unsigned char *, enum floatformat_byteorders,
560 /* Set a field which starts at START and is LEN bits long. DATA and
561 TOTAL_LEN are the thing we are extracting it from, in byteorder ORDER. */
563 put_field (unsigned char *data, enum floatformat_byteorders order,
564 unsigned int total_len, unsigned int start, unsigned int len,
565 unsigned long stuff_to_put)
567 unsigned int cur_byte;
569 int nextbyte = (order == floatformat_little) ? 1 : -1;
571 /* Start is in big-endian bit order! Fix that first. */
572 start = total_len - (start + len);
574 /* Start at the least significant part of the field. */
575 if (order == floatformat_little)
576 cur_byte = start / FLOATFORMAT_CHAR_BIT;
578 cur_byte = (total_len - start - 1) / FLOATFORMAT_CHAR_BIT;
580 lo_bit = start % FLOATFORMAT_CHAR_BIT;
581 hi_bit = min (lo_bit + len, FLOATFORMAT_CHAR_BIT);
585 unsigned char *byte_ptr = data + cur_byte;
586 unsigned int bits = hi_bit - lo_bit;
587 unsigned int mask = ((1 << bits) - 1) << lo_bit;
588 *byte_ptr = (*byte_ptr & ~mask) | ((stuff_to_put << lo_bit) & mask);
589 stuff_to_put >>= bits;
591 cur_byte += nextbyte;
593 hi_bit = min (len, FLOATFORMAT_CHAR_BIT);
598 /* The converse: convert the double *FROM to an extended float
599 and store where TO points. Neither FROM nor TO have any alignment
603 floatformat_from_double (const struct floatformat *fmt,
604 const double *from, void *to)
609 unsigned int mant_bits, mant_off;
611 unsigned char *uto = (unsigned char *) to;
614 memset (uto, 0, fmt->totalsize / FLOATFORMAT_CHAR_BIT);
616 /* Split values are not handled specially, since a bottom half of
617 zero is correct for any value representable as double (in the
618 only supported case of split values). */
620 /* If negative, set the sign bit. */
623 put_field (uto, fmt->byteorder, fmt->totalsize, fmt->sign_start, 1, 1);
636 put_field (uto, fmt->byteorder, fmt->totalsize, fmt->exp_start,
637 fmt->exp_len, fmt->exp_nan);
638 /* Be sure it's not infinity, but NaN value is irrelevant. */
639 put_field (uto, fmt->byteorder, fmt->totalsize, fmt->man_start,
644 if (dfrom + dfrom == dfrom)
646 /* This can only happen for an infinite value (or zero, which we
647 already handled above). */
648 put_field (uto, fmt->byteorder, fmt->totalsize, fmt->exp_start,
649 fmt->exp_len, fmt->exp_nan);
653 mant = frexp (dfrom, &exponent);
654 if (exponent + fmt->exp_bias - 1 > 0)
655 put_field (uto, fmt->byteorder, fmt->totalsize, fmt->exp_start,
656 fmt->exp_len, exponent + fmt->exp_bias - 1);
659 /* Handle a denormalized number. FIXME: What should we do for
661 put_field (uto, fmt->byteorder, fmt->totalsize, fmt->exp_start,
663 mant = ldexp (mant, exponent + fmt->exp_bias - 1);
666 mant_bits_left = fmt->man_len;
667 mant_off = fmt->man_start;
668 while (mant_bits_left > 0)
670 unsigned long mant_long;
671 mant_bits = mant_bits_left < 32 ? mant_bits_left : 32;
673 mant *= 4294967296.0;
674 mant_long = (unsigned long)mant;
677 /* If the integer bit is implicit, and we are not creating a
678 denormalized number, then we need to discard it. */
679 if ((unsigned int) mant_bits_left == fmt->man_len
680 && fmt->intbit == floatformat_intbit_no
681 && exponent + fmt->exp_bias - 1 > 0)
683 mant_long &= 0x7fffffff;
686 else if (mant_bits < 32)
688 /* The bits we want are in the most significant MANT_BITS bits of
689 mant_long. Move them to the least significant. */
690 mant_long >>= 32 - mant_bits;
693 put_field (uto, fmt->byteorder, fmt->totalsize,
694 mant_off, mant_bits, mant_long);
695 mant_off += mant_bits;
696 mant_bits_left -= mant_bits;
700 /* Return non-zero iff the data at FROM is a valid number in format FMT. */
703 floatformat_is_valid (const struct floatformat *fmt, const void *from)
705 return fmt->is_valid (fmt, from);
713 /* This is to be run on a host which uses IEEE floating point. */
720 floatformat_to_double (&floatformat_ieee_double_little, &n, &result);
721 if ((n != result && (! isnan (n) || ! isnan (result)))
722 || (n < 0 && result >= 0)
723 || (n >= 0 && result < 0))
724 printf ("Differ(to): %.20g -> %.20g\n", n, result);
726 floatformat_from_double (&floatformat_ieee_double_little, &n, &result);
727 if ((n != result && (! isnan (n) || ! isnan (result)))
728 || (n < 0 && result >= 0)
729 || (n >= 0 && result < 0))
730 printf ("Differ(from): %.20g -> %.20g\n", n, result);
736 floatformat_from_double (&floatformat_m68881_ext, &n, exten);
737 floatformat_to_double (&floatformat_m68881_ext, exten, &result);
739 printf ("Differ(to+from): %.20g -> %.20g\n", n, result);
744 /* This is to be run on a host which uses 68881 format. */
746 long double ex = *(long double *)exten;
748 printf ("Differ(from vs. extended): %.20g\n", n);
761 ieee_test (234235.78907234);
763 ieee_test (-0.004321);
765 ieee_test (1.2E-316);
766 ieee_test (4.9406564584124654E-324);
767 ieee_test (- 4.9406564584124654E-324);
769 ieee_test (- INFINITY);
771 ieee_test (INFINITY);