* gpgkeys_hkp.c (send_key, get_key, get_name, search_key, main): Add
[gnupg.git] / mpi / mpih-div.c
1 /* mpihelp-div.c  -  MPI helper functions
2  *      Copyright (C) 1994, 1996 Free Software Foundation, Inc.
3  *      Copyright (C) 1998, 1999 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG 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 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG 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, see <http://www.gnu.org/licenses/>.
19  *
20  * Note: This code is heavily based on the GNU MP Library.
21  *       Actually it's the same code with only minor changes in the
22  *       way the data is stored; this is to support the abstraction
23  *       of an optional secure memory allocation which may be used
24  *       to avoid revealing of sensitive data due to paging etc.
25  *       The GNU MP Library itself is published under the LGPL;
26  *       however I decided to publish this code under the plain GPL.
27  */
28
29 #include <config.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include "mpi-internal.h"
33 #include "longlong.h"
34
35 #ifndef UMUL_TIME
36 #define UMUL_TIME 1
37 #endif
38 #ifndef UDIV_TIME
39 #define UDIV_TIME UMUL_TIME
40 #endif
41
42 /* FIXME: We should be using invert_limb (or invert_normalized_limb)
43  * here (not udiv_qrnnd).
44  */
45
46 mpi_limb_t
47 mpihelp_mod_1(mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
48                                       mpi_limb_t divisor_limb)
49 {
50     mpi_size_t i;
51     mpi_limb_t n1, n0, r;
52     int dummy;
53
54     /* Botch: Should this be handled at all?  Rely on callers?  */
55     if( !dividend_size )
56         return 0;
57
58     /* If multiplication is much faster than division, and the
59      * dividend is large, pre-invert the divisor, and use
60      * only multiplications in the inner loop.
61      *
62      * This test should be read:
63      *   Does it ever help to use udiv_qrnnd_preinv?
64      *     && Does what we save compensate for the inversion overhead?
65      */
66     if( UDIV_TIME > (2 * UMUL_TIME + 6)
67         && (UDIV_TIME - (2 * UMUL_TIME + 6)) * dividend_size > UDIV_TIME ) {
68         int normalization_steps;
69
70         count_leading_zeros( normalization_steps, divisor_limb );
71         if( normalization_steps ) {
72             mpi_limb_t divisor_limb_inverted;
73
74             divisor_limb <<= normalization_steps;
75
76             /* Compute (2**2N - 2**N * DIVISOR_LIMB) / DIVISOR_LIMB.  The
77              * result is a (N+1)-bit approximation to 1/DIVISOR_LIMB, with the
78              * most significant bit (with weight 2**N) implicit.
79              *
80              * Special case for DIVISOR_LIMB == 100...000.
81              */
82             if( !(divisor_limb << 1) )
83                 divisor_limb_inverted = ~(mpi_limb_t)0;
84             else
85                 udiv_qrnnd(divisor_limb_inverted, dummy,
86                            -divisor_limb, 0, divisor_limb);
87
88             n1 = dividend_ptr[dividend_size - 1];
89             r = n1 >> (BITS_PER_MPI_LIMB - normalization_steps);
90
91             /* Possible optimization:
92              * if (r == 0
93              * && divisor_limb > ((n1 << normalization_steps)
94              *                 | (dividend_ptr[dividend_size - 2] >> ...)))
95              * ...one division less...
96              */
97             for( i = dividend_size - 2; i >= 0; i--) {
98                 n0 = dividend_ptr[i];
99                 UDIV_QRNND_PREINV(dummy, r, r,
100                                    ((n1 << normalization_steps)
101                           | (n0 >> (BITS_PER_MPI_LIMB - normalization_steps))),
102                           divisor_limb, divisor_limb_inverted);
103                 n1 = n0;
104             }
105             UDIV_QRNND_PREINV(dummy, r, r,
106                               n1 << normalization_steps,
107                               divisor_limb, divisor_limb_inverted);
108             return r >> normalization_steps;
109         }
110         else {
111             mpi_limb_t divisor_limb_inverted;
112
113             /* Compute (2**2N - 2**N * DIVISOR_LIMB) / DIVISOR_LIMB.  The
114              * result is a (N+1)-bit approximation to 1/DIVISOR_LIMB, with the
115              * most significant bit (with weight 2**N) implicit.
116              *
117              * Special case for DIVISOR_LIMB == 100...000.
118              */
119             if( !(divisor_limb << 1) )
120                 divisor_limb_inverted = ~(mpi_limb_t)0;
121             else
122                 udiv_qrnnd(divisor_limb_inverted, dummy,
123                             -divisor_limb, 0, divisor_limb);
124
125             i = dividend_size - 1;
126             r = dividend_ptr[i];
127
128             if( r >= divisor_limb )
129                 r = 0;
130             else
131                 i--;
132
133             for( ; i >= 0; i--) {
134                 n0 = dividend_ptr[i];
135                 UDIV_QRNND_PREINV(dummy, r, r,
136                                   n0, divisor_limb, divisor_limb_inverted);
137             }
138             return r;
139         }
140     }
141     else {
142         if( UDIV_NEEDS_NORMALIZATION ) {
143             int normalization_steps;
144
145             count_leading_zeros(normalization_steps, divisor_limb);
146             if( normalization_steps ) {
147                 divisor_limb <<= normalization_steps;
148
149                 n1 = dividend_ptr[dividend_size - 1];
150                 r = n1 >> (BITS_PER_MPI_LIMB - normalization_steps);
151
152                 /* Possible optimization:
153                  * if (r == 0
154                  * && divisor_limb > ((n1 << normalization_steps)
155                  *                 | (dividend_ptr[dividend_size - 2] >> ...)))
156                  * ...one division less...
157                  */
158                 for(i = dividend_size - 2; i >= 0; i--) {
159                     n0 = dividend_ptr[i];
160                     udiv_qrnnd (dummy, r, r,
161                                 ((n1 << normalization_steps)
162                          | (n0 >> (BITS_PER_MPI_LIMB - normalization_steps))),
163                          divisor_limb);
164                     n1 = n0;
165                 }
166                 udiv_qrnnd (dummy, r, r,
167                             n1 << normalization_steps,
168                             divisor_limb);
169                 return r >> normalization_steps;
170             }
171         }
172         /* No normalization needed, either because udiv_qrnnd doesn't require
173          * it, or because DIVISOR_LIMB is already normalized.  */
174         i = dividend_size - 1;
175         r = dividend_ptr[i];
176
177         if(r >= divisor_limb)
178             r = 0;
179         else
180             i--;
181
182         for(; i >= 0; i--) {
183             n0 = dividend_ptr[i];
184             udiv_qrnnd (dummy, r, r, n0, divisor_limb);
185         }
186         return r;
187     }
188 }
189
190 /* Divide num (NP/NSIZE) by den (DP/DSIZE) and write
191  * the NSIZE-DSIZE least significant quotient limbs at QP
192  * and the DSIZE long remainder at NP.  If QEXTRA_LIMBS is
193  * non-zero, generate that many fraction bits and append them after the
194  * other quotient limbs.
195  * Return the most significant limb of the quotient, this is always 0 or 1.
196  *
197  * Preconditions:
198  * 0. NSIZE >= DSIZE.
199  * 1. The most significant bit of the divisor must be set.
200  * 2. QP must either not overlap with the input operands at all, or
201  *    QP + DSIZE >= NP must hold true.  (This means that it's
202  *    possible to put the quotient in the high part of NUM, right after the
203  *    remainder in NUM.
204  * 3. NSIZE >= DSIZE, even if QEXTRA_LIMBS is non-zero.
205  */
206
207 mpi_limb_t
208 mpihelp_divrem( mpi_ptr_t qp, mpi_size_t qextra_limbs,
209                 mpi_ptr_t np, mpi_size_t nsize,
210                 mpi_ptr_t dp, mpi_size_t dsize)
211 {
212     mpi_limb_t most_significant_q_limb = 0;
213
214     switch(dsize) {
215       case 0:
216         /* We are asked to divide by zero, so go ahead and do it!  (To make
217            the compiler not remove this statement, return the value.)  */
218         return 1 / dsize;
219
220       case 1:
221         {
222             mpi_size_t i;
223             mpi_limb_t n1;
224             mpi_limb_t d;
225
226             d = dp[0];
227             n1 = np[nsize - 1];
228
229             if( n1 >= d ) {
230                 n1 -= d;
231                 most_significant_q_limb = 1;
232             }
233
234             qp += qextra_limbs;
235             for( i = nsize - 2; i >= 0; i--)
236                 udiv_qrnnd( qp[i], n1, n1, np[i], d );
237             qp -= qextra_limbs;
238
239             for( i = qextra_limbs - 1; i >= 0; i-- )
240                 udiv_qrnnd (qp[i], n1, n1, 0, d);
241
242             np[0] = n1;
243         }
244         break;
245
246       case 2:
247         {
248             mpi_size_t i;
249             mpi_limb_t n1, n0, n2;
250             mpi_limb_t d1, d0;
251
252             np += nsize - 2;
253             d1 = dp[1];
254             d0 = dp[0];
255             n1 = np[1];
256             n0 = np[0];
257
258             if( n1 >= d1 && (n1 > d1 || n0 >= d0) ) {
259                 sub_ddmmss (n1, n0, n1, n0, d1, d0);
260                 most_significant_q_limb = 1;
261             }
262
263             for( i = qextra_limbs + nsize - 2 - 1; i >= 0; i-- ) {
264                 mpi_limb_t q;
265                 mpi_limb_t r;
266
267                 if( i >= qextra_limbs )
268                     np--;
269                 else
270                     np[0] = 0;
271
272                 if( n1 == d1 ) {
273                     /* Q should be either 111..111 or 111..110.  Need special
274                      * treatment of this rare case as normal division would
275                      * give overflow.  */
276                     q = ~(mpi_limb_t)0;
277
278                     r = n0 + d1;
279                     if( r < d1 ) {   /* Carry in the addition? */
280                         add_ssaaaa( n1, n0, r - d0, np[0], 0, d0 );
281                         qp[i] = q;
282                         continue;
283                     }
284                     n1 = d0 - (d0 != 0?1:0);
285                     n0 = -d0;
286                 }
287                 else {
288                     udiv_qrnnd (q, r, n1, n0, d1);
289                     umul_ppmm (n1, n0, d0, q);
290                 }
291
292                 n2 = np[0];
293               q_test:
294                 if( n1 > r || (n1 == r && n0 > n2) ) {
295                     /* The estimated Q was too large.  */
296                     q--;
297                     sub_ddmmss (n1, n0, n1, n0, 0, d0);
298                     r += d1;
299                     if( r >= d1 )    /* If not carry, test Q again.  */
300                         goto q_test;
301                 }
302
303                 qp[i] = q;
304                 sub_ddmmss (n1, n0, r, n2, n1, n0);
305             }
306             np[1] = n1;
307             np[0] = n0;
308         }
309         break;
310
311       default:
312         {
313             mpi_size_t i;
314             mpi_limb_t dX, d1, n0;
315
316             np += nsize - dsize;
317             dX = dp[dsize - 1];
318             d1 = dp[dsize - 2];
319             n0 = np[dsize - 1];
320
321             if( n0 >= dX ) {
322                 if(n0 > dX || mpihelp_cmp(np, dp, dsize - 1) >= 0 ) {
323                     mpihelp_sub_n(np, np, dp, dsize);
324                     n0 = np[dsize - 1];
325                     most_significant_q_limb = 1;
326                 }
327             }
328
329             for( i = qextra_limbs + nsize - dsize - 1; i >= 0; i--) {
330                 mpi_limb_t q;
331                 mpi_limb_t n1, n2;
332                 mpi_limb_t cy_limb;
333
334                 if( i >= qextra_limbs ) {
335                     np--;
336                     n2 = np[dsize];
337                 }
338                 else {
339                     n2 = np[dsize - 1];
340                     MPN_COPY_DECR (np + 1, np, dsize - 1);
341                     np[0] = 0;
342                 }
343
344                 if( n0 == dX ) {
345                     /* This might over-estimate q, but it's probably not worth
346                      * the extra code here to find out.  */
347                     q = ~(mpi_limb_t)0;
348                 }
349                 else {
350                     mpi_limb_t r;
351
352                     udiv_qrnnd(q, r, n0, np[dsize - 1], dX);
353                     umul_ppmm(n1, n0, d1, q);
354
355                     while( n1 > r || (n1 == r && n0 > np[dsize - 2])) {
356                         q--;
357                         r += dX;
358                         if( r < dX ) /* I.e. "carry in previous addition?" */
359                             break;
360                         n1 -= n0 < d1;
361                         n0 -= d1;
362                     }
363                 }
364
365                 /* Possible optimization: We already have (q * n0) and (1 * n1)
366                  * after the calculation of q.  Taking advantage of that, we
367                  * could make this loop make two iterations less.  */
368                 cy_limb = mpihelp_submul_1(np, dp, dsize, q);
369
370                 if( n2 != cy_limb ) {
371                     mpihelp_add_n(np, np, dp, dsize);
372                     q--;
373                 }
374
375                 qp[i] = q;
376                 n0 = np[dsize - 1];
377             }
378         }
379     }
380
381     return most_significant_q_limb;
382 }
383
384
385 /****************
386  * Divide (DIVIDEND_PTR,,DIVIDEND_SIZE) by DIVISOR_LIMB.
387  * Write DIVIDEND_SIZE limbs of quotient at QUOT_PTR.
388  * Return the single-limb remainder.
389  * There are no constraints on the value of the divisor.
390  *
391  * QUOT_PTR and DIVIDEND_PTR might point to the same limb.
392  */
393
394 mpi_limb_t
395 mpihelp_divmod_1( mpi_ptr_t quot_ptr,
396                   mpi_ptr_t dividend_ptr, mpi_size_t dividend_size,
397                   mpi_limb_t divisor_limb)
398 {
399     mpi_size_t i;
400     mpi_limb_t n1, n0, r;
401     int dummy;
402
403     if( !dividend_size )
404         return 0;
405
406     /* If multiplication is much faster than division, and the
407      * dividend is large, pre-invert the divisor, and use
408      * only multiplications in the inner loop.
409      *
410      * This test should be read:
411      * Does it ever help to use udiv_qrnnd_preinv?
412      * && Does what we save compensate for the inversion overhead?
413      */
414     if( UDIV_TIME > (2 * UMUL_TIME + 6)
415         && (UDIV_TIME - (2 * UMUL_TIME + 6)) * dividend_size > UDIV_TIME ) {
416         int normalization_steps;
417
418         count_leading_zeros( normalization_steps, divisor_limb );
419         if( normalization_steps ) {
420             mpi_limb_t divisor_limb_inverted;
421
422             divisor_limb <<= normalization_steps;
423
424             /* Compute (2**2N - 2**N * DIVISOR_LIMB) / DIVISOR_LIMB.  The
425              * result is a (N+1)-bit approximation to 1/DIVISOR_LIMB, with the
426              * most significant bit (with weight 2**N) implicit.
427              */
428             /* Special case for DIVISOR_LIMB == 100...000.  */
429             if( !(divisor_limb << 1) )
430                 divisor_limb_inverted = ~(mpi_limb_t)0;
431             else
432                 udiv_qrnnd(divisor_limb_inverted, dummy,
433                            -divisor_limb, 0, divisor_limb);
434
435             n1 = dividend_ptr[dividend_size - 1];
436             r = n1 >> (BITS_PER_MPI_LIMB - normalization_steps);
437
438             /* Possible optimization:
439              * if (r == 0
440              * && divisor_limb > ((n1 << normalization_steps)
441              *                 | (dividend_ptr[dividend_size - 2] >> ...)))
442              * ...one division less...
443              */
444             for( i = dividend_size - 2; i >= 0; i--) {
445                 n0 = dividend_ptr[i];
446                 UDIV_QRNND_PREINV( quot_ptr[i + 1], r, r,
447                                    ((n1 << normalization_steps)
448                          | (n0 >> (BITS_PER_MPI_LIMB - normalization_steps))),
449                               divisor_limb, divisor_limb_inverted);
450                 n1 = n0;
451             }
452             UDIV_QRNND_PREINV( quot_ptr[0], r, r,
453                                n1 << normalization_steps,
454                                divisor_limb, divisor_limb_inverted);
455             return r >> normalization_steps;
456         }
457         else {
458             mpi_limb_t divisor_limb_inverted;
459
460             /* Compute (2**2N - 2**N * DIVISOR_LIMB) / DIVISOR_LIMB.  The
461              * result is a (N+1)-bit approximation to 1/DIVISOR_LIMB, with the
462              * most significant bit (with weight 2**N) implicit.
463              */
464             /* Special case for DIVISOR_LIMB == 100...000.  */
465             if( !(divisor_limb << 1) )
466                 divisor_limb_inverted = ~(mpi_limb_t) 0;
467             else
468                 udiv_qrnnd(divisor_limb_inverted, dummy,
469                            -divisor_limb, 0, divisor_limb);
470
471             i = dividend_size - 1;
472             r = dividend_ptr[i];
473
474             if( r >= divisor_limb )
475                 r = 0;
476             else
477                 quot_ptr[i--] = 0;
478
479             for( ; i >= 0; i-- ) {
480                 n0 = dividend_ptr[i];
481                 UDIV_QRNND_PREINV( quot_ptr[i], r, r,
482                                    n0, divisor_limb, divisor_limb_inverted);
483             }
484             return r;
485         }
486     }
487     else {
488         if(UDIV_NEEDS_NORMALIZATION) {
489             int normalization_steps;
490
491             count_leading_zeros (normalization_steps, divisor_limb);
492             if( normalization_steps ) {
493                 divisor_limb <<= normalization_steps;
494
495                 n1 = dividend_ptr[dividend_size - 1];
496                 r = n1 >> (BITS_PER_MPI_LIMB - normalization_steps);
497
498                 /* Possible optimization:
499                  * if (r == 0
500                  * && divisor_limb > ((n1 << normalization_steps)
501                  *                 | (dividend_ptr[dividend_size - 2] >> ...)))
502                  * ...one division less...
503                  */
504                 for( i = dividend_size - 2; i >= 0; i--) {
505                     n0 = dividend_ptr[i];
506                     udiv_qrnnd (quot_ptr[i + 1], r, r,
507                              ((n1 << normalization_steps)
508                          | (n0 >> (BITS_PER_MPI_LIMB - normalization_steps))),
509                                 divisor_limb);
510                     n1 = n0;
511                 }
512                 udiv_qrnnd (quot_ptr[0], r, r,
513                             n1 << normalization_steps,
514                             divisor_limb);
515                 return r >> normalization_steps;
516             }
517         }
518         /* No normalization needed, either because udiv_qrnnd doesn't require
519          * it, or because DIVISOR_LIMB is already normalized.  */
520         i = dividend_size - 1;
521         r = dividend_ptr[i];
522
523         if(r >= divisor_limb)
524             r = 0;
525         else
526             quot_ptr[i--] = 0;
527
528         for(; i >= 0; i--) {
529             n0 = dividend_ptr[i];
530             udiv_qrnnd( quot_ptr[i], r, r, n0, divisor_limb );
531         }
532         return r;
533     }
534 }