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
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 is set to zero.
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];
94 #endif
95
96 #if defined(OPENSSL_ARM) || defined(OPENSSL_AARCH64)
97
98 #if defined(OPENSSL_APPLE)
99 /* iOS builds use the static ARM configuration. */
100 #define OPENSSL_STATIC_ARMCAP
101 #endif
102
103 #if !defined(OPENSSL_STATIC_ARMCAP)
104
105 /* CRYPTO_is_NEON_capable_at_runtime returns true if the current CPU has a NEON
106 * unit. Note that |OPENSSL_armcap_P| also exists and contains the same
107 * information in a form that's easier for assembly to use. */
108 OPENSSL_EXPORT char CRYPTO_is_NEON_capable_at_runtime(void);
109
110 /* CRYPTO_is_NEON_capable returns true if the current CPU has a NEON unit. If
111 * this is known statically then it returns one immediately. */
CRYPTO_is_NEON_capable(void)112 static inline int CRYPTO_is_NEON_capable(void) {
113 /* Only statically skip the runtime lookup on aarch64. On arm, one CPU is
114 * known to have a broken NEON unit which is known to fail with on some
115 * hand-written NEON assembly. For now, continue to apply the workaround even
116 * when the compiler is instructed to freely emit NEON code. See
117 * https://crbug.com/341598 and https://crbug.com/606629. */
118 #if defined(__ARM_NEON__) && !defined(OPENSSL_ARM)
119 return 1;
120 #else
121 return CRYPTO_is_NEON_capable_at_runtime();
122 #endif
123 }
124
125 #if defined(OPENSSL_ARM)
126 /* CRYPTO_has_broken_NEON returns one if the current CPU is known to have a
127 * broken NEON unit. See https://crbug.com/341598. */
128 OPENSSL_EXPORT int CRYPTO_has_broken_NEON(void);
129 #endif
130
131 /* CRYPTO_is_ARMv8_AES_capable returns true if the current CPU supports the
132 * ARMv8 AES instruction. */
133 int CRYPTO_is_ARMv8_AES_capable(void);
134
135 /* CRYPTO_is_ARMv8_PMULL_capable returns true if the current CPU supports the
136 * ARMv8 PMULL instruction. */
137 int CRYPTO_is_ARMv8_PMULL_capable(void);
138
139 #else
140
CRYPTO_is_NEON_capable(void)141 static inline int CRYPTO_is_NEON_capable(void) {
142 #if defined(OPENSSL_STATIC_ARMCAP_NEON) || defined(__ARM_NEON__)
143 return 1;
144 #else
145 return 0;
146 #endif
147 }
148
CRYPTO_is_ARMv8_AES_capable(void)149 static inline int CRYPTO_is_ARMv8_AES_capable(void) {
150 #if defined(OPENSSL_STATIC_ARMCAP_AES)
151 return 1;
152 #else
153 return 0;
154 #endif
155 }
156
CRYPTO_is_ARMv8_PMULL_capable(void)157 static inline int CRYPTO_is_ARMv8_PMULL_capable(void) {
158 #if defined(OPENSSL_STATIC_ARMCAP_PMULL)
159 return 1;
160 #else
161 return 0;
162 #endif
163 }
164
165 #endif /* OPENSSL_STATIC_ARMCAP */
166 #endif /* OPENSSL_ARM || OPENSSL_AARCH64 */
167
168 #if defined(OPENSSL_PPC64LE)
169
170 /* CRYPTO_is_PPC64LE_vcrypto_capable returns true iff the current CPU supports
171 * the Vector.AES category of instructions. */
172 int CRYPTO_is_PPC64LE_vcrypto_capable(void);
173
174 #endif /* OPENSSL_PPC64LE */
175
176
177 #if defined(__cplusplus)
178 } /* extern C */
179 #endif
180
181 #endif /* OPENSSL_HEADER_CPU_H */
182