1 /* Operations with long integers.
2 Copyright (C) 2006, 2007, 2008, 2010 Free Software Foundation, Inc.
4 This file is part of GCC.
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
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
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/>. */
23 #ifndef GENERATOR_FILE
26 #include "coretypes.h"
28 /* A large integer is currently represented as a pair of HOST_WIDE_INTs.
29 It therefore represents a number with precision of
30 2 * HOST_BITS_PER_WIDE_INT bits (it is however possible that the
31 internal representation will change, if numbers with greater precision
32 are needed, so the users should not rely on it). The representation does
33 not contain any information about signedness of the represented value, so
34 it can be used to represent both signed and unsigned numbers. For
35 operations where the results depend on signedness (division, comparisons),
36 it must be specified separately. For each such operation, there are three
37 versions of the function -- double_int_op, that takes an extra UNS argument
38 giving the signedness of the values, and double_int_sop and double_int_uop
39 that stand for its specializations for signed and unsigned values.
41 You may also represent with numbers in smaller precision using double_int.
42 You however need to use double_int_ext (that fills in the bits of the
43 number over the prescribed precision with zeros or with the sign bit) before
44 operations that do not perform arithmetics modulo 2^precision (comparisons,
45 division), and possibly before storing the results, if you want to keep
46 them in some canonical form). In general, the signedness of double_int_ext
47 should match the signedness of the operation.
49 ??? The components of double_int differ in signedness mostly for
50 historical reasons (they replace an older structure used to represent
51 numbers with precision higher than HOST_WIDE_INT). It might be less
52 confusing to have them both signed or both unsigned. */
56 unsigned HOST_WIDE_INT low
;
60 #define HOST_BITS_PER_DOUBLE_INT (2 * HOST_BITS_PER_WIDE_INT)
62 /* Constructors and conversions. */
64 /* Constructs double_int from integer CST. The bits over the precision of
65 HOST_WIDE_INT are filled with the sign bit. */
67 static inline double_int
68 shwi_to_double_int (HOST_WIDE_INT cst
)
72 r
.low
= (unsigned HOST_WIDE_INT
) cst
;
73 r
.high
= cst
< 0 ? -1 : 0;
78 /* Some useful constants. */
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))
86 /* Constructs double_int from unsigned integer CST. The bits over the
87 precision of HOST_WIDE_INT are filled with zeros. */
89 static inline double_int
90 uhwi_to_double_int (unsigned HOST_WIDE_INT cst
)
100 /* Returns value of CST as a signed number. CST must satisfy
101 double_int_fits_in_shwi_p. */
103 static inline HOST_WIDE_INT
104 double_int_to_shwi (double_int cst
)
106 return (HOST_WIDE_INT
) cst
.low
;
109 /* Returns value of CST as an unsigned number. CST must satisfy
110 double_int_fits_in_uhwi_p. */
112 static inline unsigned HOST_WIDE_INT
113 double_int_to_uhwi (double_int cst
)
118 bool double_int_fits_in_hwi_p (double_int
, bool);
119 bool double_int_fits_in_shwi_p (double_int
);
121 /* Returns true if CST fits in unsigned HOST_WIDE_INT. */
124 double_int_fits_in_uhwi_p (double_int cst
)
126 return cst
.high
== 0;
129 /* The following operations perform arithmetics modulo 2^precision,
130 so you do not need to call double_int_ext between them, even if
131 you are representing numbers with precision less than
132 2 * HOST_BITS_PER_WIDE_INT bits. */
134 double_int
double_int_mul (double_int
, double_int
);
135 double_int
double_int_add (double_int
, double_int
);
136 double_int
double_int_sub (double_int
, double_int
);
137 double_int
double_int_neg (double_int
);
139 /* You must ensure that double_int_ext is called on the operands
140 of the following operations, if the precision of the numbers
141 is less than 2 * HOST_BITS_PER_WIDE_INT bits. */
142 double_int
double_int_div (double_int
, double_int
, bool, unsigned);
143 double_int
double_int_sdiv (double_int
, double_int
, unsigned);
144 double_int
double_int_udiv (double_int
, double_int
, unsigned);
145 double_int
double_int_mod (double_int
, double_int
, bool, unsigned);
146 double_int
double_int_smod (double_int
, double_int
, unsigned);
147 double_int
double_int_umod (double_int
, double_int
, unsigned);
148 double_int
double_int_divmod (double_int
, double_int
, bool, unsigned, double_int
*);
149 double_int
double_int_sdivmod (double_int
, double_int
, unsigned, double_int
*);
150 double_int
double_int_udivmod (double_int
, double_int
, unsigned, double_int
*);
151 double_int
double_int_setbit (double_int
, unsigned);
153 /* Logical operations. */
157 static inline double_int
158 double_int_not (double_int a
)
167 static inline double_int
168 double_int_ior (double_int a
, double_int b
)
177 static inline double_int
178 double_int_and (double_int a
, double_int b
)
185 /* Returns A & ~B. */
187 static inline double_int
188 double_int_and_not (double_int a
, double_int b
)
197 static inline double_int
198 double_int_xor (double_int a
, double_int b
)
206 /* Shift operations. */
207 double_int
double_int_lshift (double_int
, HOST_WIDE_INT
, unsigned int, bool);
208 double_int
double_int_rshift (double_int
, HOST_WIDE_INT
, unsigned int, bool);
209 double_int
double_int_lrotate (double_int
, HOST_WIDE_INT
, unsigned int);
210 double_int
double_int_rrotate (double_int
, HOST_WIDE_INT
, unsigned int);
212 /* Returns true if CST is negative. Of course, CST is considered to
216 double_int_negative_p (double_int cst
)
221 int double_int_cmp (double_int
, double_int
, bool);
222 int double_int_scmp (double_int
, double_int
);
223 int double_int_ucmp (double_int
, double_int
);
225 double_int
double_int_max (double_int
, double_int
, bool);
226 double_int
double_int_smax (double_int
, double_int
);
227 double_int
double_int_umax (double_int
, double_int
);
229 double_int
double_int_min (double_int
, double_int
, bool);
230 double_int
double_int_smin (double_int
, double_int
);
231 double_int
double_int_umin (double_int
, double_int
);
233 void dump_double_int (FILE *, double_int
, bool);
235 /* Zero and sign extension of numbers in smaller precisions. */
237 double_int
double_int_ext (double_int
, unsigned, bool);
238 double_int
double_int_sext (double_int
, unsigned);
239 double_int
double_int_zext (double_int
, unsigned);
240 double_int
double_int_mask (unsigned);
242 #define ALL_ONES (~((unsigned HOST_WIDE_INT) 0))
244 /* The operands of the following comparison functions must be processed
245 with double_int_ext, if their precision is less than
246 2 * HOST_BITS_PER_WIDE_INT bits. */
248 /* Returns true if CST is zero. */
251 double_int_zero_p (double_int cst
)
253 return cst
.low
== 0 && cst
.high
== 0;
256 /* Returns true if CST is one. */
259 double_int_one_p (double_int cst
)
261 return cst
.low
== 1 && cst
.high
== 0;
264 /* Returns true if CST is minus one. */
267 double_int_minus_one_p (double_int cst
)
269 return (cst
.low
== ALL_ONES
&& cst
.high
== -1);
272 /* Returns true if CST1 == CST2. */
275 double_int_equal_p (double_int cst1
, double_int cst2
)
277 return cst1
.low
== cst2
.low
&& cst1
.high
== cst2
.high
;
281 /* Legacy interface with decomposed high/low parts. */
283 extern int add_double_with_sign (unsigned HOST_WIDE_INT
, HOST_WIDE_INT
,
284 unsigned HOST_WIDE_INT
, HOST_WIDE_INT
,
285 unsigned HOST_WIDE_INT
*, HOST_WIDE_INT
*,
287 #define add_double(l1,h1,l2,h2,lv,hv) \
288 add_double_with_sign (l1, h1, l2, h2, lv, hv, false)
289 extern int neg_double (unsigned HOST_WIDE_INT
, HOST_WIDE_INT
,
290 unsigned HOST_WIDE_INT
*, HOST_WIDE_INT
*);
291 extern int mul_double_with_sign (unsigned HOST_WIDE_INT
, HOST_WIDE_INT
,
292 unsigned HOST_WIDE_INT
, HOST_WIDE_INT
,
293 unsigned HOST_WIDE_INT
*, HOST_WIDE_INT
*,
295 #define mul_double(l1,h1,l2,h2,lv,hv) \
296 mul_double_with_sign (l1, h1, l2, h2, lv, hv, false)
297 extern void lshift_double (unsigned HOST_WIDE_INT
, HOST_WIDE_INT
,
298 HOST_WIDE_INT
, unsigned int,
299 unsigned HOST_WIDE_INT
*, HOST_WIDE_INT
*, bool);
300 extern void rshift_double (unsigned HOST_WIDE_INT
, HOST_WIDE_INT
,
301 HOST_WIDE_INT
, unsigned int,
302 unsigned HOST_WIDE_INT
*, HOST_WIDE_INT
*, bool);
303 extern int div_and_round_double (unsigned, int, unsigned HOST_WIDE_INT
,
304 HOST_WIDE_INT
, unsigned HOST_WIDE_INT
,
305 HOST_WIDE_INT
, unsigned HOST_WIDE_INT
*,
306 HOST_WIDE_INT
*, unsigned HOST_WIDE_INT
*,
310 #ifndef GENERATOR_FILE
311 /* Conversion to and from GMP integer representations. */
313 void mpz_set_double_int (mpz_t
, double_int
, bool);
314 double_int
mpz_get_double_int (const_tree
, mpz_t
, bool);
317 #endif /* DOUBLE_INT_H */