]>
Commit | Line | Data |
---|---|---|
c8a2ab6d | 1 | /* Chains of recurrences. |
85ec4feb | 2 | Copyright (C) 2003-2018 Free Software Foundation, Inc. |
0ff4040e | 3 | Contributed by Sebastian Pop <pop@cri.ensmp.fr> |
c8a2ab6d SP |
4 | |
5 | This file is part of GCC. | |
6 | ||
7 | GCC is free software; you can redistribute it and/or modify it under | |
8 | the terms of the GNU General Public License as published by the Free | |
9dcd6f09 | 9 | Software Foundation; either version 3, or (at your option) any later |
c8a2ab6d SP |
10 | version. |
11 | ||
12 | GCC is distributed in the hope that it will be useful, but WITHOUT ANY | |
13 | WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 | for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
9dcd6f09 NC |
18 | along with GCC; see the file COPYING3. If not see |
19 | <http://www.gnu.org/licenses/>. */ | |
c8a2ab6d SP |
20 | |
21 | #ifndef GCC_TREE_CHREC_H | |
22 | #define GCC_TREE_CHREC_H | |
23 | ||
b8698a0f L |
24 | /* The following trees are unique elements. Thus the comparison of another |
25 | element to these elements should be done on the pointer to these trees, | |
c8a2ab6d SP |
26 | and not on their value. */ |
27 | ||
28 | extern tree chrec_not_analyzed_yet; | |
29 | extern GTY(()) tree chrec_dont_know; | |
30 | extern GTY(()) tree chrec_known; | |
31 | ||
32 | /* After having added an automatically generated element, please | |
33 | include it in the following function. */ | |
34 | ||
35 | static inline bool | |
ed7a4b4b | 36 | automatically_generated_chrec_p (const_tree chrec) |
c8a2ab6d | 37 | { |
e71d7f88 | 38 | return (chrec == chrec_dont_know |
c8a2ab6d SP |
39 | || chrec == chrec_known); |
40 | } | |
41 | ||
42 | /* The tree nodes aka. CHRECs. */ | |
43 | ||
44 | static inline bool | |
ed7a4b4b | 45 | tree_is_chrec (const_tree expr) |
c8a2ab6d SP |
46 | { |
47 | if (TREE_CODE (expr) == POLYNOMIAL_CHREC | |
48 | || automatically_generated_chrec_p (expr)) | |
49 | return true; | |
50 | else | |
51 | return false; | |
52 | } | |
53 | ||
54 | \f | |
c1bf2a39 AM |
55 | enum ev_direction {EV_DIR_GROWS, EV_DIR_DECREASES, EV_DIR_UNKNOWN}; |
56 | enum ev_direction scev_direction (const_tree); | |
c8a2ab6d SP |
57 | |
58 | /* Chrec folding functions. */ | |
59 | extern tree chrec_fold_plus (tree, tree, tree); | |
60 | extern tree chrec_fold_minus (tree, tree, tree); | |
61 | extern tree chrec_fold_multiply (tree, tree, tree); | |
b24d9420 | 62 | extern tree chrec_convert (tree, tree, gimple *, bool = true, tree = NULL); |
355fe088 | 63 | extern tree chrec_convert_rhs (tree, tree, gimple *); |
c70ed622 | 64 | extern tree chrec_convert_aggressive (tree, tree, bool *); |
c8a2ab6d SP |
65 | |
66 | /* Operations. */ | |
67 | extern tree chrec_apply (unsigned, tree, tree); | |
9771b263 | 68 | extern tree chrec_apply_map (tree, vec<tree> ); |
c8a2ab6d | 69 | extern tree chrec_replace_initial_condition (tree, tree); |
c8a2ab6d | 70 | extern tree initial_condition (tree); |
6775f1f3 | 71 | extern tree initial_condition_in_loop_num (tree, unsigned); |
c8a2ab6d SP |
72 | extern tree evolution_part_in_loop_num (tree, unsigned); |
73 | extern tree hide_evolution_in_other_loops_than_loop (tree, unsigned); | |
74 | extern tree reset_evolution_in_loop (unsigned, tree, tree); | |
75 | extern tree chrec_merge (tree, tree); | |
f8bf9252 | 76 | extern void for_each_scev_op (tree *, bool (*) (tree *, void *), void *); |
355fe088 | 77 | extern bool convert_affine_scev (struct loop *, tree, tree *, tree *, gimple *, |
b24d9420 | 78 | bool, tree = NULL); |
c8a2ab6d SP |
79 | |
80 | /* Observers. */ | |
ed7a4b4b KG |
81 | extern bool eq_evolutions_p (const_tree, const_tree); |
82 | extern bool is_multivariate_chrec (const_tree); | |
ed7a4b4b KG |
83 | extern bool chrec_contains_symbols (const_tree); |
84 | extern bool chrec_contains_symbols_defined_in_loop (const_tree, unsigned); | |
85 | extern bool chrec_contains_undetermined (const_tree); | |
86 | extern bool tree_contains_chrecs (const_tree, int *); | |
87 | extern bool evolution_function_is_affine_multivariate_p (const_tree, int); | |
88 | extern bool evolution_function_is_univariate_p (const_tree); | |
86df10e3 | 89 | extern unsigned nb_vars_in_chrec (tree); |
0f7c0775 | 90 | extern bool evolution_function_is_invariant_p (tree, int); |
6a114766 | 91 | extern bool scev_is_linear_expression (tree); |
e7c705bb | 92 | extern bool evolution_function_right_is_integer_cst (const_tree); |
c8a2ab6d | 93 | |
e9793dae SP |
94 | /* Determines whether CHREC is equal to zero. */ |
95 | ||
b8698a0f | 96 | static inline bool |
ed7a4b4b | 97 | chrec_zerop (const_tree chrec) |
e9793dae SP |
98 | { |
99 | if (chrec == NULL_TREE) | |
100 | return false; | |
b8698a0f | 101 | |
e9793dae SP |
102 | if (TREE_CODE (chrec) == INTEGER_CST) |
103 | return integer_zerop (chrec); | |
b8698a0f | 104 | |
e9793dae SP |
105 | return false; |
106 | } | |
c8a2ab6d | 107 | |
b8698a0f | 108 | /* Determines whether CHREC is a loop invariant with respect to LOOP_NUM. |
0f7c0775 SP |
109 | Set the result in RES and return true when the property can be computed. */ |
110 | ||
111 | static inline bool | |
112 | no_evolution_in_loop_p (tree chrec, unsigned loop_num, bool *res) | |
113 | { | |
114 | tree scev; | |
b8698a0f | 115 | |
0f7c0775 SP |
116 | if (chrec == chrec_not_analyzed_yet |
117 | || chrec == chrec_dont_know | |
118 | || chrec_contains_symbols_defined_in_loop (chrec, loop_num)) | |
119 | return false; | |
120 | ||
f29deac9 | 121 | STRIP_NOPS (chrec); |
0f7c0775 | 122 | scev = hide_evolution_in_other_loops_than_loop (chrec, loop_num); |
105e8c06 | 123 | *res = !tree_contains_chrecs (scev, NULL); |
0f7c0775 SP |
124 | return true; |
125 | } | |
126 | ||
c8a2ab6d SP |
127 | /* Build a polynomial chain of recurrence. */ |
128 | ||
b8698a0f L |
129 | static inline tree |
130 | build_polynomial_chrec (unsigned loop_num, | |
131 | tree left, | |
c8a2ab6d SP |
132 | tree right) |
133 | { | |
0f7c0775 SP |
134 | bool val; |
135 | ||
c8a2ab6d SP |
136 | if (left == chrec_dont_know |
137 | || right == chrec_dont_know) | |
138 | return chrec_dont_know; | |
139 | ||
3cb8677c RG |
140 | if (!no_evolution_in_loop_p (left, loop_num, &val) |
141 | || !val) | |
0f7c0775 SP |
142 | return chrec_dont_know; |
143 | ||
a820c834 RB |
144 | /* Types of left and right sides of a chrec should be compatible, but |
145 | pointer CHRECs are special in that the evolution is of ptroff type. */ | |
5be014d5 | 146 | if (POINTER_TYPE_P (TREE_TYPE (left))) |
a820c834 | 147 | gcc_checking_assert (ptrofftype_p (TREE_TYPE (right))); |
5be014d5 | 148 | else |
a820c834 RB |
149 | { |
150 | /* Pointer types should occur only on the left hand side, i.e. in | |
151 | the base of the chrec, and not in the step. */ | |
152 | gcc_checking_assert (!POINTER_TYPE_P (TREE_TYPE (right)) | |
153 | && types_compatible_p (TREE_TYPE (left), | |
154 | TREE_TYPE (right))); | |
155 | } | |
e2157b49 | 156 | |
e9793dae SP |
157 | if (chrec_zerop (right)) |
158 | return left; | |
159 | ||
d2ec0277 RB |
160 | tree chrec = build2 (POLYNOMIAL_CHREC, TREE_TYPE (left), left, right); |
161 | CHREC_VARIABLE (chrec) = loop_num; | |
162 | return chrec; | |
c8a2ab6d SP |
163 | } |
164 | ||
c8a2ab6d SP |
165 | /* Determines whether the expression CHREC is a constant. */ |
166 | ||
b8698a0f | 167 | static inline bool |
ed7a4b4b | 168 | evolution_function_is_constant_p (const_tree chrec) |
c8a2ab6d SP |
169 | { |
170 | if (chrec == NULL_TREE) | |
171 | return false; | |
172 | ||
7668b0a6 | 173 | return is_gimple_min_invariant (chrec); |
c8a2ab6d SP |
174 | } |
175 | ||
5b78fc3e | 176 | /* Determine whether CHREC is an affine evolution function in LOOPNUM. */ |
c8a2ab6d | 177 | |
b8698a0f | 178 | static inline bool |
5b78fc3e | 179 | evolution_function_is_affine_in_loop (const_tree chrec, int loopnum) |
c8a2ab6d SP |
180 | { |
181 | if (chrec == NULL_TREE) | |
182 | return false; | |
b8698a0f | 183 | |
c8a2ab6d SP |
184 | switch (TREE_CODE (chrec)) |
185 | { | |
186 | case POLYNOMIAL_CHREC: | |
5b78fc3e JS |
187 | if (evolution_function_is_invariant_p (CHREC_LEFT (chrec), loopnum) |
188 | && evolution_function_is_invariant_p (CHREC_RIGHT (chrec), loopnum)) | |
c8a2ab6d SP |
189 | return true; |
190 | else | |
191 | return false; | |
b8698a0f | 192 | |
c8a2ab6d SP |
193 | default: |
194 | return false; | |
195 | } | |
196 | } | |
197 | ||
5b78fc3e | 198 | /* Determine whether CHREC is an affine evolution function or not. */ |
c8a2ab6d | 199 | |
b8698a0f | 200 | static inline bool |
5b78fc3e | 201 | evolution_function_is_affine_p (const_tree chrec) |
c8a2ab6d | 202 | { |
21d91009 SP |
203 | return chrec |
204 | && TREE_CODE (chrec) == POLYNOMIAL_CHREC | |
205 | && evolution_function_is_invariant_p (CHREC_RIGHT (chrec), | |
bce26def SP |
206 | CHREC_VARIABLE (chrec)) |
207 | && (TREE_CODE (CHREC_RIGHT (chrec)) != POLYNOMIAL_CHREC | |
208 | || evolution_function_is_affine_p (CHREC_RIGHT (chrec))); | |
c8a2ab6d SP |
209 | } |
210 | ||
211 | /* Determines whether EXPR does not contains chrec expressions. */ | |
212 | ||
213 | static inline bool | |
ed7a4b4b | 214 | tree_does_not_contain_chrecs (const_tree expr) |
c8a2ab6d | 215 | { |
2412d35c | 216 | return !tree_contains_chrecs (expr, NULL); |
c8a2ab6d SP |
217 | } |
218 | ||
e2157b49 SP |
219 | /* Returns the type of the chrec. */ |
220 | ||
221 | static inline tree | |
ed7a4b4b | 222 | chrec_type (const_tree chrec) |
e2157b49 SP |
223 | { |
224 | if (automatically_generated_chrec_p (chrec)) | |
225 | return NULL_TREE; | |
226 | ||
227 | return TREE_TYPE (chrec); | |
228 | } | |
229 | ||
5b78fc3e JS |
230 | static inline tree |
231 | chrec_fold_op (enum tree_code code, tree type, tree op0, tree op1) | |
232 | { | |
233 | switch (code) | |
234 | { | |
235 | case PLUS_EXPR: | |
236 | return chrec_fold_plus (type, op0, op1); | |
237 | ||
238 | case MINUS_EXPR: | |
239 | return chrec_fold_minus (type, op0, op1); | |
240 | ||
241 | case MULT_EXPR: | |
242 | return chrec_fold_multiply (type, op0, op1); | |
243 | ||
244 | default: | |
245 | gcc_unreachable (); | |
246 | } | |
247 | ||
248 | } | |
e2157b49 | 249 | |
c8a2ab6d | 250 | #endif /* GCC_TREE_CHREC_H */ |