gcc/fold-const.h

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