1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
mod sys;
pub use sys::Version;
pub(crate) use sys::{SysFeatures, SystemFeatures};
pub fn check_for(fid: Feature) -> bool {
let bit = fid.into_bit();
(bit & SysFeatures::get().cpu_features()) != 0
}
#[macro_export]
macro_rules! is_x86_feature_detected {
("ia32") => {
$crate::feature::check_for($crate::feature::Feature::ia32)
};
("fpu") => {
$crate::feature::check_for($crate::feature::Feature::fpu)
};
("cmov") => {
$crate::feature::check_for($crate::feature::Feature::cmov)
};
("mmx") => {
$crate::feature::check_for($crate::feature::Feature::mmx)
};
("fxsave") => {
$crate::feature::check_for($crate::feature::Feature::fxsave)
};
("sse") => {
$crate::feature::check_for($crate::feature::Feature::sse)
};
("sse2") => {
$crate::feature::check_for($crate::feature::Feature::sse2)
};
("sse3") => {
$crate::feature::check_for($crate::feature::Feature::sse3)
};
("ssse3") => {
$crate::feature::check_for($crate::feature::Feature::ssse3)
};
("sse4.1") => {
$crate::feature::check_for($crate::feature::Feature::sse4_1)
};
("sse4.2") => {
$crate::feature::check_for($crate::feature::Feature::sse4_2)
};
("movbe") => {
$crate::feature::check_for($crate::feature::Feature::movbe)
};
("popcnt") => {
$crate::feature::check_for($crate::feature::Feature::popcnt)
};
("pclmulqdq") => {
$crate::feature::check_for($crate::feature::Feature::pclmulqdq)
};
("aes") => {
$crate::feature::check_for($crate::feature::Feature::aes)
};
("f16c") => {
$crate::feature::check_for($crate::feature::Feature::f16c)
};
("avx") => {
$crate::feature::check_for($crate::feature::Feature::avx)
};
("rdrand") => {
$crate::feature::check_for($crate::feature::Feature::rdrand)
};
("fma") => {
$crate::feature::check_for($crate::feature::Feature::fma)
};
("bmi") => {
$crate::feature::check_for($crate::feature::Feature::bmi)
};
("lzcnt") => {
$crate::feature::check_for($crate::feature::Feature::lzcnt)
};
("hle") => {
$crate::feature::check_for($crate::feature::Feature::hle)
};
("rtm") => {
$crate::feature::check_for($crate::feature::Feature::rtm)
};
("avx2") => {
$crate::feature::check_for($crate::feature::Feature::avx2)
};
("avx512dq") => {
$crate::feature::check_for($crate::feature::Feature::avx512dq)
};
("ptwrite") => {
$crate::feature::check_for($crate::feature::Feature::ptwrite)
};
("kncni") => {
$crate::feature::check_for($crate::feature::Feature::kncni)
};
("avx512f") => {
$crate::feature::check_for($crate::feature::Feature::avx512f)
};
("adx") => {
$crate::feature::check_for($crate::feature::Feature::adx)
};
("rdseed") => {
$crate::feature::check_for($crate::feature::Feature::rdseed)
};
("avx512ifma") => {
$crate::feature::check_for($crate::feature::Feature::avx512ifma)
};
("inorder") => {
$crate::feature::check_for($crate::feature::Feature::full_inorder)
};
("avx512er") => {
$crate::feature::check_for($crate::feature::Feature::avx512er)
};
("avx512pf") => {
$crate::feature::check_for($crate::feature::Feature::avx512pf)
};
("avx512cd") => {
$crate::feature::check_for($crate::feature::Feature::avx512cd)
};
("sha") => {
$crate::feature::check_for($crate::feature::Feature::sha)
};
("mpx") => {
$crate::feature::check_for($crate::feature::Feature::mpx)
};
("avx512bw") => {
$crate::feature::check_for($crate::feature::Feature::avx512bw)
};
("avx512vl") => {
$crate::feature::check_for($crate::feature::Feature::avx512vl)
};
("avx512vbmi") => {
$crate::feature::check_for($crate::feature::Feature::avx512vbmi)
};
("avx5124fmaps") => {
$crate::feature::check_for($crate::feature::Feature::avx512_4fmaps)
};
("avx5124vnniw") => {
$crate::feature::check_for($crate::feature::Feature::avx512_4vnniw)
};
("avx512vpopcntdq") => {
$crate::feature::check_for($crate::feature::Feature::avx512_vpopcntdq)
};
("avx512bitalg") => {
$crate::feature::check_for($crate::feature::Feature::avx512_bitalg)
};
("avx512vbmi2") => {
$crate::feature::check_for($crate::feature::Feature::avx512vbmi2)
};
("gfni") => {
$crate::feature::check_for($crate::feature::Feature::gfni)
};
("vaes") => {
$crate::feature::check_for($crate::feature::Feature::vaes)
};
("vpclmulqdq") => {
$crate::feature::check_for($crate::feature::Feature::vpclmulqdq)
};
("avx512vnni") => {
$crate::feature::check_for($crate::feature::Feature::avx512vnni)
};
("clwb") => {
$crate::feature::check_for($crate::feature::Feature::clwb)
};
("rdpid") => {
$crate::feature::check_for($crate::feature::Feature::rdpid)
};
("ibt") => {
$crate::feature::check_for($crate::feature::Feature::ibt)
};
("shstk") => {
$crate::feature::check_for($crate::feature::Feature::shstk)
};
("sgx") => {
$crate::feature::check_for($crate::feature::Feature::sgx)
};
("wbnoinvd") => {
$crate::feature::check_for($crate::feature::Feature::wbnoinvd)
};
("pconfig") => {
$crate::feature::check_for($crate::feature::Feature::pconfig)
};
($t:tt,) => {
is_x86_feature_detected!($t);
};
($t:tt) => {
compile_error!(concat!("unknown cpu feature: ", $t))
};
}
impl_enum! {
#[repr(u32)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Feature {
none = 0,
ia32 = 1, /* 0x00000001 */
fpu = 2, /* 0x00000002 */
cmov = 3, /* 0x00000004 */
mmx = 4, /* 0x00000008 */
fxsave = 5, /* 0x00000010 */
sse = 6, /* 0x00000020 */
sse2 = 7, /* 0x00000040 */
sse3 = 8, /* 0x00000080 */
ssse3 = 9, /* 0x00000100 */
sse4_1 = 10, /* 0x00000200 */
sse4_2 = 11, /* 0x00000400 */
movbe = 12, /* 0x00000800 */
popcnt = 13, /* 0x00001000 */
pclmulqdq = 14, /* 0x00002000 */
aes = 15, /* 0x00004000 */
/* 16-bit floating-point conversions instructions */
f16c = 16, /* 0x00008000 */
/* AVX instructions - SNB */
avx = 17, /* 0x00010000 */
/* RDRND (read random value) instruction */
rdrand = 18, /* 0x00020000 */
/* FMA, may need more precise name - HSW */
fma = 19, /* 0x00040000 */
/* two groups of advanced bit manipulation extensions */
bmi = 20, /* 0x00080000 */
/* LZCNT (leading zeroes count) */
lzcnt = 21, /* 0x00100000 */
/* HLE (hardware lock elision) */
hle = 22, /* 0x00200000 */
/* RTM (restricted transactional memory) */
rtm = 23, /* 0x00400000 */
/* AVX2 instructions - HSW */
avx2 = 24, /* 0x00800000 */
/* AVX512DQ - SKX 512-bit dword/qword vector instructions */
avx512dq = 25, /* 0x01000000 */
/* Unused, remained from KNF */
ptwrite = 26, /* 0x02000000 */
/* KNC new instructions */
kncni = 27, /* 0x04000000 */
/* AVX-512 foundation instructions - KNL and SKX */
avx512f = 28, /* 0x08000000 */
/* uint add with OF or CF flags (ADOX, ADCX) - BDW */
adx = 29, /* 0x10000000 */
/* Enhanced non-deterministic rand generator - BDW */
rdseed = 30, /* 0x20000000 */
/* AVX512IFMA52: vpmadd52huq and vpmadd52luq. */
avx512ifma = 31, /* 0x40000000 */
/* Full inorder (like Silverthorne) processor */
full_inorder = 32, /* 0x80000000 */
/* AVX-512 exponential and reciprocal instructions - KNL */
avx512er = 33, /* 0x100000000 */
/* AVX-512 gather/scatter prefetch instructions - KNL */
avx512pf = 34, /* 0x200000000 */
/* AVX-512 conflict detection instructions - KNL */
avx512cd = 35, /* 0x400000000 */
/* Secure Hash Algorithm instructions (SHA) */
sha = 36, /* 0x800000000 */
/* Memory Protection Extensions (MPX) */
mpx = 37, /* 0x1000000000 */
/* AVX512BW - SKX 512-bit byte/word vector instructions */
avx512bw = 38, /* 0x2000000000 */
/* AVX512VL - adds 128/256-bit vector support of other AVX512 instructions. */
avx512vl = 39, /* 0x4000000000 */
/* AVX512VBMI: vpermb, vpermi2b, vpermt2b and vpmultishiftqb. */
avx512vbmi = 40, /* 0x8000000000 */
/* AVX512_4FMAPS: Single Precision FMA for multivector(4 vector) operand. */
avx512_4fmaps = 41, /* 0x10000000000 */
/* AVX512_4VNNIW: Vector Neural Network Instructions for
* multivector(4 vector) operand with word elements. */
avx512_4vnniw = 42, /* 0x20000000000 */
/* AVX512_VPOPCNTDQ: 512-bit vector POPCNT. */
avx512_vpopcntdq = 43, /* 0x40000000000 */
/* AVX512_BITALG: vector bit algebra in AVX512. */
avx512_bitalg = 44, /* 0x80000000000 */
/* AVX512_VBMI2: additional byte, word, dword and qword capabilities */
avx512vbmi2 = 45, /* 0x100000000000 */
/* GFNI: Galois Field New Instructions. */
gfni = 46, /* 0x200000000000 */
/* VAES: vector AES instructions */
vaes = 47, /* 0x400000000000 */
/* VPCLMULQDQ: vector PCLMULQDQ instructions. */
vpclmulqdq = 48, /* 0x800000000000 */
/* AVX512_VNNI: vector Neural Network Instructions. */
avx512vnni = 49, /* 0x1000000000000 */
/* CLWB: Cache Line Write Back. */
clwb = 50, /* 0x2000000000000 */
/* RDPID: Read Processor ID. */
rdpid = 51, /* 0x4000000000000 */
ibt = 52, /* 0x8000000000000 */
shstk = 53,
sgx = 54,
wbnoinvd = 55,
pconfig = 56,
end = 57,
}
}
impl Feature {
pub fn into_bit(self) -> u64 {
let id: u32 = self.into();
if (id > Self::none.into()) && (id < Self::end.into()) {
1 << (id - 1)
} else {
0
}
}
}