mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add command to run our benchmarks

Browse Source
This commit is contained in:
Ralf Jung 2022-07-04 15:15:23 -04:00
parent 04a0135af7
commit d7a9989f52
2 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -147,6 +147,12 @@ does not automatically trigger a re-build of the standard library; you have to
clear the Miri build cache manually (on Linux, `rm -rf ~/.cache/miri`; clear the Miri build cache manually (on Linux, `rm -rf ~/.cache/miri`;
and on Windows, `rmdir /S "%LOCALAPPDATA%\rust-lang\miri\cache"`). and on Windows, `rmdir /S "%LOCALAPPDATA%\rust-lang\miri\cache"`).
### Benchmarking
Miri comes with a few benchmarks; you can run `./miri bench` to run them with the locally built
Miri. Note: this will run `./miri install` as a side-effect. Also requires `hyperfine` to be
installed (`cargo install hyperfine`).
## Configuring `rust-analyzer` ## Configuring `rust-analyzer`
To configure `rust-analyzer` and VS Code for working on Miri, save the following To configure `rust-analyzer` and VS Code for working on Miri, save the following

30
miri
View File

@ -37,6 +37,10 @@ Runs <command> over and over again with different seeds for Miri. The MIRIFLAGS
variable is set to its original value appended with ` -Zmiri-seed=$SEED` for variable is set to its original value appended with ` -Zmiri-seed=$SEED` for
many different seeds. many different seeds.
./miri bench <benches>:
Runs the benchmarks from bench-cargo-miri in hyperfine. hyperfine needs to be installed.
<benches> can explicitly list the benchmarks to run; by default, all of them are run.
ENVIRONMENT VARIABLES ENVIRONMENT VARIABLES
MIRI_SYSROOT: MIRI_SYSROOT:
@ -47,6 +51,11 @@ Pass extra flags to all cargo invocations.
EOF EOF
) )
## Preparation
# macOS does not have a useful readlink/realpath so we have to use Python instead...
MIRIDIR=$(python3 -c 'import os, sys; print(os.path.dirname(os.path.realpath(sys.argv[1])))' "$0")
TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
# Determine command. # Determine command.
COMMAND="$1" COMMAND="$1"
[ $# -gt 0 ] && shift [ $# -gt 0 ] && shift
@ -60,14 +69,23 @@ many-seeds)
done done
exit 0 exit 0
;; ;;
bench)
# Make sure we have an up-to-date Miri installed
"$0" install
# Run the requested benchmarks
if [ -z "$@" ]; then
BENCHES=( $(ls "$MIRIDIR/bench-cargo-miri" ) )
else
BENCHES=("$@")
fi
for BENCH in "${BENCHES[@]}"; do
hyperfine -w 1 -m 5 --shell=none "cargo +$TOOLCHAIN miri run --manifest-path bench-cargo-miri/$BENCH/Cargo.toml"
done
exit 0
;;
esac esac
## Preparation ## Prepare the environment
# macOS does not have a useful readlink/realpath so we have to use Python instead...
MIRIDIR=$(python3 -c 'import os, sys; print(os.path.dirname(os.path.realpath(sys.argv[1])))' "$0")
# Determine toolchain *in the Miri dir* and use that.
TOOLCHAIN=$(cd "$MIRIDIR"; rustup show active-toolchain | head -n 1 | cut -d ' ' -f 1)
# Determine some toolchain properties # Determine some toolchain properties
TARGET=$(rustc +$TOOLCHAIN --version --verbose | grep "^host:" | cut -d ' ' -f 2) TARGET=$(rustc +$TOOLCHAIN --version --verbose | grep "^host:" | cut -d ' ' -f 2)
SYSROOT=$(rustc +$TOOLCHAIN --print sysroot) SYSROOT=$(rustc +$TOOLCHAIN --print sysroot)