Switched to GPLv3.
[gnupg.git] / mpi / mpi-div.c
1 /* mpi-div.c  -  MPI functions
2  *      Copyright (C) 1994, 1996 Free Software Foundation, Inc.
3  *      Copyright (C) 1998, 1999, 2000, 2001 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
36
37 void
38 mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor )
39 {
40     int divisor_sign = divisor->sign;
41     MPI temp_divisor = NULL;
42
43     /* We need the original value of the divisor after the remainder has been
44      * preliminary calculated.  We have to copy it to temporary space if it's
45      * the same variable as REM.  */
46     if( rem == divisor ) {
47         temp_divisor = mpi_copy( divisor );
48         divisor = temp_divisor;
49     }
50
51     mpi_tdiv_r( rem, dividend, divisor );
52
53     if( ((divisor_sign?1:0) ^ (dividend->sign?1:0)) && rem->nlimbs )
54         mpi_add( rem, rem, divisor);
55
56     if( temp_divisor )
57         mpi_free(temp_divisor);
58 }
59
60
61
62 /****************
63  * Division rounding the quotient towards -infinity.
64  * The remainder gets the same sign as the denominator.
65  * rem is optional
66  */
67
68 ulong
69 mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor )
70 {
71     mpi_limb_t rlimb;
72
73     rlimb = mpihelp_mod_1( dividend->d, dividend->nlimbs, divisor );
74     if( rlimb && dividend->sign )
75         rlimb = divisor - rlimb;
76
77     if( rem ) {
78         rem->d[0] = rlimb;
79         rem->nlimbs = rlimb? 1:0;
80     }
81     return rlimb;
82 }
83
84
85 void
86 mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor )
87 {
88     MPI tmp = mpi_alloc( mpi_get_nlimbs(quot) );
89     mpi_fdiv_qr( quot, tmp, dividend, divisor);
90     mpi_free(tmp);
91 }
92
93 void
94 mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor )
95 {
96     int divisor_sign = divisor->sign;
97     MPI temp_divisor = NULL;
98
99     if( quot == divisor || rem == divisor ) {
100         temp_divisor = mpi_copy( divisor );
101         divisor = temp_divisor;
102     }
103
104     mpi_tdiv_qr( quot, rem, dividend, divisor );
105
106     if( (divisor_sign ^ dividend->sign) && rem->nlimbs ) {
107         mpi_sub_ui( quot, quot, 1 );
108         mpi_add( rem, rem, divisor);
109     }
110
111     if( temp_divisor )
112         mpi_free(temp_divisor);
113 }
114
115
116 /* If den == quot, den needs temporary storage.
117  * If den == rem, den needs temporary storage.
118  * If num == quot, num needs temporary storage.
119  * If den has temporary storage, it can be normalized while being copied,
120  *   i.e no extra storage should be allocated.
121  */
122
123 void
124 mpi_tdiv_r( MPI rem, MPI num, MPI den)
125 {
126     mpi_tdiv_qr(NULL, rem, num, den );
127 }
128
129 void
130 mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den)
131 {
132     mpi_ptr_t np, dp;
133     mpi_ptr_t qp, rp;
134     mpi_size_t nsize = num->nlimbs;
135     mpi_size_t dsize = den->nlimbs;
136     mpi_size_t qsize, rsize;
137     mpi_size_t sign_remainder = num->sign;
138     mpi_size_t sign_quotient = num->sign ^ den->sign;
139     unsigned normalization_steps;
140     mpi_limb_t q_limb;
141     mpi_ptr_t marker[5];
142     int markidx=0;
143
144     /* Ensure space is enough for quotient and remainder.
145      * We need space for an extra limb in the remainder, because it's
146      * up-shifted (normalized) below.  */
147     rsize = nsize + 1;
148     mpi_resize( rem, rsize);
149
150     qsize = rsize - dsize;        /* qsize cannot be bigger than this.  */
151     if( qsize <= 0 ) {
152         if( num != rem ) {
153             rem->nlimbs = num->nlimbs;
154             rem->sign = num->sign;
155             MPN_COPY(rem->d, num->d, nsize);
156         }
157         if( quot ) {
158             /* This needs to follow the assignment to rem, in case the
159              * numerator and quotient are the same.  */
160             quot->nlimbs = 0;
161             quot->sign = 0;
162         }
163         return;
164     }
165
166     if( quot )
167         mpi_resize( quot, qsize);
168
169     /* Read pointers here, when reallocation is finished.  */
170     np = num->d;
171     dp = den->d;
172     rp = rem->d;
173
174     /* Optimize division by a single-limb divisor.  */
175     if( dsize == 1 ) {
176         mpi_limb_t rlimb;
177         if( quot ) {
178             qp = quot->d;
179             rlimb = mpihelp_divmod_1( qp, np, nsize, dp[0] );
180             qsize -= qp[qsize - 1] == 0;
181             quot->nlimbs = qsize;
182             quot->sign = sign_quotient;
183         }
184         else
185             rlimb = mpihelp_mod_1( np, nsize, dp[0] );
186         rp[0] = rlimb;
187         rsize = rlimb != 0?1:0;
188         rem->nlimbs = rsize;
189         rem->sign = sign_remainder;
190         return;
191     }
192
193
194     if( quot ) {
195         qp = quot->d;
196         /* Make sure QP and NP point to different objects.  Otherwise the
197          * numerator would be gradually overwritten by the quotient limbs.  */
198         if(qp == np) { /* Copy NP object to temporary space.  */
199             np = marker[markidx++] = mpi_alloc_limb_space(nsize,
200                                                           mpi_is_secure(quot));
201             MPN_COPY(np, qp, nsize);
202         }
203     }
204     else /* Put quotient at top of remainder. */
205         qp = rp + dsize;
206
207     count_leading_zeros( normalization_steps, dp[dsize - 1] );
208
209     /* Normalize the denominator, i.e. make its most significant bit set by
210      * shifting it NORMALIZATION_STEPS bits to the left.  Also shift the
211      * numerator the same number of steps (to keep the quotient the same!).
212      */
213     if( normalization_steps ) {
214         mpi_ptr_t tp;
215         mpi_limb_t nlimb;
216
217         /* Shift up the denominator setting the most significant bit of
218          * the most significant word.  Use temporary storage not to clobber
219          * the original contents of the denominator.  */
220         tp = marker[markidx++] = mpi_alloc_limb_space(dsize,mpi_is_secure(den));
221         mpihelp_lshift( tp, dp, dsize, normalization_steps );
222         dp = tp;
223
224         /* Shift up the numerator, possibly introducing a new most
225          * significant word.  Move the shifted numerator in the remainder
226          * meanwhile.  */
227         nlimb = mpihelp_lshift(rp, np, nsize, normalization_steps);
228         if( nlimb ) {
229             rp[nsize] = nlimb;
230             rsize = nsize + 1;
231         }
232         else
233             rsize = nsize;
234     }
235     else {
236         /* The denominator is already normalized, as required.  Copy it to
237          * temporary space if it overlaps with the quotient or remainder.  */
238         if( dp == rp || (quot && (dp == qp))) {
239             mpi_ptr_t tp;
240
241             tp = marker[markidx++] = mpi_alloc_limb_space(dsize, mpi_is_secure(den));
242             MPN_COPY( tp, dp, dsize );
243             dp = tp;
244         }
245
246         /* Move the numerator to the remainder.  */
247         if( rp != np )
248             MPN_COPY(rp, np, nsize);
249
250         rsize = nsize;
251     }
252
253     q_limb = mpihelp_divrem( qp, 0, rp, rsize, dp, dsize );
254
255     if( quot ) {
256         qsize = rsize - dsize;
257         if(q_limb) {
258             qp[qsize] = q_limb;
259             qsize += 1;
260         }
261
262         quot->nlimbs = qsize;
263         quot->sign = sign_quotient;
264     }
265
266     rsize = dsize;
267     MPN_NORMALIZE (rp, rsize);
268
269     if( normalization_steps && rsize ) {
270         mpihelp_rshift(rp, rp, rsize, normalization_steps);
271         rsize -= rp[rsize - 1] == 0?1:0;
272     }
273
274     rem->nlimbs = rsize;
275     rem->sign   = sign_remainder;
276     while( markidx )
277         mpi_free_limb_space(marker[--markidx]);
278 }
279
280 void
281 mpi_tdiv_q_2exp( MPI w, MPI u, unsigned count )
282 {
283     mpi_size_t usize, wsize;
284     mpi_size_t limb_cnt;
285
286     usize = u->nlimbs;
287     limb_cnt = count / BITS_PER_MPI_LIMB;
288     wsize = usize - limb_cnt;
289     if( limb_cnt >= usize )
290         w->nlimbs = 0;
291     else {
292         mpi_ptr_t wp;
293         mpi_ptr_t up;
294
295         RESIZE_IF_NEEDED( w, wsize );
296         wp = w->d;
297         up = u->d;
298
299         count %= BITS_PER_MPI_LIMB;
300         if( count ) {
301             mpihelp_rshift( wp, up + limb_cnt, wsize, count );
302             wsize -= !wp[wsize - 1];
303         }
304         else {
305             MPN_COPY_INCR( wp, up + limb_cnt, wsize);
306         }
307
308         w->nlimbs = wsize;
309     }
310 }
311
312 /****************
313  * Check whether dividend is divisible by divisor
314  * (note: divisor must fit into a limb)
315  */
316 int
317 mpi_divisible_ui(MPI dividend, ulong divisor )
318 {
319     return !mpihelp_mod_1( dividend->d, dividend->nlimbs, divisor );
320 }
321