chore: add MIRI flag for exposed provenance

polazarus · Jan 10, 2025 · 409d442 · 409d442
1 parent a7a5979
commit 409d442
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/.github/workflows/analysis.yml b/.github/workflows/analysis.yml
@@ -52,7 +52,7 @@ jobs:
     strategy:
       matrix:
         platform:
-          - s390x-unknown-linux-gnu # 32-bit LE
+          - s390x-unknown-linux-gnu # 32-bit BE
           - powerpc64-unknown-linux-gnu # 64-bit BE
           - i686-unknown-linux-gnu
           - x86_64-unknown-linux-gnu
@@ -67,4 +67,8 @@ jobs:
           components: miri
 
       - name: Run tests under Miri
+        env:
+          MIRIFLAGS: >-
+            -Zmiri-permissive-provenance
+            -Zmiri-many-seeds
         run: cargo +nightly miri test --verbose --target ${{matrix.platform}} --all-features
diff --git a/README.md b/README.md
@@ -114,11 +114,11 @@ RUSTFLAGS='--cfg loom' cargo test --release loom
 This crate runs successfully with Miri:
 
 ```bash
-MIRIFLAGS=-Zmiri-symbolic-alignment-check cargo +nightly miri test
+MIRIFLAGS='-Zmiri-symbolic-alignment-check -Zmiri-permissive-provenance' cargo +nightly miri test
 
 for SEED in $(seq 0 10); do
   echo "Trying seed: $SEED"
-  MIRIFLAGS="-Zmiri-seed=$SEED" cargo +nightly miri test || { echo "Failing seed: $SEED"; break; };
+  MIRIFLAGS="-Zmiri-seed=$SEED -Zmiri-permissive-provenance" cargo +nightly miri test || { echo "Failing seed: $SEED"; break; };
 done
 ```
 
@@ -132,6 +132,8 @@ cargo +nightly miri test --target i686-unknown-linux-gnu
 ```
 
 Note: this crate leverages the "exposed provenance" semantics.
+`MIRIFLAGS=-Zmiri-permissive-provenance` silences the warning related to the use
+of exposed provenance.
 
 ## 📦 Similar crates