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 #define fold_unary(CODE,T1,T2)\
  48    fold_unary_loc (UNKNOWN_LOCATION, CODE, T1, T2)
  49 extern 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)
  52 extern 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)
  55 extern 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)
  58 extern tree fold_ternary_loc (location_t, enum tree_code, tree, tree, tree, tree);
  59 #define fold_build1(c,t1,t2)\
  60    fold_build1_loc (UNKNOWN_LOCATION, c, t1, t2 MEM_STAT_INFO)
  61 extern tree fold_build1_loc (location_t, enum tree_code, tree,
  62                              tree CXX_MEM_STAT_INFO);
  63 #define fold_build2(c,t1,t2,t3)\
  64    fold_build2_loc (UNKNOWN_LOCATION, c, t1, t2, t3 MEM_STAT_INFO)
  65 extern tree fold_build2_loc (location_t, enum tree_code, tree, tree,
  66                              tree CXX_MEM_STAT_INFO);
  67 #define fold_build3(c,t1,t2,t3,t4)\
  68    fold_build3_loc (UNKNOWN_LOCATION, c, t1, t2, t3, t4 MEM_STAT_INFO)
  69 extern tree fold_build3_loc (location_t, enum tree_code, tree, tree, tree,
  70                                   tree CXX_MEM_STAT_INFO);
  71 extern tree fold_build1_initializer_loc (location_t, enum tree_code, tree, tree);
  72 extern 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)
  75 extern 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)
  78 extern tree fold_build_call_array_initializer_loc (location_t, tree, tree, int, tree *);
  79 extern tree get_array_ctor_element_at_index (tree, offset_int,
  80                                              unsigned * = NULL);
  81 extern bool fold_convertible_p (const_tree, const_tree);
  82 #define fold_convert(T1,T2)\
  83    fold_convert_loc (UNKNOWN_LOCATION, T1, T2)
  84 extern tree fold_convert_loc (location_t, tree, tree);
  85 extern tree fold_single_bit_test (location_t, enum tree_code, tree, tree, tree);
  86 extern tree fold_ignored_result (tree);
  87 extern tree fold_abs_const (tree, tree);
  88 extern tree fold_indirect_ref_1 (location_t, tree, tree);
  89 extern void fold_defer_overflow_warnings (void);
  90 extern void fold_undefer_overflow_warnings (bool, const gimple *, int);
  91 extern void fold_undefer_and_ignore_overflow_warnings (void);
  92 extern bool fold_deferring_overflow_warnings_p (void);
  93 extern void fold_overflow_warning (const char*, enum warn_strict_overflow_code);
  94 extern enum tree_code fold_div_compare (enum tree_code, tree, tree,
  95                                         tree *, tree *, bool *);
  96 extern bool operand_equal_p (const_tree, const_tree, unsigned int flags = 0);
  97 extern 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)
 100 extern 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)
 103 extern tree omit_two_operands_loc (location_t, tree, tree, tree, tree);
 104 #define invert_truthvalue(T)\
 105    invert_truthvalue_loc (UNKNOWN_LOCATION, T)
 106 extern tree invert_truthvalue_loc (location_t, tree);
 107 extern tree fold_unary_to_constant (enum tree_code, tree, tree);
 108 extern tree fold_binary_to_constant (enum tree_code, tree, tree, tree);
 109 extern 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 *);
 112 extern tree fold_read_from_constant_string (tree);
 113 extern tree fold_read_from_vector (tree, poly_uint64);
 114 #if GCC_VEC_PERN_INDICES_H
 115 extern tree fold_vec_perm (tree, tree, tree, const vec_perm_indices &);
 116 #endif
 117 extern bool wide_int_binop (wide_int &res, enum tree_code,
 118                             const wide_int &arg1, const wide_int &arg2,
 119                             signop, wi::overflow_type *);
 120 extern tree int_const_binop (enum tree_code, const_tree, const_tree, int = 1);
 121 #define build_fold_addr_expr(T)\
 122         build_fold_addr_expr_loc (UNKNOWN_LOCATION, (T))
 123 extern 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)
 126 extern tree build_fold_addr_expr_with_type_loc (location_t, tree, tree);
 127 extern tree fold_build_cleanup_point_expr (tree type, tree expr);
 128 #define build_fold_indirect_ref(T)\
 129         build_fold_indirect_ref_loc (UNKNOWN_LOCATION, T)
 130 extern tree build_fold_indirect_ref_loc (location_t, tree);
 131 #define fold_indirect_ref(T)\
 132         fold_indirect_ref_loc (UNKNOWN_LOCATION, T)
 133 extern tree fold_indirect_ref_loc (location_t, tree);
 134 extern 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)
 137 extern poly_offset_int mem_ref_offset (const_tree);
 138 extern tree build_invariant_address (tree, tree, poly_int64);
 139 extern tree constant_boolean_node (bool, tree);
 140 extern tree div_if_zero_remainder (const_tree, const_tree);
 141
 142 extern bool tree_swap_operands_p (const_tree, const_tree);
 143 extern enum tree_code swap_tree_comparison (enum tree_code);
 144
 145 extern bool ptr_difference_const (tree, tree, poly_int64_pod *);
 146 extern enum tree_code invert_tree_comparison (enum tree_code, bool);
 147 extern bool inverse_conditions_p (const_tree, const_tree);
 148
 149 extern bool tree_unary_nonzero_warnv_p (enum tree_code, tree, tree, bool *);
 150 extern bool tree_binary_nonzero_warnv_p (enum tree_code, tree, tree, tree op1,
 151                                          bool *);
 152 extern bool tree_single_nonzero_warnv_p (tree, bool *);
 153 extern bool tree_unary_nonnegative_warnv_p (enum tree_code, tree, tree,
 154                                             bool *, int);
 155 extern bool tree_binary_nonnegative_warnv_p (enum tree_code, tree, tree, tree,
 156                                              bool *, int);
 157 extern bool tree_single_nonnegative_warnv_p (tree, bool *, int);
 158 extern bool tree_call_nonnegative_warnv_p (tree, combined_fn, tree, tree,
 159                                            bool *, int);
 160
 161 extern bool integer_valued_real_unary_p (tree_code, tree, int);
 162 extern bool integer_valued_real_binary_p (tree_code, tree, tree, int);
 163 extern bool integer_valued_real_call_p (combined_fn, tree, tree, int);
 164 extern bool integer_valued_real_single_p (tree, int);
 165 extern bool integer_valued_real_p (tree, int = 0);
 166
 167 extern bool fold_real_zero_addition_p (const_tree, const_tree, const_tree,
 168                                        int);
 169 extern tree combine_comparisons (location_t, enum tree_code, enum tree_code,
 170                                  enum tree_code, tree, tree, tree);
 171 extern void debug_fold_checksum (const_tree);
 172 extern bool may_negate_without_overflow_p (const_tree);
 173 #define round_up(T,N) round_up_loc (UNKNOWN_LOCATION, T, N)
 174 extern tree round_up_loc (location_t, tree, unsigned int);
 175 #define round_down(T,N) round_down_loc (UNKNOWN_LOCATION, T, N)
 176 extern tree round_down_loc (location_t, tree, int);
 177 extern tree size_int_kind (poly_int64, enum size_type_kind);
 178 #define size_binop(CODE,T1,T2)\
 179    size_binop_loc (UNKNOWN_LOCATION, CODE, T1, T2)
 180 extern 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)
 183 extern 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)
 187 extern tree non_lvalue_loc (location_t, tree);
 188
 189 extern bool tree_expr_nonzero_p (tree);
 190 extern bool tree_expr_nonnegative_p (tree);
 191 extern bool tree_expr_nonnegative_warnv_p (tree, bool *, int = 0);
 192 extern bool tree_expr_finite_p (const_tree);
 193 extern bool tree_expr_infinite_p (const_tree);
 194 extern bool tree_expr_maybe_infinite_p (const_tree);
 195 extern bool tree_expr_signaling_nan_p (const_tree);
 196 extern bool tree_expr_maybe_signaling_nan_p (const_tree);
 197 extern bool tree_expr_nan_p (const_tree);
 198 extern bool tree_expr_maybe_nan_p (const_tree);
 199 extern bool tree_expr_maybe_real_minus_zero_p (const_tree);
 200 extern tree make_range (tree, int *, tree *, tree *, bool *);
 201 extern tree make_range_step (location_t, enum tree_code, tree, tree, tree,
 202                              tree *, tree *, int *, bool *);
 203 extern tree range_check_type (tree);
 204 extern tree build_range_check (location_t, tree, tree, int, tree, tree);
 205 extern bool merge_ranges (int *, tree *, tree *, int, tree, tree, int,
 206                           tree, tree);
 207 extern tree sign_bit_p (tree, const_tree);
 208 extern tree exact_inverse (tree, tree);
 209 extern bool expr_not_equal_to (tree t, const wide_int &);
 210 extern tree const_unop (enum tree_code, tree, tree);
 211 extern tree const_binop (enum tree_code, tree, tree, tree);
 212 extern bool negate_mathfn_p (combined_fn);
 213 extern const char *getbyterep (tree, unsigned HOST_WIDE_INT *);
 214 extern const char *c_getstr (tree);
 215 extern wide_int tree_nonzero_bits (const_tree);
 216
 217 /* Return OFF converted to a pointer offset type suitable as offset for
 218    POINTER_PLUS_EXPR.  Use location LOC for this conversion.  */
 219 extern 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.  */
 224 extern 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.  */
 230 extern 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)
 234
 235
 236 /* Class used to compare gimple operands.  */
 237
 238 class operand_compare
 239 {
 240 public:
 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
 249 protected:
 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
 257 #endif // GCC_FOLD_CONST_H