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 <GFp/base.h>
65 
66 // Runtime CPU feature support
67 
68 
69 #if defined(OPENSSL_X86) || defined(OPENSSL_X86_64)
70 // GFp_ia32cap_P contains the Intel CPUID bits when running on an x86 or
71 // x86-64 system.
72 //
73 //   Index 0:
74 //     EDX for CPUID where EAX = 1
75 //     Bit 20 is always zero
76 //     Bit 28 is adjusted to reflect whether the data cache is shared between
77 //       multiple logical cores
78 //     Bit 30 is used to indicate an Intel CPU
79 //   Index 1:
80 //     ECX for CPUID where EAX = 1
81 //     Bit 11 is used to indicate AMD XOP support, not SDBG
82 //   Index 2:
83 //     EBX for CPUID where EAX = 7
84 //   Index 3:
85 //     ECX for CPUID where EAX = 7
86 //
87 // Note: the CPUID bits are pre-adjusted for the OSXSAVE bit and the YMM and XMM
88 // bits in XCR0, so it is not necessary to check those.
89 extern uint32_t GFp_ia32cap_P[4];
90 #endif
91 
92 #if defined(OPENSSL_ARM) || defined(OPENSSL_AARCH64)
93 
94 #if defined(OPENSSL_APPLE)
95 // iOS builds use the static ARM configuration.
96 #define OPENSSL_STATIC_ARMCAP
97 #endif
98 
99 #if !defined(OPENSSL_STATIC_ARMCAP)
100 
101 // GFp_is_NEON_capable_at_runtime returns true if the current CPU has a NEON
102 // unit. Note that |OPENSSL_armcap_P| also exists and contains the same
103 // information in a form that's easier for assembly to use.
104 OPENSSL_EXPORT uint8_t GFp_is_NEON_capable_at_runtime(void);
105 
106 // GFp_is_NEON_capable returns true if the current CPU has a NEON unit. If
107 // this is known statically then it returns one immediately.
GFp_is_NEON_capable(void)108 static inline int GFp_is_NEON_capable(void) {
109   // On 32-bit ARM, one CPU is known to have a broken NEON unit which is known
110   // to fail with on some hand-written NEON assembly. Assume that non-Android
111   // applications will not use that buggy CPU but still support Android users
112   // that do, even when the compiler is instructed to freely emit NEON code.
113   // See https://crbug.com/341598 and https://crbug.com/606629.
114 #if (defined(__ARM_NEON__) || defined(__ARM_NEON)) \
115     && (!defined(OPENSSL_ARM) || !defined(__ANDROID__))
116   return 1;
117 #else
118   return GFp_is_NEON_capable_at_runtime();
119 #endif
120 }
121 
122 // GFp_is_ARMv8_AES_capable returns true if the current CPU supports the
123 // ARMv8 AES instruction.
124 int GFp_is_ARMv8_AES_capable(void);
125 
126 #else
127 
GFp_is_NEON_capable(void)128 static inline int GFp_is_NEON_capable(void) {
129 #if defined(OPENSSL_STATIC_ARMCAP_NEON) || \
130     (defined(__ARM_NEON__) || defined(__ARM_NEON))
131   return 1;
132 #else
133   return 0;
134 #endif
135 }
136 
GFp_is_ARMv8_AES_capable(void)137 static inline int GFp_is_ARMv8_AES_capable(void) {
138 #if defined(OPENSSL_STATIC_ARMCAP_AES) || defined(__ARM_FEATURE_CRYPTO)
139   return 1;
140 #else
141   return 0;
142 #endif
143 }
144 
145 #endif  // OPENSSL_STATIC_ARMCAP
146 #endif  // OPENSSL_ARM || OPENSSL_AARCH64
147 
148 #if defined(OPENSSL_PPC64LE)
149 
150 // GFp_is_PPC64LE_vcrypto_capable returns true iff the current CPU supports
151 // the Vector.AES category of instructions.
152 int GFp_is_PPC64LE_vcrypto_capable(void);
153 
154 #endif  // OPENSSL_PPC64LE
155 
156 #endif  // OPENSSL_HEADER_CPU_H
157