Line data Source code
1 : /* Fold a constant sub-tree into a single node for C-compiler
2 : Copyright (C) 1987-2026 Free Software Foundation, Inc.
3 :
4 : This file is part of GCC.
5 :
6 : GCC is free software; you can redistribute it and/or modify it under
7 : the terms of the GNU General Public License as published by the Free
8 : Software Foundation; either version 3, or (at your option) any later
9 : version.
10 :
11 : GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 : WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 : FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 : for more details.
15 :
16 : You should have received a copy of the GNU General Public License
17 : along with GCC; see the file COPYING3. If not see
18 : <http://www.gnu.org/licenses/>. */
19 :
20 : #ifndef GCC_FOLD_CONST_H
21 : #define GCC_FOLD_CONST_H
22 :
23 : /* Nonzero if we are folding constants inside an initializer or a C++
24 : manifestly-constant-evaluated context; zero otherwise.
25 : Should be used when folding in initializer enables additional
26 : optimizations. */
27 : extern int folding_initializer;
28 : /* Nonzero if we are folding C++ manifestly-constant-evaluated context; zero
29 : otherwise.
30 : Should be used when certain constructs shouldn't be optimized
31 : during folding in that context. */
32 : extern bool folding_cxx_constexpr;
33 :
34 : /* Convert between trees and native memory representation. */
35 : extern int native_encode_expr (const_tree, unsigned char *, int, int off = -1);
36 : extern int native_encode_initializer (tree, unsigned char *, int,
37 : int off = -1, unsigned char * = nullptr);
38 : extern int native_encode_wide_int (tree, const wide_int_ref &,
39 : unsigned char *, int, int off = -1);
40 : extern int native_encode_real (scalar_float_mode, const REAL_VALUE_TYPE *,
41 : unsigned char *, int, int off = -1);
42 : extern tree native_interpret_expr (tree, const unsigned char *, int);
43 : extern tree native_interpret_real (tree, const unsigned char *, int);
44 : extern bool can_native_interpret_type_p (tree);
45 : extern tree native_interpret_aggregate (tree, const unsigned char *, int, int);
46 : extern tree find_bitfield_repr_type (int, int);
47 : extern void shift_bytes_in_array_left (unsigned char *, unsigned int,
48 : unsigned int);
49 : extern void shift_bytes_in_array_right (unsigned char *, unsigned int,
50 : unsigned int);
51 :
52 : /* Fold constants as much as possible in an expression.
53 : Returns the simplified expression.
54 : Acts only on the top level of the expression;
55 : if the argument itself cannot be simplified, its
56 : subexpressions are not changed. */
57 :
58 : extern tree fold (tree);
59 : extern tree fold_init (tree);
60 : #define fold_unary(CODE,T1,T2)\
61 : fold_unary_loc (UNKNOWN_LOCATION, CODE, T1, T2)
62 : extern tree fold_unary_loc (location_t, enum tree_code, tree, tree);
63 : #define fold_unary_ignore_overflow(CODE,T1,T2)\
64 : fold_unary_ignore_overflow_loc (UNKNOWN_LOCATION, CODE, T1, T2)
65 : extern tree fold_unary_ignore_overflow_loc (location_t, enum tree_code, tree, tree);
66 : #define fold_binary(CODE,T1,T2,T3)\
67 : fold_binary_loc (UNKNOWN_LOCATION, CODE, T1, T2, T3)
68 : extern tree fold_binary_loc (location_t, enum tree_code, tree, tree, tree);
69 : #define fold_ternary(CODE,T1,T2,T3,T4)\
70 : fold_ternary_loc (UNKNOWN_LOCATION, CODE, T1, T2, T3, T4)
71 : extern tree fold_ternary_loc (location_t, enum tree_code, tree, tree, tree, tree);
72 : #define fold_build1(c,t1,t2)\
73 : fold_build1_loc (UNKNOWN_LOCATION, c, t1, t2 MEM_STAT_INFO)
74 : extern tree fold_build1_loc (location_t, enum tree_code, tree,
75 : tree CXX_MEM_STAT_INFO);
76 : #define fold_build2(c,t1,t2,t3)\
77 : fold_build2_loc (UNKNOWN_LOCATION, c, t1, t2, t3 MEM_STAT_INFO)
78 : extern tree fold_build2_loc (location_t, enum tree_code, tree, tree,
79 : tree CXX_MEM_STAT_INFO);
80 : #define fold_build3(c,t1,t2,t3,t4)\
81 : fold_build3_loc (UNKNOWN_LOCATION, c, t1, t2, t3, t4 MEM_STAT_INFO)
82 : extern tree fold_build3_loc (location_t, enum tree_code, tree, tree, tree,
83 : tree CXX_MEM_STAT_INFO);
84 : extern tree fold_build1_initializer_loc (location_t, enum tree_code, tree, tree);
85 : extern tree fold_build2_initializer_loc (location_t, enum tree_code, tree, tree, tree);
86 : #define fold_build_call_array(T1,T2,N,T4)\
87 : fold_build_call_array_loc (UNKNOWN_LOCATION, T1, T2, N, T4)
88 : extern tree fold_build_call_array_loc (location_t, tree, tree, int, tree *);
89 : #define fold_build_call_array_initializer(T1,T2,N,T4)\
90 : fold_build_call_array_initializer_loc (UNKNOWN_LOCATION, T1, T2, N, T4)
91 : extern tree fold_build_call_array_initializer_loc (location_t, tree, tree, int, tree *);
92 : extern tree fold_binary_initializer_loc (location_t, tree_code, tree, tree, tree);
93 : extern tree get_array_ctor_element_at_index (tree, offset_int,
94 : unsigned * = NULL);
95 : extern bool fold_convertible_p (const_tree, const_tree);
96 : #define fold_convert(T1,T2)\
97 : fold_convert_loc (UNKNOWN_LOCATION, T1, T2)
98 : extern tree fold_convert_loc (location_t, tree, tree);
99 : extern tree fold_ignored_result (tree);
100 : extern tree fold_abs_const (tree, tree);
101 : extern tree fold_indirect_ref_1 (location_t, tree, tree);
102 : extern enum tree_code fold_div_compare (enum tree_code, tree, tree,
103 : tree *, tree *, bool *);
104 : extern bool operand_equal_p (const_tree, const_tree, unsigned int flags = 0);
105 : extern bool multiple_of_p (tree, const_tree, const_tree, bool = true);
106 : #define omit_one_operand(T1,T2,T3)\
107 : omit_one_operand_loc (UNKNOWN_LOCATION, T1, T2, T3)
108 : extern tree omit_one_operand_loc (location_t, tree, tree, tree);
109 : #define omit_two_operands(T1,T2,T3,T4)\
110 : omit_two_operands_loc (UNKNOWN_LOCATION, T1, T2, T3, T4)
111 : extern tree omit_two_operands_loc (location_t, tree, tree, tree, tree);
112 : #define invert_truthvalue(T)\
113 : invert_truthvalue_loc (UNKNOWN_LOCATION, T)
114 : extern tree invert_truthvalue_loc (location_t, tree);
115 : extern tree fold_unary_to_constant (enum tree_code, tree, tree);
116 : extern tree fold_binary_to_constant (enum tree_code, tree, tree, tree);
117 : extern tree fold_bit_and_mask (tree, tree, enum tree_code,
118 : tree, enum tree_code, tree, tree,
119 : tree, enum tree_code, tree, tree, tree *);
120 : extern tree fold_read_from_constant_string (tree);
121 : extern tree fold_read_from_vector (tree, poly_uint64);
122 : #if GCC_VEC_PERN_INDICES_H
123 : extern tree fold_vec_perm (tree, tree, tree, const vec_perm_indices &);
124 : #endif
125 : extern bool wide_int_binop (wide_int &res, enum tree_code,
126 : const wide_int &arg1, const wide_int &arg2,
127 : signop, wi::overflow_type *);
128 : extern bool poly_int_binop (poly_wide_int &res, enum tree_code,
129 : const_tree, const_tree, signop,
130 : wi::overflow_type *);
131 : extern tree int_const_binop (enum tree_code, const_tree, const_tree, int = 1);
132 : extern tree int_const_convert (tree, const_tree, int = 1);
133 : #define build_fold_addr_expr(T)\
134 : build_fold_addr_expr_loc (UNKNOWN_LOCATION, (T))
135 : extern tree build_fold_addr_expr_loc (location_t, tree);
136 : #define build_fold_addr_expr_with_type(T,TYPE)\
137 : build_fold_addr_expr_with_type_loc (UNKNOWN_LOCATION, (T), TYPE)
138 : extern tree build_fold_addr_expr_with_type_loc (location_t, tree, tree);
139 : extern tree fold_build_cleanup_point_expr (tree type, tree expr);
140 : #define build_fold_indirect_ref(T)\
141 : build_fold_indirect_ref_loc (UNKNOWN_LOCATION, T)
142 : extern tree build_fold_indirect_ref_loc (location_t, tree);
143 : #define fold_indirect_ref(T)\
144 : fold_indirect_ref_loc (UNKNOWN_LOCATION, T)
145 : extern tree fold_indirect_ref_loc (location_t, tree);
146 : extern tree build_simple_mem_ref_loc (location_t, tree);
147 : #define build_simple_mem_ref(T)\
148 : build_simple_mem_ref_loc (UNKNOWN_LOCATION, T)
149 : extern poly_offset_int mem_ref_offset (const_tree);
150 : extern tree build_invariant_address (tree, tree, poly_int64);
151 : extern tree constant_boolean_node (bool, tree);
152 :
153 : extern bool tree_swap_operands_p (const_tree, const_tree);
154 : extern enum tree_code swap_tree_comparison (enum tree_code);
155 :
156 : extern bool ptr_difference_const (tree, tree, poly_int64 *);
157 : extern enum tree_code invert_tree_comparison (enum tree_code, bool);
158 : extern bool inverse_conditions_p (const_tree, const_tree);
159 :
160 : extern bool tree_unary_nonzero_p (enum tree_code, tree, tree);
161 : extern bool tree_binary_nonzero_p (enum tree_code, tree, tree, tree op1);
162 : extern bool tree_single_nonzero_p (tree);
163 : extern bool tree_unary_nonnegative_p (enum tree_code, tree, tree, int);
164 : extern bool tree_binary_nonnegative_p (enum tree_code, tree, tree, tree, int);
165 : extern bool tree_single_nonnegative_p (tree, int);
166 : extern bool tree_call_nonnegative_p (tree, combined_fn, tree, tree, int);
167 :
168 : extern bool integer_valued_real_unary_p (tree_code, tree, int);
169 : extern bool integer_valued_real_binary_p (tree_code, tree, tree, int);
170 : extern bool integer_valued_real_call_p (combined_fn, tree, tree, int);
171 : extern bool integer_valued_real_single_p (tree, int);
172 : extern bool integer_valued_real_p (tree, int = 0);
173 :
174 : extern bool fold_real_zero_addition_p (const_tree, const_tree, const_tree,
175 : int);
176 : extern tree combine_comparisons (location_t, enum tree_code, enum tree_code,
177 : enum tree_code, tree, tree, tree);
178 : extern void debug_fold_checksum (const_tree);
179 : extern bool may_negate_without_overflow_p (const_tree);
180 : #define round_up(T,N) round_up_loc (UNKNOWN_LOCATION, T, N)
181 : extern tree round_up_loc (location_t, tree, unsigned int);
182 : #define round_down(T,N) round_down_loc (UNKNOWN_LOCATION, T, N)
183 : extern tree round_down_loc (location_t, tree, int);
184 : extern tree size_int_kind (poly_int64, enum size_type_kind);
185 : #define size_binop(CODE,T1,T2)\
186 : size_binop_loc (UNKNOWN_LOCATION, CODE, T1, T2)
187 : extern tree size_binop_loc (location_t, enum tree_code, tree, tree);
188 : #define size_diffop(T1,T2)\
189 : size_diffop_loc (UNKNOWN_LOCATION, T1, T2)
190 : extern tree size_diffop_loc (location_t, tree, tree);
191 :
192 : /* Return an expr equal to X but certainly not valid as an lvalue. */
193 : #define non_lvalue(T) non_lvalue_loc (UNKNOWN_LOCATION, T)
194 : extern tree non_lvalue_loc (location_t, tree);
195 :
196 : extern bool tree_expr_nonzero_p (tree);
197 : extern bool tree_expr_nonnegative_p (tree, int = 0);
198 : extern bool tree_expr_finite_p (const_tree);
199 : extern bool tree_expr_infinite_p (const_tree);
200 : extern bool tree_expr_maybe_infinite_p (const_tree);
201 : extern bool tree_expr_signaling_nan_p (const_tree);
202 : extern bool tree_expr_maybe_signaling_nan_p (const_tree);
203 : extern bool tree_expr_nan_p (const_tree);
204 : extern bool tree_expr_maybe_nan_p (const_tree);
205 : extern bool tree_expr_maybe_real_minus_zero_p (const_tree);
206 : extern tree make_range (tree, int *, tree *, tree *);
207 : extern tree make_range_step (location_t, enum tree_code, tree, tree, tree,
208 : tree *, tree *, int *);
209 : extern tree range_check_type (tree);
210 : extern tree build_range_check (location_t, tree, tree, int, tree, tree);
211 : extern bool merge_ranges (int *, tree *, tree *, int, tree, tree, int,
212 : tree, tree);
213 : extern tree sign_bit_p (tree, const_tree);
214 : extern bool simple_condition_p (tree);
215 : extern tree exact_inverse (tree, tree);
216 : extern bool expr_not_equal_to (tree t, const wide_int &, gimple * = NULL);
217 : extern tree const_unop (enum tree_code, tree, tree);
218 : extern tree vector_const_binop (enum tree_code, tree, tree,
219 : tree (*) (enum tree_code, tree, tree));
220 : extern tree const_binop (enum tree_code, tree, tree, tree);
221 : extern bool negate_mathfn_p (combined_fn);
222 : extern const char *getbyterep (tree, unsigned HOST_WIDE_INT *);
223 : extern const char *c_getstr (tree);
224 : extern wide_int tree_nonzero_bits (const_tree);
225 : extern int address_compare (tree_code, tree, tree, tree, tree &, tree &,
226 : poly_int64 &, poly_int64 &, bool);
227 : extern tree ctor_single_nonzero_element (const_tree);
228 :
229 : /* Return OFF converted to a pointer offset type suitable as offset for
230 : POINTER_PLUS_EXPR. Use location LOC for this conversion. */
231 : extern tree convert_to_ptrofftype_loc (location_t loc, tree off);
232 :
233 : #define convert_to_ptrofftype(t) convert_to_ptrofftype_loc (UNKNOWN_LOCATION, t)
234 :
235 : /* Build and fold a POINTER_PLUS_EXPR at LOC offsetting PTR by OFF. */
236 : extern tree fold_build_pointer_plus_loc (location_t loc, tree ptr, tree off);
237 :
238 : #define fold_build_pointer_plus(p,o) \
239 : fold_build_pointer_plus_loc (UNKNOWN_LOCATION, p, o)
240 :
241 : /* Build and fold a POINTER_PLUS_EXPR at LOC offsetting PTR by OFF. */
242 : extern tree fold_build_pointer_plus_hwi_loc (location_t loc, tree ptr, HOST_WIDE_INT off);
243 :
244 : #define fold_build_pointer_plus_hwi(p,o) \
245 : fold_build_pointer_plus_hwi_loc (UNKNOWN_LOCATION, p, o)
246 :
247 : extern tree_code minmax_from_comparison (tree_code, tree,
248 : const widest_int,
249 : const widest_int);
250 : extern tree_code minmax_from_comparison (tree_code, tree, tree,
251 : tree, tree);
252 :
253 : extern tree make_bit_field_ref (location_t, tree, tree, tree,
254 : HOST_WIDE_INT, poly_int64, int, int);
255 :
256 : /* In gimple-fold.cc. */
257 : extern void clear_type_padding_in_mask (tree, unsigned char *);
258 : extern bool clear_padding_type_may_have_padding_p (tree);
259 : extern bool arith_overflowed_p (enum tree_code, const_tree, const_tree,
260 : const_tree);
261 : extern tree fold_truth_andor_for_ifcombine (enum tree_code, tree,
262 : location_t, enum tree_code,
263 : tree, tree,
264 : location_t, enum tree_code,
265 : tree, tree,
266 : tree *);
267 :
268 :
269 : /* Class used to compare gimple operands. */
270 :
271 382265 : class operand_compare
272 : {
273 : public:
274 : /* Return true if two operands are equal. The flags fields can be used
275 : to specify OEP flags described in tree-core.h. */
276 : virtual bool operand_equal_p (const_tree, const_tree, unsigned int flags);
277 :
278 : /* Generate a hash value for an expression. This can be used iteratively
279 : by passing a previous result as the HSTATE argument. */
280 : virtual void hash_operand (const_tree, inchash::hash &, unsigned flags);
281 :
282 : protected:
283 : /* Verify that when arguments (ARG0 and ARG1) are equal, then they have
284 : an equal hash value. When the function knowns comparison return,
285 : true is returned. Then RET is set to corresponding comparison result. */
286 : bool verify_hash_value (const_tree arg0, const_tree arg1, unsigned int flags,
287 : bool *ret);
288 :
289 : private:
290 : /* Return true if two operands are equal. The flags fields can be used
291 : to specify OEP flags described in tree-core.h. */
292 : bool operand_equal_p (tree, const_tree, tree, const_tree,
293 : unsigned int flags);
294 : };
295 :
296 : #endif // GCC_FOLD_CONST_H
|
