miri

   1 #!/bin/bash
   2 set -e
   3 USAGE=$(cat <<"EOF"
   4   COMMANDS
   5
   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`.
  11
  12 ./miri build <flags>:
  13 Just build miri. <flags> are passed to `cargo build`.
  14
  15 ./miri check <flags>:
  16 Just check miri. <flags> are passed to `cargo check`.
  17
  18 ./miri test <flags>:
  19 Build miri, set up a sysroot and then run the test suite. <flags> are passed
  20 to the final `cargo test` invocation.
  21
  22 ./miri run <flags>:
  23 Build miri, set up a sysroot and then run the driver with the given <flags>.
  24 (Also respects MIRIFLAGS environment variable.)
  25
  26 ./miri fmt <flags>:
  27 Format all sources and tests. <flags> are passed to `rustfmt`.
  28
  29 ./miri clippy <flags>:
  30 Runs clippy on all sources. <flags> are passed to `cargo clippy`.
  31
  32 ./miri many-seeds <command>:
  33 Runs <command> over and over again with different seeds for Miri. The MIRIFLAGS
  34 variable is set to its original value appended with ` -Zmiri-seed=$SEED` for
  35 many different seeds.
  36
  37 ./miri bench <benches>:
  38 Runs the benchmarks from bench-cargo-miri in hyperfine. hyperfine needs to be installed.
  39 <benches> can explicitly list the benchmarks to run; by default, all of them are run.
  40
  41   ENVIRONMENT VARIABLES
  42
  43 MIRI_SYSROOT:
  44 If already set, the "sysroot setup" step is skipped.
  45
  46 CARGO_EXTRA_FLAGS:
  47 Pass extra flags to all cargo invocations.
  48 EOF
  49 )
  50
  51 ## We need to know where we are.
  52 # macOS does not have a useful readlink/realpath so we have to use Python instead...
  53 MIRIDIR=$(python3 -c 'import os, sys; print(os.path.dirname(os.path.realpath(sys.argv[1])))' "$0")
  54
  55 ## Run the auto-things.
  56 if [ -z "$MIRI_AUTO_OPS" ]; then
  57     export MIRI_AUTO_OPS=42
  58
  59     # Run this first, so that the toolchain doesn't change after
  60     # other code has run.
  61     if [ -f "$MIRIDIR/.auto-everything" ] || [ -f "$MIRIDIR/.auto-toolchain" ] ; then
  62         (cd "$MIRIDIR" && ./rustup-toolchain)
  63     fi
  64
  65     if [ -f "$MIRIDIR/.auto-everything" ] || [ -f "$MIRIDIR/.auto-fmt" ] ; then
  66         $0 fmt
  67     fi
  68
  69     if [ -f "$MIRIDIR/.auto-everything" ] || [ -f "$MIRIDIR/.auto-clippy" ] ; then
  70         $0 clippy -- -D warnings
  71     fi
  72 fi
  73
  74 ## Determine command and toolchain.
  75 COMMAND="$1"
  76 [ $# -gt 0 ] && shift
  77 # Doing this *after* auto-toolchain logic above, since that might change the toolchain.
  78 TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
  79
  80 ## Handle some commands early, since they should *not* alter the environment.
  81 case "$COMMAND" in
  82 many-seeds)
  83     for SEED in $({ echo obase=16; seq 0 255; } | bc); do
  84         echo "Trying seed: $SEED"
  85         MIRIFLAGS="$MIRIFLAGS -Zmiri-seed=$SEED" $@ || { echo "Failing seed: $SEED"; break; }
  86     done
  87     exit 0
  88     ;;
  89 bench)
  90     # Make sure we have an up-to-date Miri installed
  91     "$0" install
  92     # Run the requested benchmarks
  93     if [ -z "$@" ]; then
  94         BENCHES=( $(ls "$MIRIDIR/bench-cargo-miri" ) )
  95     else
  96         BENCHES=("$@")
  97     fi
  98     for BENCH in "${BENCHES[@]}"; do
  99         hyperfine -w 1 -m 5 --shell=none "cargo +$TOOLCHAIN miri run --manifest-path bench-cargo-miri/$BENCH/Cargo.toml"
 100     done
 101     exit 0
 102     ;;
 103 esac
 104
 105 ## Prepare the environment
 106 # Determine some toolchain properties
 107 TARGET=$(rustc +$TOOLCHAIN --version --verbose | grep "^host:" | cut -d ' ' -f 2)
 108 SYSROOT=$(rustc +$TOOLCHAIN --print sysroot)
 109 LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
 110 if ! test -d "$LIBDIR"; then
 111     echo "Something went wrong determining the library dir."
 112     echo "I got $LIBDIR but that does not exist."
 113     echo "Please report a bug at https://github.com/rust-lang/miri/issues."
 114     exit 2
 115 fi
 116
 117 # Prepare flags for cargo and rustc.
 118 CARGO="cargo +$TOOLCHAIN"
 119 # Share target dir between `miri` and `cargo-miri`.
 120 if [ -z "$CARGO_TARGET_DIR" ]; then
 121     export CARGO_TARGET_DIR="$MIRIDIR/target"
 122 fi
 123 # We configure dev builds to not be unusably slow.
 124 if [ -z "$CARGO_PROFILE_DEV_OPT_LEVEL" ]; then
 125     export CARGO_PROFILE_DEV_OPT_LEVEL=2
 126 fi
 127 # We set the rpath so that Miri finds the private rustc libraries it needs.
 128 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR $RUSTFLAGS"
 129
 130 ## Helper functions
 131
 132 # Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
 133 build_sysroot() {
 134     # Build once, for the user to see.
 135     $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
 136     # Call again, to just set env var.
 137     export MIRI_SYSROOT="$($CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
 138 }
 139
 140 # Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
 141 # locally built vs. distributed rustc.
 142 find_sysroot() {
 143     if [ -n "$MIRI_SYSROOT" ]; then
 144         # Sysroot already set, use that.
 145         return 0
 146     fi
 147     # We need to build a sysroot.
 148     if [ -n "$MIRI_TEST_TARGET" ]; then
 149         build_sysroot --target "$MIRI_TEST_TARGET"
 150     else
 151         build_sysroot
 152     fi
 153 }
 154
 155 ## Main
 156
 157 # Run command.
 158 case "$COMMAND" in
 159 install)
 160     # "--locked" to respect the Cargo.lock file if it exists.
 161     $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR" --force --locked "$@"
 162     $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked "$@"
 163     ;;
 164 check)
 165     # Check, and let caller control flags.
 166     $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
 167     $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
 168     ;;
 169 build)
 170     # Build, and let caller control flags.
 171     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
 172     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
 173     ;;
 174 test|bless)
 175     # First build and get a sysroot.
 176     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
 177     find_sysroot
 178     if [ "$COMMAND" = "bless" ]; then
 179         export MIRI_BLESS="Gesundheit"
 180     fi
 181     # Then test, and let caller control flags.
 182     # Only in root project and ui_test as `cargo-miri` has no tests.
 183     $CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
 184     $CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml "$@"
 185     ;;
 186 run)
 187     # Scan for "--target" to overwrite the "MIRI_TEST_TARGET" env var so
 188     # that we set the MIRI_SYSROOT up the right way.
 189     FOUND_TARGET_OPT=0
 190     for ARG in "$@"; do
 191         if [ "$LAST_ARG" = "--target" ]; then
 192             # Found it!
 193             export MIRI_TEST_TARGET="$ARG"
 194             FOUND_TARGET_OPT=1
 195             break
 196         fi
 197         LAST_ARG="$ARG"
 198     done
 199     if [ "$FOUND_TARGET_OPT" = "0" ] && [ -n "$MIRI_TEST_TARGET" ]; then
 200         # Make sure Miri actually uses this target.
 201         MIRIFLAGS="$MIRIFLAGS --target $MIRI_TEST_TARGET"
 202     fi
 203     # First build and get a sysroot.
 204     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
 205     find_sysroot
 206     # Then run the actual command.
 207     exec $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml -- --sysroot "$MIRI_SYSROOT" $MIRIFLAGS "$@"
 208     ;;
 209 fmt)
 210     find "$MIRIDIR" -not \( -name target -prune \) -name '*.rs' \
 211         | xargs rustfmt +$TOOLCHAIN --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
 212     ;;
 213 clippy)
 214     $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
 215     $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml --all-targets "$@"
 216     $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
 217     ;;
 218 *)
 219     if [ -n "$COMMAND" ]; then
 220       echo "Unknown command: $COMMAND"
 221       echo
 222     fi
 223     echo "$USAGE"
 224     exit 1
 225 esac