1*e4b17023SJohn Marino /* Operations with long integers.
2*e4b17023SJohn Marino Copyright (C) 2006, 2007, 2008, 2010 Free Software Foundation, Inc.
3*e4b17023SJohn Marino
4*e4b17023SJohn Marino This file is part of GCC.
5*e4b17023SJohn Marino
6*e4b17023SJohn Marino GCC is free software; you can redistribute it and/or modify it
7*e4b17023SJohn Marino under the terms of the GNU General Public License as published by the
8*e4b17023SJohn Marino Free Software Foundation; either version 3, or (at your option) any
9*e4b17023SJohn Marino later version.
10*e4b17023SJohn Marino
11*e4b17023SJohn Marino GCC is distributed in the hope that it will be useful, but WITHOUT
12*e4b17023SJohn Marino ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13*e4b17023SJohn Marino FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14*e4b17023SJohn Marino for more details.
15*e4b17023SJohn Marino
16*e4b17023SJohn Marino You should have received a copy of the GNU General Public License
17*e4b17023SJohn Marino along with GCC; see the file COPYING3. If not see
18*e4b17023SJohn Marino <http://www.gnu.org/licenses/>. */
19*e4b17023SJohn Marino
20*e4b17023SJohn Marino #ifndef DOUBLE_INT_H
21*e4b17023SJohn Marino #define DOUBLE_INT_H
22*e4b17023SJohn Marino
23*e4b17023SJohn Marino #ifndef GENERATOR_FILE
24*e4b17023SJohn Marino #include <gmp.h>
25*e4b17023SJohn Marino #endif
26*e4b17023SJohn Marino #include "coretypes.h"
27*e4b17023SJohn Marino
28*e4b17023SJohn Marino /* A large integer is currently represented as a pair of HOST_WIDE_INTs.
29*e4b17023SJohn Marino It therefore represents a number with precision of
30*e4b17023SJohn Marino 2 * HOST_BITS_PER_WIDE_INT bits (it is however possible that the
31*e4b17023SJohn Marino internal representation will change, if numbers with greater precision
32*e4b17023SJohn Marino are needed, so the users should not rely on it). The representation does
33*e4b17023SJohn Marino not contain any information about signedness of the represented value, so
34*e4b17023SJohn Marino it can be used to represent both signed and unsigned numbers. For
35*e4b17023SJohn Marino operations where the results depend on signedness (division, comparisons),
36*e4b17023SJohn Marino it must be specified separately. For each such operation, there are three
37*e4b17023SJohn Marino versions of the function -- double_int_op, that takes an extra UNS argument
38*e4b17023SJohn Marino giving the signedness of the values, and double_int_sop and double_int_uop
39*e4b17023SJohn Marino that stand for its specializations for signed and unsigned values.
40*e4b17023SJohn Marino
41*e4b17023SJohn Marino You may also represent with numbers in smaller precision using double_int.
42*e4b17023SJohn Marino You however need to use double_int_ext (that fills in the bits of the
43*e4b17023SJohn Marino number over the prescribed precision with zeros or with the sign bit) before
44*e4b17023SJohn Marino operations that do not perform arithmetics modulo 2^precision (comparisons,
45*e4b17023SJohn Marino division), and possibly before storing the results, if you want to keep
46*e4b17023SJohn Marino them in some canonical form). In general, the signedness of double_int_ext
47*e4b17023SJohn Marino should match the signedness of the operation.
48*e4b17023SJohn Marino
49*e4b17023SJohn Marino ??? The components of double_int differ in signedness mostly for
50*e4b17023SJohn Marino historical reasons (they replace an older structure used to represent
51*e4b17023SJohn Marino numbers with precision higher than HOST_WIDE_INT). It might be less
52*e4b17023SJohn Marino confusing to have them both signed or both unsigned. */
53*e4b17023SJohn Marino
54*e4b17023SJohn Marino typedef struct
55*e4b17023SJohn Marino {
56*e4b17023SJohn Marino unsigned HOST_WIDE_INT low;
57*e4b17023SJohn Marino HOST_WIDE_INT high;
58*e4b17023SJohn Marino } double_int;
59*e4b17023SJohn Marino
60*e4b17023SJohn Marino #define HOST_BITS_PER_DOUBLE_INT (2 * HOST_BITS_PER_WIDE_INT)
61*e4b17023SJohn Marino
62*e4b17023SJohn Marino /* Constructors and conversions. */
63*e4b17023SJohn Marino
64*e4b17023SJohn Marino /* Constructs double_int from integer CST. The bits over the precision of
65*e4b17023SJohn Marino HOST_WIDE_INT are filled with the sign bit. */
66*e4b17023SJohn Marino
67*e4b17023SJohn Marino static inline double_int
shwi_to_double_int(HOST_WIDE_INT cst)68*e4b17023SJohn Marino shwi_to_double_int (HOST_WIDE_INT cst)
69*e4b17023SJohn Marino {
70*e4b17023SJohn Marino double_int r;
71*e4b17023SJohn Marino
72*e4b17023SJohn Marino r.low = (unsigned HOST_WIDE_INT) cst;
73*e4b17023SJohn Marino r.high = cst < 0 ? -1 : 0;
74*e4b17023SJohn Marino
75*e4b17023SJohn Marino return r;
76*e4b17023SJohn Marino }
77*e4b17023SJohn Marino
78*e4b17023SJohn Marino /* Some useful constants. */
79*e4b17023SJohn Marino
80*e4b17023SJohn Marino #define double_int_minus_one (shwi_to_double_int (-1))
81*e4b17023SJohn Marino #define double_int_zero (shwi_to_double_int (0))
82*e4b17023SJohn Marino #define double_int_one (shwi_to_double_int (1))
83*e4b17023SJohn Marino #define double_int_two (shwi_to_double_int (2))
84*e4b17023SJohn Marino #define double_int_ten (shwi_to_double_int (10))
85*e4b17023SJohn Marino
86*e4b17023SJohn Marino /* Constructs double_int from unsigned integer CST. The bits over the
87*e4b17023SJohn Marino precision of HOST_WIDE_INT are filled with zeros. */
88*e4b17023SJohn Marino
89*e4b17023SJohn Marino static inline double_int
uhwi_to_double_int(unsigned HOST_WIDE_INT cst)90*e4b17023SJohn Marino uhwi_to_double_int (unsigned HOST_WIDE_INT cst)
91*e4b17023SJohn Marino {
92*e4b17023SJohn Marino double_int r;
93*e4b17023SJohn Marino
94*e4b17023SJohn Marino r.low = cst;
95*e4b17023SJohn Marino r.high = 0;
96*e4b17023SJohn Marino
97*e4b17023SJohn Marino return r;
98*e4b17023SJohn Marino }
99*e4b17023SJohn Marino
100*e4b17023SJohn Marino /* Returns value of CST as a signed number. CST must satisfy
101*e4b17023SJohn Marino double_int_fits_in_shwi_p. */
102*e4b17023SJohn Marino
103*e4b17023SJohn Marino static inline HOST_WIDE_INT
double_int_to_shwi(double_int cst)104*e4b17023SJohn Marino double_int_to_shwi (double_int cst)
105*e4b17023SJohn Marino {
106*e4b17023SJohn Marino return (HOST_WIDE_INT) cst.low;
107*e4b17023SJohn Marino }
108*e4b17023SJohn Marino
109*e4b17023SJohn Marino /* Returns value of CST as an unsigned number. CST must satisfy
110*e4b17023SJohn Marino double_int_fits_in_uhwi_p. */
111*e4b17023SJohn Marino
112*e4b17023SJohn Marino static inline unsigned HOST_WIDE_INT
double_int_to_uhwi(double_int cst)113*e4b17023SJohn Marino double_int_to_uhwi (double_int cst)
114*e4b17023SJohn Marino {
115*e4b17023SJohn Marino return cst.low;
116*e4b17023SJohn Marino }
117*e4b17023SJohn Marino
118*e4b17023SJohn Marino bool double_int_fits_in_hwi_p (double_int, bool);
119*e4b17023SJohn Marino bool double_int_fits_in_shwi_p (double_int);
120*e4b17023SJohn Marino
121*e4b17023SJohn Marino /* Returns true if CST fits in unsigned HOST_WIDE_INT. */
122*e4b17023SJohn Marino
123*e4b17023SJohn Marino static inline bool
double_int_fits_in_uhwi_p(double_int cst)124*e4b17023SJohn Marino double_int_fits_in_uhwi_p (double_int cst)
125*e4b17023SJohn Marino {
126*e4b17023SJohn Marino return cst.high == 0;
127*e4b17023SJohn Marino }
128*e4b17023SJohn Marino
129*e4b17023SJohn Marino /* The following operations perform arithmetics modulo 2^precision,
130*e4b17023SJohn Marino so you do not need to call double_int_ext between them, even if
131*e4b17023SJohn Marino you are representing numbers with precision less than
132*e4b17023SJohn Marino 2 * HOST_BITS_PER_WIDE_INT bits. */
133*e4b17023SJohn Marino
134*e4b17023SJohn Marino double_int double_int_mul (double_int, double_int);
135*e4b17023SJohn Marino double_int double_int_mul_with_sign (double_int, double_int, bool, int *);
136*e4b17023SJohn Marino double_int double_int_add (double_int, double_int);
137*e4b17023SJohn Marino double_int double_int_sub (double_int, double_int);
138*e4b17023SJohn Marino double_int double_int_neg (double_int);
139*e4b17023SJohn Marino
140*e4b17023SJohn Marino /* You must ensure that double_int_ext is called on the operands
141*e4b17023SJohn Marino of the following operations, if the precision of the numbers
142*e4b17023SJohn Marino is less than 2 * HOST_BITS_PER_WIDE_INT bits. */
143*e4b17023SJohn Marino double_int double_int_div (double_int, double_int, bool, unsigned);
144*e4b17023SJohn Marino double_int double_int_sdiv (double_int, double_int, unsigned);
145*e4b17023SJohn Marino double_int double_int_udiv (double_int, double_int, unsigned);
146*e4b17023SJohn Marino double_int double_int_mod (double_int, double_int, bool, unsigned);
147*e4b17023SJohn Marino double_int double_int_smod (double_int, double_int, unsigned);
148*e4b17023SJohn Marino double_int double_int_umod (double_int, double_int, unsigned);
149*e4b17023SJohn Marino double_int double_int_divmod (double_int, double_int, bool, unsigned, double_int *);
150*e4b17023SJohn Marino double_int double_int_sdivmod (double_int, double_int, unsigned, double_int *);
151*e4b17023SJohn Marino double_int double_int_udivmod (double_int, double_int, unsigned, double_int *);
152*e4b17023SJohn Marino
153*e4b17023SJohn Marino double_int double_int_setbit (double_int, unsigned);
154*e4b17023SJohn Marino int double_int_ctz (double_int);
155*e4b17023SJohn Marino
156*e4b17023SJohn Marino /* Logical operations. */
157*e4b17023SJohn Marino
158*e4b17023SJohn Marino /* Returns ~A. */
159*e4b17023SJohn Marino
160*e4b17023SJohn Marino static inline double_int
double_int_not(double_int a)161*e4b17023SJohn Marino double_int_not (double_int a)
162*e4b17023SJohn Marino {
163*e4b17023SJohn Marino a.low = ~a.low;
164*e4b17023SJohn Marino a.high = ~a.high;
165*e4b17023SJohn Marino return a;
166*e4b17023SJohn Marino }
167*e4b17023SJohn Marino
168*e4b17023SJohn Marino /* Returns A | B. */
169*e4b17023SJohn Marino
170*e4b17023SJohn Marino static inline double_int
double_int_ior(double_int a,double_int b)171*e4b17023SJohn Marino double_int_ior (double_int a, double_int b)
172*e4b17023SJohn Marino {
173*e4b17023SJohn Marino a.low |= b.low;
174*e4b17023SJohn Marino a.high |= b.high;
175*e4b17023SJohn Marino return a;
176*e4b17023SJohn Marino }
177*e4b17023SJohn Marino
178*e4b17023SJohn Marino /* Returns A & B. */
179*e4b17023SJohn Marino
180*e4b17023SJohn Marino static inline double_int
double_int_and(double_int a,double_int b)181*e4b17023SJohn Marino double_int_and (double_int a, double_int b)
182*e4b17023SJohn Marino {
183*e4b17023SJohn Marino a.low &= b.low;
184*e4b17023SJohn Marino a.high &= b.high;
185*e4b17023SJohn Marino return a;
186*e4b17023SJohn Marino }
187*e4b17023SJohn Marino
188*e4b17023SJohn Marino /* Returns A & ~B. */
189*e4b17023SJohn Marino
190*e4b17023SJohn Marino static inline double_int
double_int_and_not(double_int a,double_int b)191*e4b17023SJohn Marino double_int_and_not (double_int a, double_int b)
192*e4b17023SJohn Marino {
193*e4b17023SJohn Marino a.low &= ~b.low;
194*e4b17023SJohn Marino a.high &= ~b.high;
195*e4b17023SJohn Marino return a;
196*e4b17023SJohn Marino }
197*e4b17023SJohn Marino
198*e4b17023SJohn Marino /* Returns A ^ B. */
199*e4b17023SJohn Marino
200*e4b17023SJohn Marino static inline double_int
double_int_xor(double_int a,double_int b)201*e4b17023SJohn Marino double_int_xor (double_int a, double_int b)
202*e4b17023SJohn Marino {
203*e4b17023SJohn Marino a.low ^= b.low;
204*e4b17023SJohn Marino a.high ^= b.high;
205*e4b17023SJohn Marino return a;
206*e4b17023SJohn Marino }
207*e4b17023SJohn Marino
208*e4b17023SJohn Marino
209*e4b17023SJohn Marino /* Shift operations. */
210*e4b17023SJohn Marino double_int double_int_lshift (double_int, HOST_WIDE_INT, unsigned int, bool);
211*e4b17023SJohn Marino double_int double_int_rshift (double_int, HOST_WIDE_INT, unsigned int, bool);
212*e4b17023SJohn Marino double_int double_int_lrotate (double_int, HOST_WIDE_INT, unsigned int);
213*e4b17023SJohn Marino double_int double_int_rrotate (double_int, HOST_WIDE_INT, unsigned int);
214*e4b17023SJohn Marino
215*e4b17023SJohn Marino /* Returns true if CST is negative. Of course, CST is considered to
216*e4b17023SJohn Marino be signed. */
217*e4b17023SJohn Marino
218*e4b17023SJohn Marino static inline bool
double_int_negative_p(double_int cst)219*e4b17023SJohn Marino double_int_negative_p (double_int cst)
220*e4b17023SJohn Marino {
221*e4b17023SJohn Marino return cst.high < 0;
222*e4b17023SJohn Marino }
223*e4b17023SJohn Marino
224*e4b17023SJohn Marino int double_int_cmp (double_int, double_int, bool);
225*e4b17023SJohn Marino int double_int_scmp (double_int, double_int);
226*e4b17023SJohn Marino int double_int_ucmp (double_int, double_int);
227*e4b17023SJohn Marino
228*e4b17023SJohn Marino double_int double_int_max (double_int, double_int, bool);
229*e4b17023SJohn Marino double_int double_int_smax (double_int, double_int);
230*e4b17023SJohn Marino double_int double_int_umax (double_int, double_int);
231*e4b17023SJohn Marino
232*e4b17023SJohn Marino double_int double_int_min (double_int, double_int, bool);
233*e4b17023SJohn Marino double_int double_int_smin (double_int, double_int);
234*e4b17023SJohn Marino double_int double_int_umin (double_int, double_int);
235*e4b17023SJohn Marino
236*e4b17023SJohn Marino void dump_double_int (FILE *, double_int, bool);
237*e4b17023SJohn Marino
238*e4b17023SJohn Marino /* Zero and sign extension of numbers in smaller precisions. */
239*e4b17023SJohn Marino
240*e4b17023SJohn Marino double_int double_int_ext (double_int, unsigned, bool);
241*e4b17023SJohn Marino double_int double_int_sext (double_int, unsigned);
242*e4b17023SJohn Marino double_int double_int_zext (double_int, unsigned);
243*e4b17023SJohn Marino double_int double_int_mask (unsigned);
244*e4b17023SJohn Marino
245*e4b17023SJohn Marino #define ALL_ONES (~((unsigned HOST_WIDE_INT) 0))
246*e4b17023SJohn Marino
247*e4b17023SJohn Marino /* The operands of the following comparison functions must be processed
248*e4b17023SJohn Marino with double_int_ext, if their precision is less than
249*e4b17023SJohn Marino 2 * HOST_BITS_PER_WIDE_INT bits. */
250*e4b17023SJohn Marino
251*e4b17023SJohn Marino /* Returns true if CST is zero. */
252*e4b17023SJohn Marino
253*e4b17023SJohn Marino static inline bool
double_int_zero_p(double_int cst)254*e4b17023SJohn Marino double_int_zero_p (double_int cst)
255*e4b17023SJohn Marino {
256*e4b17023SJohn Marino return cst.low == 0 && cst.high == 0;
257*e4b17023SJohn Marino }
258*e4b17023SJohn Marino
259*e4b17023SJohn Marino /* Returns true if CST is one. */
260*e4b17023SJohn Marino
261*e4b17023SJohn Marino static inline bool
double_int_one_p(double_int cst)262*e4b17023SJohn Marino double_int_one_p (double_int cst)
263*e4b17023SJohn Marino {
264*e4b17023SJohn Marino return cst.low == 1 && cst.high == 0;
265*e4b17023SJohn Marino }
266*e4b17023SJohn Marino
267*e4b17023SJohn Marino /* Returns true if CST is minus one. */
268*e4b17023SJohn Marino
269*e4b17023SJohn Marino static inline bool
double_int_minus_one_p(double_int cst)270*e4b17023SJohn Marino double_int_minus_one_p (double_int cst)
271*e4b17023SJohn Marino {
272*e4b17023SJohn Marino return (cst.low == ALL_ONES && cst.high == -1);
273*e4b17023SJohn Marino }
274*e4b17023SJohn Marino
275*e4b17023SJohn Marino /* Returns true if CST1 == CST2. */
276*e4b17023SJohn Marino
277*e4b17023SJohn Marino static inline bool
double_int_equal_p(double_int cst1,double_int cst2)278*e4b17023SJohn Marino double_int_equal_p (double_int cst1, double_int cst2)
279*e4b17023SJohn Marino {
280*e4b17023SJohn Marino return cst1.low == cst2.low && cst1.high == cst2.high;
281*e4b17023SJohn Marino }
282*e4b17023SJohn Marino
283*e4b17023SJohn Marino
284*e4b17023SJohn Marino /* Legacy interface with decomposed high/low parts. */
285*e4b17023SJohn Marino
286*e4b17023SJohn Marino extern int add_double_with_sign (unsigned HOST_WIDE_INT, HOST_WIDE_INT,
287*e4b17023SJohn Marino unsigned HOST_WIDE_INT, HOST_WIDE_INT,
288*e4b17023SJohn Marino unsigned HOST_WIDE_INT *, HOST_WIDE_INT *,
289*e4b17023SJohn Marino bool);
290*e4b17023SJohn Marino #define add_double(l1,h1,l2,h2,lv,hv) \
291*e4b17023SJohn Marino add_double_with_sign (l1, h1, l2, h2, lv, hv, false)
292*e4b17023SJohn Marino extern int neg_double (unsigned HOST_WIDE_INT, HOST_WIDE_INT,
293*e4b17023SJohn Marino unsigned HOST_WIDE_INT *, HOST_WIDE_INT *);
294*e4b17023SJohn Marino extern int mul_double_with_sign (unsigned HOST_WIDE_INT, HOST_WIDE_INT,
295*e4b17023SJohn Marino unsigned HOST_WIDE_INT, HOST_WIDE_INT,
296*e4b17023SJohn Marino unsigned HOST_WIDE_INT *, HOST_WIDE_INT *,
297*e4b17023SJohn Marino bool);
298*e4b17023SJohn Marino #define mul_double(l1,h1,l2,h2,lv,hv) \
299*e4b17023SJohn Marino mul_double_with_sign (l1, h1, l2, h2, lv, hv, false)
300*e4b17023SJohn Marino extern void lshift_double (unsigned HOST_WIDE_INT, HOST_WIDE_INT,
301*e4b17023SJohn Marino HOST_WIDE_INT, unsigned int,
302*e4b17023SJohn Marino unsigned HOST_WIDE_INT *, HOST_WIDE_INT *, bool);
303*e4b17023SJohn Marino extern int div_and_round_double (unsigned, int, unsigned HOST_WIDE_INT,
304*e4b17023SJohn Marino HOST_WIDE_INT, unsigned HOST_WIDE_INT,
305*e4b17023SJohn Marino HOST_WIDE_INT, unsigned HOST_WIDE_INT *,
306*e4b17023SJohn Marino HOST_WIDE_INT *, unsigned HOST_WIDE_INT *,
307*e4b17023SJohn Marino HOST_WIDE_INT *);
308*e4b17023SJohn Marino
309*e4b17023SJohn Marino
310*e4b17023SJohn Marino #ifndef GENERATOR_FILE
311*e4b17023SJohn Marino /* Conversion to and from GMP integer representations. */
312*e4b17023SJohn Marino
313*e4b17023SJohn Marino void mpz_set_double_int (mpz_t, double_int, bool);
314*e4b17023SJohn Marino double_int mpz_get_double_int (const_tree, mpz_t, bool);
315*e4b17023SJohn Marino #endif
316*e4b17023SJohn Marino
317*e4b17023SJohn Marino #endif /* DOUBLE_INT_H */
318