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`.
33 Runs just `cargo <flags>` with the Miri-specific environment variables.
34 Mainly meant to be invoked by rust-analyzer.
36 ./miri many-seeds <command>:
37 Runs <command> over and over again with different seeds for Miri. The MIRIFLAGS
38 variable is set to its original value appended with ` -Zmiri-seed=$SEED` for
41 ./miri bench <benches>:
42 Runs the benchmarks from bench-cargo-miri in hyperfine. hyperfine needs to be installed.
43 <benches> can explicitly list the benchmarks to run; by default, all of them are run.
48 If already set, the "sysroot setup" step is skipped.
51 Pass extra flags to all cargo invocations. (Ignored by `./miri cargo`.)
55 ## We need to know where we are.
56 # macOS does not have a useful readlink/realpath so we have to use Python instead...
57 MIRIDIR=$(python3 -c 'import os, sys; print(os.path.dirname(os.path.realpath(sys.argv[1])))' "$0")
59 ## Run the auto-things.
60 if [ -z "$MIRI_AUTO_OPS" ]; then
61 export MIRI_AUTO_OPS=42
63 # Run this first, so that the toolchain doesn't change after
65 if [ -f "$MIRIDIR/.auto-everything" ] || [ -f "$MIRIDIR/.auto-toolchain" ] ; then
66 (cd "$MIRIDIR" && ./rustup-toolchain)
69 if [ -f "$MIRIDIR/.auto-everything" ] || [ -f "$MIRIDIR/.auto-fmt" ] ; then
73 if [ -f "$MIRIDIR/.auto-everything" ] || [ -f "$MIRIDIR/.auto-clippy" ] ; then
74 $0 clippy -- -D warnings
78 ## Determine command and toolchain.
81 # Doing this *after* auto-toolchain logic above, since that might change the toolchain.
82 TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
84 ## Handle some commands early, since they should *not* alter the environment.
87 for SEED in $({ echo obase=16; seq 0 255; } | bc); do
88 echo "Trying seed: $SEED"
89 MIRIFLAGS="$MIRIFLAGS -Zmiri-seed=$SEED" $@ || { echo "Failing seed: $SEED"; break; }
94 # Make sure we have an up-to-date Miri installed
96 # Run the requested benchmarks
97 if [ -z "${1+exists}" ]; then
98 BENCHES=( $(ls "$MIRIDIR/bench-cargo-miri" ) )
102 for BENCH in "${BENCHES[@]}"; do
103 hyperfine -w 1 -m 5 --shell=none "cargo +$TOOLCHAIN miri run --manifest-path $MIRIDIR/bench-cargo-miri/$BENCH/Cargo.toml"
109 ## Prepare the environment
110 # Determine some toolchain properties
111 # export the target so its available in miri
112 TARGET=$(rustc +$TOOLCHAIN --version --verbose | grep "^host:" | cut -d ' ' -f 2)
113 SYSROOT=$(rustc +$TOOLCHAIN --print sysroot)
114 LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
115 if ! test -d "$LIBDIR"; then
116 echo "Something went wrong determining the library dir."
117 echo "I got $LIBDIR but that does not exist."
118 echo "Please report a bug at https://github.com/rust-lang/miri/issues."
122 # Prepare flags for cargo and rustc.
123 CARGO="cargo +$TOOLCHAIN"
124 # Share target dir between `miri` and `cargo-miri`.
125 if [ -z "$CARGO_TARGET_DIR" ]; then
126 export CARGO_TARGET_DIR="$MIRIDIR/target"
128 # We configure dev builds to not be unusably slow.
129 if [ -z "$CARGO_PROFILE_DEV_OPT_LEVEL" ]; then
130 export CARGO_PROFILE_DEV_OPT_LEVEL=2
132 # Enable rustc-specific lints (ignored without `-Zunstable-options`).
133 export RUSTFLAGS="-Zunstable-options -Wrustc::internal $RUSTFLAGS"
134 # We set the rpath so that Miri finds the private rustc libraries it needs.
135 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR $RUSTFLAGS"
139 # Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
141 if ! MIRI_SYSROOT="$($CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup --print-sysroot "$@")"; then
142 echo "'cargo miri setup' failed"
148 # Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
149 # locally built vs. distributed rustc.
151 if [ -n "$MIRI_SYSROOT" ]; then
152 # Sysroot already set, use that.
155 # We need to build a sysroot.
156 if [ -n "$MIRI_TEST_TARGET" ]; then
157 build_sysroot --target "$MIRI_TEST_TARGET"
168 # "--locked" to respect the Cargo.lock file if it exists.
169 $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR" --force --locked "$@"
170 $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked "$@"
173 # Check, and let caller control flags.
174 $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
175 $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
178 # Build, and let caller control flags.
179 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
180 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
183 # First build and get a sysroot.
184 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
186 if [ "$COMMAND" = "bless" ]; then
187 export MIRI_BLESS="Gesundheit"
189 # Then test, and let caller control flags.
190 # Only in root project as `cargo-miri` has no tests.
191 $CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
194 # Scan for "--target" to overwrite the "MIRI_TEST_TARGET" env var so
195 # that we set the MIRI_SYSROOT up the right way.
198 if [ "$LAST_ARG" = "--target" ]; then
200 export MIRI_TEST_TARGET="$ARG"
206 if [ "$FOUND_TARGET_OPT" = "0" ] && [ -n "$MIRI_TEST_TARGET" ]; then
207 # Make sure Miri actually uses this target.
208 MIRIFLAGS="$MIRIFLAGS --target $MIRI_TEST_TARGET"
210 # First build and get a sysroot.
211 $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
213 # Then run the actual command.
214 exec $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml -- $MIRIFLAGS "$@"
217 find "$MIRIDIR" -not \( -name target -prune \) -name '*.rs' \
218 | xargs rustfmt +$TOOLCHAIN --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
221 $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
222 $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
225 # We carefully kept the working dir intact, so this will run cargo *on the workspace in the
226 # current working dir*, not on the main Miri workspace. That is exactly what RA needs.
230 if [ -n "$COMMAND" ]; then
231 echo "Unknown command: $COMMAND"