Import of openssl-0.9.8, a feature release.
[dragonfly.git] / crypto / openssl-0.9 / 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 /*
123  * BN_window_bits_for_exponent_size -- macro for sliding window mod_exp functions
124  *
125  *
126  * For window size 'w' (w >= 2) and a random 'b' bits exponent,
127  * the number of multiplications is a constant plus on average
128  *
129  *    2^(w-1) + (b-w)/(w+1);
130  *
131  * here  2^(w-1)  is for precomputing the table (we actually need
132  * entries only for windows that have the lowest bit set), and
133  * (b-w)/(w+1)  is an approximation for the expected number of
134  * w-bit windows, not counting the first one.
135  *
136  * Thus we should use
137  *
138  *    w >= 6  if        b > 671
139  *     w = 5  if  671 > b > 239
140  *     w = 4  if  239 > b >  79
141  *     w = 3  if   79 > b >  23
142  *    w <= 2  if   23 > b
143  *
144  * (with draws in between).  Very small exponents are often selected
145  * with low Hamming weight, so we use  w = 1  for b <= 23.
146  */
147 #if 1
148 #define BN_window_bits_for_exponent_size(b) \
149                 ((b) > 671 ? 6 : \
150                  (b) > 239 ? 5 : \
151                  (b) >  79 ? 4 : \
152                  (b) >  23 ? 3 : 1)
153 #else
154 /* Old SSLeay/OpenSSL table.
155  * Maximum window size was 5, so this table differs for b==1024;
156  * but it coincides for other interesting values (b==160, b==512).
157  */
158 #define BN_window_bits_for_exponent_size(b) \
159                 ((b) > 255 ? 5 : \
160                  (b) > 127 ? 4 : \
161                  (b) >  17 ? 3 : 1)
162 #endif   
163
164
165
166 /* BN_mod_exp_mont_conttime is based on the assumption that the
167  * L1 data cache line width of the target processor is at least
168  * the following value.
169  */
170 #define MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH      ( 64 )
171 #define MOD_EXP_CTIME_MIN_CACHE_LINE_MASK       (MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH - 1)
172
173 /* Window sizes optimized for fixed window size modular exponentiation
174  * algorithm (BN_mod_exp_mont_consttime).
175  *
176  * To achieve the security goals of BN_mode_exp_mont_consttime, the
177  * maximum size of the window must not exceed
178  * log_2(MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH). 
179  *
180  * Window size thresholds are defined for cache line sizes of 32 and 64,
181  * cache line sizes where log_2(32)=5 and log_2(64)=6 respectively. A
182  * window size of 7 should only be used on processors that have a 128
183  * byte or greater cache line size.
184  */
185 #if MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH == 64
186
187 #  define BN_window_bits_for_ctime_exponent_size(b) \
188                 ((b) > 937 ? 6 : \
189                  (b) > 306 ? 5 : \
190                  (b) >  89 ? 4 : \
191                  (b) >  22 ? 3 : 1)
192 #  define BN_MAX_WINDOW_BITS_FOR_CTIME_EXPONENT_SIZE    (6)
193
194 #elif MOD_EXP_CTIME_MIN_CACHE_LINE_WIDTH == 32
195
196 #  define BN_window_bits_for_ctime_exponent_size(b) \
197                 ((b) > 306 ? 5 : \
198                  (b) >  89 ? 4 : \
199                  (b) >  22 ? 3 : 1)
200 #  define BN_MAX_WINDOW_BITS_FOR_CTIME_EXPONENT_SIZE    (5)
201
202 #endif
203
204
205 /* Pentium pro 16,16,16,32,64 */
206 /* Alpha       16,16,16,16.64 */
207 #define BN_MULL_SIZE_NORMAL                     (16) /* 32 */
208 #define BN_MUL_RECURSIVE_SIZE_NORMAL            (16) /* 32 less than */
209 #define BN_SQR_RECURSIVE_SIZE_NORMAL            (16) /* 32 */
210 #define BN_MUL_LOW_RECURSIVE_SIZE_NORMAL        (32) /* 32 */
211 #define BN_MONT_CTX_SET_SIZE_WORD               (64) /* 32 */
212
213 #if !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM) && !defined(PEDANTIC)
214 /*
215  * BN_UMULT_HIGH section.
216  *
217  * No, I'm not trying to overwhelm you when stating that the
218  * product of N-bit numbers is 2*N bits wide:-) No, I don't expect
219  * you to be impressed when I say that if the compiler doesn't
220  * support 2*N integer type, then you have to replace every N*N
221  * multiplication with 4 (N/2)*(N/2) accompanied by some shifts
222  * and additions which unavoidably results in severe performance
223  * penalties. Of course provided that the hardware is capable of
224  * producing 2*N result... That's when you normally start
225  * considering assembler implementation. However! It should be
226  * pointed out that some CPUs (most notably Alpha, PowerPC and
227  * upcoming IA-64 family:-) provide *separate* instruction
228  * calculating the upper half of the product placing the result
229  * into a general purpose register. Now *if* the compiler supports
230  * inline assembler, then it's not impossible to implement the
231  * "bignum" routines (and have the compiler optimize 'em)
232  * exhibiting "native" performance in C. That's what BN_UMULT_HIGH
233  * macro is about:-)
234  *
235  *                                      <appro@fy.chalmers.se>
236  */
237 # if defined(__alpha) && (defined(SIXTY_FOUR_BIT_LONG) || defined(SIXTY_FOUR_BIT))
238 #  if defined(__DECC)
239 #   include <c_asm.h>
240 #   define BN_UMULT_HIGH(a,b)   (BN_ULONG)asm("umulh %a0,%a1,%v0",(a),(b))
241 #  elif defined(__GNUC__)
242 #   define BN_UMULT_HIGH(a,b)   ({      \
243         register BN_ULONG ret;          \
244         asm ("umulh     %1,%2,%0"       \
245              : "=r"(ret)                \
246              : "r"(a), "r"(b));         \
247         ret;                    })
248 #  endif        /* compiler */
249 # elif defined(_ARCH_PPC) && defined(__64BIT__) && defined(SIXTY_FOUR_BIT_LONG)
250 #  if defined(__GNUC__)
251 #   define BN_UMULT_HIGH(a,b)   ({      \
252         register BN_ULONG ret;          \
253         asm ("mulhdu    %0,%1,%2"       \
254              : "=r"(ret)                \
255              : "r"(a), "r"(b));         \
256         ret;                    })
257 #  endif        /* compiler */
258 # elif defined(__x86_64) && defined(SIXTY_FOUR_BIT_LONG)
259 #  if defined(__GNUC__)
260 #   define BN_UMULT_HIGH(a,b)   ({      \
261         register BN_ULONG ret,discard;  \
262         asm ("mulq      %3"             \
263              : "=a"(discard),"=d"(ret)  \
264              : "a"(a), "g"(b)           \
265              : "cc");                   \
266         ret;                    })
267 #   define BN_UMULT_LOHI(low,high,a,b)  \
268         asm ("mulq      %3"             \
269                 : "=a"(low),"=d"(high)  \
270                 : "a"(a),"g"(b)         \
271                 : "cc");
272 #  endif
273 # endif         /* cpu */
274 #endif          /* OPENSSL_NO_ASM */
275
276 /*************************************************************
277  * Using the long long type
278  */
279 #define Lw(t)    (((BN_ULONG)(t))&BN_MASK2)
280 #define Hw(t)    (((BN_ULONG)((t)>>BN_BITS2))&BN_MASK2)
281
282 #ifdef BN_DEBUG_RAND
283 #define bn_clear_top2max(a) \
284         { \
285         int      ind = (a)->dmax - (a)->top; \
286         BN_ULONG *ftl = &(a)->d[(a)->top-1]; \
287         for (; ind != 0; ind--) \
288                 *(++ftl) = 0x0; \
289         }
290 #else
291 #define bn_clear_top2max(a)
292 #endif
293
294 #ifdef BN_LLONG
295 #define mul_add(r,a,w,c) { \
296         BN_ULLONG t; \
297         t=(BN_ULLONG)w * (a) + (r) + (c); \
298         (r)= Lw(t); \
299         (c)= Hw(t); \
300         }
301
302 #define mul(r,a,w,c) { \
303         BN_ULLONG t; \
304         t=(BN_ULLONG)w * (a) + (c); \
305         (r)= Lw(t); \
306         (c)= Hw(t); \
307         }
308
309 #define sqr(r0,r1,a) { \
310         BN_ULLONG t; \
311         t=(BN_ULLONG)(a)*(a); \
312         (r0)=Lw(t); \
313         (r1)=Hw(t); \
314         }
315
316 #elif defined(BN_UMULT_HIGH)
317 #define mul_add(r,a,w,c) {              \
318         BN_ULONG high,low,ret,tmp=(a);  \
319         ret =  (r);                     \
320         high=  BN_UMULT_HIGH(w,tmp);    \
321         ret += (c);                     \
322         low =  (w) * tmp;               \
323         (c) =  (ret<(c))?1:0;           \
324         (c) += high;                    \
325         ret += low;                     \
326         (c) += (ret<low)?1:0;           \
327         (r) =  ret;                     \
328         }
329
330 #define mul(r,a,w,c)    {               \
331         BN_ULONG high,low,ret,ta=(a);   \
332         low =  (w) * ta;                \
333         high=  BN_UMULT_HIGH(w,ta);     \
334         ret =  low + (c);               \
335         (c) =  high;                    \
336         (c) += (ret<low)?1:0;           \
337         (r) =  ret;                     \
338         }
339
340 #define sqr(r0,r1,a)    {               \
341         BN_ULONG tmp=(a);               \
342         (r0) = tmp * tmp;               \
343         (r1) = BN_UMULT_HIGH(tmp,tmp);  \
344         }
345
346 #else
347 /*************************************************************
348  * No long long type
349  */
350
351 #define LBITS(a)        ((a)&BN_MASK2l)
352 #define HBITS(a)        (((a)>>BN_BITS4)&BN_MASK2l)
353 #define L2HBITS(a)      (((a)<<BN_BITS4)&BN_MASK2)
354
355 #define LLBITS(a)       ((a)&BN_MASKl)
356 #define LHBITS(a)       (((a)>>BN_BITS2)&BN_MASKl)
357 #define LL2HBITS(a)     ((BN_ULLONG)((a)&BN_MASKl)<<BN_BITS2)
358
359 #define mul64(l,h,bl,bh) \
360         { \
361         BN_ULONG m,m1,lt,ht; \
362  \
363         lt=l; \
364         ht=h; \
365         m =(bh)*(lt); \
366         lt=(bl)*(lt); \
367         m1=(bl)*(ht); \
368         ht =(bh)*(ht); \
369         m=(m+m1)&BN_MASK2; if (m < m1) ht+=L2HBITS((BN_ULONG)1); \
370         ht+=HBITS(m); \
371         m1=L2HBITS(m); \
372         lt=(lt+m1)&BN_MASK2; if (lt < m1) ht++; \
373         (l)=lt; \
374         (h)=ht; \
375         }
376
377 #define sqr64(lo,ho,in) \
378         { \
379         BN_ULONG l,h,m; \
380  \
381         h=(in); \
382         l=LBITS(h); \
383         h=HBITS(h); \
384         m =(l)*(h); \
385         l*=l; \
386         h*=h; \
387         h+=(m&BN_MASK2h1)>>(BN_BITS4-1); \
388         m =(m&BN_MASK2l)<<(BN_BITS4+1); \
389         l=(l+m)&BN_MASK2; if (l < m) h++; \
390         (lo)=l; \
391         (ho)=h; \
392         }
393
394 #define mul_add(r,a,bl,bh,c) { \
395         BN_ULONG l,h; \
396  \
397         h= (a); \
398         l=LBITS(h); \
399         h=HBITS(h); \
400         mul64(l,h,(bl),(bh)); \
401  \
402         /* non-multiply part */ \
403         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
404         (c)=(r); \
405         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
406         (c)=h&BN_MASK2; \
407         (r)=l; \
408         }
409
410 #define mul(r,a,bl,bh,c) { \
411         BN_ULONG l,h; \
412  \
413         h= (a); \
414         l=LBITS(h); \
415         h=HBITS(h); \
416         mul64(l,h,(bl),(bh)); \
417  \
418         /* non-multiply part */ \
419         l+=(c); if ((l&BN_MASK2) < (c)) h++; \
420         (c)=h&BN_MASK2; \
421         (r)=l&BN_MASK2; \
422         }
423 #endif /* !BN_LLONG */
424
425 void bn_mul_normal(BN_ULONG *r,BN_ULONG *a,int na,BN_ULONG *b,int nb);
426 void bn_mul_comba8(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
427 void bn_mul_comba4(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
428 void bn_sqr_normal(BN_ULONG *r, const BN_ULONG *a, int n, BN_ULONG *tmp);
429 void bn_sqr_comba8(BN_ULONG *r,const BN_ULONG *a);
430 void bn_sqr_comba4(BN_ULONG *r,const BN_ULONG *a);
431 int bn_cmp_words(const BN_ULONG *a,const BN_ULONG *b,int n);
432 int bn_cmp_part_words(const BN_ULONG *a, const BN_ULONG *b,
433         int cl, int dl);
434 void bn_mul_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,
435         int dna,int dnb,BN_ULONG *t);
436 void bn_mul_part_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,
437         int n,int tna,int tnb,BN_ULONG *t);
438 void bn_sqr_recursive(BN_ULONG *r,const BN_ULONG *a, int n2, BN_ULONG *t);
439 void bn_mul_low_normal(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b, int n);
440 void bn_mul_low_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,
441         BN_ULONG *t);
442 void bn_mul_high(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,BN_ULONG *l,int n2,
443         BN_ULONG *t);
444 BN_ULONG bn_add_part_words(BN_ULONG *r, const BN_ULONG *a, const BN_ULONG *b,
445         int cl, int dl);
446 BN_ULONG bn_sub_part_words(BN_ULONG *r, const BN_ULONG *a, const BN_ULONG *b,
447         int cl, int dl);
448
449 #ifdef  __cplusplus
450 }
451 #endif
452
453 #endif