miri

   1 #!/bin/sh
   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.
  10
  11 ./miri build <flags>:
  12 Just build miri.  <flags> are passed to `cargo build`.
  13
  14 ./miri check <flags>:
  15 Just check miri.  <flags> are passed to `cargo check`.
  16
  17 ./miri test <flags>:
  18 Build miri, set up a sysroot and then run the test suite. <flags> are passed
  19 to the final `cargo test` invocation.
  20
  21 ./miri run <flags>:
  22 Build miri, set up a sysroot and then run the driver with the given <flags>.
  23
  24 All commands also exist in a "-debug" variant (e.g. "./miri run-debug
  25 <flags>") which uses debug builds instead of release builds, for faster build
  26 times and slower execution times.
  27
  28   ENVIRONMENT VARIABLES
  29
  30 MIRI_SYSROOT:
  31 If already set, the "sysroot setup" step is skipped.
  32
  33 CARGO_EXTRA_FLAGS:
  34 Pass extra flags to all cargo invocations.
  35 EOF
  36 )
  37
  38 ## Preparation
  39 TARGET=$(rustc --version --verbose | grep "^host:" | cut -d ' ' -f 2)
  40 SYSROOT=$(rustc --print sysroot)
  41 LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
  42 if ! test -d "$LIBDIR"; then
  43     echo "Something went wrong determining the library dir."
  44     echo "I got $LIBDIR but that does not exist."
  45     echo "Please report a bug at https://github.com/rust-lang/miri/issues."
  46     exit 2
  47 fi
  48 if [ -z "$CARGO_INCREMENTAL" ]; then
  49     # Default CARGO_INCREMENTAL to 1.
  50     export CARGO_INCREMENTAL=1
  51 fi
  52 if [ -z "$CARGO_TARGET_DIR" ]; then
  53     # Share target dir between `miri` and `cargo-miri`.
  54     export CARGO_TARGET_DIR="$(dirname "$0")"/target
  55 fi
  56 # We set the rpath so that Miri finds the private rustc libraries it needs.
  57 # We enable debug-assertions to get tracing.
  58 # We enable line-only debuginfo for backtraces.
  59 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR -C debug-assertions -C debuginfo=1 $RUSTFLAGS"
  60
  61 ## Helper functions
  62
  63 # Build a sysroot and set MIRI_SYSROOT to use it.  Arguments are passed to `cargo miri setup`.
  64 build_sysroot() {
  65     # Build once, for the user to see.
  66     cargo run $CARGO_BUILD_FLAGS --manifest-path "$(dirname "$0")"/cargo-miri/Cargo.toml -- miri setup "$@"
  67     # Call again, to just set env var.
  68     export MIRI_SYSROOT="$(cargo run $CARGO_BUILD_FLAGS --manifest-path "$(dirname "$0")"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
  69 }
  70
  71 # Prepare and set MIRI_SYSROOT.  Respects `MIRI_TEST_TARGET` and takes into account
  72 # locally built vs. distributed rustc.
  73 find_sysroot() {
  74     if [ -n "$MIRI_SYSROOT" ]; then
  75         # Sysroot already set, use that.
  76         return 0
  77     fi
  78     # We need to build a sysroot.
  79     if [ -n "$MIRI_TEST_TARGET" ]; then
  80         build_sysroot --target "$MIRI_TEST_TARGET"
  81     else
  82         build_sysroot
  83     fi
  84 }
  85
  86 ## Main
  87
  88 # Determine command.
  89 COMMAND="$1"
  90 [ $# -gt 0 ] && shift
  91
  92 # Determine flags passed to all cargo invocations.
  93 # This is a bit more annoying that one would hope due to
  94 # <https://github.com/rust-lang/cargo/issues/6992>.
  95 case "$COMMAND" in
  96 *-debug)
  97     CARGO_INSTALL_FLAGS="--target $TARGET --debug $CARGO_EXTRA_FLAGS"
  98     CARGO_BUILD_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
  99     ;;
 100 *)
 101     CARGO_INSTALL_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
 102     CARGO_BUILD_FLAGS="--target $TARGET --release $CARGO_EXTRA_FLAGS"
 103     ;;
 104 esac
 105
 106 # Run command.
 107 case "$COMMAND" in
 108 install|install-debug)
 109     # "--locked" to respect the Cargo.lock file if it exists,
 110     # "--offline" to avoid querying the registry (for yanked packages).
 111     cargo install $CARGO_INSTALL_FLAGS --path "$(dirname "$0")" --force --locked --offline "$@"
 112     cargo install $CARGO_INSTALL_FLAGS --path "$(dirname "$0")"/cargo-miri --force --locked --offline "$@"
 113     ;;
 114 check|check-debug)
 115     # Check, and let caller control flags.
 116     cargo check $CARGO_BUILD_FLAGS --manifest-path "$(dirname "$0")"/Cargo.toml "$@"
 117     cargo check $CARGO_BUILD_FLAGS --manifest-path "$(dirname "$0")"/cargo-miri/Cargo.toml "$@"
 118     ;;
 119 build|build-debug)
 120     # Build, and let caller control flags.
 121     cargo build $CARGO_BUILD_FLAGS --manifest-path "$(dirname "$0")"/Cargo.toml "$@"
 122     cargo build $CARGO_BUILD_FLAGS --manifest-path "$(dirname "$0")"/cargo-miri/Cargo.toml "$@"
 123     ;;
 124 test|test-debug)
 125     # First build and get a sysroot.
 126     cargo build $CARGO_BUILD_FLAGS
 127     find_sysroot
 128     # Then test, and let caller control flags.
 129     # Only in root project as `cargo-miri` has no tests.
 130     exec cargo test $CARGO_BUILD_FLAGS "$@"
 131     ;;
 132 run|run-debug)
 133     # Scan for "--target" to set the "MIRI_TEST_TARGET" env var so
 134     # that we set the MIRI_SYSROOT up the right way.
 135     if [ -z "$MIRI_TEST_TARGET" ]; then
 136         for ARG in "$@"; do
 137             if [ "$LAST_ARG" = "--target" ]; then
 138                 # Found it!
 139                 export MIRI_TEST_TARGET="$ARG"
 140                 break
 141             fi
 142             LAST_ARG="$ARG"
 143         done
 144     fi
 145     # First build and get a sysroot.
 146     cargo build $CARGO_BUILD_FLAGS
 147     find_sysroot
 148     # Then run the actual command.
 149     exec cargo run $CARGO_BUILD_FLAGS -- --sysroot "$MIRI_SYSROOT" "$@"
 150     ;;
 151 *)
 152     if [ -n "$COMMAND" ]; then
 153       echo "Unknown command: $COMMAND"
 154       echo
 155     fi
 156     echo "$USAGE"
 157     exit 1
 158 esac