326e95227b0ca97d4d9b390f64051f7af6949670
[libgcrypt.git] / mpi / mpi-bit.c
1 /* mpi-bit.c  -  MPI bit level fucntions
2  * Copyright (C) 1998, 1999, 2001, 2002, 2006 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt 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 Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License 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 #include "mpi-internal.h"
26 #include "longlong.h"
27
28
29 #ifdef MPI_INTERNAL_NEED_CLZ_TAB
30 #ifdef __STDC__
31 const
32 #endif
33 unsigned char
34 _gcry_clz_tab[] =
35 {
36   0,1,2,2,3,3,3,3,4,4,4,4,4,4,4,4,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,
37   6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,
38   7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
39   7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
40   8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,
41   8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,
42   8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,
43   8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,
44 };
45 #endif
46
47
48 #define A_LIMB_1 ((mpi_limb_t)1)
49
50
51 /****************
52  * Sometimes we have MSL (most significant limbs) which are 0;
53  * this is for some reasons not good, so this function removes them.
54  */
55 void
56 _gcry_mpi_normalize( gcry_mpi_t a )
57 {
58     if( mpi_is_opaque(a) )
59         return;
60
61     for( ; a->nlimbs && !a->d[a->nlimbs-1]; a->nlimbs-- )
62         ;
63 }
64
65
66
67 /****************
68  * Return the number of bits in A.
69  */
70 unsigned int
71 gcry_mpi_get_nbits( gcry_mpi_t a )
72 {
73     unsigned n;
74
75     if( mpi_is_opaque(a) ) {
76         return a->sign; /* which holds the number of bits */
77     }
78
79     _gcry_mpi_normalize( a );
80     if( a->nlimbs ) {
81         mpi_limb_t alimb = a->d[a->nlimbs-1];
82         if( alimb )
83             count_leading_zeros( n, alimb );
84         else
85             n = BITS_PER_MPI_LIMB;
86         n = BITS_PER_MPI_LIMB - n + (a->nlimbs-1) * BITS_PER_MPI_LIMB;
87     }
88     else
89         n = 0;
90     return n;
91 }
92
93
94 /****************
95  * Test whether bit N is set.
96  */
97 int
98 gcry_mpi_test_bit( gcry_mpi_t a, unsigned int n )
99 {
100     unsigned int limbno, bitno;
101     mpi_limb_t limb;
102
103     limbno = n / BITS_PER_MPI_LIMB;
104     bitno  = n % BITS_PER_MPI_LIMB;
105
106     if( limbno >= a->nlimbs )
107         return 0; /* too far left: this is a 0 */
108     limb = a->d[limbno];
109     return (limb & (A_LIMB_1 << bitno))? 1: 0;
110 }
111
112
113 /****************
114  * Set bit N of A.
115  */
116 void
117 gcry_mpi_set_bit( gcry_mpi_t a, unsigned int n )
118 {
119   unsigned int limbno, bitno;
120
121   limbno = n / BITS_PER_MPI_LIMB;
122   bitno  = n % BITS_PER_MPI_LIMB;
123
124   if ( limbno >= a->nlimbs ) 
125     {
126       mpi_resize (a, limbno+1 );
127       a->nlimbs = limbno+1;
128     }
129   a->d[limbno] |= (A_LIMB_1<<bitno);
130 }
131
132 /****************
133  * Set bit N of A. and clear all bits above
134  */
135 void
136 gcry_mpi_set_highbit( gcry_mpi_t a, unsigned int n )
137 {
138   unsigned int limbno, bitno;
139   
140   limbno = n / BITS_PER_MPI_LIMB;
141   bitno  = n % BITS_PER_MPI_LIMB;
142   
143   if ( limbno >= a->nlimbs ) 
144     { 
145       mpi_resize (a, limbno+1 );
146       a->nlimbs = limbno+1;
147     }
148   a->d[limbno] |= (A_LIMB_1<<bitno);
149   for ( bitno++; bitno < BITS_PER_MPI_LIMB; bitno++ )
150     a->d[limbno] &= ~(A_LIMB_1 << bitno);
151   a->nlimbs = limbno+1;
152 }
153
154 /****************
155  * clear bit N of A and all bits above
156  */
157 void
158 gcry_mpi_clear_highbit( gcry_mpi_t a, unsigned int n )
159 {
160     unsigned int limbno, bitno;
161
162     limbno = n / BITS_PER_MPI_LIMB;
163     bitno  = n % BITS_PER_MPI_LIMB;
164
165     if( limbno >= a->nlimbs )
166         return; /* not allocated, therefore no need to clear bits
167                    :-) */
168
169     for( ; bitno < BITS_PER_MPI_LIMB; bitno++ )
170         a->d[limbno] &= ~(A_LIMB_1 << bitno);
171     a->nlimbs = limbno+1;
172 }
173
174 /****************
175  * Clear bit N of A.
176  */
177 void
178 gcry_mpi_clear_bit( gcry_mpi_t a, unsigned int n )
179 {
180     unsigned int limbno, bitno;
181
182     limbno = n / BITS_PER_MPI_LIMB;
183     bitno  = n % BITS_PER_MPI_LIMB;
184
185     if( limbno >= a->nlimbs )
186         return; /* don't need to clear this bit, it's to far to left */
187     a->d[limbno] &= ~(A_LIMB_1 << bitno);
188 }
189
190
191 /****************
192  * Shift A by COUNT limbs to the right
193  * This is used only within the MPI library
194  */
195 void
196 _gcry_mpi_rshift_limbs( gcry_mpi_t a, unsigned int count )
197 {
198     mpi_ptr_t ap = a->d;
199     mpi_size_t n = a->nlimbs;
200     unsigned int i;
201
202     if( count >= n ) {
203         a->nlimbs = 0;
204         return;
205     }
206
207     for( i = 0; i < n - count; i++ )
208         ap[i] = ap[i+count];
209     ap[i] = 0;
210     a->nlimbs -= count;
211 }
212
213
214 /*
215  * Shift A by N bits to the right.
216  */
217 void
218 gcry_mpi_rshift ( gcry_mpi_t x, gcry_mpi_t a, unsigned int n )
219 {
220   mpi_size_t xsize;
221   unsigned int i;
222   unsigned int nlimbs = (n/BITS_PER_MPI_LIMB);
223   unsigned int nbits = (n%BITS_PER_MPI_LIMB);
224
225   if ( x == a )
226     {
227       /* In-place operation.  */
228       if ( nlimbs >= x->nlimbs )
229         {
230           x->nlimbs = 0;
231           return;
232         }
233
234       if (nlimbs)
235         {
236           for (i=0; i < x->nlimbs - nlimbs; i++ )
237             x->d[i] = x->d[i+nlimbs];
238           x->d[i] = 0;
239           x->nlimbs -= nlimbs;
240
241         }
242       if ( x->nlimbs && nbits )
243         _gcry_mpih_rshift ( x->d, x->d, x->nlimbs, nbits );
244     }
245   else if ( nlimbs )
246     {
247       /* Copy and shift by more or equal bits than in a limb. */
248       xsize = a->nlimbs;
249       x->sign = a->sign;
250       RESIZE_IF_NEEDED (x, xsize);
251       x->nlimbs = xsize;
252       for (i=0; i < a->nlimbs; i++ )
253         x->d[i] = a->d[i];
254       x->nlimbs = i;
255
256       if ( nlimbs >= x->nlimbs )
257         {
258           x->nlimbs = 0;
259           return;
260         }
261
262       if (nlimbs)
263         {
264           for (i=0; i < x->nlimbs - nlimbs; i++ )
265             x->d[i] = x->d[i+nlimbs];
266           x->d[i] = 0;
267           x->nlimbs -= nlimbs;
268         }
269
270       if ( x->nlimbs && nbits )
271         _gcry_mpih_rshift ( x->d, x->d, x->nlimbs, nbits );
272     }
273   else
274     {
275       /* Copy and shift by less than bits in a limb.  */
276       xsize = a->nlimbs;
277       x->sign = a->sign;
278       RESIZE_IF_NEEDED (x, xsize);
279       x->nlimbs = xsize;
280       
281       if ( xsize )
282         {
283           if (nbits )
284             _gcry_mpih_rshift (x->d, a->d, x->nlimbs, nbits );
285           else
286             {
287               /* The rshift helper function is not specified for
288                  NBITS==0, thus we do a plain copy here. */
289               for (i=0; i < x->nlimbs; i++ )
290                 x->d[i] = a->d[i];
291             }
292         }
293     }
294   MPN_NORMALIZE (x->d, x->nlimbs);
295 }
296
297
298 /****************
299  * Shift A by COUNT limbs to the left
300  * This is used only within the MPI library
301  */
302 void
303 _gcry_mpi_lshift_limbs (gcry_mpi_t a, unsigned int count)
304 {
305   mpi_ptr_t ap;
306   int n = a->nlimbs;
307   int i;
308
309   if (!count || !n)
310     return;
311
312   RESIZE_IF_NEEDED (a, n+count);
313
314   ap = a->d;
315   for (i = n-1; i >= 0; i--)
316     ap[i+count] = ap[i];
317   for (i=0; i < count; i++ )
318     ap[i] = 0;
319   a->nlimbs += count;
320 }
321
322
323 /*
324  * Shift A by N bits to the left.
325  */
326 void
327 gcry_mpi_lshift ( gcry_mpi_t x, gcry_mpi_t a, unsigned int n )
328 {
329   unsigned int nlimbs = (n/BITS_PER_MPI_LIMB);
330   unsigned int nbits = (n%BITS_PER_MPI_LIMB);
331
332   if (x == a && !n)
333     return;  /* In-place shift with an amount of zero.  */
334
335   if ( x != a )
336     {
337       /* Copy A to X.  */
338       unsigned int alimbs = a->nlimbs;
339       int asign  = a->sign;
340       mpi_ptr_t xp, ap;
341
342       RESIZE_IF_NEEDED (x, alimbs+nlimbs+1);
343       xp = x->d;
344       ap = a->d;
345       MPN_COPY (xp, ap, alimbs);
346       x->nlimbs = alimbs;
347       x->flags = a->flags;
348       x->sign = asign;
349     }
350
351   if (nlimbs && !nbits)
352     {
353       /* Shift a full number of limbs.  */
354       _gcry_mpi_lshift_limbs (x, nlimbs);
355     }
356   else if (n)
357     {
358       /* We use a very dump approach: Shift left by the number of
359          limbs plus one and than fix it up by an rshift.  */
360       _gcry_mpi_lshift_limbs (x, nlimbs+1);
361       gcry_mpi_rshift (x, x, BITS_PER_MPI_LIMB - nbits);
362     }
363
364   MPN_NORMALIZE (x->d, x->nlimbs);
365 }
366