Auto merge of #2296 - RalfJung:miri-script, r=RalfJung
./miri improvements I have needed to run something with many different seeds often enough that I would like an easier way to do it. ;) So now we have `./miri many-seeds`. Also I made the script less dependent on the working directory, so calling it from a different directory should work properly now even if that other directory does not have the same rustup override as the one where Miri lives.
This commit is contained in:
bors
commit
5815d8d81c
114
miri
114
miri
@ -5,14 +5,14 @@ USAGE=$(cat <<"EOF"
|
||||
|
||||
./miri install <flags>:
|
||||
Installs the miri driver and cargo-miri. <flags> are passed to `cargo
|
||||
install`. Sets up the rpath such that the installed binary should work in any
|
||||
install`. Sets up the rpath such that the installed binary should work in any
|
||||
working directory.
|
||||
|
||||
./miri build <flags>:
|
||||
Just build miri. <flags> are passed to `cargo build`.
|
||||
Just build miri. <flags> are passed to `cargo build`.
|
||||
|
||||
./miri check <flags>:
|
||||
Just check miri. <flags> are passed to `cargo check`.
|
||||
Just check miri. <flags> are passed to `cargo check`.
|
||||
|
||||
./miri test <flags>:
|
||||
Build miri, set up a sysroot and then run the test suite. <flags> are passed
|
||||
@ -20,16 +20,22 @@ to the final `cargo test` invocation.
|
||||
|
||||
./miri run <flags>:
|
||||
Build miri, set up a sysroot and then run the driver with the given <flags>.
|
||||
(Also respects MIRIFLAGS environment variable.)
|
||||
|
||||
The commands above also exist in a "-debug" variant (e.g. "./miri run-debug
|
||||
<flags>") which uses debug builds instead of release builds, for faster build
|
||||
times and slower execution times.
|
||||
|
||||
./miri fmt <flags>:
|
||||
Format all sources and tests. <flags> are passed to `rustfmt`.
|
||||
Format all sources and tests. <flags> are passed to `rustfmt`.
|
||||
|
||||
./miri clippy <flags>:
|
||||
Format all sources and tests. <flags> are passed to `cargo clippy`.
|
||||
Format all sources and tests. <flags> are passed to `cargo clippy`.
|
||||
|
||||
./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.
|
||||
|
||||
ENVIRONMENT VARIABLES
|
||||
|
||||
@ -41,18 +47,39 @@ Pass extra flags to all cargo invocations.
|
||||
EOF
|
||||
)
|
||||
|
||||
# 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
|
||||
MIRIFLAGS="$MIRIFLAGS -Zmiri-seed=$SEED" $@ || { echo "Failing seed: $SEED"; break; }
|
||||
done
|
||||
exit 0
|
||||
;;
|
||||
esac
|
||||
|
||||
## Preparation
|
||||
TARGET=$(rustc --version --verbose | grep "^host:" | cut -d ' ' -f 2)
|
||||
SYSROOT=$(rustc --print sysroot)
|
||||
LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
|
||||
# macOS does not have a useful readlink/realpath so we have to use Python instead...
|
||||
MIRIDIR=$(dirname "$(python3 -c 'import os, sys; print(os.path.realpath(sys.argv[1]))' "$0")")
|
||||
MIRIDIR=$(python3 -c 'import os, sys; print(os.path.dirname(os.path.realpath(sys.argv[1])))' "$0")
|
||||
# Determine toolchain *in the Miri dir* and use that.
|
||||
TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
|
||||
|
||||
# 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
|
||||
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
|
||||
|
||||
# Prepare flags for cargo and rustc.
|
||||
CARGO="cargo +$TOOLCHAIN"
|
||||
if [ -z "$CARGO_INCREMENTAL" ]; then
|
||||
# Default CARGO_INCREMENTAL to 1.
|
||||
export CARGO_INCREMENTAL=1
|
||||
@ -65,18 +92,31 @@ fi
|
||||
# We enable debug-assertions to get tracing.
|
||||
# We enable line-only debuginfo for backtraces.
|
||||
export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR -C debug-assertions -C debuginfo=1 $RUSTFLAGS"
|
||||
# Determine flags passed to all cargo invocations.
|
||||
# This is a bit more annoying that one would hope due to
|
||||
# <https://github.com/rust-lang/cargo/issues/6992>.
|
||||
case "$COMMAND" in
|
||||
*-debug)
|
||||
CARGO_INSTALL_FLAGS="--target $TARGET --debug $CARGO_EXTRA_FLAGS"
|
||||
CARGO_BUILD_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
|
||||
;;
|
||||
*)
|
||||
CARGO_INSTALL_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
|
||||
CARGO_BUILD_FLAGS="--target $TARGET --release $CARGO_EXTRA_FLAGS"
|
||||
;;
|
||||
esac
|
||||
|
||||
## Helper functions
|
||||
|
||||
# Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
|
||||
# Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
|
||||
build_sysroot() {
|
||||
# Build once, for the user to see.
|
||||
cargo run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
|
||||
$CARGO run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
|
||||
# Call again, to just set env var.
|
||||
export MIRI_SYSROOT="$(cargo run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
|
||||
export MIRI_SYSROOT="$($CARGO run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
|
||||
}
|
||||
|
||||
# Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
|
||||
# Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
|
||||
# locally built vs. distributed rustc.
|
||||
find_sysroot() {
|
||||
if [ -n "$MIRI_SYSROOT" ]; then
|
||||
@ -93,45 +133,27 @@ find_sysroot() {
|
||||
|
||||
## Main
|
||||
|
||||
# Determine command.
|
||||
COMMAND="$1"
|
||||
[ $# -gt 0 ] && shift
|
||||
|
||||
# Determine flags passed to all cargo invocations.
|
||||
# This is a bit more annoying that one would hope due to
|
||||
# <https://github.com/rust-lang/cargo/issues/6992>.
|
||||
case "$COMMAND" in
|
||||
*-debug)
|
||||
CARGO_INSTALL_FLAGS="--target $TARGET --debug $CARGO_EXTRA_FLAGS"
|
||||
CARGO_BUILD_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
|
||||
;;
|
||||
*)
|
||||
CARGO_INSTALL_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
|
||||
CARGO_BUILD_FLAGS="--target $TARGET --release $CARGO_EXTRA_FLAGS"
|
||||
;;
|
||||
esac
|
||||
|
||||
# Run command.
|
||||
case "$COMMAND" in
|
||||
install|install-debug)
|
||||
# "--locked" to respect the Cargo.lock file if it exists,
|
||||
# "--offline" to avoid querying the registry (for yanked packages).
|
||||
cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR" --force --locked --offline "$@"
|
||||
cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked --offline "$@"
|
||||
$CARGO install $CARGO_INSTALL_FLAGS --path "$MIRIDIR" --force --locked --offline "$@"
|
||||
$CARGO install $CARGO_INSTALL_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked --offline "$@"
|
||||
;;
|
||||
check|check-debug)
|
||||
# Check, and let caller control flags.
|
||||
cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
|
||||
cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
||||
$CARGO check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
|
||||
$CARGO check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
||||
;;
|
||||
build|build-debug)
|
||||
# Build, and let caller control flags.
|
||||
cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
|
||||
cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
||||
$CARGO build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
|
||||
$CARGO build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
||||
;;
|
||||
test|test-debug|bless|bless-debug)
|
||||
# First build and get a sysroot.
|
||||
cargo build $CARGO_BUILD_FLAGS
|
||||
$CARGO build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
|
||||
find_sysroot
|
||||
case "$COMMAND" in
|
||||
bless|bless-debug)
|
||||
@ -140,8 +162,8 @@ test|test-debug|bless|bless-debug)
|
||||
esac
|
||||
# Then test, and let caller control flags.
|
||||
# Only in root project and ui_test as `cargo-miri` has no tests.
|
||||
cargo test $CARGO_BUILD_FLAGS "$@"
|
||||
cargo test $CARGO_BUILD_FLAGS --manifest-path ui_test/Cargo.toml "$@"
|
||||
$CARGO test $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
|
||||
$CARGO test $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml "$@"
|
||||
;;
|
||||
run|run-debug)
|
||||
# Scan for "--target" to set the "MIRI_TEST_TARGET" env var so
|
||||
@ -157,19 +179,19 @@ run|run-debug)
|
||||
done
|
||||
fi
|
||||
# First build and get a sysroot.
|
||||
cargo build $CARGO_BUILD_FLAGS
|
||||
$CARGO build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
|
||||
find_sysroot
|
||||
# Then run the actual command.
|
||||
exec cargo run $CARGO_BUILD_FLAGS -- --sysroot "$MIRI_SYSROOT" "$@"
|
||||
exec $CARGO run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml -- --sysroot "$MIRI_SYSROOT" $MIRIFLAGS "$@"
|
||||
;;
|
||||
fmt)
|
||||
find "$MIRIDIR" -not \( -name target -prune \) -name '*.rs' \
|
||||
| xargs rustfmt --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
|
||||
| xargs rustfmt +$TOOLCHAIN --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
|
||||
;;
|
||||
clippy)
|
||||
cargo clippy $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
|
||||
cargo clippy $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml --all-targets "$@"
|
||||
cargo clippy $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
||||
$CARGO clippy $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
|
||||
$CARGO clippy $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml --all-targets "$@"
|
||||
$CARGO clippy $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
||||
;;
|
||||
*)
|
||||
if [ -n "$COMMAND" ]; then
|
||||
|
||||
Loading…
Reference in New Issue
Block a user