Some assembler-related clean-ups.
[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 #ifndef HEADER_BN_LCL_H
60 #define HEADER_BN_LCL_H
61
62 #include <openssl/bn.h>
63
64 #ifdef  __cplusplus
65 extern "C" {
66 #endif
67
68 /* Pentium pro 16,16,16,32,64 */
69 /* Alpha       16,16,16,16.64 */
70 #define BN_MULL_SIZE_NORMAL                     (16) /* 32 */
71 #define BN_MUL_RECURSIVE_SIZE_NORMAL            (16) /* 32 less than */
72 #define BN_SQR_RECURSIVE_SIZE_NORMAL            (16) /* 32 */
73 #define BN_MUL_LOW_RECURSIVE_SIZE_NORMAL        (32) /* 32 */
74 #define BN_MONT_CTX_SET_SIZE_WORD               (64) /* 32 */
75
76 #if 0
77 #ifndef BN_MUL_COMBA
78 /* #define bn_mul_comba8(r,a,b) bn_mul_normal(r,a,8,b,8) */
79 /* #define bn_mul_comba4(r,a,b) bn_mul_normal(r,a,4,b,4) */
80 #endif
81
82 #ifndef BN_SQR_COMBA
83 /* This is probably faster than using the C code - I need to check */
84 #define bn_sqr_comba8(r,a)      bn_mul_normal(r,a,8,a,8)
85 #define bn_sqr_comba4(r,a)      bn_mul_normal(r,a,4,a,4)
86 #endif
87 #endif
88
89 /*************************************************************
90  * Using the long long type
91  */
92 #define Lw(t)    (((BN_ULONG)(t))&BN_MASK2)
93 #define Hw(t)    (((BN_ULONG)((t)>>BN_BITS2))&BN_MASK2)
94
95 /* These are used for internal error checking and are not normally used */
96 #ifdef BN_DEBUG
97 #define bn_check_top(a) \
98         { if (((a)->top < 0) || ((a)->top > (a)->max)) \
99                 { char *nullp=NULL; *nullp='z'; } }
100 #define bn_check_num(a) if ((a) < 0) { char *nullp=NULL; *nullp='z'; }
101 #else
102 #define bn_check_top(a)
103 #define bn_check_num(a)
104 #endif
105
106 /* This macro is to add extra stuff for development checking */
107 #ifdef BN_DEBUG
108 #define bn_set_max(r) ((r)->max=(r)->top,BN_set_flags((r),BN_FLG_STATIC_DATA))
109 #else
110 #define bn_set_max(r)
111 #endif
112
113 /* These macros are used to 'take' a section of a bignum for read only use */
114 #define bn_set_low(r,a,n) \
115         { \
116         (r)->top=((a)->top > (n))?(n):(a)->top; \
117         (r)->d=(a)->d; \
118         (r)->neg=(a)->neg; \
119         (r)->flags|=BN_FLG_STATIC_DATA; \
120         bn_set_max(r); \
121         }
122
123 #define bn_set_high(r,a,n) \
124         { \
125         if ((a)->top > (n)) \
126                 { \
127                 (r)->top=(a)->top-n; \
128                 (r)->d= &((a)->d[n]); \
129                 } \
130         else \
131                 (r)->top=0; \
132         (r)->neg=(a)->neg; \
133         (r)->flags|=BN_FLG_STATIC_DATA; \
134         bn_set_max(r); \
135         }
136
137 /* #define bn_expand(n,b) ((((b)/BN_BITS2) <= (n)->max)?(n):bn_expand2((n),(b))) */
138
139 #ifdef BN_LLONG
140 #define mul_add(r,a,w,c) { \
141         BN_ULLONG t; \
142         t=(BN_ULLONG)w * (a) + (r) + (c); \
143         (r)= Lw(t); \
144         (c)= Hw(t); \
145         }
146
147 #define mul(r,a,w,c) { \
148         BN_ULLONG t; \
149         t=(BN_ULLONG)w * (a) + (c); \
150         (r)= Lw(t); \
151         (c)= Hw(t); \
152         }
153
154 #else
155 /*************************************************************
156  * No long long type
157  */
158
159 #define LBITS(a)        ((a)&BN_MASK2l)
160 #define HBITS(a)        (((a)>>BN_BITS4)&BN_MASK2l)
161 #define L2HBITS(a)      ((BN_ULONG)((a)&BN_MASK2l)<<BN_BITS4)
162
163 #define LLBITS(a)       ((a)&BN_MASKl)
164 #define LHBITS(a)       (((a)>>BN_BITS2)&BN_MASKl)
165 #define LL2HBITS(a)     ((BN_ULLONG)((a)&BN_MASKl)<<BN_BITS2)
166
167 #define mul64(l,h,bl,bh) \
168         { \
169         BN_ULONG m,m1,lt,ht; \
170  \
171         lt=l; \
172         ht=h; \
173         m =(bh)*(lt); \
174         lt=(bl)*(lt); \
175         m1=(bl)*(ht); \
176         ht =(bh)*(ht); \
177         m=(m+m1)&BN_MASK2; if (m < m1) ht+=L2HBITS(1L); \
178         ht+=HBITS(m); \
179         m1=L2HBITS(m); \
180         lt=(lt+m1)&BN_MASK2; if (lt < m1) ht++; \
181         (l)=lt; \
182         (h)=ht; \
183         }
184
185 #define sqr64(lo,ho,in) \
186         { \
187         BN_ULONG l,h,m; \
188  \
189         h=(in); \
190         l=LBITS(h); \
191         h=HBITS(h); \
192         m =(l)*(h); \
193         l*=l; \
194         h*=h; \
195         h+=(m&BN_MASK2h1)>>(BN_BITS4-1); \
196         m =(m&BN_MASK2l)<<(BN_BITS4+1); \
197         l=(l+m)&BN_MASK2; if (l < m) h++; \
198         (lo)=l; \
199         (ho)=h; \
200         }
201
202 #define mul_add(r,a,bl,bh,c) { \
203         BN_ULONG l,h; \
204  \
205         h= (a); \
206         l=LBITS(h); \
207         h=HBITS(h); \
208         mul64(l,h,(bl),(bh)); \
209  \
210         /* non-multiply part */ \
211         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
212         (c)=(r); \
213         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
214         (c)=h&BN_MASK2; \
215         (r)=l; \
216         }
217
218 #define mul(r,a,bl,bh,c) { \
219         BN_ULONG l,h; \
220  \
221         h= (a); \
222         l=LBITS(h); \
223         h=HBITS(h); \
224         mul64(l,h,(bl),(bh)); \
225  \
226         /* non-multiply part */ \
227         l+=(c); if ((l&BN_MASK2) < (c)) h++; \
228         (c)=h&BN_MASK2; \
229         (r)=l&BN_MASK2; \
230         }
231
232 #endif
233
234 OPENSSL_EXTERN int bn_limit_bits;
235 OPENSSL_EXTERN int bn_limit_num;        /* (1<<bn_limit_bits) */
236 /* Recursive 'low' limit */
237 OPENSSL_EXTERN int bn_limit_bits_low;
238 OPENSSL_EXTERN int bn_limit_num_low;    /* (1<<bn_limit_bits_low) */
239 /* Do modified 'high' part calculation' */
240 OPENSSL_EXTERN int bn_limit_bits_high;
241 OPENSSL_EXTERN int bn_limit_num_high;   /* (1<<bn_limit_bits_high) */
242 OPENSSL_EXTERN int bn_limit_bits_mont;
243 OPENSSL_EXTERN int bn_limit_num_mont;   /* (1<<bn_limit_bits_mont) */
244
245 BIGNUM *bn_expand2(BIGNUM *b, int bits);
246
247 void bn_mul_normal(BN_ULONG *r,BN_ULONG *a,int na,BN_ULONG *b,int nb);
248 void bn_mul_comba8(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
249 void bn_mul_comba4(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
250 void bn_sqr_normal(BN_ULONG *r, BN_ULONG *a, int n, BN_ULONG *tmp);
251 void bn_sqr_comba8(BN_ULONG *r,BN_ULONG *a);
252 void bn_sqr_comba4(BN_ULONG *r,BN_ULONG *a);
253 int bn_cmp_words(BN_ULONG *a,BN_ULONG *b,int n);
254 void bn_mul_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,BN_ULONG *t);
255 void bn_mul_part_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,
256         int tn, int n,BN_ULONG *t);
257 void bn_sqr_recursive(BN_ULONG *r,BN_ULONG *a, int n2, BN_ULONG *t);
258 void bn_mul_low_normal(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b, int n);
259 void bn_mul_low_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,
260         BN_ULONG *t);
261 void bn_mul_high(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,BN_ULONG *l,int n2,
262         BN_ULONG *t);
263
264 #ifdef  __cplusplus
265 }
266 #endif
267
268 #endif