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.
5 * This file is part of GnuPG.
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 2 of the License, or
10 * (at your option) any later version.
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.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
21 * Note: This code is heavily based on the GNU MP Library.
22 * Actually it's the same code with only minor changes in the
23 * way the data is stored; this is to support the abstraction
24 * of an optional secure memory allocation which may be used
25 * to avoid revealing of sensitive data due to paging etc.
26 * The GNU MP Library itself is published under the LGPL;
27 * however I decided to publish this code under the plain GPL.
30 #include "mpi-internal.h"
37 #define UDIV_TIME UMUL_TIME
40 /* FIXME: We should be using invert_limb (or invert_normalized_limb)
41 * here (not udiv_qrnnd).
45 mpihelp_mod_1(mpi_ptr_t dividend_ptr
, mpi_size_t dividend_size
,
46 mpi_limb_t divisor_limb
)
52 /* Botch: Should this be handled at all? Rely on callers? */
56 /* If multiplication is much faster than division, and the
57 * dividend is large, pre-invert the divisor, and use
58 * only multiplications in the inner loop.
60 * This test should be read:
61 * Does it ever help to use udiv_qrnnd_preinv?
62 * && Does what we save compensate for the inversion overhead?
64 if (UDIV_TIME
> (2 * UMUL_TIME
+ 6)
65 && (UDIV_TIME
- (2 * UMUL_TIME
+ 6)) * dividend_size
> UDIV_TIME
) {
66 int normalization_steps
;
68 count_leading_zeros(normalization_steps
, divisor_limb
);
69 if (normalization_steps
) {
70 mpi_limb_t divisor_limb_inverted
;
72 divisor_limb
<<= normalization_steps
;
74 /* Compute (2**2N - 2**N * DIVISOR_LIMB) / DIVISOR_LIMB. The
75 * result is a (N+1)-bit approximation to 1/DIVISOR_LIMB, with the
76 * most significant bit (with weight 2**N) implicit.
78 * Special case for DIVISOR_LIMB == 100...000.
80 if (!(divisor_limb
<< 1))
81 divisor_limb_inverted
= ~(mpi_limb_t
) 0;
83 udiv_qrnnd(divisor_limb_inverted
, dummy
,
84 -divisor_limb
, 0, divisor_limb
);
86 n1
= dividend_ptr
[dividend_size
- 1];
87 r
= n1
>> (BITS_PER_MPI_LIMB
- normalization_steps
);
89 /* Possible optimization:
91 * && divisor_limb > ((n1 << normalization_steps)
92 * | (dividend_ptr[dividend_size - 2] >> ...)))
93 * ...one division less...
95 for (i
= dividend_size
- 2; i
>= 0; i
--) {
97 UDIV_QRNND_PREINV(dummy
, r
, r
,
98 ((n1
<< normalization_steps
)
101 normalization_steps
))),
103 divisor_limb_inverted
);
106 UDIV_QRNND_PREINV(dummy
, r
, r
,
107 n1
<< normalization_steps
,
108 divisor_limb
, divisor_limb_inverted
);
109 return r
>> normalization_steps
;
111 mpi_limb_t divisor_limb_inverted
;
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.
117 * Special case for DIVISOR_LIMB == 100...000.
119 if (!(divisor_limb
<< 1))
120 divisor_limb_inverted
= ~(mpi_limb_t
) 0;
122 udiv_qrnnd(divisor_limb_inverted
, dummy
,
123 -divisor_limb
, 0, divisor_limb
);
125 i
= dividend_size
- 1;
128 if (r
>= divisor_limb
)
133 for (; i
>= 0; i
--) {
134 n0
= dividend_ptr
[i
];
135 UDIV_QRNND_PREINV(dummy
, r
, r
,
137 divisor_limb_inverted
);
142 if (UDIV_NEEDS_NORMALIZATION
) {
143 int normalization_steps
;
145 count_leading_zeros(normalization_steps
, divisor_limb
);
146 if (normalization_steps
) {
147 divisor_limb
<<= normalization_steps
;
149 n1
= dividend_ptr
[dividend_size
- 1];
150 r
= n1
>> (BITS_PER_MPI_LIMB
-
151 normalization_steps
);
153 /* Possible optimization:
155 * && divisor_limb > ((n1 << normalization_steps)
156 * | (dividend_ptr[dividend_size - 2] >> ...)))
157 * ...one division less...
159 for (i
= dividend_size
- 2; i
>= 0; i
--) {
160 n0
= dividend_ptr
[i
];
161 udiv_qrnnd(dummy
, r
, r
,
162 ((n1
<< normalization_steps
)
165 normalization_steps
))),
169 udiv_qrnnd(dummy
, r
, r
,
170 n1
<< normalization_steps
,
172 return r
>> normalization_steps
;
175 /* No normalization needed, either because udiv_qrnnd doesn't require
176 * it, or because DIVISOR_LIMB is already normalized. */
177 i
= dividend_size
- 1;
180 if (r
>= divisor_limb
)
185 for (; i
>= 0; i
--) {
186 n0
= dividend_ptr
[i
];
187 udiv_qrnnd(dummy
, r
, r
, n0
, divisor_limb
);
193 /* Divide num (NP/NSIZE) by den (DP/DSIZE) and write
194 * the NSIZE-DSIZE least significant quotient limbs at QP
195 * and the DSIZE long remainder at NP. If QEXTRA_LIMBS is
196 * non-zero, generate that many fraction bits and append them after the
197 * other quotient limbs.
198 * Return the most significant limb of the quotient, this is always 0 or 1.
202 * 1. The most significant bit of the divisor must be set.
203 * 2. QP must either not overlap with the input operands at all, or
204 * QP + DSIZE >= NP must hold true. (This means that it's
205 * possible to put the quotient in the high part of NUM, right after the
207 * 3. NSIZE >= DSIZE, even if QEXTRA_LIMBS is non-zero.
211 mpihelp_divrem(mpi_ptr_t qp
, mpi_size_t qextra_limbs
,
212 mpi_ptr_t np
, mpi_size_t nsize
, mpi_ptr_t dp
, mpi_size_t dsize
)
214 mpi_limb_t most_significant_q_limb
= 0;
218 /* We are asked to divide by zero, so go ahead and do it! (To make
219 the compiler not remove this statement, return the value.) */
233 most_significant_q_limb
= 1;
237 for (i
= nsize
- 2; i
>= 0; i
--)
238 udiv_qrnnd(qp
[i
], n1
, n1
, np
[i
], d
);
241 for (i
= qextra_limbs
- 1; i
>= 0; i
--)
242 udiv_qrnnd(qp
[i
], n1
, n1
, 0, d
);
251 mpi_limb_t n1
, n0
, n2
;
260 if (n1
>= d1
&& (n1
> d1
|| n0
>= d0
)) {
261 sub_ddmmss(n1
, n0
, n1
, n0
, d1
, d0
);
262 most_significant_q_limb
= 1;
265 for (i
= qextra_limbs
+ nsize
- 2 - 1; i
>= 0; i
--) {
269 if (i
>= qextra_limbs
)
275 /* Q should be either 111..111 or 111..110. Need special
276 * treatment of this rare case as normal division would
281 if (r
< d1
) { /* Carry in the addition? */
282 add_ssaaaa(n1
, n0
, r
- d0
,
287 n1
= d0
- (d0
!= 0 ? 1 : 0);
290 udiv_qrnnd(q
, r
, n1
, n0
, d1
);
291 umul_ppmm(n1
, n0
, d0
, q
);
296 if (n1
> r
|| (n1
== r
&& n0
> n2
)) {
297 /* The estimated Q was too large. */
299 sub_ddmmss(n1
, n0
, n1
, n0
, 0, d0
);
301 if (r
>= d1
) /* If not carry, test Q again. */
306 sub_ddmmss(n1
, n0
, r
, n2
, n1
, n0
);
316 mpi_limb_t dX
, d1
, n0
;
325 || mpihelp_cmp(np
, dp
, dsize
- 1) >= 0) {
326 mpihelp_sub_n(np
, np
, dp
, dsize
);
328 most_significant_q_limb
= 1;
332 for (i
= qextra_limbs
+ nsize
- dsize
- 1; i
>= 0; i
--) {
337 if (i
>= qextra_limbs
) {
342 MPN_COPY_DECR(np
+ 1, np
, dsize
- 1);
347 /* This might over-estimate q, but it's probably not worth
348 * the extra code here to find out. */
353 udiv_qrnnd(q
, r
, n0
, np
[dsize
- 1], dX
);
354 umul_ppmm(n1
, n0
, d1
, q
);
358 && n0
> np
[dsize
- 2])) {
361 if (r
< dX
) /* I.e. "carry in previous addition?" */
368 /* Possible optimization: We already have (q * n0) and (1 * n1)
369 * after the calculation of q. Taking advantage of that, we
370 * could make this loop make two iterations less. */
371 cy_limb
= mpihelp_submul_1(np
, dp
, dsize
, q
);
374 mpihelp_add_n(np
, np
, dp
, dsize
);
384 return most_significant_q_limb
;
388 * Divide (DIVIDEND_PTR,,DIVIDEND_SIZE) by DIVISOR_LIMB.
389 * Write DIVIDEND_SIZE limbs of quotient at QUOT_PTR.
390 * Return the single-limb remainder.
391 * There are no constraints on the value of the divisor.
393 * QUOT_PTR and DIVIDEND_PTR might point to the same limb.
397 mpihelp_divmod_1(mpi_ptr_t quot_ptr
,
398 mpi_ptr_t dividend_ptr
, mpi_size_t dividend_size
,
399 mpi_limb_t divisor_limb
)
402 mpi_limb_t n1
, n0
, r
;
408 /* If multiplication is much faster than division, and the
409 * dividend is large, pre-invert the divisor, and use
410 * only multiplications in the inner loop.
412 * This test should be read:
413 * Does it ever help to use udiv_qrnnd_preinv?
414 * && Does what we save compensate for the inversion overhead?
416 if (UDIV_TIME
> (2 * UMUL_TIME
+ 6)
417 && (UDIV_TIME
- (2 * UMUL_TIME
+ 6)) * dividend_size
> UDIV_TIME
) {
418 int normalization_steps
;
420 count_leading_zeros(normalization_steps
, divisor_limb
);
421 if (normalization_steps
) {
422 mpi_limb_t divisor_limb_inverted
;
424 divisor_limb
<<= normalization_steps
;
426 /* Compute (2**2N - 2**N * DIVISOR_LIMB) / DIVISOR_LIMB. The
427 * result is a (N+1)-bit approximation to 1/DIVISOR_LIMB, with the
428 * most significant bit (with weight 2**N) implicit.
430 /* Special case for DIVISOR_LIMB == 100...000. */
431 if (!(divisor_limb
<< 1))
432 divisor_limb_inverted
= ~(mpi_limb_t
) 0;
434 udiv_qrnnd(divisor_limb_inverted
, dummy
,
435 -divisor_limb
, 0, divisor_limb
);
437 n1
= dividend_ptr
[dividend_size
- 1];
438 r
= n1
>> (BITS_PER_MPI_LIMB
- normalization_steps
);
440 /* Possible optimization:
442 * && divisor_limb > ((n1 << normalization_steps)
443 * | (dividend_ptr[dividend_size - 2] >> ...)))
444 * ...one division less...
446 for (i
= dividend_size
- 2; i
>= 0; i
--) {
447 n0
= dividend_ptr
[i
];
448 UDIV_QRNND_PREINV(quot_ptr
[i
+ 1], r
, r
,
449 ((n1
<< normalization_steps
)
452 normalization_steps
))),
454 divisor_limb_inverted
);
457 UDIV_QRNND_PREINV(quot_ptr
[0], r
, r
,
458 n1
<< normalization_steps
,
459 divisor_limb
, divisor_limb_inverted
);
460 return r
>> normalization_steps
;
462 mpi_limb_t divisor_limb_inverted
;
464 /* Compute (2**2N - 2**N * DIVISOR_LIMB) / DIVISOR_LIMB. The
465 * result is a (N+1)-bit approximation to 1/DIVISOR_LIMB, with the
466 * most significant bit (with weight 2**N) implicit.
468 /* Special case for DIVISOR_LIMB == 100...000. */
469 if (!(divisor_limb
<< 1))
470 divisor_limb_inverted
= ~(mpi_limb_t
) 0;
472 udiv_qrnnd(divisor_limb_inverted
, dummy
,
473 -divisor_limb
, 0, divisor_limb
);
475 i
= dividend_size
- 1;
478 if (r
>= divisor_limb
)
483 for (; i
>= 0; i
--) {
484 n0
= dividend_ptr
[i
];
485 UDIV_QRNND_PREINV(quot_ptr
[i
], r
, r
,
487 divisor_limb_inverted
);
492 if (UDIV_NEEDS_NORMALIZATION
) {
493 int normalization_steps
;
495 count_leading_zeros(normalization_steps
, divisor_limb
);
496 if (normalization_steps
) {
497 divisor_limb
<<= normalization_steps
;
499 n1
= dividend_ptr
[dividend_size
- 1];
500 r
= n1
>> (BITS_PER_MPI_LIMB
-
501 normalization_steps
);
503 /* Possible optimization:
505 * && divisor_limb > ((n1 << normalization_steps)
506 * | (dividend_ptr[dividend_size - 2] >> ...)))
507 * ...one division less...
509 for (i
= dividend_size
- 2; i
>= 0; i
--) {
510 n0
= dividend_ptr
[i
];
511 udiv_qrnnd(quot_ptr
[i
+ 1], r
, r
,
512 ((n1
<< normalization_steps
)
515 normalization_steps
))),
519 udiv_qrnnd(quot_ptr
[0], r
, r
,
520 n1
<< normalization_steps
,
522 return r
>> normalization_steps
;
525 /* No normalization needed, either because udiv_qrnnd doesn't require
526 * it, or because DIVISOR_LIMB is already normalized. */
527 i
= dividend_size
- 1;
530 if (r
>= divisor_limb
)
535 for (; i
>= 0; i
--) {
536 n0
= dividend_ptr
[i
];
537 udiv_qrnnd(quot_ptr
[i
], r
, r
, n0
, divisor_limb
);