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