2748ddad968fadb61ad7b60d4a049415a66132b0
[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  *      Copyright (C) 1994, 1996 Free Software Foundation, Inc.
4  *
5  * This file is part of G10.
6  *
7  * G10 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  * G10 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
36
37 typedef mpi_limb_t *mpi_ptr_t; /* pointer to a limb */
38 typedef int mpi_size_t;        /* (must be a signed type) */
39
40 #define ABS(x) (x >= 0 ? x : -x)
41 #define MIN(l,o) ((l) < (o) ? (l) : (o))
42 #define MAX(h,i) ((h) > (i) ? (h) : (i))
43 #define RESIZE_IF_NEEDED(a,b) \
44     do {                           \
45         if( (a)->alloced < (b) )   \
46             mpi_resize((a), (b));  \
47     } while(0)
48
49 /* Copy N limbs from S to D.  */
50 #define MPN_COPY( d, s, n) \
51     do {                                \
52         mpi_size_t _i;                  \
53         for( _i = 0; _i < (n); _i++ )   \
54             (d)[_i] = (s)[_i];          \
55     } while(0)
56
57 #define MPN_COPY_DECR( d, s, n ) \
58     do {                                \
59         mpi_size_t _i;                  \
60         for( _i = (n)-1; _i >= 0; _i--) \
61            (d)[_i] = (s)[_i];           \
62     } while(0)
63
64 /* Zero N limbs at D */
65 #define MPN_ZERO(d, n) \
66     do {                                  \
67         int  _i;                          \
68         for( _i = 0; _i < (n); _i++ )  \
69             (d)[_i] = 0;                    \
70     } while (0)
71
72 #define MPN_NORMALIZE(d, n)  \
73     do {                       \
74         while( (n) > 0 ) {     \
75             if( (d)[(n)-1] ) \
76                 break;         \
77             (n)--;             \
78         }                      \
79     } while(0)
80
81 #define MPN_NORMALIZE_NOT_ZERO(d, n) \
82     do {                                    \
83         for(;;) {                           \
84             if( (d)[(n)-1] )                \
85                 break;                      \
86             (n)--;                          \
87         }                                   \
88     } while(0)
89
90 #define MPN_MUL_N_RECURSE(prodp, up, vp, size, tspace) \
91     do {                                                \
92         if( (size) < KARATSUBA_THRESHOLD )              \
93             mul_n_basecase (prodp, up, vp, size);       \
94         else                                            \
95             mul_n (prodp, up, vp, size, tspace);        \
96     } while (0);
97
98
99 /* Divide the two-limb number in (NH,,NL) by D, with DI being the largest
100  * limb not larger than (2**(2*BITS_PER_MP_LIMB))/D - (2**BITS_PER_MP_LIMB).
101  * If this would yield overflow, DI should be the largest possible number
102  * (i.e., only ones).  For correct operation, the most significant bit of D
103  * has to be set.  Put the quotient in Q and the remainder in R.
104  */
105 #define UDIV_QRNND_PREINV(q, r, nh, nl, d, di) \
106     do {                                                            \
107         mpi_limb_t _q, _ql, _r;                                     \
108         mpi_limb_t _xh, _xl;                                        \
109         umul_ppmm (_q, _ql, (nh), (di));                            \
110         _q += (nh);     /* DI is 2**BITS_PER_MPI_LIMB too small */  \
111         umul_ppmm (_xh, _xl, _q, (d));                              \
112         sub_ddmmss (_xh, _r, (nh), (nl), _xh, _xl);                 \
113         if( _xh ) {                                                 \
114             sub_ddmmss (_xh, _r, _xh, _r, 0, (d));                  \
115             _q++;                                                   \
116             if( _xh) {                                              \
117                 sub_ddmmss (_xh, _r, _xh, _r, 0, (d));              \
118                 _q++;                                               \
119             }                                                       \
120         }                                                           \
121         if( _r >= (d) ) {                                           \
122             _r -= (d);                                              \
123             _q++;                                                   \
124         }                                                           \
125         (r) = _r;                                                   \
126         (q) = _q;                                                   \
127     } while (0)
128
129
130 /*-- mpiutil.c --*/
131 #ifdef M_DEBUG
132   #define mpi_alloc_limb_space(n,f)  mpi_debug_alloc_limb_space((n),(f), M_DBGINFO( __LINE__ ) )
133   #define mpi_free_limb_space(n)  mpi_debug_free_limb_space((n),  M_DBGINFO( __LINE__ ) )
134   mpi_ptr_t mpi_debug_alloc_limb_space( unsigned nlimbs, int sec, const char *info  );
135   void mpi_debug_free_limb_space( mpi_ptr_t a, const char *info );
136 #else
137   mpi_ptr_t mpi_alloc_limb_space( unsigned nlimbs, int sec );
138   void mpi_free_limb_space( mpi_ptr_t a );
139 #endif
140 void mpi_assign_limb_space( MPI a, mpi_ptr_t ap, unsigned nlimbs );
141
142 /*-- mpihelp-add.c --*/
143 mpi_limb_t mpihelp_add_1(mpi_ptr_t res_ptr,  mpi_ptr_t s1_ptr,
144                          mpi_size_t s1_size, mpi_limb_t s2_limb );
145 mpi_limb_t mpihelp_add_n( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
146                           mpi_ptr_t s2_ptr,  mpi_size_t size);
147 mpi_limb_t mpihelp_add(mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr, mpi_size_t s1_size,
148                        mpi_ptr_t s2_ptr, mpi_size_t s2_size);
149
150 /*-- mpihelp-sub.c --*/
151 mpi_limb_t mpihelp_sub_1( mpi_ptr_t res_ptr,  mpi_ptr_t s1_ptr,
152                           mpi_size_t s1_size, mpi_limb_t s2_limb );
153 mpi_limb_t mpihelp_sub_n( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
154                           mpi_ptr_t s2_ptr, mpi_size_t size);
155 mpi_limb_t mpihelp_sub(mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr, mpi_size_t s1_size,
156                        mpi_ptr_t s2_ptr, mpi_size_t s2_size);
157
158 /*-- mpihelp-cmp.c --*/
159 int mpihelp_cmp( mpi_ptr_t op1_ptr, mpi_ptr_t op2_ptr, mpi_size_t size );
160
161 /*-- mpihelp-mul.c --*/
162 mpi_limb_t mpihelp_addmul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
163                              mpi_size_t s1_size, mpi_limb_t s2_limb);
164 mpi_limb_t mpihelp_submul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
165                              mpi_size_t s1_size, mpi_limb_t s2_limb);
166 void mpihelp_mul_n( mpi_ptr_t prodp, mpi_ptr_t up, mpi_ptr_t vp,
167                                                    mpi_size_t size);
168 mpi_limb_t mpihelp_mul( mpi_ptr_t prodp, mpi_ptr_t up, mpi_size_t usize,
169                                          mpi_ptr_t vp, mpi_size_t vsize);
170
171 /*-- mpihelp-mul_1.c (or xxx/cpu/*.S) --*/
172 mpi_limb_t mpihelp_mul_1( mpi_ptr_t res_ptr, mpi_ptr_t s1_ptr,
173                           mpi_size_t s1_size, mpi_limb_t s2_limb);
174
175 /*-- mpihelp-div.c --*/
176 mpi_limb_t mpihelp_mod_1(mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
177                                                  mpi_limb_t divisor_limb);
178 mpi_limb_t mpihelp_divrem( mpi_ptr_t qp, mpi_size_t qextra_limbs,
179                            mpi_ptr_t np, mpi_size_t nsize,
180                            mpi_ptr_t dp, mpi_size_t dsize);
181 mpi_limb_t mpihelp_divmod_1( mpi_ptr_t quot_ptr,
182                              mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
183                              mpi_limb_t divisor_limb);
184
185 /*-- mpihelp-shift.c --*/
186 mpi_limb_t mpihelp_lshift( mpi_ptr_t wp, mpi_ptr_t up, mpi_size_t usize,
187                                                            unsigned cnt);
188 mpi_limb_t mpihelp_rshift( mpi_ptr_t wp, mpi_ptr_t up, mpi_size_t usize,
189                                                            unsigned cnt);
190
191
192 /* Define stuff for longlong.h.  */
193 #define W_TYPE_SIZE BITS_PER_MPI_LIMB
194   typedef mpi_limb_t   UWtype;
195   typedef unsigned int UHWtype;
196 #if defined (__GNUC__)
197   typedef unsigned int UQItype    __attribute__ ((mode (QI)));
198   typedef          int SItype     __attribute__ ((mode (SI)));
199   typedef unsigned int USItype    __attribute__ ((mode (SI)));
200   typedef          int DItype     __attribute__ ((mode (DI)));
201   typedef unsigned int UDItype    __attribute__ ((mode (DI)));
202 #else
203   typedef unsigned char UQItype;
204   typedef          long SItype;
205   typedef unsigned long USItype;
206 #endif
207
208 #ifdef __GNUC__
209   #include "mpi-inline.h"
210 #endif
211
212 #endif /*G10_MPI_INTERNAL_H*/