gcc/tree-affine.h

   1 /* Operations with affine combinations of trees.
   2    Copyright (C) 2005-2014 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
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 3, or (at your option) any
   9 later version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT
  12 ANY 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 /* Affine combination of trees.  We keep track of at most MAX_AFF_ELTS elements
  21    to make things simpler; this is sufficient in most cases.  */
  22
  23 #include "hash-map.h"
  24 #include "wide-int.h"
  25
  26 #define MAX_AFF_ELTS 8
  27
  28 /* Element of an affine combination.  */
  29
  30 struct aff_comb_elt
  31 {
  32   /* The value of the element.  */
  33   tree val;
  34
  35   /* Its coefficient in the combination.  */
  36   widest_int coef;
  37 };
  38
  39 struct aff_tree
  40 {
  41   /* Type of the result of the combination.  */
  42   tree type;
  43
  44   /* Constant offset.  */
  45   widest_int offset;
  46
  47   /* Number of elements of the combination.  */
  48   unsigned n;
  49
  50   /* Elements and their coefficients.  Type of elements may be different from
  51      TYPE, but their sizes must be the same (STRIP_NOPS is applied to the
  52      elements).
  53
  54      The coefficients are always sign extended from the precision of TYPE
  55      (regardless of signedness of TYPE).  */
  56   struct aff_comb_elt elts[MAX_AFF_ELTS];
  57
  58   /* Remainder of the expression.  Usually NULL, used only if there are more
  59      than MAX_AFF_ELTS elements.  Type of REST will be either sizetype for
  60      TYPE of POINTER_TYPEs or TYPE.  */
  61   tree rest;
  62 };
  63
  64 struct name_expansion;
  65
  66 widest_int wide_int_ext_for_comb (const widest_int &, aff_tree *);
  67 void aff_combination_const (aff_tree *, tree, const widest_int &);
  68 void aff_combination_elt (aff_tree *, tree, tree);
  69 void aff_combination_scale (aff_tree *, const widest_int &);
  70 void aff_combination_mult (aff_tree *, aff_tree *, aff_tree *);
  71 void aff_combination_add (aff_tree *, aff_tree *);
  72 void aff_combination_add_elt (aff_tree *, tree, const widest_int &);
  73 void aff_combination_remove_elt (aff_tree *, unsigned);
  74 void aff_combination_convert (aff_tree *, tree);
  75 void tree_to_aff_combination (tree, tree, aff_tree *);
  76 tree aff_combination_to_tree (aff_tree *);
  77 void unshare_aff_combination (aff_tree *);
  78 bool aff_combination_constant_multiple_p (aff_tree *, aff_tree *, widest_int *);
  79 void aff_combination_expand (aff_tree *, hash_map<tree, name_expansion *> **);
  80 void tree_to_aff_combination_expand (tree, tree, aff_tree *,
  81                                      hash_map<tree, name_expansion *> **);
  82 tree get_inner_reference_aff (tree, aff_tree *, widest_int *);
  83 void free_affine_expand_cache (hash_map<tree, name_expansion *> **);
  84 bool aff_comb_cannot_overlap_p (aff_tree *, const widest_int &,
  85                                 const widest_int &);
  86
  87 /* Debugging functions.  */
  88 void debug_aff (aff_tree *);
  89
  90 /* Return true if AFF is actually ZERO.  */
  91 static inline bool
  92 aff_combination_zero_p (aff_tree *aff)
  93 {
  94   if (!aff)
  95     return true;
  96
  97   if (aff->n == 0 && aff->offset == 0)
  98     return true;
  99
 100   return false;
 101 }