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
|
|
|
|
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`.
|
|
|
|
|
2020-03-21 11:43:28 -05:00
|
|
|
./miri check <flags>:
|
|
|
|
Just check miri. <flags> are passed to `cargo check`.
|
|
|
|
|
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-06-22 07:00:07 -05:00
|
|
|
The commands above also exist in a "-debug" variant (e.g. "./miri run-debug
|
2019-05-29 02:36:59 -05:00
|
|
|
<flags>") which uses debug builds instead of release builds, for faster build
|
|
|
|
times and slower execution times.
|
|
|
|
|
2022-06-22 07:00:07 -05:00
|
|
|
./miri fmt <flags>:
|
|
|
|
Format all sources and tests. <flags> are passed to `rustfmt`.
|
|
|
|
|
2022-06-29 17:14:41 -05:00
|
|
|
./miri clippy <flags>:
|
|
|
|
Format all sources and tests. <flags> are passed to `cargo clippy`.
|
|
|
|
|
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
|
|
|
|
|
|
|
## Preparation
|
2019-05-29 02:39:49 -05:00
|
|
|
TARGET=$(rustc --version --verbose | grep "^host:" | cut -d ' ' -f 2)
|
2019-05-27 05:51:59 -05:00
|
|
|
SYSROOT=$(rustc --print sysroot)
|
2019-05-29 02:39:49 -05:00
|
|
|
LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
|
2021-12-20 16:14:17 -06:00
|
|
|
# macOS does not have a useful readlink/realpath so we have to use Python instead...
|
2022-05-10 05:14:47 -05:00
|
|
|
MIRIDIR=$(dirname "$(python3 -c 'import os, sys; print(os.path.realpath(sys.argv[1]))' "$0")")
|
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
|
2020-04-02 02:49:48 -05:00
|
|
|
if [ -z "$CARGO_INCREMENTAL" ]; then
|
|
|
|
# Default CARGO_INCREMENTAL to 1.
|
|
|
|
export CARGO_INCREMENTAL=1
|
|
|
|
fi
|
2020-05-21 07:18:18 -05:00
|
|
|
if [ -z "$CARGO_TARGET_DIR" ]; then
|
|
|
|
# Share target dir between `miri` and `cargo-miri`.
|
2020-09-06 12:28:29 -05:00
|
|
|
export CARGO_TARGET_DIR="$MIRIDIR/target"
|
2020-05-21 07:18:18 -05:00
|
|
|
fi
|
2020-05-21 04:23:04 -05:00
|
|
|
# We set the rpath so that Miri finds the private rustc libraries it needs.
|
|
|
|
# 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"
|
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
|
|
|
|
2019-05-27 07:40:27 -05:00
|
|
|
# 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.
|
2020-09-06 12:28:29 -05:00
|
|
|
cargo run $CARGO_BUILD_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.
|
2020-09-06 12:28:29 -05:00
|
|
|
export MIRI_SYSROOT="$(cargo run $CARGO_BUILD_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
|
|
|
|
2019-05-27 07:40:27 -05:00
|
|
|
# Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
|
|
|
|
# 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
|
|
|
# Determine command.
|
2019-05-27 07:40:27 -05:00
|
|
|
COMMAND="$1"
|
2019-06-27 20:46:24 -05:00
|
|
|
[ $# -gt 0 ] && shift
|
2019-05-27 05:51:59 -05:00
|
|
|
|
2019-05-28 12:01:43 -05:00
|
|
|
# Determine flags passed to all cargo invocations.
|
2019-05-28 12:04:31 -05:00
|
|
|
# This is a bit more annoying that one would hope due to
|
|
|
|
# <https://github.com/rust-lang/cargo/issues/6992>.
|
2019-05-27 07:40:27 -05:00
|
|
|
case "$COMMAND" in
|
2019-05-28 12:01:43 -05:00
|
|
|
*-debug)
|
2020-07-03 04:18:44 -05:00
|
|
|
CARGO_INSTALL_FLAGS="--target $TARGET --debug $CARGO_EXTRA_FLAGS"
|
|
|
|
CARGO_BUILD_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
|
2019-05-28 12:01:43 -05:00
|
|
|
;;
|
|
|
|
*)
|
2020-07-03 04:18:44 -05:00
|
|
|
CARGO_INSTALL_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
|
|
|
|
CARGO_BUILD_FLAGS="--target $TARGET --release $CARGO_EXTRA_FLAGS"
|
2019-05-28 12:01:43 -05:00
|
|
|
;;
|
|
|
|
esac
|
|
|
|
|
|
|
|
# Run command.
|
|
|
|
case "$COMMAND" in
|
|
|
|
install|install-debug)
|
2019-05-27 07:40:27 -05:00
|
|
|
# "--locked" to respect the Cargo.lock file if it exists,
|
|
|
|
# "--offline" to avoid querying the registry (for yanked packages).
|
2020-09-06 12:28:29 -05:00
|
|
|
cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR" --force --locked --offline "$@"
|
|
|
|
cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked --offline "$@"
|
2019-05-27 07:40:27 -05:00
|
|
|
;;
|
2020-03-21 11:43:28 -05:00
|
|
|
check|check-debug)
|
|
|
|
# Check, and let caller control flags.
|
2022-05-30 05:20:12 -05:00
|
|
|
cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
|
2020-09-06 12:28:29 -05:00
|
|
|
cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
2020-03-21 11:43:28 -05:00
|
|
|
;;
|
2019-05-28 12:01:43 -05:00
|
|
|
build|build-debug)
|
2019-05-27 07:40:27 -05:00
|
|
|
# Build, and let caller control flags.
|
2020-09-06 12:28:29 -05:00
|
|
|
cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
|
|
|
|
cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
|
2019-05-28 12:01:43 -05:00
|
|
|
;;
|
2022-03-17 08:49:10 -05:00
|
|
|
test|test-debug|bless|bless-debug)
|
2019-05-28 12:01:43 -05:00
|
|
|
# First build and get a sysroot.
|
|
|
|
cargo build $CARGO_BUILD_FLAGS
|
|
|
|
find_sysroot
|
2022-03-17 08:49:10 -05:00
|
|
|
case "$COMMAND" in
|
|
|
|
bless|bless-debug)
|
|
|
|
export MIRI_BLESS="Gesundheit"
|
|
|
|
;;
|
|
|
|
esac
|
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-05-25 12:48:03 -05:00
|
|
|
cargo test $CARGO_BUILD_FLAGS "$@"
|
2022-05-30 02:26:47 -05:00
|
|
|
cargo test $CARGO_BUILD_FLAGS --manifest-path ui_test/Cargo.toml "$@"
|
2019-05-27 07:40:27 -05:00
|
|
|
;;
|
2019-05-28 12:01:43 -05:00
|
|
|
run|run-debug)
|
|
|
|
# Scan for "--target" to set 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.
|
2019-05-28 12:01:43 -05:00
|
|
|
if [ -z "$MIRI_TEST_TARGET" ]; then
|
2019-05-27 07:40:27 -05:00
|
|
|
for ARG in "$@"; do
|
|
|
|
if [ "$LAST_ARG" = "--target" ]; then
|
|
|
|
# Found it!
|
|
|
|
export MIRI_TEST_TARGET="$ARG"
|
|
|
|
break
|
|
|
|
fi
|
|
|
|
LAST_ARG="$ARG"
|
|
|
|
done
|
|
|
|
fi
|
|
|
|
# First build and get a sysroot.
|
2019-05-28 12:01:43 -05:00
|
|
|
cargo build $CARGO_BUILD_FLAGS
|
2019-05-27 07:40:27 -05:00
|
|
|
find_sysroot
|
|
|
|
# Then run the actual command.
|
2019-06-09 10:10:04 -05:00
|
|
|
exec cargo run $CARGO_BUILD_FLAGS -- --sysroot "$MIRI_SYSROOT" "$@"
|
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' \
|
|
|
|
| xargs rustfmt --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
|
|
|
|
;;
|
2022-06-29 17:14:41 -05:00
|
|
|
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 "$@"
|
|
|
|
;;
|
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
|