AppleCSP/open_ssl/bn/bn_lcl.h

   1 /*
   2  * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 /* crypto/bn/bn_lcl.h */
  20 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  21  * All rights reserved.
  22  *
  23  * This package is an SSL implementation written
  24  * by Eric Young (eay@cryptsoft.com).
  25  * The implementation was written so as to conform with Netscapes SSL.
  26  *
  27  * This library is free for commercial and non-commercial use as long as
  28  * the following conditions are aheared to.  The following conditions
  29  * apply to all code found in this distribution, be it the RC4, RSA,
  30  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  31  * included with this distribution is covered by the same copyright terms
  32  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  33  *
  34  * Copyright remains Eric Young's, and as such any Copyright notices in
  35  * the code are not to be removed.
  36  * If this package is used in a product, Eric Young should be given attribution
  37  * as the author of the parts of the library used.
  38  * This can be in the form of a textual message at program startup or
  39  * in documentation (online or textual) provided with the package.
  40  *
  41  * Redistribution and use in source and binary forms, with or without
  42  * modification, are permitted provided that the following conditions
  43  * are met:
  44  * 1. Redistributions of source code must retain the copyright
  45  *    notice, this list of conditions and the following disclaimer.
  46  * 2. Redistributions in binary form must reproduce the above copyright
  47  *    notice, this list of conditions and the following disclaimer in the
  48  *    documentation and/or other materials provided with the distribution.
  49  * 3. All advertising materials mentioning features or use of this software
  50  *    must display the following acknowledgement:
  51  *    "This product includes cryptographic software written by
  52  *     Eric Young (eay@cryptsoft.com)"
  53  *    The word 'cryptographic' can be left out if the rouines from the library
  54  *    being used are not cryptographic related :-).
  55  * 4. If you include any Windows specific code (or a derivative thereof) from
  56  *    the apps directory (application code) you must include an acknowledgement:
  57  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  58  *
  59  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  69  * SUCH DAMAGE.
  70  *
  71  * The licence and distribution terms for any publically available version or
  72  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  73  * copied and put under another distribution licence
  74  * [including the GNU Public Licence.]
  75  */
  76
  77 #ifndef HEADER_BN_LCL_H
  78 #define HEADER_BN_LCL_H
  79
  80 #include <openssl/bn.h>
  81
  82 #ifdef  __cplusplus
  83 extern "C" {
  84 #endif
  85
  86 /* Pentium pro 16,16,16,32,64 */
  87 /* Alpha       16,16,16,16.64 */
  88 #define BN_MULL_SIZE_NORMAL                     (16) /* 32 */
  89 #define BN_MUL_RECURSIVE_SIZE_NORMAL            (16) /* 32 less than */
  90 #define BN_SQR_RECURSIVE_SIZE_NORMAL            (16) /* 32 */
  91 #define BN_MUL_LOW_RECURSIVE_SIZE_NORMAL        (32) /* 32 */
  92 #define BN_MONT_CTX_SET_SIZE_WORD               (64) /* 32 */
  93
  94 #if !defined(NO_ASM) && !defined(NO_INLINE_ASM) && !defined(PEDANTIC)
  95 /*
  96  * BN_UMULT_HIGH section.
  97  *
  98  * No, I'm not trying to overwhelm you when stating that the
  99  * product of N-bit numbers is 2*N bits wide:-) No, I don't expect
 100  * you to be impressed when I say that if the compiler doesn't
 101  * support 2*N integer type, then you have to replace every N*N
 102  * multiplication with 4 (N/2)*(N/2) accompanied by some shifts
 103  * and additions which unavoidably results in severe performance
 104  * penalties. Of course provided that the hardware is capable of
 105  * producing 2*N result... That's when you normally start
 106  * considering assembler implementation. However! It should be
 107  * pointed out that some CPUs (most notably Alpha, PowerPC and
 108  * upcoming IA-64 family:-) provide *separate* instruction
 109  * calculating the upper half of the product placing the result
 110  * into a general purpose register. Now *if* the compiler supports
 111  * inline assembler, then it's not impossible to implement the
 112  * "bignum" routines (and have the compiler optimize 'em)
 113  * exhibiting "native" performance in C. That's what BN_UMULT_HIGH
 114  * macro is about:-)
 115  *
 116  *                                      <appro@fy.chalmers.se>
 117  */
 118 # if defined(__alpha) && (defined(SIXTY_FOUR_BIT_LONG) || defined(SIXTY_FOUR_BIT))
 119 #  if defined(__DECC)
 120 #   include <c_asm.h>
 121 #   define BN_UMULT_HIGH(a,b)   (BN_ULONG)asm("umulh %a0,%a1,%v0",(a),(b))
 122 #  elif defined(__GNUC__)
 123 #   define BN_UMULT_HIGH(a,b)   ({      \
 124         register BN_ULONG ret;          \
 125         asm ("umulh     %1,%2,%0"       \
 126              : "=r"(ret)                \
 127              : "r"(a), "r"(b));         \
 128         ret;                    })
 129 #  endif        /* compiler */
 130 # elif defined(_ARCH_PPC) && defined(__64BIT__) && defined(SIXTY_FOUR_BIT_LONG)
 131 #  if defined(__GNUC__)
 132 #   define BN_UMULT_HIGH(a,b)   ({      \
 133         register BN_ULONG ret;          \
 134         asm ("mulhdu    %0,%1,%2"       \
 135              : "=r"(ret)                \
 136              : "r"(a), "r"(b));         \
 137         ret;                    })
 138 #  endif        /* compiler */
 139 # endif         /* cpu */
 140 #endif          /* NO_ASM */
 141
 142 /*************************************************************
 143  * Using the long long type
 144  */
 145 #define Lw(t)    (((BN_ULONG)(t))&BN_MASK2)
 146 #define Hw(t)    (((BN_ULONG)((t)>>BN_BITS2))&BN_MASK2)
 147
 148 /* This is used for internal error checking and is not normally used */
 149 #ifdef BN_DEBUG
 150 # include <assert.h>
 151 # define bn_check_top(a) assert ((a)->top >= 0 && (a)->top <= (a)->max);
 152 #else
 153 # define bn_check_top(a)
 154 #endif
 155
 156 /* This macro is to add extra stuff for development checking */
 157 #ifdef BN_DEBUG
 158 #define bn_set_max(r) ((r)->max=(r)->top,BN_set_flags((r),BN_FLG_STATIC_DATA))
 159 #else
 160 #define bn_set_max(r)
 161 #endif
 162
 163 /* These macros are used to 'take' a section of a bignum for read only use */
 164 #define bn_set_low(r,a,n) \
 165         { \
 166         (r)->top=((a)->top > (n))?(n):(a)->top; \
 167         (r)->d=(a)->d; \
 168         (r)->neg=(a)->neg; \
 169         (r)->flags|=BN_FLG_STATIC_DATA; \
 170         bn_set_max(r); \
 171         }
 172
 173 #define bn_set_high(r,a,n) \
 174         { \
 175         if ((a)->top > (n)) \
 176                 { \
 177                 (r)->top=(a)->top-n; \
 178                 (r)->d= &((a)->d[n]); \
 179                 } \
 180         else \
 181                 (r)->top=0; \
 182         (r)->neg=(a)->neg; \
 183         (r)->flags|=BN_FLG_STATIC_DATA; \
 184         bn_set_max(r); \
 185         }
 186
 187 #ifdef BN_LLONG
 188 #define mul_add(r,a,w,c) { \
 189         BN_ULLONG t; \
 190         t=(BN_ULLONG)w * (a) + (r) + (c); \
 191         (r)= Lw(t); \
 192         (c)= Hw(t); \
 193         }
 194
 195 #define mul(r,a,w,c) { \
 196         BN_ULLONG t; \
 197         t=(BN_ULLONG)w * (a) + (c); \
 198         (r)= Lw(t); \
 199         (c)= Hw(t); \
 200         }
 201
 202 #define sqr(r0,r1,a) { \
 203         BN_ULLONG t; \
 204         t=(BN_ULLONG)(a)*(a); \
 205         (r0)=Lw(t); \
 206         (r1)=Hw(t); \
 207         }
 208
 209 #elif defined(BN_UMULT_HIGH)
 210 #define mul_add(r,a,w,c) {              \
 211         BN_ULONG high,low,ret,tmp=(a);  \
 212         ret =  (r);                     \
 213         high=  BN_UMULT_HIGH(w,tmp);    \
 214         ret += (c);                     \
 215         low =  (w) * tmp;               \
 216         (c) =  (ret<(c))?1:0;           \
 217         (c) += high;                    \
 218         ret += low;                     \
 219         (c) += (ret<low)?1:0;           \
 220         (r) =  ret;                     \
 221         }
 222
 223 #define mul(r,a,w,c)    {               \
 224         BN_ULONG high,low,ret,ta=(a);   \
 225         low =  (w) * ta;                \
 226         high=  BN_UMULT_HIGH(w,ta);     \
 227         ret =  low + (c);               \
 228         (c) =  high;                    \
 229         (c) += (ret<low)?1:0;           \
 230         (r) =  ret;                     \
 231         }
 232
 233 #define sqr(r0,r1,a)    {               \
 234         BN_ULONG tmp=(a);               \
 235         (r0) = tmp * tmp;               \
 236         (r1) = BN_UMULT_HIGH(tmp,tmp);  \
 237         }
 238
 239 #else
 240 /*************************************************************
 241  * No long long type
 242  */
 243
 244 #define LBITS(a)        ((a)&BN_MASK2l)
 245 #define HBITS(a)        (((a)>>BN_BITS4)&BN_MASK2l)
 246 #define L2HBITS(a)      ((BN_ULONG)((a)&BN_MASK2l)<<BN_BITS4)
 247
 248 #define LLBITS(a)       ((a)&BN_MASKl)
 249 #define LHBITS(a)       (((a)>>BN_BITS2)&BN_MASKl)
 250 #define LL2HBITS(a)     ((BN_ULLONG)((a)&BN_MASKl)<<BN_BITS2)
 251
 252 #define mul64(l,h,bl,bh) \
 253         { \
 254         BN_ULONG m,m1,lt,ht; \
 255  \
 256         lt=l; \
 257         ht=h; \
 258         m =(bh)*(lt); \
 259         lt=(bl)*(lt); \
 260         m1=(bl)*(ht); \
 261         ht =(bh)*(ht); \
 262         m=(m+m1)&BN_MASK2; if (m < m1) ht+=L2HBITS(1L); \
 263         ht+=HBITS(m); \
 264         m1=L2HBITS(m); \
 265         lt=(lt+m1)&BN_MASK2; if (lt < m1) ht++; \
 266         (l)=lt; \
 267         (h)=ht; \
 268         }
 269
 270 #define sqr64(lo,ho,in) \
 271         { \
 272         BN_ULONG l,h,m; \
 273  \
 274         h=(in); \
 275         l=LBITS(h); \
 276         h=HBITS(h); \
 277         m =(l)*(h); \
 278         l*=l; \
 279         h*=h; \
 280         h+=(m&BN_MASK2h1)>>(BN_BITS4-1); \
 281         m =(m&BN_MASK2l)<<(BN_BITS4+1); \
 282         l=(l+m)&BN_MASK2; if (l < m) h++; \
 283         (lo)=l; \
 284         (ho)=h; \
 285         }
 286
 287 #define mul_add(r,a,bl,bh,c) { \
 288         BN_ULONG l,h; \
 289  \
 290         h= (a); \
 291         l=LBITS(h); \
 292         h=HBITS(h); \
 293         mul64(l,h,(bl),(bh)); \
 294  \
 295         /* non-multiply part */ \
 296         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
 297         (c)=(r); \
 298         l=(l+(c))&BN_MASK2; if (l < (c)) h++; \
 299         (c)=h&BN_MASK2; \
 300         (r)=l; \
 301         }
 302
 303 #define mul(r,a,bl,bh,c) { \
 304         BN_ULONG l,h; \
 305  \
 306         h= (a); \
 307         l=LBITS(h); \
 308         h=HBITS(h); \
 309         mul64(l,h,(bl),(bh)); \
 310  \
 311         /* non-multiply part */ \
 312         l+=(c); if ((l&BN_MASK2) < (c)) h++; \
 313         (c)=h&BN_MASK2; \
 314         (r)=l&BN_MASK2; \
 315         }
 316 #endif /* !BN_LLONG */
 317
 318 void bn_mul_normal(BN_ULONG *r,BN_ULONG *a,int na,BN_ULONG *b,int nb);
 319 void bn_mul_comba8(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
 320 void bn_mul_comba4(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b);
 321 void bn_sqr_normal(BN_ULONG *r, BN_ULONG *a, int n, BN_ULONG *tmp);
 322 void bn_sqr_comba8(BN_ULONG *r,BN_ULONG *a);
 323 void bn_sqr_comba4(BN_ULONG *r,BN_ULONG *a);
 324 int bn_cmp_words(BN_ULONG *a,BN_ULONG *b,int n);
 325 void bn_mul_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,BN_ULONG *t);
 326 void bn_mul_part_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,
 327         int tn, int n,BN_ULONG *t);
 328 void bn_sqr_recursive(BN_ULONG *r,BN_ULONG *a, int n2, BN_ULONG *t);
 329 void bn_mul_low_normal(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b, int n);
 330 void bn_mul_low_recursive(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,int n2,
 331         BN_ULONG *t);
 332 void bn_mul_high(BN_ULONG *r,BN_ULONG *a,BN_ULONG *b,BN_ULONG *l,int n2,
 333         BN_ULONG *t);
 334
 335 #ifdef  __cplusplus
 336 }
 337 #endif
 338
 339 #endif