Fix couple of endianness issues in fold_ctor_reference
[official-gcc.git] / gcc / value-range.cc
blobf5d4bf3bb4a4100396383a45512453735bd434d2
1 /* Support routines for value ranges.
2 Copyright (C) 2019-2023 Free Software Foundation, Inc.
3 Major hacks by Aldy Hernandez <aldyh@redhat.com> and
4 Andrew MacLeod <amacleod@redhat.com>.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "backend.h"
26 #include "tree.h"
27 #include "gimple.h"
28 #include "ssa.h"
29 #include "tree-pretty-print.h"
30 #include "value-range-pretty-print.h"
31 #include "fold-const.h"
32 #include "gimple-range.h"
34 void
35 irange::accept (const vrange_visitor &v) const
37 v.visit (*this);
40 void
41 unsupported_range::accept (const vrange_visitor &v) const
43 v.visit (*this);
46 // Convenience function only available for integers and pointers.
48 wide_int
49 Value_Range::lower_bound () const
51 if (is_a <irange> (*m_vrange))
52 return as_a <irange> (*m_vrange).lower_bound ();
53 gcc_unreachable ();
56 // Convenience function only available for integers and pointers.
58 wide_int
59 Value_Range::upper_bound () const
61 if (is_a <irange> (*m_vrange))
62 return as_a <irange> (*m_vrange).upper_bound ();
63 gcc_unreachable ();
66 void
67 Value_Range::dump (FILE *out) const
69 if (m_vrange)
70 m_vrange->dump (out);
71 else
72 fprintf (out, "NULL");
75 DEBUG_FUNCTION void
76 debug (const Value_Range &r)
78 r.dump (stderr);
79 fprintf (stderr, "\n");
82 // Default vrange definitions.
84 bool
85 vrange::contains_p (tree) const
87 return varying_p ();
90 bool
91 vrange::singleton_p (tree *) const
93 return false;
96 void
97 vrange::set (tree min, tree, value_range_kind)
99 set_varying (TREE_TYPE (min));
102 tree
103 vrange::type () const
105 return void_type_node;
108 bool
109 vrange::supports_type_p (const_tree) const
111 return false;
114 void
115 vrange::set_undefined ()
117 m_kind = VR_UNDEFINED;
120 void
121 vrange::set_varying (tree)
123 m_kind = VR_VARYING;
126 bool
127 vrange::union_ (const vrange &r)
129 if (r.undefined_p () || varying_p ())
130 return false;
131 if (undefined_p () || r.varying_p ())
133 operator= (r);
134 return true;
136 gcc_unreachable ();
137 return false;
140 bool
141 vrange::intersect (const vrange &r)
143 if (undefined_p () || r.varying_p ())
144 return false;
145 if (r.undefined_p ())
147 set_undefined ();
148 return true;
150 if (varying_p ())
152 operator= (r);
153 return true;
155 gcc_unreachable ();
156 return false;
159 bool
160 vrange::zero_p () const
162 return false;
165 bool
166 vrange::nonzero_p () const
168 return false;
171 void
172 vrange::set_nonzero (tree type)
174 set_varying (type);
177 void
178 vrange::set_zero (tree type)
180 set_varying (type);
183 void
184 vrange::set_nonnegative (tree type)
186 set_varying (type);
189 bool
190 vrange::fits_p (const vrange &) const
192 return true;
195 // Assignment operator for generic ranges. Copying incompatible types
196 // is not allowed.
198 vrange &
199 vrange::operator= (const vrange &src)
201 if (is_a <irange> (src))
202 as_a <irange> (*this) = as_a <irange> (src);
203 else if (is_a <frange> (src))
204 as_a <frange> (*this) = as_a <frange> (src);
205 else
207 gcc_checking_assert (is_a <unsupported_range> (src));
208 m_kind = src.m_kind;
210 return *this;
213 // Equality operator for generic ranges.
215 bool
216 vrange::operator== (const vrange &src) const
218 if (is_a <irange> (src))
219 return as_a <irange> (*this) == as_a <irange> (src);
220 if (is_a <frange> (src))
221 return as_a <frange> (*this) == as_a <frange> (src);
222 gcc_unreachable ();
225 // Wrapper for vrange_printer to dump a range to a file.
227 void
228 vrange::dump (FILE *file) const
230 pretty_printer buffer;
231 pp_needs_newline (&buffer) = true;
232 buffer.buffer->stream = file;
233 vrange_printer vrange_pp (&buffer);
234 this->accept (vrange_pp);
235 pp_flush (&buffer);
238 namespace inchash
241 void
242 add_vrange (const vrange &v, inchash::hash &hstate,
243 unsigned int)
245 if (v.undefined_p ())
247 hstate.add_int (VR_UNDEFINED);
248 return;
250 // Types are ignored throughout to inhibit two ranges being equal
251 // but having different hash values. This can happen when two
252 // ranges are equal and their types are different (but
253 // types_compatible_p is true).
254 if (is_a <irange> (v))
256 const irange &r = as_a <irange> (v);
257 if (r.varying_p ())
258 hstate.add_int (VR_VARYING);
259 else
260 hstate.add_int (VR_RANGE);
261 for (unsigned i = 0; i < r.num_pairs (); ++i)
263 hstate.add_wide_int (r.lower_bound (i));
264 hstate.add_wide_int (r.upper_bound (i));
266 hstate.add_wide_int (r.get_nonzero_bits ());
267 return;
269 if (is_a <frange> (v))
271 const frange &r = as_a <frange> (v);
272 if (r.known_isnan ())
273 hstate.add_int (VR_NAN);
274 else
276 hstate.add_int (r.varying_p () ? VR_VARYING : VR_RANGE);
277 hstate.add_real_value (r.lower_bound ());
278 hstate.add_real_value (r.upper_bound ());
280 nan_state nan = r.get_nan_state ();
281 hstate.add_int (nan.pos_p ());
282 hstate.add_int (nan.neg_p ());
283 return;
285 gcc_unreachable ();
288 } //namespace inchash
290 bool
291 irange::supports_type_p (const_tree type) const
293 return supports_p (type);
296 // Return TRUE if R fits in THIS.
298 bool
299 irange::fits_p (const vrange &r) const
301 return m_max_ranges >= as_a <irange> (r).num_pairs ();
304 void
305 irange::set_nonnegative (tree type)
307 set (type,
308 wi::zero (TYPE_PRECISION (type)),
309 wi::to_wide (TYPE_MAX_VALUE (type)));
312 void
313 frange::accept (const vrange_visitor &v) const
315 v.visit (*this);
318 // Flush denormal endpoints to the appropriate 0.0.
320 void
321 frange::flush_denormals_to_zero ()
323 if (undefined_p () || known_isnan ())
324 return;
326 machine_mode mode = TYPE_MODE (type ());
327 // Flush [x, -DENORMAL] to [x, -0.0].
328 if (real_isdenormal (&m_max, mode) && real_isneg (&m_max))
330 if (HONOR_SIGNED_ZEROS (m_type))
331 m_max = dconstm0;
332 else
333 m_max = dconst0;
335 // Flush [+DENORMAL, x] to [+0.0, x].
336 if (real_isdenormal (&m_min, mode) && !real_isneg (&m_min))
337 m_min = dconst0;
340 // Setter for franges.
342 void
343 frange::set (tree type,
344 const REAL_VALUE_TYPE &min, const REAL_VALUE_TYPE &max,
345 const nan_state &nan, value_range_kind kind)
347 switch (kind)
349 case VR_UNDEFINED:
350 set_undefined ();
351 return;
352 case VR_VARYING:
353 case VR_ANTI_RANGE:
354 set_varying (type);
355 return;
356 case VR_RANGE:
357 break;
358 default:
359 gcc_unreachable ();
362 gcc_checking_assert (!real_isnan (&min) && !real_isnan (&max));
364 m_kind = kind;
365 m_type = type;
366 m_min = min;
367 m_max = max;
368 if (HONOR_NANS (m_type))
370 m_pos_nan = nan.pos_p ();
371 m_neg_nan = nan.neg_p ();
373 else
375 m_pos_nan = false;
376 m_neg_nan = false;
379 if (!MODE_HAS_SIGNED_ZEROS (TYPE_MODE (m_type)))
381 if (real_iszero (&m_min, 1))
382 m_min.sign = 0;
383 if (real_iszero (&m_max, 1))
384 m_max.sign = 0;
386 else if (!HONOR_SIGNED_ZEROS (m_type))
388 if (real_iszero (&m_max, 1))
389 m_max.sign = 0;
390 if (real_iszero (&m_min, 0))
391 m_min.sign = 1;
394 // For -ffinite-math-only we can drop ranges outside the
395 // representable numbers to min/max for the type.
396 if (!HONOR_INFINITIES (m_type))
398 REAL_VALUE_TYPE min_repr = frange_val_min (m_type);
399 REAL_VALUE_TYPE max_repr = frange_val_max (m_type);
400 if (real_less (&m_min, &min_repr))
401 m_min = min_repr;
402 else if (real_less (&max_repr, &m_min))
403 m_min = max_repr;
404 if (real_less (&max_repr, &m_max))
405 m_max = max_repr;
406 else if (real_less (&m_max, &min_repr))
407 m_max = min_repr;
410 // Check for swapped ranges.
411 gcc_checking_assert (real_compare (LE_EXPR, &min, &max));
413 normalize_kind ();
416 // Setter for an frange defaulting the NAN possibility to +-NAN when
417 // HONOR_NANS.
419 void
420 frange::set (tree type,
421 const REAL_VALUE_TYPE &min, const REAL_VALUE_TYPE &max,
422 value_range_kind kind)
424 set (type, min, max, nan_state (true), kind);
427 void
428 frange::set (tree min, tree max, value_range_kind kind)
430 set (TREE_TYPE (min),
431 *TREE_REAL_CST_PTR (min), *TREE_REAL_CST_PTR (max), kind);
434 // Normalize range to VARYING or UNDEFINED, or vice versa. Return
435 // TRUE if anything changed.
437 // A range with no known properties can be dropped to VARYING.
438 // Similarly, a VARYING with any properties should be dropped to a
439 // VR_RANGE. Normalizing ranges upon changing them ensures there is
440 // only one representation for a given range.
442 bool
443 frange::normalize_kind ()
445 if (m_kind == VR_RANGE
446 && frange_val_is_min (m_min, m_type)
447 && frange_val_is_max (m_max, m_type))
449 if (!HONOR_NANS (m_type) || (m_pos_nan && m_neg_nan))
451 set_varying (m_type);
452 return true;
455 else if (m_kind == VR_VARYING)
457 if (HONOR_NANS (m_type) && (!m_pos_nan || !m_neg_nan))
459 m_kind = VR_RANGE;
460 m_min = frange_val_min (m_type);
461 m_max = frange_val_max (m_type);
462 if (flag_checking)
463 verify_range ();
464 return true;
467 else if (m_kind == VR_NAN && !m_pos_nan && !m_neg_nan)
468 set_undefined ();
469 return false;
472 // Union or intersect the zero endpoints of two ranges. For example:
473 // [-0, x] U [+0, x] => [-0, x]
474 // [ x, -0] U [ x, +0] => [ x, +0]
475 // [-0, x] ^ [+0, x] => [+0, x]
476 // [ x, -0] ^ [ x, +0] => [ x, -0]
478 // UNION_P is true when performing a union, or false when intersecting.
480 bool
481 frange::combine_zeros (const frange &r, bool union_p)
483 gcc_checking_assert (!undefined_p () && !known_isnan ());
485 bool changed = false;
486 if (real_iszero (&m_min) && real_iszero (&r.m_min)
487 && real_isneg (&m_min) != real_isneg (&r.m_min))
489 m_min.sign = union_p;
490 changed = true;
492 if (real_iszero (&m_max) && real_iszero (&r.m_max)
493 && real_isneg (&m_max) != real_isneg (&r.m_max))
495 m_max.sign = !union_p;
496 changed = true;
498 // If the signs are swapped, the resulting range is empty.
499 if (m_min.sign == 0 && m_max.sign == 1)
501 if (maybe_isnan ())
502 m_kind = VR_NAN;
503 else
504 set_undefined ();
505 changed = true;
507 return changed;
510 // Union two ranges when one is known to be a NAN.
512 bool
513 frange::union_nans (const frange &r)
515 gcc_checking_assert (known_isnan () || r.known_isnan ());
517 if (known_isnan ())
519 m_kind = r.m_kind;
520 m_min = r.m_min;
521 m_max = r.m_max;
523 m_pos_nan |= r.m_pos_nan;
524 m_neg_nan |= r.m_neg_nan;
525 normalize_kind ();
526 return true;
529 bool
530 frange::union_ (const vrange &v)
532 const frange &r = as_a <frange> (v);
534 if (r.undefined_p () || varying_p ())
535 return false;
536 if (undefined_p () || r.varying_p ())
538 *this = r;
539 return true;
542 // Combine NAN info.
543 if (known_isnan () || r.known_isnan ())
544 return union_nans (r);
545 bool changed = false;
546 if (m_pos_nan != r.m_pos_nan || m_neg_nan != r.m_neg_nan)
548 m_pos_nan |= r.m_pos_nan;
549 m_neg_nan |= r.m_neg_nan;
550 changed = true;
553 // Combine endpoints.
554 if (real_less (&r.m_min, &m_min))
556 m_min = r.m_min;
557 changed = true;
559 if (real_less (&m_max, &r.m_max))
561 m_max = r.m_max;
562 changed = true;
565 if (HONOR_SIGNED_ZEROS (m_type))
566 changed |= combine_zeros (r, true);
568 changed |= normalize_kind ();
569 return changed;
572 // Intersect two ranges when one is known to be a NAN.
574 bool
575 frange::intersect_nans (const frange &r)
577 gcc_checking_assert (known_isnan () || r.known_isnan ());
579 m_pos_nan &= r.m_pos_nan;
580 m_neg_nan &= r.m_neg_nan;
581 if (maybe_isnan ())
582 m_kind = VR_NAN;
583 else
584 set_undefined ();
585 if (flag_checking)
586 verify_range ();
587 return true;
590 bool
591 frange::intersect (const vrange &v)
593 const frange &r = as_a <frange> (v);
595 if (undefined_p () || r.varying_p ())
596 return false;
597 if (r.undefined_p ())
599 set_undefined ();
600 return true;
602 if (varying_p ())
604 *this = r;
605 return true;
608 // Combine NAN info.
609 if (known_isnan () || r.known_isnan ())
610 return intersect_nans (r);
611 bool changed = false;
612 if (m_pos_nan != r.m_pos_nan || m_neg_nan != r.m_neg_nan)
614 m_pos_nan &= r.m_pos_nan;
615 m_neg_nan &= r.m_neg_nan;
616 changed = true;
619 // Combine endpoints.
620 if (real_less (&m_min, &r.m_min))
622 m_min = r.m_min;
623 changed = true;
625 if (real_less (&r.m_max, &m_max))
627 m_max = r.m_max;
628 changed = true;
630 // If the endpoints are swapped, the resulting range is empty.
631 if (real_less (&m_max, &m_min))
633 if (maybe_isnan ())
634 m_kind = VR_NAN;
635 else
636 set_undefined ();
637 if (flag_checking)
638 verify_range ();
639 return true;
642 if (HONOR_SIGNED_ZEROS (m_type))
643 changed |= combine_zeros (r, false);
645 changed |= normalize_kind ();
646 return changed;
649 frange &
650 frange::operator= (const frange &src)
652 m_kind = src.m_kind;
653 m_type = src.m_type;
654 m_min = src.m_min;
655 m_max = src.m_max;
656 m_pos_nan = src.m_pos_nan;
657 m_neg_nan = src.m_neg_nan;
659 if (flag_checking)
660 verify_range ();
661 return *this;
664 bool
665 frange::operator== (const frange &src) const
667 if (m_kind == src.m_kind)
669 if (undefined_p ())
670 return true;
672 if (varying_p ())
673 return types_compatible_p (m_type, src.m_type);
675 bool nan1 = known_isnan ();
676 bool nan2 = src.known_isnan ();
677 if (nan1 || nan2)
679 if (nan1 && nan2)
680 return (m_pos_nan == src.m_pos_nan
681 && m_neg_nan == src.m_neg_nan);
682 return false;
685 return (real_identical (&m_min, &src.m_min)
686 && real_identical (&m_max, &src.m_max)
687 && m_pos_nan == src.m_pos_nan
688 && m_neg_nan == src.m_neg_nan
689 && types_compatible_p (m_type, src.m_type));
691 return false;
694 // Return TRUE if range contains R.
696 bool
697 frange::contains_p (const REAL_VALUE_TYPE &r) const
699 gcc_checking_assert (m_kind != VR_ANTI_RANGE);
701 if (undefined_p ())
702 return false;
704 if (varying_p ())
705 return true;
707 if (real_isnan (&r))
709 // No NAN in range.
710 if (!m_pos_nan && !m_neg_nan)
711 return false;
712 // Both +NAN and -NAN are present.
713 if (m_pos_nan && m_neg_nan)
714 return true;
715 return m_neg_nan == r.sign;
717 if (known_isnan ())
718 return false;
720 if (real_compare (GE_EXPR, &r, &m_min) && real_compare (LE_EXPR, &r, &m_max))
722 // Make sure the signs are equal for signed zeros.
723 if (HONOR_SIGNED_ZEROS (m_type) && real_iszero (&r))
724 return r.sign == m_min.sign || r.sign == m_max.sign;
725 return true;
727 return false;
730 // If range is a singleton, place it in RESULT and return TRUE. If
731 // RESULT is NULL, just return TRUE.
733 // A NAN can never be a singleton.
735 bool
736 frange::internal_singleton_p (REAL_VALUE_TYPE *result) const
738 if (m_kind == VR_RANGE && real_identical (&m_min, &m_max))
740 // Return false for any singleton that may be a NAN.
741 if (HONOR_NANS (m_type) && maybe_isnan ())
742 return false;
744 if (MODE_COMPOSITE_P (TYPE_MODE (m_type)))
746 // For IBM long doubles, if the value is +-Inf or is exactly
747 // representable in double, the other double could be +0.0
748 // or -0.0. Since this means there is more than one way to
749 // represent a value, return false to avoid propagating it.
750 // See libgcc/config/rs6000/ibm-ldouble-format for details.
751 if (real_isinf (&m_min))
752 return false;
753 REAL_VALUE_TYPE r;
754 real_convert (&r, DFmode, &m_min);
755 if (real_identical (&r, &m_min))
756 return false;
759 if (result)
760 *result = m_min;
761 return true;
763 return false;
766 bool
767 frange::singleton_p (tree *result) const
769 if (internal_singleton_p ())
771 if (result)
772 *result = build_real (m_type, m_min);
773 return true;
775 return false;
778 bool
779 frange::singleton_p (REAL_VALUE_TYPE &r) const
781 return internal_singleton_p (&r);
784 bool
785 frange::supports_type_p (const_tree type) const
787 return supports_p (type);
790 void
791 frange::verify_range ()
793 if (!undefined_p ())
794 gcc_checking_assert (HONOR_NANS (m_type) || !maybe_isnan ());
795 switch (m_kind)
797 case VR_UNDEFINED:
798 gcc_checking_assert (!m_type);
799 return;
800 case VR_VARYING:
801 gcc_checking_assert (m_type);
802 gcc_checking_assert (frange_val_is_min (m_min, m_type));
803 gcc_checking_assert (frange_val_is_max (m_max, m_type));
804 if (HONOR_NANS (m_type))
805 gcc_checking_assert (m_pos_nan && m_neg_nan);
806 else
807 gcc_checking_assert (!m_pos_nan && !m_neg_nan);
808 return;
809 case VR_RANGE:
810 gcc_checking_assert (m_type);
811 break;
812 case VR_NAN:
813 gcc_checking_assert (m_type);
814 gcc_checking_assert (m_pos_nan || m_neg_nan);
815 return;
816 default:
817 gcc_unreachable ();
820 // NANs cannot appear in the endpoints of a range.
821 gcc_checking_assert (!real_isnan (&m_min) && !real_isnan (&m_max));
823 // Make sure we don't have swapped ranges.
824 gcc_checking_assert (!real_less (&m_max, &m_min));
826 // [ +0.0, -0.0 ] is nonsensical.
827 gcc_checking_assert (!(real_iszero (&m_min, 0) && real_iszero (&m_max, 1)));
829 // If all the properties are clear, we better not span the entire
830 // domain, because that would make us varying.
831 if (m_pos_nan && m_neg_nan)
832 gcc_checking_assert (!frange_val_is_min (m_min, m_type)
833 || !frange_val_is_max (m_max, m_type));
836 // We can't do much with nonzeros yet.
837 void
838 frange::set_nonzero (tree type)
840 set_varying (type);
843 // We can't do much with nonzeros yet.
844 bool
845 frange::nonzero_p () const
847 return false;
850 // Set range to [+0.0, +0.0] if honoring signed zeros, or [0.0, 0.0]
851 // otherwise.
853 void
854 frange::set_zero (tree type)
856 if (HONOR_SIGNED_ZEROS (type))
858 set (type, dconstm0, dconst0);
859 clear_nan ();
861 else
862 set (type, dconst0, dconst0);
865 // Return TRUE for any zero regardless of sign.
867 bool
868 frange::zero_p () const
870 return (m_kind == VR_RANGE
871 && real_iszero (&m_min)
872 && real_iszero (&m_max));
875 // Set the range to non-negative numbers, that is [+0.0, +INF].
877 // The NAN in the resulting range (if HONOR_NANS) has a varying sign
878 // as there are no guarantees in IEEE 754 wrt to the sign of a NAN,
879 // except for copy, abs, and copysign. It is the responsibility of
880 // the caller to set the NAN's sign if desired.
882 void
883 frange::set_nonnegative (tree type)
885 set (type, dconst0, frange_val_max (type));
888 // Here we copy between any two irange's.
890 irange &
891 irange::operator= (const irange &src)
893 int needed = src.num_pairs ();
894 maybe_resize (needed);
896 unsigned x;
897 unsigned lim = src.m_num_ranges;
898 if (lim > m_max_ranges)
899 lim = m_max_ranges;
901 for (x = 0; x < lim * 2; ++x)
902 m_base[x] = src.m_base[x];
904 // If the range didn't fit, the last range should cover the rest.
905 if (lim != src.m_num_ranges)
906 m_base[x - 1] = src.m_base[src.m_num_ranges * 2 - 1];
908 m_num_ranges = lim;
909 m_type = src.m_type;
910 m_kind = src.m_kind;
911 m_nonzero_mask = src.m_nonzero_mask;
912 if (m_max_ranges == 1)
913 normalize_kind ();
914 if (flag_checking)
915 verify_range ();
916 return *this;
919 value_range_kind
920 get_legacy_range (const irange &r, tree &min, tree &max)
922 if (r.undefined_p ())
924 min = NULL_TREE;
925 max = NULL_TREE;
926 return VR_UNDEFINED;
929 tree type = r.type ();
930 if (r.varying_p ())
932 min = wide_int_to_tree (type, r.lower_bound ());
933 max = wide_int_to_tree (type, r.upper_bound ());
934 return VR_VARYING;
937 unsigned int precision = TYPE_PRECISION (type);
938 signop sign = TYPE_SIGN (type);
939 if (r.num_pairs () > 1
940 && precision > 1
941 && r.lower_bound () == wi::min_value (precision, sign)
942 && r.upper_bound () == wi::max_value (precision, sign))
944 int_range<3> inv (r);
945 inv.invert ();
946 min = wide_int_to_tree (type, inv.lower_bound (0));
947 max = wide_int_to_tree (type, inv.upper_bound (0));
948 return VR_ANTI_RANGE;
951 min = wide_int_to_tree (type, r.lower_bound ());
952 max = wide_int_to_tree (type, r.upper_bound ());
953 return VR_RANGE;
956 /* Set value range to the canonical form of {VRTYPE, MIN, MAX, EQUIV}.
957 This means adjusting VRTYPE, MIN and MAX representing the case of a
958 wrapping range with MAX < MIN covering [MIN, type_max] U [type_min, MAX]
959 as anti-rage ~[MAX+1, MIN-1]. Likewise for wrapping anti-ranges.
960 In corner cases where MAX+1 or MIN-1 wraps this will fall back
961 to varying.
962 This routine exists to ease canonicalization in the case where we
963 extract ranges from var + CST op limit. */
965 void
966 irange::set (tree type, const wide_int &min, const wide_int &max,
967 value_range_kind kind)
969 unsigned prec = TYPE_PRECISION (type);
970 signop sign = TYPE_SIGN (type);
971 wide_int min_value = wi::min_value (prec, sign);
972 wide_int max_value = wi::max_value (prec, sign);
974 m_type = type;
975 m_nonzero_mask = wi::minus_one (prec);
977 if (kind == VR_RANGE)
979 m_base[0] = min;
980 m_base[1] = max;
981 m_num_ranges = 1;
982 if (min == min_value && max == max_value)
983 m_kind = VR_VARYING;
984 else
985 m_kind = VR_RANGE;
987 else
989 gcc_checking_assert (kind == VR_ANTI_RANGE);
990 gcc_checking_assert (m_max_ranges > 1);
992 m_kind = VR_UNDEFINED;
993 m_num_ranges = 0;
994 wi::overflow_type ovf;
995 wide_int lim;
996 if (sign == SIGNED)
997 lim = wi::add (min, -1, sign, &ovf);
998 else
999 lim = wi::sub (min, 1, sign, &ovf);
1001 if (!ovf)
1003 m_kind = VR_RANGE;
1004 m_base[0] = min_value;
1005 m_base[1] = lim;
1006 ++m_num_ranges;
1008 if (sign == SIGNED)
1009 lim = wi::sub (max, -1, sign, &ovf);
1010 else
1011 lim = wi::add (max, 1, sign, &ovf);
1012 if (!ovf)
1014 m_kind = VR_RANGE;
1015 m_base[m_num_ranges * 2] = lim;
1016 m_base[m_num_ranges * 2 + 1] = max_value;
1017 ++m_num_ranges;
1021 if (flag_checking)
1022 verify_range ();
1025 void
1026 irange::set (tree min, tree max, value_range_kind kind)
1028 if (POLY_INT_CST_P (min) || POLY_INT_CST_P (max))
1030 set_varying (TREE_TYPE (min));
1031 return;
1034 gcc_checking_assert (TREE_CODE (min) == INTEGER_CST);
1035 gcc_checking_assert (TREE_CODE (max) == INTEGER_CST);
1037 return set (TREE_TYPE (min), wi::to_wide (min), wi::to_wide (max), kind);
1040 // Check the validity of the range.
1042 void
1043 irange::verify_range ()
1045 gcc_checking_assert (m_discriminator == VR_IRANGE);
1046 if (m_kind == VR_UNDEFINED)
1048 gcc_checking_assert (m_num_ranges == 0);
1049 return;
1051 gcc_checking_assert (m_num_ranges <= m_max_ranges);
1053 // Legacy allowed these to represent VARYING for unknown types.
1054 // Leave this in for now, until all users are converted. Eventually
1055 // we should abort in set_varying.
1056 if (m_kind == VR_VARYING && m_type == error_mark_node)
1057 return;
1059 unsigned prec = TYPE_PRECISION (m_type);
1060 if (m_kind == VR_VARYING)
1062 gcc_checking_assert (m_nonzero_mask == -1);
1063 gcc_checking_assert (m_num_ranges == 1);
1064 gcc_checking_assert (varying_compatible_p ());
1065 gcc_checking_assert (lower_bound ().get_precision () == prec);
1066 gcc_checking_assert (upper_bound ().get_precision () == prec);
1067 return;
1069 gcc_checking_assert (m_num_ranges != 0);
1070 gcc_checking_assert (!varying_compatible_p ());
1071 for (unsigned i = 0; i < m_num_ranges; ++i)
1073 wide_int lb = lower_bound (i);
1074 wide_int ub = upper_bound (i);
1075 gcc_checking_assert (lb.get_precision () == prec);
1076 gcc_checking_assert (ub.get_precision () == prec);
1077 int c = wi::cmp (lb, ub, TYPE_SIGN (m_type));
1078 gcc_checking_assert (c == 0 || c == -1);
1080 gcc_checking_assert (m_nonzero_mask.get_precision () == prec);
1083 bool
1084 irange::operator== (const irange &other) const
1086 if (m_num_ranges != other.m_num_ranges)
1087 return false;
1089 if (m_num_ranges == 0)
1090 return true;
1092 signop sign1 = TYPE_SIGN (type ());
1093 signop sign2 = TYPE_SIGN (other.type ());
1095 for (unsigned i = 0; i < m_num_ranges; ++i)
1097 widest_int lb = widest_int::from (lower_bound (i), sign1);
1098 widest_int ub = widest_int::from (upper_bound (i), sign1);
1099 widest_int lb_other = widest_int::from (other.lower_bound (i), sign2);
1100 widest_int ub_other = widest_int::from (other.upper_bound (i), sign2);
1101 if (lb != lb_other || ub != ub_other)
1102 return false;
1104 widest_int nz1 = widest_int::from (get_nonzero_bits (), sign1);
1105 widest_int nz2 = widest_int::from (other.get_nonzero_bits (), sign2);
1106 return nz1 == nz2;
1109 /* If range is a singleton, place it in RESULT and return TRUE. */
1111 bool
1112 irange::singleton_p (tree *result) const
1114 if (num_pairs () == 1 && lower_bound () == upper_bound ())
1116 if (result)
1117 *result = wide_int_to_tree (type (), lower_bound ());
1118 return true;
1120 return false;
1123 bool
1124 irange::singleton_p (wide_int &w) const
1126 if (num_pairs () == 1 && lower_bound () == upper_bound ())
1128 w = lower_bound ();
1129 return true;
1131 return false;
1134 /* Return 1 if CST is inside value range.
1135 0 if CST is not inside value range.
1137 Benchmark compile/20001226-1.c compilation time after changing this
1138 function. */
1140 bool
1141 irange::contains_p (const wide_int &cst) const
1143 if (undefined_p ())
1144 return false;
1146 // See if we can exclude CST based on the nonzero bits.
1147 if (m_nonzero_mask != -1
1148 && cst != 0
1149 && wi::bit_and (m_nonzero_mask, cst) == 0)
1150 return false;
1152 signop sign = TYPE_SIGN (type ());
1153 for (unsigned r = 0; r < m_num_ranges; ++r)
1155 if (wi::lt_p (cst, lower_bound (r), sign))
1156 return false;
1157 if (wi::le_p (cst, upper_bound (r), sign))
1158 return true;
1161 return false;
1164 // Perform an efficient union with R when both ranges have only a single pair.
1165 // Excluded are VARYING and UNDEFINED ranges.
1167 bool
1168 irange::irange_single_pair_union (const irange &r)
1170 gcc_checking_assert (!undefined_p () && !varying_p ());
1171 gcc_checking_assert (!r.undefined_p () && !varying_p ());
1173 signop sign = TYPE_SIGN (m_type);
1174 // Check if current lower bound is also the new lower bound.
1175 if (wi::le_p (m_base[0], r.m_base[0], sign))
1177 // If current upper bound is new upper bound, we're done.
1178 if (wi::le_p (r.m_base[1], m_base[1], sign))
1179 return union_nonzero_bits (r);
1180 // Otherwise R has the new upper bound.
1181 // Check for overlap/touching ranges, or single target range.
1182 if (m_max_ranges == 1
1183 || (widest_int::from (m_base[1], sign) + 1
1184 >= widest_int::from (r.m_base[0], TYPE_SIGN (r.m_type))))
1185 m_base[1] = r.m_base[1];
1186 else
1188 // This is a dual range result.
1189 m_base[2] = r.m_base[0];
1190 m_base[3] = r.m_base[1];
1191 m_num_ranges = 2;
1193 // The range has been altered, so normalize it even if nothing
1194 // changed in the mask.
1195 if (!union_nonzero_bits (r))
1196 normalize_kind ();
1197 if (flag_checking)
1198 verify_range ();
1199 return true;
1202 // Set the new lower bound to R's lower bound.
1203 wide_int lb = m_base[0];
1204 m_base[0] = r.m_base[0];
1206 // If R fully contains THIS range, just set the upper bound.
1207 if (wi::ge_p (r.m_base[1], m_base[1], sign))
1208 m_base[1] = r.m_base[1];
1209 // Check for overlapping ranges, or target limited to a single range.
1210 else if (m_max_ranges == 1
1211 || (widest_int::from (r.m_base[1], TYPE_SIGN (r.m_type)) + 1
1212 >= widest_int::from (lb, sign)))
1214 else
1216 // Left with 2 pairs.
1217 m_num_ranges = 2;
1218 m_base[2] = lb;
1219 m_base[3] = m_base[1];
1220 m_base[1] = r.m_base[1];
1222 // The range has been altered, so normalize it even if nothing
1223 // changed in the mask.
1224 if (!union_nonzero_bits (r))
1225 normalize_kind ();
1226 if (flag_checking)
1227 verify_range ();
1228 return true;
1231 // Return TRUE if anything changes.
1233 bool
1234 irange::union_ (const vrange &v)
1236 const irange &r = as_a <irange> (v);
1238 if (r.undefined_p ())
1239 return false;
1241 if (undefined_p ())
1243 operator= (r);
1244 if (flag_checking)
1245 verify_range ();
1246 return true;
1249 if (varying_p ())
1250 return false;
1252 if (r.varying_p ())
1254 set_varying (type ());
1255 return true;
1258 // Special case one range union one range.
1259 if (m_num_ranges == 1 && r.m_num_ranges == 1)
1260 return irange_single_pair_union (r);
1262 // If this ranges fully contains R, then we need do nothing.
1263 if (irange_contains_p (r))
1264 return union_nonzero_bits (r);
1266 // Do not worry about merging and such by reserving twice as many
1267 // pairs as needed, and then simply sort the 2 ranges into this
1268 // intermediate form.
1270 // The intermediate result will have the property that the beginning
1271 // of each range is <= the beginning of the next range. There may
1272 // be overlapping ranges at this point. I.e. this would be valid
1273 // [-20, 10], [-10, 0], [0, 20], [40, 90] as it satisfies this
1274 // constraint : -20 < -10 < 0 < 40. When the range is rebuilt into r,
1275 // the merge is performed.
1277 // [Xi,Yi]..[Xn,Yn] U [Xj,Yj]..[Xm,Ym] --> [Xk,Yk]..[Xp,Yp]
1278 auto_vec<wide_int, 20> res (m_num_ranges * 2 + r.m_num_ranges * 2);
1279 unsigned i = 0, j = 0, k = 0;
1280 signop sign = TYPE_SIGN (m_type);
1282 while (i < m_num_ranges * 2 && j < r.m_num_ranges * 2)
1284 // lower of Xi and Xj is the lowest point.
1285 if (widest_int::from (m_base[i], sign)
1286 <= widest_int::from (r.m_base[j], sign))
1288 res.quick_push (m_base[i]);
1289 res.quick_push (m_base[i + 1]);
1290 k += 2;
1291 i += 2;
1293 else
1295 res.quick_push (r.m_base[j]);
1296 res.quick_push (r.m_base[j + 1]);
1297 k += 2;
1298 j += 2;
1301 for ( ; i < m_num_ranges * 2; i += 2)
1303 res.quick_push (m_base[i]);
1304 res.quick_push (m_base[i + 1]);
1305 k += 2;
1307 for ( ; j < r.m_num_ranges * 2; j += 2)
1309 res.quick_push (r.m_base[j]);
1310 res.quick_push (r.m_base[j + 1]);
1311 k += 2;
1314 // Now normalize the vector removing any overlaps.
1315 i = 2;
1316 for (j = 2; j < k ; j += 2)
1318 // Current upper+1 is >= lower bound next pair, then we merge ranges.
1319 if (widest_int::from (res[i - 1], sign) + 1
1320 >= widest_int::from (res[j], sign))
1322 // New upper bounds is greater of current or the next one.
1323 if (widest_int::from (res[j + 1], sign)
1324 > widest_int::from (res[i - 1], sign))
1325 res[i - 1] = res[j + 1];
1327 else
1329 // This is a new distinct range, but no point in copying it
1330 // if it is already in the right place.
1331 if (i != j)
1333 res[i++] = res[j];
1334 res[i++] = res[j + 1];
1336 else
1337 i += 2;
1341 // At this point, the vector should have i ranges, none overlapping.
1342 // Now it simply needs to be copied, and if there are too many
1343 // ranges, merge some. We wont do any analysis as to what the
1344 // "best" merges are, simply combine the final ranges into one.
1345 maybe_resize (i / 2);
1346 if (i > m_max_ranges * 2)
1348 res[m_max_ranges * 2 - 1] = res[i - 1];
1349 i = m_max_ranges * 2;
1352 for (j = 0; j < i ; j++)
1353 m_base[j] = res [j];
1354 m_num_ranges = i / 2;
1356 m_kind = VR_RANGE;
1357 // The range has been altered, so normalize it even if nothing
1358 // changed in the mask.
1359 if (!union_nonzero_bits (r))
1360 normalize_kind ();
1361 if (flag_checking)
1362 verify_range ();
1363 return true;
1366 // Return TRUE if THIS fully contains R. No undefined or varying cases.
1368 bool
1369 irange::irange_contains_p (const irange &r) const
1371 gcc_checking_assert (!undefined_p () && !varying_p ());
1372 gcc_checking_assert (!r.undefined_p () && !varying_p ());
1374 // In order for THIS to fully contain R, all of the pairs within R must
1375 // be fully contained by the pairs in this object.
1376 signop sign = TYPE_SIGN (m_type);
1377 unsigned ri = 0;
1378 unsigned i = 0;
1379 wide_int rl = r.m_base[0];
1380 wide_int ru = r.m_base[1];
1381 wide_int l = m_base[0];
1382 wide_int u = m_base[1];
1383 while (1)
1385 // If r is contained within this range, move to the next R
1386 if (wi::ge_p (rl, l, sign)
1387 && wi::le_p (ru, u, sign))
1389 // This pair is OK, Either done, or bump to the next.
1390 if (++ri >= r.num_pairs ())
1391 return true;
1392 rl = r.m_base[ri * 2];
1393 ru = r.m_base[ri * 2 + 1];
1394 continue;
1396 // Otherwise, check if this's pair occurs before R's.
1397 if (wi::lt_p (u, rl, sign))
1399 // There's still at least one pair of R left.
1400 if (++i >= num_pairs ())
1401 return false;
1402 l = m_base[i * 2];
1403 u = m_base[i * 2 + 1];
1404 continue;
1406 return false;
1408 return false;
1412 // Return TRUE if anything changes.
1414 bool
1415 irange::intersect (const vrange &v)
1417 const irange &r = as_a <irange> (v);
1418 gcc_checking_assert (undefined_p () || r.undefined_p ()
1419 || range_compatible_p (type (), r.type ()));
1421 if (undefined_p ())
1422 return false;
1423 if (r.undefined_p ())
1425 set_undefined ();
1426 return true;
1428 if (r.varying_p ())
1429 return false;
1430 if (varying_p ())
1432 operator= (r);
1433 return true;
1436 if (r.num_pairs () == 1)
1438 bool res = intersect (r.lower_bound (), r.upper_bound ());
1439 if (undefined_p ())
1440 return true;
1442 res |= intersect_nonzero_bits (r);
1443 return res;
1446 // If R fully contains this, then intersection will change nothing.
1447 if (r.irange_contains_p (*this))
1448 return intersect_nonzero_bits (r);
1450 // ?? We could probably come up with something smarter than the
1451 // worst case scenario here.
1452 int needed = num_pairs () + r.num_pairs ();
1453 maybe_resize (needed);
1455 signop sign = TYPE_SIGN (m_type);
1456 unsigned bld_pair = 0;
1457 unsigned bld_lim = m_max_ranges;
1458 int_range_max r2 (*this);
1459 unsigned r2_lim = r2.num_pairs ();
1460 unsigned i2 = 0;
1461 for (unsigned i = 0; i < r.num_pairs (); )
1463 // If r1's upper is < r2's lower, we can skip r1's pair.
1464 wide_int ru = r.m_base[i * 2 + 1];
1465 wide_int r2l = r2.m_base[i2 * 2];
1466 if (wi::lt_p (ru, r2l, sign))
1468 i++;
1469 continue;
1471 // Likewise, skip r2's pair if its excluded.
1472 wide_int r2u = r2.m_base[i2 * 2 + 1];
1473 wide_int rl = r.m_base[i * 2];
1474 if (wi::lt_p (r2u, rl, sign))
1476 i2++;
1477 if (i2 < r2_lim)
1478 continue;
1479 // No more r2, break.
1480 break;
1483 // Must be some overlap. Find the highest of the lower bounds,
1484 // and set it, unless the build limits lower bounds is already
1485 // set.
1486 if (bld_pair < bld_lim)
1488 if (wi::ge_p (rl, r2l, sign))
1489 m_base[bld_pair * 2] = rl;
1490 else
1491 m_base[bld_pair * 2] = r2l;
1493 else
1494 // Decrease and set a new upper.
1495 bld_pair--;
1497 // ...and choose the lower of the upper bounds.
1498 if (wi::le_p (ru, r2u, sign))
1500 m_base[bld_pair * 2 + 1] = ru;
1501 bld_pair++;
1502 // Move past the r1 pair and keep trying.
1503 i++;
1504 continue;
1506 else
1508 m_base[bld_pair * 2 + 1] = r2u;
1509 bld_pair++;
1510 i2++;
1511 if (i2 < r2_lim)
1512 continue;
1513 // No more r2, break.
1514 break;
1516 // r2 has the higher lower bound.
1519 // At the exit of this loop, it is one of 2 things:
1520 // ran out of r1, or r2, but either means we are done.
1521 m_num_ranges = bld_pair;
1522 if (m_num_ranges == 0)
1524 set_undefined ();
1525 return true;
1528 m_kind = VR_RANGE;
1529 // The range has been altered, so normalize it even if nothing
1530 // changed in the mask.
1531 if (!intersect_nonzero_bits (r))
1532 normalize_kind ();
1533 if (flag_checking)
1534 verify_range ();
1535 return true;
1539 // Multirange intersect for a specified wide_int [lb, ub] range.
1540 // Return TRUE if intersect changed anything.
1542 // NOTE: It is the caller's responsibility to intersect the nonzero masks.
1544 bool
1545 irange::intersect (const wide_int& lb, const wide_int& ub)
1547 // Undefined remains undefined.
1548 if (undefined_p ())
1549 return false;
1551 tree range_type = type();
1552 signop sign = TYPE_SIGN (range_type);
1554 gcc_checking_assert (TYPE_PRECISION (range_type) == wi::get_precision (lb));
1555 gcc_checking_assert (TYPE_PRECISION (range_type) == wi::get_precision (ub));
1557 // If this range is fully contained, then intersection will do nothing.
1558 if (wi::ge_p (lower_bound (), lb, sign)
1559 && wi::le_p (upper_bound (), ub, sign))
1560 return false;
1562 unsigned bld_index = 0;
1563 unsigned pair_lim = num_pairs ();
1564 for (unsigned i = 0; i < pair_lim; i++)
1566 wide_int pairl = m_base[i * 2];
1567 wide_int pairu = m_base[i * 2 + 1];
1568 // Once UB is less than a pairs lower bound, we're done.
1569 if (wi::lt_p (ub, pairl, sign))
1570 break;
1571 // if LB is greater than this pairs upper, this pair is excluded.
1572 if (wi::lt_p (pairu, lb, sign))
1573 continue;
1575 // Must be some overlap. Find the highest of the lower bounds,
1576 // and set it
1577 if (wi::gt_p (lb, pairl, sign))
1578 m_base[bld_index * 2] = lb;
1579 else
1580 m_base[bld_index * 2] = pairl;
1582 // ...and choose the lower of the upper bounds and if the base pair
1583 // has the lower upper bound, need to check next pair too.
1584 if (wi::lt_p (ub, pairu, sign))
1586 m_base[bld_index++ * 2 + 1] = ub;
1587 break;
1589 else
1590 m_base[bld_index++ * 2 + 1] = pairu;
1593 m_num_ranges = bld_index;
1594 if (m_num_ranges == 0)
1596 set_undefined ();
1597 return true;
1600 m_kind = VR_RANGE;
1601 normalize_kind ();
1602 return true;
1606 // Signed 1-bits are strange. You can't subtract 1, because you can't
1607 // represent the number 1. This works around that for the invert routine.
1609 static wide_int inline
1610 subtract_one (const wide_int &x, tree type, wi::overflow_type &overflow)
1612 if (TYPE_SIGN (type) == SIGNED)
1613 return wi::add (x, -1, SIGNED, &overflow);
1614 else
1615 return wi::sub (x, 1, UNSIGNED, &overflow);
1618 // The analogous function for adding 1.
1620 static wide_int inline
1621 add_one (const wide_int &x, tree type, wi::overflow_type &overflow)
1623 if (TYPE_SIGN (type) == SIGNED)
1624 return wi::sub (x, -1, SIGNED, &overflow);
1625 else
1626 return wi::add (x, 1, UNSIGNED, &overflow);
1629 // Return the inverse of a range.
1631 void
1632 irange::invert ()
1634 gcc_checking_assert (!undefined_p () && !varying_p ());
1636 // We always need one more set of bounds to represent an inverse, so
1637 // if we're at the limit, we can't properly represent things.
1639 // For instance, to represent the inverse of a 2 sub-range set
1640 // [5, 10][20, 30], we would need a 3 sub-range set
1641 // [-MIN, 4][11, 19][31, MAX].
1643 // In this case, return the most conservative thing.
1645 // However, if any of the extremes of the range are -MIN/+MAX, we
1646 // know we will not need an extra bound. For example:
1648 // INVERT([-MIN,20][30,40]) => [21,29][41,+MAX]
1649 // INVERT([-MIN,20][30,MAX]) => [21,29]
1650 tree ttype = type ();
1651 unsigned prec = TYPE_PRECISION (ttype);
1652 signop sign = TYPE_SIGN (ttype);
1653 wide_int type_min = wi::min_value (prec, sign);
1654 wide_int type_max = wi::max_value (prec, sign);
1655 m_nonzero_mask = wi::minus_one (prec);
1657 // At this point, we need one extra sub-range to represent the
1658 // inverse.
1659 maybe_resize (m_num_ranges + 1);
1661 // The algorithm is as follows. To calculate INVERT ([a,b][c,d]), we
1662 // generate [-MIN, a-1][b+1, c-1][d+1, MAX].
1664 // If there is an over/underflow in the calculation for any
1665 // sub-range, we eliminate that subrange. This allows us to easily
1666 // calculate INVERT([-MIN, 5]) with: [-MIN, -MIN-1][6, MAX]. And since
1667 // we eliminate the underflow, only [6, MAX] remains.
1668 unsigned i = 0;
1669 wi::overflow_type ovf;
1670 // Construct leftmost range.
1671 int_range_max orig_range (*this);
1672 unsigned nitems = 0;
1673 wide_int tmp;
1674 // If this is going to underflow on the MINUS 1, don't even bother
1675 // checking. This also handles subtracting one from an unsigned 0,
1676 // which doesn't set the underflow bit.
1677 if (type_min != orig_range.lower_bound ())
1679 m_base[nitems++] = type_min;
1680 tmp = subtract_one (orig_range.lower_bound (), ttype, ovf);
1681 m_base[nitems++] = tmp;
1682 if (ovf)
1683 nitems = 0;
1685 i++;
1686 // Construct middle ranges if applicable.
1687 if (orig_range.num_pairs () > 1)
1689 unsigned j = i;
1690 for (; j < (orig_range.num_pairs () * 2) - 1; j += 2)
1692 // The middle ranges cannot have MAX/MIN, so there's no need
1693 // to check for unsigned overflow on the +1 and -1 here.
1694 tmp = wi::add (orig_range.m_base[j], 1, sign, &ovf);
1695 m_base[nitems++] = tmp;
1696 tmp = subtract_one (orig_range.m_base[j + 1], ttype, ovf);
1697 m_base[nitems++] = tmp;
1698 if (ovf)
1699 nitems -= 2;
1701 i = j;
1703 // Construct rightmost range.
1705 // However, if this will overflow on the PLUS 1, don't even bother.
1706 // This also handles adding one to an unsigned MAX, which doesn't
1707 // set the overflow bit.
1708 if (type_max != orig_range.m_base[i])
1710 tmp = add_one (orig_range.m_base[i], ttype, ovf);
1711 m_base[nitems++] = tmp;
1712 m_base[nitems++] = type_max;
1713 if (ovf)
1714 nitems -= 2;
1716 m_num_ranges = nitems / 2;
1718 // We disallow undefined or varying coming in, so the result can
1719 // only be a VR_RANGE.
1720 gcc_checking_assert (m_kind == VR_RANGE);
1722 if (flag_checking)
1723 verify_range ();
1726 // Return the nonzero bits inherent in the range.
1728 wide_int
1729 irange::get_nonzero_bits_from_range () const
1731 wide_int min = lower_bound ();
1732 wide_int max = upper_bound ();
1733 wide_int xorv = min ^ max;
1734 if (xorv != 0)
1736 unsigned prec = TYPE_PRECISION (type ());
1737 xorv = wi::mask (prec - wi::clz (xorv), false, prec);
1739 return min | xorv;
1742 // If the the nonzero mask can be trivially converted to a range, do
1743 // so and return TRUE.
1745 bool
1746 irange::set_range_from_nonzero_bits ()
1748 gcc_checking_assert (!undefined_p ());
1749 if (m_nonzero_mask == -1)
1750 return false;
1751 unsigned popcount = wi::popcount (m_nonzero_mask);
1753 // If we have only one bit set in the mask, we can figure out the
1754 // range immediately.
1755 if (popcount == 1)
1757 // Make sure we don't pessimize the range.
1758 if (!contains_p (m_nonzero_mask))
1759 return false;
1761 bool has_zero = contains_zero_p (*this);
1762 wide_int nz = m_nonzero_mask;
1763 set (m_type, nz, nz);
1764 m_nonzero_mask = nz;
1765 if (has_zero)
1767 int_range<2> zero;
1768 zero.set_zero (type ());
1769 union_ (zero);
1771 if (flag_checking)
1772 verify_range ();
1773 return true;
1775 else if (popcount == 0)
1777 set_zero (type ());
1778 return true;
1780 return false;
1783 void
1784 irange::set_nonzero_bits (const wide_int &bits)
1786 gcc_checking_assert (!undefined_p ());
1788 // Drop VARYINGs with a nonzero mask to a plain range.
1789 if (m_kind == VR_VARYING && bits != -1)
1790 m_kind = VR_RANGE;
1792 m_nonzero_mask = bits;
1793 if (!set_range_from_nonzero_bits ())
1794 normalize_kind ();
1795 if (flag_checking)
1796 verify_range ();
1799 // Return the nonzero bitmask. This will return the nonzero bits plus
1800 // the nonzero bits inherent in the range.
1802 wide_int
1803 irange::get_nonzero_bits () const
1805 gcc_checking_assert (!undefined_p ());
1806 // The nonzero mask inherent in the range is calculated on-demand.
1807 // For example, [0,255] does not have a 0xff nonzero mask by default
1808 // (unless manually set). This saves us considerable time, because
1809 // setting it at creation incurs a large penalty for irange::set.
1810 // At the time of writing there was a 5% slowdown in VRP if we kept
1811 // the mask precisely up to date at all times. Instead, we default
1812 // to -1 and set it when explicitly requested. However, this
1813 // function will always return the correct mask.
1814 if (m_nonzero_mask == -1)
1815 return get_nonzero_bits_from_range ();
1816 else
1817 return m_nonzero_mask & get_nonzero_bits_from_range ();
1820 // Intersect the nonzero bits in R into THIS. Return TRUE and
1821 // normalize the range if anything changed.
1823 bool
1824 irange::intersect_nonzero_bits (const irange &r)
1826 gcc_checking_assert (!undefined_p () && !r.undefined_p ());
1828 if (m_nonzero_mask == -1 && r.m_nonzero_mask == -1)
1829 return false;
1831 if (m_nonzero_mask != r.m_nonzero_mask)
1833 wide_int nz = get_nonzero_bits () & r.get_nonzero_bits ();
1834 // If the nonzero bits did not change, return false.
1835 if (nz == get_nonzero_bits ())
1836 return false;
1838 m_nonzero_mask = nz;
1839 if (!set_range_from_nonzero_bits ())
1840 normalize_kind ();
1841 if (flag_checking)
1842 verify_range ();
1843 return true;
1845 return false;
1848 // Union the nonzero bits in R into THIS. Return TRUE and normalize
1849 // the range if anything changed.
1851 bool
1852 irange::union_nonzero_bits (const irange &r)
1854 gcc_checking_assert (!undefined_p () && !r.undefined_p ());
1856 if (m_nonzero_mask == -1 && r.m_nonzero_mask == -1)
1857 return false;
1859 if (m_nonzero_mask != r.m_nonzero_mask)
1861 wide_int save = get_nonzero_bits ();
1862 m_nonzero_mask = save | r.get_nonzero_bits ();
1863 if (m_nonzero_mask == save)
1864 return false;
1865 // No need to call set_range_from_nonzero_bits, because we'll
1866 // never narrow the range. Besides, it would cause endless
1867 // recursion because of the union_ in
1868 // set_range_from_nonzero_bits.
1869 normalize_kind ();
1870 return true;
1872 return false;
1875 void
1876 dump_value_range (FILE *file, const vrange *vr)
1878 vr->dump (file);
1881 DEBUG_FUNCTION void
1882 debug (const vrange *vr)
1884 dump_value_range (stderr, vr);
1885 fprintf (stderr, "\n");
1888 DEBUG_FUNCTION void
1889 debug (const vrange &vr)
1891 debug (&vr);
1894 DEBUG_FUNCTION void
1895 debug (const value_range *vr)
1897 dump_value_range (stderr, vr);
1898 fprintf (stderr, "\n");
1901 DEBUG_FUNCTION void
1902 debug (const value_range &vr)
1904 dump_value_range (stderr, &vr);
1905 fprintf (stderr, "\n");
1908 /* Return true, if VAL1 and VAL2 are equal values for VRP purposes. */
1910 bool
1911 vrp_operand_equal_p (const_tree val1, const_tree val2)
1913 if (val1 == val2)
1914 return true;
1915 if (!val1 || !val2 || !operand_equal_p (val1, val2, 0))
1916 return false;
1917 return true;
1920 void
1921 gt_ggc_mx (irange *x)
1923 if (!x->undefined_p ())
1924 gt_ggc_mx (x->m_type);
1927 void
1928 gt_pch_nx (irange *x)
1930 if (!x->undefined_p ())
1931 gt_pch_nx (x->m_type);
1934 void
1935 gt_pch_nx (irange *x, gt_pointer_operator op, void *cookie)
1937 for (unsigned i = 0; i < x->m_num_ranges; ++i)
1939 op (&x->m_base[i * 2], NULL, cookie);
1940 op (&x->m_base[i * 2 + 1], NULL, cookie);
1944 void
1945 gt_ggc_mx (frange *x)
1947 gt_ggc_mx (x->m_type);
1950 void
1951 gt_pch_nx (frange *x)
1953 gt_pch_nx (x->m_type);
1956 void
1957 gt_pch_nx (frange *x, gt_pointer_operator op, void *cookie)
1959 op (&x->m_type, NULL, cookie);
1962 void
1963 gt_ggc_mx (vrange *x)
1965 if (is_a <irange> (*x))
1966 return gt_ggc_mx ((irange *) x);
1967 if (is_a <frange> (*x))
1968 return gt_ggc_mx ((frange *) x);
1969 gcc_unreachable ();
1972 void
1973 gt_pch_nx (vrange *x)
1975 if (is_a <irange> (*x))
1976 return gt_pch_nx ((irange *) x);
1977 if (is_a <frange> (*x))
1978 return gt_pch_nx ((frange *) x);
1979 gcc_unreachable ();
1982 void
1983 gt_pch_nx (vrange *x, gt_pointer_operator op, void *cookie)
1985 if (is_a <irange> (*x))
1986 gt_pch_nx ((irange *) x, op, cookie);
1987 else if (is_a <frange> (*x))
1988 gt_pch_nx ((frange *) x, op, cookie);
1989 else
1990 gcc_unreachable ();
1993 #define DEFINE_INT_RANGE_INSTANCE(N) \
1994 template int_range<N>::int_range(tree_node *, \
1995 const wide_int &, \
1996 const wide_int &, \
1997 value_range_kind); \
1998 template int_range<N>::int_range(tree); \
1999 template int_range<N>::int_range(const irange &); \
2000 template int_range<N>::int_range(const int_range &); \
2001 template int_range<N>& int_range<N>::operator= (const int_range &);
2003 DEFINE_INT_RANGE_INSTANCE(1)
2004 DEFINE_INT_RANGE_INSTANCE(2)
2005 DEFINE_INT_RANGE_INSTANCE(3)
2006 DEFINE_INT_RANGE_INSTANCE(255)
2008 #if CHECKING_P
2009 #include "selftest.h"
2011 #define INT(x) wi::shwi ((x), TYPE_PRECISION (integer_type_node))
2012 #define UINT(x) wi::uhwi ((x), TYPE_PRECISION (unsigned_type_node))
2013 #define SCHAR(x) wi::shwi ((x), TYPE_PRECISION (signed_char_type_node))
2015 namespace selftest
2018 static int_range<2>
2019 range (tree type, int a, int b, value_range_kind kind = VR_RANGE)
2021 wide_int w1, w2;
2022 if (TYPE_UNSIGNED (type))
2024 w1 = wi::uhwi (a, TYPE_PRECISION (type));
2025 w2 = wi::uhwi (b, TYPE_PRECISION (type));
2027 else
2029 w1 = wi::shwi (a, TYPE_PRECISION (type));
2030 w2 = wi::shwi (b, TYPE_PRECISION (type));
2032 return int_range<2> (type, w1, w2, kind);
2035 static int_range<2>
2036 range_int (int a, int b, value_range_kind kind = VR_RANGE)
2038 return range (integer_type_node, a, b, kind);
2041 static int_range<2>
2042 range_uint (int a, int b, value_range_kind kind = VR_RANGE)
2044 return range (unsigned_type_node, a, b, kind);
2047 static int_range<2>
2048 range_uint128 (int a, int b, value_range_kind kind = VR_RANGE)
2050 tree u128_type_node = build_nonstandard_integer_type (128, 1);
2051 return range (u128_type_node, a, b, kind);
2054 static int_range<2>
2055 range_uchar (int a, int b, value_range_kind kind = VR_RANGE)
2057 return range (unsigned_char_type_node, a, b, kind);
2060 static int_range<2>
2061 range_char (int a, int b, value_range_kind kind = VR_RANGE)
2063 return range (signed_char_type_node, a, b, kind);
2066 static int_range<3>
2067 build_range3 (int a, int b, int c, int d, int e, int f)
2069 int_range<3> i1 = range_int (a, b);
2070 int_range<3> i2 = range_int (c, d);
2071 int_range<3> i3 = range_int (e, f);
2072 i1.union_ (i2);
2073 i1.union_ (i3);
2074 return i1;
2077 static void
2078 range_tests_irange3 ()
2080 int_range<3> r0, r1, r2;
2081 int_range<3> i1, i2, i3;
2083 // ([10,20] U [5,8]) U [1,3] ==> [1,3][5,8][10,20].
2084 r0 = range_int (10, 20);
2085 r1 = range_int (5, 8);
2086 r0.union_ (r1);
2087 r1 = range_int (1, 3);
2088 r0.union_ (r1);
2089 ASSERT_TRUE (r0 == build_range3 (1, 3, 5, 8, 10, 20));
2091 // [1,3][5,8][10,20] U [-5,0] => [-5,3][5,8][10,20].
2092 r1 = range_int (-5, 0);
2093 r0.union_ (r1);
2094 ASSERT_TRUE (r0 == build_range3 (-5, 3, 5, 8, 10, 20));
2096 // [10,20][30,40] U [50,60] ==> [10,20][30,40][50,60].
2097 r1 = range_int (50, 60);
2098 r0 = range_int (10, 20);
2099 r0.union_ (range_int (30, 40));
2100 r0.union_ (r1);
2101 ASSERT_TRUE (r0 == build_range3 (10, 20, 30, 40, 50, 60));
2102 // [10,20][30,40][50,60] U [70, 80] ==> [10,20][30,40][50,60][70,80].
2103 r1 = range_int (70, 80);
2104 r0.union_ (r1);
2106 r2 = build_range3 (10, 20, 30, 40, 50, 60);
2107 r2.union_ (range_int (70, 80));
2108 ASSERT_TRUE (r0 == r2);
2110 // [10,20][30,40][50,60] U [6,35] => [6,40][50,60].
2111 r0 = build_range3 (10, 20, 30, 40, 50, 60);
2112 r1 = range_int (6, 35);
2113 r0.union_ (r1);
2114 r1 = range_int (6, 40);
2115 r1.union_ (range_int (50, 60));
2116 ASSERT_TRUE (r0 == r1);
2118 // [10,20][30,40][50,60] U [6,60] => [6,60].
2119 r0 = build_range3 (10, 20, 30, 40, 50, 60);
2120 r1 = range_int (6, 60);
2121 r0.union_ (r1);
2122 ASSERT_TRUE (r0 == range_int (6, 60));
2124 // [10,20][30,40][50,60] U [6,70] => [6,70].
2125 r0 = build_range3 (10, 20, 30, 40, 50, 60);
2126 r1 = range_int (6, 70);
2127 r0.union_ (r1);
2128 ASSERT_TRUE (r0 == range_int (6, 70));
2130 // [10,20][30,40][50,60] U [35,70] => [10,20][30,70].
2131 r0 = build_range3 (10, 20, 30, 40, 50, 60);
2132 r1 = range_int (35, 70);
2133 r0.union_ (r1);
2134 r1 = range_int (10, 20);
2135 r1.union_ (range_int (30, 70));
2136 ASSERT_TRUE (r0 == r1);
2138 // [10,20][30,40][50,60] U [15,35] => [10,40][50,60].
2139 r0 = build_range3 (10, 20, 30, 40, 50, 60);
2140 r1 = range_int (15, 35);
2141 r0.union_ (r1);
2142 r1 = range_int (10, 40);
2143 r1.union_ (range_int (50, 60));
2144 ASSERT_TRUE (r0 == r1);
2146 // [10,20][30,40][50,60] U [35,35] => [10,20][30,40][50,60].
2147 r0 = build_range3 (10, 20, 30, 40, 50, 60);
2148 r1 = range_int (35, 35);
2149 r0.union_ (r1);
2150 ASSERT_TRUE (r0 == build_range3 (10, 20, 30, 40, 50, 60));
2153 static void
2154 range_tests_int_range_max ()
2156 int_range_max big;
2157 unsigned int nrange;
2159 // Build a huge multi-range range.
2160 for (nrange = 0; nrange < 50; ++nrange)
2162 int_range<1> tmp = range_int (nrange*10, nrange *10 + 5);
2163 big.union_ (tmp);
2165 ASSERT_TRUE (big.num_pairs () == nrange);
2167 // Verify that we can copy it without loosing precision.
2168 int_range_max copy (big);
2169 ASSERT_TRUE (copy.num_pairs () == nrange);
2171 // Inverting it should produce one more sub-range.
2172 big.invert ();
2173 ASSERT_TRUE (big.num_pairs () == nrange + 1);
2175 int_range<1> tmp = range_int (5, 37);
2176 big.intersect (tmp);
2177 ASSERT_TRUE (big.num_pairs () == 4);
2179 // Test that [10,10][20,20] does NOT contain 15.
2181 int_range_max i1 = range_int (10, 10);
2182 int_range_max i2 = range_int (20, 20);
2183 i1.union_ (i2);
2184 ASSERT_FALSE (i1.contains_p (INT (15)));
2188 // Simulate -fstrict-enums where the domain of a type is less than the
2189 // underlying type.
2191 static void
2192 range_tests_strict_enum ()
2194 // The enum can only hold [0, 3].
2195 tree rtype = copy_node (unsigned_type_node);
2196 TYPE_MIN_VALUE (rtype) = build_int_cstu (rtype, 0);
2197 TYPE_MAX_VALUE (rtype) = build_int_cstu (rtype, 3);
2199 // Test that even though vr1 covers the strict enum domain ([0, 3]),
2200 // it does not cover the domain of the underlying type.
2201 int_range<1> vr1 = range (rtype, 0, 1);
2202 int_range<1> vr2 = range (rtype, 2, 3);
2203 vr1.union_ (vr2);
2204 ASSERT_TRUE (vr1 == range (rtype, 0, 3));
2205 ASSERT_FALSE (vr1.varying_p ());
2207 // Test that copying to a multi-range does not change things.
2208 int_range<2> ir1 (vr1);
2209 ASSERT_TRUE (ir1 == vr1);
2210 ASSERT_FALSE (ir1.varying_p ());
2212 // The same test as above, but using TYPE_{MIN,MAX}_VALUE instead of [0,3].
2213 vr1 = int_range<2> (rtype,
2214 wi::to_wide (TYPE_MIN_VALUE (rtype)),
2215 wi::to_wide (TYPE_MAX_VALUE (rtype)));
2216 ir1 = vr1;
2217 ASSERT_TRUE (ir1 == vr1);
2218 ASSERT_FALSE (ir1.varying_p ());
2221 static void
2222 range_tests_misc ()
2224 tree u128_type = build_nonstandard_integer_type (128, /*unsigned=*/1);
2225 int_range<2> i1, i2, i3;
2226 int_range<2> r0, r1, rold;
2228 // Test 1-bit signed integer union.
2229 // [-1,-1] U [0,0] = VARYING.
2230 tree one_bit_type = build_nonstandard_integer_type (1, 0);
2231 wide_int one_bit_min = irange_val_min (one_bit_type);
2232 wide_int one_bit_max = irange_val_max (one_bit_type);
2234 int_range<2> min = int_range<2> (one_bit_type, one_bit_min, one_bit_min);
2235 int_range<2> max = int_range<2> (one_bit_type, one_bit_max, one_bit_max);
2236 max.union_ (min);
2237 ASSERT_TRUE (max.varying_p ());
2239 // Test that we can set a range of true+false for a 1-bit signed int.
2240 r0 = range_true_and_false (one_bit_type);
2242 // Test inversion of 1-bit signed integers.
2244 int_range<2> min = int_range<2> (one_bit_type, one_bit_min, one_bit_min);
2245 int_range<2> max = int_range<2> (one_bit_type, one_bit_max, one_bit_max);
2246 int_range<2> t;
2247 t = min;
2248 t.invert ();
2249 ASSERT_TRUE (t == max);
2250 t = max;
2251 t.invert ();
2252 ASSERT_TRUE (t == min);
2255 // Test that NOT(255) is [0..254] in 8-bit land.
2256 int_range<1> not_255 = range_uchar (255, 255, VR_ANTI_RANGE);
2257 ASSERT_TRUE (not_255 == range_uchar (0, 254));
2259 // Test that NOT(0) is [1..255] in 8-bit land.
2260 int_range<2> not_zero = range_nonzero (unsigned_char_type_node);
2261 ASSERT_TRUE (not_zero == range_uchar (1, 255));
2263 // Check that [0,127][0x..ffffff80,0x..ffffff]
2264 // => ~[128, 0x..ffffff7f].
2265 r0 = range_uint128 (0, 127);
2266 wide_int high = wi::minus_one (128);
2267 // low = -1 - 127 => 0x..ffffff80.
2268 wide_int low = wi::sub (high, wi::uhwi (127, 128));
2269 r1 = int_range<1> (u128_type, low, high); // [0x..ffffff80, 0x..ffffffff]
2270 // r0 = [0,127][0x..ffffff80,0x..fffffff].
2271 r0.union_ (r1);
2272 // r1 = [128, 0x..ffffff7f].
2273 r1 = int_range<1> (u128_type,
2274 wi::uhwi (128, 128),
2275 wi::sub (wi::minus_one (128), wi::uhwi (128, 128)));
2276 r0.invert ();
2277 ASSERT_TRUE (r0 == r1);
2279 r0.set_varying (integer_type_node);
2280 wide_int minint = r0.lower_bound ();
2281 wide_int maxint = r0.upper_bound ();
2283 r0.set_varying (short_integer_type_node);
2285 r0.set_varying (unsigned_type_node);
2286 wide_int maxuint = r0.upper_bound ();
2288 // Check that ~[0,5] => [6,MAX] for unsigned int.
2289 r0 = range_uint (0, 5);
2290 r0.invert ();
2291 ASSERT_TRUE (r0 == int_range<1> (unsigned_type_node,
2292 wi::uhwi (6, TYPE_PRECISION (unsigned_type_node)),
2293 maxuint));
2295 // Check that ~[10,MAX] => [0,9] for unsigned int.
2296 r0 = int_range<1> (unsigned_type_node,
2297 wi::uhwi (10, TYPE_PRECISION (unsigned_type_node)),
2298 maxuint);
2299 r0.invert ();
2300 ASSERT_TRUE (r0 == range_uint (0, 9));
2302 // Check that ~[0,5] => [6,MAX] for unsigned 128-bit numbers.
2303 r0 = range_uint128 (0, 5, VR_ANTI_RANGE);
2304 r1 = int_range<1> (u128_type, wi::uhwi (6, 128), wi::minus_one (128));
2305 ASSERT_TRUE (r0 == r1);
2307 // Check that [~5] is really [-MIN,4][6,MAX].
2308 r0 = range_int (5, 5, VR_ANTI_RANGE);
2309 r1 = int_range<1> (integer_type_node, minint, INT (4));
2310 r1.union_ (int_range<1> (integer_type_node, INT (6), maxint));
2311 ASSERT_FALSE (r1.undefined_p ());
2312 ASSERT_TRUE (r0 == r1);
2314 r1 = range_int (5, 5);
2315 int_range<2> r2 (r1);
2316 ASSERT_TRUE (r1 == r2);
2318 r1 = range_int (5, 10);
2320 r1 = range_int (5, 10);
2321 ASSERT_TRUE (r1.contains_p (INT (7)));
2323 r1 = range_char (0, 20);
2324 ASSERT_TRUE (r1.contains_p (SCHAR(15)));
2325 ASSERT_FALSE (r1.contains_p (SCHAR(300)));
2327 // NOT([10,20]) ==> [-MIN,9][21,MAX].
2328 r0 = r1 = range_int (10, 20);
2329 r2 = int_range<1> (integer_type_node, minint, INT(9));
2330 r2.union_ (int_range<1> (integer_type_node, INT(21), maxint));
2331 ASSERT_FALSE (r2.undefined_p ());
2332 r1.invert ();
2333 ASSERT_TRUE (r1 == r2);
2334 // Test that NOT(NOT(x)) == x.
2335 r2.invert ();
2336 ASSERT_TRUE (r0 == r2);
2338 // Test that booleans and their inverse work as expected.
2339 r0 = range_zero (boolean_type_node);
2340 ASSERT_TRUE (r0 == range_false ());
2341 r0.invert ();
2342 ASSERT_TRUE (r0 == range_true ());
2344 // Make sure NULL and non-NULL of pointer types work, and that
2345 // inverses of them are consistent.
2346 tree voidp = build_pointer_type (void_type_node);
2347 r0 = range_zero (voidp);
2348 r1 = r0;
2349 r0.invert ();
2350 r0.invert ();
2351 ASSERT_TRUE (r0 == r1);
2353 // [10,20] U [15, 30] => [10, 30].
2354 r0 = range_int (10, 20);
2355 r1 = range_int (15, 30);
2356 r0.union_ (r1);
2357 ASSERT_TRUE (r0 == range_int (10, 30));
2359 // [15,40] U [] => [15,40].
2360 r0 = range_int (15, 40);
2361 r1.set_undefined ();
2362 r0.union_ (r1);
2363 ASSERT_TRUE (r0 == range_int (15, 40));
2365 // [10,20] U [10,10] => [10,20].
2366 r0 = range_int (10, 20);
2367 r1 = range_int (10, 10);
2368 r0.union_ (r1);
2369 ASSERT_TRUE (r0 == range_int (10, 20));
2371 // [10,20] U [9,9] => [9,20].
2372 r0 = range_int (10, 20);
2373 r1 = range_int (9, 9);
2374 r0.union_ (r1);
2375 ASSERT_TRUE (r0 == range_int (9, 20));
2377 // [10,20] ^ [15,30] => [15,20].
2378 r0 = range_int (10, 20);
2379 r1 = range_int (15, 30);
2380 r0.intersect (r1);
2381 ASSERT_TRUE (r0 == range_int (15, 20));
2383 // Test the internal sanity of wide_int's wrt HWIs.
2384 ASSERT_TRUE (wi::max_value (TYPE_PRECISION (boolean_type_node),
2385 TYPE_SIGN (boolean_type_node))
2386 == wi::uhwi (1, TYPE_PRECISION (boolean_type_node)));
2388 // Test zero_p().
2389 r0 = range_int (0, 0);
2390 ASSERT_TRUE (r0.zero_p ());
2392 // Test nonzero_p().
2393 r0 = range_int (0, 0);
2394 r0.invert ();
2395 ASSERT_TRUE (r0.nonzero_p ());
2397 // r0 = ~[1,1]
2398 r0 = range_int (1, 1, VR_ANTI_RANGE);
2399 // r1 = ~[3,3]
2400 r1 = range_int (3, 3, VR_ANTI_RANGE);
2402 // vv = [0,0][2,2][4, MAX]
2403 int_range<3> vv = r0;
2404 vv.intersect (r1);
2406 ASSERT_TRUE (vv.contains_p (UINT (2)));
2407 ASSERT_TRUE (vv.num_pairs () == 3);
2409 r0 = range_int (1, 1);
2410 // And union it with [0,0][2,2][4,MAX] multi range
2411 r0.union_ (vv);
2412 // The result should be [0,2][4,MAX], or ~[3,3] but it must contain 2
2413 ASSERT_TRUE (r0.contains_p (INT (2)));
2416 static void
2417 range_tests_nonzero_bits ()
2419 int_range<2> r0, r1;
2421 // Adding nonzero bits to a varying drops the varying.
2422 r0.set_varying (integer_type_node);
2423 r0.set_nonzero_bits (INT (255));
2424 ASSERT_TRUE (!r0.varying_p ());
2425 // Dropping the nonzero bits brings us back to varying.
2426 r0.set_nonzero_bits (INT (-1));
2427 ASSERT_TRUE (r0.varying_p ());
2429 // Test contains_p with nonzero bits.
2430 r0.set_zero (integer_type_node);
2431 ASSERT_TRUE (r0.contains_p (INT (0)));
2432 ASSERT_FALSE (r0.contains_p (INT (1)));
2433 r0.set_nonzero_bits (INT (0xfe));
2434 ASSERT_FALSE (r0.contains_p (INT (0x100)));
2435 ASSERT_FALSE (r0.contains_p (INT (0x3)));
2437 // Union of nonzero bits.
2438 r0.set_varying (integer_type_node);
2439 r0.set_nonzero_bits (INT (0xf0));
2440 r1.set_varying (integer_type_node);
2441 r1.set_nonzero_bits (INT (0xf));
2442 r0.union_ (r1);
2443 ASSERT_TRUE (r0.get_nonzero_bits () == 0xff);
2445 // Intersect of nonzero bits.
2446 r0 = range_int (0, 255);
2447 r0.set_nonzero_bits (INT (0xfe));
2448 r1.set_varying (integer_type_node);
2449 r1.set_nonzero_bits (INT (0xf0));
2450 r0.intersect (r1);
2451 ASSERT_TRUE (r0.get_nonzero_bits () == 0xf0);
2453 // Intersect where the mask of nonzero bits is implicit from the range.
2454 r0.set_varying (integer_type_node);
2455 r1 = range_int (0, 255);
2456 r0.intersect (r1);
2457 ASSERT_TRUE (r0.get_nonzero_bits () == 0xff);
2459 // The union of a mask of 0xff..ffff00 with a mask of 0xff spans the
2460 // entire domain, and makes the range a varying.
2461 r0.set_varying (integer_type_node);
2462 wide_int x = wi::shwi (0xff, TYPE_PRECISION (integer_type_node));
2463 x = wi::bit_not (x);
2464 r0.set_nonzero_bits (x); // 0xff..ff00
2465 r1.set_varying (integer_type_node);
2466 r1.set_nonzero_bits (INT (0xff));
2467 r0.union_ (r1);
2468 ASSERT_TRUE (r0.varying_p ());
2470 // Test that setting a nonzero bit of 1 does not pessimize the range.
2471 r0.set_zero (integer_type_node);
2472 r0.set_nonzero_bits (INT (1));
2473 ASSERT_TRUE (r0.zero_p ());
2476 // Build an frange from string endpoints.
2478 static inline frange
2479 frange_float (const char *lb, const char *ub, tree type = float_type_node)
2481 REAL_VALUE_TYPE min, max;
2482 gcc_assert (real_from_string (&min, lb) == 0);
2483 gcc_assert (real_from_string (&max, ub) == 0);
2484 return frange (type, min, max);
2487 static void
2488 range_tests_nan ()
2490 frange r0, r1;
2491 REAL_VALUE_TYPE q, r;
2492 bool signbit;
2494 // Equal ranges but with differing NAN bits are not equal.
2495 if (HONOR_NANS (float_type_node))
2497 r1 = frange_float ("10", "12");
2498 r0 = r1;
2499 ASSERT_EQ (r0, r1);
2500 r0.clear_nan ();
2501 ASSERT_NE (r0, r1);
2502 r0.update_nan ();
2503 ASSERT_EQ (r0, r1);
2505 // [10, 20] NAN ^ [30, 40] NAN = NAN.
2506 r0 = frange_float ("10", "20");
2507 r1 = frange_float ("30", "40");
2508 r0.intersect (r1);
2509 ASSERT_TRUE (r0.known_isnan ());
2511 // [3,5] U [5,10] NAN = ... NAN
2512 r0 = frange_float ("3", "5");
2513 r0.clear_nan ();
2514 r1 = frange_float ("5", "10");
2515 r0.union_ (r1);
2516 ASSERT_TRUE (r0.maybe_isnan ());
2519 // [5,6] U NAN = [5,6] NAN.
2520 r0 = frange_float ("5", "6");
2521 r0.clear_nan ();
2522 r1.set_nan (float_type_node);
2523 r0.union_ (r1);
2524 real_from_string (&q, "5");
2525 real_from_string (&r, "6");
2526 ASSERT_TRUE (real_identical (&q, &r0.lower_bound ()));
2527 ASSERT_TRUE (real_identical (&r, &r0.upper_bound ()));
2528 ASSERT_TRUE (r0.maybe_isnan ());
2530 // NAN U NAN = NAN
2531 r0.set_nan (float_type_node);
2532 r1.set_nan (float_type_node);
2533 r0.union_ (r1);
2534 ASSERT_TRUE (r0.known_isnan ());
2536 // [INF, INF] NAN ^ NAN = NAN
2537 r0.set_nan (float_type_node);
2538 r1 = frange_float ("+Inf", "+Inf");
2539 if (!HONOR_NANS (float_type_node))
2540 r1.update_nan ();
2541 r0.intersect (r1);
2542 ASSERT_TRUE (r0.known_isnan ());
2544 // NAN ^ NAN = NAN
2545 r0.set_nan (float_type_node);
2546 r1.set_nan (float_type_node);
2547 r0.intersect (r1);
2548 ASSERT_TRUE (r0.known_isnan ());
2550 // +NAN ^ -NAN = UNDEFINED
2551 r0.set_nan (float_type_node, false);
2552 r1.set_nan (float_type_node, true);
2553 r0.intersect (r1);
2554 ASSERT_TRUE (r0.undefined_p ());
2556 // VARYING ^ NAN = NAN.
2557 r0.set_nan (float_type_node);
2558 r1.set_varying (float_type_node);
2559 r0.intersect (r1);
2560 ASSERT_TRUE (r0.known_isnan ());
2562 // [3,4] ^ NAN = UNDEFINED.
2563 r0 = frange_float ("3", "4");
2564 r0.clear_nan ();
2565 r1.set_nan (float_type_node);
2566 r0.intersect (r1);
2567 ASSERT_TRUE (r0.undefined_p ());
2569 // [-3, 5] ^ NAN = UNDEFINED
2570 r0 = frange_float ("-3", "5");
2571 r0.clear_nan ();
2572 r1.set_nan (float_type_node);
2573 r0.intersect (r1);
2574 ASSERT_TRUE (r0.undefined_p ());
2576 // Setting the NAN bit to yes does not make us a known NAN.
2577 r0.set_varying (float_type_node);
2578 r0.update_nan ();
2579 ASSERT_FALSE (r0.known_isnan ());
2581 // NAN is in a VARYING.
2582 r0.set_varying (float_type_node);
2583 real_nan (&r, "", 1, TYPE_MODE (float_type_node));
2584 REAL_VALUE_TYPE nan = r;
2585 ASSERT_TRUE (r0.contains_p (nan));
2587 // -NAN is in a VARYING.
2588 r0.set_varying (float_type_node);
2589 q = real_value_negate (&r);
2590 REAL_VALUE_TYPE neg_nan = q;
2591 ASSERT_TRUE (r0.contains_p (neg_nan));
2593 // Clearing the NAN on a [] NAN is the empty set.
2594 r0.set_nan (float_type_node);
2595 r0.clear_nan ();
2596 ASSERT_TRUE (r0.undefined_p ());
2598 // [10,20] NAN ^ [21,25] NAN = [NAN]
2599 r0 = frange_float ("10", "20");
2600 r0.update_nan ();
2601 r1 = frange_float ("21", "25");
2602 r1.update_nan ();
2603 r0.intersect (r1);
2604 ASSERT_TRUE (r0.known_isnan ());
2606 // NAN U [5,6] should be [5,6] +-NAN.
2607 r0.set_nan (float_type_node);
2608 r1 = frange_float ("5", "6");
2609 r1.clear_nan ();
2610 r0.union_ (r1);
2611 real_from_string (&q, "5");
2612 real_from_string (&r, "6");
2613 ASSERT_TRUE (real_identical (&q, &r0.lower_bound ()));
2614 ASSERT_TRUE (real_identical (&r, &r0.upper_bound ()));
2615 ASSERT_TRUE (!r0.signbit_p (signbit));
2616 ASSERT_TRUE (r0.maybe_isnan ());
2619 static void
2620 range_tests_signed_zeros ()
2622 REAL_VALUE_TYPE zero = dconst0;
2623 REAL_VALUE_TYPE neg_zero = zero;
2624 neg_zero.sign = 1;
2625 frange r0, r1;
2626 bool signbit;
2628 // [0,0] contains [0,0] but not [-0,-0] and vice versa.
2629 r0 = frange_float ("0.0", "0.0");
2630 r1 = frange_float ("-0.0", "-0.0");
2631 ASSERT_TRUE (r0.contains_p (zero));
2632 ASSERT_TRUE (!r0.contains_p (neg_zero));
2633 ASSERT_TRUE (r1.contains_p (neg_zero));
2634 ASSERT_TRUE (!r1.contains_p (zero));
2636 // Test contains_p() when we know the sign of the zero.
2637 r0 = frange_float ("0.0", "0.0");
2638 ASSERT_TRUE (r0.contains_p (zero));
2639 ASSERT_FALSE (r0.contains_p (neg_zero));
2640 r0 = frange_float ("-0.0", "-0.0");
2641 ASSERT_TRUE (r0.contains_p (neg_zero));
2642 ASSERT_FALSE (r0.contains_p (zero));
2644 r0 = frange_float ("-0.0", "0.0");
2645 ASSERT_TRUE (r0.contains_p (neg_zero));
2646 ASSERT_TRUE (r0.contains_p (zero));
2648 r0 = frange_float ("-3", "5");
2649 ASSERT_TRUE (r0.contains_p (neg_zero));
2650 ASSERT_TRUE (r0.contains_p (zero));
2652 // The intersection of zeros that differ in sign is a NAN (or
2653 // undefined if not honoring NANs).
2654 r0 = frange_float ("-0.0", "-0.0");
2655 r1 = frange_float ("0.0", "0.0");
2656 r0.intersect (r1);
2657 if (HONOR_NANS (float_type_node))
2658 ASSERT_TRUE (r0.known_isnan ());
2659 else
2660 ASSERT_TRUE (r0.undefined_p ());
2662 // The union of zeros that differ in sign is a zero with unknown sign.
2663 r0 = frange_float ("0.0", "0.0");
2664 r1 = frange_float ("-0.0", "-0.0");
2665 r0.union_ (r1);
2666 ASSERT_TRUE (r0.zero_p () && !r0.signbit_p (signbit));
2668 // [-0, +0] has an unknown sign.
2669 r0 = frange_float ("-0.0", "0.0");
2670 ASSERT_TRUE (r0.zero_p () && !r0.signbit_p (signbit));
2672 // [-0, +0] ^ [0, 0] is [0, 0]
2673 r0 = frange_float ("-0.0", "0.0");
2674 r1 = frange_float ("0.0", "0.0");
2675 r0.intersect (r1);
2676 ASSERT_TRUE (r0.zero_p ());
2678 r0 = frange_float ("+0", "5");
2679 r0.clear_nan ();
2680 ASSERT_TRUE (r0.signbit_p (signbit) && !signbit);
2682 r0 = frange_float ("-0", "5");
2683 r0.clear_nan ();
2684 ASSERT_TRUE (!r0.signbit_p (signbit));
2686 r0 = frange_float ("-0", "10");
2687 r1 = frange_float ("0", "5");
2688 r0.intersect (r1);
2689 ASSERT_TRUE (real_iszero (&r0.lower_bound (), false));
2691 r0 = frange_float ("-0", "5");
2692 r1 = frange_float ("0", "5");
2693 r0.union_ (r1);
2694 ASSERT_TRUE (real_iszero (&r0.lower_bound (), true));
2696 r0 = frange_float ("-5", "-0");
2697 r0.update_nan ();
2698 r1 = frange_float ("0", "0");
2699 r1.update_nan ();
2700 r0.intersect (r1);
2701 if (HONOR_NANS (float_type_node))
2702 ASSERT_TRUE (r0.known_isnan ());
2703 else
2704 ASSERT_TRUE (r0.undefined_p ());
2706 r0.set_nonnegative (float_type_node);
2707 if (HONOR_NANS (float_type_node))
2708 ASSERT_TRUE (r0.maybe_isnan ());
2710 // Numbers containing zero should have an unknown SIGNBIT.
2711 r0 = frange_float ("0", "10");
2712 r0.clear_nan ();
2713 ASSERT_TRUE (r0.signbit_p (signbit) && !signbit);
2716 static void
2717 range_tests_signbit ()
2719 frange r0, r1;
2720 bool signbit;
2722 // Negative numbers should have the SIGNBIT set.
2723 r0 = frange_float ("-5", "-1");
2724 r0.clear_nan ();
2725 ASSERT_TRUE (r0.signbit_p (signbit) && signbit);
2726 // Positive numbers should have the SIGNBIT clear.
2727 r0 = frange_float ("1", "10");
2728 r0.clear_nan ();
2729 ASSERT_TRUE (r0.signbit_p (signbit) && !signbit);
2730 // Numbers spanning both positive and negative should have an
2731 // unknown SIGNBIT.
2732 r0 = frange_float ("-10", "10");
2733 r0.clear_nan ();
2734 ASSERT_TRUE (!r0.signbit_p (signbit));
2735 r0.set_varying (float_type_node);
2736 ASSERT_TRUE (!r0.signbit_p (signbit));
2739 static void
2740 range_tests_floats ()
2742 frange r0, r1;
2744 if (HONOR_NANS (float_type_node))
2745 range_tests_nan ();
2746 range_tests_signbit ();
2748 if (HONOR_SIGNED_ZEROS (float_type_node))
2749 range_tests_signed_zeros ();
2751 // A range of [-INF,+INF] is actually VARYING if no other properties
2752 // are set.
2753 r0 = frange_float ("-Inf", "+Inf");
2754 ASSERT_TRUE (r0.varying_p ());
2755 // ...unless it has some special property...
2756 if (HONOR_NANS (r0.type ()))
2758 r0.clear_nan ();
2759 ASSERT_FALSE (r0.varying_p ());
2762 // For most architectures, where float and double are different
2763 // sizes, having the same endpoints does not necessarily mean the
2764 // ranges are equal.
2765 if (!types_compatible_p (float_type_node, double_type_node))
2767 r0 = frange_float ("3.0", "3.0", float_type_node);
2768 r1 = frange_float ("3.0", "3.0", double_type_node);
2769 ASSERT_NE (r0, r1);
2772 // [3,5] U [10,12] = [3,12].
2773 r0 = frange_float ("3", "5");
2774 r1 = frange_float ("10", "12");
2775 r0.union_ (r1);
2776 ASSERT_EQ (r0, frange_float ("3", "12"));
2778 // [5,10] U [4,8] = [4,10]
2779 r0 = frange_float ("5", "10");
2780 r1 = frange_float ("4", "8");
2781 r0.union_ (r1);
2782 ASSERT_EQ (r0, frange_float ("4", "10"));
2784 // [3,5] U [4,10] = [3,10]
2785 r0 = frange_float ("3", "5");
2786 r1 = frange_float ("4", "10");
2787 r0.union_ (r1);
2788 ASSERT_EQ (r0, frange_float ("3", "10"));
2790 // [4,10] U [5,11] = [4,11]
2791 r0 = frange_float ("4", "10");
2792 r1 = frange_float ("5", "11");
2793 r0.union_ (r1);
2794 ASSERT_EQ (r0, frange_float ("4", "11"));
2796 // [3,12] ^ [10,12] = [10,12].
2797 r0 = frange_float ("3", "12");
2798 r1 = frange_float ("10", "12");
2799 r0.intersect (r1);
2800 ASSERT_EQ (r0, frange_float ("10", "12"));
2802 // [10,12] ^ [11,11] = [11,11]
2803 r0 = frange_float ("10", "12");
2804 r1 = frange_float ("11", "11");
2805 r0.intersect (r1);
2806 ASSERT_EQ (r0, frange_float ("11", "11"));
2808 // [10,20] ^ [5,15] = [10,15]
2809 r0 = frange_float ("10", "20");
2810 r1 = frange_float ("5", "15");
2811 r0.intersect (r1);
2812 ASSERT_EQ (r0, frange_float ("10", "15"));
2814 // [10,20] ^ [15,25] = [15,20]
2815 r0 = frange_float ("10", "20");
2816 r1 = frange_float ("15", "25");
2817 r0.intersect (r1);
2818 ASSERT_EQ (r0, frange_float ("15", "20"));
2820 // [10,20] ^ [21,25] = []
2821 r0 = frange_float ("10", "20");
2822 r0.clear_nan ();
2823 r1 = frange_float ("21", "25");
2824 r1.clear_nan ();
2825 r0.intersect (r1);
2826 ASSERT_TRUE (r0.undefined_p ());
2828 if (HONOR_INFINITIES (float_type_node))
2830 // Make sure [-Inf, -Inf] doesn't get normalized.
2831 r0 = frange_float ("-Inf", "-Inf");
2832 ASSERT_TRUE (real_isinf (&r0.lower_bound (), true));
2833 ASSERT_TRUE (real_isinf (&r0.upper_bound (), true));
2836 // Test that reading back a global range yields the same result as
2837 // what we wrote into it.
2838 tree ssa = make_temp_ssa_name (float_type_node, NULL, "blah");
2839 r0.set_varying (float_type_node);
2840 r0.clear_nan ();
2841 set_range_info (ssa, r0);
2842 get_global_range_query ()->range_of_expr (r1, ssa);
2843 ASSERT_EQ (r0, r1);
2846 // Run floating range tests for various combinations of NAN and INF
2847 // support.
2849 static void
2850 range_tests_floats_various ()
2852 int save_finite_math_only = flag_finite_math_only;
2854 // Test -ffinite-math-only.
2855 flag_finite_math_only = 1;
2856 range_tests_floats ();
2857 // Test -fno-finite-math-only.
2858 flag_finite_math_only = 0;
2859 range_tests_floats ();
2861 flag_finite_math_only = save_finite_math_only;
2864 void
2865 range_tests ()
2867 range_tests_irange3 ();
2868 range_tests_int_range_max ();
2869 range_tests_strict_enum ();
2870 range_tests_nonzero_bits ();
2871 range_tests_floats_various ();
2872 range_tests_misc ();
2875 } // namespace selftest
2877 #endif // CHECKING_P