gcc/fold-const.h

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