Switched to GPLv3.
[gnupg.git] / mpi / mpi-internal.h
1 /* mpi-internal.h  -  Internal to the Multi Precision Integers
2  *      Copyright (C) 1994, 1996 Free Software Foundation, Inc.
3  *      Copyright (C) 1998, 2000 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 3 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, see <http://www.gnu.org/licenses/>.
19  *
20  * Note: This code is heavily based on the GNU MP Library.
21  *       Actually it's the same code with only minor changes in the
22  *       way the data is stored; this is to support the abstraction
23  *       of an optional secure memory allocation which may be used
24  *       to avoid revealing of sensitive data due to paging etc.
25  *       The GNU MP Library itself is published under the LGPL;
26  *       however I decided to publish this code under the plain GPL.
27  */
28
29 #ifndef G10_MPI_INTERNAL_H
30 #define G10_MPI_INTERNAL_H
31
32 #include "mpi.h"
33 #include "mpi-asm-defs.h"
34
35 #if BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_INT
36   typedef unsigned int mpi_limb_t;
37   typedef   signed int mpi_limb_signed_t;
38 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG
39   typedef unsigned long int mpi_limb_t;
40   typedef   signed long int mpi_limb_signed_t;
41 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG_LONG
42   typedef unsigned long long int mpi_limb_t;
43   typedef   signed long long int mpi_limb_signed_t;
44 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_SHORT
45   typedef unsigned short int mpi_limb_t;
46   typedef   signed short int mpi_limb_signed_t;
47 #else
48 #error BYTES_PER_MPI_LIMB does not match any C type
49 #endif
50 #define BITS_PER_MPI_LIMB    (8*BYTES_PER_MPI_LIMB)
51
52
53 struct gcry_mpi {
54     int alloced;    /* array size (# of allocated limbs) */
55     int nlimbs;     /* number of valid limbs */
56     unsigned int nbits; /* the real number of valid bits (info only) */
57     int sign;       /* indicates a negative number */
58     unsigned flags; /* bit 0: array must be allocated in secure memory space */
59                     /* bit 1: not used */
60                     /* bit 2: the limb is a pointer to some xmalloced data */
61     mpi_limb_t *d;  /* array with the limbs */
62 };
63
64
65
66 /* If KARATSUBA_THRESHOLD is not already defined, define it to a
67  * value which is good on most machines.  */
68
69 /* tested 4, 16, 32 and 64, where 16 gave the best performance when
70  * checking a 768 and a 1024 bit ElGamal signature.
71  * (wk 22.12.97) */
72 #ifndef KARATSUBA_THRESHOLD
73 #define KARATSUBA_THRESHOLD 16
74 #endif
75
76 /* The code can't handle KARATSUBA_THRESHOLD smaller than 2.  */
77 #if KARATSUBA_THRESHOLD < 2
78 #undef KARATSUBA_THRESHOLD
79 #define KARATSUBA_THRESHOLD 2
80 #endif
81
82
83 typedef mpi_limb_t *mpi_ptr_t; /* pointer to a limb */
84 typedef int mpi_size_t;        /* (must be a signed type) */
85
86 #define ABS(x) (x >= 0 ? x : -x)
87 #define MIN(l,o) ((l) < (o) ? (l) : (o))
88 #define MAX(h,i) ((h) > (i) ? (h) : (i))
89 #define RESIZE_IF_NEEDED(a,b) \
90     do {                           \
91         if( (a)->alloced < (b) )   \
92             mpi_resize((a), (b));  \
93     } while(0)
94
95 /* Copy N limbs from S to D.  */
96 #define MPN_COPY( d, s, n) \
97     do {                                \
98         mpi_size_t _i;                  \
99         for( _i = 0; _i < (n); _i++ )   \
100             (d)[_i] = (s)[_i];          \
101     } while(0)
102
103 #define MPN_COPY_INCR( d, s, n)         \
104     do {                                \
105         mpi_size_t _i;                  \
106         for( _i = 0; _i < (n); _i++ )   \
107             (d)[_i] = (d)[_i];          \
108     } while (0)
109
110 #define MPN_COPY_DECR( d, s, n ) \
111     do {                                \
112         mpi_size_t _i;                  \
113         for( _i = (n)-1; _i >= 0; _i--) \
114            (d)[_i] = (s)[_i];           \
115     } while(0)
116
117 /* Zero N limbs at D */
118 #define MPN_ZERO(d, n) \
119     do {                                  \
120         int  _i;                          \
121         for( _i = 0; _i < (n); _i++ )  \
122             (d)[_i] = 0;                    \
123     } while (0)
124
125 #define MPN_NORMALIZE(d, n)  \
126     do {                       \
127         while( (n) > 0 ) {     \
128             if( (d)[(n)-1] ) \
129                 break;         \
130             (n)--;             \
131         }                      \
132     } while(0)
133
134 #define MPN_NORMALIZE_NOT_ZERO(d, n) \
135     do {                                    \
136         for(;;) {                           \
137             if( (d)[(n)-1] )                \
138                 break;                      \
139             (n)--;                          \
140         }                                   \
141     } while(0)
142
143 #define MPN_MUL_N_RECURSE(prodp, up, vp, size, tspace) \
144     do {                                                \
145         if( (size) < KARATSUBA_THRESHOLD )              \
146             mul_n_basecase (prodp, up, vp, size);       \
147         else                                            \
148             mul_n (prodp, up, vp, size, tspace);        \
149     } while (0);
150
151
152 /* Divide the two-limb number in (NH,,NL) by D, with DI being the largest
153  * limb not larger than (2**(2*BITS_PER_MP_LIMB))/D - (2**BITS_PER_MP_LIMB).
154  * If this would yield overflow, DI should be the largest possible number
155  * (i.e., only ones).  For correct operation, the most significant bit of D
156  * has to be set.  Put the quotient in Q and the remainder in R.
157  */
158 #define UDIV_QRNND_PREINV(q, r, nh, nl, d, di) \
159     do {                                                            \
160         mpi_limb_t _q, _ql, _r;                                     \
161         mpi_limb_t _xh, _xl;                                        \
162         umul_ppmm (_q, _ql, (nh), (di));                            \
163         _q += (nh);     /* DI is 2**BITS_PER_MPI_LIMB too small */  \
164         umul_ppmm (_xh, _xl, _q, (d));                              \
165         sub_ddmmss (_xh, _r, (nh), (nl), _xh, _xl);                 \
166         if( _xh ) {                                                 \
167             sub_ddmmss (_xh, _r, _xh, _r, 0, (d));                  \
168             _q++;                                                   \
169             if( _xh) {                                              \
170                 sub_ddmmss (_xh, _r, _xh, _r, 0, (d));              \
171                 _q++;                                               \
172             }                                                       \
173         }                                                           \
174         if( _r >= (d) ) {                                           \
175             _r -= (d);                                              \
176             _q++;                                                   \
177         }                                                           \
178         (r) = _r;                                                   \
179         (q) = _q;                                                   \
180     } while (0)
181
182
183 /*-- mpiutil.c --*/
184 #ifdef M_DEBUG
185 #define mpi_alloc_limb_space(n,f)  mpi_debug_alloc_limb_space((n),(f), M_DBGINFO( __LINE__ ) )
186 #define mpi_free_limb_space(n)  mpi_debug_free_limb_space((n),  M_DBGINFO( __LINE__ ) )
187   mpi_ptr_t mpi_debug_alloc_limb_space( unsigned nlimbs, int sec, const char *info  );
188   void mpi_debug_free_limb_space( mpi_ptr_t a, const char *info );
189 #else
190   mpi_ptr_t mpi_alloc_limb_space( unsigned nlimbs, int sec );
191   void mpi_free_limb_space( mpi_ptr_t a );
192 #endif
193 void mpi_assign_limb_space( MPI a, mpi_ptr_t ap, unsigned nlimbs );
194
195 /*-- mpi-bit.c --*/
196 void mpi_rshift_limbs( MPI a, unsigned int count );
197 void mpi_lshift_limbs( MPI a, unsigned int count );
198
199
200 /*-- mpihelp-add.c --*/
201 mpi_limb_t mpihelp_add_1(mpi_ptr_t res_ptr,  mpi_ptr_t s1_ptr,
202                          mpi_size_t s1_size, mpi_limb_t s2_limb );
203 mpi_limb_t mpihelp_add_n( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
204                           mpi_ptr_t s2_ptr,  mpi_size_t size);
205 mpi_limb_t mpihelp_add(mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr, mpi_size_t s1_size,
206                        mpi_ptr_t s2_ptr, mpi_size_t s2_size);
207
208 /*-- mpihelp-sub.c --*/
209 mpi_limb_t mpihelp_sub_1( mpi_ptr_t res_ptr,  mpi_ptr_t s1_ptr,
210                           mpi_size_t s1_size, mpi_limb_t s2_limb );
211 mpi_limb_t mpihelp_sub_n( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
212                           mpi_ptr_t s2_ptr, mpi_size_t size);
213 mpi_limb_t mpihelp_sub(mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr, mpi_size_t s1_size,
214                        mpi_ptr_t s2_ptr, mpi_size_t s2_size);
215
216 /*-- mpihelp-cmp.c --*/
217 int mpihelp_cmp( mpi_ptr_t op1_ptr, mpi_ptr_t op2_ptr, mpi_size_t size );
218
219 /*-- mpihelp-mul.c --*/
220
221 struct karatsuba_ctx {
222     struct karatsuba_ctx *next;
223     mpi_ptr_t tspace;
224     mpi_size_t tspace_size;
225     mpi_ptr_t tp;
226     mpi_size_t tp_size;
227 };
228
229 void mpihelp_release_karatsuba_ctx( struct karatsuba_ctx *ctx );
230
231 mpi_limb_t mpihelp_addmul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
232                              mpi_size_t s1_size, mpi_limb_t s2_limb);
233 mpi_limb_t mpihelp_submul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
234                              mpi_size_t s1_size, mpi_limb_t s2_limb);
235 void mpihelp_mul_n( mpi_ptr_t prodp, mpi_ptr_t up, mpi_ptr_t vp,
236                                                    mpi_size_t size);
237 mpi_limb_t mpihelp_mul( mpi_ptr_t prodp, mpi_ptr_t up, mpi_size_t usize,
238                                          mpi_ptr_t vp, mpi_size_t vsize);
239 void mpih_sqr_n_basecase( mpi_ptr_t prodp, mpi_ptr_t up, mpi_size_t size );
240 void mpih_sqr_n( mpi_ptr_t prodp, mpi_ptr_t up, mpi_size_t size,
241                                                 mpi_ptr_t tspace);
242
243 void mpihelp_mul_karatsuba_case( mpi_ptr_t prodp,
244                                  mpi_ptr_t up, mpi_size_t usize,
245                                  mpi_ptr_t vp, mpi_size_t vsize,
246                                  struct karatsuba_ctx *ctx );
247
248
249 /*-- mpihelp-mul_1.c (or xxx/cpu/ *.S) --*/
250 mpi_limb_t mpihelp_mul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
251                           mpi_size_t s1_size, mpi_limb_t s2_limb);
252
253 /*-- mpihelp-div.c --*/
254 mpi_limb_t mpihelp_mod_1(mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
255                                                  mpi_limb_t divisor_limb);
256 mpi_limb_t mpihelp_divrem( mpi_ptr_t qp, mpi_size_t qextra_limbs,
257                            mpi_ptr_t np, mpi_size_t nsize,
258                            mpi_ptr_t dp, mpi_size_t dsize);
259 mpi_limb_t mpihelp_divmod_1( mpi_ptr_t quot_ptr,
260                              mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
261                              mpi_limb_t divisor_limb);
262
263 /*-- mpihelp-shift.c --*/
264 mpi_limb_t mpihelp_lshift( mpi_ptr_t wp, mpi_ptr_t up, mpi_size_t usize,
265                                                            unsigned cnt);
266 mpi_limb_t mpihelp_rshift( mpi_ptr_t wp, mpi_ptr_t up, mpi_size_t usize,
267                                                            unsigned cnt);
268
269
270 /* Define stuff for longlong.h.  */
271 #define W_TYPE_SIZE BITS_PER_MPI_LIMB
272   typedef mpi_limb_t   UWtype;
273   typedef unsigned int UHWtype;
274 #if defined (__GNUC__)
275   typedef unsigned int UQItype    __attribute__ ((mode (QI)));
276   typedef          int SItype     __attribute__ ((mode (SI)));
277   typedef unsigned int USItype    __attribute__ ((mode (SI)));
278   typedef          int DItype     __attribute__ ((mode (DI)));
279   typedef unsigned int UDItype    __attribute__ ((mode (DI)));
280 #else
281   typedef unsigned char UQItype;
282   typedef          long SItype;
283   typedef unsigned long USItype;
284 #endif
285
286 #ifdef __GNUC__
287 #include "mpi-inline.h"
288 #endif
289
290 #endif /*G10_MPI_INTERNAL_H*/