6 ./miri install <flags>:
7 Installs the miri driver and cargo-miri. <flags> are passed to `cargo
8 install`. Sets up the rpath such that the installed binary should work in any
9 working directory. However, the rustup toolchain when invoking `cargo miri`
10 needs to be the same one used for `./miri install`.
13 Just build miri. <flags> are passed to `cargo build`.
16 Just check miri. <flags> are passed to `cargo check`.
19 Build miri, set up a sysroot and then run the test suite. <flags> are passed
20 to the final `cargo test` invocation.
23 Build miri, set up a sysroot and then run the driver with the given <flags>.
24 (Also respects MIRIFLAGS environment variable.)
27 Format all sources and tests. <flags> are passed to `rustfmt`.
29 ./miri clippy <flags>:
30 Runs clippy on all sources. <flags> are passed to `cargo clippy`.
32 ./miri many-seeds <command>:
33 Runs <command> over and over again with different seeds for Miri. The MIRIFLAGS
34 variable is set to its original value appended with ` -Zmiri-seed=$SEED` for
37 ./miri bench <benches>:
38 Runs the benchmarks from bench-cargo-miri in hyperfine. hyperfine needs to be installed.
39 <benches> can explicitly list the benchmarks to run; by default, all of them are run.
44 If already set, the "sysroot setup" step is skipped.
47 Pass extra flags to all cargo invocations.
52 # macOS does not have a useful readlink/realpath so we have to use Python instead...
53 MIRIDIR=$(python3 -c 'import os, sys; print(os.path.dirname(os.path.realpath(sys.argv[1])))' "$0")
54 TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
60 ## Handle some commands early, since they should *not* alter the environment.
63 for SEED in $({ echo obase=16; seq 0 255; } | bc); do
64 echo "Trying seed: $SEED"
65 MIRIFLAGS="$MIRIFLAGS -Zmiri-seed=$SEED" $@ || { echo "Failing seed: $SEED"; break; }
70 # Make sure we have an up-to-date Miri installed
72 # Run the requested benchmarks
74 BENCHES=( $(ls "$MIRIDIR/bench-cargo-miri" ) )
78 for BENCH in "${BENCHES[@]}"; do
79 hyperfine -w 1 -m 5 --shell=none "cargo +$TOOLCHAIN miri run --manifest-path bench-cargo-miri/$BENCH/Cargo.toml"
85 ## Prepare the environment
86 # Determine some toolchain properties
87 TARGET=$(rustc +$TOOLCHAIN --version --verbose | grep "^host:" | cut -d ' ' -f 2)
88 SYSROOT=$(rustc +$TOOLCHAIN --print sysroot)
89 LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
90 if ! test -d "$LIBDIR"; then
91 echo "Something went wrong determining the library dir."
92 echo "I got $LIBDIR but that does not exist."
93 echo "Please report a bug at https://github.com/rust-lang/miri/issues."
97 # Prepare flags for cargo and rustc.
98 CARGO="cargo +$TOOLCHAIN"
99 if [ -z "$CARGO_TARGET_DIR" ]; then
100 # Share target dir between `miri` and `cargo-miri`.
101 export CARGO_TARGET_DIR="$MIRIDIR/target"
103 # We set the rpath so that Miri finds the private rustc libraries it needs.
104 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR $RUSTFLAGS"
108 # Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
110 # Build once, for the user to see.
111 $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
112 # Call again, to just set env var.
113 export MIRI_SYSROOT="$($CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
116 # Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
117 # locally built vs. distributed rustc.
119 if [ -n "$MIRI_SYSROOT" ]; then
120 # Sysroot already set, use that.
123 # We need to build a sysroot.
124 if [ -n "$MIRI_TEST_TARGET" ]; then
125 build_sysroot --target "$MIRI_TEST_TARGET"
136 # "--locked" to respect the Cargo.lock file if it exists.
137 $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR" --force --locked "$@"
138 $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked "$@"
141 # Check, and let caller control flags.
142 $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
143 $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
146 # Build, and let caller control flags.
147 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
148 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
151 # First build and get a sysroot.
152 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
154 if [ "$COMMAND" = "bless" ]; then
155 export MIRI_BLESS="Gesundheit"
157 # Then test, and let caller control flags.
158 # Only in root project and ui_test as `cargo-miri` has no tests.
159 $CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
160 $CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml "$@"
163 # Scan for "--target" to overwrite the "MIRI_TEST_TARGET" env var so
164 # that we set the MIRI_SYSROOT up the right way.
167 if [ "$LAST_ARG" = "--target" ]; then
169 export MIRI_TEST_TARGET="$ARG"
175 if [ "$FOUND_TARGET_OPT" = "0" ] && [ -n "$MIRI_TEST_TARGET" ]; then
176 # Make sure Miri actually uses this target.
177 MIRIFLAGS="$MIRIFLAGS --target $MIRI_TEST_TARGET"
179 # First build and get a sysroot.
180 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
182 # Then run the actual command.
183 exec $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml -- --sysroot "$MIRI_SYSROOT" $MIRIFLAGS "$@"
186 find "$MIRIDIR" -not \( -name target -prune \) -name '*.rs' \
187 | xargs rustfmt +$TOOLCHAIN --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
190 $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
191 $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml --all-targets "$@"
192 $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
195 if [ -n "$COMMAND" ]; then
196 echo "Unknown command: $COMMAND"