Replace all //error-pattern comments with strict syntax and fix other comments in...

[rust.git] / miri

diff --git a/miri b/miri
index 0d3d361af2face1f80aac1c5b544754bc0d6cb97..be51535d59bf326c80c2f0ac64297d4ec4afc428 100755 (executable)
--- a/miri
+++ b/miri
@@ -30,13 +30,17 @@ times and slower execution times.
 Format all sources and tests. <flags> are passed to `rustfmt`.
 
 ./miri clippy <flags>:
-Format all sources and tests. <flags> are passed to `cargo clippy`.
+Runs clippy on all sources. <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.
 
+./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.
+
   ENVIRONMENT VARIABLES
 
 MIRI_SYSROOT:
@@ -47,6 +51,11 @@ Pass extra flags to all cargo invocations.
 EOF
 )
 
+## 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)
+
 # Determine command.
 COMMAND="$1"
 [ $# -gt 0 ] && shift
@@ -55,22 +64,32 @@ COMMAND="$1"
 case "$COMMAND" in
 many-seeds)
     for SEED in $({ echo obase=16; seq 0 255; } | bc); do
+        echo "Trying seed: $SEED"
         MIRIFLAGS="$MIRIFLAGS -Zmiri-seed=$SEED" $@ || { echo "Failing seed: $SEED"; break; }
     done
     exit 0
     ;;
+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
+    ;;
 esac
 
-## Preparation
-# 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")")
-# Determine toolchain *in the Miri dir* and use that.
-TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
+## Prepare the environment
 # 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."
@@ -78,6 +97,7 @@ if ! test -d "$LIBDIR"; then
     exit 2
 fi
 
+# Prepare flags for cargo and rustc.
 CARGO="cargo +$TOOLCHAIN"
 if [ -z "$CARGO_INCREMENTAL" ]; then
     # Default CARGO_INCREMENTAL to 1.
@@ -91,6 +111,19 @@ 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
 
@@ -119,20 +152,6 @@ find_sysroot() {
 
 ## Main
 
-# 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)
@@ -162,21 +181,25 @@ 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 --manifest-path "$MIRIDIR"/Cargo.toml "$@"
     $CARGO test $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml "$@"
+    $CARGO test $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
     ;;
 run|run-debug)
-    # Scan for "--target" to set the "MIRI_TEST_TARGET" env var so
+    # Scan for "--target" to overwrite the "MIRI_TEST_TARGET" env var so
     # that we set the MIRI_SYSROOT up the right way.
-    if [ -z "$MIRI_TEST_TARGET" ]; then
-        for ARG in "$@"; do
-            if [ "$LAST_ARG" = "--target" ]; then
-                # Found it!
-                export MIRI_TEST_TARGET="$ARG"
-                break
-            fi
-            LAST_ARG="$ARG"
-        done
+    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"
     fi
     # First build and get a sysroot.
     $CARGO build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml