2020-10-27 08:21:59 -05:00
|
|
|
#!/bin/bash
|
2019-05-29 02:36:59 -05:00
|
|
|
set -e
|
|
|
|
USAGE=$(cat <<"EOF"
|
|
|
|
COMMANDS
|
|
|
|
|
|
|
|
./miri install <flags>:
|
|
|
|
Installs the miri driver and cargo-miri. <flags> are passed to `cargo
|
2022-07-01 06:53:17 -05:00
|
|
|
install`. Sets up the rpath such that the installed binary should work in any
|
2022-07-14 12:08:09 -05:00
|
|
|
working directory. However, the rustup toolchain when invoking `cargo miri`
|
|
|
|
needs to be the same one used for `./miri install`.
|
2019-05-29 02:36:59 -05:00
|
|
|
|
|
|
|
./miri build <flags>:
|
2022-07-01 06:53:17 -05:00
|
|
|
Just build miri. <flags> are passed to `cargo build`.
|
2019-05-29 02:36:59 -05:00
|
|
|
|
2020-03-21 11:43:28 -05:00
|
|
|
./miri check <flags>:
|
2022-07-01 06:53:17 -05:00
|
|
|
Just check miri. <flags> are passed to `cargo check`.
|
2020-03-21 11:43:28 -05:00
|
|
|
|
2019-05-29 02:36:59 -05:00
|
|
|
./miri test <flags>:
|
|
|
|
Build miri, set up a sysroot and then run the test suite. <flags> are passed
|
|
|
|
to the final `cargo test` invocation.
|
|
|
|
|
|
|
|
./miri run <flags>:
|
|
|
|
Build miri, set up a sysroot and then run the driver with the given <flags>.
|
2022-07-01 08:55:02 -05:00
|
|
|
(Also respects MIRIFLAGS environment variable.)
|
2019-05-29 02:36:59 -05:00
|
|
|
|
2022-06-22 07:00:07 -05:00
|
|
|
./miri fmt <flags>:
|
2022-07-01 06:53:17 -05:00
|
|
|
Format all sources and tests. <flags> are passed to `rustfmt`.
|
2022-06-22 07:00:07 -05:00
|
|
|
|
2022-06-29 17:14:41 -05:00
|
|
|
./miri clippy <flags>:
|
2022-07-07 07:20:24 -05:00
|
|
|
Runs clippy on all sources. <flags> are passed to `cargo clippy`.
|
2022-06-29 17:14:41 -05:00
|
|
|
|
2022-07-01 08:55:02 -05:00
|
|
|
./miri many-seeds <command>:
|
|
|
|
Runs <command> over and over again with different seeds for Miri. The MIRIFLAGS
|
|
|
|
variable is set to its original value appended with ` -Zmiri-seed=$SEED` for
|
|
|
|
many different seeds.
|
|
|
|
|
2022-07-04 14:15:23 -05:00
|
|
|
./miri bench <benches>:
|
|
|
|
Runs the benchmarks from bench-cargo-miri in hyperfine. hyperfine needs to be installed.
|
|
|
|
<benches> can explicitly list the benchmarks to run; by default, all of them are run.
|
|
|
|
|
2019-05-29 02:36:59 -05:00
|
|
|
ENVIRONMENT VARIABLES
|
|
|
|
|
|
|
|
MIRI_SYSROOT:
|
|
|
|
If already set, the "sysroot setup" step is skipped.
|
|
|
|
|
|
|
|
CARGO_EXTRA_FLAGS:
|
|
|
|
Pass extra flags to all cargo invocations.
|
|
|
|
EOF
|
|
|
|
)
|
2019-05-28 12:01:43 -05:00
|
|
|
|
2022-07-20 07:38:27 -05:00
|
|
|
## Run the subcommands that the user requested to always run first
|
|
|
|
if [ -z "$AUTO_OPS" ]; then
|
|
|
|
export AUTO_OPS=42
|
|
|
|
|
|
|
|
# Run this first, so that the toolchain doesn't change after
|
|
|
|
# other code has run.
|
|
|
|
if [ -f ".auto-everything" ] || [ -f ".auto-toolchain" ] ; then
|
|
|
|
"$MIRIDIR"/rustup-toolchain
|
|
|
|
fi
|
|
|
|
|
|
|
|
if [ -f ".auto-everything" ] || [ -f ".auto-fmt" ] ; then
|
|
|
|
$0 fmt
|
|
|
|
fi
|
|
|
|
|
|
|
|
if [ -f ".auto-everything" ] || [ -f ".auto-clippy" ] ; then
|
|
|
|
$0 clippy -- -D warnings
|
|
|
|
fi
|
|
|
|
fi
|
|
|
|
|
2022-07-04 14:15:23 -05:00
|
|
|
## Preparation
|
|
|
|
# macOS does not have a useful readlink/realpath so we have to use Python instead...
|
|
|
|
MIRIDIR=$(python3 -c 'import os, sys; print(os.path.dirname(os.path.realpath(sys.argv[1])))' "$0")
|
|
|
|
TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
|
|
|
|
|
2022-07-01 08:55:02 -05:00
|
|
|
# Determine command.
|
|
|
|
COMMAND="$1"
|
|
|
|
[ $# -gt 0 ] && shift
|
|
|
|
|
|
|
|
## Handle some commands early, since they should *not* alter the environment.
|
|
|
|
case "$COMMAND" in
|
|
|
|
many-seeds)
|
|
|
|
for SEED in $({ echo obase=16; seq 0 255; } | bc); do
|
2022-07-02 15:06:23 -05:00
|
|
|
echo "Trying seed: $SEED"
|
2022-07-01 08:55:02 -05:00
|
|
|
MIRIFLAGS="$MIRIFLAGS -Zmiri-seed=$SEED" $@ || { echo "Failing seed: $SEED"; break; }
|
|
|
|
done
|
|
|
|
exit 0
|
|
|
|
;;
|
2022-07-04 14:15:23 -05:00
|
|
|
bench)
|
|
|
|
# Make sure we have an up-to-date Miri installed
|
|
|
|
"$0" install
|
|
|
|
# Run the requested benchmarks
|
|
|
|
if [ -z "$@" ]; then
|
|
|
|
BENCHES=( $(ls "$MIRIDIR/bench-cargo-miri" ) )
|
|
|
|
else
|
|
|
|
BENCHES=("$@")
|
|
|
|
fi
|
|
|
|
for BENCH in "${BENCHES[@]}"; do
|
|
|
|
hyperfine -w 1 -m 5 --shell=none "cargo +$TOOLCHAIN miri run --manifest-path bench-cargo-miri/$BENCH/Cargo.toml"
|
|
|
|
done
|
|
|
|
exit 0
|
|
|
|
;;
|
2022-07-01 08:55:02 -05:00
|
|
|
esac
|
|
|
|
|
2022-07-04 14:15:23 -05:00
|
|
|
## Prepare the environment
|
2022-07-01 06:53:17 -05:00
|
|
|
# Determine some toolchain properties
|
|
|
|
TARGET=$(rustc +$TOOLCHAIN --version --verbose | grep "^host:" | cut -d ' ' -f 2)
|
|
|
|
SYSROOT=$(rustc +$TOOLCHAIN --print sysroot)
|
|
|
|
LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
|
2019-05-29 02:39:49 -05:00
|
|
|
if ! test -d "$LIBDIR"; then
|
|
|
|
echo "Something went wrong determining the library dir."
|
|
|
|
echo "I got $LIBDIR but that does not exist."
|
|
|
|
echo "Please report a bug at https://github.com/rust-lang/miri/issues."
|
|
|
|
exit 2
|
|
|
|
fi
|
2022-07-01 06:53:17 -05:00
|
|
|
|
2022-07-01 09:01:00 -05:00
|
|
|
# Prepare flags for cargo and rustc.
|
2022-07-01 06:53:17 -05:00
|
|
|
CARGO="cargo +$TOOLCHAIN"
|
2022-07-18 16:47:32 -05:00
|
|
|
# Share target dir between `miri` and `cargo-miri`.
|
2020-05-21 07:18:18 -05:00
|
|
|
if [ -z "$CARGO_TARGET_DIR" ]; then
|
2020-09-06 12:28:29 -05:00
|
|
|
export CARGO_TARGET_DIR="$MIRIDIR/target"
|
2020-05-21 07:18:18 -05:00
|
|
|
fi
|
2022-07-18 16:47:32 -05:00
|
|
|
# We configure dev builds to not be unusably slow.
|
|
|
|
if [ -z "$CARGO_PROFILE_DEV_OPT_LEVEL" ]; then
|
|
|
|
export CARGO_PROFILE_DEV_OPT_LEVEL=2
|
|
|
|
fi
|
2020-05-21 04:23:04 -05:00
|
|
|
# We set the rpath so that Miri finds the private rustc libraries it needs.
|
2022-07-13 18:22:22 -05:00
|
|
|
export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR $RUSTFLAGS"
|
2019-05-27 05:51:59 -05:00
|
|
|
|
2019-05-27 07:40:27 -05:00
|
|
|
## Helper functions
|
2019-05-27 05:51:59 -05:00
|
|
|
|
2022-07-01 06:53:17 -05:00
|
|
|
# Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
|
2019-05-27 07:40:27 -05:00
|
|
|
build_sysroot() {
|
|
|
|
# Build once, for the user to see.
|
2022-07-14 12:08:09 -05:00
|
|
|
$CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
|
2019-05-27 07:40:27 -05:00
|
|
|
# Call again, to just set env var.
|
2022-07-14 12:08:09 -05:00
|
|
|
export MIRI_SYSROOT="$($CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
|
2019-05-27 07:40:27 -05:00
|
|
|
}
|
2019-05-27 05:51:59 -05:00
|
|
|
|
2022-07-01 06:53:17 -05:00
|
|
|
# Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
|
2019-05-27 07:40:27 -05:00
|
|
|
# locally built vs. distributed rustc.
|
|
|
|
find_sysroot() {
|
2019-05-27 05:51:59 -05:00
|
|
|
if [ -n "$MIRI_SYSROOT" ]; then
|
2019-05-27 07:40:27 -05:00
|
|
|
# Sysroot already set, use that.
|
2019-08-09 04:29:10 -05:00
|
|
|
return 0
|
|
|
|
fi
|
|
|
|
# We need to build a sysroot.
|
|
|
|
if [ -n "$MIRI_TEST_TARGET" ]; then
|
|
|
|
build_sysroot --target "$MIRI_TEST_TARGET"
|
2019-05-27 05:51:59 -05:00
|
|
|
else
|
2019-08-09 04:29:10 -05:00
|
|
|
build_sysroot
|
2019-05-27 05:51:59 -05:00
|
|
|
fi
|
2019-05-27 07:40:27 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
## Main
|
|
|
|
|
2019-05-28 12:01:43 -05:00
|
|
|
# Run command.
|
|
|
|
case "$COMMAND" in
|
2022-07-14 12:08:09 -05:00
|
|
|
install)
|
2022-07-17 02:46:02 -05:00
|
|
|
# "--locked" to respect the Cargo.lock file if it exists.
|
|
|
|
$CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR" --force --locked "$@"
|
|
|
|
$CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked "$@"
|
2019-05-27 07:40:27 -05:00
|
|
|
;;
|
2022-07-14 12:08:09 -05:00
|
|
|
check)
|
2020-03-21 11:43:28 -05:00
|
|
|
# Check, and let caller control flags.
|
2022-07-14 12:08:09 -05:00
|
|
|
$CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
|
|
|
|
$CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
2020-03-21 11:43:28 -05:00
|
|
|
;;
|
2022-07-14 12:08:09 -05:00
|
|
|
build)
|
2019-05-27 07:40:27 -05:00
|
|
|
# Build, and let caller control flags.
|
2022-07-14 12:08:09 -05:00
|
|
|
$CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
|
|
|
|
$CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
2019-05-28 12:01:43 -05:00
|
|
|
;;
|
2022-07-14 12:08:09 -05:00
|
|
|
test|bless)
|
2019-05-28 12:01:43 -05:00
|
|
|
# First build and get a sysroot.
|
2022-07-14 12:08:09 -05:00
|
|
|
$CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
|
2019-05-28 12:01:43 -05:00
|
|
|
find_sysroot
|
2022-07-14 12:08:09 -05:00
|
|
|
if [ "$COMMAND" = "bless" ]; then
|
2022-03-17 08:49:10 -05:00
|
|
|
export MIRI_BLESS="Gesundheit"
|
2022-07-14 12:08:09 -05:00
|
|
|
fi
|
2019-05-28 12:01:43 -05:00
|
|
|
# Then test, and let caller control flags.
|
2022-05-27 06:43:14 -05:00
|
|
|
# Only in root project and ui_test as `cargo-miri` has no tests.
|
2022-07-14 12:08:09 -05:00
|
|
|
$CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
|
|
|
|
$CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml "$@"
|
2019-05-27 07:40:27 -05:00
|
|
|
;;
|
2022-07-14 12:08:09 -05:00
|
|
|
run)
|
2022-07-03 07:35:44 -05:00
|
|
|
# Scan for "--target" to overwrite the "MIRI_TEST_TARGET" env var so
|
2019-05-27 07:40:27 -05:00
|
|
|
# that we set the MIRI_SYSROOT up the right way.
|
2022-07-03 07:35:44 -05:00
|
|
|
FOUND_TARGET_OPT=0
|
|
|
|
for ARG in "$@"; do
|
|
|
|
if [ "$LAST_ARG" = "--target" ]; then
|
|
|
|
# Found it!
|
|
|
|
export MIRI_TEST_TARGET="$ARG"
|
|
|
|
FOUND_TARGET_OPT=1
|
|
|
|
break
|
|
|
|
fi
|
|
|
|
LAST_ARG="$ARG"
|
|
|
|
done
|
|
|
|
if [ "$FOUND_TARGET_OPT" = "0" ] && [ -n "$MIRI_TEST_TARGET" ]; then
|
|
|
|
# Make sure Miri actually uses this target.
|
|
|
|
MIRIFLAGS="$MIRIFLAGS --target $MIRI_TEST_TARGET"
|
2019-05-27 07:40:27 -05:00
|
|
|
fi
|
|
|
|
# First build and get a sysroot.
|
2022-07-14 12:08:09 -05:00
|
|
|
$CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
|
2019-05-27 07:40:27 -05:00
|
|
|
find_sysroot
|
|
|
|
# Then run the actual command.
|
2022-07-14 12:08:09 -05:00
|
|
|
exec $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml -- --sysroot "$MIRI_SYSROOT" $MIRIFLAGS "$@"
|
2019-05-27 05:51:59 -05:00
|
|
|
;;
|
2022-06-22 07:00:07 -05:00
|
|
|
fmt)
|
|
|
|
find "$MIRIDIR" -not \( -name target -prune \) -name '*.rs' \
|
2022-07-01 06:53:17 -05:00
|
|
|
| xargs rustfmt +$TOOLCHAIN --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
|
2022-06-22 07:00:07 -05:00
|
|
|
;;
|
2022-06-29 17:14:41 -05:00
|
|
|
clippy)
|
2022-07-14 12:08:09 -05:00
|
|
|
$CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
|
|
|
|
$CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml --all-targets "$@"
|
|
|
|
$CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
2022-06-29 17:14:41 -05:00
|
|
|
;;
|
2019-05-29 02:36:59 -05:00
|
|
|
*)
|
2020-04-06 02:34:27 -05:00
|
|
|
if [ -n "$COMMAND" ]; then
|
|
|
|
echo "Unknown command: $COMMAND"
|
|
|
|
echo
|
|
|
|
fi
|
2019-05-29 02:36:59 -05:00
|
|
|
echo "$USAGE"
|
|
|
|
exit 1
|
2019-05-27 05:51:59 -05:00
|
|
|
esac
|