Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1 | /* Copyright (C) 1995-1998 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 | * This product includes cryptographic software written by Eric Young |
| 58 | * (eay@cryptsoft.com). This product includes software written by Tim |
| 59 | * Hudson (tjh@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 |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 80 | * Bit 20 is always zero |
| 81 | * Bit 28 is adjusted to reflect whether the data cache is shared between |
| 82 | * multiple logical cores |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 83 | * Bit 30 is used to indicate an Intel CPU |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 84 | * Index 1: |
| 85 | * ECX for CPUID where EAX = 1 |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 86 | * Bit 11 is used to indicate AMD XOP support, not SDBG |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 87 | * Index 2: |
| 88 | * EBX for CPUID where EAX = 7 |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 89 | * Index 3 is set to zero. |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 90 | * |
| 91 | * Note: the CPUID bits are pre-adjusted for the OSXSAVE bit and the YMM and XMM |
| 92 | * bits in XCR0, so it is not necessary to check those. */ |
| 93 | extern uint32_t OPENSSL_ia32cap_P[4]; |
Robert Sloan | 2424d84 | 2017-05-01 07:46:28 -0700 | [diff] [blame] | 94 | |
| 95 | #if defined(BORINGSSL_FIPS) |
| 96 | const uint32_t *OPENSSL_ia32cap_get(void); |
| 97 | #else |
| 98 | static inline const uint32_t *OPENSSL_ia32cap_get(void) { |
| 99 | return OPENSSL_ia32cap_P; |
| 100 | } |
| 101 | #endif |
| 102 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 103 | #endif |
| 104 | |
| 105 | #if defined(OPENSSL_ARM) || defined(OPENSSL_AARCH64) |
Kenny Root | e99801b | 2015-11-06 15:31:15 -0800 | [diff] [blame] | 106 | |
| 107 | #if defined(OPENSSL_APPLE) |
| 108 | /* iOS builds use the static ARM configuration. */ |
| 109 | #define OPENSSL_STATIC_ARMCAP |
| 110 | #endif |
| 111 | |
| 112 | #if !defined(OPENSSL_STATIC_ARMCAP) |
| 113 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 114 | /* CRYPTO_is_NEON_capable_at_runtime returns true if the current CPU has a NEON |
| 115 | * unit. Note that |OPENSSL_armcap_P| also exists and contains the same |
| 116 | * information in a form that's easier for assembly to use. */ |
| 117 | OPENSSL_EXPORT char CRYPTO_is_NEON_capable_at_runtime(void); |
| 118 | |
| 119 | /* CRYPTO_is_NEON_capable returns true if the current CPU has a NEON unit. If |
| 120 | * this is known statically then it returns one immediately. */ |
| 121 | static inline int CRYPTO_is_NEON_capable(void) { |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 122 | /* Only statically skip the runtime lookup on aarch64. On arm, one CPU is |
| 123 | * known to have a broken NEON unit which is known to fail with on some |
| 124 | * hand-written NEON assembly. For now, continue to apply the workaround even |
| 125 | * when the compiler is instructed to freely emit NEON code. See |
| 126 | * https://crbug.com/341598 and https://crbug.com/606629. */ |
| 127 | #if defined(__ARM_NEON__) && !defined(OPENSSL_ARM) |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 128 | return 1; |
| 129 | #else |
| 130 | return CRYPTO_is_NEON_capable_at_runtime(); |
| 131 | #endif |
| 132 | } |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 133 | |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 134 | #if defined(OPENSSL_ARM) |
| 135 | /* CRYPTO_has_broken_NEON returns one if the current CPU is known to have a |
| 136 | * broken NEON unit. See https://crbug.com/341598. */ |
| 137 | OPENSSL_EXPORT int CRYPTO_has_broken_NEON(void); |
| 138 | #endif |
Kenny Root | e99801b | 2015-11-06 15:31:15 -0800 | [diff] [blame] | 139 | |
| 140 | /* CRYPTO_is_ARMv8_AES_capable returns true if the current CPU supports the |
| 141 | * ARMv8 AES instruction. */ |
| 142 | int CRYPTO_is_ARMv8_AES_capable(void); |
| 143 | |
| 144 | /* CRYPTO_is_ARMv8_PMULL_capable returns true if the current CPU supports the |
| 145 | * ARMv8 PMULL instruction. */ |
| 146 | int CRYPTO_is_ARMv8_PMULL_capable(void); |
| 147 | |
| 148 | #else |
| 149 | |
| 150 | static inline int CRYPTO_is_NEON_capable(void) { |
| 151 | #if defined(OPENSSL_STATIC_ARMCAP_NEON) || defined(__ARM_NEON__) |
| 152 | return 1; |
| 153 | #else |
| 154 | return 0; |
| 155 | #endif |
| 156 | } |
| 157 | |
Kenny Root | e99801b | 2015-11-06 15:31:15 -0800 | [diff] [blame] | 158 | static inline int CRYPTO_is_ARMv8_AES_capable(void) { |
| 159 | #if defined(OPENSSL_STATIC_ARMCAP_AES) |
| 160 | return 1; |
| 161 | #else |
| 162 | return 0; |
| 163 | #endif |
| 164 | } |
| 165 | |
| 166 | static inline int CRYPTO_is_ARMv8_PMULL_capable(void) { |
| 167 | #if defined(OPENSSL_STATIC_ARMCAP_PMULL) |
| 168 | return 1; |
| 169 | #else |
| 170 | return 0; |
| 171 | #endif |
| 172 | } |
| 173 | |
| 174 | #endif /* OPENSSL_STATIC_ARMCAP */ |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 175 | #endif /* OPENSSL_ARM || OPENSSL_AARCH64 */ |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 176 | |
Steven Valdez | bb1ceac | 2016-10-07 10:34:51 -0400 | [diff] [blame] | 177 | #if defined(OPENSSL_PPC64LE) |
| 178 | |
| 179 | /* CRYPTO_is_PPC64LE_vcrypto_capable returns true iff the current CPU supports |
| 180 | * the Vector.AES category of instructions. */ |
| 181 | int CRYPTO_is_PPC64LE_vcrypto_capable(void); |
| 182 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 183 | extern unsigned long OPENSSL_ppc64le_hwcap2; |
| 184 | |
Steven Valdez | bb1ceac | 2016-10-07 10:34:51 -0400 | [diff] [blame] | 185 | #endif /* OPENSSL_PPC64LE */ |
| 186 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 187 | |
| 188 | #if defined(__cplusplus) |
| 189 | } /* extern C */ |
| 190 | #endif |
| 191 | |
| 192 | #endif /* OPENSSL_HEADER_CPU_H */ |