Add std_detect::detect::features() -> impl Iterator<Item=(&'static str, bool)> API

Author: gnzlbg

crates/std_detect/src/detect/arch/aarch64.rs

@@ -78,6 +78,7 @@ macro_rules! is_aarch64_feature_detected {
 /// PLEASE: do not use this, it is an implementation detail subject to change.
 #[doc(hidden)]
 #[allow(non_camel_case_types)]
+#[derive(Copy, Clone)]
 #[repr(u8)]
 #[unstable(feature = "stdsimd_internal", issue = "0")]
 pub enum Feature {
@@ -103,4 +104,26 @@ pub enum Feature {
     rcpc,
     /// Vector Dot-Product (ASIMDDP)
     dotprod,
+
+    // Do not add variants after last:
+    _last,
+}
+
+impl Feature {
+    pub fn to_str(self) -> &'static str {
+        match self {
+            Feature::asimd => "asimd",
+            Feature::pmull => "pmull",
+            Feature::fp => "fp",
+            Feature::fp16 => "fp16",
+            Feature::sve => "sve",
+            Feature::crc => "crc",
+            Feature::crypto => "crypto",
+            Feature::lse => "lse",
+            Feature::rdm => "rdm",
+            Feature::rcpc => "rcpc",
+            Feature::dotprod => "dotprod",
+            Feature::_last => unreachable!(),
+        }
+    }
 }

crates/std_detect/src/detect/arch/arm.rs

@@ -29,11 +29,25 @@ macro_rules! is_arm_feature_detected {
 /// PLEASE: do not use this, it is an implementation detail subject to change.
 #[doc(hidden)]
 #[allow(non_camel_case_types)]
+#[derive(Copy, Clone)]
 #[repr(u8)]
 #[unstable(feature = "stdsimd_internal", issue = "0")]
 pub enum Feature {
     /// ARM Advanced SIMD (NEON) - Aarch32
     neon,
     /// Polynomial Multiply
     pmull,
+
+    // Do not add variants after last:
+    _last,
+}
+
+impl Feature {
+    pub fn to_str(self) -> &'static str {
+        match self {
+            Feature::neon => "neon",
+            Feature::pmull => "pmull",
+            Feature::_last => unreachable!(),
+        }
+    }
 }

crates/std_detect/src/detect/arch/mips.rs

@@ -21,9 +21,22 @@ macro_rules! is_mips_feature_detected {
 /// PLEASE: do not use this, it is an implementation detail subject to change.
 #[doc(hidden)]
 #[allow(non_camel_case_types)]
+#[derive(Copy, Clone)]
 #[repr(u8)]
 #[unstable(feature = "stdsimd_internal", issue = "0")]
 pub enum Feature {
     /// MIPS SIMD Architecture (MSA)
     msa,
+
+    // Do not add variants after last:
+    _last,
+}
+
+impl Feature {
+    pub fn to_str(self) -> &'static str {
+        match self {
+            Feature::msa => "msa",
+            Feature::_last => unreachable!(),
+        }
+    }
 }

crates/std_detect/src/detect/arch/mips64.rs

@@ -21,9 +21,22 @@ macro_rules! is_mips64_feature_detected {
 /// PLEASE: do not use this, it is an implementation detail subject to change.
 #[doc(hidden)]
 #[allow(non_camel_case_types)]
+#[derive(Copy, Clone)]
 #[repr(u8)]
 #[unstable(feature = "stdsimd_internal", issue = "0")]
 pub enum Feature {
     /// MIPS SIMD Architecture (MSA)
     msa,
+
+    // Do not add variants after last:
+    _last,
+}
+
+impl Feature {
+    pub fn to_str(self) -> &'static str {
+        match self {
+            Feature::msa => "msa",
+            Feature::_last => unreachable!(),
+        }
+    }
 }

crates/std_detect/src/detect/arch/powerpc.rs

@@ -30,6 +30,7 @@ macro_rules! is_powerpc_feature_detected {
 /// PLEASE: do not use this, it is an implementation detail subject to change.
 #[doc(hidden)]
 #[allow(non_camel_case_types)]
+#[derive(Copy, Clone)]
 #[repr(u8)]
 #[unstable(feature = "stdsimd_internal", issue = "0")]
 pub enum Feature {
@@ -39,4 +40,18 @@ pub enum Feature {
     vsx,
     /// Power8
     power8,
+
+    // Do not add variants after last:
+    _last,
+}
+
+impl Feature {
+    pub fn to_str(self) -> &'static str {
+        match self {
+            Feature::altivec => "altivec",
+            Feature::vsx => "vsx",
+            Feature::power8 => "power8",
+            Feature::_last => unreachable!(),
+        }
+    }
 }

crates/std_detect/src/detect/arch/powerpc64.rs

@@ -30,6 +30,7 @@ macro_rules! is_powerpc64_feature_detected {
 /// PLEASE: do not use this, it is an implementation detail subject to change.
 #[doc(hidden)]
 #[allow(non_camel_case_types)]
+#[derive(Copy, Clone)]
 #[repr(u8)]
 #[unstable(feature = "stdsimd_internal", issue = "0")]
 pub enum Feature {
@@ -39,4 +40,18 @@ pub enum Feature {
     vsx,
     /// Power8
     power8,
+
+    // Do not add variants after last:
+    _last,
+}
+
+impl Feature {
+    pub fn to_str(self) -> &'static str {
+        match self {
+            Feature::altivec => "altivec",
+            Feature::vsx => "vsx",
+            Feature::power8 => "power8",
+            Feature::_last => unreachable!(),
+        }
+    }
 }

crates/std_detect/src/detect/arch/x86.rs

@@ -258,6 +258,7 @@ macro_rules! is_x86_feature_detected {
 /// This is an unstable implementation detail subject to change.
 #[allow(non_camel_case_types)]
 #[repr(u8)]
+#[derive(Copy, Clone)]
 #[doc(hidden)]
 #[unstable(feature = "stdsimd_internal", issue = "0")]
 pub enum Feature {
@@ -345,4 +346,54 @@ pub enum Feature {
     adx,
     /// RTM, Intel (Restricted Transactional Memory)
     rtm,
+    // Do not add variants after last:
+    _last,
+}
+
+impl Feature {
+    pub fn to_str(self) -> &'static str {
+        match self {
+            Feature::aes => "aes",
+            Feature::pclmulqdq => "pclmulqdq",
+            Feature::rdrand => "rdrand",
+            Feature::rdseed => "rdseed",
+            Feature::tsc => "tsc",
+            Feature::mmx => "mmx",
+            Feature::sse => "sse",
+            Feature::sse2 => "sse2",
+            Feature::sse3 => "sse3",
+            Feature::ssse3 => "ssse3",
+            Feature::sse4_1 => "sse4.1",
+            Feature::sse4_2 => "sse4.2",
+            Feature::sse4a => "sse4a",
+            Feature::sha => "sha",
+            Feature::avx => "avx",
+            Feature::avx2 => "avx2",
+            Feature::avx512f => "avx512f",
+            Feature::avx512cd => "avx512cd",
+            Feature::avx512er => "avx512er",
+            Feature::avx512pf => "avx512pf",
+            Feature::avx512bw => "avx512bw",
+            Feature::avx512dq => "avx512dq",
+            Feature::avx512vl => "avx512vl",
+            Feature::avx512_ifma => "avx512ifma",
+            Feature::avx512_vbmi => "avx512vbmi",
+            Feature::avx512_vpopcntdq => "avx512vpopcntdq",
+            Feature::fma => "fma",
+            Feature::bmi => "bmi",
+            Feature::bmi2 => "bmi2",
+            Feature::abm => "abm",
+            Feature::tbm => "tbm",
+            Feature::popcnt => "popcnt",
+            Feature::fxsr => "fxsr",
+            Feature::xsave => "xsave",
+            Feature::xsaveopt => "xsaveopt",
+            Feature::xsaves => "xsaves",
+            Feature::xsavec => "xsavec",
+            Feature::cmpxchg16b => "cmpxchg16b",
+            Feature::adx => "adx",
+            Feature::rtm => "rtm",
+            Feature::_last => unreachable!(),
+        }
+    }
 }

crates/std_detect/src/detect/mod.rs

@@ -83,3 +83,36 @@ cfg_if! {
     }
 }
 pub use self::os::check_for;
+
+/// Returns an `Iterator<Item=(&'static str, bool)>` where
+/// `Item.0` is the feature name, and `Item.1` is a `bool` which
+/// is `true` if the feature is supported by the host and `false` otherwise.
+#[unstable(feature = "stdsimd", issue = "27731")]
+pub fn features() -> impl Iterator<Item = (&'static str, bool)> {
+    cfg_if! {
+        if #[cfg(any(
+            target_arch = "x86",
+            target_arch = "x86_64",
+            target_arch = "arm",
+            target_arch = "aarch64",
+            target_arch = "powerpc",
+            target_arch = "powerpc64",
+            target_arch = "mips",
+            target_arch = "mips64",
+        ))] {
+            fn impl_() -> impl Iterator<Item=(&'static str, bool)> {
+                (0_u8..Feature::_last as u8).map(|discriminant: u8| {
+                    let f: Feature = unsafe { crate::mem::transmute(discriminant) };
+                    let name: &'static str = f.to_str();
+                    let enabled: bool = check_for(f);
+                    (name, enabled)
+                })
+            }
+        } else {
+            fn impl_() -> impl Iterator<Item=(&'static str, bool)> {
+                (0_u8..0_u8).map(|_x: u8| ("", false))
+            }
+        }
+    }
+    impl_()
+}

crates/std_detect/tests/cpu-detection.rs

@@ -1,18 +1,25 @@
 #![feature(stdsimd)]
 #![cfg_attr(stdsimd_strict, deny(warnings))]
 #![allow(clippy::option_unwrap_used, clippy::use_debug, clippy::print_stdout)]
-
-#[cfg(any(
+#![cfg(any(
     target_arch = "arm",
     target_arch = "aarch64",
     target_arch = "x86",
     target_arch = "x86_64",
     target_arch = "powerpc",
     target_arch = "powerpc64"
 ))]
+
 #[macro_use]
 extern crate std_detect;
 
+#[test]
+fn all() {
+    for (f, e) in std_detect::detect::features() {
+        println!("{}: {}", f, e);
+    }
+}
+
 #[test]
 #[cfg(all(target_arch = "arm", any(target_os = "linux", target_os = "android")))]
 fn arm_linux() {
@@ -74,17 +81,17 @@ fn x86_all() {
     println!("sha: {:?}", is_x86_feature_detected!("sha"));
     println!("avx: {:?}", is_x86_feature_detected!("avx"));
     println!("avx2: {:?}", is_x86_feature_detected!("avx2"));
-    println!("avx512f {:?}", is_x86_feature_detected!("avx512f"));
-    println!("avx512cd {:?}", is_x86_feature_detected!("avx512cd"));
-    println!("avx512er {:?}", is_x86_feature_detected!("avx512er"));
-    println!("avx512pf {:?}", is_x86_feature_detected!("avx512pf"));
-    println!("avx512bw {:?}", is_x86_feature_detected!("avx512bw"));
-    println!("avx512dq {:?}", is_x86_feature_detected!("avx512dq"));
-    println!("avx512vl {:?}", is_x86_feature_detected!("avx512vl"));
-    println!("avx512_ifma {:?}", is_x86_feature_detected!("avx512ifma"));
-    println!("avx512_vbmi {:?}", is_x86_feature_detected!("avx512vbmi"));
+    println!("avx512f: {:?}", is_x86_feature_detected!("avx512f"));
+    println!("avx512cd: {:?}", is_x86_feature_detected!("avx512cd"));
+    println!("avx512er: {:?}", is_x86_feature_detected!("avx512er"));
+    println!("avx512pf: {:?}", is_x86_feature_detected!("avx512pf"));
+    println!("avx512bw: {:?}", is_x86_feature_detected!("avx512bw"));
+    println!("avx512dq: {:?}", is_x86_feature_detected!("avx512dq"));
+    println!("avx512vl: {:?}", is_x86_feature_detected!("avx512vl"));
+    println!("avx512ifma: {:?}", is_x86_feature_detected!("avx512ifma"));
+    println!("avx512vbmi: {:?}", is_x86_feature_detected!("avx512vbmi"));
     println!(
-        "avx512_vpopcntdq {:?}",
+        "avx512vpopcntdq: {:?}",
         is_x86_feature_detected!("avx512vpopcntdq")
     );
     println!("f16c: {:?}", is_x86_feature_detected!("f16c"));