xref: /xnu-10002.1.13/osfmk/corecrypto/cc_runtime_config.h (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a) !
1*1031c584SApple OSS Distributions /* Copyright (c) (2012,2014,2015,2016,2017,2018,2019,2020) Apple Inc. All rights reserved.
2*1031c584SApple OSS Distributions  *
3*1031c584SApple OSS Distributions  * corecrypto is licensed under Apple Inc.’s Internal Use License Agreement (which
4*1031c584SApple OSS Distributions  * is contained in the License.txt file distributed with corecrypto) and only to
5*1031c584SApple OSS Distributions  * people who accept that license. IMPORTANT:  Any license rights granted to you by
6*1031c584SApple OSS Distributions  * Apple Inc. (if any) are limited to internal use within your organization only on
7*1031c584SApple OSS Distributions  * devices and computers you own or control, for the sole purpose of verifying the
8*1031c584SApple OSS Distributions  * security characteristics and correct functioning of the Apple Software.  You may
9*1031c584SApple OSS Distributions  * not, directly or indirectly, redistribute the Apple Software or any portions thereof.
10*1031c584SApple OSS Distributions  *
11*1031c584SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
12*1031c584SApple OSS Distributions  *
13*1031c584SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
14*1031c584SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
15*1031c584SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
16*1031c584SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
17*1031c584SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
18*1031c584SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
19*1031c584SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
20*1031c584SApple OSS Distributions  * terms of an Apple operating system software license agreement.
21*1031c584SApple OSS Distributions  *
22*1031c584SApple OSS Distributions  * Please obtain a copy of the License at
23*1031c584SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
24*1031c584SApple OSS Distributions  *
25*1031c584SApple OSS Distributions  * The Original Code and all software distributed under the License are
26*1031c584SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
27*1031c584SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
28*1031c584SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
29*1031c584SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
30*1031c584SApple OSS Distributions  * Please see the License for the specific language governing rights and
31*1031c584SApple OSS Distributions  * limitations under the License.
32*1031c584SApple OSS Distributions  *
33*1031c584SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
34*1031c584SApple OSS Distributions  */
35*1031c584SApple OSS Distributions 
36*1031c584SApple OSS Distributions #ifndef CORECRYPTO_CC_RUNTIME_CONFIG_H_
37*1031c584SApple OSS Distributions #define CORECRYPTO_CC_RUNTIME_CONFIG_H_
38*1031c584SApple OSS Distributions 
39*1031c584SApple OSS Distributions #include <corecrypto/cc_config.h>
40*1031c584SApple OSS Distributions 
41*1031c584SApple OSS Distributions #if defined(__x86_64__) || defined(__i386__)
42*1031c584SApple OSS Distributions 
43*1031c584SApple OSS Distributions #if CC_KERNEL
44*1031c584SApple OSS Distributions     #include <i386/cpuid.h>
45*1031c584SApple OSS Distributions     #define CC_HAS_RDRAND() ((cpuid_features() & CPUID_FEATURE_RDRAND) != 0)
46*1031c584SApple OSS Distributions     #define CC_HAS_AESNI() ((cpuid_features() & CPUID_FEATURE_AES) != 0)
47*1031c584SApple OSS Distributions     #define CC_HAS_SupplementalSSE3() ((cpuid_features() & CPUID_FEATURE_SSSE3) != 0)
48*1031c584SApple OSS Distributions     #define CC_HAS_AVX1() ((cpuid_features() & CPUID_FEATURE_AVX1_0) != 0)
49*1031c584SApple OSS Distributions     #define CC_HAS_AVX2() ((cpuid_info()->cpuid_leaf7_features & CPUID_LEAF7_FEATURE_AVX2) != 0)
50*1031c584SApple OSS Distributions     #define CC_HAS_AVX512_AND_IN_KERNEL()    ((cpuid_info()->cpuid_leaf7_features & CPUID_LEAF7_FEATURE_AVX512F) !=0)
51*1031c584SApple OSS Distributions     #define CC_HAS_BMI2() ((cpuid_info()->cpuid_leaf7_features & CPUID_LEAF7_FEATURE_BMI2) != 0)
52*1031c584SApple OSS Distributions     #define CC_HAS_ADX() ((cpuid_info()->cpuid_leaf7_features & CPUID_LEAF7_FEATURE_ADX) != 0)
53*1031c584SApple OSS Distributions 
54*1031c584SApple OSS Distributions #elif CC_DARWIN && CC_INTERNAL_SDK
55*1031c584SApple OSS Distributions     #include <System/i386/cpu_capabilities.h>
56*1031c584SApple OSS Distributions     #define CC_HAS_RDRAND() (_get_cpu_capabilities() & kHasRDRAND)
57*1031c584SApple OSS Distributions     #define CC_HAS_AESNI() (_get_cpu_capabilities() & kHasAES)
58*1031c584SApple OSS Distributions     #define CC_HAS_SupplementalSSE3() (_get_cpu_capabilities() & kHasSupplementalSSE3)
59*1031c584SApple OSS Distributions     #define CC_HAS_AVX1() (_get_cpu_capabilities() & kHasAVX1_0)
60*1031c584SApple OSS Distributions     #define CC_HAS_AVX2() (_get_cpu_capabilities() & kHasAVX2_0)
61*1031c584SApple OSS Distributions     #define CC_HAS_AVX512_AND_IN_KERNEL() 0
62*1031c584SApple OSS Distributions     #define CC_HAS_BMI2() (_get_cpu_capabilities() & kHasBMI2)
63*1031c584SApple OSS Distributions     #define CC_HAS_ADX() (_get_cpu_capabilities() & kHasADX)
64*1031c584SApple OSS Distributions 
65*1031c584SApple OSS Distributions #elif CC_SGX
66*1031c584SApple OSS Distributions     #include <cpuid.h>
67*1031c584SApple OSS Distributions     #include <stdbool.h>
68*1031c584SApple OSS Distributions     #include <stdint.h>
69*1031c584SApple OSS Distributions 
70*1031c584SApple OSS Distributions     #define CPUID_REG_RAX 0
71*1031c584SApple OSS Distributions     #define CPUID_REG_RBX 1
72*1031c584SApple OSS Distributions     #define CPUID_REG_RCX 2
73*1031c584SApple OSS Distributions     #define CPUID_REG_RDX 3
74*1031c584SApple OSS Distributions 
75*1031c584SApple OSS Distributions     #define CPUID_FEATURE_AES 25
76*1031c584SApple OSS Distributions     #define CPUID_FEATURE_SSE3 0
77*1031c584SApple OSS Distributions     #define CPUID_FEATURE_AVX1 28
78*1031c584SApple OSS Distributions     #define CPUID_FEATURE_LEAF7_AVX2 5
79*1031c584SApple OSS Distributions     #define CPUID_FEATURE_LEAF7_BMI2 8
80*1031c584SApple OSS Distributions     #define CPUID_FEATURE_RDRAND 30
81*1031c584SApple OSS Distributions     #define CPUID_FEATURE_LEAF7_ADX 19
82*1031c584SApple OSS Distributions 
83*1031c584SApple OSS Distributions CC_INLINE bool
_cpu_supports(uint64_t leaf,uint64_t subleaf,uint8_t cpuid_register,uint8_t bit)84*1031c584SApple OSS Distributions _cpu_supports(uint64_t leaf, uint64_t subleaf, uint8_t cpuid_register, uint8_t bit)
85*1031c584SApple OSS Distributions {
86*1031c584SApple OSS Distributions 	uint64_t registers[4] = {0};
87*1031c584SApple OSS Distributions 	registers[CPUID_REG_RAX] = leaf;
88*1031c584SApple OSS Distributions 	registers[CPUID_REG_RCX] = subleaf;
89*1031c584SApple OSS Distributions 	if (oe_emulate_cpuid(&registers[CPUID_REG_RAX], &registers[CPUID_REG_RBX], &registers[CPUID_REG_RCX], &registers[CPUID_REG_RDX])) {
90*1031c584SApple OSS Distributions 		return false;
91*1031c584SApple OSS Distributions 	}
92*1031c584SApple OSS Distributions 	return (registers[cpuid_register] >> bit) & 1;
93*1031c584SApple OSS Distributions }
94*1031c584SApple OSS Distributions 
95*1031c584SApple OSS Distributions 
96*1031c584SApple OSS Distributions     #define CC_HAS_AESNI() _cpu_supports(1, 0, CPUID_REG_RCX, CPUID_FEATURE_AES)
97*1031c584SApple OSS Distributions     #define CC_HAS_SupplementalSSE3() _cpu_supports(1, 0, CPUID_REG_RCX, CPUID_FEATURE_SSE3)
98*1031c584SApple OSS Distributions     #define CC_HAS_AVX1() _cpu_supports(1, 0, CPUID_REG_RCX, CPUID_FEATURE_AVX1)
99*1031c584SApple OSS Distributions     #define CC_HAS_AVX2() _cpu_supports(7, 0, CPUID_REG_RBX, CPUID_FEATURE_LEAF7_AVX2)
100*1031c584SApple OSS Distributions     #define CC_HAS_AVX512_AND_IN_KERNEL() 0
101*1031c584SApple OSS Distributions     #define CC_HAS_BMI2() _cpu_supports(7, 0, CPUID_REG_RBX, CPUID_FEATURE_LEAF7_BMI2)
102*1031c584SApple OSS Distributions     #define CC_HAS_RDRAND() _cpu_supports(1, 0, CPUID_REG_RCX, CPUID_FEATURE_RDRAND)
103*1031c584SApple OSS Distributions     #define CC_HAS_ADX() _cpu_supports(7, 0, CPUID_REG_RBX, CPUID_FEATURE_LEAF7_ADX)
104*1031c584SApple OSS Distributions #else
105*1031c584SApple OSS Distributions     #define CC_HAS_AESNI() __builtin_cpu_supports("aes")
106*1031c584SApple OSS Distributions     #define CC_HAS_SupplementalSSE3() __builtin_cpu_supports("ssse3")
107*1031c584SApple OSS Distributions     #define CC_HAS_AVX1() __builtin_cpu_supports("avx")
108*1031c584SApple OSS Distributions     #define CC_HAS_AVX2() __builtin_cpu_supports("avx2")
109*1031c584SApple OSS Distributions     #define CC_HAS_AVX512_AND_IN_KERNEL() 0
110*1031c584SApple OSS Distributions     #define CC_HAS_BMI2() __builtin_cpu_supports("bmi2")
111*1031c584SApple OSS Distributions #if CC_LINUX || !CC_INTERNAL_SDK
112*1031c584SApple OSS Distributions     #include <cpuid.h>
113*1031c584SApple OSS Distributions     #include <stdbool.h>
114*1031c584SApple OSS Distributions 
115*1031c584SApple OSS Distributions CC_INLINE bool
_cpu_supports_rdrand()116*1031c584SApple OSS Distributions _cpu_supports_rdrand()
117*1031c584SApple OSS Distributions {
118*1031c584SApple OSS Distributions 	unsigned int eax, ebx, ecx, edx;
119*1031c584SApple OSS Distributions 	__cpuid(1, eax, ebx, ecx, edx);
120*1031c584SApple OSS Distributions 	return ecx & bit_RDRND;
121*1031c584SApple OSS Distributions }
122*1031c584SApple OSS Distributions 
123*1031c584SApple OSS Distributions CC_INLINE bool
_cpu_supports_adx()124*1031c584SApple OSS Distributions _cpu_supports_adx()
125*1031c584SApple OSS Distributions {
126*1031c584SApple OSS Distributions 	unsigned int eax, ebx, ecx, edx;
127*1031c584SApple OSS Distributions 	__cpuid_count(7, 0, eax, ebx, ecx, edx);
128*1031c584SApple OSS Distributions 	return ebx & bit_ADX;
129*1031c584SApple OSS Distributions }
130*1031c584SApple OSS Distributions 
131*1031c584SApple OSS Distributions     #define CC_HAS_RDRAND() _cpu_supports_rdrand()
132*1031c584SApple OSS Distributions     #define CC_HAS_ADX() _cpu_supports_adx()
133*1031c584SApple OSS Distributions #else
134*1031c584SApple OSS Distributions     #define CC_HAS_RDRAND() 0
135*1031c584SApple OSS Distributions     #define CC_HAS_ADX() 0
136*1031c584SApple OSS Distributions #endif
137*1031c584SApple OSS Distributions 
138*1031c584SApple OSS Distributions #endif
139*1031c584SApple OSS Distributions 
140*1031c584SApple OSS Distributions #endif  // defined(__x86_64__) || defined(__i386__)
141*1031c584SApple OSS Distributions 
142*1031c584SApple OSS Distributions #if defined(__arm64__)
143*1031c584SApple OSS Distributions 
144*1031c584SApple OSS Distributions #if CC_DARWIN && CC_INTERNAL_SDK
145*1031c584SApple OSS Distributions     #include <System/arm/cpu_capabilities.h>
146*1031c584SApple OSS Distributions     #define CC_HAS_SHA512() (_get_cpu_capabilities() & kHasARMv82SHA512)
147*1031c584SApple OSS Distributions     #define CC_HAS_SHA3() (_get_cpu_capabilities() & kHasARMv82SHA3)
148*1031c584SApple OSS Distributions #else
149*1031c584SApple OSS Distributions     #define CC_HAS_SHA512() (0)
150*1031c584SApple OSS Distributions     #define CC_HAS_SHA3() (0)
151*1031c584SApple OSS Distributions #endif
152*1031c584SApple OSS Distributions 
153*1031c584SApple OSS Distributions #endif // defined(__arm64__)
154*1031c584SApple OSS Distributions 
155*1031c584SApple OSS Distributions #endif /* CORECRYPTO_CC_RUNTIME_CONFIG_H_ */
156