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 # macOS does not have a useful readlink/realpath so we have to use Python instead...
43 MIRIDIR=$(dirname "$(python3 -c 'import os, sys; print(os.path.realpath(sys.argv[1]))' "$0")")
44 if ! test -d "$LIBDIR"; then
45 echo "Something went wrong determining the library dir."
46 echo "I got $LIBDIR but that does not exist."
47 echo "Please report a bug at https://github.com/rust-lang/miri/issues."
50 if [ -z "$CARGO_INCREMENTAL" ]; then
51 # Default CARGO_INCREMENTAL to 1.
52 export CARGO_INCREMENTAL=1
54 if [ -z "$CARGO_TARGET_DIR" ]; then
55 # Share target dir between `miri` and `cargo-miri`.
56 export CARGO_TARGET_DIR="$MIRIDIR/target"
58 # We set the rpath so that Miri finds the private rustc libraries it needs.
59 # We enable debug-assertions to get tracing.
60 # We enable line-only debuginfo for backtraces.
61 export RUSTFLAGS="-C link-args=-Wl,-rpath,$LIBDIR -C debug-assertions -C debuginfo=1 $RUSTFLAGS"
65 # Build a sysroot and set MIRI_SYSROOT to use it. Arguments are passed to `cargo miri setup`.
67 # Build once, for the user to see.
68 cargo run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -- miri setup "$@"
69 # Call again, to just set env var.
70 export MIRI_SYSROOT="$(cargo run $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml -q -- miri setup --print-sysroot "$@")"
73 # Prepare and set MIRI_SYSROOT. Respects `MIRI_TEST_TARGET` and takes into account
74 # locally built vs. distributed rustc.
76 if [ -n "$MIRI_SYSROOT" ]; then
77 # Sysroot already set, use that.
80 # We need to build a sysroot.
81 if [ -n "$MIRI_TEST_TARGET" ]; then
82 build_sysroot --target "$MIRI_TEST_TARGET"
94 # Determine flags passed to all cargo invocations.
95 # This is a bit more annoying that one would hope due to
96 # <https://github.com/rust-lang/cargo/issues/6992>.
99 CARGO_INSTALL_FLAGS="--target $TARGET --debug $CARGO_EXTRA_FLAGS"
100 CARGO_BUILD_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
103 CARGO_INSTALL_FLAGS="--target $TARGET $CARGO_EXTRA_FLAGS"
104 CARGO_BUILD_FLAGS="--target $TARGET --release $CARGO_EXTRA_FLAGS"
110 install|install-debug)
111 # "--locked" to respect the Cargo.lock file if it exists,
112 # "--offline" to avoid querying the registry (for yanked packages).
113 cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR" --force --locked --offline "$@"
114 cargo install $CARGO_INSTALL_FLAGS --path "$MIRIDIR"/cargo-miri --force --locked --offline "$@"
117 # Check, and let caller control flags.
118 cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
119 cargo check $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
122 # Build, and let caller control flags.
123 cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/Cargo.toml "$@"
124 cargo build $CARGO_BUILD_FLAGS --manifest-path "$MIRIDIR"/cargo-miri/Cargo.toml "$@"
127 # First build and get a sysroot.
128 cargo build $CARGO_BUILD_FLAGS
130 # Then test, and let caller control flags.
131 # Only in root project as `cargo-miri` has no tests.
132 exec cargo test $CARGO_BUILD_FLAGS "$@"
135 # Scan for "--target" to set the "MIRI_TEST_TARGET" env var so
136 # that we set the MIRI_SYSROOT up the right way.
137 if [ -z "$MIRI_TEST_TARGET" ]; then
139 if [ "$LAST_ARG" = "--target" ]; then
141 export MIRI_TEST_TARGET="$ARG"
147 # First build and get a sysroot.
148 cargo build $CARGO_BUILD_FLAGS
150 # Then run the actual command.
151 exec cargo run $CARGO_BUILD_FLAGS -- --sysroot "$MIRI_SYSROOT" "$@"
154 if [ -n "$COMMAND" ]; then
155 echo "Unknown command: $COMMAND"