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