new release
[gnupg.git] / mpi / mpiutil.c
1 /* mpiutilac  -  Utility functions for MPI
2  *      Copyright (C) 1998 Free Software Foundation, Inc.
3  *
4  * This file is part of GNUPG.
5  *
6  * GNUPG 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  * GNUPG 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 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <assert.h>
25
26 #include "mpi.h"
27 #include "mpi-internal.h"
28 #include "memory.h"
29 #include "util.h"
30
31
32 #ifdef M_DEBUG
33   #undef mpi_alloc
34   #undef mpi_alloc_secure
35   #undef mpi_free
36 #endif
37
38 /****************
39  * fixme: It was a bad idea to use the number of limbs to allocate
40  *        because on a alpha the limbs are large but we normally need
41  *        integers of n bits - So we should chnage this to bits (or bytes).
42  *
43  *        But mpi_alloc is used in a lot of places :-)
44  */
45 MPI
46 #ifdef M_DEBUG
47 mpi_debug_alloc( unsigned nlimbs, const char *info )
48 #else
49 mpi_alloc( unsigned nlimbs )
50 #endif
51 {
52     MPI a;
53
54     if( DBG_MEMORY )
55         log_debug("mpi_alloc(%u)\n", nlimbs*BITS_PER_MPI_LIMB );
56   #ifdef M_DEBUG
57     a = m_debug_alloc( sizeof *a, info );
58     a->d = nlimbs? mpi_debug_alloc_limb_space( nlimbs, 0, info ) : NULL;
59   #else
60     a = m_alloc( sizeof *a );
61     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 0 ) : NULL;
62   #endif
63     a->alloced = nlimbs;
64     a->nlimbs = 0;
65     a->sign = 0;
66     a->secure = 0;
67     return a;
68 }
69
70 void
71 mpi_m_check( MPI a )
72 {
73     m_check(a);
74     m_check(a->d);
75 }
76
77 MPI
78 #ifdef M_DEBUG
79 mpi_debug_alloc_secure( unsigned nlimbs, const char *info )
80 #else
81 mpi_alloc_secure( unsigned nlimbs )
82 #endif
83 {
84     MPI a;
85
86     if( DBG_MEMORY )
87         log_debug("mpi_alloc_secure(%u)\n", nlimbs*BITS_PER_MPI_LIMB );
88   #ifdef M_DEBUG
89     a = m_debug_alloc( sizeof *a, info );
90     a->d = nlimbs? mpi_debug_alloc_limb_space( nlimbs, 1, info ) : NULL;
91   #else
92     a = m_alloc( sizeof *a );
93     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 1 ) : NULL;
94   #endif
95     a->alloced = nlimbs;
96     a->secure = 1;
97     a->nlimbs = 0;
98     a->sign = 0;
99     return a;
100 }
101
102
103 mpi_ptr_t
104 #ifdef M_DEBUG
105 mpi_debug_alloc_limb_space( unsigned nlimbs, int secure, const char *info )
106 #else
107 mpi_alloc_limb_space( unsigned nlimbs, int secure )
108 #endif
109 {
110     size_t len = nlimbs * sizeof(mpi_limb_t);
111
112     if( DBG_MEMORY )
113         log_debug("mpi_alloc_limb_space(%u)\n", (unsigned)len*8 );
114   #ifdef M_DEBUG
115     return secure? m_debug_alloc_secure(len, info):m_debug_alloc( len, info );
116   #else
117     return secure? m_alloc_secure( len ):m_alloc( len );
118   #endif
119 }
120
121 void
122 #ifdef M_DEBUG
123 mpi_debug_free_limb_space( mpi_ptr_t a, const char *info )
124 #else
125 mpi_free_limb_space( mpi_ptr_t a )
126 #endif
127 {
128     if( !a )
129         return;
130     if( DBG_MEMORY )
131         log_debug("mpi_free_limb_space of size %lu\n", (ulong)m_size(a)*8 );
132     m_free(a);
133 }
134
135
136 void
137 mpi_assign_limb_space( MPI a, mpi_ptr_t ap, unsigned nlimbs )
138 {
139     mpi_free_limb_space(a->d);
140     a->d = ap;
141     a->alloced = nlimbs;
142 }
143
144
145
146 /****************
147  * Resize the array of A to NLIMBS. the additional space is cleared
148  * (set to 0) [done by m_realloc()]
149  */
150 void
151 #ifdef M_DEBUG
152 mpi_debug_resize( MPI a, unsigned nlimbs, const char *info )
153 #else
154 mpi_resize( MPI a, unsigned nlimbs )
155 #endif
156 {
157     if( nlimbs <= a->alloced )
158         return; /* no need to do it */
159     /* FIXME: add realloc_secure based on a->secure */
160   #ifdef M_DEBUG
161     if( a->d )
162         a->d = m_debug_realloc(a->d, nlimbs * sizeof(mpi_limb_t), info );
163     else
164         a->d = m_debug_alloc_clear( nlimbs * sizeof(mpi_limb_t), info );
165   #else
166     if( a->d )
167         a->d = m_realloc(a->d, nlimbs * sizeof(mpi_limb_t) );
168     else
169         a->d = m_alloc_clear( nlimbs * sizeof(mpi_limb_t) );
170   #endif
171     a->alloced = nlimbs;
172 }
173
174 void
175 mpi_clear( MPI a )
176 {
177     a->nlimbs = 0;
178 }
179
180
181 void
182 #ifdef M_DEBUG
183 mpi_debug_free( MPI a, const char *info )
184 #else
185 mpi_free( MPI a )
186 #endif
187 {
188     if( !a )
189         return;
190     if( DBG_MEMORY )
191         log_debug("mpi_free\n" );
192   #ifdef M_DEBUG
193     mpi_debug_free_limb_space(a->d, info);
194   #else
195     mpi_free_limb_space(a->d);
196   #endif
197
198     m_free(a);
199 }
200
201
202 void
203 mpi_set_secure( MPI a )
204 {
205     mpi_ptr_t ap, bp;
206
207     if( a->secure )
208         return;
209     a->secure = 1;
210     ap = a->d;
211     if( !a->nlimbs ) {
212         assert(!ap);
213         return;
214     }
215   #ifdef M_DEBUG
216     bp = mpi_debug_alloc_limb_space( a->nlimbs, 1, "set_secure" );
217   #else
218     bp = mpi_alloc_limb_space( a->nlimbs, 1 );
219   #endif
220     MPN_COPY( bp, ap, a->nlimbs );
221     a->d = bp;
222   #ifdef M_DEBUG
223     mpi_debug_free_limb_space(ap, "set_secure");
224   #else
225     mpi_free_limb_space(ap);
226   #endif
227 }
228
229
230 /****************
231  * Note: This copy function shpould not interpret the MPI
232  *       but copy it transparently.
233  */
234 MPI
235 #ifdef M_DEBUG
236 mpi_debug_copy( MPI a, const char *info )
237 #else
238 mpi_copy( MPI a )
239 #endif
240 {
241     int i;
242     MPI b;
243
244     if( a ) {
245       #ifdef M_DEBUG
246         b = a->secure? mpi_debug_alloc_secure( a->nlimbs, info )
247                      : mpi_debug_alloc( a->nlimbs, info );
248       #else
249         b = a->secure? mpi_alloc_secure( a->nlimbs )
250                      : mpi_alloc( a->nlimbs );
251       #endif
252         b->nlimbs = a->nlimbs;
253         b->sign = a->sign;
254         b->secure = a->secure;
255         for(i=0; i < b->nlimbs; i++ )
256             b->d[i] = a->d[i];
257     }
258     else
259         b = NULL;
260     return b;
261 }
262
263
264 void
265 mpi_set( MPI w, MPI u)
266 {
267     mpi_ptr_t wp, up;
268     mpi_size_t usize = u->nlimbs;
269     int usign = u->sign;
270
271     RESIZE_IF_NEEDED(w, usize);
272     wp = w->d;
273     up = u->d;
274     MPN_COPY( wp, up, usize );
275     w->nlimbs = usize;
276     w->sign = usign;
277 }
278
279
280 void
281 mpi_set_ui( MPI w, unsigned long u)
282 {
283     RESIZE_IF_NEEDED(w, 1);
284     w->d[0] = u;
285     w->nlimbs = u? 1:0;
286     w->sign = 0;
287 }
288
289
290 MPI
291 mpi_alloc_set_ui( unsigned long u)
292 {
293   #ifdef M_DEBUG
294     MPI w = mpi_debug_alloc(1,"alloc_set_ui");
295   #else
296     MPI w = mpi_alloc(1);
297   #endif
298     w->d[0] = u;
299     w->nlimbs = u? 1:0;
300     w->sign = 0;
301     return w;
302 }
303
304
305 void
306 mpi_swap( MPI a, MPI b)
307 {
308     struct mpi_struct tmp;
309
310     tmp = *a; *a = *b; *b = tmp;
311 }
312
313