1b5c29c7ac07cc84d33cff1d39231ae0a6b1f809
[openssl.git] / crypto / bn / bn_div.c
1 /* crypto/bn/bn_div.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59
60
61 #include <openssl/bn.h>
62 #include "cryptlib.h"
63 #include "bn_lcl.h"
64
65
66 /* The old slow way */
67 #if 0
68 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
69            BN_CTX *ctx)
70         {
71         int i,nm,nd;
72         int ret = 0;
73         BIGNUM *D;
74
75         bn_check_top(m);
76         bn_check_top(d);
77         if (BN_is_zero(d))
78                 {
79                 BNerr(BN_F_BN_DIV,BN_R_DIV_BY_ZERO);
80                 return(0);
81                 }
82
83         if (BN_ucmp(m,d) < 0)
84                 {
85                 if (rem != NULL)
86                         { if (BN_copy(rem,m) == NULL) return(0); }
87                 if (dv != NULL) BN_zero(dv);
88                 return(1);
89                 }
90
91         BN_CTX_start(ctx);
92         D = BN_CTX_get(ctx);
93         if (dv == NULL) dv = BN_CTX_get(ctx);
94         if (rem == NULL) rem = BN_CTX_get(ctx);
95         if (D == NULL || dv == NULL || rem == NULL)
96                 goto end;
97
98         nd=BN_num_bits(d);
99         nm=BN_num_bits(m);
100         if (BN_copy(D,d) == NULL) goto end;
101         if (BN_copy(rem,m) == NULL) goto end;
102
103         /* The next 2 are needed so we can do a dv->d[0]|=1 later
104          * since BN_lshift1 will only work once there is a value :-) */
105         BN_zero(dv);
106         if(bn_wexpand(dv,1) == NULL) goto end;
107         dv->top=1;
108
109         if (!BN_lshift(D,D,nm-nd)) goto end;
110         for (i=nm-nd; i>=0; i--)
111                 {
112                 if (!BN_lshift1(dv,dv)) goto end;
113                 if (BN_ucmp(rem,D) >= 0)
114                         {
115                         dv->d[0]|=1;
116                         if (!BN_usub(rem,rem,D)) goto end;
117                         }
118 /* CAN IMPROVE (and have now :=) */
119                 if (!BN_rshift1(D,D)) goto end;
120                 }
121         rem->neg=BN_is_zero(rem)?0:m->neg;
122         dv->neg=m->neg^d->neg;
123         ret = 1;
124  end:
125         BN_CTX_end(ctx);
126         return(ret);
127         }
128
129 #else
130
131 #if !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM) \
132     && !defined(PEDANTIC) && !defined(BN_DIV3W)
133 # if defined(__GNUC__) && __GNUC__>=2
134 #  if defined(__i386) || defined (__i386__)
135    /*
136     * There were two reasons for implementing this template:
137     * - GNU C generates a call to a function (__udivdi3 to be exact)
138     *   in reply to ((((BN_ULLONG)n0)<<BN_BITS2)|n1)/d0 (I fail to
139     *   understand why...);
140     * - divl doesn't only calculate quotient, but also leaves
141     *   remainder in %edx which we can definitely use here:-)
142     *
143     *                                   <appro@fy.chalmers.se>
144     */
145 #undef bn_div_words
146 #  define bn_div_words(n0,n1,d0)                \
147         ({  asm volatile (                      \
148                 "divl   %4"                     \
149                 : "=a"(q), "=d"(rem)            \
150                 : "a"(n1), "d"(n0), "g"(d0)     \
151                 : "cc");                        \
152             q;                                  \
153         })
154 #  define REMAINDER_IS_ALREADY_CALCULATED
155 #  elif defined(__x86_64) && defined(SIXTY_FOUR_BIT_LONG)
156    /*
157     * Same story here, but it's 128-bit by 64-bit division. Wow!
158     *                                   <appro@fy.chalmers.se>
159     */
160 #  undef bn_div_words
161 #  define bn_div_words(n0,n1,d0)                \
162         ({  asm volatile (                      \
163                 "divq   %4"                     \
164                 : "=a"(q), "=d"(rem)            \
165                 : "a"(n1), "d"(n0), "g"(d0)     \
166                 : "cc");                        \
167             q;                                  \
168         })
169 #  define REMAINDER_IS_ALREADY_CALCULATED
170 #  endif /* __<cpu> */
171 # endif /* __GNUC__ */
172 #endif /* OPENSSL_NO_ASM */
173
174
175 /* BN_div computes  dv := num / divisor,  rounding towards
176  * zero, and sets up rm  such that  dv*divisor + rm = num  holds.
177  * Thus:
178  *     dv->neg == num->neg ^ divisor->neg  (unless the result is zero)
179  *     rm->neg == num->neg                 (unless the remainder is zero)
180  * If 'dv' or 'rm' is NULL, the respective value is not returned.
181  */
182 int BN_div(BIGNUM *dv, BIGNUM *rm, const BIGNUM *num, const BIGNUM *divisor,
183            BN_CTX *ctx)
184         {
185         int norm_shift,i,loop;
186         BIGNUM *tmp,wnum,*snum,*sdiv,*res;
187         BN_ULONG *resp,*wnump;
188         BN_ULONG d0,d1;
189         int num_n,div_n;
190         int no_branch=0;
191
192         /* Invalid zero-padding would have particularly bad consequences
193          * so don't just rely on bn_check_top() here
194          * (bn_check_top() works only for BN_DEBUG builds) */
195         if ((num->top > 0 && num->d[num->top - 1] == 0) ||
196                 (divisor->top > 0 && divisor->d[divisor->top - 1] == 0))
197                 {
198                 BNerr(BN_F_BN_DIV,BN_R_NOT_INITIALIZED);
199                 return 0;
200                 }
201
202         bn_check_top(num);
203         bn_check_top(divisor);
204
205         if ((BN_get_flags(num, BN_FLG_CONSTTIME) != 0) || (BN_get_flags(divisor, BN_FLG_CONSTTIME) != 0))
206                 {
207                 no_branch=1;
208                 }
209
210         bn_check_top(dv);
211         bn_check_top(rm);
212         /* bn_check_top(num); */ /* 'num' has been checked already */
213         /* bn_check_top(divisor); */ /* 'divisor' has been checked already */
214
215         if (BN_is_zero(divisor))
216                 {
217                 BNerr(BN_F_BN_DIV,BN_R_DIV_BY_ZERO);
218                 return(0);
219                 }
220
221         if (!no_branch && BN_ucmp(num,divisor) < 0)
222                 {
223                 if (rm != NULL)
224                         { if (BN_copy(rm,num) == NULL) return(0); }
225                 if (dv != NULL) BN_zero(dv);
226                 return(1);
227                 }
228
229         BN_CTX_start(ctx);
230         tmp=BN_CTX_get(ctx);
231         snum=BN_CTX_get(ctx);
232         sdiv=BN_CTX_get(ctx);
233         if (dv == NULL)
234                 res=BN_CTX_get(ctx);
235         else    res=dv;
236         if (sdiv == NULL || res == NULL || tmp == NULL || snum == NULL)
237                 goto err;
238
239         /* First we normalise the numbers */
240         norm_shift=BN_BITS2-((BN_num_bits(divisor))%BN_BITS2);
241         if (!(BN_lshift(sdiv,divisor,norm_shift))) goto err;
242         sdiv->neg=0;
243         norm_shift+=BN_BITS2;
244         if (!(BN_lshift(snum,num,norm_shift))) goto err;
245         snum->neg=0;
246
247         if (no_branch)
248                 {
249                 /* Since we don't know whether snum is larger than sdiv,
250                  * we pad snum with enough zeroes without changing its
251                  * value. 
252                  */
253                 if (snum->top <= sdiv->top+1) 
254                         {
255                         if (bn_wexpand(snum, sdiv->top + 2) == NULL) goto err;
256                         for (i = snum->top; i < sdiv->top + 2; i++) snum->d[i] = 0;
257                         snum->top = sdiv->top + 2;
258                         }
259                 else
260                         {
261                         if (bn_wexpand(snum, snum->top + 1) == NULL) goto err;
262                         snum->d[snum->top] = 0;
263                         snum->top ++;
264                         }
265                 }
266
267         div_n=sdiv->top;
268         num_n=snum->top;
269         loop=num_n-div_n;
270         /* Lets setup a 'window' into snum
271          * This is the part that corresponds to the current
272          * 'area' being divided */
273         wnum.neg   = 0;
274         wnum.d     = &(snum->d[loop]);
275         wnum.top   = div_n;
276         /* only needed when BN_ucmp messes up the values between top and max */
277         wnum.dmax  = snum->dmax - loop; /* so we don't step out of bounds */
278
279         /* Get the top 2 words of sdiv */
280         /* div_n=sdiv->top; */
281         d0=sdiv->d[div_n-1];
282         d1=(div_n == 1)?0:sdiv->d[div_n-2];
283
284         /* pointer to the 'top' of snum */
285         wnump= &(snum->d[num_n-1]);
286
287         /* Setup to 'res' */
288         res->neg= (num->neg^divisor->neg);
289         if (!bn_wexpand(res,(loop+1))) goto err;
290         res->top=loop-no_branch;
291         resp= &(res->d[loop-1]);
292
293         /* space for temp */
294         if (!bn_wexpand(tmp,(div_n+1))) goto err;
295
296         if (!no_branch)
297                 {
298                 if (BN_ucmp(&wnum,sdiv) >= 0)
299                         {
300                         /* If BN_DEBUG_RAND is defined BN_ucmp changes (via
301                          * bn_pollute) the const bignum arguments =>
302                          * clean the values between top and max again */
303                         bn_clear_top2max(&wnum);
304                         bn_sub_words(wnum.d, wnum.d, sdiv->d, div_n);
305                         *resp=1;
306                         }
307                 else
308                         res->top--;
309                 }
310
311         /* if res->top == 0 then clear the neg value otherwise decrease
312          * the resp pointer */
313         if (res->top == 0)
314                 res->neg = 0;
315         else
316                 resp--;
317
318         for (i=0; i<loop-1; i++, wnump--, resp--)
319                 {
320                 BN_ULONG q,l0;
321                 /* the first part of the loop uses the top two words of
322                  * snum and sdiv to calculate a BN_ULONG q such that
323                  * | wnum - sdiv * q | < sdiv */
324 #if defined(BN_DIV3W) && !defined(OPENSSL_NO_ASM)
325                 BN_ULONG bn_div_3_words(BN_ULONG*,BN_ULONG,BN_ULONG);
326                 q=bn_div_3_words(wnump,d1,d0);
327 #else
328                 BN_ULONG n0,n1,rem=0;
329
330                 n0=wnump[0];
331                 n1=wnump[-1];
332                 if (n0 == d0)
333                         q=BN_MASK2;
334                 else                    /* n0 < d0 */
335                         {
336 #ifdef BN_LLONG
337                         BN_ULLONG t2;
338
339 #if defined(BN_LLONG) && defined(BN_DIV2W) && !defined(bn_div_words)
340                         q=(BN_ULONG)(((((BN_ULLONG)n0)<<BN_BITS2)|n1)/d0);
341 #else
342                         q=bn_div_words(n0,n1,d0);
343 #ifdef BN_DEBUG_LEVITTE
344                         fprintf(stderr,"DEBUG: bn_div_words(0x%08X,0x%08X,0x%08\
345 X) -> 0x%08X\n",
346                                 n0, n1, d0, q);
347 #endif
348 #endif
349
350 #ifndef REMAINDER_IS_ALREADY_CALCULATED
351                         /*
352                          * rem doesn't have to be BN_ULLONG. The least we
353                          * know it's less that d0, isn't it?
354                          */
355                         rem=(n1-q*d0)&BN_MASK2;
356 #endif
357                         t2=(BN_ULLONG)d1*q;
358
359                         for (;;)
360                                 {
361                                 if (t2 <= ((((BN_ULLONG)rem)<<BN_BITS2)|wnump[-2]))
362                                         break;
363                                 q--;
364                                 rem += d0;
365                                 if (rem < d0) break; /* don't let rem overflow */
366                                 t2 -= d1;
367                                 }
368 #else /* !BN_LLONG */
369                         BN_ULONG t2l,t2h;
370
371                         q=bn_div_words(n0,n1,d0);
372 #ifdef BN_DEBUG_LEVITTE
373                         fprintf(stderr,"DEBUG: bn_div_words(0x%08X,0x%08X,0x%08\
374 X) -> 0x%08X\n",
375                                 n0, n1, d0, q);
376 #endif
377 #ifndef REMAINDER_IS_ALREADY_CALCULATED
378                         rem=(n1-q*d0)&BN_MASK2;
379 #endif
380
381 #if defined(BN_UMULT_LOHI)
382                         BN_UMULT_LOHI(t2l,t2h,d1,q);
383 #elif defined(BN_UMULT_HIGH)
384                         t2l = d1 * q;
385                         t2h = BN_UMULT_HIGH(d1,q);
386 #else
387                         {
388                         BN_ULONG ql, qh;
389                         t2l=LBITS(d1); t2h=HBITS(d1);
390                         ql =LBITS(q);  qh =HBITS(q);
391                         mul64(t2l,t2h,ql,qh); /* t2=(BN_ULLONG)d1*q; */
392                         }
393 #endif
394
395                         for (;;)
396                                 {
397                                 if ((t2h < rem) ||
398                                         ((t2h == rem) && (t2l <= wnump[-2])))
399                                         break;
400                                 q--;
401                                 rem += d0;
402                                 if (rem < d0) break; /* don't let rem overflow */
403                                 if (t2l < d1) t2h--; t2l -= d1;
404                                 }
405 #endif /* !BN_LLONG */
406                         }
407 #endif /* !BN_DIV3W */
408
409                 l0=bn_mul_words(tmp->d,sdiv->d,div_n,q);
410                 tmp->d[div_n]=l0;
411                 wnum.d--;
412                 /* ingore top values of the bignums just sub the two 
413                  * BN_ULONG arrays with bn_sub_words */
414                 if (bn_sub_words(wnum.d, wnum.d, tmp->d, div_n+1))
415                         {
416                         /* Note: As we have considered only the leading
417                          * two BN_ULONGs in the calculation of q, sdiv * q
418                          * might be greater than wnum (but then (q-1) * sdiv
419                          * is less or equal than wnum)
420                          */
421                         q--;
422                         if (bn_add_words(wnum.d, wnum.d, sdiv->d, div_n))
423                                 /* we can't have an overflow here (assuming
424                                  * that q != 0, but if q == 0 then tmp is
425                                  * zero anyway) */
426                                 (*wnump)++;
427                         }
428                 /* store part of the result */
429                 *resp = q;
430                 }
431         bn_correct_top(snum);
432         if (rm != NULL)
433                 {
434                 /* Keep a copy of the neg flag in num because if rm==num
435                  * BN_rshift() will overwrite it.
436                  */
437                 int neg = num->neg;
438                 BN_rshift(rm,snum,norm_shift);
439                 if (!BN_is_zero(rm))
440                         rm->neg = neg;
441                 bn_check_top(rm);
442                 }
443         if (no_branch)  bn_correct_top(res);
444         BN_CTX_end(ctx);
445         return(1);
446 err:
447         bn_check_top(rm);
448         BN_CTX_end(ctx);
449         return(0);
450         }
451 #endif