8#include <botan/internal/cpuid.h>
10#include <botan/compiler.h>
11#include <botan/mem_ops.h>
12#include <botan/internal/target_info.h>
16#if defined(BOTAN_BUILD_COMPILER_IS_MSVC)
24void invoke_cpuid(uint32_t type, uint32_t out[4]) {
27#if defined(BOTAN_USE_GCC_INLINE_ASM)
29 asm volatile(
"cpuid\n\t" :
"=a"(out[0]),
"=b"(out[1]),
"=c"(out[2]),
"=d"(out[3]) :
"0"(type));
31#elif defined(BOTAN_BUILD_COMPILER_IS_MSVC)
32 __cpuid((
int*)out, type);
36 #warning "No way of calling x86 cpuid instruction for this compiler"
40void invoke_cpuid_sublevel(uint32_t type, uint32_t level, uint32_t out[4]) {
43#if defined(BOTAN_USE_GCC_INLINE_ASM)
45 asm volatile(
"cpuid\n\t" :
"=a"(out[0]),
"=b"(out[1]),
"=c"(out[2]),
"=d"(out[3]) :
"0"(type),
"2"(level));
47#elif defined(BOTAN_BUILD_COMPILER_IS_MSVC)
48 __cpuidex((
int*)out, type, level);
52 #warning "No way of calling x86 cpuid instruction for this compiler"
62uint32_t CPUID::CPUID_Data::detect_cpu_features(uint32_t allowed) {
63 enum class x86_CPUID_1_bits : uint64_t {
69 POPCNT = (1ULL << 55),
72 OSXSAVE = (1ULL << 59) | (1ULL << 60),
76 enum class x86_CPUID_7_bits : uint64_t {
80 BMI_1_AND_2 = BMI1 | BMI2,
81 AVX512_F = (1ULL << 16),
82 AVX512_DQ = (1ULL << 17),
83 RDSEED = (1ULL << 18),
85 AVX512_IFMA = (1ULL << 21),
87 AVX512_BW = (1ULL << 30),
88 AVX512_VL = (1ULL << 31),
89 AVX512_VBMI = (1ULL << 33),
90 AVX512_VBMI2 = (1ULL << 38),
92 AVX512_VAES = (1ULL << 41),
93 AVX512_VCLMUL = (1ULL << 42),
94 AVX512_VBITALG = (1ULL << 44),
113 AVX512_F | AVX512_DQ | AVX512_IFMA | AVX512_BW | AVX512_VL | AVX512_VBMI | AVX512_VBMI2 | AVX512_VBITALG,
117 enum class x86_CPUID_7_1_bits : uint64_t {
124 uint32_t cpuid[4] = {0};
125 bool has_sse41 =
false;
126 bool has_os_ymm_support =
false;
127 bool has_os_zmm_support =
false;
130 invoke_cpuid(0, cpuid);
132 const uint32_t max_supported_sublevel = cpuid[0];
134 if(max_supported_sublevel >= 1) {
136 invoke_cpuid(1, cpuid);
137 const uint64_t flags0 = (
static_cast<uint64_t
>(cpuid[2]) << 32) | cpuid[3];
139 feat |=
if_set(flags0, x86_CPUID_1_bits::RDTSC, CPUFeature::Bit::RDTSC, allowed);
141 feat |=
if_set(flags0, x86_CPUID_1_bits::RDRAND, CPUFeature::Bit::RDRAND, allowed);
143 feat |=
if_set(flags0, x86_CPUID_1_bits::POPCNT, CPUFeature::Bit::POPCNT, allowed);
145 feat |=
if_set(flags0, x86_CPUID_1_bits::SSE2, CPUFeature::Bit::SSE2, allowed);
147 if(is_set(feat, CPUFeature::Bit::SSE2)) {
148 feat |=
if_set(flags0, x86_CPUID_1_bits::SSSE3, CPUFeature::Bit::SSSE3, allowed);
150 if(is_set(feat, CPUFeature::Bit::SSSE3)) {
151 feat |=
if_set(flags0, x86_CPUID_1_bits::CLMUL, CPUFeature::Bit::CLMUL, allowed);
152 feat |=
if_set(flags0, x86_CPUID_1_bits::AESNI, CPUFeature::Bit::AESNI, allowed);
155 const uint64_t sse41 =
static_cast<uint64_t
>(x86_CPUID_1_bits::SSE41);
156 has_sse41 = (flags0 & sse41) == sse41;
159 const uint64_t osxsave64 =
static_cast<uint64_t
>(x86_CPUID_1_bits::OSXSAVE);
160 if((flags0 & osxsave64) == osxsave64) {
161 const uint64_t xcr_flags = xgetbv();
162 if((xcr_flags & 0x6) == 0x6) {
163 has_os_ymm_support =
true;
164 has_os_zmm_support = (xcr_flags & 0xE0) == 0xE0;
170 if(max_supported_sublevel >= 7) {
172 invoke_cpuid_sublevel(7, 0, cpuid);
174 const uint64_t flags7 = (
static_cast<uint64_t
>(cpuid[2]) << 32) | cpuid[1];
177 invoke_cpuid_sublevel(7, 1, cpuid);
178 const uint32_t flags7_1 = cpuid[0];
180 feat |=
if_set(flags7, x86_CPUID_7_bits::RDSEED, CPUFeature::Bit::RDSEED, allowed);
181 feat |=
if_set(flags7, x86_CPUID_7_bits::ADX, CPUFeature::Bit::ADX, allowed);
187 feat |=
if_set(flags7, x86_CPUID_7_bits::BMI_1_AND_2, CPUFeature::Bit::BMI, allowed);
189 if(is_set(feat, CPUFeature::Bit::SSSE3)) {
192 feat |=
if_set(flags7, x86_CPUID_7_bits::SHA, CPUFeature::Bit::SHA, allowed);
196 if(has_os_ymm_support) {
197 feat |=
if_set(flags7, x86_CPUID_7_bits::AVX2, CPUFeature::Bit::AVX2, allowed);
199 if(is_set(feat, CPUFeature::Bit::AVX2)) {
200 feat |=
if_set(flags7, x86_CPUID_7_bits::GFNI, CPUFeature::Bit::GFNI, allowed);
201 if(is_set(feat, CPUFeature::Bit::AESNI)) {
202 feat |=
if_set(flags7, x86_CPUID_7_bits::AVX512_VAES, CPUFeature::Bit::AVX2_AES, allowed);
204 feat |=
if_set(flags7_1, x86_CPUID_7_1_bits::SHA512, CPUFeature::Bit::SHA512, allowed);
206 feat |=
if_set(flags7_1, x86_CPUID_7_1_bits::SM3, CPUFeature::Bit::SM3, allowed);
207 feat |=
if_set(flags7_1, x86_CPUID_7_1_bits::SM4, CPUFeature::Bit::SM4, allowed);
210 if(is_set(feat, CPUFeature::Bit::CLMUL)) {
211 feat |=
if_set(flags7, x86_CPUID_7_bits::AVX512_VCLMUL, CPUFeature::Bit::AVX2_CLMUL, allowed);
215 if(has_os_zmm_support) {
216 feat |=
if_set(flags7, x86_CPUID_7_bits::AVX512_PROFILE, CPUFeature::Bit::AVX512, allowed);
218 if(is_set(feat, CPUFeature::Bit::AVX512)) {
219 if(is_set(feat, CPUFeature::Bit::AESNI)) {
220 feat |=
if_set(flags7, x86_CPUID_7_bits::AVX512_VAES, CPUFeature::Bit::AVX512_AES, allowed);
222 if(is_set(feat, CPUFeature::Bit::CLMUL)) {
223 feat |=
if_set(flags7, x86_CPUID_7_bits::AVX512_VCLMUL, CPUFeature::Bit::AVX512_CLMUL, allowed);
236#if defined(BOTAN_TARGET_ARCH_IS_X86_64)
238 feat |= CPUFeature::Bit::SSE2 & allowed;
239 feat |= CPUFeature::Bit::RDTSC & allowed;
static uint32_t if_set(uint64_t cpuid, T flag, CPUID::Feature bit, uint32_t allowed)
#define BOTAN_FUNC_ISA(isa)
constexpr void clear_mem(T *ptr, size_t n)