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 ## Preparation
  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 TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
  55
  56 # Determine command.
  57 COMMAND="$1"
  58 [ $# -gt 0 ] && shift
  59
  60 ## Handle some commands early, since they should *not* alter the environment.
  61 case "$COMMAND" in
  62 many-seeds)
  63     for SEED in $({ echo obase=16; seq 0 255; } | bc); do
  64         echo "Trying seed: $SEED"
  65         MIRIFLAGS="$MIRIFLAGS -Zmiri-seed=$SEED" $@ || { echo "Failing seed: $SEED"; break; }
  66     done
  67     exit 0
  68     ;;
  69 bench)
  70     # Make sure we have an up-to-date Miri installed
  71     "$0" install
  72     # Run the requested benchmarks
  73     if [ -z "$@" ]; then
  74         BENCHES=( $(ls "$MIRIDIR/bench-cargo-miri" ) )
  75     else
  76         BENCHES=("$@")
  77     fi
  78     for BENCH in "${BENCHES[@]}"; do
  79         hyperfine -w 1 -m 5 --shell=none "cargo +$TOOLCHAIN miri run --manifest-path bench-cargo-miri/$BENCH/Cargo.toml"
  80     done
  81     exit 0
  82     ;;
  83 esac
  84
  85 ## Prepare the environment
  86 # Determine some toolchain properties
  87 TARGET=$(rustc +$TOOLCHAIN --version --verbose | grep "^host:" | cut -d ' ' -f 2)
  88 SYSROOT=$(rustc +$TOOLCHAIN --print sysroot)
  89 LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
  90 if ! test -d "$LIBDIR"; then
  91     echo "Something went wrong determining the library dir."
  92     echo "I got $LIBDIR but that does not exist."
  93     echo "Please report a bug at https://github.com/rust-lang/miri/issues."
  94     exit 2
  95 fi
  96
  97 # Prepare flags for cargo and rustc.
  98 CARGO="cargo +$TOOLCHAIN"
  99 if [ -z "$CARGO_TARGET_DIR" ]; then
 100     # Share target dir between `miri` and `cargo-miri`.
 101     export CARGO_TARGET_DIR="$MIRIDIR/target"
 102 fi
 103 # We set the rpath so that Miri finds the private rustc libraries it needs.
 104 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR $RUSTFLAGS"
 105
 106 ## Helper functions
 107
 108 # Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
 109 build_sysroot() {
 110     # Build once, for the user to see.
 111     $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
 112     # Call again, to just set env var.
 113     export MIRI_SYSROOT="$($CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
 114 }
 115
 116 # Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
 117 # locally built vs. distributed rustc.
 118 find_sysroot() {
 119     if [ -n "$MIRI_SYSROOT" ]; then
 120         # Sysroot already set, use that.
 121         return 0
 122     fi
 123     # We need to build a sysroot.
 124     if [ -n "$MIRI_TEST_TARGET" ]; then
 125         build_sysroot --target "$MIRI_TEST_TARGET"
 126     else
 127         build_sysroot
 128     fi
 129 }
 130
 131 ## Main
 132
 133 # Run command.
 134 case "$COMMAND" in
 135 install)
 136     # "--locked" to respect the Cargo.lock file if it exists,
 137     # "--offline" to avoid querying the registry (for yanked packages).
 138     $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR" --force --locked --offline "$@"
 139     $CARGO install $CARGO_EXTRA_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked --offline "$@"
 140     ;;
 141 check)
 142     # Check, and let caller control flags.
 143     $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
 144     $CARGO check $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
 145     ;;
 146 build)
 147     # Build, and let caller control flags.
 148     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
 149     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
 150     ;;
 151 test|bless)
 152     # First build and get a sysroot.
 153     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
 154     find_sysroot
 155     if [ "$COMMAND" = "bless" ]; then
 156         export MIRI_BLESS="Gesundheit"
 157     fi
 158     # Then test, and let caller control flags.
 159     # Only in root project and ui_test as `cargo-miri` has no tests.
 160     $CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
 161     $CARGO test $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml "$@"
 162     ;;
 163 run)
 164     # Scan for "--target" to overwrite the "MIRI_TEST_TARGET" env var so
 165     # that we set the MIRI_SYSROOT up the right way.
 166     FOUND_TARGET_OPT=0
 167     for ARG in "$@"; do
 168         if [ "$LAST_ARG" = "--target" ]; then
 169             # Found it!
 170             export MIRI_TEST_TARGET="$ARG"
 171             FOUND_TARGET_OPT=1
 172             break
 173         fi
 174         LAST_ARG="$ARG"
 175     done
 176     if [ "$FOUND_TARGET_OPT" = "0" ] && [ -n "$MIRI_TEST_TARGET" ]; then
 177         # Make sure Miri actually uses this target.
 178         MIRIFLAGS="$MIRIFLAGS --target $MIRI_TEST_TARGET"
 179     fi
 180     # First build and get a sysroot.
 181     $CARGO build $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml
 182     find_sysroot
 183     # Then run the actual command.
 184     exec $CARGO run $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml -- --sysroot "$MIRI_SYSROOT" $MIRIFLAGS "$@"
 185     ;;
 186 fmt)
 187     find "$MIRIDIR" -not \( -name target -prune \) -name '*.rs' \
 188         | xargs rustfmt +$TOOLCHAIN --edition=2021 --config-path "$MIRIDIR/rustfmt.toml" "$@"
 189     ;;
 190 clippy)
 191     $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml --all-targets "$@"
 192     $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/ui_test/Cargo.toml --all-targets "$@"
 193     $CARGO clippy $CARGO_EXTRA_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
 194     ;;
 195 *)
 196     if [ -n "$COMMAND" ]; then
 197       echo "Unknown command: $COMMAND"
 198       echo
 199     fi
 200     echo "$USAGE"
 201     exit 1
 202 esac