1 /* Support routines for value ranges.
2 Copyright (C) 2019-2023 Free Software Foundation, Inc.
3 Contributed 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)
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 #ifndef GCC_VALUE_RANGE_H
23 #define GCC_VALUE_RANGE_H
27 // Types of value ranges.
32 /* Range spans the entire domain. */
34 /* Range is [MIN, MAX]. */
36 /* Range is ~[MIN, MAX]. */
40 /* Range is a nice guy. */
44 // Discriminator between different vrange types.
46 enum value_range_discriminator
48 // Range holds an integer or pointer.
50 // Floating point range.
52 // Range holds an unsupported type.
56 // Abstract class for ranges of any of the supported types.
58 // To query what types ranger and the entire ecosystem can support,
59 // use Value_Range::supports_type_p(tree type). This is a static
60 // method available independently of any vrange object.
62 // To query what a given vrange variant can support, use:
63 // irange::supports_p ()
64 // frange::supports_p ()
67 // To query what a range object can support, use:
68 // void foo (vrange &v, irange &i, frange &f)
70 // if (v.supports_type_p (type)) ...
71 // if (i.supports_type_p (type)) ...
72 // if (f.supports_type_p (type)) ...
75 class GTY((user
)) vrange
77 template <typename T
> friend bool is_a (vrange
&);
78 friend class Value_Range
;
79 friend void streamer_write_vrange (struct output_block
*, const vrange
&);
80 friend class range_op_handler
;
82 virtual void accept (const class vrange_visitor
&v
) const = 0;
83 virtual void set (tree
, tree
, value_range_kind
= VR_RANGE
);
84 virtual tree
type () const;
85 virtual bool supports_type_p (const_tree type
) const;
86 virtual void set_varying (tree type
);
87 virtual void set_undefined ();
88 virtual bool union_ (const vrange
&);
89 virtual bool intersect (const vrange
&);
90 virtual bool singleton_p (tree
*result
= NULL
) const;
91 virtual bool contains_p (tree cst
) const;
92 virtual bool zero_p () const;
93 virtual bool nonzero_p () const;
94 virtual void set_nonzero (tree type
);
95 virtual void set_zero (tree type
);
96 virtual void set_nonnegative (tree type
);
97 virtual bool fits_p (const vrange
&r
) const;
99 bool varying_p () const;
100 bool undefined_p () const;
101 vrange
& operator= (const vrange
&);
102 bool operator== (const vrange
&) const;
103 bool operator!= (const vrange
&r
) const { return !(*this == r
); }
104 void dump (FILE *) const;
106 vrange (enum value_range_discriminator d
) : m_discriminator (d
) { }
107 ENUM_BITFIELD(value_range_kind
) m_kind
: 8;
108 const ENUM_BITFIELD(value_range_discriminator
) m_discriminator
: 4;
113 extern void add_vrange (const vrange
&, hash
&, unsigned flags
= 0);
116 // A pair of values representing the known bits in a range. Zero bits
117 // in MASK cover constant values. Set bits in MASK cover unknown
118 // values. VALUE are the known bits.
120 // Set bits in MASK (no meaningful information) must have their
121 // corresponding bits in VALUE cleared, as this speeds up union and
127 irange_bitmask () { /* uninitialized */ }
128 irange_bitmask (unsigned prec
) { set_unknown (prec
); }
129 irange_bitmask (const wide_int
&value
, const wide_int
&mask
);
130 wide_int
value () const { return m_value
; }
131 wide_int
mask () const { return m_mask
; }
132 void set_unknown (unsigned prec
);
133 bool unknown_p () const;
134 unsigned get_precision () const;
135 bool union_ (const irange_bitmask
&src
);
136 bool intersect (const irange_bitmask
&src
);
137 bool operator== (const irange_bitmask
&src
) const;
138 bool operator!= (const irange_bitmask
&src
) const { return !(*this == src
); }
139 void verify_mask () const;
140 void dump (FILE *) const;
142 // Convenience functions for nonzero bitmask compatibility.
143 wide_int
get_nonzero_bits () const;
144 void set_nonzero_bits (const wide_int
&bits
);
151 irange_bitmask::set_unknown (unsigned prec
)
153 m_value
= wi::zero (prec
);
154 m_mask
= wi::minus_one (prec
);
159 // Return TRUE if THIS does not have any meaningful information.
162 irange_bitmask::unknown_p () const
168 irange_bitmask::irange_bitmask (const wide_int
&value
, const wide_int
&mask
)
177 irange_bitmask::get_precision () const
179 return m_mask
.get_precision ();
182 // The following two functions are meant for backwards compatability
183 // with the nonzero bitmask. A cleared bit means the value must be 0.
184 // A set bit means we have no information for the bit.
186 // Return the nonzero bits.
188 irange_bitmask::get_nonzero_bits () const
190 return m_value
| m_mask
;
193 // Set the bitmask to the nonzero bits in BITS.
195 irange_bitmask::set_nonzero_bits (const wide_int
&bits
)
197 m_value
= wi::zero (bits
.get_precision ());
204 irange_bitmask::operator== (const irange_bitmask
&src
) const
206 bool unknown1
= unknown_p ();
207 bool unknown2
= src
.unknown_p ();
208 if (unknown1
|| unknown2
)
209 return unknown1
== unknown2
;
210 return m_value
== src
.m_value
&& m_mask
== src
.m_mask
;
214 irange_bitmask::union_ (const irange_bitmask
&orig_src
)
217 irange_bitmask
src (orig_src
.m_value
& ~orig_src
.m_mask
, orig_src
.m_mask
);
220 irange_bitmask
save (*this);
221 m_mask
= (m_mask
| src
.m_mask
) | (m_value
^ src
.m_value
);
222 m_value
= m_value
& src
.m_value
;
225 return *this != save
;
229 irange_bitmask::intersect (const irange_bitmask
&orig_src
)
232 irange_bitmask
src (orig_src
.m_value
& ~orig_src
.m_mask
, orig_src
.m_mask
);
235 irange_bitmask
save (*this);
236 // If we have two known bits that are incompatible, the resulting
237 // bit is undefined. It is unclear whether we should set the entire
238 // range to UNDEFINED, or just a subset of it. For now, set the
239 // entire bitmask to unknown (VARYING).
240 if (wi::bit_and (~(m_mask
| src
.m_mask
),
241 m_value
^ src
.m_value
) != 0)
243 unsigned prec
= m_mask
.get_precision ();
244 m_mask
= wi::minus_one (prec
);
245 m_value
= wi::zero (prec
);
249 m_mask
= m_mask
& src
.m_mask
;
250 m_value
= m_value
| src
.m_value
;
254 return *this != save
;
257 // An integer range without any storage.
259 class GTY((user
)) irange
: public vrange
261 friend value_range_kind
get_legacy_range (const irange
&, tree
&, tree
&);
262 friend class irange_storage
;
263 friend class vrange_printer
;
266 void set (tree type
, const wide_int
&, const wide_int
&,
267 value_range_kind
= VR_RANGE
);
268 virtual void set_nonzero (tree type
) override
;
269 virtual void set_zero (tree type
) override
;
270 virtual void set_nonnegative (tree type
) override
;
271 virtual void set_varying (tree type
) override
;
272 virtual void set_undefined () override
;
275 static bool supports_p (const_tree type
);
276 virtual bool supports_type_p (const_tree type
) const override
;
277 virtual tree
type () const override
;
279 // Iteration over sub-ranges.
280 unsigned num_pairs () const;
281 wide_int
lower_bound (unsigned = 0) const;
282 wide_int
upper_bound (unsigned) const;
283 wide_int
upper_bound () const;
286 virtual bool zero_p () const override
;
287 virtual bool nonzero_p () const override
;
288 virtual bool singleton_p (tree
*result
= NULL
) const override
;
289 bool singleton_p (wide_int
&) const;
290 bool contains_p (const wide_int
&) const;
291 bool nonnegative_p () const;
292 bool nonpositive_p () const;
294 // In-place operators.
295 virtual bool union_ (const vrange
&) override
;
296 virtual bool intersect (const vrange
&) override
;
299 // Operator overloads.
300 irange
& operator= (const irange
&);
301 bool operator== (const irange
&) const;
302 bool operator!= (const irange
&r
) const { return !(*this == r
); }
305 virtual bool fits_p (const vrange
&r
) const override
;
306 virtual void accept (const vrange_visitor
&v
) const override
;
308 void update_bitmask (const irange_bitmask
&);
309 irange_bitmask
get_bitmask () const;
311 wide_int
get_nonzero_bits () const;
312 void set_nonzero_bits (const wide_int
&bits
);
315 void maybe_resize (int needed
);
316 virtual void set (tree
, tree
, value_range_kind
= VR_RANGE
) override
;
317 virtual bool contains_p (tree cst
) const override
;
318 irange (wide_int
*, unsigned nranges
, bool resizable
);
320 // In-place operators.
321 bool irange_contains_p (const irange
&) const;
322 bool irange_single_pair_union (const irange
&r
);
324 void normalize_kind ();
326 void verify_range ();
328 // Hard limit on max ranges allowed.
329 static const int HARD_MAX_RANGES
= 255;
331 friend void gt_ggc_mx (irange
*);
332 friend void gt_pch_nx (irange
*);
333 friend void gt_pch_nx (irange
*, gt_pointer_operator
, void *);
335 bool varying_compatible_p () const;
336 bool intersect_bitmask (const irange
&r
);
337 bool union_bitmask (const irange
&r
);
338 irange_bitmask
get_bitmask_from_range () const;
339 bool set_range_from_bitmask ();
341 bool intersect (const wide_int
& lb
, const wide_int
& ub
);
342 unsigned char m_num_ranges
;
344 unsigned char m_max_ranges
;
346 irange_bitmask m_bitmask
;
351 // Here we describe an irange with N pairs of ranges. The storage for
352 // the pairs is embedded in the class as an array.
354 // If RESIZABLE is true, the storage will be resized on the heap when
355 // the number of ranges needed goes past N up to a max of
356 // HARD_MAX_RANGES. This new storage is freed upon destruction.
358 template<unsigned N
, bool RESIZABLE
= false>
359 class GTY((user
)) int_range
: public irange
363 int_range (tree type
, const wide_int
&, const wide_int
&,
364 value_range_kind
= VR_RANGE
);
365 int_range (tree type
);
366 int_range (const int_range
&);
367 int_range (const irange
&);
368 virtual ~int_range ();
369 int_range
& operator= (const int_range
&);
371 int_range (tree
, tree
, value_range_kind
= VR_RANGE
);
373 wide_int m_ranges
[N
*2];
376 // Unsupported temporaries may be created by ranger before it's known
377 // they're unsupported, or by vr_values::get_value_range.
379 class unsupported_range
: public vrange
383 : vrange (VR_UNKNOWN
)
387 virtual void set_undefined () final override
389 m_kind
= VR_UNDEFINED
;
391 virtual void accept (const vrange_visitor
&v
) const override
;
394 // The NAN state as an opaque object.
400 nan_state (bool pos_nan
, bool neg_nan
);
408 // Set NAN state to +-NAN if NAN_P is true. Otherwise set NAN state
412 nan_state::nan_state (bool nan_p
)
418 // Constructor initializing the object to +NAN if POS_NAN is set, -NAN
419 // if NEG_NAN is set, or +-NAN if both are set. Otherwise POS_NAN and
420 // NEG_NAN are clear, and the object cannot be a NAN.
423 nan_state::nan_state (bool pos_nan
, bool neg_nan
)
429 // Return if +NAN is possible.
432 nan_state::pos_p () const
437 // Return if -NAN is possible.
440 nan_state::neg_p () const
445 // A floating point range.
447 // The representation is a type with a couple of endpoints, unioned
448 // with the set of { -NAN, +Nan }.
450 class GTY((user
)) frange
: public vrange
452 friend class frange_storage
;
453 friend class vrange_printer
;
454 friend void gt_ggc_mx (frange
*);
455 friend void gt_pch_nx (frange
*);
456 friend void gt_pch_nx (frange
*, gt_pointer_operator
, void *);
459 frange (const frange
&);
460 frange (tree
, tree
, value_range_kind
= VR_RANGE
);
462 frange (tree type
, const REAL_VALUE_TYPE
&min
, const REAL_VALUE_TYPE
&max
,
463 value_range_kind
= VR_RANGE
);
464 static bool supports_p (const_tree type
)
466 // ?? Decimal floats can have multiple representations for the
467 // same number. Supporting them may be as simple as just
468 // disabling them in singleton_p. No clue.
469 return SCALAR_FLOAT_TYPE_P (type
) && !DECIMAL_FLOAT_TYPE_P (type
);
471 virtual tree
type () const override
;
472 void set (tree type
, const REAL_VALUE_TYPE
&, const REAL_VALUE_TYPE
&,
473 value_range_kind
= VR_RANGE
);
474 void set (tree type
, const REAL_VALUE_TYPE
&, const REAL_VALUE_TYPE
&,
475 const nan_state
&, value_range_kind
= VR_RANGE
);
476 void set_nan (tree type
);
477 void set_nan (tree type
, bool sign
);
478 void set_nan (tree type
, const nan_state
&);
479 virtual void set_varying (tree type
) override
;
480 virtual void set_undefined () override
;
481 virtual bool union_ (const vrange
&) override
;
482 virtual bool intersect (const vrange
&) override
;
483 bool contains_p (const REAL_VALUE_TYPE
&) const;
484 virtual bool singleton_p (tree
*result
= NULL
) const override
;
485 bool singleton_p (REAL_VALUE_TYPE
&r
) const;
486 virtual bool supports_type_p (const_tree type
) const override
;
487 virtual void accept (const vrange_visitor
&v
) const override
;
488 virtual bool zero_p () const override
;
489 virtual bool nonzero_p () const override
;
490 virtual void set_nonzero (tree type
) override
;
491 virtual void set_zero (tree type
) override
;
492 virtual void set_nonnegative (tree type
) override
;
493 frange
& operator= (const frange
&);
494 bool operator== (const frange
&) const;
495 bool operator!= (const frange
&r
) const { return !(*this == r
); }
496 const REAL_VALUE_TYPE
&lower_bound () const;
497 const REAL_VALUE_TYPE
&upper_bound () const;
498 nan_state
get_nan_state () const;
500 void update_nan (bool sign
);
501 void update_nan (tree
) = delete; // Disallow silent conversion to bool.
502 void update_nan (const nan_state
&);
504 void flush_denormals_to_zero ();
506 // fpclassify like API
507 bool known_isfinite () const;
508 bool known_isnan () const;
509 bool known_isinf () const;
510 bool maybe_isnan () const;
511 bool maybe_isnan (bool sign
) const;
512 bool maybe_isinf () const;
513 bool signbit_p (bool &signbit
) const;
514 bool nan_signbit_p (bool &signbit
) const;
517 virtual bool contains_p (tree cst
) const override
;
518 virtual void set (tree
, tree
, value_range_kind
= VR_RANGE
) override
;
521 bool internal_singleton_p (REAL_VALUE_TYPE
* = NULL
) const;
522 void verify_range ();
523 bool normalize_kind ();
524 bool union_nans (const frange
&);
525 bool intersect_nans (const frange
&);
526 bool combine_zeros (const frange
&, bool union_p
);
529 REAL_VALUE_TYPE m_min
;
530 REAL_VALUE_TYPE m_max
;
535 inline const REAL_VALUE_TYPE
&
536 frange::lower_bound () const
538 gcc_checking_assert (!undefined_p () && !known_isnan ());
542 inline const REAL_VALUE_TYPE
&
543 frange::upper_bound () const
545 gcc_checking_assert (!undefined_p () && !known_isnan ());
549 // Return the NAN state.
552 frange::get_nan_state () const
554 return nan_state (m_pos_nan
, m_neg_nan
);
557 // is_a<> and as_a<> implementation for vrange.
559 // Anything we haven't specialized is a hard fail.
560 template <typename T
>
568 template <typename T
>
570 is_a (const vrange
&v
)
572 // Reuse is_a <vrange> to implement the const version.
573 const T
&derived
= static_cast<const T
&> (v
);
574 return is_a
<T
> (const_cast<T
&> (derived
));
577 template <typename T
>
581 gcc_checking_assert (is_a
<T
> (v
));
582 return static_cast <T
&> (v
);
585 template <typename T
>
587 as_a (const vrange
&v
)
589 gcc_checking_assert (is_a
<T
> (v
));
590 return static_cast <const T
&> (v
);
593 // Specializations for the different range types.
597 is_a
<irange
> (vrange
&v
)
599 return v
.m_discriminator
== VR_IRANGE
;
604 is_a
<frange
> (vrange
&v
)
606 return v
.m_discriminator
== VR_FRANGE
;
611 is_a
<unsupported_range
> (vrange
&v
)
613 return v
.m_discriminator
== VR_UNKNOWN
;
616 // For resizable ranges, resize the range up to HARD_MAX_RANGES if the
617 // NEEDED pairs is greater than the current capacity of the range.
620 irange::maybe_resize (int needed
)
622 if (!m_resizable
|| m_max_ranges
== HARD_MAX_RANGES
)
625 if (needed
> m_max_ranges
)
627 m_max_ranges
= HARD_MAX_RANGES
;
628 wide_int
*newmem
= new wide_int
[m_max_ranges
* 2];
629 unsigned n
= num_pairs () * 2;
630 for (unsigned i
= 0; i
< n
; ++i
)
631 newmem
[i
] = m_base
[i
];
636 template<unsigned N
, bool RESIZABLE
>
638 int_range
<N
, RESIZABLE
>::~int_range ()
640 if (RESIZABLE
&& m_base
!= m_ranges
)
644 // This is an "infinite" precision irange for use in temporary
645 // calculations. It starts with a sensible default covering 99% of
646 // uses, and goes up to HARD_MAX_RANGES when needed. Any allocated
647 // storage is freed upon destruction.
648 typedef int_range
<3, /*RESIZABLE=*/true> int_range_max
;
653 virtual void visit (const irange
&) const { }
654 virtual void visit (const frange
&) const { }
655 virtual void visit (const unsupported_range
&) const { }
658 typedef int_range
<2> value_range
;
660 // This is an "infinite" precision range object for use in temporary
661 // calculations for any of the handled types. The object can be
662 // transparently used as a vrange.
668 Value_Range (const vrange
&r
);
669 Value_Range (tree type
);
670 Value_Range (tree
, tree
, value_range_kind kind
= VR_RANGE
);
671 Value_Range (const Value_Range
&);
672 void set_type (tree type
);
673 vrange
& operator= (const vrange
&);
674 Value_Range
& operator= (const Value_Range
&);
675 bool operator== (const Value_Range
&r
) const;
676 bool operator!= (const Value_Range
&r
) const;
678 operator const vrange
&() const;
679 void dump (FILE *) const;
680 static bool supports_type_p (const_tree type
);
682 // Convenience methods for vrange compatibility.
683 tree
type () { return m_vrange
->type (); }
684 bool varying_p () const { return m_vrange
->varying_p (); }
685 bool undefined_p () const { return m_vrange
->undefined_p (); }
686 void set_varying (tree type
) { init (type
); m_vrange
->set_varying (type
); }
687 void set_undefined () { m_vrange
->set_undefined (); }
688 bool union_ (const vrange
&r
) { return m_vrange
->union_ (r
); }
689 bool intersect (const vrange
&r
) { return m_vrange
->intersect (r
); }
690 bool contains_p (tree cst
) const { return m_vrange
->contains_p (cst
); }
691 bool singleton_p (tree
*result
= NULL
) const
692 { return m_vrange
->singleton_p (result
); }
693 void set_zero (tree type
) { init (type
); return m_vrange
->set_zero (type
); }
694 void set_nonzero (tree type
)
695 { init (type
); return m_vrange
->set_nonzero (type
); }
696 bool nonzero_p () const { return m_vrange
->nonzero_p (); }
697 bool zero_p () const { return m_vrange
->zero_p (); }
698 wide_int
lower_bound () const; // For irange/prange comparability.
699 wide_int
upper_bound () const; // For irange/prange comparability.
700 void accept (const vrange_visitor
&v
) const { m_vrange
->accept (v
); }
702 void init (tree type
);
703 unsupported_range m_unsupported
;
705 int_range_max m_irange
;
710 Value_Range::Value_Range ()
712 m_vrange
= &m_unsupported
;
715 // Copy constructor from a vrange.
718 Value_Range::Value_Range (const vrange
&r
)
723 // Copy constructor from a TYPE. The range of the temporary is set to
727 Value_Range::Value_Range (tree type
)
733 Value_Range::Value_Range (tree min
, tree max
, value_range_kind kind
)
735 init (TREE_TYPE (min
));
736 m_vrange
->set (min
, max
, kind
);
740 Value_Range::Value_Range (const Value_Range
&r
)
745 // Initialize object so it is possible to store temporaries of TYPE
749 Value_Range::init (tree type
)
751 gcc_checking_assert (TYPE_P (type
));
753 if (irange::supports_p (type
))
754 m_vrange
= &m_irange
;
755 else if (frange::supports_p (type
))
756 m_vrange
= &m_frange
;
758 m_vrange
= &m_unsupported
;
761 // Set the temporary to allow storing temporaries of TYPE. The range
762 // of the temporary is set to UNDEFINED.
765 Value_Range::set_type (tree type
)
768 m_vrange
->set_undefined ();
771 // Assignment operator for temporaries. Copying incompatible types is
775 Value_Range::operator= (const vrange
&r
)
777 if (is_a
<irange
> (r
))
779 m_irange
= as_a
<irange
> (r
);
780 m_vrange
= &m_irange
;
782 else if (is_a
<frange
> (r
))
784 m_frange
= as_a
<frange
> (r
);
785 m_vrange
= &m_frange
;
787 else if (is_a
<unsupported_range
> (r
))
789 m_unsupported
= as_a
<unsupported_range
> (r
);
790 m_vrange
= &m_unsupported
;
799 Value_Range::operator= (const Value_Range
&r
)
801 if (r
.m_vrange
== &r
.m_irange
)
803 m_irange
= r
.m_irange
;
804 m_vrange
= &m_irange
;
806 else if (r
.m_vrange
== &r
.m_frange
)
808 m_frange
= r
.m_frange
;
809 m_vrange
= &m_frange
;
811 else if (r
.m_vrange
== &r
.m_unsupported
)
813 m_unsupported
= r
.m_unsupported
;
814 m_vrange
= &m_unsupported
;
823 Value_Range::operator== (const Value_Range
&r
) const
825 return *m_vrange
== *r
.m_vrange
;
829 Value_Range::operator!= (const Value_Range
&r
) const
831 return *m_vrange
!= *r
.m_vrange
;
835 Value_Range::operator vrange
&()
841 Value_Range::operator const vrange
&() const
846 // Return TRUE if TYPE is supported by the vrange infrastructure.
849 Value_Range::supports_type_p (const_tree type
)
851 return irange::supports_p (type
) || frange::supports_p (type
);
854 extern value_range_kind
get_legacy_range (const irange
&, tree
&min
, tree
&max
);
855 extern void dump_value_range (FILE *, const vrange
*);
856 extern bool vrp_operand_equal_p (const_tree
, const_tree
);
857 inline REAL_VALUE_TYPE
frange_val_min (const_tree type
);
858 inline REAL_VALUE_TYPE
frange_val_max (const_tree type
);
860 // Number of sub-ranges in a range.
863 irange::num_pairs () const
869 irange::type () const
871 gcc_checking_assert (m_num_ranges
> 0);
876 irange::varying_compatible_p () const
878 if (m_num_ranges
!= 1)
881 const wide_int
&l
= m_base
[0];
882 const wide_int
&u
= m_base
[1];
885 if (m_kind
== VR_VARYING
&& t
== error_mark_node
)
888 unsigned prec
= TYPE_PRECISION (t
);
889 signop sign
= TYPE_SIGN (t
);
890 if (INTEGRAL_TYPE_P (t
) || POINTER_TYPE_P (t
))
891 return (l
== wi::min_value (prec
, sign
)
892 && u
== wi::max_value (prec
, sign
)
893 && m_bitmask
.unknown_p ());
898 vrange::varying_p () const
900 return m_kind
== VR_VARYING
;
904 vrange::undefined_p () const
906 return m_kind
== VR_UNDEFINED
;
910 irange::zero_p () const
912 return (m_kind
== VR_RANGE
&& m_num_ranges
== 1
913 && lower_bound (0) == 0
914 && upper_bound (0) == 0);
918 irange::nonzero_p () const
923 wide_int zero
= wi::zero (TYPE_PRECISION (type ()));
924 return *this == int_range
<2> (type (), zero
, zero
, VR_ANTI_RANGE
);
928 irange::supports_p (const_tree type
)
930 return INTEGRAL_TYPE_P (type
) || POINTER_TYPE_P (type
);
934 irange::contains_p (tree cst
) const
936 return contains_p (wi::to_wide (cst
));
940 range_includes_zero_p (const irange
*vr
)
942 if (vr
->undefined_p ())
945 if (vr
->varying_p ())
948 wide_int zero
= wi::zero (TYPE_PRECISION (vr
->type ()));
949 return vr
->contains_p (zero
);
952 extern void gt_ggc_mx (vrange
*);
953 extern void gt_pch_nx (vrange
*);
954 extern void gt_pch_nx (vrange
*, gt_pointer_operator
, void *);
955 extern void gt_ggc_mx (irange
*);
956 extern void gt_pch_nx (irange
*);
957 extern void gt_pch_nx (irange
*, gt_pointer_operator
, void *);
958 extern void gt_ggc_mx (frange
*);
959 extern void gt_pch_nx (frange
*);
960 extern void gt_pch_nx (frange
*, gt_pointer_operator
, void *);
964 gt_ggc_mx (int_range
<N
> *x
)
966 gt_ggc_mx ((irange
*) x
);
971 gt_pch_nx (int_range
<N
> *x
)
973 gt_pch_nx ((irange
*) x
);
978 gt_pch_nx (int_range
<N
> *x
, gt_pointer_operator op
, void *cookie
)
980 gt_pch_nx ((irange
*) x
, op
, cookie
);
983 // Constructors for irange
986 irange::irange (wide_int
*base
, unsigned nranges
, bool resizable
)
987 : vrange (VR_IRANGE
),
988 m_resizable (resizable
),
989 m_max_ranges (nranges
)
995 // Constructors for int_range<>.
997 template<unsigned N
, bool RESIZABLE
>
999 int_range
<N
, RESIZABLE
>::int_range ()
1000 : irange (m_ranges
, N
, RESIZABLE
)
1004 template<unsigned N
, bool RESIZABLE
>
1005 int_range
<N
, RESIZABLE
>::int_range (const int_range
&other
)
1006 : irange (m_ranges
, N
, RESIZABLE
)
1008 irange::operator= (other
);
1011 template<unsigned N
, bool RESIZABLE
>
1012 int_range
<N
, RESIZABLE
>::int_range (tree min
, tree max
, value_range_kind kind
)
1013 : irange (m_ranges
, N
, RESIZABLE
)
1015 irange::set (min
, max
, kind
);
1018 template<unsigned N
, bool RESIZABLE
>
1019 int_range
<N
, RESIZABLE
>::int_range (tree type
)
1020 : irange (m_ranges
, N
, RESIZABLE
)
1025 template<unsigned N
, bool RESIZABLE
>
1026 int_range
<N
, RESIZABLE
>::int_range (tree type
, const wide_int
&wmin
, const wide_int
&wmax
,
1027 value_range_kind kind
)
1028 : irange (m_ranges
, N
, RESIZABLE
)
1030 set (type
, wmin
, wmax
, kind
);
1033 template<unsigned N
, bool RESIZABLE
>
1034 int_range
<N
, RESIZABLE
>::int_range (const irange
&other
)
1035 : irange (m_ranges
, N
, RESIZABLE
)
1037 irange::operator= (other
);
1040 template<unsigned N
, bool RESIZABLE
>
1041 int_range
<N
, RESIZABLE
>&
1042 int_range
<N
, RESIZABLE
>::operator= (const int_range
&src
)
1044 irange::operator= (src
);
1049 irange::set_undefined ()
1051 m_kind
= VR_UNDEFINED
;
1056 irange::set_varying (tree type
)
1058 m_kind
= VR_VARYING
;
1060 m_bitmask
.set_unknown (TYPE_PRECISION (type
));
1062 if (INTEGRAL_TYPE_P (type
) || POINTER_TYPE_P (type
))
1065 // Strict enum's require varying to be not TYPE_MIN/MAX, but rather
1066 // min_value and max_value.
1067 m_base
[0] = wi::min_value (TYPE_PRECISION (type
), TYPE_SIGN (type
));
1068 m_base
[1] = wi::max_value (TYPE_PRECISION (type
), TYPE_SIGN (type
));
1071 m_type
= error_mark_node
;
1074 // Return the lower bound of a sub-range. PAIR is the sub-range in
1078 irange::lower_bound (unsigned pair
) const
1080 gcc_checking_assert (m_num_ranges
> 0);
1081 gcc_checking_assert (pair
+ 1 <= num_pairs ());
1082 return m_base
[pair
* 2];
1085 // Return the upper bound of a sub-range. PAIR is the sub-range in
1089 irange::upper_bound (unsigned pair
) const
1091 gcc_checking_assert (m_num_ranges
> 0);
1092 gcc_checking_assert (pair
+ 1 <= num_pairs ());
1093 return m_base
[pair
* 2 + 1];
1096 // Return the highest bound of a range.
1099 irange::upper_bound () const
1101 unsigned pairs
= num_pairs ();
1102 gcc_checking_assert (pairs
> 0);
1103 return upper_bound (pairs
- 1);
1106 // Set value range VR to a nonzero range of type TYPE.
1109 irange::set_nonzero (tree type
)
1111 unsigned prec
= TYPE_PRECISION (type
);
1113 if (TYPE_UNSIGNED (type
))
1117 m_base
[0] = wi::one (prec
);
1118 m_base
[1] = wi::minus_one (prec
);
1119 m_bitmask
.set_unknown (prec
);
1127 wide_int zero
= wi::zero (prec
);
1128 set (type
, zero
, zero
, VR_ANTI_RANGE
);
1132 // Set value range VR to a ZERO range of type TYPE.
1135 irange::set_zero (tree type
)
1137 wide_int zero
= wi::zero (TYPE_PRECISION (type
));
1138 set (type
, zero
, zero
);
1141 // Normalize a range to VARYING or UNDEFINED if possible.
1144 irange::normalize_kind ()
1146 if (m_num_ranges
== 0)
1148 else if (varying_compatible_p ())
1150 if (m_kind
== VR_RANGE
)
1151 m_kind
= VR_VARYING
;
1152 else if (m_kind
== VR_ANTI_RANGE
)
1160 contains_zero_p (const irange
&r
)
1162 if (r
.undefined_p ())
1165 wide_int zero
= wi::zero (TYPE_PRECISION (r
.type ()));
1166 return r
.contains_p (zero
);
1170 irange_val_min (const_tree type
)
1172 gcc_checking_assert (irange::supports_p (type
));
1173 return wi::min_value (TYPE_PRECISION (type
), TYPE_SIGN (type
));
1177 irange_val_max (const_tree type
)
1179 gcc_checking_assert (irange::supports_p (type
));
1180 return wi::max_value (TYPE_PRECISION (type
), TYPE_SIGN (type
));
1185 : vrange (VR_FRANGE
)
1191 frange::frange (const frange
&src
)
1192 : vrange (VR_FRANGE
)
1198 frange::frange (tree type
)
1199 : vrange (VR_FRANGE
)
1204 // frange constructor from REAL_VALUE_TYPE endpoints.
1207 frange::frange (tree type
,
1208 const REAL_VALUE_TYPE
&min
, const REAL_VALUE_TYPE
&max
,
1209 value_range_kind kind
)
1210 : vrange (VR_FRANGE
)
1212 set (type
, min
, max
, kind
);
1215 // frange constructor from trees.
1218 frange::frange (tree min
, tree max
, value_range_kind kind
)
1219 : vrange (VR_FRANGE
)
1221 set (min
, max
, kind
);
1225 frange::type () const
1227 gcc_checking_assert (!undefined_p ());
1232 frange::set_varying (tree type
)
1234 m_kind
= VR_VARYING
;
1236 m_min
= frange_val_min (type
);
1237 m_max
= frange_val_max (type
);
1238 if (HONOR_NANS (m_type
))
1251 frange::set_undefined ()
1253 m_kind
= VR_UNDEFINED
;
1257 // m_min and m_min are uninitialized as they are REAL_VALUE_TYPE ??.
1262 // Set the NAN bits to NAN and adjust the range.
1265 frange::update_nan (const nan_state
&nan
)
1267 gcc_checking_assert (!undefined_p ());
1268 if (HONOR_NANS (m_type
))
1270 m_pos_nan
= nan
.pos_p ();
1271 m_neg_nan
= nan
.neg_p ();
1278 // Set the NAN bit to +-NAN.
1281 frange::update_nan ()
1283 gcc_checking_assert (!undefined_p ());
1284 nan_state
nan (true);
1288 // Like above, but set the sign of the NAN.
1291 frange::update_nan (bool sign
)
1293 gcc_checking_assert (!undefined_p ());
1294 nan_state
nan (/*pos=*/!sign
, /*neg=*/sign
);
1299 frange::contains_p (tree cst
) const
1301 return contains_p (*TREE_REAL_CST_PTR (cst
));
1304 // Clear the NAN bit and adjust the range.
1307 frange::clear_nan ()
1309 gcc_checking_assert (!undefined_p ());
1317 // Set R to maximum representable value for TYPE.
1319 inline REAL_VALUE_TYPE
1320 real_max_representable (const_tree type
)
1324 get_max_float (REAL_MODE_FORMAT (TYPE_MODE (type
)),
1325 buf
, sizeof (buf
), false);
1326 int res
= real_from_string (&r
, buf
);
1327 gcc_checking_assert (!res
);
1331 // Return the minimum representable value for TYPE.
1333 inline REAL_VALUE_TYPE
1334 real_min_representable (const_tree type
)
1336 REAL_VALUE_TYPE r
= real_max_representable (type
);
1337 r
= real_value_negate (&r
);
1341 // Return the minimum value for TYPE.
1343 inline REAL_VALUE_TYPE
1344 frange_val_min (const_tree type
)
1346 if (HONOR_INFINITIES (type
))
1349 return real_min_representable (type
);
1352 // Return the maximum value for TYPE.
1354 inline REAL_VALUE_TYPE
1355 frange_val_max (const_tree type
)
1357 if (HONOR_INFINITIES (type
))
1360 return real_max_representable (type
);
1363 // Return TRUE if R is the minimum value for TYPE.
1366 frange_val_is_min (const REAL_VALUE_TYPE
&r
, const_tree type
)
1368 REAL_VALUE_TYPE min
= frange_val_min (type
);
1369 return real_identical (&min
, &r
);
1372 // Return TRUE if R is the max value for TYPE.
1375 frange_val_is_max (const REAL_VALUE_TYPE
&r
, const_tree type
)
1377 REAL_VALUE_TYPE max
= frange_val_max (type
);
1378 return real_identical (&max
, &r
);
1381 // Build a NAN with a state of NAN.
1384 frange::set_nan (tree type
, const nan_state
&nan
)
1386 gcc_checking_assert (nan
.pos_p () || nan
.neg_p ());
1387 if (HONOR_NANS (type
))
1391 m_neg_nan
= nan
.neg_p ();
1392 m_pos_nan
= nan
.pos_p ();
1400 // Build a signless NAN of type TYPE.
1403 frange::set_nan (tree type
)
1405 nan_state
nan (true);
1406 set_nan (type
, nan
);
1409 // Build a NAN of type TYPE with SIGN.
1412 frange::set_nan (tree type
, bool sign
)
1414 nan_state
nan (/*pos=*/!sign
, /*neg=*/sign
);
1415 set_nan (type
, nan
);
1418 // Return TRUE if range is known to be finite.
1421 frange::known_isfinite () const
1423 if (undefined_p () || varying_p () || m_kind
== VR_ANTI_RANGE
)
1425 return (!maybe_isnan () && !real_isinf (&m_min
) && !real_isinf (&m_max
));
1428 // Return TRUE if range may be infinite.
1431 frange::maybe_isinf () const
1433 if (undefined_p () || m_kind
== VR_ANTI_RANGE
|| m_kind
== VR_NAN
)
1437 return real_isinf (&m_min
) || real_isinf (&m_max
);
1440 // Return TRUE if range is known to be the [-INF,-INF] or [+INF,+INF].
1443 frange::known_isinf () const
1445 return (m_kind
== VR_RANGE
1447 && real_identical (&m_min
, &m_max
)
1448 && real_isinf (&m_min
));
1451 // Return TRUE if range is possibly a NAN.
1454 frange::maybe_isnan () const
1458 return m_pos_nan
|| m_neg_nan
;
1461 // Return TRUE if range is possibly a NAN with SIGN.
1464 frange::maybe_isnan (bool sign
) const
1473 // Return TRUE if range is a +NAN or -NAN.
1476 frange::known_isnan () const
1478 return m_kind
== VR_NAN
;
1481 // If the signbit for the range is known, set it in SIGNBIT and return
1485 frange::signbit_p (bool &signbit
) const
1490 // NAN with unknown sign.
1491 if (m_pos_nan
&& m_neg_nan
)
1494 if (!m_pos_nan
&& !m_neg_nan
)
1496 if (m_min
.sign
== m_max
.sign
)
1498 signbit
= m_min
.sign
;
1503 // NAN with known sign.
1504 bool nan_sign
= m_neg_nan
;
1506 || (nan_sign
== m_min
.sign
&& nan_sign
== m_max
.sign
))
1514 // If range has a NAN with a known sign, set it in SIGNBIT and return
1518 frange::nan_signbit_p (bool &signbit
) const
1523 if (m_pos_nan
== m_neg_nan
)
1526 signbit
= m_neg_nan
;
1530 void frange_nextafter (enum machine_mode
, REAL_VALUE_TYPE
&,
1531 const REAL_VALUE_TYPE
&);
1532 void frange_arithmetic (enum tree_code
, tree
, REAL_VALUE_TYPE
&,
1533 const REAL_VALUE_TYPE
&, const REAL_VALUE_TYPE
&,
1534 const REAL_VALUE_TYPE
&);
1536 #endif // GCC_VALUE_RANGE_H