initially checkin
[gnupg.git] / mpi / mpi-internal.h
1 /* mpi-internal.h  -  Internal to the Multi Precision Integers
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * G10 is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef G10_MPI_INTERNAL_H
22 #define G10_MPI_INTERNAL_H
23
24 #include "mpi.h"
25
26
27
28 typedef mpi_limb_t *mpi_ptr_t; /* pointer to a limb */
29 typedef int mpi_size_t;        /* (must be a signed type) */
30
31 #define ABS(x) (x >= 0 ? x : -x)
32 #define MIN(l,o) ((l) < (o) ? (l) : (o))
33 #define MAX(h,i) ((h) > (i) ? (h) : (i))
34 #define RESIZE_IF_NEEDED(a,b) \
35     do {                           \
36         if( (a)->alloced < (b) )   \
37             mpi_resize((a), (b));  \
38     } while(0)
39
40 /* Copy N limbs from S to D.  */
41 #define MPN_COPY( d, s, n) \
42     do {                                \
43         mpi_size_t _i;                  \
44         for( _i = 0; _i < (n); _i++ )   \
45             (d)[_i] = (s)[_i];          \
46     } while(0)
47
48 #define MPN_COPY_DECR( d, s, n ) \
49     do {                                \
50         mpi_size_t _i;                  \
51         for( _i = (n)-1; _i >= 0; _i--) \
52            (d)[_i] = (s)[_i];           \
53     } while(0)
54
55 /* Zero N limbs at D */
56 #define MPN_ZERO(d, n) \
57     do {                                  \
58         int  _i;                          \
59         for( _i = 0; _i < (n); _i++ )  \
60             (d)[_i] = 0;                    \
61     } while (0)
62
63 #define MPN_NORMALIZE(d, n)  \
64     do {                       \
65         while( (n) > 0 ) {     \
66             if( (d)[(n)-1] ) \
67                 break;         \
68             (n)--;             \
69         }                      \
70     } while(0)
71
72 #define MPN_NORMALIZE_NOT_ZERO(d, n) \
73     do {                                    \
74         for(;;) {                           \
75             if( (d)[(n)-1] )                \
76                 break;                      \
77             (n)--;                          \
78         }                                   \
79     } while(0)
80
81 #define MPN_MUL_N_RECURSE(prodp, up, vp, size, tspace) \
82     do {                                                \
83         if( (size) < KARATSUBA_THRESHOLD )              \
84             mul_n_basecase (prodp, up, vp, size);       \
85         else                                            \
86             mul_n (prodp, up, vp, size, tspace);        \
87     } while (0);
88
89
90 /* Divide the two-limb number in (NH,,NL) by D, with DI being the largest
91  * limb not larger than (2**(2*BITS_PER_MP_LIMB))/D - (2**BITS_PER_MP_LIMB).
92  * If this would yield overflow, DI should be the largest possible number
93  * (i.e., only ones).  For correct operation, the most significant bit of D
94  * has to be set.  Put the quotient in Q and the remainder in R.
95  */
96 #define UDIV_QRNND_PREINV(q, r, nh, nl, d, di) \
97     do {                                                            \
98         mpi_limb_t _q, _ql, _r;                                     \
99         mpi_limb_t _xh, _xl;                                        \
100         umul_ppmm (_q, _ql, (nh), (di));                            \
101         _q += (nh);     /* DI is 2**BITS_PER_MPI_LIMB too small */  \
102         umul_ppmm (_xh, _xl, _q, (d));                              \
103         sub_ddmmss (_xh, _r, (nh), (nl), _xh, _xl);                 \
104         if( _xh ) {                                                 \
105             sub_ddmmss (_xh, _r, _xh, _r, 0, (d));                  \
106             _q++;                                                   \
107             if( _xh) {                                              \
108                 sub_ddmmss (_xh, _r, _xh, _r, 0, (d));              \
109                 _q++;                                               \
110             }                                                       \
111         }                                                           \
112         if( _r >= (d) ) {                                           \
113             _r -= (d);                                              \
114             _q++;                                                   \
115         }                                                           \
116         (r) = _r;                                                   \
117         (q) = _q;                                                   \
118     } while (0)
119
120
121 /*-- mpiutil.c --*/
122 #ifdef M_DEBUG
123   #define mpi_alloc_limb_space(n)  mpi_debug_alloc_limb_space((n), M_DBGINFO( __LINE__ ) )
124   #define mpi_free_limb_space(n)  mpi_debug_free_limb_space((n),  M_DBGINFO( __LINE__ ) )
125   mpi_ptr_t mpi_debug_alloc_limb_space( unsigned nlimbs, const char *info  );
126   void mpi_debug_free_limb_space( mpi_ptr_t a, const char *info );
127 #else
128   mpi_ptr_t mpi_alloc_limb_space( unsigned nlimbs );
129   void mpi_free_limb_space( mpi_ptr_t a );
130 #endif
131 void mpi_assign_limb_space( MPI a, mpi_ptr_t ap, unsigned nlimbs );
132
133 /*-- mpihelp-add.c --*/
134 mpi_limb_t mpihelp_add_1(mpi_ptr_t res_ptr,  mpi_ptr_t s1_ptr,
135                          mpi_size_t s1_size, mpi_limb_t s2_limb );
136 mpi_limb_t mpihelp_add_n( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
137                           mpi_ptr_t s2_ptr,  mpi_size_t size);
138 mpi_limb_t mpihelp_add(mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr, mpi_size_t s1_size,
139                        mpi_ptr_t s2_ptr, mpi_size_t s2_size);
140
141 /*-- mpihelp-sub.c --*/
142 mpi_limb_t mpihelp_sub_1( mpi_ptr_t res_ptr,  mpi_ptr_t s1_ptr,
143                           mpi_size_t s1_size, mpi_limb_t s2_limb );
144 mpi_limb_t mpihelp_sub_n( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
145                           mpi_ptr_t s2_ptr, mpi_size_t size);
146 mpi_limb_t mpihelp_sub(mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr, mpi_size_t s1_size,
147                        mpi_ptr_t s2_ptr, mpi_size_t s2_size);
148
149 /*-- mpihelp-cmp.c --*/
150 int mpihelp_cmp( mpi_ptr_t op1_ptr, mpi_ptr_t op2_ptr, mpi_size_t size );
151
152 /*-- mpihelp-mul.c --*/
153 mpi_limb_t mpihelp_addmul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
154                              mpi_size_t s1_size, mpi_limb_t s2_limb);
155 mpi_limb_t mpihelp_submul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
156                              mpi_size_t s1_size, mpi_limb_t s2_limb);
157 mpi_limb_t mpihelp_mul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
158                           mpi_size_t s1_size, mpi_limb_t s2_limb);
159 void mpihelp_mul_n( mpi_ptr_t prodp, mpi_ptr_t up, mpi_ptr_t vp,
160                                                    mpi_size_t size);
161 mpi_limb_t mpihelp_mul( mpi_ptr_t prodp, mpi_ptr_t up, mpi_size_t usize,
162                                          mpi_ptr_t vp, mpi_size_t vsize);
163
164 /*-- mpihelp-div.c --*/
165 mpi_limb_t mpihelp_mod_1(mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
166                                                  mpi_limb_t divisor_limb);
167 mpi_limb_t mpihelp_divrem( mpi_ptr_t qp, mpi_size_t qextra_limbs,
168                            mpi_ptr_t np, mpi_size_t nsize,
169                            mpi_ptr_t dp, mpi_size_t dsize);
170 mpi_limb_t mpihelp_divmod_1( mpi_ptr_t quot_ptr,
171                              mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
172                              mpi_limb_t divisor_limb);
173
174 /*-- mpihelp-shift.c --*/
175 mpi_limb_t mpihelp_lshift( mpi_ptr_t wp, mpi_ptr_t up, mpi_size_t usize,
176                                                            unsigned cnt);
177 mpi_limb_t mpihelp_rshift( mpi_ptr_t wp, mpi_ptr_t up, mpi_size_t usize,
178                                                            unsigned cnt);
179
180
181 /* Define stuff for longlong.h.  */
182 #define W_TYPE_SIZE BITS_PER_MPI_LIMB
183   typedef mpi_limb_t   UWtype;
184   typedef unsigned int UHWtype;
185 #if defined (__GNUC__)
186   typedef unsigned int UQItype    __attribute__ ((mode (QI)));
187   typedef          int SItype     __attribute__ ((mode (SI)));
188   typedef unsigned int USItype    __attribute__ ((mode (SI)));
189   typedef          int DItype     __attribute__ ((mode (DI)));
190   typedef unsigned int UDItype    __attribute__ ((mode (DI)));
191 #else
192   typedef unsigned char UQItype;
193   typedef          long SItype;
194   typedef unsigned long USItype;
195 #endif
196
197
198 #endif /*G10_MPI_INTERNAL_H*/