Store ProfileMode in ProfileData

Summary: Used later (D38681490). Also may be helpful when debugging.

Reviewed By: milend

Differential Revision: D38680885

fbshipit-source-id: 724f8dc4773808583c478414a4dcfd50e343a789

Author: stepancheg

starlark/src/eval/runtime/evaluator.rs

@@ -337,9 +337,10 @@ impl<'v, 'a> Evaluator<'v, 'a> {
                 .stmt_profile
                 .gen()
                 .ok_or_else(|| EvaluatorError::StmtProfilingNotEnabled.into()),
-            ProfileMode::Bytecode | ProfileMode::BytecodePairs => {
-                self.bc_profile.gen_csv().map(ProfileData::new)
-            }
+            ProfileMode::Bytecode | ProfileMode::BytecodePairs => self
+                .bc_profile
+                .gen_csv()
+                .map(|csv| ProfileData::new(mode, csv)),
             ProfileMode::TimeFlame => self
                 .flame_profile
                 .gen()

starlark/src/eval/runtime/profile/data.rs

@@ -20,16 +20,22 @@ use std::path::Path;
 
 use anyhow::Context;
 
+use crate::eval::ProfileMode;
+
 /// Collected profiling data.
 #[derive(Clone, Debug)]
 pub struct ProfileData {
+    profile_mode: ProfileMode,
     /// Serialized to text (e.g. CSV or flamegraph).
     profile: String,
 }
 
 impl ProfileData {
-    pub(crate) fn new(profile: String) -> ProfileData {
-        ProfileData { profile }
+    pub(crate) fn new(profile_mode: ProfileMode, profile: String) -> ProfileData {
+        ProfileData {
+            profile_mode,
+            profile,
+        }
     }
 
     /// Generate a string with profile data (e.g. CSV or flamegraph, depending on profile type).
@@ -39,8 +45,13 @@ impl ProfileData {
 
     /// Write to a file.
     pub fn write(&self, path: &Path) -> anyhow::Result<()> {
-        fs::write(path, &self.profile)
-            .with_context(|| format!("write profile data to `{}`", path.display()))?;
+        fs::write(path, &self.profile).with_context(|| {
+            format!(
+                "write profile `{}` data to `{}`",
+                self.profile_mode,
+                path.display()
+            )
+        })?;
         Ok(())
     }
 }

starlark/src/eval/runtime/profile/flame.rs

@@ -26,6 +26,7 @@ use crate as starlark;
 use crate::eval::runtime::profile::data::ProfileData;
 use crate::eval::runtime::profile::flamegraph::FlameGraphWriter;
 use crate::eval::runtime::small_duration::SmallDuration;
+use crate::eval::ProfileMode;
 use crate::values::layout::pointer::RawPointer;
 use crate::values::Trace;
 use crate::values::Tracer;
@@ -177,6 +178,9 @@ impl<'v> FlameProfile<'v> {
         // root;calls1;calls2 1
         // All the numbers at the end must be whole numbers (we use milliseconds)
         let names = x.values.map(|x| x.to_repr());
-        ProfileData::new(Stacks::new(&names, &x.frames).render())
+        ProfileData::new(
+            ProfileMode::TimeFlame,
+            Stacks::new(&names, &x.frames).render(),
+        )
     }
 }

starlark/src/eval/runtime/profile/heap.rs

@@ -20,6 +20,7 @@ use std::fmt::Debug;
 use gazebo::dupe::Dupe;
 
 use crate::eval::runtime::profile::data::ProfileData;
+use crate::eval::ProfileMode;
 use crate::values::layout::heap::profile::aggregated::AggregateHeapProfileInfo;
 use crate::values::Heap;
 use crate::values::Value;
@@ -77,12 +78,12 @@ impl HeapProfile {
 
     fn write_flame_heap_profile(heap: &Heap) -> ProfileData {
         let stacks = AggregateHeapProfileInfo::collect(heap, None);
-        ProfileData::new(stacks.gen_flame_graph())
+        ProfileData::new(ProfileMode::HeapFlame, stacks.gen_flame_graph())
     }
 
     fn write_summarized_heap_profile(heap: &Heap) -> ProfileData {
         let stacks = AggregateHeapProfileInfo::collect(heap, None);
-        ProfileData::new(stacks.gen_summary_csv())
+        ProfileData::new(ProfileMode::HeapSummary, stacks.gen_summary_csv())
     }
 }
 

starlark/src/eval/runtime/profile/stmt.rs

@@ -32,6 +32,7 @@ use crate::codemap::Span;
 use crate::eval::runtime::profile::csv::CsvWriter;
 use crate::eval::runtime::profile::data::ProfileData;
 use crate::eval::runtime::small_duration::SmallDuration;
+use crate::eval::ProfileMode;
 
 #[derive(Debug, thiserror::Error)]
 enum StmtProfileError {
@@ -186,7 +187,7 @@ impl StmtProfile {
         let now = Instant::now();
         self.0
             .as_ref()
-            .map(|data| ProfileData::new(data.write_to_string(now)))
+            .map(|data| ProfileData::new(ProfileMode::Statement, data.write_to_string(now)))
     }
 
     pub(crate) fn coverage(&self) -> anyhow::Result<HashSet<ResolvedFileSpan>> {

starlark/src/eval/runtime/profile/typecheck.rs

@@ -23,6 +23,7 @@ use crate::collections::SmallMap;
 use crate::eval::runtime::profile::csv::CsvWriter;
 use crate::eval::runtime::profile::data::ProfileData;
 use crate::eval::runtime::small_duration::SmallDuration;
+use crate::eval::ProfileMode;
 use crate::values::FrozenStringValue;
 
 #[derive(Default, Debug)]
@@ -65,7 +66,7 @@ impl TypecheckProfile {
         if !self.enabled {
             return None;
         }
-        Some(ProfileData::new(self.gen_csv()))
+        Some(ProfileData::new(ProfileMode::Typecheck, self.gen_csv()))
     }
 }