[RS6000] Don't put large integer constants in TOC for -mcmodel=medium
[official-gcc.git] / gcc / tree-vrp.h
blob348fa4f0e7bc67ca252ac0163a70cb8a07d56391
1 /* Support routines for Value Range Propagation (VRP).
2 Copyright (C) 2016-2018 Free Software Foundation, Inc.
4 This file is part of GCC.
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.
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.
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/>. */
20 #ifndef GCC_TREE_VRP_H
21 #define GCC_TREE_VRP_H
23 /* Types of value ranges. */
24 enum value_range_kind
26 /* Empty range. */
27 VR_UNDEFINED,
28 /* Range spans the entire domain. */
29 VR_VARYING,
30 /* Range is [MIN, MAX]. */
31 VR_RANGE,
32 /* Range is ~[MIN, MAX]. */
33 VR_ANTI_RANGE,
34 /* Range is a nice guy. */
35 VR_LAST
39 /* Range of values that can be associated with an SSA_NAME after VRP
40 has executed. */
41 class GTY((for_user)) value_range_base
43 public:
44 value_range_base ();
45 value_range_base (value_range_kind, tree, tree);
47 void set (value_range_kind, tree, tree);
48 void set (tree);
49 void set_nonnull (tree);
50 void set_null (tree);
52 enum value_range_kind kind () const;
53 tree min () const;
54 tree max () const;
56 /* Types of value ranges. */
57 bool symbolic_p () const;
58 bool constant_p () const;
59 bool undefined_p () const;
60 bool varying_p () const;
61 void set_varying ();
62 void set_undefined ();
64 void union_ (const value_range_base *);
66 bool ignore_equivs_equal_p (const value_range_base &) const;
68 /* Misc methods. */
69 tree type () const;
70 bool may_contain_p (tree) const;
71 void set_and_canonicalize (enum value_range_kind, tree, tree);
72 bool zero_p () const;
73 bool singleton_p (tree *result = NULL) const;
75 void dump (FILE *) const;
76 void dump () const;
78 protected:
79 void check ();
80 static value_range_base union_helper (const value_range_base *,
81 const value_range_base *);
83 enum value_range_kind m_kind;
85 tree m_min;
86 tree m_max;
88 friend void gt_ggc_mx_value_range_base (void *);
89 friend void gt_pch_p_16value_range_base (void *, void *,
90 gt_pointer_operator, void *);
91 friend void gt_pch_nx_value_range_base (void *);
92 friend void gt_ggc_mx (value_range_base &);
93 friend void gt_ggc_mx (value_range_base *&);
94 friend void gt_pch_nx (value_range_base &);
95 friend void gt_pch_nx (value_range_base *, gt_pointer_operator, void *);
98 /* Note value_range cannot currently be used with GC memory, only
99 value_range_base is fully set up for this. */
100 class GTY((user)) value_range : public value_range_base
102 public:
103 value_range ();
104 value_range (const value_range_base &);
105 /* Deep-copies equiv bitmap argument. */
106 value_range (value_range_kind, tree, tree, bitmap = NULL);
108 /* Shallow-copies equiv bitmap. */
109 value_range (const value_range &) /* = delete */;
110 /* Shallow-copies equiv bitmap. */
111 value_range& operator=(const value_range&) /* = delete */;
113 /* Move equiv bitmap from source range. */
114 void move (value_range *);
116 /* Leaves equiv bitmap alone. */
117 void update (value_range_kind, tree, tree);
118 /* Deep-copies equiv bitmap argument. */
119 void set (value_range_kind, tree, tree, bitmap = NULL);
120 void set (tree);
121 void set_nonnull (tree);
122 void set_null (tree);
124 bool operator== (const value_range &) const;
125 bool operator!= (const value_range &) const;
126 void intersect (const value_range *);
127 void union_ (const value_range *);
129 /* Types of value ranges. */
130 void set_undefined ();
131 void set_varying ();
133 /* Equivalence bitmap methods. */
134 bitmap equiv () const;
135 void equiv_clear ();
136 void equiv_add (const_tree, const value_range *, bitmap_obstack * = NULL);
138 /* Misc methods. */
139 void deep_copy (const value_range *);
140 void set_and_canonicalize (enum value_range_kind, tree, tree, bitmap = NULL);
141 void dump (FILE *) const;
142 void dump () const;
144 private:
145 /* Deep-copies bitmap argument. */
146 void set_equiv (bitmap);
147 void check ();
148 bool equal_p (const value_range &, bool ignore_equivs) const;
149 void intersect_helper (value_range *, const value_range *);
151 /* Set of SSA names whose value ranges are equivalent to this one.
152 This set is only valid when TYPE is VR_RANGE or VR_ANTI_RANGE. */
153 bitmap m_equiv;
156 inline
157 value_range_base::value_range_base ()
159 m_kind = VR_UNDEFINED;
160 m_min = m_max = NULL;
163 inline
164 value_range::value_range ()
165 : value_range_base ()
167 m_equiv = NULL;
170 /* Return the kind of this range. */
172 inline value_range_kind
173 value_range_base::kind () const
175 return m_kind;
178 inline bitmap
179 value_range::equiv () const
181 return m_equiv;
184 /* Return the lower bound. */
186 inline tree
187 value_range_base::min () const
189 return m_min;
192 /* Return the upper bound. */
194 inline tree
195 value_range_base::max () const
197 return m_max;
200 /* Return TRUE if range spans the entire possible domain. */
202 inline bool
203 value_range_base::varying_p () const
205 return m_kind == VR_VARYING;
208 /* Return TRUE if range is undefined (essentially the empty set). */
210 inline bool
211 value_range_base::undefined_p () const
213 return m_kind == VR_UNDEFINED;
216 /* Return TRUE if range is the constant zero. */
218 inline bool
219 value_range_base::zero_p () const
221 return (m_kind == VR_RANGE
222 && integer_zerop (m_min)
223 && integer_zerop (m_max));
226 extern void dump_value_range (FILE *, const value_range *);
227 extern void dump_value_range (FILE *, const value_range_base *);
229 struct assert_info
231 /* Predicate code for the ASSERT_EXPR. Must be COMPARISON_CLASS_P. */
232 enum tree_code comp_code;
234 /* Name to register the assert for. */
235 tree name;
237 /* Value being compared against. */
238 tree val;
240 /* Expression to compare. */
241 tree expr;
244 extern void register_edge_assert_for (tree, edge, enum tree_code,
245 tree, tree, vec<assert_info> &);
246 extern bool stmt_interesting_for_vrp (gimple *);
247 extern bool range_includes_zero_p (const value_range_base *);
248 extern bool infer_value_range (gimple *, tree, tree_code *, tree *);
250 extern bool vrp_bitmap_equal_p (const_bitmap, const_bitmap);
252 extern tree value_range_constant_singleton (const value_range_base *);
253 extern bool range_int_cst_p (const value_range_base *);
254 extern bool range_int_cst_singleton_p (const value_range_base *);
256 extern int compare_values (tree, tree);
257 extern int compare_values_warnv (tree, tree, bool *);
258 extern int operand_less_p (tree, tree);
259 extern bool vrp_val_is_min (const_tree);
260 extern bool vrp_val_is_max (const_tree);
261 extern int value_inside_range (tree, tree, tree);
263 extern tree vrp_val_min (const_tree);
264 extern tree vrp_val_max (const_tree);
266 extern void extract_range_from_unary_expr (value_range_base *vr,
267 enum tree_code code,
268 tree type,
269 const value_range_base *vr0_,
270 tree op0_type);
271 extern void extract_range_from_binary_expr (value_range_base *,
272 enum tree_code,
273 tree, const value_range_base *,
274 const value_range_base *);
276 extern bool vrp_operand_equal_p (const_tree, const_tree);
277 extern enum value_range_kind intersect_range_with_nonzero_bits
278 (enum value_range_kind, wide_int *, wide_int *, const wide_int &, signop);
279 extern bool vrp_set_zero_nonzero_bits (const tree, const value_range_base *,
280 wide_int *, wide_int *);
282 extern bool find_case_label_range (gswitch *, tree, tree, size_t *, size_t *);
283 extern bool find_case_label_index (gswitch *, size_t, tree, size_t *);
284 extern bool overflow_comparison_p (tree_code, tree, tree, bool, tree *);
285 extern tree get_single_symbol (tree, bool *, tree *);
286 extern void maybe_set_nonzero_bits (edge, tree);
287 extern value_range_kind determine_value_range (tree, wide_int *, wide_int *);
289 #endif /* GCC_TREE_VRP_H */