090a7a0d0099a0ab4e1124d08e1889df3beea7e5
[openssl.git] / crypto / bn / bn_lcl.h
1 /* crypto/bn/bn_lcl.h */
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  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112 #ifndef HEADER_BN_LCL_H
113 #define HEADER_BN_LCL_H
114
115 #include <openssl/bn.h>
116
117 #ifdef  __cplusplus
118 extern "C" {
119 #endif
120
121
122 /* Used for temp variables */
123 #define BN_CTX_NUM      32
124 #define BN_CTX_NUM_POS  12
125 struct bignum_ctx
126         {
127         int tos;
128         BIGNUM bn[BN_CTX_NUM];
129         int flags;
130         int depth;
131         int pos[BN_CTX_NUM_POS];
132         int too_many;
133         } /* BN_CTX */;
134
135
136 /*
137  * BN_window_bits_for_exponent_size -- macro for sliding window mod_exp functions
138  *
139  *
140  * For window size 'w' (w >= 2) and a random 'b' bits exponent,
141  * the number of multiplications is a constant plus on average
142  *
143  *    2^(w-1) + (b-w)/(w+1);
144  *
145  * here  2^(w-1)  is for precomputing the table (we actually need
146  * entries only for windows that have the lowest bit set), and
147  * (b-w)/(w+1)  is an approximation for the expected number of
148  * w-bit windows, not counting the first one.
149  *
150  * Thus we should use
151  *
152  *    w >= 6  if        b > 671
153  *     w = 5  if  671 > b > 239
154  *     w = 4  if  239 > b >  79
155  *     w = 3  if   79 > b >  23
156  *    w <= 2  if   23 > b
157  *
158  * (with draws in between).  Very small exponents are often selected
159  * with low Hamming weight, so we use  w = 1  for b <= 23.
160  */
161 #if 1
162 #define BN_window_bits_for_exponent_size(b) \
163                 ((b) > 671 ? 6 : \
164                  (b) > 239 ? 5 : \
165                  (b) >  79 ? 4 : \
166                  (b) >  23 ? 3 : 1)
167 #else
168 /* Old SSLeay/OpenSSL table.
169  * Maximum window size was 5, so this table differs for b==1024;
170  * but it coincides for other interesting values (b==160, b==512).
171  */
172 #define BN_window_bits_for_exponent_size(b) \
173                 ((b) > 255 ? 5 : \
174                  (b) > 127 ? 4 : \
175                  (b) >  17 ? 3 : 1)
176 #endif   
177
178
179
180 /* Pentium pro 16,16,16,32,64 */
181 /* Alpha       16,16,16,16.64 */
182 #define BN_MULL_SIZE_NORMAL                     (16) /* 32 */
183 #define BN_MUL_RECURSIVE_SIZE_NORMAL            (16) /* 32 less than */
184 #define BN_SQR_RECURSIVE_SIZE_NORMAL            (16) /* 32 */
185 #define BN_MUL_LOW_RECURSIVE_SIZE_NORMAL        (32) /* 32 */
186 #define BN_MONT_CTX_SET_SIZE_WORD               (64) /* 32 */
187
188 #if !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM) && !defined(PEDANTIC)
189 /*
190  * BN_UMULT_HIGH section.
191  *
192  * No, I'm not trying to overwhelm you when stating that the
193  * product of N-bit numbers is 2*N bits wide:-) No, I don't expect
194  * you to be impressed when I say that if the compiler doesn't
195  * support 2*N integer type, then you have to replace every N*N
196  * multiplication with 4 (N/2)*(N/2) accompanied by some shifts
197  * and additions which unavoidably results in severe performance
198  * penalties. Of course provided that the hardware is capable of
199  * producing 2*N result... That's when you normally start
200  * considering assembler implementation. However! It should be
201  * pointed out that some CPUs (most notably Alpha, PowerPC and
202  * upcoming IA-64 family:-) provide *separate* instruction
203  * calculating the upper half of the product placing the result
204  * into a general purpose register. Now *if* the compiler supports
205  * inline assembler, then it's not impossible to implement the
206  * "bignum" routines (and have the compiler optimize 'em)
207  * exhibiting "native" performance in C. That's what BN_UMULT_HIGH
208  * macro is about:-)
209  *
210  *                                      <appro@fy.chalmers.se>
211  */
212 # if defined(__alpha) && (defined(SIXTY_FOUR_BIT_LONG) || defined(SIXTY_FOUR_BIT))
213 #  if defined(__DECC)
214 #   include <c_asm.h>
215 #   define BN_UMULT_HIGH(a,b)   (BN_ULONG)asm("umulh %a0,%a1,%v0",(a),(b))
216 #  elif defined(__GNUC__)
217 #   define BN_UMULT_HIGH(a,b)   ({      \
218         register BN_ULONG ret;          \
219         asm ("umulh     %1,%2,%0"       \
220              : "=r"(ret)                \
221              : "r"(a), "r"(b));         \
222         ret;                    })
223 #  endif        /* compiler */
224 # elif defined(_ARCH_PPC) && defined(__64BIT__) && defined(SIXTY_FOUR_BIT_LONG)
225 #  if defined(__GNUC__)
226 #   define BN_UMULT_HIGH(a,b)   ({      \
227         register BN_ULONG ret;          \
228         asm ("mulhdu    %0,%1,%2"       \
229              : "=r"(ret)                \
230              : "r"(a), "r"(b));         \
231         ret;                    })
232 #  endif        /* compiler */
233 # endif         /* cpu */
234 #endif          /* OPENSSL_NO_ASM */
235
236 /*************************************************************
237  * Using the long long type
238  */
239 #define Lw(t)    (((BN_ULONG)(t))&BN_MASK2)
240 #define Hw(t)    (((BN_ULONG)((t)>>BN_BITS2))&BN_MASK2)
241
242
243 #define bn_clear_top2max(a) \
244         { \
245         int      index = (a)->dmax - (a)->top; \
246         BN_ULONG *ftl = &(a)->d[(a)->top-1]; \
247         for (; index != 0; index--) \
248                 *(++ftl) = 0x0; \
249         }
250
251
252 /* This is used for internal error checking and is not normally used */
253 #ifdef BN_DEBUG
254 # include <assert.h>
255 # define bn_check_top(a) assert ((a)->top >= 0 && (a)->top <= (a)->dmax);
256 #else
257 # define bn_check_top(a)
258 #endif
259
260 /* This macro is to add extra stuff for development checking */
261 #ifdef BN_DEBUG
262 #define bn_set_max(r) ((r)->max=(r)->top,BN_set_flags((r),BN_FLG_STATIC_DATA))
263 #else
264 #define bn_set_max(r)
265 #endif
266
267 /* These macros are used to 'take' a section of a bignum for read only use */
268 #define bn_set_low(r,a,n) \
269         { \
270         (r)->top=((a)->top > (n))?(n):(a)->top; \
271         (r)->d=(a)->d; \
272         (r)->neg=(a)->neg; \
273         (r)->flags|=BN_FLG_STATIC_DATA; \
274         bn_set_max(r); \
275         }
276
277 #define bn_set_high(r,a,n) \
278         { \
279         if ((a)->top > (n)) \
280                 { \
281                 (r)->top=(a)->top-n; \
282                 (r)->d= &((a)->d[n]); \
283                 } \
284         else \
285                 (r)->top=0; \
286         (r)->neg=(a)->neg; \
287         (r)->flags|=BN_FLG_STATIC_DATA; \
288         bn_set_max(r); \
289         }
290
291 #ifdef BN_LLONG
292 #define mul_add(r,a,w,c) { \
293         BN_ULLONG t; \
294         t=(BN_ULLONG)w * (a) + (r) + (c); \
295         (r)= Lw(t); \
296         (c)= Hw(t); \
297         }
298
299 #define mul(r,a,w,c) { \
300         BN_ULLONG t; \
301         t=(BN_ULLONG)w * (a) + (c); \
302         (r)= Lw(t); \
303         (c)= Hw(t); \
304         }
305
306 #define sqr(r0,r1,a) { \
307         BN_ULLONG t; \
308         t=(BN_ULLONG)(a)*(a); \
309         (r0)=Lw(t); \
310         (r1)=Hw(t); \
311         }
312
313 #elif defined(BN_UMULT_HIGH)
314 #define mul_add(r,a,w,c) {              \
315         BN_ULONG high,low,ret,tmp=(a);  \
316         ret =  (r);                     \
317         high=  BN_UMULT_HIGH(w,tmp);    \
318         ret += (c);                     \
319         low =  (w) * tmp;               \
320         (c) =  (ret<(c))?1:0;           \
321         (c) += high;                    \
322         ret += low;                     \
323         (c) += (ret<low)?1:0;           \
324         (r) =  ret;                     \
325         }
326
327 #define mul(r,a,w,c)    {               \
328         BN_ULONG high,low,ret,ta=(a);   \
329         low =  (w) * ta;                \
330         high=  BN_UMULT_HIGH(w,ta);     \
331         ret =  low + (c);               \
332         (c) =  high;                    \
333         (c) += (ret<low)?1:0;           \
334         (r) =  ret;                     \
335         }
336
337 #define sqr(r0,r1,a)    {               \
338         BN_ULONG tmp=(a);               \
339         (r0) = tmp * tmp;               \
340         (r1) = BN_UMULT_HIGH(tmp,tmp);  \
341         }
342
343 #else
344 /*************************************************************
345  * No long long type
346  */
347
348 #define LBITS(a)        ((a)&BN_MASK2l)
349 #define HBITS(a)        (((a)>>BN_BITS4)&BN_MASK2l)
350 #define L2HBITS(a)      ((BN_ULONG)((a)&BN_MASK2l)<<BN_BITS4)
351
352 #define LLBITS(a)       ((a)&BN_MASKl)
353 #define LHBITS(a)       (((a)>>BN_BITS2)&BN_MASKl)
354 #define LL2HBITS(a)     ((BN_ULLONG)((a)&BN_MASKl)<<BN_BITS2)
355
356 #define mul64(l,h,bl,bh) \
357         { \
358         BN_ULONG m,m1,lt,ht; \
359  \
360         lt=l; \
361         ht=h; \
362         m =(bh)*(lt); \
363         lt=(bl)*(lt); \
364         m1=(bl)*(ht); \
365         ht =(bh)*(ht); \
366         m=(m+m1)&BN_MASK2; if (m < m1) ht+=L2HBITS(1L); \
367         ht+=HBITS(m); \
368         m1=L2HBITS(m); \
369         lt=(lt+m1)&BN_MASK2; if (lt < m1) ht++; \
370         (l)=lt; \
371         (h)=ht; \
372         }
373
374 #define sqr64(lo,ho,in) \
375         { \
376         BN_ULONG l,h,m; \
377  \
378         h=(in); \
379         l=LBITS(h); \
380         h=HBITS(h); \
381         m =(l)*(h); \
382         l*=l; \
383         h*=h; \
384         h+=(m&BN_MASK2h1)>>(BN_BITS4-1); \
385         m =(m&BN_MASK2l)<<(BN_BITS4+1); \
386         l=(l+m)&BN_MASK2; if (l < m) h++; \
387         (lo)=l; \
388         (ho)=h; \
389         }
390
391 #define mul_add(r,a,bl,bh,c) { \
392         BN_ULONG l,h; \
393  \
394         h= (a); \
395         l=LBITS(h); \
396         h=HBITS(h); \
397         mul64(l,h,(bl),(bh)); \
398  \
399         /* non-multiply part */ \
400         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
401         (c)=(r); \
402         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
403         (c)=h&BN_MASK2; \
404         (r)=l; \
405         }
406
407 #define mul(r,a,bl,bh,c) { \
408         BN_ULONG l,h; \
409  \
410         h= (a); \
411         l=LBITS(h); \
412         h=HBITS(h); \
413         mul64(l,h,(bl),(bh)); \
414  \
415         /* non-multiply part */ \
416         l+=(c); if ((l&BN_MASK2) < (c)) h++; \
417         (c)=h&BN_MASK2; \
418         (r)=l&BN_MASK2; \
419         }
420 #endif /* !BN_LLONG */
421
422 void bn_mul_normal(BN_ULONG *r,BN_ULONG *a,int na,BN_ULONG *b,int nb);
423 void bn_mul_comba8(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
424 void bn_mul_comba4(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
425 void bn_sqr_normal(BN_ULONG *r, const BN_ULONG *a, int n, BN_ULONG *tmp);
426 void bn_sqr_comba8(BN_ULONG *r,const BN_ULONG *a);
427 void bn_sqr_comba4(BN_ULONG *r,const BN_ULONG *a);
428 int bn_cmp_words(const BN_ULONG *a,const BN_ULONG *b,int n);
429 int bn_cmp_part_words(const BN_ULONG *a, const BN_ULONG *b,
430         int cl, int dl);
431 void bn_mul_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,
432         int dna,int dnb,BN_ULONG *t);
433 void bn_mul_part_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,
434         int n,int tna,int tnb,BN_ULONG *t);
435 void bn_sqr_recursive(BN_ULONG *r,const BN_ULONG *a, int n2, BN_ULONG *t);
436 void bn_mul_low_normal(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b, int n);
437 void bn_mul_low_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,
438         BN_ULONG *t);
439 void bn_mul_high(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,BN_ULONG *l,int n2,
440         BN_ULONG *t);
441 BN_ULONG bn_add_part_words(BN_ULONG *r, const BN_ULONG *a, const BN_ULONG *b,
442         int cl, int dl);
443 BN_ULONG bn_sub_part_words(BN_ULONG *r, const BN_ULONG *a, const BN_ULONG *b,
444         int cl, int dl);
445
446 #ifdef  __cplusplus
447 }
448 #endif
449
450 #endif