src/third_party/boringssl/src/crypto/bn/internal.h

   1 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57 /* ====================================================================
  58  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
  59  *
  60  * Redistribution and use in source and binary forms, with or without
  61  * modification, are permitted provided that the following conditions
  62  * are met:
  63  *
  64  * 1. Redistributions of source code must retain the above copyright
  65  *    notice, this list of conditions and the following disclaimer.
  66  *
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in
  69  *    the documentation and/or other materials provided with the
  70  *    distribution.
  71  *
  72  * 3. All advertising materials mentioning features or use of this
  73  *    software must display the following acknowledgment:
  74  *    "This product includes software developed by the OpenSSL Project
  75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76  *
  77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78  *    endorse or promote products derived from this software without
  79  *    prior written permission. For written permission, please contact
  80  *    openssl-core@openssl.org.
  81  *
  82  * 5. Products derived from this software may not be called "OpenSSL"
  83  *    nor may "OpenSSL" appear in their names without prior written
  84  *    permission of the OpenSSL Project.
  85  *
  86  * 6. Redistributions of any form whatsoever must retain the following
  87  *    acknowledgment:
  88  *    "This product includes software developed by the OpenSSL Project
  89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90  *
  91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 102  * OF THE POSSIBILITY OF SUCH DAMAGE.
 103  * ====================================================================
 104  *
 105  * This product includes cryptographic software written by Eric Young
 106  * (eay@cryptsoft.com).  This product includes software written by Tim
 107  * Hudson (tjh@cryptsoft.com).
 108  *
 109  */
 110 /* ====================================================================
 111  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
 112  *
 113  * Portions of the attached software ("Contribution") are developed by
 114  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
 115  *
 116  * The Contribution is licensed pursuant to the Eric Young open source
 117  * license provided above.
 118  *
 119  * The binary polynomial arithmetic software is originally written by
 120  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems
 121  * Laboratories. */
 122
 123 #ifndef OPENSSL_HEADER_BN_INTERNAL_H
 124 #define OPENSSL_HEADER_BN_INTERNAL_H
 125
 126 #include <openssl/base.h>
 127
 128 #include <inttypes.h>
 129
 130 #if defined(__cplusplus)
 131 extern "C" {
 132 #endif
 133
 134 /* BN_wexpand ensures that |bn| has at least |words| works of space without
 135  * altering its value. It returns one on success or zero on allocation
 136  * failure. */
 137 BIGNUM *bn_wexpand(BIGNUM *bn, unsigned words);
 138
 139 /* bn_expand acts the same as |BN_wexpand|, but takes a number of bits rather
 140  * than a number of words. */
 141 BIGNUM *bn_expand(BIGNUM *bn, unsigned bits);
 142
 143 /* bn_correct_top decrements |bn->top| until |bn->d[top-1]| is non-zero or
 144  * until |top| is zero. */
 145 void bn_correct_top(BIGNUM *bn);
 146
 147 #if defined(OPENSSL_64_BIT)
 148
 149 #define BN_ULLONG       unsigned long long
 150 #define BN_LONG         long
 151 #define BN_BITS         128
 152 #define BN_BYTES        8
 153 #define BN_BITS4        32
 154 #define BN_MASK         (0xffffffffffffffffffffffffffffffffLL)
 155 #define BN_MASK2        (0xffffffffffffffffL)
 156 #define BN_MASK2l       (0xffffffffL)
 157 #define BN_MASK2h       (0xffffffff00000000L)
 158 #define BN_MASK2h1      (0xffffffff80000000L)
 159 #define BN_TBIT         (0x8000000000000000L)
 160 #define BN_DEC_CONV     (10000000000000000000UL)
 161 #define BN_DEC_FMT1     "%" PRIu64
 162 #define BN_DEC_FMT2     "%019" PRIu64
 163 #define BN_DEC_NUM      19
 164 #define BN_HEX_FMT1     "%" PRIx64
 165
 166 #elif defined(OPENSSL_32_BIT)
 167
 168 #define BN_ULLONG       unsigned long long
 169 #define BN_MASK (0xffffffffffffffffLL)
 170 #define BN_LONG         int32_t
 171 #define BN_BITS         64
 172 #define BN_BYTES        4
 173 #define BN_BITS4        16
 174 #define BN_MASK2        (0xffffffffL)
 175 #define BN_MASK2l       (0xffff)
 176 #define BN_MASK2h1      (0xffff8000L)
 177 #define BN_MASK2h       (0xffff0000L)
 178 #define BN_TBIT         (0x80000000L)
 179 #define BN_DEC_CONV     (1000000000L)
 180 #define BN_DEC_FMT1     "%" PRIu32
 181 #define BN_DEC_FMT2     "%09" PRIu32
 182 #define BN_DEC_NUM      9
 183 #define BN_HEX_FMT1     "%" PRIx32
 184
 185 #else
 186 #error "Must define either OPENSSL_32_BIT or OPENSSL_64_BIT"
 187 #endif
 188
 189 /* Pentium pro 16,16,16,32,64 */
 190 /* Alpha       16,16,16,16.64 */
 191 #define BN_MULL_SIZE_NORMAL (16)              /* 32 */
 192 #define BN_MUL_RECURSIVE_SIZE_NORMAL (16)     /* 32 less than */
 193 #define BN_SQR_RECURSIVE_SIZE_NORMAL (16)     /* 32 */
 194 #define BN_MUL_LOW_RECURSIVE_SIZE_NORMAL (32) /* 32 */
 195 #define BN_MONT_CTX_SET_SIZE_WORD (64)        /* 32 */
 196
 197 BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
 198 BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
 199 void     bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num);
 200 BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
 201 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
 202 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
 203
 204 void bn_mul_comba4(BN_ULONG *r, BN_ULONG *a, BN_ULONG *b);
 205 void bn_mul_comba8(BN_ULONG *r, BN_ULONG *a, BN_ULONG *b);
 206 void bn_sqr_comba8(BN_ULONG *r, const BN_ULONG *a);
 207 void bn_sqr_comba4(BN_ULONG *r, const BN_ULONG *a);
 208
 209 /* bn_cmp_words returns a value less than, equal to or greater than zero if
 210  * the, length |n|, array |a| is less than, equal to or greater than |b|. */
 211 int bn_cmp_words(const BN_ULONG *a, const BN_ULONG *b, int n);
 212
 213 /* bn_cmp_words returns a value less than, equal to or greater than zero if the
 214  * array |a| is less than, equal to or greater than |b|. The arrays can be of
 215  * different lengths: |cl| gives the minimum of the two lengths and |dl| gives
 216  * the length of |a| minus the length of |b|. */
 217 int bn_cmp_part_words(const BN_ULONG *a, const BN_ULONG *b, int cl, int dl);
 218
 219 int bn_mul_mont(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,
 220                 const BN_ULONG *np, const BN_ULONG *n0, int num);
 221
 222 #define LBITS(a) ((a) & BN_MASK2l)
 223 #define HBITS(a) (((a) >> BN_BITS4) & BN_MASK2l)
 224 #define L2HBITS(a) (((a) << BN_BITS4) & BN_MASK2)
 225
 226 #define LLBITS(a) ((a) & BN_MASKl)
 227 #define LHBITS(a) (((a) >> BN_BITS2) & BN_MASKl)
 228 #define LL2HBITS(a) ((BN_ULLONG)((a) & BN_MASKl) << BN_BITS2)
 229
 230 #define mul64(l, h, bl, bh)       \
 231   {                               \
 232     BN_ULONG m, m1, lt, ht;       \
 233                                   \
 234     lt = l;                       \
 235     ht = h;                       \
 236     m = (bh) * (lt);              \
 237     lt = (bl) * (lt);             \
 238     m1 = (bl) * (ht);             \
 239     ht = (bh) * (ht);             \
 240     m = (m + m1) & BN_MASK2;      \
 241     if (m < m1)                   \
 242       ht += L2HBITS((BN_ULONG)1); \
 243     ht += HBITS(m);               \
 244     m1 = L2HBITS(m);              \
 245     lt = (lt + m1) & BN_MASK2;    \
 246     if (lt < m1)                  \
 247       ht++;                       \
 248     (l) = lt;                     \
 249     (h) = ht;                     \
 250   }
 251
 252 #if !defined(OPENSSL_NO_ASM) && defined(OPENSSL_X86_64)
 253 # if defined(__GNUC__) && __GNUC__>=2
 254 #  define BN_UMULT_HIGH(a,b)    ({      \
 255         register BN_ULONG ret,discard;  \
 256         __asm__ ("mulq  %3"             \
 257              : "=a"(discard),"=d"(ret)  \
 258              : "a"(a), "g"(b)           \
 259              : "cc");                   \
 260         ret;                    })
 261 #  define BN_UMULT_LOHI(low,high,a,b)   \
 262         __asm__ ("mulq  %3"             \
 263                 : "=a"(low),"=d"(high)  \
 264                 : "a"(a),"g"(b)         \
 265                 : "cc");
 266 # endif
 267 # if defined(_MSC_VER) && _MSC_VER>=1400
 268    unsigned __int64 __umulh     (unsigned __int64 a,unsigned __int64 b);
 269    unsigned __int64 _umul128    (unsigned __int64 a,unsigned __int64 b,
 270                                  unsigned __int64 *h);
 271 #  pragma intrinsic(__umulh,_umul128)
 272 #  define BN_UMULT_HIGH(a,b)            __umulh((a),(b))
 273 #  define BN_UMULT_LOHI(low,high,a,b)   ((low)=_umul128((a),(b),&(high)))
 274 # endif
 275 #elif !defined(OPENSSL_NO_ASM) && defined(OPENSSL_AARCH64)
 276 # if defined(__GNUC__) && __GNUC__>=2
 277 #  define BN_UMULT_HIGH(a,b)    ({      \
 278         register BN_ULONG ret;          \
 279         __asm__ ("umulh %0,%1,%2"       \
 280              : "=r"(ret)                \
 281              : "r"(a), "r"(b));         \
 282         ret;                    })
 283 # endif
 284 #endif
 285
 286
 287 #if defined(__cplusplus)
 288 }  /* extern C */
 289 #endif
 290
 291 #endif  /* OPENSSL_HEADER_BN_INTERNAL_H */