mark all block comments that need format preserving so that
[openssl.git] / crypto / bn / bn_sqr.c
1 /* crypto/bn/bn_sqr.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 #include "cryptlib.h"
60 #include "bn_lcl.h"
61
62 /* r must not be a */
63 /* I've just gone over this and it is now %20 faster on x86 - eay - 27 Jun 96 */
64 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx)
65         {
66         int max,al;
67         int ret = 0;
68         BIGNUM *tmp,*rr;
69
70         bn_check_top(a);
71
72         al=a->top;
73         if (al <= 0)
74                 {
75                 r->top=0;
76                 r->neg = 0;
77                 return 1;
78                 }
79
80         BN_CTX_start(ctx);
81         rr=(a != r) ? r : BN_CTX_get(ctx);
82         tmp=BN_CTX_get(ctx);
83         if (!rr || !tmp) goto err;
84
85         max = 2 * al; /* Non-zero (from above) */
86         if (bn_wexpand(rr,max) == NULL) goto err;
87
88         if (al == 4)
89                 {
90 #ifndef BN_SQR_COMBA
91                 BN_ULONG t[8];
92                 bn_sqr_normal(rr->d,a->d,4,t);
93 #else
94                 bn_sqr_comba4(rr->d,a->d);
95 #endif
96                 }
97         else if (al == 8)
98                 {
99 #ifndef BN_SQR_COMBA
100                 BN_ULONG t[16];
101                 bn_sqr_normal(rr->d,a->d,8,t);
102 #else
103                 bn_sqr_comba8(rr->d,a->d);
104 #endif
105                 }
106         else 
107                 {
108 #if defined(BN_RECURSION)
109                 if (al < BN_SQR_RECURSIVE_SIZE_NORMAL)
110                         {
111                         BN_ULONG t[BN_SQR_RECURSIVE_SIZE_NORMAL*2];
112                         bn_sqr_normal(rr->d,a->d,al,t);
113                         }
114                 else
115                         {
116                         int j,k;
117
118                         j=BN_num_bits_word((BN_ULONG)al);
119                         j=1<<(j-1);
120                         k=j+j;
121                         if (al == j)
122                                 {
123                                 if (bn_wexpand(tmp,k*2) == NULL) goto err;
124                                 bn_sqr_recursive(rr->d,a->d,al,tmp->d);
125                                 }
126                         else
127                                 {
128                                 if (bn_wexpand(tmp,max) == NULL) goto err;
129                                 bn_sqr_normal(rr->d,a->d,al,tmp->d);
130                                 }
131                         }
132 #else
133                 if (bn_wexpand(tmp,max) == NULL) goto err;
134                 bn_sqr_normal(rr->d,a->d,al,tmp->d);
135 #endif
136                 }
137
138         rr->neg=0;
139         /* If the most-significant half of the top word of 'a' is zero, then
140          * the square of 'a' will max-1 words. */
141         if(a->d[al - 1] == (a->d[al - 1] & BN_MASK2l))
142                 rr->top = max - 1;
143         else
144                 rr->top = max;
145         if (rr != r) BN_copy(r,rr);
146         ret = 1;
147  err:
148         bn_check_top(rr);
149         bn_check_top(tmp);
150         BN_CTX_end(ctx);
151         return(ret);
152         }
153
154 /* tmp must have 2*n words */
155 void bn_sqr_normal(BN_ULONG *r, const BN_ULONG *a, int n, BN_ULONG *tmp)
156         {
157         int i,j,max;
158         const BN_ULONG *ap;
159         BN_ULONG *rp;
160
161         max=n*2;
162         ap=a;
163         rp=r;
164         rp[0]=rp[max-1]=0;
165         rp++;
166         j=n;
167
168         if (--j > 0)
169                 {
170                 ap++;
171                 rp[j]=bn_mul_words(rp,ap,j,ap[-1]);
172                 rp+=2;
173                 }
174
175         for (i=n-2; i>0; i--)
176                 {
177                 j--;
178                 ap++;
179                 rp[j]=bn_mul_add_words(rp,ap,j,ap[-1]);
180                 rp+=2;
181                 }
182
183         bn_add_words(r,r,r,max);
184
185         /* There will not be a carry */
186
187         bn_sqr_words(tmp,a,n);
188
189         bn_add_words(r,r,tmp,max);
190         }
191
192 #ifdef BN_RECURSION
193 /*-
194  * r is 2*n words in size,
195  * a and b are both n words in size.    (There's not actually a 'b' here ...)
196  * n must be a power of 2.
197  * We multiply and return the result.
198  * t must be 2*n words in size
199  * We calculate
200  * a[0]*b[0]
201  * a[0]*b[0]+a[1]*b[1]+(a[0]-a[1])*(b[1]-b[0])
202  * a[1]*b[1]
203  */
204 void bn_sqr_recursive(BN_ULONG *r, const BN_ULONG *a, int n2, BN_ULONG *t)
205         {
206         int n=n2/2;
207         int zero,c1;
208         BN_ULONG ln,lo,*p;
209
210         if (n2 == 4)
211                 {
212 #ifndef BN_SQR_COMBA
213                 bn_sqr_normal(r,a,4,t);
214 #else
215                 bn_sqr_comba4(r,a);
216 #endif
217                 return;
218                 }
219         else if (n2 == 8)
220                 {
221 #ifndef BN_SQR_COMBA
222                 bn_sqr_normal(r,a,8,t);
223 #else
224                 bn_sqr_comba8(r,a);
225 #endif
226                 return;
227                 }
228         if (n2 < BN_SQR_RECURSIVE_SIZE_NORMAL)
229                 {
230                 bn_sqr_normal(r,a,n2,t);
231                 return;
232                 }
233         /* r=(a[0]-a[1])*(a[1]-a[0]) */
234         c1=bn_cmp_words(a,&(a[n]),n);
235         zero=0;
236         if (c1 > 0)
237                 bn_sub_words(t,a,&(a[n]),n);
238         else if (c1 < 0)
239                 bn_sub_words(t,&(a[n]),a,n);
240         else
241                 zero=1;
242
243         /* The result will always be negative unless it is zero */
244         p= &(t[n2*2]);
245
246         if (!zero)
247                 bn_sqr_recursive(&(t[n2]),t,n,p);
248         else
249                 memset(&(t[n2]),0,n2*sizeof(BN_ULONG));
250         bn_sqr_recursive(r,a,n,p);
251         bn_sqr_recursive(&(r[n2]),&(a[n]),n,p);
252
253         /*-
254          * t[32] holds (a[0]-a[1])*(a[1]-a[0]), it is negative or zero
255          * r[10] holds (a[0]*b[0])
256          * r[32] holds (b[1]*b[1])
257          */
258
259         c1=(int)(bn_add_words(t,r,&(r[n2]),n2));
260
261         /* t[32] is negative */
262         c1-=(int)(bn_sub_words(&(t[n2]),t,&(t[n2]),n2));
263
264         /*-
265          * t[32] holds (a[0]-a[1])*(a[1]-a[0])+(a[0]*a[0])+(a[1]*a[1])
266          * r[10] holds (a[0]*a[0])
267          * r[32] holds (a[1]*a[1])
268          * c1 holds the carry bits
269          */
270         c1+=(int)(bn_add_words(&(r[n]),&(r[n]),&(t[n2]),n2));
271         if (c1)
272                 {
273                 p= &(r[n+n2]);
274                 lo= *p;
275                 ln=(lo+c1)&BN_MASK2;
276                 *p=ln;
277
278                 /* The overflow will stop before we over write
279                  * words we should not overwrite */
280                 if (ln < (BN_ULONG)c1)
281                         {
282                         do      {
283                                 p++;
284                                 lo= *p;
285                                 ln=(lo+1)&BN_MASK2;
286                                 *p=ln;
287                                 } while (ln == 0);
288                         }
289                 }
290         }
291 #endif