1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay (at) 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 (at) 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 (at) 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 (at) 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 * This product includes cryptographic software written by Eric Young 58 * (eay (at) cryptsoft.com). This product includes software written by Tim 59 * Hudson (tjh (at) cryptsoft.com). */ 60 61 #ifndef OPENSSL_HEADER_CPU_H 62 #define OPENSSL_HEADER_CPU_H 63 64 #include <openssl/base.h> 65 66 #if defined(__cplusplus) 67 extern "C" { 68 #endif 69 70 71 // Runtime CPU feature support 72 73 74 #if defined(OPENSSL_X86) || defined(OPENSSL_X86_64) 75 // OPENSSL_ia32cap_P contains the Intel CPUID bits when running on an x86 or 76 // x86-64 system. 77 // 78 // Index 0: 79 // EDX for CPUID where EAX = 1 80 // Bit 20 is always zero 81 // Bit 28 is adjusted to reflect whether the data cache is shared between 82 // multiple logical cores 83 // Bit 30 is used to indicate an Intel CPU 84 // Index 1: 85 // ECX for CPUID where EAX = 1 86 // Bit 11 is used to indicate AMD XOP support, not SDBG 87 // Index 2: 88 // EBX for CPUID where EAX = 7 89 // Index 3: 90 // ECX for CPUID where EAX = 7 91 // 92 // Note: the CPUID bits are pre-adjusted for the OSXSAVE bit and the YMM and XMM 93 // bits in XCR0, so it is not necessary to check those. 94 extern uint32_t OPENSSL_ia32cap_P[4]; 95 96 #if defined(BORINGSSL_FIPS) 97 const uint32_t *OPENSSL_ia32cap_get(void); 98 #else 99 OPENSSL_INLINE const uint32_t *OPENSSL_ia32cap_get(void) { 100 return OPENSSL_ia32cap_P; 101 } 102 #endif 103 104 #endif 105 106 #if defined(OPENSSL_ARM) || defined(OPENSSL_AARCH64) 107 108 #if defined(OPENSSL_APPLE) 109 // iOS builds use the static ARM configuration. 110 #define OPENSSL_STATIC_ARMCAP 111 #endif 112 113 #if !defined(OPENSSL_STATIC_ARMCAP) 114 115 // CRYPTO_is_NEON_capable_at_runtime returns true if the current CPU has a NEON 116 // unit. Note that |OPENSSL_armcap_P| also exists and contains the same 117 // information in a form that's easier for assembly to use. 118 OPENSSL_EXPORT char CRYPTO_is_NEON_capable_at_runtime(void); 119 120 // CRYPTO_is_NEON_capable returns true if the current CPU has a NEON unit. If 121 // this is known statically then it returns one immediately. 122 OPENSSL_INLINE int CRYPTO_is_NEON_capable(void) { 123 // Only statically skip the runtime lookup on aarch64. On arm, one CPU is 124 // known to have a broken NEON unit which is known to fail with on some 125 // hand-written NEON assembly. For now, continue to apply the workaround even 126 // when the compiler is instructed to freely emit NEON code. See 127 // https://crbug.com/341598 and https://crbug.com/606629. 128 #if (defined(__ARM_NEON__) || defined(__ARM_NEON)) && !defined(OPENSSL_ARM) 129 return 1; 130 #else 131 return CRYPTO_is_NEON_capable_at_runtime(); 132 #endif 133 } 134 135 #if defined(OPENSSL_ARM) 136 // CRYPTO_has_broken_NEON returns one if the current CPU is known to have a 137 // broken NEON unit. See https://crbug.com/341598. 138 OPENSSL_EXPORT int CRYPTO_has_broken_NEON(void); 139 140 // CRYPTO_needs_hwcap2_workaround returns one if the ARMv8 AArch32 AT_HWCAP2 141 // workaround was needed. See https://crbug.com/boringssl/46. 142 OPENSSL_EXPORT int CRYPTO_needs_hwcap2_workaround(void); 143 #endif 144 145 // CRYPTO_is_ARMv8_AES_capable returns true if the current CPU supports the 146 // ARMv8 AES instruction. 147 int CRYPTO_is_ARMv8_AES_capable(void); 148 149 // CRYPTO_is_ARMv8_PMULL_capable returns true if the current CPU supports the 150 // ARMv8 PMULL instruction. 151 int CRYPTO_is_ARMv8_PMULL_capable(void); 152 153 #else 154 155 OPENSSL_INLINE int CRYPTO_is_NEON_capable(void) { 156 #if defined(OPENSSL_STATIC_ARMCAP_NEON) || \ 157 (defined(__ARM_NEON__) || defined(__ARM_NEON)) 158 return 1; 159 #else 160 return 0; 161 #endif 162 } 163 164 OPENSSL_INLINE int CRYPTO_is_ARMv8_AES_capable(void) { 165 #if defined(OPENSSL_STATIC_ARMCAP_AES) || defined(__ARM_FEATURE_CRYPTO) 166 return 1; 167 #else 168 return 0; 169 #endif 170 } 171 172 OPENSSL_INLINE int CRYPTO_is_ARMv8_PMULL_capable(void) { 173 #if defined(OPENSSL_STATIC_ARMCAP_PMULL) || defined(__ARM_FEATURE_CRYPTO) 174 return 1; 175 #else 176 return 0; 177 #endif 178 } 179 180 #endif // OPENSSL_STATIC_ARMCAP 181 #endif // OPENSSL_ARM || OPENSSL_AARCH64 182 183 #if defined(OPENSSL_PPC64LE) 184 185 // CRYPTO_is_PPC64LE_vcrypto_capable returns true iff the current CPU supports 186 // the Vector.AES category of instructions. 187 int CRYPTO_is_PPC64LE_vcrypto_capable(void); 188 189 extern unsigned long OPENSSL_ppc64le_hwcap2; 190 191 #endif // OPENSSL_PPC64LE 192 193 #if !defined(NDEBUG) && !defined(BORINGSSL_FIPS) 194 // Runtime CPU dispatch testing support 195 196 // BORINGSSL_function_hit is an array of flags. The following functions will 197 // set these flags in non-FIPS builds if NDEBUG is not defined. 198 // 0: aes_hw_ctr32_encrypt_blocks 199 // 1: aes_hw_encrypt 200 // 2: aesni_gcm_encrypt 201 // 3: aes_hw_set_encrypt_key 202 // 4: vpaes_encrypt 203 // 5: vpaes_set_encrypt_key 204 // 6: bsaes_ctr32_encrypt_blocks 205 extern uint8_t BORINGSSL_function_hit[7]; 206 #endif // !NDEBUG && !FIPS 207 208 209 #if defined(__cplusplus) 210 } // extern C 211 #endif 212 213 #endif // OPENSSL_HEADER_CPU_H 214
