Merge pull request #1678 from lqd/debug-metadata

Show `dev` profile metadata for benchmarks

Author: Kobzol

site/build.rs

@@ -55,22 +55,11 @@ fn main() -> Result<(), Box<dyn Error>> {
         let manifest: toml::Value = toml::from_str(&manifest_contents)?;
 
         let table = manifest.as_table().unwrap();
-        let profile = table.get("profile");
-        let release = profile
-            .and_then(|p| p.as_table())
-            .and_then(|t| t.get("release"))
-            .and_then(|t| t.as_table());
-        let debug = release.and_then(|t| t.get("debug"));
-        let lto = release.and_then(|t| t.get("lto"));
-        let codegen_units = release.and_then(|t| t.get("codegen-units"));
-
+        let profiles = table.get("profile");
         let metadata = CompileBenchmarkMetadata {
             perf_config: config,
-            release_metadata: ProfileMetadata {
-                debug: debug.map(|v| v.to_string()),
-                lto: lto.map(|v| v.to_string()),
-                codegen_units: codegen_units.and_then(|v| v.as_integer().map(|v| v as u32)),
-            },
+            release_metadata: read_profile_metadata(profiles, "release"),
+            dev_metadata: read_profile_metadata(profiles, "dev"),
         };
         suite.insert(benchmark_name, metadata);
     }
@@ -82,3 +71,23 @@ fn main() -> Result<(), Box<dyn Error>> {
 
     Ok(())
 }
+
+/// If the manifest has `profile.*` entries, read some of the compilation metadata from a built-in
+/// profile with the given `profile` name, if it exists (for example, the options for cargo's
+/// optimized profile is named `release`).
+/// Note that some, or all, of the metadata that we want to display may be missing from the
+/// manifest: it just won't be shown in the UI in that case.
+fn read_profile_metadata(profiles: Option<&toml::Value>, profile: &str) -> ProfileMetadata {
+    let profile = profiles
+        .and_then(|p| p.as_table())
+        .and_then(|t| t.get(profile))
+        .and_then(|t| t.as_table());
+    let debug = profile.and_then(|t| t.get("debug"));
+    let lto = profile.and_then(|t| t.get("lto"));
+    let codegen_units = profile.and_then(|t| t.get("codegen-units"));
+    ProfileMetadata {
+        debug: debug.map(|v| v.to_string()),
+        lto: lto.map(|v| v.to_string()),
+        codegen_units: codegen_units.and_then(|v| v.as_integer().map(|v| v as u32)),
+    }
+}

site/frontend/src/pages/compare/compile/common.ts

@@ -67,6 +67,7 @@ export interface CompileBenchmarkMetadata {
   binary: boolean | null;
   iterations: number | null;
   release_profile: CargoProfileMetadata;
+  dev_profile: CargoProfileMetadata;
 }
 
 export interface CompileBenchmarkComparison {

site/frontend/src/pages/compare/compile/comparisons-table.vue

@@ -73,8 +73,7 @@ Category: ${metadata.category}
   if (metadata.iterations !== null) {
     tooltip += `Iterations: ${metadata.iterations}\n`;
   }
-  if (testCase.profile === "opt" && metadata.release_profile !== null) {
-    const {lto, debug, codegen_units} = metadata.release_profile;
+  const addMetadata = ({lto, debug, codegen_units}) => {
     if (lto !== null) {
       tooltip += `LTO: ${lto}\n`;
     }
@@ -84,6 +83,11 @@ Category: ${metadata.category}
     if (codegen_units !== null) {
       tooltip += `Codegen units: ${codegen_units}\n`;
     }
+  };
+  if (testCase.profile === "opt" && metadata.release_profile !== null) {
+    addMetadata(metadata.release_profile);
+  } else if (testCase.profile === "debug" && metadata.dev_profile !== null) {
+    addMetadata(metadata.dev_profile);
   }
 
   return tooltip;

site/src/api.rs

@@ -159,6 +159,7 @@ pub mod comparison {
         pub binary: Option<bool>,
         pub iterations: Option<u32>,
         pub release_profile: Option<ProfileMetadata>,
+        pub dev_profile: Option<ProfileMetadata>,
     }
 
     #[derive(Debug, Clone, Serialize)]

site/src/benchmark_metadata/metadata.rs

@@ -22,6 +22,7 @@ pub struct ProfileMetadata {
 pub struct CompileBenchmarkMetadata {
     pub perf_config: serde_json::Value,
     pub release_metadata: ProfileMetadata,
+    pub dev_metadata: ProfileMetadata,
 }
 
 #[derive(serde::Serialize, serde::Deserialize)]

site/src/benchmark_metadata/mod.rs

@@ -13,6 +13,7 @@ pub use metadata::ProfileMetadata;
 pub struct CompileBenchmarkMetadata {
     pub perf_config: BenchmarkConfig,
     pub release_metadata: ProfileMetadata,
+    pub dev_metadata: ProfileMetadata,
 }
 
 /// The metadata of compile-time benchmarks is embedded directly within the binary using
@@ -50,6 +51,7 @@ fn load_compile_benchmark_metadata() -> HashMap<String, CompileBenchmarkMetadata
             let metadata::CompileBenchmarkMetadata {
                 perf_config,
                 release_metadata,
+                dev_metadata,
             } = metadata;
             let perf_config: BenchmarkConfig =
                 serde_json::from_value(perf_config).unwrap_or_else(|error| {
@@ -62,6 +64,7 @@ fn load_compile_benchmark_metadata() -> HashMap<String, CompileBenchmarkMetadata
             let metadata = CompileBenchmarkMetadata {
                 perf_config,
                 release_metadata,
+                dev_metadata,
             };
             (name, metadata)
         })

site/src/comparison.rs

@@ -185,6 +185,7 @@ pub async fn handle_compare(
                 binary: metadata.map(|m| m.perf_config.artifact() == ArtifactType::Binary),
                 iterations: metadata.map(|m| m.perf_config.iterations() as u32),
                 release_profile: metadata.map(|m| m.release_metadata.clone()),
+                dev_profile: metadata.map(|m| m.dev_metadata.clone()),
             }
         })
         .collect();