move comparison::Metric to database crate

s7tya · s7tya · commit 64003a05c124 · 2024-08-06T00:42:14.000+09:00
diff --git a/database/src/comparison.rs b/database/src/comparison.rs
@@ -0,0 +1,113 @@
+use std::str::FromStr;
+
+use serde::{de::IntoDeserializer, Deserialize, Serialize};
+
+/// This enum contains all "known" metrics coming from rustc or profiling tools that we know
+/// (and care) about.
+#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
+pub enum Metric {
+    #[serde(rename = "context-switches")]
+    ContextSwitches,
+    #[serde(rename = "cpu-clock")]
+    CpuClock,
+    #[serde(rename = "cpu-clock:u")]
+    CpuClockUser,
+    #[serde(rename = "cycles")]
+    Cycles,
+    #[serde(rename = "cycles:u")]
+    CyclesUser,
+    #[serde(rename = "faults")]
+    Faults,
+    #[serde(rename = "faults:u")]
+    FaultsUser,
+    #[serde(rename = "instructions:u")]
+    InstructionsUser,
+    #[serde(rename = "max-rss")]
+    MaxRSS,
+    #[serde(rename = "task-clock")]
+    TaskClock,
+    #[serde(rename = "task-clock:u")]
+    TaskClockUser,
+    #[serde(rename = "wall-time")]
+    WallTime,
+    #[serde(rename = "branch-misses")]
+    BranchMisses,
+    #[serde(rename = "cache-misses")]
+    CacheMisses,
+    /// Rustc guesses the codegen unit size by MIR count.
+    #[serde(rename = "size:codegen_unit_size_estimate")]
+    CodegenUnitSize,
+    /// The codegen unit size by llvm ir count, the real size of a cgu.
+    #[serde(rename = "size:cgu_instructions")]
+    CodegenUnitLlvmIrCount,
+    #[serde(rename = "size:dep_graph")]
+    DepGraphSize,
+    #[serde(rename = "size:linked_artifact")]
+    LinkedArtifactSize,
+    #[serde(rename = "size:object_file")]
+    ObjectFileSize,
+    #[serde(rename = "size:query_cache")]
+    QueryCacheSize,
+    #[serde(rename = "size:work_product_index")]
+    WorkProductIndexSize,
+    #[serde(rename = "size:crate_metadata")]
+    CrateMetadataSize,
+    #[serde(rename = "size:dwo_file")]
+    DwoFileSize,
+    #[serde(rename = "size:assembly_file")]
+    AssemblyFileSize,
+    #[serde(rename = "size:llvm_bitcode")]
+    LlvmBitcodeSize,
+    #[serde(rename = "size:llvm_ir")]
+    LlvmIrSize,
+    /// Total bytes of a generated documentation directory
+    #[serde(rename = "size:doc_bytes")]
+    DocByteSize,
+    /// Number of files inside a generated documentation directory.
+    #[serde(rename = "size:doc_files_count")]
+    DocFilesCount,
+}
+
+impl FromStr for Metric {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        Metric::deserialize(s.into_deserializer())
+            .map_err(|e: serde::de::value::Error| format!("Unknown metric `{s}`: {e:?}"))
+    }
+}
+
+impl Metric {
+    pub fn as_str(&self) -> &str {
+        match self {
+            Metric::ContextSwitches => "context-switches",
+            Metric::CpuClock => "cpu-clock",
+            Metric::CpuClockUser => "cpu-clock:u",
+            Metric::Cycles => "cycles",
+            Metric::CyclesUser => "cycles:u",
+            Metric::Faults => "faults",
+            Metric::FaultsUser => "faults:u",
+            Metric::InstructionsUser => "instructions:u",
+            Metric::MaxRSS => "max-rss",
+            Metric::TaskClock => "task-clock",
+            Metric::TaskClockUser => "task-clock:u",
+            Metric::WallTime => "wall-time",
+            Metric::BranchMisses => "branch-misses",
+            Metric::CacheMisses => "cache-misses",
+            Metric::CodegenUnitSize => "size:codegen_unit_size_estimate",
+            Metric::CodegenUnitLlvmIrCount => "size:cgu_instructions",
+            Metric::DepGraphSize => "size:dep_graph",
+            Metric::LinkedArtifactSize => "size:linked_artifact",
+            Metric::ObjectFileSize => "size:object_file",
+            Metric::QueryCacheSize => "size:query_cache",
+            Metric::WorkProductIndexSize => "size:work_product_index",
+            Metric::CrateMetadataSize => "size:crate_metadata",
+            Metric::DwoFileSize => "size:dwo_file",
+            Metric::AssemblyFileSize => "size:assembly_file",
+            Metric::LlvmBitcodeSize => "size:llvm_bitcode",
+            Metric::LlvmIrSize => "size:llvm_ir",
+            Metric::DocByteSize => "size:doc_bytes",
+            Metric::DocFilesCount => "size:doc_files_count",
+        }
+    }
+}
diff --git a/database/src/lib.rs b/database/src/lib.rs
@@ -9,6 +9,7 @@ use std::ops::{Add, Sub};
 use std::sync::Arc;
 use std::time::Duration;
 
+pub mod comparison;
 pub mod interpolate;
 pub mod pool;
 pub mod selector;
diff --git a/site/src/api.rs b/site/src/api.rs
@@ -252,9 +252,8 @@ pub mod bootstrap {
 
 pub mod comparison {
     use crate::benchmark_metadata::ProfileMetadata;
-    use crate::comparison::Metric;
     use collector::Bound;
-    use database::Date;
+    use database::{comparison::Metric, Date};
     use serde::{Deserialize, Serialize};
     use std::collections::HashMap;
 
@@ -595,8 +594,8 @@ pub mod github {
 }
 
 pub mod triage {
-    use crate::comparison::Metric;
     use collector::Bound;
+    use database::comparison::Metric;
     use serde::{Deserialize, Serialize};
 
     #[derive(Debug, Clone, Serialize, Deserialize)]
diff --git a/site/src/comparison.rs b/site/src/comparison.rs
@@ -12,22 +12,21 @@ use crate::selector::{
 
 use collector::compile::benchmark::category::Category;
 use collector::Bound;
-use serde::{Deserialize, Serialize};
+use database::comparison::Metric;
+use serde::Serialize;
 
 use crate::api::comparison::CompileBenchmarkMetadata;
 use crate::benchmark_metadata::get_compile_benchmarks_metadata;
 use crate::server::comparison::StatComparison;
 use collector::compile::benchmark::ArtifactType;
 use database::{CodegenBackend, CommitType, CompileBenchmark};
-use serde::de::IntoDeserializer;
 use std::cmp;
 use std::collections::{HashMap, HashSet};
 use std::error::Error;
 use std::fmt::Write;
 use std::hash::Hash;
 use std::iter;
 use std::ops::Deref;
-use std::str::FromStr;
 use std::sync::Arc;
 
 type BoxedError = Box<dyn Error + Send + Sync>;
@@ -234,115 +233,12 @@ async fn populate_report(
     }
 }
 
-/// This enum contains all "known" metrics coming from rustc or profiling tools that we know
-/// (and care) about.
-#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
-pub enum Metric {
-    #[serde(rename = "context-switches")]
-    ContextSwitches,
-    #[serde(rename = "cpu-clock")]
-    CpuClock,
-    #[serde(rename = "cpu-clock:u")]
-    CpuClockUser,
-    #[serde(rename = "cycles")]
-    Cycles,
-    #[serde(rename = "cycles:u")]
-    CyclesUser,
-    #[serde(rename = "faults")]
-    Faults,
-    #[serde(rename = "faults:u")]
-    FaultsUser,
-    #[serde(rename = "instructions:u")]
-    InstructionsUser,
-    #[serde(rename = "max-rss")]
-    MaxRSS,
-    #[serde(rename = "task-clock")]
-    TaskClock,
-    #[serde(rename = "task-clock:u")]
-    TaskClockUser,
-    #[serde(rename = "wall-time")]
-    WallTime,
-    #[serde(rename = "branch-misses")]
-    BranchMisses,
-    #[serde(rename = "cache-misses")]
-    CacheMisses,
-    /// Rustc guesses the codegen unit size by MIR count.
-    #[serde(rename = "size:codegen_unit_size_estimate")]
-    CodegenUnitSize,
-    /// The codegen unit size by llvm ir count, the real size of a cgu.
-    #[serde(rename = "size:cgu_instructions")]
-    CodegenUnitLlvmIrCount,
-    #[serde(rename = "size:dep_graph")]
-    DepGraphSize,
-    #[serde(rename = "size:linked_artifact")]
-    LinkedArtifactSize,
-    #[serde(rename = "size:object_file")]
-    ObjectFileSize,
-    #[serde(rename = "size:query_cache")]
-    QueryCacheSize,
-    #[serde(rename = "size:work_product_index")]
-    WorkProductIndexSize,
-    #[serde(rename = "size:crate_metadata")]
-    CrateMetadataSize,
-    #[serde(rename = "size:dwo_file")]
-    DwoFileSize,
-    #[serde(rename = "size:assembly_file")]
-    AssemblyFileSize,
-    #[serde(rename = "size:llvm_bitcode")]
-    LlvmBitcodeSize,
-    #[serde(rename = "size:llvm_ir")]
-    LlvmIrSize,
-    /// Total bytes of a generated documentation directory
-    #[serde(rename = "size:doc_bytes")]
-    DocByteSize,
-    /// Number of files inside a generated documentation directory.
-    #[serde(rename = "size:doc_files_count")]
-    DocFilesCount,
+trait MetricExt {
+    fn relative_change_magnitude(&self, change: f64) -> Magnitude;
+    fn is_typically_noisy(&self) -> bool;
 }
 
-impl FromStr for Metric {
-    type Err = String;
-
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        Metric::deserialize(s.into_deserializer())
-            .map_err(|e: serde::de::value::Error| format!("Unknown metric `{s}`: {e:?}"))
-    }
-}
-
-impl Metric {
-    pub fn as_str(&self) -> &str {
-        match self {
-            Metric::ContextSwitches => "context-switches",
-            Metric::CpuClock => "cpu-clock",
-            Metric::CpuClockUser => "cpu-clock:u",
-            Metric::Cycles => "cycles",
-            Metric::CyclesUser => "cycles:u",
-            Metric::Faults => "faults",
-            Metric::FaultsUser => "faults:u",
-            Metric::InstructionsUser => "instructions:u",
-            Metric::MaxRSS => "max-rss",
-            Metric::TaskClock => "task-clock",
-            Metric::TaskClockUser => "task-clock:u",
-            Metric::WallTime => "wall-time",
-            Metric::BranchMisses => "branch-misses",
-            Metric::CacheMisses => "cache-misses",
-            Metric::CodegenUnitSize => "size:codegen_unit_size_estimate",
-            Metric::CodegenUnitLlvmIrCount => "size:cgu_instructions",
-            Metric::DepGraphSize => "size:dep_graph",
-            Metric::LinkedArtifactSize => "size:linked_artifact",
-            Metric::ObjectFileSize => "size:object_file",
-            Metric::QueryCacheSize => "size:query_cache",
-            Metric::WorkProductIndexSize => "size:work_product_index",
-            Metric::CrateMetadataSize => "size:crate_metadata",
-            Metric::DwoFileSize => "size:dwo_file",
-            Metric::AssemblyFileSize => "size:assembly_file",
-            Metric::LlvmBitcodeSize => "size:llvm_bitcode",
-            Metric::LlvmIrSize => "size:llvm_ir",
-            Metric::DocByteSize => "size:doc_bytes",
-            Metric::DocFilesCount => "size:doc_files_count",
-        }
-    }
-
+impl MetricExt for Metric {
     /// Determines the magnitude of a percent relative change for a given metric.
     ///
     /// Takes into account how noisy the stat is. For example, instruction
diff --git a/site/src/github/comparison_summary.rs b/site/src/github/comparison_summary.rs
@@ -1,10 +1,10 @@
 use crate::comparison::{
     deserves_attention_icount, write_summary_table, ArtifactComparison, ArtifactComparisonSummary,
-    Direction, Metric,
+    Direction,
 };
 use crate::load::SiteCtxt;
 
-use database::{ArtifactId, QueuedCommit};
+use database::{comparison::Metric, ArtifactId, QueuedCommit};
 
 use crate::github::{COMMENT_MARK_ROLLUP, COMMENT_MARK_TEMPORARY, RUST_REPO_GITHUB_API_URL};
 use humansize::BINARY;
diff --git a/site/src/request_handlers/dashboard.rs b/site/src/request_handlers/dashboard.rs
@@ -4,8 +4,7 @@ use lazy_static::lazy_static;
 
 use crate::api::{dashboard, ServerResult};
 use crate::benchmark_metadata::get_stable_benchmark_names;
-use crate::comparison::Metric;
-use crate::db::{self, ArtifactId, Profile, Scenario};
+use crate::db::{self, comparison::Metric, ArtifactId, Profile, Scenario};
 use crate::load::SiteCtxt;
 use crate::selector;
 
diff --git a/site/src/request_handlers/self_profile.rs b/site/src/request_handlers/self_profile.rs
@@ -4,13 +4,12 @@ use std::sync::Arc;
 use std::time::Instant;
 
 use bytes::Buf;
-use database::CommitType;
+use database::{comparison::Metric, CommitType};
 use headers::{ContentType, Header};
 use hyper::StatusCode;
 
 use crate::api::self_profile::ArtifactSizeDelta;
 use crate::api::{self_profile, self_profile_processed, self_profile_raw, ServerResult};
-use crate::comparison::Metric;
 use crate::db::ArtifactId;
 use crate::load::SiteCtxt;
 use crate::selector::{self};
diff --git a/site/src/selector.rs b/site/src/selector.rs
@@ -25,12 +25,12 @@ use crate::db::{ArtifactId, Profile, Scenario};
 use crate::load::SiteCtxt;
 
 use collector::Bound;
+use database::comparison::Metric;
 use database::interpolate::Interpolate;
 use database::selector::StatisticSeries;
 use database::ArtifactIdIter;
 use database::{selector::Point, Benchmark, CodegenBackend, Commit, Connection, Index, Lookup};
 
-use crate::comparison::Metric;
 use async_trait::async_trait;
 use std::fmt::Debug;
 use std::hash::Hash;
