Line data Source code
1 : /* Header file for the GIMPLE fold_using_range interface.
2 : Copyright (C) 2019-2026 Free Software Foundation, Inc.
3 : Contributed by Andrew MacLeod <amacleod@redhat.com>
4 : and Aldy Hernandez <aldyh@redhat.com>.
5 :
6 : This file is part of GCC.
7 :
8 : GCC is free software; you can redistribute it and/or modify it under
9 : the terms of the GNU General Public License as published by the Free
10 : Software Foundation; either version 3, or (at your option) any later
11 : version.
12 :
13 : GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 : WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 : FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 : for more details.
17 :
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/>. */
21 :
22 : #ifndef GCC_GIMPLE_RANGE_FOLD_H
23 : #define GCC_GIMPLE_RANGE_FOLD_H
24 :
25 : // This file is the main include point for gimple range folding.
26 : // These routines will fold stmt S into the result range R.
27 : // Any ssa_names on the stmt will be calculated using the range_query
28 : // parameter via a call to range_of_expr.
29 : // If no range_query is provided, current global range info will be used.
30 : // The second variation specifies an edge, and stmt S is recalculated as if
31 : // it appeared on that edge.
32 :
33 : // Fold stmt S into range R using range query Q.
34 : bool fold_range (vrange &r, gimple *s, range_query *q = NULL);
35 : // Recalculate stmt S into R using range query Q as if it were on edge ON_EDGE.
36 : bool fold_range (vrange &v, gimple *s, edge on_edge, range_query *q = NULL);
37 :
38 : // These routines the operands to be specified when manually folding.
39 : // Any excess queries will be drawn from the current range_query.
40 : bool fold_range (vrange &r, gimple *s, vrange &r1, range_query *q = NULL);
41 : bool fold_range (vrange &r, gimple *s, vrange &r1, vrange &r2,
42 : range_query *q = NULL);
43 : bool fold_range (vrange &r, gimple *s, unsigned num_elements, vrange **vector,
44 : range_query *q = NULL);
45 :
46 : // Calculate op1 on stmt S.
47 : bool op1_range (vrange &, gimple *s, range_query *q = NULL);
48 : bool op1_range (vrange &, gimple *s, const vrange &lhs, range_query *q = NULL);
49 : // Calculate op2 on stmt S.
50 : bool op2_range (vrange &, gimple *s, range_query *q = NULL);
51 : bool op2_range (vrange &, gimple *s, const vrange &lhs, range_query *q = NULL);
52 :
53 : // This routine will return a relation trio for stmt S.
54 : relation_trio fold_relations (gimple *s, range_query *q = NULL);
55 :
56 : // Return the type of range which statement S calculates. If the type is
57 : // unsupported or no type can be determined, return NULL_TREE.
58 :
59 : inline tree
60 393017345 : gimple_range_type (const gimple *s)
61 : {
62 393017345 : tree lhs = gimple_get_lhs (s);
63 393017345 : tree type = NULL_TREE;
64 393017345 : if (lhs)
65 285023261 : type = TREE_TYPE (lhs);
66 : else
67 : {
68 107994084 : enum gimple_code code = gimple_code (s);
69 107994084 : if (code == GIMPLE_COND)
70 106949421 : type = boolean_type_node;
71 1044663 : else if (code == GIMPLE_PHI)
72 0 : type = TREE_TYPE (gimple_phi_result (s));
73 1044663 : else if (code == GIMPLE_CALL)
74 : {
75 377816 : type = gimple_call_fntype (s);
76 : // If it has a type, get the return type.
77 377816 : if (type)
78 377186 : type = TREE_TYPE (type);
79 : }
80 : }
81 392349868 : if (type && value_range::supports_type_p (type))
82 392005349 : return type;
83 : return NULL_TREE;
84 : }
85 :
86 : // Return EXP if it is an SSA_NAME with a type supported by gimple ranges.
87 :
88 : inline tree
89 5334285126 : gimple_range_ssa_p (tree exp)
90 : {
91 5256444890 : if (exp && TREE_CODE (exp) == SSA_NAME &&
92 14197976949 : !SSA_NAME_IS_VIRTUAL_OPERAND (exp) &&
93 4412773086 : value_range::supports_type_p (TREE_TYPE (exp)))
94 4405787794 : return exp;
95 : return NULL_TREE;
96 : }
97 :
98 : // Source of all operands for fold_using_range and gori_compute.
99 : // It abstracts out the source of an operand so it can come from a stmt or
100 : // and edge or anywhere a derived class of fur_source wants.
101 : // The default simply picks up ranges from the current range_query.
102 :
103 : class fur_source
104 : {
105 : public:
106 : fur_source (range_query *q = NULL);
107 352314804 : inline range_query *query () const { return m_query; }
108 304173038 : inline gori_map *gori_ssa () const
109 245550333 : { return (m_depend_p && m_query) ? m_query->gori_ssa () : NULL; }
110 145114738 : inline class gimple_outgoing_range *gori ()
111 145114738 : { return m_depend_p ? &(m_query->gori ()) : NULL; }
112 : virtual bool get_operand (vrange &r, tree expr);
113 : virtual bool get_phi_operand (vrange &r, tree expr, edge e);
114 : virtual relation_kind query_relation (tree op1, tree op2);
115 : virtual bool register_relation (gimple *stmt, relation_kind k, tree op1,
116 : tree op2);
117 : virtual bool register_relation (edge e, relation_kind k, tree op1,
118 : tree op2);
119 : void register_outgoing_edges (gcond *, irange &lhs_range, edge e0, edge e1);
120 : protected:
121 : range_query *m_query;
122 : bool m_depend_p;
123 : };
124 :
125 : // fur_stmt is the specification for drawing an operand from range_query Q
126 : // via a range_of_Expr call on stmt S.
127 :
128 : class fur_stmt : public fur_source
129 : {
130 : public:
131 : fur_stmt (gimple *s, range_query *q = NULL);
132 : virtual bool get_operand (vrange &r, tree expr) override;
133 : virtual bool get_phi_operand (vrange &r, tree expr, edge e) override;
134 : virtual relation_kind query_relation (tree op1, tree op2) override;
135 : private:
136 : gimple *m_stmt;
137 : };
138 :
139 : // This version of fur_source will pick a range from a stmt, and also register
140 : // dependencies via a gori_compute object. This is mostly an internal API.
141 :
142 : class fur_depend : public fur_stmt
143 : {
144 : public:
145 : fur_depend (gimple *s, range_query *q = NULL, class ranger_cache *c = NULL);
146 : virtual bool register_relation (gimple *stmt, relation_kind k, tree op1,
147 : tree op2) override;
148 : virtual bool register_relation (edge e, relation_kind k, tree op1,
149 : tree op2) override;
150 : private:
151 : ranger_cache *m_cache;
152 : };
153 :
154 :
155 : // This version of fur_source will pick a range up off an edge.
156 :
157 : class fur_edge : public fur_source
158 : {
159 : public:
160 59054804 : fur_edge (edge e, range_query *q = NULL) : fur_source (q)
161 59054804 : { m_edge = e; }
162 : virtual bool get_operand (vrange &r, tree expr) override;
163 : virtual bool get_phi_operand (vrange &r, tree expr, edge e) override;
164 : private:
165 : edge m_edge;
166 : };
167 :
168 : // This class uses ranges to fold a gimple statement producing a range for
169 : // the LHS. The source of all operands is supplied via the fur_source class
170 : // which provides a range_query as well as a source location and any other
171 : // required information.
172 :
173 : class fold_using_range
174 : {
175 : public:
176 : bool fold_stmt (vrange &r, gimple *s, class fur_source &src,
177 : tree name = NULL_TREE);
178 : protected:
179 : bool range_of_range_op (vrange &r, gimple_range_op_handler &handler,
180 : fur_source &src);
181 : bool range_of_call (vrange &r, gcall *call, fur_source &src);
182 : bool range_of_cond_expr (vrange &r, gassign* cond, fur_source &src);
183 : bool range_of_address (prange &r, gimple *s, fur_source &src);
184 : bool range_from_readonly_var (vrange &r, gimple *stmt);
185 : bool range_of_phi (vrange &r, gphi *phi, fur_source &src);
186 : void range_of_ssa_name_with_loop_info (vrange &, tree, class loop *, gphi *,
187 : fur_source &src);
188 : void relation_fold_and_or (irange& lhs_range, gimple *s, fur_source &src,
189 : vrange &op1, vrange &op2);
190 : bool condexpr_adjust (vrange &r1, vrange &r2, gimple *, tree cond, tree op1,
191 : tree op2, fur_source &src);
192 : };
193 : #endif // GCC_GIMPLE_RANGE_FOLD_H
|
