Switched to GPLv3.
[gnupg.git] / mpi / mpiutil.c
1 /* mpiutil.ac  -  Utility functions for MPI
2  * Copyright (C) 1998, 1999 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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.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  * Note:  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 = xmalloc( 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 = xmalloc( 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 #if 0
106 static void *unused_limbs_5;
107 static void *unused_limbs_32;
108 static void *unused_limbs_64;
109 #endif
110
111 mpi_ptr_t
112 #ifdef M_DEBUG
113 mpi_debug_alloc_limb_space( unsigned nlimbs, int secure, const char *info )
114 #else
115 mpi_alloc_limb_space( unsigned nlimbs, int secure )
116 #endif
117 {
118     size_t len = nlimbs * sizeof(mpi_limb_t);
119     mpi_ptr_t p;
120
121     if( DBG_MEMORY )
122         log_debug("mpi_alloc_limb_space(%u)\n", (unsigned)len*8 );
123 #if 0
124     if( !secure ) {
125         if( nlimbs == 5 && unused_limbs_5 ) {  /* DSA 160 bits */
126             p = unused_limbs_5;
127             unused_limbs_5 = *p;
128             return p;
129         }
130         else if( nlimbs == 32 && unused_limbs_32 ) {  /* DSA 1024 bits */
131             p = unused_limbs_32;
132             unused_limbs_32 = *p;
133             return p;
134         }
135         else if( nlimbs == 64 && unused_limbs_64 ) {  /* DSA 2*1024 bits */
136             p = unused_limbs_64;
137             unused_limbs_64 = *p;
138             return p;
139         }
140     }
141 #endif
142
143 #ifdef M_DEBUG
144     p = secure? m_debug_alloc_secure(len, info):m_debug_alloc( len, info );
145 #else
146     p = secure? xmalloc_secure( len ):xmalloc( len );
147 #endif
148
149     return p;
150 }
151
152 void
153 #ifdef M_DEBUG
154 mpi_debug_free_limb_space( mpi_ptr_t a, const char *info )
155 #else
156 mpi_free_limb_space( mpi_ptr_t a )
157 #endif
158 {
159     if( !a )
160         return;
161     if( DBG_MEMORY )
162         log_debug("mpi_free_limb_space of size %lu\n", (ulong)m_size(a)*8 );
163
164 #if 0
165     if( !m_is_secure(a) ) {
166         size_t nlimbs = m_size(a) / 4 ;
167         void *p = a;
168
169         if( nlimbs == 5 ) {  /* DSA 160 bits */
170             *a = unused_limbs_5;
171             unused_limbs_5 = a;
172             return;
173         }
174         else if( nlimbs == 32 ) {  /* DSA 1024 bits */
175             *a = unused_limbs_32;
176             unused_limbs_32 = a;
177             return;
178         }
179         else if( nlimbs == 64 ) {  /* DSA 2*1024 bits */
180             *a = unused_limbs_64;
181             unused_limbs_64 = a;
182             return;
183         }
184     }
185 #endif
186
187     xfree(a);
188 }
189
190
191 void
192 mpi_assign_limb_space( MPI a, mpi_ptr_t ap, unsigned nlimbs )
193 {
194     mpi_free_limb_space(a->d);
195     a->d = ap;
196     a->alloced = nlimbs;
197 }
198
199
200
201 /****************
202  * Resize the array of A to NLIMBS. the additional space is cleared
203  * (set to 0) [done by xrealloc()]
204  */
205 void
206 #ifdef M_DEBUG
207 mpi_debug_resize( MPI a, unsigned nlimbs, const char *info )
208 #else
209 mpi_resize( MPI a, unsigned nlimbs )
210 #endif
211 {
212     if( nlimbs <= a->alloced )
213         return; /* no need to do it */
214     /* Note: a->secure is not used - instead the realloc functions
215      * take care of it. Maybe we should drop a->secure completely
216      * and rely on a mpi_is_secure function, which would be
217      * a wrapper around m_is_secure
218      */
219 #ifdef M_DEBUG
220     if( a->d )
221         a->d = m_debug_realloc(a->d, nlimbs * sizeof(mpi_limb_t), info );
222     else
223         a->d = m_debug_alloc_clear( nlimbs * sizeof(mpi_limb_t), info );
224 #else
225     if( a->d )
226         a->d = xrealloc(a->d, nlimbs * sizeof(mpi_limb_t) );
227     else
228         a->d = xmalloc_clear( nlimbs * sizeof(mpi_limb_t) );
229 #endif
230     a->alloced = nlimbs;
231 }
232
233 void
234 mpi_clear( MPI a )
235 {
236     a->nlimbs = 0;
237     a->nbits = 0;
238     a->flags = 0;
239 }
240
241
242 void
243 #ifdef M_DEBUG
244 mpi_debug_free( MPI a, const char *info )
245 #else
246 mpi_free( MPI a )
247 #endif
248 {
249     if( !a )
250         return;
251     if( DBG_MEMORY )
252         log_debug("mpi_free\n" );
253     if( a->flags & 4 )
254         xfree( a->d );
255     else {
256 #ifdef M_DEBUG
257         mpi_debug_free_limb_space(a->d, info);
258 #else
259         mpi_free_limb_space(a->d);
260 #endif
261     }
262     if( a->flags & ~7 )
263         log_bug("invalid flag value in mpi\n");
264     xfree(a);
265 }
266
267
268 void
269 mpi_set_secure( MPI a )
270 {
271     mpi_ptr_t ap, bp;
272
273     if( (a->flags & 1) )
274         return;
275     a->flags |= 1;
276     ap = a->d;
277     if( !a->nlimbs ) {
278         assert(!ap);
279         return;
280     }
281 #ifdef M_DEBUG
282     bp = mpi_debug_alloc_limb_space( a->nlimbs, 1, "set_secure" );
283 #else
284     bp = mpi_alloc_limb_space( a->nlimbs, 1 );
285 #endif
286     MPN_COPY( bp, ap, a->nlimbs );
287     a->d = bp;
288 #ifdef M_DEBUG
289     mpi_debug_free_limb_space(ap, "set_secure");
290 #else
291     mpi_free_limb_space(ap);
292 #endif
293 }
294
295
296 MPI
297 mpi_set_opaque( MPI a, void *p, unsigned int len )
298 {
299     if( !a ) {
300 #ifdef M_DEBUG
301         a = mpi_debug_alloc(0,"alloc_opaque");
302 #else
303         a = mpi_alloc(0);
304 #endif
305     }
306
307     if( a->flags & 4 )
308         xfree( a->d );
309     else {
310 #ifdef M_DEBUG
311         mpi_debug_free_limb_space(a->d, "alloc_opaque");
312 #else
313         mpi_free_limb_space(a->d);
314 #endif
315     }
316
317     a->d = p;
318     a->alloced = 0;
319     a->nlimbs = 0;
320     a->nbits = len;
321     a->flags = 4;
322     return a;
323 }
324
325
326 void *
327 mpi_get_opaque( MPI a, unsigned int *len )
328 {
329     if( !(a->flags & 4) )
330         log_bug("mpi_get_opaque on normal mpi\n");
331     if( len )
332         *len = a->nbits;
333     return a->d;
334 }
335
336
337 /****************
338  * Note: This copy function should not interpret the MPI
339  *       but copy it transparently.
340  */
341 MPI
342 #ifdef M_DEBUG
343 mpi_debug_copy( MPI a, const char *info )
344 #else
345 mpi_copy( MPI a )
346 #endif
347 {
348     int i;
349     MPI b;
350
351     if( a && (a->flags & 4) ) {
352         void *p = m_is_secure(a->d)? xmalloc_secure( a->nbits )
353                                    : xmalloc( a->nbits );
354         memcpy( p, a->d, a->nbits );
355         b = mpi_set_opaque( NULL, p, a->nbits );
356     }
357     else if( a ) {
358 #ifdef M_DEBUG
359         b = mpi_is_secure(a)? mpi_debug_alloc_secure( a->nlimbs, info )
360                             : mpi_debug_alloc( a->nlimbs, info );
361 #else
362         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
363                             : mpi_alloc( a->nlimbs );
364 #endif
365         b->nlimbs = a->nlimbs;
366         b->sign = a->sign;
367         b->flags  = a->flags;
368         b->nbits = a->nbits;
369         for(i=0; i < b->nlimbs; i++ )
370             b->d[i] = a->d[i];
371     }
372     else
373         b = NULL;
374     return b;
375 }
376
377
378 /****************
379  * This function allocates an MPI which is optimized to hold
380  * a value as large as the one given in the argument and allocates it
381  * with the same flags as A.
382  */
383 MPI
384 #ifdef M_DEBUG
385 mpi_debug_alloc_like( MPI a, const char *info )
386 #else
387 mpi_alloc_like( MPI a )
388 #endif
389 {
390     MPI b;
391
392     if( a && (a->flags & 4) ) {
393         void *p = m_is_secure(a->d)? xmalloc_secure( a->nbits )
394                                    : xmalloc( a->nbits );
395         memcpy( p, a->d, a->nbits );
396         b = mpi_set_opaque( NULL, p, a->nbits );
397     }
398     else if( a ) {
399 #ifdef M_DEBUG
400         b = mpi_is_secure(a)? mpi_debug_alloc_secure( a->nlimbs, info )
401                             : mpi_debug_alloc( a->nlimbs, info );
402 #else
403         b = mpi_is_secure(a)? mpi_alloc_secure( a->nlimbs )
404                             : mpi_alloc( a->nlimbs );
405 #endif
406         b->nlimbs = 0;
407         b->sign = 0;
408         b->flags = a->flags;
409         b->nbits = 0;
410     }
411     else
412         b = NULL;
413     return b;
414 }
415
416
417 void
418 mpi_set( MPI w, MPI u)
419 {
420     mpi_ptr_t wp, up;
421     mpi_size_t usize = u->nlimbs;
422     int usign = u->sign;
423
424     RESIZE_IF_NEEDED(w, usize);
425     wp = w->d;
426     up = u->d;
427     MPN_COPY( wp, up, usize );
428     w->nlimbs = usize;
429     w->nbits = u->nbits;
430     w->flags = u->flags;
431     w->sign = usign;
432 }
433
434
435 void
436 mpi_set_ui( MPI w, unsigned long u)
437 {
438     RESIZE_IF_NEEDED(w, 1);
439     w->d[0] = u;
440     w->nlimbs = u? 1:0;
441     w->sign = 0;
442     w->nbits = 0;
443     w->flags = 0;
444 }
445
446
447 MPI
448 mpi_alloc_set_ui( unsigned long u)
449 {
450 #ifdef M_DEBUG
451     MPI w = mpi_debug_alloc(1,"alloc_set_ui");
452 #else
453     MPI w = mpi_alloc(1);
454 #endif
455     w->d[0] = u;
456     w->nlimbs = u? 1:0;
457     w->sign = 0;
458     return w;
459 }
460
461
462 void
463 mpi_swap( MPI a, MPI b)
464 {
465     struct gcry_mpi tmp;
466
467     tmp = *a; *a = *b; *b = tmp;
468 }
469
470
471 int
472 mpi_get_nlimbs (MPI a)
473 {
474   return a->nlimbs;
475 }
476
477
478 int 
479 mpi_is_neg (MPI a)
480 {
481   return a->sign;
482 }
483
484
485 /* Return the number of limbs to store an MPI which is specified by
486    the number of bytes to represent it. */
487 unsigned int
488 mpi_nlimb_hint_from_nbytes (unsigned int nbytes)
489 {
490   return (nbytes+BYTES_PER_MPI_LIMB-1) / BYTES_PER_MPI_LIMB;
491 }
492
493 /* Return the number of limbs to store an MPI which is specified by
494    the number of bytes to represent it. */
495 unsigned int
496 mpi_nlimb_hint_from_nbits (unsigned int nbits)
497 {
498   return (nbits+BITS_PER_MPI_LIMB-1) / BITS_PER_MPI_LIMB;
499 }
500
501 unsigned int
502 mpi_get_flags (MPI a)
503 {
504   return a->flags;
505 }