[mips/mips64: msa] add add_a_b intrinsic (#365)

* [mips64/msa] add add_a_b intrinsic

* add make/file to mips64el's Dockerfile

* add run-time detection support for mips64

* add mips64 build bot

* generate docs for mips64

* fix linux test

* cleanup rt-detection

* support mips64/mips64el in stdsimd-test

* support asserting instructions with  in their name

* better error msgs for the auxv_crate test

* debug auxv on mips64

* override run-time detection on mips msa tests

* remove unused #[macro_use]

* try another MIPS cpu

* detect default TARGET in simd-test-macro

* use mips64r2-generic

* disable unused function in mips tests

* move msa to mips

* remove mips from ci

* split into mips and mips64 modules

* add rt-detection for 32-bit mips

* fmt

* remove merge error

* add norun build bots for mips

* add -p to avoid changing the cwd

* fixup

* refactor run-time detection module

Author: gnzlbg

.travis.yml

@@ -12,6 +12,10 @@ matrix:
     - env: TARGET=arm-unknown-linux-gnueabihf
     - env: TARGET=armv7-unknown-linux-gnueabihf
     - env: TARGET=aarch64-unknown-linux-gnu
+    - env: TARGET=mips-unknown-linux-gnu NORUN=1
+    - env: TARGET=mipsel-unknown-linux-gnu NORUN=1
+    - env: TARGET=mips64-unknown-linux-gnuabi64 NORUN=1
+    - env: TARGET=mips64el-unknown-linux-gnuabi64 NORUN=1
     - env: TARGET=powerpc-unknown-linux-gnu
     - env: TARGET=powerpc64-unknown-linux-gnu
     - env: TARGET=powerpc64le-unknown-linux-gnu
@@ -21,11 +25,6 @@ matrix:
     - os: osx
       env: TARGET=x86_64-apple-darwin NO_ADD=1
       script: ci/run.sh
-    - env: DOCUMENTATION
-      install: true
-      script: ci/dox.sh
-    - script: cargo test --manifest-path crates/stdsimd-verify/Cargo.toml
-      install: true
     - env: TARGET=wasm32-unknown-unknown
       before_script:
         - git clone --recursive https://github.com/WebAssembly/wabt
@@ -39,6 +38,11 @@ matrix:
         - cat wasm.wat
         - grep current_memory wasm.wat
         - grep grow_memory wasm.wat
+    - env: DOCUMENTATION
+      install: true
+      script: ci/dox.sh
+    - script: cargo test --manifest-path crates/stdsimd-verify/Cargo.toml
+      install: true
     - env: RUSTFMT=On TARGET=x86_64-unknown-linux-gnu NO_ADD=1
       before_script:
       - rustup component add rustfmt-preview
@@ -60,7 +64,13 @@ install:
 
 script:
   - cargo generate-lockfile
-  - ci/run-docker.sh $TARGET $FEATURES
+  - |
+    if [ "$NORUN" == "1" ]; then
+      cargo build --target=$TARGET -p coresimd -p stdsimd --manifest-path crates/stdsimd/Cargo.toml
+      cargo build --release --target=$TARGET -p coresimd -p stdsimd --manifest-path crates/stdsimd/Cargo.toml
+    else
+      ci/run-docker.sh $TARGET $FEATURES
+    fi
 
 notifications:
   email:

ci/dox.sh

@@ -42,6 +42,8 @@ dox arm armv7-unknown-linux-gnueabihf
 dox aarch64 aarch64-unknown-linux-gnu
 dox powerpc powerpc-unknown-linux-gnu
 dox powerpc64 powerpc64-unknown-linux-gnu
+dox mips mips-unknown-linux-gnu
+dox mips64 mips64-unknown-linux-gnuabi64
 
 # If we're on travis, not a PR, and on the right branch, publish!
 if [ "$TRAVIS_PULL_REQUEST" = "false" ] && [ "$TRAVIS_BRANCH" = "master" ]; then

coresimd/mips/mod.rs

@@ -0,0 +1,4 @@
+//! MIPS
+
+mod msa;
+pub use self::msa::*;

coresimd/mips/msa.rs

@@ -0,0 +1,54 @@
+//! MIPS SIMD Architecture intrinsics
+//!
+//! The reference is [MIPS Architecture for Programmers Volume IV-j: The
+//! MIPS32 SIMD Architecture Module Revision 1.12][msa_ref].
+//!
+//! [msa_ref]: http://cdn2.imgtec.com/documentation/MD00866-2B-MSA32-AFP-01.12.pdf
+
+#[cfg(test)]
+use stdsimd_test::assert_instr;
+use coresimd::simd::*;
+
+#[allow(improper_ctypes)]
+extern "C" {
+    #[link_name = "llvm.mips.add.a.b"]
+    fn msa_add_a_b(a: i8x16, b: i8x16) -> i8x16;
+}
+
+/// Vector Add Absolute Values.
+///
+/// Adds the absolute values of the elements in `a` and `b` into the result vector.
+#[inline]
+#[target_feature(enable = "msa")]
+#[cfg_attr(test, assert_instr(add_a.b))]
+pub unsafe fn __msa_add_a_b(a: i8x16, b: i8x16) -> i8x16 {
+    msa_add_a_b(a, b)
+}
+
+#[cfg(test)]
+mod tests {
+    use simd::*;
+    use stdsimd_test::simd_test;
+    use coresimd::mips64::msa;
+
+    #[simd_test = "msa"]
+    unsafe fn __msa_add_a_b() {
+        #[cfg_attr(rustfmt, rustfmt_skip)]
+        let a = i8x16::new(
+            1, 2, 3, 4,
+            1, 2, 3, 4,
+            1, 2, 3, 4,
+            1, 2, 3, 4,
+        );
+        #[cfg_attr(rustfmt, rustfmt_skip)]
+        let b = i8x16::new(
+            -4, -3, -2, -1,
+            -4, -3, -2, -1,
+            -4, -3, -2, -1,
+            -4, -3, -2, -1,
+        );
+        let r = i8x16::splat(5);
+
+        assert_eq!(r, msa::__msa_add_a_b(a, b));
+    }
+}

coresimd/mod.rs

@@ -29,11 +29,15 @@ pub mod simd {
 /// * [`x86_64`]
 /// * [`arm`]
 /// * [`aarch64`]
+/// * [`mips`]
+/// * [`mips64`]
 ///
 /// [`x86`]: https://rust-lang-nursery.github.io/stdsimd/x86/stdsimd/arch/index.html
 /// [`x86_64`]: https://rust-lang-nursery.github.io/stdsimd/x86_64/stdsimd/arch/index.html
 /// [`arm`]: https://rust-lang-nursery.github.io/stdsimd/arm/stdsimd/arch/index.html
 /// [`aarch64`]: https://rust-lang-nursery.github.io/stdsimd/aarch64/stdsimd/arch/index.html
+/// [`mips`]: https://rust-lang-nursery.github.io/stdsimd/mips/stdsimd/arch/index.html
+/// [`mips64`]: https://rust-lang-nursery.github.io/stdsimd/mips64/stdsimd/arch/index.html
 #[unstable(feature = "stdsimd", issue = "0")]
 pub mod arch {
     /// Platform-specific intrinsics for the `x86` platform.
@@ -81,6 +85,24 @@ pub mod arch {
     pub mod wasm32 {
         pub use coresimd::wasm32::*;
     }
+
+    /// Platform-specific intrinsics for the `mips` platform.
+    ///
+    /// See the [module documentation](../index.html) for more details.
+    #[cfg(any(target_arch = "mips", dox))]
+    #[doc(cfg(target_arch = "mips"))]
+    pub mod mips {
+        pub use coresimd::mips::*;
+    }
+
+    /// Platform-specific intrinsics for the `mips64` platform.
+    ///
+    /// See the [module documentation](../index.html) for more details.
+    #[cfg(any(target_arch = "mips64", dox))]
+    #[doc(cfg(target_arch = "mips64"))]
+    pub mod mips64 {
+        pub use coresimd::mips::*;
+    }
 }
 
 mod simd_llvm;
@@ -97,4 +119,7 @@ mod aarch64;
 #[cfg(target_arch = "wasm32")]
 mod wasm32;
 
+#[cfg(any(target_arch = "mips", target_arch = "mips64", dox))]
+mod mips;
+
 mod nvptx;

crates/assert-instr-macro/src/lib.rs

@@ -39,8 +39,15 @@ pub fn assert_instr(
         (quote! { #[ignore] }).into()
     };
     let name = &func.ident;
+    use quote::ToTokens;
+    let instr_str = instr
+        .clone()
+        .into_tokens()
+        .to_string()
+        .replace('.', "_")
+        .replace(|c: char| c.is_whitespace(), "");
     let assert_name = syn::Ident::from(
-        &format!("assert_{}_{}", name.as_ref(), instr.as_ref())[..],
+        &format!("assert_{}_{}", name.as_ref(), instr_str)[..],
     );
     let shim_name = syn::Ident::from(format!("{}_shim", name.as_ref()));
     let mut inputs = Vec::new();
@@ -72,7 +79,7 @@ pub fn assert_instr(
             attr.path
                 .segments
                 .first()
-                .unwrap()
+                .expect("attr.path.segments.first() failed")
                 .value()
                 .ident
                 .as_ref()
@@ -109,7 +116,8 @@ pub fn assert_instr(
         }
     }.into();
     // why? necessary now to get tests to work?
-    let tts: TokenStream = tts.to_string().parse().unwrap();
+    let tts: TokenStream =
+        tts.to_string().parse().expect("cannot parse tokenstream");
 
     let tts: TokenStream = quote! {
         #item
@@ -119,13 +127,13 @@ pub fn assert_instr(
 }
 
 struct Invoc {
-    instr: syn::Ident,
+    instr: syn::Expr,
     args: Vec<(syn::Ident, syn::Expr)>,
 }
 
 impl syn::synom::Synom for Invoc {
     named!(parse -> Self, map!(parens!(do_parse!(
-        instr: syn!(syn::Ident) >>
+        instr: syn!(syn::Expr) >>
         args: many0!(do_parse!(
             syn!(syn::token::Comma) >>
             name: syn!(syn::Ident) >>

crates/simd-test-macro/src/lib.rs

@@ -53,14 +53,48 @@ pub fn simd_test(
     let item = TokenStream::from(item);
     let name = find_name(item.clone());
 
-    let name: TokenStream = name.as_str().parse().unwrap();
+    let name: TokenStream = name.as_str()
+        .parse()
+        .expect(&format!("failed to parse name: {}", name.clone().as_str()));
 
-    let target = env::var("TARGET").unwrap();
-    let macro_test = match target.split('-').next().unwrap() {
+    let default_target = if cfg!(target_os = "windows") {
+        Some("x86_64-pc-windows-msvc")
+    } else if cfg!(target_os = "linux") {
+        Some("x86_64-unknown-linux-gnu")
+    } else if cfg!(target_os = "macos") {
+        Some("x86_64-apple-darwin")
+    } else {
+        None
+    };
+
+    let target = env::var("TARGET").unwrap_or_else(|_| {
+        default_target.expect("TARGET environment variable not set and no default target known for the current target.").to_string()
+    });
+    let mut force_test = false;
+    let macro_test = match target
+        .split('-')
+        .next()
+        .expect(&format!("target triple contained no \"-\": {}", target))
+    {
         "i686" | "x86_64" | "i586" => "is_x86_feature_detected",
         "arm" => "is_arm_feature_detected",
         "aarch64" => "is_aarch64_feature_detected",
         "powerpc64" => "is_powerpc64_feature_detected",
+        "mips" | "mipsel" => {
+            // FIXME:
+            // On MIPS CI run-time feature detection always returns false due
+            // to this qemu bug: https://bugs.launchpad.net/qemu/+bug/1754372
+            //
+            // This is a workaround to force the MIPS tests to always run on
+            // CI.
+            force_test = true;
+            "is_mips_feature_detected"
+        }
+        "mips64" | "mips64el" => {
+            // FIXME: see above
+            force_test = true;
+            "is_mips64_feature_detected"
+        }
         t => panic!("unknown target: {}", t),
     };
     let macro_test = proc_macro2::Term::intern(macro_test);
@@ -82,7 +116,7 @@ pub fn simd_test(
         #[allow(non_snake_case)]
         #[test]
         fn #name() {
-            if #cfg_target_features {
+            if #force_test | (#cfg_target_features) {
                 return unsafe { #name() };
             } else {
                 ::stdsimd_test::assert_skip_test_ok(stringify!(#name));

crates/stdsimd/src/lib.rs

@@ -29,6 +29,9 @@ mod stdsimd;
 
 pub use stdsimd::*;
 
+#[allow(unused_imports)]
 use _std::prelude;
+#[allow(unused_imports)]
 use _std::fs;
+#[allow(unused_imports)]
 use _std::io;