Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: make solver generic #245

Merged
merged 10 commits into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat: added benchmarks
  • Loading branch information
baszalmstra committed Jul 4, 2023
commit d036b4131730ba86b31619ecf1e1bb315c9d99cc
7 changes: 7 additions & 0 deletions crates/rattler_solve/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@ insta = { version = "1.29.0", features = ["yaml"] }
rstest = "0.17.0"
serde_json = "1.0.96"
url = "2.4.0"
similar-asserts = "1.4.2"
once_cell = "1.18.0"
criterion = "0.5.1"

[features]
default = ["libsolv-sys"]
libsolv-sys = ["dep:libsolv-sys", "libc"]

[[bench]]
name = "bench"
harness = false
92 changes: 92 additions & 0 deletions crates/rattler_solve/benches/bench.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
use criterion::{black_box, criterion_group, criterion_main, Criterion};
use rattler_conda_types::{Channel, ChannelConfig, MatchSpec};
use rattler_repodata_gateway::sparse::SparseRepoData;
use rattler_solve::{SolverBackend, SolverTask};
use std::str::FromStr;

fn conda_json_path() -> String {
format!(
"{}/{}",
env!("CARGO_MANIFEST_DIR"),
"../../test-data/channels/conda-forge/linux-64/repodata.json"
)
}

fn conda_json_path_noarch() -> String {
format!(
"{}/{}",
env!("CARGO_MANIFEST_DIR"),
"../../test-data/channels/conda-forge/noarch/repodata.json"
)
}

fn read_sparse_repodata(path: &str) -> SparseRepoData {
SparseRepoData::new(
Channel::from_str("dummy", &ChannelConfig::default()).unwrap(),
"dummy".to_string(),
path,
)
.unwrap()
}

fn bench_solve_environment(c: &mut Criterion, specs: Vec<&str>) {
let name = specs.join(", ");
let mut group = c.benchmark_group(format!("solve {name}"));

let specs = specs
.iter()
.map(|s| MatchSpec::from_str(s).unwrap())
.collect::<Vec<MatchSpec>>();

let json_file = conda_json_path();
let json_file_noarch = conda_json_path_noarch();

let sparse_repo_datas = vec![
read_sparse_repodata(&json_file),
read_sparse_repodata(&json_file_noarch),
];

let names = specs.iter().map(|s| s.name.clone().unwrap());
let available_packages =
SparseRepoData::load_records_recursive(&sparse_repo_datas, names).unwrap();

#[cfg(feature = "libsolv-sys")]
group.bench_function("libsolv-sys", |b| {
b.iter(|| {
rattler_solve::LibsolvBackend
.solve(black_box(SolverTask {
available_packages: &available_packages,
locked_packages: vec![],
pinned_packages: vec![],
virtual_packages: vec![],
specs: specs.clone(),
}))
.unwrap()
})
});

#[cfg(feature = "libsolv_rs")]
group.bench_function("libsolv_rs", |b| {
b.iter(|| {
rattler_solve::LibsolvRsBackend
.solve(black_box(SolverTask {
available_packages: &available_packages,
locked_packages: vec![],
pinned_packages: vec![],
virtual_packages: vec![],
specs: specs.clone(),
}))
.unwrap()
})
});

group.finish();
}

fn criterion_benchmark(c: &mut Criterion) {
bench_solve_environment(c, vec!["python=3.9"]);
bench_solve_environment(c, vec!["tensorboard=2.1.1", "grpc-cpp=1.39.1"]);
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);
116 changes: 108 additions & 8 deletions crates/rattler_solve/tests/backends.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use once_cell::sync::Lazy;
use rattler_conda_types::{
Channel, ChannelConfig, GenericVirtualPackage, MatchSpec, NoArchType, PackageRecord, RepoData,
RepoDataRecord, Version,
Expand Down Expand Up @@ -103,17 +104,11 @@ fn solve_real_world<T: SolverBackend + Default>(specs: Vec<&str>) -> Vec<String>
.map(|s| MatchSpec::from_str(s).unwrap())
.collect::<Vec<_>>();

let json_file = conda_json_path();
let json_file_noarch = conda_json_path_noarch();

let sparse_repo_datas = vec![
read_sparse_repodata(&json_file),
read_sparse_repodata(&json_file_noarch),
];
let sparse_repo_datas = read_real_world_repo_data();

let names = specs.iter().map(|s| s.name.clone().unwrap());
let available_packages =
SparseRepoData::load_records_recursive(&sparse_repo_datas, names).unwrap();
SparseRepoData::load_records_recursive(sparse_repo_datas, names).unwrap();

let solver_task = SolverTask {
available_packages: &available_packages,
Expand Down Expand Up @@ -145,6 +140,20 @@ fn solve_real_world<T: SolverBackend + Default>(specs: Vec<&str>) -> Vec<String>
extract_pkgs(pkgs1)
}

fn read_real_world_repo_data() -> &'static Vec<SparseRepoData> {
static REPO_DATA: Lazy<Vec<SparseRepoData>> = Lazy::new(|| {
let json_file = conda_json_path();
let json_file_noarch = conda_json_path_noarch();

vec![
read_sparse_repodata(&json_file),
read_sparse_repodata(&json_file_noarch),
]
});

&REPO_DATA
}

macro_rules! solver_backend_tests {
($T:ident) => {
#[test]
Expand Down Expand Up @@ -479,3 +488,94 @@ fn solve<T: SolverBackend + Default>(

Ok(pkgs)
}

fn compare_solve(specs: Vec<&str>) {
let specs = specs
.iter()
.map(|s| MatchSpec::from_str(s).unwrap())
.collect::<Vec<_>>();

let sparse_repo_datas = read_real_world_repo_data();

let names = specs.iter().filter_map(|s| s.name.clone());
let available_packages =
SparseRepoData::load_records_recursive(sparse_repo_datas, names).unwrap();

let extract_pkgs = |records: Vec<RepoDataRecord>| {
let mut pkgs = records
.into_iter()
.map(|pkg| {
format!(
"{} {} {}",
pkg.package_record.name, pkg.package_record.version, pkg.package_record.build
)
})
.collect::<Vec<_>>();

// The order of packages is nondeterministic, so we sort them to ensure we can compare them
// to a previous run
pkgs.sort();
pkgs
};

let mut results = Vec::new();

#[cfg(feature = "libsolv-sys")]
results.push((
"libsolv-sys",
extract_pkgs(
rattler_solve::LibsolvBackend
.solve(SolverTask {
available_packages: &available_packages,
specs: specs.clone(),
locked_packages: Default::default(),
pinned_packages: Default::default(),
virtual_packages: Default::default(),
})
.unwrap(),
),
));

#[cfg(feature = "libsolv_rs")]
results.push((
"libsolv_rs",
extract_pkgs(
rattler_solve::LibsolvRsBackend
.solve(SolverTask {
available_packages: &available_packages,
specs: specs.clone(),
locked_packages: Default::default(),
pinned_packages: Default::default(),
virtual_packages: Default::default(),
})
.unwrap(),
),
));

results.into_iter().fold(None, |previous, current| {
let previous = match previous {
Some(previous) => previous,
None => return Some(current),
};

similar_asserts::assert_eq!(
&previous.1,
&current.1,
"The result between {} and {} differs",
&previous.0,
&current.0
);

Some(current)
});
}

#[test]
fn compare_solve_tensorboard() {
compare_solve(vec!["tensorboard=2.1.1", "grpc-cpp=1.39.1"]);
}

#[test]
fn compare_solve_python() {
compare_solve(vec!["python=3.9"]);
}