Add AArch64 tests to CI (#1526)

* Add AArch64 tests to CI

This commit enhances our CI with an AArch64 builder. Currently we have
no physical hardware to run on so for now we run all tests in an
emulator. The AArch64 build is cross-compiled from x86_64 from Linux.
Tests all happen in release mode with a recent version of QEMU (recent
version because it's so much faster, and in release mode because debug
mode tests take quite a long time in an emulator).

The goal here was not to get all tests passing on CI, but rather to get
AArch64 running on CI and get it green at the same time. To achieve that
goal many tests are now ignored on aarch64 platforms. Many tests fail
due to unimplemented functionality in the aarch64 backend (#1521), and
all wasmtime tests involving compilation are also disabled due to
panicking attempting to generate generate instruction offset information
for trap symbolication (#1523).

Despite this, though, all Cranelift tests and other wasmtime tests
should be runnin on AArch64 through QEMU with this PR. Additionally
we'll have an AArch64 binary release of Wasmtime for Linux, although it
won't be too useful just yet since it will panic on almost all wasm
modules.

* Review comments

Author: alexcrichton

.github/workflows/main.yml

@@ -266,13 +266,52 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        include:
+        - build: x86_64-linux
+          os: ubuntu-latest
+        - build: x86_64-macos
+          os: macos-latest
+        - build: x86_64-windows
+          os: windows-latest
+        - build: aarch64-linux
+          os: ubuntu-latest
+          rust: stable
+          target: aarch64-unknown-linux-gnu
+          gcc_package: gcc-aarch64-linux-gnu
+          gcc: aarch64-linux-gnu-gcc
+          qemu: qemu-aarch64 -L /usr/aarch64-linux-gnu
+          qemu_target: aarch64-linux-user
     steps:
     - uses: actions/checkout@v1
       with:
         submodules: true
     - uses: ./.github/actions/install-rust
     - uses: ./.github/actions/binary-compatible-builds
+      if: matrix.target == ''
+
+    - name: Install cross-compilation tools
+      run: |
+        set -ex
+        sudo apt-get update
+        sudo apt-get install -y ${{ matrix.gcc_package }}
+
+        # Download and build qemu from source since the most recent release is
+        # way faster at arm emulation than the current version github actions'
+        # ubuntu image uses. Disable as much as we can to get it to build
+        # quickly.
+        curl https://download.qemu.org/qemu-4.2.0.tar.xz | tar xJf -
+        cd qemu-4.2.0
+        ./configure --target-list=${{ matrix.qemu_target }} --prefix=$HOME/qemu --disable-tools --disable-slirp --disable-fdt --disable-capstone --disable-docs
+        make -j$(nproc) install
+
+        # Configure Cargo for cross compilation and tell it how it can run
+        # cross executables
+        upcase=$(echo ${{ matrix.target }} | awk '{ print toupper($0) }' | sed 's/-/_/g')
+        echo ::set-env name=CARGO_TARGET_${upcase}_RUNNER::$HOME/qemu/bin/${{ matrix.qemu }}
+        echo ::set-env name=CARGO_TARGET_${upcase}_LINKER::${{ matrix.gcc }}
+        echo ::set-env name=CARGO_BUILD_TARGET::${{ matrix.target }}
+        rustup target add ${{ matrix.target }}
+      if: matrix.target != ''
 
     # Install wasm32-wasi target in order to build wasi-common's integration
     # tests
@@ -285,7 +324,7 @@ jobs:
     - run: $CENTOS cargo build --release --manifest-path crates/c-api/Cargo.toml
       shell: bash
     # Test what we just built
-    - run: $CENTOS cargo test --features test-programs/test_programs --release --all --exclude lightbeam --exclude wasmtime --exclude wasmtime-c-api --exclude wasmtime-fuzzing
+    - run: $CENTOS cargo test --features test-programs/test_programs --release --all --exclude lightbeam
       shell: bash
       env:
         RUST_BACKTRACE: 1
@@ -304,14 +343,18 @@ jobs:
 
     # Move binaries to dist folder
     - run: cp target/release/wasmtime dist
-      if: matrix.os != 'windows-latest'
+      if: matrix.os != 'windows-latest' && matrix.target == ''
+    - run: cp target/${{ matrix.target }}/release/wasmtime dist
+      if: matrix.os != 'windows-latest' && matrix.target != ''
     - run: cp target/release/wasmtime.exe dist
       shell: bash
       if: matrix.os == 'windows-latest'
 
     # Move libwasmtime dylib to dist folder
     - run: cp target/release/libwasmtime.{so,a} dist
-      if: matrix.os == 'ubuntu-latest'
+      if: matrix.os == 'ubuntu-latest' && matrix.target == ''
+    - run: cp target/${{ matrix.target }}/release/libwasmtime.{so,a} dist
+      if: matrix.os == 'ubuntu-latest' && matrix.target != ''
     - run: cp target/release/libwasmtime.{dylib,a} dist
       if: matrix.os == 'macos-latest'
     - run: cp target/release/wasmtime.{dll,lib,dll.lib} dist
@@ -329,7 +372,7 @@ jobs:
 
     - uses: actions/upload-artifact@v1
       with:
-        name: bins-${{ matrix.os }}
+        name: bins-${{ matrix.build }}
         path: dist
 
   # Consumes all published artifacts from all the previous build steps, creates
@@ -357,18 +400,22 @@ jobs:
       uses: actions/download-artifact@v1
       with:
         name: doc-api
-    - name: Download macOS binaries
+    - name: Download x86_64 macOS binaries
+      uses: actions/download-artifact@v1
+      with:
+        name: bins-x86_64-macos
+    - name: Download x86_64 Linux binaries
       uses: actions/download-artifact@v1
       with:
-        name: bins-macos-latest
-    - name: Download Linux binaries
+        name: bins-x86_64-linux
+    - name: Download AArch64 Linux binaries
       uses: actions/download-artifact@v1
       with:
-        name: bins-ubuntu-latest
-    - name: Download Windows binaries
+        name: bins-aarch64-linux
+    - name: Download x86_64 Windows binaries
       uses: actions/download-artifact@v1
       with:
-        name: bins-windows-latest
+        name: bins-x86_64-windows
 
     - name: Assemble gh-pages
       run: |
@@ -400,9 +447,10 @@ jobs:
     # Assemble all the build artifacts into tarballs and zip archives.
     - name: Assemble tarballs
       run: |
-        ./ci/build-tarballs.sh x86_64-linux ubuntu-latest
-        ./ci/build-tarballs.sh x86_64-windows windows-latest .exe
-        ./ci/build-tarballs.sh x86_64-macos macos-latest
+        ./ci/build-tarballs.sh x86_64-linux
+        ./ci/build-tarballs.sh x86_64-windows .exe
+        ./ci/build-tarballs.sh x86_64-macos
+        ./ci/build-tarballs.sh aarch64-linux
 
     # Upload all assembled tarballs as an artifact of the github action run, so
     # that way even PRs can inspect the output.

build.rs

@@ -154,10 +154,13 @@ fn write_testsuite_tests(
     if ignore(testsuite, &testname, strategy) {
         writeln!(out, "#[ignore]")?;
     }
-    writeln!(out, "fn r#{}() -> anyhow::Result<()> {{", &testname)?;
+    if should_panic(testsuite, &testname) {
+        writeln!(out, "#[should_panic]")?;
+    }
+    writeln!(out, "fn r#{}() {{", &testname)?;
     writeln!(
         out,
-        "crate::wast::run_wast(r#\"{}\"#, crate::wast::Strategy::{})",
+        "crate::wast::run_wast(r#\"{}\"#, crate::wast::Strategy::{}).unwrap();",
         path.display(),
         strategy
     )?;
@@ -168,6 +171,7 @@ fn write_testsuite_tests(
 
 /// Ignore tests that aren't supported yet.
 fn ignore(testsuite: &str, testname: &str, strategy: &str) -> bool {
+    let target = env::var("TARGET").unwrap();
     match strategy {
         #[cfg(feature = "lightbeam")]
         "Lightbeam" => match (testsuite, testname) {
@@ -205,10 +209,53 @@ fn ignore(testsuite: &str, testname: &str, strategy: &str) -> bool {
                 return true;
             }
 
+            // FIXME(#1569) stack protection isn't implemented yet and these
+            // tests segfault.
+            ("spec_testsuite", "skip_stack_guard_page")
+            | ("spec_testsuite", "stack")
+            | ("misc_testsuite", "stack_overflow")
+                if target.contains("aarch64") =>
+            {
+                return true
+            }
+
             _ => {}
         },
         _ => panic!("unrecognized strategy"),
     }
 
     false
 }
+
+/// Determine whether to add a should_panic attribute. These tests currently
+/// panic because of unfinished backend implementation work; we will remove them
+/// from this list as we finish the implementation
+fn should_panic(testsuite: &str, testname: &str) -> bool {
+    let target = env::var("TARGET").unwrap();
+    if !target.contains("aarch64") {
+        return false;
+    }
+    match (testsuite, testname) {
+        // FIXME(#1521)
+        ("bulk_memory_operations", "imports")
+        | ("misc_testsuite", "func_400_params")
+        | ("misc_testsuite", "misc_traps")
+        | ("simd", _)
+        | ("multi_value", "call")
+        | ("spec_testsuite", "address")
+        | ("spec_testsuite", "align")
+        | ("spec_testsuite", "call")
+        | ("spec_testsuite", "conversions")
+        | ("spec_testsuite", "f32_bitwise")
+        | ("spec_testsuite", "float_misc")
+        | ("spec_testsuite", "i32")
+        | ("spec_testsuite", "i64")
+        | ("spec_testsuite", "imports")
+        | ("spec_testsuite", "int_exprs")
+        | ("spec_testsuite", "memory_grow")
+        | ("spec_testsuite", "memory_trap")
+        | ("spec_testsuite", "traps") => true,
+
+        _ => false,
+    }
+}

ci/build-tarballs.sh

@@ -9,12 +9,15 @@
 # the second argument is the name of the github actions platform which is where
 # we source binaries from. The final third argument is ".exe" on Windows to
 # handle executable extensions right.
+#
+# Usage: build-tarballs.sh PLATFORM [.exe]
+
+# where PLATFORM is e.g. x86_64-linux, aarch64-linux, ...
 
 set -ex
 
 platform=$1
-src=$2
-exe=$3
+exe=$2
 
 rm -rf tmp
 mkdir tmp
@@ -33,12 +36,12 @@ mktarball() {
 bin_pkgname=wasmtime-$TAG-$platform
 mkdir tmp/$bin_pkgname
 cp LICENSE README.md tmp/$bin_pkgname
-mv bins-$src/wasmtime$exe tmp/$bin_pkgname
+mv bins-$platform/wasmtime$exe tmp/$bin_pkgname
 chmod +x tmp/$bin_pkgname/wasmtime$exe
 mktarball $bin_pkgname
 
 if [ "$exe" = ".exe" ]; then
-  mv bins-$src/installer.msi dist/$bin_pkgname.msi
+  mv bins-$platform/installer.msi dist/$bin_pkgname.msi
 fi
 
 # Create tarball of API libraries
@@ -47,7 +50,7 @@ mkdir tmp/$api_pkgname
 mkdir tmp/$api_pkgname/lib
 mkdir tmp/$api_pkgname/include
 cp LICENSE README.md tmp/$api_pkgname
-mv bins-$src/* tmp/$api_pkgname/lib
+mv bins-$platform/* tmp/$api_pkgname/lib
 cp crates/c-api/wasm-c-api/include/wasm.h tmp/$api_pkgname/include
 cp crates/c-api/include/{wasmtime,wasi}.h tmp/$api_pkgname/include
 mktarball $api_pkgname

cranelift/docs/testing.md

@@ -316,10 +316,15 @@ functions must have the signature `() -> bNN` where `bNN` is some sort of
 boolean, e.g. `b1` or `b32`. A `true` value is interpreted as a successful
 test execution, whereas a `false` value is interpreted as a failed test.
 
+Currently a `target` is required but is only used to indicate whether the host
+platform can run the test, and currently only the architecture is filtered. The
+host platform's native target will be used to actually compile the test.
+
 Example:
 
 ```
     test run
+    target x86_64
 
     function %trivial_test() -> b1 {
     ebb0:

cranelift/filetests/filetests/isa/x86/run-const.clif

@@ -1,4 +1,5 @@
 test run
+target x86_64
 
 function %test_compare_i32() -> b1 {
 block0:

cranelift/filetests/filetests/isa/x86/simd-comparison-run.clif

@@ -1,5 +1,6 @@
 test run
 set enable_simd
+target x86_64
 
 function %icmp_eq_i8x16() -> b8 {
 block0:

cranelift/filetests/filetests/isa/x86/simd-conversion-run.clif

@@ -1,5 +1,6 @@
 test run
 set enable_simd
+target x86_64
 
 function %fcvt_from_sint() -> b1 {
 block0:

cranelift/filetests/filetests/isa/x86/simd-lane-access-run.clif

@@ -1,5 +1,6 @@
 test run
 set enable_simd
+target x86_64
 
 function %shuffle_different_ssa_values() -> b1 {
 block0:

cranelift/filetests/filetests/isa/x86/simd-vconst-run.clif

@@ -1,5 +1,6 @@
 test run
 set enable_simd
+target x86_64
 
 function %vconst_syntax() -> b1 {
 block0:

cranelift/filetests/src/test_run.rs

@@ -4,12 +4,12 @@
 
 use crate::function_runner::FunctionRunner;
 use crate::subtest::{Context, SubTest, SubtestResult};
-use cranelift_codegen;
 use cranelift_codegen::ir;
 use cranelift_reader::parse_run_command;
 use cranelift_reader::TestCommand;
 use log::trace;
 use std::borrow::Cow;
+use target_lexicon::Architecture;
 
 struct TestRun;
 
@@ -32,7 +32,7 @@ impl SubTest for TestRun {
     }
 
     fn needs_isa(&self) -> bool {
-        false
+        true
     }
 
     fn run(&self, func: Cow<ir::Function>, context: &Context) -> SubtestResult<()> {
@@ -42,8 +42,22 @@ impl SubTest for TestRun {
                 let command = parse_run_command(trimmed_comment, &func.signature)
                     .map_err(|e| format!("{}", e))?;
                 trace!("Parsed run command: {}", command);
-                // TODO in following changes we will use the parsed command to alter FunctionRunner's behavior.
 
+                // If this test requests to run on a completely different
+                // architecture than the host platform then we skip it entirely,
+                // since we won't be able to natively execute machine code.
+                let requested_arch = context.isa.unwrap().triple().architecture;
+                if requested_arch != Architecture::host() {
+                    return Ok(());
+                }
+
+                // TODO in following changes we will use the parsed command to alter FunctionRunner's behavior.
+                //
+                // Note that here we're also explicitly ignoring `context.isa`,
+                // regardless of what's requested. We want to use the native
+                // host ISA no matter what here, so the ISA listed in the file
+                // is only used as a filter to not run into situations like
+                // running x86_64 code on aarch64 platforms.
                 let runner =
                     FunctionRunner::with_host_isa(func.clone().into_owned(), context.flags.clone());
                 runner.run()?