]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/fold-const.h
Update copyright years.
[thirdparty/gcc.git] / gcc / fold-const.h
CommitLineData
d8a2d370 1/* Fold a constant sub-tree into a single node for C-compiler
a945c346 2 Copyright (C) 1987-2024 Free Software Foundation, Inc.
d8a2d370
DN
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for 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_FOLD_CONST_H
21#define GCC_FOLD_CONST_H
22
f9e900ce
JJ
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. */
d8a2d370 27extern int folding_initializer;
f9e900ce
JJ
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. */
32extern bool folding_cxx_constexpr;
d8a2d370
DN
33
34/* Convert between trees and native memory representation. */
b2505143 35extern int native_encode_expr (const_tree, unsigned char *, int, int off = -1);
ea69031c 36extern int native_encode_initializer (tree, unsigned char *, int,
896048cf 37 int off = -1, unsigned char * = nullptr);
d8a2d370 38extern tree native_interpret_expr (tree, const unsigned char *, int);
2801f23f 39extern tree native_interpret_real (tree, const unsigned char *, int);
ea69031c 40extern bool can_native_interpret_type_p (tree);
896048cf
JJ
41extern tree native_interpret_aggregate (tree, const unsigned char *, int, int);
42extern tree find_bitfield_repr_type (int, int);
8aba425f
JJ
43extern void shift_bytes_in_array_left (unsigned char *, unsigned int,
44 unsigned int);
45extern void shift_bytes_in_array_right (unsigned char *, unsigned int,
46 unsigned int);
d8a2d370
DN
47
48/* Fold constants as much as possible in an expression.
49 Returns the simplified expression.
50 Acts only on the top level of the expression;
51 if the argument itself cannot be simplified, its
52 subexpressions are not changed. */
53
54extern tree fold (tree);
600dcd74 55extern tree fold_init (tree);
d8a2d370
DN
56#define fold_unary(CODE,T1,T2)\
57 fold_unary_loc (UNKNOWN_LOCATION, CODE, T1, T2)
58extern tree fold_unary_loc (location_t, enum tree_code, tree, tree);
59#define fold_unary_ignore_overflow(CODE,T1,T2)\
60 fold_unary_ignore_overflow_loc (UNKNOWN_LOCATION, CODE, T1, T2)
61extern tree fold_unary_ignore_overflow_loc (location_t, enum tree_code, tree, tree);
62#define fold_binary(CODE,T1,T2,T3)\
63 fold_binary_loc (UNKNOWN_LOCATION, CODE, T1, T2, T3)
64extern tree fold_binary_loc (location_t, enum tree_code, tree, tree, tree);
65#define fold_ternary(CODE,T1,T2,T3,T4)\
66 fold_ternary_loc (UNKNOWN_LOCATION, CODE, T1, T2, T3, T4)
67extern tree fold_ternary_loc (location_t, enum tree_code, tree, tree, tree, tree);
68#define fold_build1(c,t1,t2)\
226b8289
TS
69 fold_build1_loc (UNKNOWN_LOCATION, c, t1, t2 MEM_STAT_INFO)
70extern tree fold_build1_loc (location_t, enum tree_code, tree,
71 tree CXX_MEM_STAT_INFO);
d8a2d370 72#define fold_build2(c,t1,t2,t3)\
226b8289
TS
73 fold_build2_loc (UNKNOWN_LOCATION, c, t1, t2, t3 MEM_STAT_INFO)
74extern tree fold_build2_loc (location_t, enum tree_code, tree, tree,
75 tree CXX_MEM_STAT_INFO);
d8a2d370 76#define fold_build3(c,t1,t2,t3,t4)\
226b8289
TS
77 fold_build3_loc (UNKNOWN_LOCATION, c, t1, t2, t3, t4 MEM_STAT_INFO)
78extern tree fold_build3_loc (location_t, enum tree_code, tree, tree, tree,
79 tree CXX_MEM_STAT_INFO);
d8a2d370
DN
80extern tree fold_build1_initializer_loc (location_t, enum tree_code, tree, tree);
81extern tree fold_build2_initializer_loc (location_t, enum tree_code, tree, tree, tree);
82#define fold_build_call_array(T1,T2,N,T4)\
83 fold_build_call_array_loc (UNKNOWN_LOCATION, T1, T2, N, T4)
84extern tree fold_build_call_array_loc (location_t, tree, tree, int, tree *);
85#define fold_build_call_array_initializer(T1,T2,N,T4)\
86 fold_build_call_array_initializer_loc (UNKNOWN_LOCATION, T1, T2, N, T4)
87extern tree fold_build_call_array_initializer_loc (location_t, tree, tree, int, tree *);
53caa472 88extern tree fold_binary_initializer_loc (location_t, tree_code, tree, tree, tree);
831e688a
RB
89extern tree get_array_ctor_element_at_index (tree, offset_int,
90 unsigned * = NULL);
d8a2d370
DN
91extern bool fold_convertible_p (const_tree, const_tree);
92#define fold_convert(T1,T2)\
93 fold_convert_loc (UNKNOWN_LOCATION, T1, T2)
94extern tree fold_convert_loc (location_t, tree, tree);
d8a2d370
DN
95extern tree fold_ignored_result (tree);
96extern tree fold_abs_const (tree, tree);
97extern tree fold_indirect_ref_1 (location_t, tree, tree);
98extern void fold_defer_overflow_warnings (void);
355fe088 99extern void fold_undefer_overflow_warnings (bool, const gimple *, int);
d8a2d370
DN
100extern void fold_undefer_and_ignore_overflow_warnings (void);
101extern bool fold_deferring_overflow_warnings_p (void);
a8b85ce9 102extern void fold_overflow_warning (const char*, enum warn_strict_overflow_code);
8d1628eb
JJ
103extern enum tree_code fold_div_compare (enum tree_code, tree, tree,
104 tree *, tree *, bool *);
7f4a8ee0 105extern bool operand_equal_p (const_tree, const_tree, unsigned int flags = 0);
ca15abc0 106extern bool multiple_of_p (tree, const_tree, const_tree, bool = true);
d8a2d370
DN
107#define omit_one_operand(T1,T2,T3)\
108 omit_one_operand_loc (UNKNOWN_LOCATION, T1, T2, T3)
109extern tree omit_one_operand_loc (location_t, tree, tree, tree);
110#define omit_two_operands(T1,T2,T3,T4)\
111 omit_two_operands_loc (UNKNOWN_LOCATION, T1, T2, T3, T4)
112extern tree omit_two_operands_loc (location_t, tree, tree, tree, tree);
113#define invert_truthvalue(T)\
114 invert_truthvalue_loc (UNKNOWN_LOCATION, T)
115extern tree invert_truthvalue_loc (location_t, tree);
116extern tree fold_unary_to_constant (enum tree_code, tree, tree);
117extern tree fold_binary_to_constant (enum tree_code, tree, tree, tree);
f2901002
JJ
118extern tree fold_bit_and_mask (tree, tree, enum tree_code,
119 tree, enum tree_code, tree, tree,
120 tree, enum tree_code, tree, tree, tree *);
d8a2d370 121extern tree fold_read_from_constant_string (tree);
4f8b89f0 122extern tree fold_read_from_vector (tree, poly_uint64);
ebd733a7
RB
123#if GCC_VEC_PERN_INDICES_H
124extern tree fold_vec_perm (tree, tree, tree, const vec_perm_indices &);
125#endif
5f9d2c58
AH
126extern bool wide_int_binop (wide_int &res, enum tree_code,
127 const wide_int &arg1, const wide_int &arg2,
128 signop, wi::overflow_type *);
129extern tree int_const_binop (enum tree_code, const_tree, const_tree, int = 1);
d8a2d370
DN
130#define build_fold_addr_expr(T)\
131 build_fold_addr_expr_loc (UNKNOWN_LOCATION, (T))
132extern tree build_fold_addr_expr_loc (location_t, tree);
133#define build_fold_addr_expr_with_type(T,TYPE)\
134 build_fold_addr_expr_with_type_loc (UNKNOWN_LOCATION, (T), TYPE)
135extern tree build_fold_addr_expr_with_type_loc (location_t, tree, tree);
136extern tree fold_build_cleanup_point_expr (tree type, tree expr);
d8a2d370
DN
137#define build_fold_indirect_ref(T)\
138 build_fold_indirect_ref_loc (UNKNOWN_LOCATION, T)
139extern tree build_fold_indirect_ref_loc (location_t, tree);
140#define fold_indirect_ref(T)\
141 fold_indirect_ref_loc (UNKNOWN_LOCATION, T)
142extern tree fold_indirect_ref_loc (location_t, tree);
143extern tree build_simple_mem_ref_loc (location_t, tree);
144#define build_simple_mem_ref(T)\
145 build_simple_mem_ref_loc (UNKNOWN_LOCATION, T)
aca52e6f 146extern poly_offset_int mem_ref_offset (const_tree);
36fd6408 147extern tree build_invariant_address (tree, tree, poly_int64);
d8a2d370 148extern tree constant_boolean_node (bool, tree);
807e902e 149extern tree div_if_zero_remainder (const_tree, const_tree);
d8a2d370 150
14e72812 151extern bool tree_swap_operands_p (const_tree, const_tree);
d8a2d370
DN
152extern enum tree_code swap_tree_comparison (enum tree_code);
153
eaa41a6d 154extern bool ptr_difference_const (tree, tree, poly_int64 *);
d8a2d370 155extern enum tree_code invert_tree_comparison (enum tree_code, bool);
2c58d42c 156extern bool inverse_conditions_p (const_tree, const_tree);
d8a2d370
DN
157
158extern bool tree_unary_nonzero_warnv_p (enum tree_code, tree, tree, bool *);
159extern bool tree_binary_nonzero_warnv_p (enum tree_code, tree, tree, tree op1,
160 bool *);
161extern bool tree_single_nonzero_warnv_p (tree, bool *);
68e57f04
RS
162extern bool tree_unary_nonnegative_warnv_p (enum tree_code, tree, tree,
163 bool *, int);
d8a2d370 164extern bool tree_binary_nonnegative_warnv_p (enum tree_code, tree, tree, tree,
68e57f04
RS
165 bool *, int);
166extern bool tree_single_nonnegative_warnv_p (tree, bool *, int);
1d9da71f
RS
167extern bool tree_call_nonnegative_warnv_p (tree, combined_fn, tree, tree,
168 bool *, int);
d8a2d370 169
67dbe582
RS
170extern bool integer_valued_real_unary_p (tree_code, tree, int);
171extern bool integer_valued_real_binary_p (tree_code, tree, tree, int);
1d9da71f 172extern bool integer_valued_real_call_p (combined_fn, tree, tree, int);
67dbe582
RS
173extern bool integer_valued_real_single_p (tree, int);
174extern bool integer_valued_real_p (tree, int = 0);
175
5b02ed4b
RS
176extern bool fold_real_zero_addition_p (const_tree, const_tree, const_tree,
177 int);
d8a2d370
DN
178extern tree combine_comparisons (location_t, enum tree_code, enum tree_code,
179 enum tree_code, tree, tree, tree);
180extern void debug_fold_checksum (const_tree);
181extern bool may_negate_without_overflow_p (const_tree);
182#define round_up(T,N) round_up_loc (UNKNOWN_LOCATION, T, N)
605f12f4 183extern tree round_up_loc (location_t, tree, unsigned int);
d8a2d370
DN
184#define round_down(T,N) round_down_loc (UNKNOWN_LOCATION, T, N)
185extern tree round_down_loc (location_t, tree, int);
36fd6408 186extern tree size_int_kind (poly_int64, enum size_type_kind);
d8a2d370
DN
187#define size_binop(CODE,T1,T2)\
188 size_binop_loc (UNKNOWN_LOCATION, CODE, T1, T2)
189extern tree size_binop_loc (location_t, enum tree_code, tree, tree);
190#define size_diffop(T1,T2)\
191 size_diffop_loc (UNKNOWN_LOCATION, T1, T2)
192extern tree size_diffop_loc (location_t, tree, tree);
193
194/* Return an expr equal to X but certainly not valid as an lvalue. */
195#define non_lvalue(T) non_lvalue_loc (UNKNOWN_LOCATION, T)
196extern tree non_lvalue_loc (location_t, tree);
197
e36c1cfe 198extern bool tree_expr_nonzero_p (tree);
d8a2d370 199extern bool tree_expr_nonnegative_p (tree);
68e57f04 200extern bool tree_expr_nonnegative_warnv_p (tree, bool *, int = 0);
1be48781
RS
201extern bool tree_expr_finite_p (const_tree);
202extern bool tree_expr_infinite_p (const_tree);
203extern bool tree_expr_maybe_infinite_p (const_tree);
204extern bool tree_expr_signaling_nan_p (const_tree);
205extern bool tree_expr_maybe_signaling_nan_p (const_tree);
206extern bool tree_expr_nan_p (const_tree);
207extern bool tree_expr_maybe_nan_p (const_tree);
a761829a 208extern bool tree_expr_maybe_real_minus_zero_p (const_tree);
d8a2d370
DN
209extern tree make_range (tree, int *, tree *, tree *, bool *);
210extern tree make_range_step (location_t, enum tree_code, tree, tree, tree,
211 tree *, tree *, int *, bool *);
8d1628eb 212extern tree range_check_type (tree);
d8a2d370
DN
213extern tree build_range_check (location_t, tree, tree, int, tree, tree);
214extern bool merge_ranges (int *, tree *, tree *, int, tree, tree, int,
215 tree, tree);
a7f24614 216extern tree sign_bit_p (tree, const_tree);
08b51bad 217extern bool simple_condition_p (tree);
a7f24614 218extern tree exact_inverse (tree, tree);
20b8d734 219extern bool expr_not_equal_to (tree t, const wide_int &);
8006f46b
RB
220extern tree const_unop (enum tree_code, tree, tree);
221extern tree const_binop (enum tree_code, tree, tree, tree);
1d9da71f 222extern bool negate_mathfn_p (combined_fn);
866626ef
MS
223extern const char *getbyterep (tree, unsigned HOST_WIDE_INT *);
224extern const char *c_getstr (tree);
ba6557e2 225extern wide_int tree_nonzero_bits (const_tree);
6123b998
JJ
226extern int address_compare (tree_code, tree, tree, tree, tree &, tree &,
227 poly_int64 &, poly_int64 &, bool);
2ef0e75d 228extern tree ctor_single_nonzero_element (const_tree);
d8a2d370 229
40e23961
MC
230/* Return OFF converted to a pointer offset type suitable as offset for
231 POINTER_PLUS_EXPR. Use location LOC for this conversion. */
232extern tree convert_to_ptrofftype_loc (location_t loc, tree off);
233
234#define convert_to_ptrofftype(t) convert_to_ptrofftype_loc (UNKNOWN_LOCATION, t)
235
236/* Build and fold a POINTER_PLUS_EXPR at LOC offsetting PTR by OFF. */
237extern tree fold_build_pointer_plus_loc (location_t loc, tree ptr, tree off);
238
239#define fold_build_pointer_plus(p,o) \
240 fold_build_pointer_plus_loc (UNKNOWN_LOCATION, p, o)
241
242/* Build and fold a POINTER_PLUS_EXPR at LOC offsetting PTR by OFF. */
243extern tree fold_build_pointer_plus_hwi_loc (location_t loc, tree ptr, HOST_WIDE_INT off);
244
245#define fold_build_pointer_plus_hwi(p,o) \
246 fold_build_pointer_plus_hwi_loc (UNKNOWN_LOCATION, p, o)
7f4a8ee0 247
b9b30dba
AP
248extern tree_code minmax_from_comparison (tree_code, tree, tree,
249 tree, tree);
250
ba206889
RB
251/* In gimple-fold.cc. */
252extern void clear_type_padding_in_mask (tree, unsigned char *);
253extern bool clear_padding_type_may_have_padding_p (tree);
254extern bool arith_overflowed_p (enum tree_code, const_tree, const_tree,
255 const_tree);
7f4a8ee0
ML
256
257/* Class used to compare gimple operands. */
258
259class operand_compare
260{
261public:
262 /* Return true if two operands are equal. The flags fields can be used
691924db 263 to specify OEP flags described in tree-core.h. */
7f4a8ee0
ML
264 virtual bool operand_equal_p (const_tree, const_tree, unsigned int flags);
265
266 /* Generate a hash value for an expression. This can be used iteratively
267 by passing a previous result as the HSTATE argument. */
268 virtual void hash_operand (const_tree, inchash::hash &, unsigned flags);
269
270protected:
271 /* Verify that when arguments (ARG0 and ARG1) are equal, then they have
272 an equal hash value. When the function knowns comparison return,
273 true is returned. Then RET is set to corresponding comparsion result. */
274 bool verify_hash_value (const_tree arg0, const_tree arg1, unsigned int flags,
275 bool *ret);
276};
277
d8a2d370 278#endif // GCC_FOLD_CONST_H