1 /* Support routines for value ranges with equivalences.
2    Copyright (C) 2020-2021 Free Software Foundation, Inc.
3 
4 This file is part of GCC.
5 
6 GCC is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3, or (at your option)
9 any later version.
10 
11 GCC is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3.  If not see
18 <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef GCC_VALUE_RANGE_EQUIV_H
21 #define GCC_VALUE_RANGE_EQUIV_H
22 
23 #include "value-range.h"
24 
25 /* Note value_range_equiv cannot currently be used with GC memory,
26    only value_range is fully set up for this.  */
class(user)27 class GTY((user)) value_range_equiv : public value_range
28 {
29  public:
30   value_range_equiv () : value_range () { m_equiv = NULL; }
31   value_range_equiv (const value_range &);
32   /* Deep-copies equiv bitmap argument.  */
33   value_range_equiv (tree, tree, bitmap = NULL, value_range_kind = VR_RANGE);
34 
35   /* Shallow-copies equiv bitmap.  */
36   value_range_equiv (const value_range_equiv &) /* = delete */;
37   /* Shallow-copies equiv bitmap.  */
38   value_range_equiv& operator=(const value_range_equiv &) /* = delete */;
39 
40   /* Move equiv bitmap from source range.  */
41   void move (value_range_equiv *);
42 
43   /* Leaves equiv bitmap alone.  */
44   void update (tree, tree, value_range_kind = VR_RANGE);
45   /* Deep-copies equiv bitmap argument.  */
46   void set (tree, tree, bitmap = NULL, value_range_kind = VR_RANGE);
47   void set (tree);
48 
49   bool operator== (const value_range_equiv &) const /* = delete */;
50   bool operator!= (const value_range_equiv &) const /* = delete */;
51   void intersect (const value_range_equiv *);
52   void union_ (const value_range_equiv *);
53   bool equal_p (const value_range_equiv &, bool ignore_equivs) const;
54 
55   /* Types of value ranges.  */
56   void set_undefined ();
57   void set_varying (tree);
58 
59   /* Equivalence bitmap methods.  */
60   bitmap equiv () const { return m_equiv; }
61   void equiv_clear ();
62   void equiv_add (const_tree, const value_range_equiv *,
63 		  bitmap_obstack * = NULL);
64 
65   /* Misc methods.  */
66   void deep_copy (const value_range_equiv *);
67   void dump (FILE *) const;
68   void dump () const;
69 
70  private:
71   /* Deep-copies bitmap argument.  */
72   void set_equiv (bitmap);
73   void check ();
74 
75   /* Set of SSA names whose value ranges are equivalent to this one.
76      This set is only valid when TYPE is VR_RANGE or VR_ANTI_RANGE.  */
77   bitmap m_equiv;
78 };
79 
80 extern void dump_value_range (FILE *, const value_range_equiv *);
81 
82 #endif // GCC_VALUE_RANGE_EQUIV_H
83