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