intermediate check in
[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->flags = 0;
67     a->nbits = 0;
68     return a;
69 }
70
71 void
72 mpi_m_check( MPI a )
73 {
74     m_check(a);
75     m_check(a->d);
76 }
77
78 MPI
79 #ifdef M_DEBUG
80 mpi_debug_alloc_secure( unsigned nlimbs, const char *info )
81 #else
82 mpi_alloc_secure( unsigned nlimbs )
83 #endif
84 {
85     MPI a;
86
87     if( DBG_MEMORY )
88         log_debug("mpi_alloc_secure(%u)\n", nlimbs*BITS_PER_MPI_LIMB );
89   #ifdef M_DEBUG
90     a = m_debug_alloc( sizeof *a, info );
91     a->d = nlimbs? mpi_debug_alloc_limb_space( nlimbs, 1, info ) : NULL;
92   #else
93     a = m_alloc( sizeof *a );
94     a->d = nlimbs? mpi_alloc_limb_space( nlimbs, 1 ) : NULL;
95   #endif
96     a->alloced = nlimbs;
97     a->flags = 1;
98     a->nlimbs = 0;
99     a->sign = 0;
100     a->nbits = 0;
101     return a;
102 }
103
104
105 mpi_ptr_t
106 #ifdef M_DEBUG
107 mpi_debug_alloc_limb_space( unsigned nlimbs, int secure, const char *info )
108 #else
109 mpi_alloc_limb_space( unsigned nlimbs, int secure )
110 #endif
111 {
112     size_t len = nlimbs * sizeof(mpi_limb_t);
113
114     if( DBG_MEMORY )
115         log_debug("mpi_alloc_limb_space(%u)\n", (unsigned)len*8 );
116   #ifdef M_DEBUG
117     return secure? m_debug_alloc_secure(len, info):m_debug_alloc( len, info );
118   #else
119     return secure? m_alloc_secure( len ):m_alloc( len );
120   #endif
121 }
122
123 void
124 #ifdef M_DEBUG
125 mpi_debug_free_limb_space( mpi_ptr_t a, const char *info )
126 #else
127 mpi_free_limb_space( mpi_ptr_t a )
128 #endif
129 {
130     if( !a )
131         return;
132     if( DBG_MEMORY )
133         log_debug("mpi_free_limb_space of size %lu\n", (ulong)m_size(a)*8 );
134     m_free(a);
135 }
136
137
138 void
139 mpi_assign_limb_space( MPI a, mpi_ptr_t ap, unsigned nlimbs )
140 {
141     mpi_free_limb_space(a->d);
142     a->d = ap;
143     a->alloced = nlimbs;
144 }
145
146
147
148 /****************
149  * Resize the array of A to NLIMBS. the additional space is cleared
150  * (set to 0) [done by m_realloc()]
151  */
152 void
153 #ifdef M_DEBUG
154 mpi_debug_resize( MPI a, unsigned nlimbs, const char *info )
155 #else
156 mpi_resize( MPI a, unsigned nlimbs )
157 #endif
158 {
159     if( nlimbs <= a->alloced )
160         return; /* no need to do it */
161     /* FIXME: add realloc_secure based on a->secure */
162   #ifdef M_DEBUG
163     if( a->d )
164         a->d = m_debug_realloc(a->d, nlimbs * sizeof(mpi_limb_t), info );
165     else
166         a->d = m_debug_alloc_clear( nlimbs * sizeof(mpi_limb_t), info );
167   #else
168     if( a->d )
169         a->d = m_realloc(a->d, nlimbs * sizeof(mpi_limb_t) );
170     else
171         a->d = m_alloc_clear( nlimbs * sizeof(mpi_limb_t) );
172   #endif
173     a->alloced = nlimbs;
174 }
175
176 void
177 mpi_clear( MPI a )
178 {
179     a->nlimbs = 0;
180     a->nbits = 0;
181     a->flags = 0;
182 }
183
184
185 void
186 #ifdef M_DEBUG
187 mpi_debug_free( MPI a, const char *info )
188 #else
189 mpi_free( MPI a )
190 #endif
191 {
192     if( !a )
193         return;
194     if( DBG_MEMORY )
195         log_debug("mpi_free\n" );
196     if( a->flags & 4 )
197         m_free( a->d );
198     else {
199       #ifdef M_DEBUG
200         mpi_debug_free_limb_space(a->d, info);
201       #else
202         mpi_free_limb_space(a->d);
203       #endif
204     }
205     if( a->flags & ~7 )
206         log_bug("invalid flag value in mpi\n");
207     m_free(a);
208 }
209
210
211 void
212 mpi_set_secure( MPI a )
213 {
214     mpi_ptr_t ap, bp;
215
216     if( (a->flags & 1) )
217         return;
218     a->flags |= 1;
219     ap = a->d;
220     if( !a->nlimbs ) {
221         assert(!ap);
222         return;
223     }
224   #ifdef M_DEBUG
225     bp = mpi_debug_alloc_limb_space( a->nlimbs, 1, "set_secure" );
226   #else
227     bp = mpi_alloc_limb_space( a->nlimbs, 1 );
228   #endif
229     MPN_COPY( bp, ap, a->nlimbs );
230     a->d = bp;
231   #ifdef M_DEBUG
232     mpi_debug_free_limb_space(ap, "set_secure");
233   #else
234     mpi_free_limb_space(ap);
235   #endif
236 }
237
238
239 MPI
240 mpi_set_opaque( MPI a, void *p, int len )
241 {
242     if( !a ) {
243       #ifdef M_DEBUG
244         a = mpi_debug_alloc(0,"alloc_opaque");
245       #else
246         a = mpi_alloc(0);
247       #endif
248     }
249
250     if( a->flags & 4 )
251         m_free( a->d );
252     else {
253       #ifdef M_DEBUG
254         mpi_debug_free_limb_space(a->d, "alloc_opaque");
255       #else
256         mpi_free_limb_space(a->d);
257       #endif
258     }
259
260     a->d = p;
261     a->alloced = 0;
262     a->nlimbs = 0;
263     a->nbits = len;
264     a->flags = 4;
265     return a;
266 }
267
268
269 void *
270 mpi_get_opaque( MPI a, int *len )
271 {
272     if( !(a->flags & 4) )
273         log_bug("mpi_get_opaque on normal mpi\n");
274     if( len )
275         *len = a->nbits;
276     return a->d;
277 }
278
279
280 /****************
281  * Note: This copy function should not interpret the MPI
282  *       but copy it transparently.
283  */
284 MPI
285 #ifdef M_DEBUG
286 mpi_debug_copy( MPI a, const char *info )
287 #else
288 mpi_copy( MPI a )
289 #endif
290 {
291     int i;
292     MPI b;
293
294     if( a && (a->flags & 4) ) {
295         void *p = m_is_secure(a->d)? m_alloc_secure( a->nbits )
296                                    : m_alloc( a->nbits );
297         memcpy( p, a->d, a->nbits );
298         b = mpi_set_opaque( NULL, p, a->nbits );
299     }
300     else if( a ) {
301       #ifdef M_DEBUG
302         b = mpi_is_secure(a)? mpi_debug_alloc_secure( a->nlimbs, info )
303                             : mpi_debug_alloc( a->nlimbs, info );
304       #else
305         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
306                             : mpi_alloc( a->nlimbs );
307       #endif
308         b->nlimbs = a->nlimbs;
309         b->sign = a->sign;
310         b->flags  = a->flags;
311         b->nbits = a->nbits;
312         for(i=0; i < b->nlimbs; i++ )
313             b->d[i] = a->d[i];
314     }
315     else
316         b = NULL;
317     return b;
318 }
319
320
321 void
322 mpi_set( MPI w, MPI u)
323 {
324     mpi_ptr_t wp, up;
325     mpi_size_t usize = u->nlimbs;
326     int usign = u->sign;
327
328     RESIZE_IF_NEEDED(w, usize);
329     wp = w->d;
330     up = u->d;
331     MPN_COPY( wp, up, usize );
332     w->nlimbs = usize;
333     w->nbits = u->nbits;
334     w->flags = u->flags;
335     w->sign = usign;
336 }
337
338
339 void
340 mpi_set_ui( MPI w, unsigned long u)
341 {
342     RESIZE_IF_NEEDED(w, 1);
343     w->d[0] = u;
344     w->nlimbs = u? 1:0;
345     w->sign = 0;
346     w->nbits = 0;
347     w->flags = 0;
348 }
349
350
351 MPI
352 mpi_alloc_set_ui( unsigned long u)
353 {
354   #ifdef M_DEBUG
355     MPI w = mpi_debug_alloc(1,"alloc_set_ui");
356   #else
357     MPI w = mpi_alloc(1);
358   #endif
359     w->d[0] = u;
360     w->nlimbs = u? 1:0;
361     w->sign = 0;
362     return w;
363 }
364
365
366 void
367 mpi_swap( MPI a, MPI b)
368 {
369     struct mpi_struct tmp;
370
371     tmp = *a; *a = *b; *b = tmp;
372 }
373
374