summaryrefslogtreecommitdiff
path: root/gcc/value-range.h
blob: 0a9dc6f151f373096d6317595002e10920ac93ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/* Support routines for value ranges.
   Copyright (C) 2019-2020 Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.

GCC is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */

#ifndef GCC_VALUE_RANGE_H
#define GCC_VALUE_RANGE_H

/* Types of value ranges.  */
enum value_range_kind
{
  /* Empty range.  */
  VR_UNDEFINED,
  /* Range spans the entire domain.  */
  VR_VARYING,
  /* Range is [MIN, MAX].  */
  VR_RANGE,
  /* Range is ~[MIN, MAX].  */
  VR_ANTI_RANGE,
  /* Range is a nice guy.  */
  VR_LAST
};

// Range of values that can be associated with an SSA_NAME.

class GTY((for_user)) value_range
{
public:
  value_range ();
  value_range (tree, tree, value_range_kind = VR_RANGE);
  value_range (tree type, const wide_int &, const wide_int &,
	       value_range_kind = VR_RANGE);
  value_range (tree type);

  void set (tree, tree, value_range_kind = VR_RANGE);
  void set (tree);
  void set_nonzero (tree);
  void set_zero (tree);

  enum value_range_kind kind () const;
  tree min () const;
  tree max () const;

  /* Types of value ranges.  */
  bool symbolic_p () const;
  bool constant_p () const;
  bool undefined_p () const;
  bool varying_p () const;
  void set_varying (tree type);
  void set_undefined ();

  void union_ (const value_range *);
  void intersect (const value_range *);
  void union_ (const value_range &);
  void intersect (const value_range &);

  bool operator== (const value_range &) const;
  bool operator!= (const value_range &) const /* = delete */;
  bool equal_p (const value_range &) const;

  /* Misc methods.  */
  tree type () const;
  bool may_contain_p (tree) const;
  bool zero_p () const;
  bool nonzero_p () const;
  bool singleton_p (tree *result = NULL) const;
  void dump (FILE *) const;
  void dump () const;

  static bool supports_type_p (tree);
  void normalize_symbolics ();
  void normalize_addresses ();

  static const unsigned int m_max_pairs = 2;
  bool contains_p (tree) const;
  unsigned num_pairs () const;
  wide_int lower_bound (unsigned = 0) const;
  wide_int upper_bound (unsigned) const;
  wide_int upper_bound () const;
  void invert ();

protected:
  void check ();
  static value_range union_helper (const value_range *, const value_range *);
  static value_range intersect_helper (const value_range *,
				       const value_range *);

  friend void gt_ggc_mx_value_range (void *);
  friend void gt_pch_p_11value_range (void *, void *,
				      gt_pointer_operator, void *);
  friend void gt_pch_nx_value_range (void *);
  friend void gt_ggc_mx (value_range &);
  friend void gt_ggc_mx (value_range *&);
  friend void gt_pch_nx (value_range &);
  friend void gt_pch_nx (value_range *, gt_pointer_operator, void *);

  enum value_range_kind m_kind;
  tree m_min;
  tree m_max;

private:
  int value_inside_range (tree) const;
};

extern bool range_has_numeric_bounds_p (const value_range *);
extern bool ranges_from_anti_range (const value_range *,
				    value_range *, value_range *);
extern void dump_value_range (FILE *, const value_range *);
extern bool vrp_val_is_min (const_tree);
extern bool vrp_val_is_max (const_tree);
extern tree vrp_val_min (const_tree);
extern tree vrp_val_max (const_tree);
extern bool vrp_operand_equal_p (const_tree, const_tree);

inline
value_range::value_range ()
{
  m_kind = VR_UNDEFINED;
  m_min = m_max = NULL;
}

inline value_range_kind
value_range::kind () const
{
  return m_kind;
}

inline tree
value_range::type () const
{
  return TREE_TYPE (min ());
}

inline tree
value_range::min () const
{
  return m_min;
}

inline tree
value_range::max () const
{
  return m_max;
}

inline bool
value_range::varying_p () const
{
  return m_kind == VR_VARYING;
}

inline bool
value_range::undefined_p () const
{
  return m_kind == VR_UNDEFINED;
}

inline bool
value_range::zero_p () const
{
  return (m_kind == VR_RANGE
	  && integer_zerop (m_min)
	  && integer_zerop (m_max));
}

inline bool
value_range::nonzero_p () const
{
  if (m_kind == VR_ANTI_RANGE
      && !TYPE_UNSIGNED (type ())
      && integer_zerop (m_min)
      && integer_zerop (m_max))
    return true;

  return (m_kind == VR_RANGE
	  && TYPE_UNSIGNED (type ())
	  && integer_onep (m_min)
	  && vrp_val_is_max (m_max));
}

inline bool
value_range::supports_type_p (tree type)
{
  if (type && (INTEGRAL_TYPE_P (type) || POINTER_TYPE_P (type)))
    return type;
  return false;
}

inline bool
range_includes_zero_p (const value_range *vr)
{
  if (vr->undefined_p ())
    return false;

  if (vr->varying_p ())
    return true;

  return vr->may_contain_p (build_zero_cst (vr->type ()));
}

#endif // GCC_VALUE_RANGE_H