gcc/double-int.h

   1 /* Operations with long integers.
   2    Copyright (C) 2006 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 2, 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 COPYING.  If not, write to the Free
  18 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301, USA.  */
  20
  21 #ifndef DOUBLE_INT_H
  22 #define DOUBLE_INT_H
  23
  24 /* A large integer is currently represented as a pair of HOST_WIDE_INTs.
  25    It therefore represents a number with precision of
  26    2 * HOST_BITS_PER_WIDE_INT bits (it is however possible that the
  27    internal representation will change, if numbers with greater precision
  28    are needed, so the users should not rely on it).  The representation does
  29    not contain any information about signedness of the represented value, so
  30    it can be used to represent both signed and unsigned numbers.  For
  31    operations where the results depend on signedness (division, comparisons),
  32    it must be specified separately.  For each such operation, there are three
  33    versions of the function -- double_int_op, that takes an extra UNS argument
  34    giving the signedness of the values, and double_int_sop and double_int_uop
  35    that stand for its specializations for signed and unsigned values.
  36
  37    You may also represent with numbers in smaller precision using double_int.
  38    You however need to use double_int_ext (that fills in the bits of the
  39    number over the prescribed precision with zeros or with the sign bit) before
  40    operations that do not perform arithmetics modulo 2^precision (comparisons,
  41    division), and possibly before storing the results, if you want to keep
  42    them in some canonical form).  In general, the signedness of double_int_ext
  43    should match the signedness of the operation.
  44
  45    ??? The components of double_int differ in signedness mostly for
  46    historical reasons (they replace an older structure used to represent
  47    numbers with precision higher than HOST_WIDE_INT).  It might be less
  48    confusing to have them both signed or both unsigned.  */
  49
  50 typedef struct
  51 {
  52   unsigned HOST_WIDE_INT low;
  53   HOST_WIDE_INT high;
  54 } double_int;
  55
  56 union tree_node;
  57
  58 /* Constructors and conversions.  */
  59
  60 union tree_node *double_int_to_tree (union tree_node *, double_int);
  61 bool double_int_fits_to_tree_p (union tree_node *, double_int);
  62 double_int tree_to_double_int (union tree_node *);
  63
  64 /* Constructs double_int from integer CST.  The bits over the precision of
  65    HOST_WIDE_INT are filled with the sign bit.  */
  66
  67 static inline double_int
  68 shwi_to_double_int (HOST_WIDE_INT cst)
  69 {
  70   double_int r;
  71
  72   r.low = (unsigned HOST_WIDE_INT) cst;
  73   r.high = cst < 0 ? -1 : 0;
  74
  75   return r;
  76 }
  77
  78 /* Some useful constants.  */
  79
  80 #define double_int_minus_one (shwi_to_double_int (-1))
  81 #define double_int_zero (shwi_to_double_int (0))
  82 #define double_int_one (shwi_to_double_int (1))
  83 #define double_int_two (shwi_to_double_int (2))
  84 #define double_int_ten (shwi_to_double_int (10))
  85
  86 /* Constructs double_int from unsigned integer CST.  The bits over the
  87    precision of HOST_WIDE_INT are filled with zeros.  */
  88
  89 static inline double_int
  90 uhwi_to_double_int (unsigned HOST_WIDE_INT cst)
  91 {
  92   double_int r;
  93
  94   r.low = cst;
  95   r.high = 0;
  96
  97   return r;
  98 }
  99
 100 /* The following operations perform arithmetics modulo 2^precision,
 101    so you do not need to call double_int_ext between them, even if
 102    you are representing numbers with precision less than
 103    2 * HOST_BITS_PER_WIDE_INT bits.  */
 104
 105 double_int double_int_mul (double_int, double_int);
 106 double_int double_int_add (double_int, double_int);
 107 double_int double_int_neg (double_int);
 108
 109 /* You must ensure that double_int_ext is called on the operands
 110    of the following operations, if the precision of the numbers
 111    is less than 2 * HOST_BITS_PER_WIDE_INT bits.  */
 112 bool double_int_fits_in_hwi_p (double_int, bool);
 113 bool double_int_fits_in_shwi_p (double_int);
 114 bool double_int_fits_in_uhwi_p (double_int);
 115 HOST_WIDE_INT double_int_to_shwi (double_int);
 116 unsigned HOST_WIDE_INT double_int_to_uhwi (double_int);
 117 double_int double_int_div (double_int, double_int, bool, unsigned);
 118 double_int double_int_sdiv (double_int, double_int, unsigned);
 119 double_int double_int_udiv (double_int, double_int, unsigned);
 120 double_int double_int_mod (double_int, double_int, bool, unsigned);
 121 double_int double_int_smod (double_int, double_int, unsigned);
 122 double_int double_int_umod (double_int, double_int, unsigned);
 123 double_int double_int_divmod (double_int, double_int, bool, unsigned, double_int *);
 124 double_int double_int_sdivmod (double_int, double_int, unsigned, double_int *);
 125 double_int double_int_udivmod (double_int, double_int, unsigned, double_int *);
 126 bool double_int_negative_p (double_int);
 127 int double_int_cmp (double_int, double_int, bool);
 128 int double_int_scmp (double_int, double_int);
 129 int double_int_ucmp (double_int, double_int);
 130 void dump_double_int (FILE *, double_int, bool);
 131
 132 /* Zero and sign extension of numbers in smaller precisions.  */
 133
 134 double_int double_int_ext (double_int, unsigned, bool);
 135 double_int double_int_sext (double_int, unsigned);
 136 double_int double_int_zext (double_int, unsigned);
 137
 138 #define ALL_ONES (~((unsigned HOST_WIDE_INT) 0))
 139
 140 /* The operands of the following comparison functions must be processed
 141    with double_int_ext, if their precision is less than
 142    2 * HOST_BITS_PER_WIDE_INT bits.  */
 143
 144 /* Returns true if CST is zero.  */
 145
 146 static inline bool
 147 double_int_zero_p (double_int cst)
 148 {
 149   return cst.low == 0 && cst.high == 0;
 150 }
 151
 152 /* Returns true if CST is one.  */
 153
 154 static inline bool
 155 double_int_one_p (double_int cst)
 156 {
 157   return cst.low == 1 && cst.high == 0;
 158 }
 159
 160 /* Returns true if CST is minus one.  */
 161
 162 static inline bool
 163 double_int_minus_one_p (double_int cst)
 164 {
 165   return (cst.low == ALL_ONES && cst.high == -1);
 166 }
 167
 168 /* Returns true if CST1 == CST2.  */
 169
 170 static inline bool
 171 double_int_equal_p (double_int cst1, double_int cst2)
 172 {
 173   return cst1.low == cst2.low && cst1.high == cst2.high;
 174 }
 175
 176 #endif /* DOUBLE_INT_H */