1/* Support routines for Value Range Propagation (VRP).
2 Copyright (C) 2016-2017 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 3, or (at your option)
9any later version.
10
11GCC is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20#ifndef GCC_TREE_VRP_H
21#define GCC_TREE_VRP_H
22
23/* Type of value ranges. See value_range below for a
24 description of these types. */
25enum value_range_type { VR_UNDEFINED, VR_RANGE,
26 VR_ANTI_RANGE, VR_VARYING, VR_LAST };
27
28/* Range of values that can be associated with an SSA_NAME after VRP
29 has executed. */
30struct GTY((for_user)) value_range
31{
32 /* Lattice value represented by this range. */
33 enum value_range_type type;
34
35 /* Minimum and maximum values represented by this range. These
36 values should be interpreted as follows:
37
38 - If TYPE is VR_UNDEFINED or VR_VARYING then MIN and MAX must
39 be NULL.
40
41 - If TYPE == VR_RANGE then MIN holds the minimum value and
42 MAX holds the maximum value of the range [MIN, MAX].
43
44 - If TYPE == ANTI_RANGE the variable is known to NOT
45 take any values in the range [MIN, MAX]. */
46 tree min;
47 tree max;
48
49 /* Set of SSA names whose value ranges are equivalent to this one.
50 This set is only valid when TYPE is VR_RANGE or VR_ANTI_RANGE. */
51 bitmap equiv;
52};
53
54extern void vrp_intersect_ranges (value_range *vr0, value_range *vr1);
55extern void vrp_meet (value_range *vr0, const value_range *vr1);
56extern void dump_value_range (FILE *, const value_range *);
57extern void extract_range_from_unary_expr (value_range *vr,
58 enum tree_code code,
59 tree type,
60 value_range *vr0_,
61 tree op0_type);
62
63extern bool vrp_operand_equal_p (const_tree, const_tree);
64
65struct assert_info
66{
67 /* Predicate code for the ASSERT_EXPR. Must be COMPARISON_CLASS_P. */
68 enum tree_code comp_code;
69
70 /* Name to register the assert for. */
71 tree name;
72
73 /* Value being compared against. */
74 tree val;
75
76 /* Expression to compare. */
77 tree expr;
78};
79
80extern void register_edge_assert_for (tree, edge, enum tree_code,
81 tree, tree, vec<assert_info> &);
82extern bool stmt_interesting_for_vrp (gimple *);
83extern void set_value_range_to_varying (value_range *);
84extern int range_includes_zero_p (tree, tree);
85extern bool infer_value_range (gimple *, tree, tree_code *, tree *);
86
87extern void set_value_range_to_nonnull (value_range *, tree);
88extern void set_value_range (value_range *, enum value_range_type, tree,
89 tree, bitmap);
90extern void set_and_canonicalize_value_range (value_range *,
91 enum value_range_type,
92 tree, tree, bitmap);
93extern bool vrp_bitmap_equal_p (const_bitmap, const_bitmap);
94extern bool range_is_nonnull (value_range *);
95extern tree value_range_constant_singleton (value_range *);
96extern bool symbolic_range_p (value_range *);
97extern int compare_values (tree, tree);
98extern int compare_values_warnv (tree, tree, bool *);
99extern bool vrp_val_is_min (const_tree);
100extern bool vrp_val_is_max (const_tree);
101extern void copy_value_range (value_range *, value_range *);
102extern void set_value_range_to_value (value_range *, tree, bitmap);
103extern void extract_range_from_binary_expr_1 (value_range *, enum tree_code,
104 tree, value_range *,
105 value_range *);
106extern tree vrp_val_min (const_tree);
107extern tree vrp_val_max (const_tree);
108extern void set_value_range_to_null (value_range *, tree);
109extern bool range_int_cst_p (value_range *);
110extern int operand_less_p (tree, tree);
111extern bool find_case_label_range (gswitch *, tree, tree, size_t *, size_t *);
112extern bool find_case_label_index (gswitch *, size_t, tree, size_t *);
113extern bool zero_nonzero_bits_from_vr (const tree, value_range *,
114 wide_int *, wide_int *);
115extern bool overflow_comparison_p (tree_code, tree, tree, bool, tree *);
116extern bool range_int_cst_singleton_p (value_range *);
117extern int value_inside_range (tree, tree, tree);
118extern tree get_single_symbol (tree, bool *, tree *);
119extern void maybe_set_nonzero_bits (edge, tree);
120
121
122struct switch_update {
123 gswitch *stmt;
124 tree vec;
125};
126
127extern vec<edge> to_remove_edges;
128extern vec<switch_update> to_update_switch_stmts;
129
130#endif /* GCC_TREE_VRP_H */
131