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