Initial implementation of tests with sanitizers

.github/workflows/ci-miri.yaml

@@ -0,0 +1,82 @@
+name: Miri CI
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - 'master'
+  schedule:
+    - cron: '00 2 * * *' # At 02:00 UTC every day (like rustup-components-history).
+
+jobs:
+  # test-core:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - name: Setup environment
+  #       run: bash ./ci-miri-setup.sh
+  #     - name: Test
+  #       run: bash ./ci-miri-test.sh core
+
+  # test-alloc:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - name: Setup environment
+  #       run: bash ./ci-miri-setup.sh
+  #     - name: Test
+  #       run: bash ./ci-miri-test.sh alloc
+
+  # test-std:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - name: Setup environment
+  #       run: bash ./ci-miri-setup.sh
+  #     - name: Test
+  #       run: bash ./ci-miri-test.sh std
+
+  # test-simd:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - name: Setup environment
+  #       run: bash ./ci-miri-setup.sh
+  #     - name: Test
+  #       run: bash ./ci-miri-test.sh simd
+
+  # test-stdarch:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - name: Setup environment
+  #       run: bash ./ci-miri-setup.sh
+  #     - name: Test
+  #       run: bash ./ci-miri-test.sh stdarch
+
+  # # Send a Zulip notification when a cron job fails
+  # cron-fail-notify:
+  #   name: cronjob failure notification
+  #   runs-on: ubuntu-latest
+  #   needs: [test-core, test-alloc, test-std, test-simd]
+  #   if: github.event_name == 'schedule' && (failure() || cancelled())
+  #   steps:
+  #     - name: Install zulip-send
+  #       run: pip3 install zulip
+  #     - name: Send Zulip notification
+  #       shell: bash
+  #       env:
+  #         ZULIP_BOT_EMAIL: ${{ secrets.ZULIP_BOT_EMAIL }}
+  #         ZULIP_API_TOKEN: ${{ secrets.ZULIP_API_TOKEN }}
+  #       run: |
+  #         ~/.local/bin/zulip-send --stream miri --subject "Cron Job Failure (miri-test-libstd, $(date -u +%Y-%m))" \
+  #           --message 'Dear @*T-miri*,
+
+  #         The standard library test suite is [failing under Miri]('"https://github.com/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"'). Would you mind investigating this issue?
+
+  #         Thanks in advance!
+  #         Sincerely,
+  #         The Miri Cronjobs Bot' \
+  #           --user $ZULIP_BOT_EMAIL --api-key $ZULIP_API_TOKEN --site https://rust-lang.zulipchat.com

.github/workflows/ci-sanitizers.yaml

@@ -0,0 +1,76 @@
+name: Sanitizers CI
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - 'master'
+  schedule:
+    - cron: '00 2 * * *' # At 02:00 UTC every day (like rustup-components-history).
+
+# only one target for now
+env:
+  TARGET: x86_64-unknown-linux-gnu
+  RUST_BACKTRACE: full
+
+jobs:
+  enable_matrix:
+    strategy:
+      max-parallel: 10 # 30 jobs to run...
+      matrix:
+        crate: [core, alloc, std, simd, stdarch]
+        sanitizer: [address, memory, thread, cfi, safestack, leak]
+        # exclude:
+          # FIXME: cfi is a mix of lto, bitcode, 1-cgu, and it doesn't seem to
+          # even compile
+          # - sanitizer: cfi 
+          # FIXME: we get some failures pretty early here
+          # - sanitizer: memory
+          # - sanitizer: leak
+    name: Test ${{ matrix.crate }} with ${{ matrix.sanitizer }} sanitizer
+    runs-on: ubuntu-latest
+    # continue running if other tests fail. Disable this once we get out of the
+    # prototype phase
+    if: always()
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup environment
+        run: bash ./ci-sanitizers-setup.sh
+      - name: Run ${{ matrix.sanitizer }} sanitizer
+        # Mark everything as pass just so GH doesn't cancel on us as soon as there is a failure
+        run: >
+          ./ci-sanitizers-test.sh ${{ matrix.crate }} ${{ matrix.sanitizer }} &&
+            echo 'good!' ||
+            printf "::endgroup::\nfail!\n";
+  mark_failure:
+    runs-on: ubuntu-latest
+    steps:
+      - run: sleep 2000 && echo 'that is enough time!'; exit 1
+
+  # Send a Zulip notification when a cron job fails
+  # cron-fail-notify:
+  #   name: cronjob failure notification
+  #   runs-on: ubuntu-latest
+  #   needs: [test-core, test-alloc, test-std, test-simd]
+  #   if: github.event_name == 'schedule' && (failure() || cancelled())
+  #   steps:
+  #     - name: Install zulip-send
+  #       run: pip3 install zulip
+  #     - name: Send Zulip notification
+  #       shell: bash
+  #       env:
+  #         ZULIP_BOT_EMAIL: ${{ secrets.ZULIP_BOT_EMAIL }}
+  #         ZULIP_API_TOKEN: ${{ secrets.ZULIP_API_TOKEN }}
+  #       run: |
+  #         ~/.local/bin/zulip-send --stream miri --subject "Cron Job Failure (miri-test-libstd, $(date -u +%Y-%m))" \
+  #           --message 'Dear @*T-miri*,
+
+  #         The standard library test suite is [failing under Miri]('"https://github.com/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"'). Would you mind investigating this issue?
+
+  #         Thanks in advance!
+  #         Sincerely,
+  #         The Miri Cronjobs Bot' \
+  #           --user $ZULIP_BOT_EMAIL --api-key $ZULIP_API_TOKEN --site https://rust-lang.zulipchat.com

.gitignore

@@ -1,4 +1,4 @@
 target
 Cargo.lock
-rust-src-patched
+rust-src-patched*
 library

Cargo.toml

@@ -1,12 +1,15 @@
 [workspace]
+resolver = "2"
+
 members = [
-  "core_miri_test",
-  "alloc_miri_test",
-  "std_miri_test",
+  "core_run_test",
+  "alloc_run_test",
+  "std_run_test",
 ]
 
 exclude = [
   # stdarch has its own Cargo workspace
   "library/stdarch",
   "rust-src-patched/library/stdarch",
+  "rust-src-patched-san/library/stdarch",
 ]

alloc_miri_test/Cargo.toml → alloc_run_test/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "alloc_miri_test"
+name = "alloc_run_test"
 version = "0.0.0"
 autotests = false
 autobenches = false
 edition = "2021"
 
 [lib]
-name = "alloc_miri_test"
+name = "alloc_run_test"
 path = "../library/alloc/src/lib.rs"
 
 [features]

ci-test.sh → ci-miri-test.sh

@@ -5,9 +5,10 @@ DEFAULTFLAGS="-Zmiri-retag-fields -Zrandomize-layout -Zmiri-strict-provenance"
 
 # apply our patch
 rm -rf rust-src-patched
-cp -a $(rustc --print sysroot)/lib/rustlib/src/rust/ rust-src-patched
+cp -a "$(rustc --print sysroot)/lib/rustlib/src/rust/" rust-src-patched
 ( cd rust-src-patched && patch -f -p1 < ../rust-src.diff >/dev/null ) || ( echo "Applying rust-src.diff failed!" && exit 1 )
-export MIRI_LIB_SRC=$(pwd)/rust-src-patched/library
+MIRI_LIB_SRC="$(pwd)/rust-src-patched/library"
+export MIRI_LIB_SRC
 
 # run the tests (some also without validation, to exercise those code paths in Miri)
 case "$1" in
@@ -60,13 +61,13 @@ std)
         echo "::group::Testing std core ($CORE on $TARGET)"
         MIRIFLAGS="$DEFAULTFLAGS -Zmiri-disable-isolation" \
             ./run-test.sh std --target $TARGET --lib --tests \
-            -- $CORE \
+            -- "$CORE" \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
         echo "::group::Testing std core docs ($CORE on $TARGET, ignore leaks)"
         MIRIFLAGS="$DEFAULTFLAGS -Zmiri-ignore-leaks -Zmiri-disable-isolation" \
             ./run-test.sh std --target $TARGET --doc \
-            -- $CORE \
+            -- "$CORE" \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
     done
@@ -85,7 +86,7 @@ std)
     echo "::endgroup::"
     ;;
 simd)
-    cd $MIRI_LIB_SRC/portable-simd
+    cd "$MIRI_LIB_SRC/portable-simd"
     export RUSTFLAGS="-Ainternal_features ${RUSTFLAGS:-}"
     export RUSTDOCFLAGS="-Ainternal_features ${RUSTDOCFLAGS:-}"
 
@@ -108,7 +109,7 @@ stdarch)
     for TARGET in x86_64-unknown-linux-gnu i686-unknown-linux-gnu; do
         echo "::group::Testing stdarch ($TARGET)"
         MIRIFLAGS="$DEFAULTFLAGS" \
-            ./run-stdarch-test.sh $TARGET \
+            ./miri-run-stdarch-test.sh $TARGET \
             2>&1 | ts -i '%.s  '
         echo "::endgroup::"
     done

ci-sanitizers-setup.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+set -eauxo pipefail
+
+## Shared setup code for CI jobs
+
+# We need 'ts' and 'llvm-symbolizer'
+sudo apt-get -y install moreutils llvm
+echo
+
+# And of course we need Rust
+if [[ "$GITHUB_EVENT_NAME" == 'schedule' ]]; then
+    RUST_TOOLCHAIN=nightly
+else
+    RUST_TOOLCHAIN=$(cat rust-version)
+fi
+
+echo "Installing Rust version: $RUST_TOOLCHAIN"
+rustup toolchain install "$RUST_TOOLCHAIN" --component rust-src
+rustup override set "$RUST_TOOLCHAIN"