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 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."
48 if [ -z "$CARGO_INCREMENTAL" ]; then
49 # Default CARGO_INCREMENTAL to 1.
50 export CARGO_INCREMENTAL=1
52 if [ -z "$CARGO_TARGET_DIR" ]; then
53 # Share target dir between `miri` and `cargo-miri`.
54 export CARGO_TARGET_DIR="$(dirname "$0")"/target
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"
63 # Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
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 "$@")"
71 # Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
72 # locally built vs. distributed rustc.
74 if [ -n "$MIRI_SYSROOT" ]; then
75 # Sysroot already set, use that.
78 # We need to build a sysroot.
79 if [ -n "$MIRI_TEST_TARGET" ]; then
80 build_sysroot --target "$MIRI_TEST_TARGET"
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>.
97 CARGO_INSTALL_FLAGS="--target $TARGET --debug $CARGO_EXTRA_FLAGS"
98 CARGO_BUILD_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
101 CARGO_INSTALL_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
102 CARGO_BUILD_FLAGS="--target $TARGET --release $CARGO_EXTRA_FLAGS"
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 "$@"
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 "$@"
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 "$@"
125 # First build and get a sysroot.
126 cargo build $CARGO_BUILD_FLAGS
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 "$@"
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
137 if [ "$LAST_ARG" = "--target" ]; then
139 export MIRI_TEST_TARGET="$ARG"
145 # First build and get a sysroot.
146 cargo build $CARGO_BUILD_FLAGS
148 # Then run the actual command.
149 exec cargo run $CARGO_BUILD_FLAGS -- --sysroot "$MIRI_SYSROOT" "$@"
152 if [ -n "$COMMAND" ]; then
153 echo "Unknown command: $COMMAND"