Expand description
Foundry benchmark runner.
Re-exportsยง
pub(crate) use crate::results::HyperfineOutput;๐pub(crate) use crate::results::HyperfineResult;๐pub(crate) use crate::symbolic::Fixture;๐pub(crate) use crate::symbolic::Overlay;๐pub(crate) use crate::symbolic::Sample;๐pub(crate) use crate::symbolic::Sidecar;๐pub(crate) use Result;๐pub(crate) use WrapErr;๐pub(crate) use sh_eprintln;๐pub(crate) use sh_println;๐pub(crate) use foundry_compilers::project_util::TempProject;๐pub(crate) use foundry_test_utils::util::clone_remote;๐pub(crate) use once_cell::sync::Lazy;๐pub(crate) use collections::HashSet;๐pub(crate) use env;๐pub(crate) use env;๐pub(crate) use fs;๐pub(crate) use Path;๐pub(crate) use PathBuf;๐pub(crate) use process::Command;๐pub(crate) use str::FromStr;๐pub(crate) use time::Instant;๐
Modulesยง
Structsยง
- Benchmark
Project - A benchmark project that represents a cloned repository ready for testing
- Repo
Config - Configuration for repositories to benchmark
Constantsยง
- DEFAULT_
LOCAL_ ๐BUILD_ PROFILE - FOUNDRY_
BINS ๐ - LOCAL_
BUILD_ ๐BINS_ ENV - LOCAL_
BUILD_ ๐PROFILE_ ENV - RUNS
- Default number of runs for benchmarks
- WORKSPACE_
ROOT ๐ - The workspace root, embedded at compile time.
benches/is one level below the workspace root. - WORKSPACE_
ROOT_ ๐ENV
Staticsยง
- BENCHMARK_
REPOS - FOUNDRY_
VERSIONS - Foundry versions to benchmark
Functionsยง
- activate_
local_ ๐binaries - default_
benchmark_ repos - Available repositories for benchmarking
- foundry_
bin_ ๐dir - get_
forge_ commit - Get the commit of the active Forge binary.
- get_
forge_ version - Get the current forge version
- get_
forge_ version_ details - Get the full forge version details including commit hash and date
- install_
local_ workspace - Build and activate the shipped Foundry binaries from an explicit workspace, without linking unused workspace binaries. Used to benchmark a baseline ref checked out into a separate worktree.
- local_
build_ ๐bins - local_
build_ ๐profile - mean ๐
- median ๐
- median_
index ๐ - parse_
forge_ ๐commit - parse_
version_ specs - Parse
--versionsentries into unique display names and optional source workspaces.name=pathbuilds Foundry frompathand labels itname. - stddev ๐
- switch_
foundry_ version - Switch to a specific foundry version.
- workspace_
root ๐