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 # We set the rpath so that Miri finds the private rustc libraries it needs.
  49 # We enable debug-assertions to get tracing.
  50 # We enable line-only debuginfo for backtraces.
  51 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR -C debug-assertions -C debuginfo=1 $RUSTC_EXTRA_FLAGS"
  52 if [ -z "$CARGO_INCREMENTAL" ]; then
  53     # Default CARGO_INCREMENTAL to 1.
  54     export CARGO_INCREMENTAL=1
  55 fi
  56
  57 ## Helper functions
  58
  59 # Build a sysroot and set MIRI_SYSROOT to use it.  Arguments are passed to `cargo miri setup`.
  60 build_sysroot() {
  61     # Build once, for the user to see.
  62     cargo run $CARGO_BUILD_FLAGS --bin cargo-miri -- miri setup "$@"
  63     # Call again, to just set env var.
  64     export MIRI_SYSROOT="$(cargo run $CARGO_BUILD_FLAGS -q --bin cargo-miri -- miri setup --print-sysroot "$@")"
  65 }
  66
  67 # Prepare and set MIRI_SYSROOT.  Respects `MIRI_TEST_TARGET` and takes into account
  68 # locally built vs. distributed rustc.
  69 find_sysroot() {
  70     if [ -n "$MIRI_SYSROOT" ]; then
  71         # Sysroot already set, use that.
  72         return 0
  73     fi
  74     # We need to build a sysroot.
  75     if [ -n "$MIRI_TEST_TARGET" ]; then
  76         build_sysroot --target "$MIRI_TEST_TARGET"
  77     else
  78         build_sysroot
  79     fi
  80 }
  81
  82 ## Main
  83
  84 # Determine command.
  85 COMMAND="$1"
  86 [ $# -gt 0 ] && shift
  87
  88 # Determine flags passed to all cargo invocations.
  89 # This is a bit more annoying that one would hope due to
  90 # <https://github.com/rust-lang/cargo/issues/6992>.
  91 case "$COMMAND" in
  92 *-debug)
  93     CARGO_INSTALL_FLAGS="--debug $CARGO_EXTRA_FLAGS"
  94     CARGO_BUILD_FLAGS="$CARGO_EXTRA_FLAGS"
  95     ;;
  96 *)
  97     CARGO_INSTALL_FLAGS="$CARGO_EXTRA_FLAGS"
  98     CARGO_BUILD_FLAGS="--release $CARGO_EXTRA_FLAGS"
  99     ;;
 100 esac
 101
 102 # Run command.
 103 case "$COMMAND" in
 104 install|install-debug)
 105     # "--locked" to respect the Cargo.lock file if it exists,
 106     # "--offline" to avoid querying the registry (for yanked packages).
 107     exec cargo install $CARGO_INSTALL_FLAGS --path "$(dirname "$0")" --force --locked --offline "$@"
 108     ;;
 109 check|check-debug)
 110     # Check, and let caller control flags.
 111     exec cargo check $CARGO_BUILD_FLAGS "$@"
 112     ;;
 113 build|build-debug)
 114     # Build, and let caller control flags.
 115     exec cargo build $CARGO_BUILD_FLAGS "$@"
 116     ;;
 117 test|test-debug)
 118     # First build and get a sysroot.
 119     cargo build $CARGO_BUILD_FLAGS
 120     find_sysroot
 121     # Then test, and let caller control flags.
 122     exec cargo test $CARGO_BUILD_FLAGS "$@"
 123     ;;
 124 run|run-debug)
 125     # Scan for "--target" to set the "MIRI_TEST_TARGET" env var so
 126     # that we set the MIRI_SYSROOT up the right way.
 127     if [ -z "$MIRI_TEST_TARGET" ]; then
 128         for ARG in "$@"; do
 129             if [ "$LAST_ARG" = "--target" ]; then
 130                 # Found it!
 131                 export MIRI_TEST_TARGET="$ARG"
 132                 break
 133             fi
 134             LAST_ARG="$ARG"
 135         done
 136     fi
 137     # First build and get a sysroot.
 138     cargo build $CARGO_BUILD_FLAGS
 139     find_sysroot
 140     # Then run the actual command.
 141     exec cargo run $CARGO_BUILD_FLAGS -- --sysroot "$MIRI_SYSROOT" "$@"
 142     ;;
 143 *)
 144     if [ -n "$COMMAND" ]; then
 145       echo "Unknown command: $COMMAND"
 146       echo
 147     fi
 148     echo "$USAGE"
 149     exit 1
 150 esac