Compile runtime benchmarks with debuginfo for profiling

Author: Kobzol

collector/src/bin/collector.rs

@@ -10,7 +10,7 @@ use collector::compile::benchmark::scenario::Scenario;
 use collector::compile::benchmark::{
     compile_benchmark_dir, get_compile_benchmarks, ArtifactType, Benchmark, BenchmarkName,
 };
-use collector::{runtime, utils, CollectorCtx, CollectorStepBuilder};
+use collector::{utils, CollectorCtx, CollectorStepBuilder};
 use database::{ArtifactId, ArtifactIdNumber, Commit, CommitType, Connection, Pool};
 use rayon::iter::{IndexedParallelIterator, IntoParallelRefIterator, ParallelIterator};
 use std::cmp::Ordering;
@@ -30,12 +30,12 @@ use tokio::runtime::Runtime;
 
 use collector::compile::execute::bencher::BenchProcessor;
 use collector::compile::execute::profiler::{ProfileProcessor, Profiler};
-use collector::runtime::profile_runtime;
 use collector::runtime::{
     bench_runtime, prepare_runtime_benchmark_suite, runtime_benchmark_dir, BenchmarkFilter,
     BenchmarkSuite, BenchmarkSuiteCompilation, CargoIsolationMode, RuntimeProfiler,
     DEFAULT_RUNTIME_ITERATIONS,
 };
+use collector::runtime::{profile_runtime, RuntimeCompilationOpts};
 use collector::toolchain::{
     create_toolchain_from_published_version, get_local_toolchain, Sysroot, Toolchain,
 };
@@ -697,6 +697,9 @@ fn main_result() -> anyhow::Result<i32> {
                 &toolchain,
                 &runtime_benchmark_dir,
                 CargoIsolationMode::Cached,
+                // Compile with debuginfo to have filenames and line numbers available in the
+                // generated profiles.
+                RuntimeCompilationOpts::default().debug_info("1"),
             )?
             .suite;
             profile_runtime(profiler, suite, &benchmark)?;
@@ -1043,7 +1046,12 @@ async fn load_runtime_benchmarks(
     let BenchmarkSuiteCompilation {
         suite,
         failed_to_compile,
-    } = runtime::prepare_runtime_benchmark_suite(toolchain, benchmark_dir, isolation_mode)?;
+    } = prepare_runtime_benchmark_suite(
+        toolchain,
+        benchmark_dir,
+        isolation_mode,
+        RuntimeCompilationOpts::default(),
+    )?;
 
     record_runtime_compilation_errors(conn, artifact_id, failed_to_compile).await;
     Ok(suite)

collector/src/runtime/benchmark.rs

@@ -106,6 +106,18 @@ pub struct BenchmarkSuiteCompilation {
     pub failed_to_compile: HashMap<String, String>,
 }
 
+#[derive(Default)]
+pub struct RuntimeCompilationOpts {
+    debug_info: Option<String>,
+}
+
+impl RuntimeCompilationOpts {
+    pub fn debug_info(mut self, debug_info: &str) -> Self {
+        self.debug_info = Some(debug_info.to_string());
+        self
+    }
+}
+
 /// Find all runtime benchmark crates in `benchmark_dir` and compile them.
 /// We assume that each binary defines a benchmark suite using `benchlib`.
 /// We then execute each benchmark suite with the `list-benchmarks` command to find out its
@@ -114,6 +126,7 @@ pub fn prepare_runtime_benchmark_suite(
     toolchain: &Toolchain,
     benchmark_dir: &Path,
     isolation_mode: CargoIsolationMode,
+    opts: RuntimeCompilationOpts,
 ) -> anyhow::Result<BenchmarkSuiteCompilation> {
     let benchmark_crates = get_runtime_benchmark_groups(benchmark_dir)?;
 
@@ -146,7 +159,7 @@ pub fn prepare_runtime_benchmark_suite(
 
         let target_dir = temp_dir.as_ref().map(|d| d.path());
 
-        let result = start_cargo_build(toolchain, &benchmark_crate.path, target_dir)
+        let result = start_cargo_build(toolchain, &benchmark_crate.path, target_dir, &opts)
             .with_context(|| {
                 anyhow::anyhow!("Cannot start compilation of {}", benchmark_crate.name)
             })
@@ -276,6 +289,7 @@ fn start_cargo_build(
     toolchain: &Toolchain,
     benchmark_dir: &Path,
     target_dir: Option<&Path>,
+    opts: &RuntimeCompilationOpts,
 ) -> anyhow::Result<Child> {
     let mut command = Command::new(&toolchain.components.cargo);
     command
@@ -289,6 +303,10 @@ fn start_cargo_build(
         .stdout(Stdio::piped())
         .stderr(Stdio::null());
 
+    if let Some(ref debug_info) = opts.debug_info {
+        command.env("CARGO_PROFILE_RELEASE_DEBUG", debug_info);
+    }
+
     if let Some(target_dir) = target_dir {
         command.arg("--target-dir");
         command.arg(target_dir);

collector/src/runtime/mod.rs

@@ -19,6 +19,7 @@ use crate::{run_command_with_output, CollectorCtx};
 mod benchmark;
 mod profile;
 
+pub use benchmark::RuntimeCompilationOpts;
 pub use profile::{profile_runtime, RuntimeProfiler};
 
 pub const DEFAULT_RUNTIME_ITERATIONS: u32 = 5;