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