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
12 Just build miri. <flags> are passed to `cargo build`.
15 Just check miri. <flags> are passed to `cargo check`.
18 Build miri, set up a sysroot and then run the test suite. <flags> are passed
19 to the final `cargo test` invocation.
22 Build miri, set up a sysroot and then run the driver with the given <flags>.
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.
31 If already set, the "sysroot setup" step is skipped.
34 Pass extra flags to all cargo invocations.
39 TARGET=$(rustc --version --verbose | grep "^host:" | cut -d ' ' -f 2)
40 SYSROOT=$(rustc --print sysroot)
41 LIBDIR=$SYSROOT/lib/rustlib/$TARGET/lib
42 MIRIDIR=$(dirname "$0")
43 if readlink -e . &>/dev/null; then
44 # This platform supports `readlink -e`.
45 MIRIDIR=$(readlink -e "$MIRIDIR")
47 if ! test -d "$LIBDIR"; then
48 echo "Something went wrong determining the library dir."
49 echo "I got $LIBDIR but that does not exist."
50 echo "Please report a bug at https://github.com/rust-lang/miri/issues."
53 if [ -z "$CARGO_INCREMENTAL" ]; then
54 # Default CARGO_INCREMENTAL to 1.
55 export CARGO_INCREMENTAL=1
57 if [ -z "$CARGO_TARGET_DIR" ]; then
58 # Share target dir between `miri` and `cargo-miri`.
59 export CARGO_TARGET_DIR="$MIRIDIR/target"
61 # We set the rpath so that Miri finds the private rustc libraries it needs.
62 # We enable debug-assertions to get tracing.
63 # We enable line-only debuginfo for backtraces.
64 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR -C debug-assertions -C debuginfo=1 $RUSTFLAGS"
68 # Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
70 # Build once, for the user to see.
71 cargo run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
72 # Call again, to just set env var.
73 export MIRI_SYSROOT="$(cargo run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
76 # Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
77 # locally built vs. distributed rustc.
79 if [ -n "$MIRI_SYSROOT" ]; then
80 # Sysroot already set, use that.
83 # We need to build a sysroot.
84 if [ -n "$MIRI_TEST_TARGET" ]; then
85 build_sysroot --target "$MIRI_TEST_TARGET"
97 # Determine flags passed to all cargo invocations.
98 # This is a bit more annoying that one would hope due to
99 # <https://github.com/rust-lang/cargo/issues/6992>.
102 CARGO_INSTALL_FLAGS="--target $TARGET --debug $CARGO_EXTRA_FLAGS"
103 CARGO_BUILD_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
106 CARGO_INSTALL_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
107 CARGO_BUILD_FLAGS="--target $TARGET --release $CARGO_EXTRA_FLAGS"
113 install|install-debug)
114 # "--locked" to respect the Cargo.lock file if it exists,
115 # "--offline" to avoid querying the registry (for yanked packages).
116 cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR" --force --locked --offline "$@"
117 cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked --offline "$@"
120 # Check, and let caller control flags.
121 cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
122 cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
125 # Build, and let caller control flags.
126 cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
127 cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
130 # First build and get a sysroot.
131 cargo build $CARGO_BUILD_FLAGS
133 # Then test, and let caller control flags.
134 # Only in root project as `cargo-miri` has no tests.
135 exec cargo test $CARGO_BUILD_FLAGS "$@"
138 # Scan for "--target" to set the "MIRI_TEST_TARGET" env var so
139 # that we set the MIRI_SYSROOT up the right way.
140 if [ -z "$MIRI_TEST_TARGET" ]; then
142 if [ "$LAST_ARG" = "--target" ]; then
144 export MIRI_TEST_TARGET="$ARG"
150 # First build and get a sysroot.
151 cargo build $CARGO_BUILD_FLAGS
153 # Then run the actual command.
154 exec cargo run $CARGO_BUILD_FLAGS -- --sysroot "$MIRI_SYSROOT" "$@"
157 if [ -n "$COMMAND" ]; then
158 echo "Unknown command: $COMMAND"