Fix benchmarks on Windows (#2024)

tweag · Aug 8, 2024 · e333308 · e333308
1 parent 2754065
commit e333308
Show file tree

Hide file tree

Showing 12 changed files with 45 additions and 37 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -86,7 +86,6 @@ strsim = "0.10.0"
 pretty_assertions.workspace = true
 assert_matches.workspace = true
 criterion.workspace = true
-pprof = { workspace = true, features = ["criterion", "flamegraph"] }
 nickel-lang-utils.workspace = true
 similar.workspace = true
 test-generator.workspace = true

diff --git a/core/benches/arrays.rs b/core/benches/arrays.rs
@@ -1,12 +1,11 @@
 use std::rc::Rc;
 
-use criterion::{criterion_main, Criterion};
+use criterion::criterion_main;
 use nickel_lang_core::term::{
     array::{Array, ArrayAttrs},
     Number, RichTerm, Term,
 };
-use nickel_lang_utils::{bench::EvalMode, ncl_bench_group};
-use pprof::criterion::{Output, PProfProfiler};
+use nickel_lang_utils::{bench::criterion_config, bench::EvalMode, ncl_bench_group};
 use pretty::{BoxAllocator, DocBuilder, Pretty};
 
 /// Generates a pseaudo-random Nickel array as a string.
@@ -35,7 +34,7 @@ fn ncl_random_array(len: usize) -> String {
 
 ncl_bench_group! {
 name = benches;
-config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+config = criterion_config();
 {
         name = "foldr strings 50",
         path = "arrays/fold",

diff --git a/core/benches/functions.rs b/core/benches/functions.rs
@@ -1,10 +1,9 @@
-use criterion::{criterion_main, Criterion};
-use nickel_lang_utils::ncl_bench_group;
-use pprof::criterion::{Output, PProfProfiler};
+use criterion::criterion_main;
+use nickel_lang_utils::{bench::criterion_config, ncl_bench_group};
 
 ncl_bench_group! {
     name = benches;
-    config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+    config = criterion_config();
     {
         name = "church 3",
         path = "functions/church",

diff --git a/core/benches/mantis.rs b/core/benches/mantis.rs
@@ -1,10 +1,9 @@
-use criterion::{criterion_main, Criterion};
-use nickel_lang_utils::{bench::EvalMode, ncl_bench_group};
-use pprof::criterion::{Output, PProfProfiler};
+use criterion::criterion_main;
+use nickel_lang_utils::{bench::criterion_config, bench::EvalMode, ncl_bench_group};
 
 ncl_bench_group! {
     name = benches;
-    config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+    config = criterion_config();
     {
         name = "mantis",
         path = "mantis/run",

diff --git a/core/benches/numeric.rs b/core/benches/numeric.rs
@@ -1,10 +1,9 @@
-use criterion::{criterion_main, Criterion};
-use nickel_lang_utils::ncl_bench_group;
-use pprof::criterion::{Output, PProfProfiler};
+use criterion::criterion_main;
+use nickel_lang_utils::{bench::criterion_config, ncl_bench_group};
 
 ncl_bench_group! {
     name = benches;
-    config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+    config = criterion_config();
     {
         name = "fibonacci 10",
         path = "numeric/fibonacci",

diff --git a/core/benches/records.rs b/core/benches/records.rs
@@ -1,10 +1,9 @@
-use criterion::{criterion_main, Criterion};
-use nickel_lang_utils::{bench::EvalMode, ncl_bench_group};
-use pprof::criterion::{Output, PProfProfiler};
+use criterion::criterion_main;
+use nickel_lang_utils::{bench::criterion_config, bench::EvalMode, ncl_bench_group};
 
 ncl_bench_group! {
     name = benches;
-    config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+    config = criterion_config();
     {
             name = "countLetters",
             path = "records/countLetters",

diff --git a/core/benches/serialization.rs b/core/benches/serialization.rs
@@ -1,10 +1,9 @@
-use criterion::{criterion_main, Criterion};
-use nickel_lang_utils::ncl_bench_group;
-use pprof::criterion::{Output, PProfProfiler};
+use criterion::criterion_main;
+use nickel_lang_utils::{bench::criterion_config, ncl_bench_group};
 
 ncl_bench_group! {
     name = benches;
-    config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+    config = criterion_config();
     {
         name = "round_trip",
         path = "serialization/main",

diff --git a/core/benches/stdlib.rs b/core/benches/stdlib.rs
@@ -1,7 +1,7 @@
 use criterion::{criterion_group, criterion_main, Criterion};
-use pprof::criterion::{Output, PProfProfiler};
 
 use nickel_lang_core::cache::{Cache, ErrorTolerance};
+use nickel_lang_utils::bench::criterion_config;
 
 pub fn typecheck_stdlib(c: &mut Criterion) {
     let mut cache = Cache::new(ErrorTolerance::Strict);
@@ -18,7 +18,7 @@ pub fn typecheck_stdlib(c: &mut Criterion) {
 
 criterion_group!(
 name = benches;
-config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+config = criterion_config();
 targets = typecheck_stdlib
 );
 criterion_main!(benches);
diff --git a/core/benches/typecheck-nixpkgs-lib.rs b/core/benches/typecheck-nixpkgs-lib.rs
@@ -1,10 +1,9 @@
-use criterion::{criterion_main, Criterion};
-use nickel_lang_utils::{bench::EvalMode, ncl_bench_group};
-use pprof::criterion::{Output, PProfProfiler};
+use criterion::criterion_main;
+use nickel_lang_utils::{bench::criterion_config, bench::EvalMode, ncl_bench_group};
 
 ncl_bench_group! {
     name = benches;
-    config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
+    config = criterion_config();
     {
         name = "nixpkgs lists",
         path = "nixpkgs/lists",

diff --git a/utils/Cargo.toml b/utils/Cargo.toml
@@ -19,3 +19,6 @@ criterion.workspace = true
 codespan.workspace = true
 serde = { workspace = true, features = ["derive"] }
 toml = { workspace = true, features = ["parse"] }
+
+[target.'cfg(target_family = "unix")'.dependencies]
+pprof = { workspace = true, features = ["criterion", "flamegraph"] }
diff --git a/utils/src/bench.rs b/utils/src/bench.rs
@@ -71,7 +71,7 @@ impl<'b> Bench<'b> {
 
         let field_path = self.subtest.map(|s| format!(".{s}")).unwrap_or_default();
         let content = format!(
-            "(import \"{}\"){}.run {}",
+            "(import {:?}){}.run {}",
             path.to_string_lossy(),
             field_path,
             self.args
@@ -86,13 +86,15 @@ impl<'b> Bench<'b> {
         } else {
             content
         };
-        parse(&content).unwrap()
+        parse(&content).unwrap_or_else(|err| panic!("Failed parsing {path:?}: {err:?}"))
     }
 
     pub fn path(&self) -> PathBuf {
-        let mut path = PathBuf::from(self.base_dir);
-        path.push(format!("benches/{}.ncl", self.subpath));
-        path
+        PathBuf::from_iter([
+            self.base_dir,
+            "benches",
+            format!("{}.ncl", self.subpath).as_str(),
+        ])
     }
 }
 
@@ -139,6 +141,17 @@ pub fn bench_terms<'r>(rts: Vec<Bench<'r>>) -> Box<dyn Fn(&mut Criterion) + 'r>
     })
 }
 
+/// Create a `Criterion` config. Uses the `PProfProfiler` on Unix systems.
+pub fn criterion_config() -> Criterion {
+    let config = Criterion::default();
+    #[cfg(target_family = "unix")]
+    let config = config.with_profiler(pprof::criterion::PProfProfiler::new(
+        100,
+        pprof::criterion::Output::Flamegraph(None),
+    ));
+    config
+}
+
 #[macro_export]
 macro_rules! ncl_bench {
     {