Rename ProfileMode::HeapSummary -> HeapSummaryAllocated

Summary: Make it choice between `HeapSummaryRetained` and `HeapSummaryAllocated` more explicit.

Reviewed By: bobyangyf

Differential Revision: D38646893

fbshipit-source-id: 8b77aa54f01f06cc28000aa2c42a1f84f9b1c023

Author: stepancheg

starlark/src/eval/runtime/evaluator.rs

@@ -231,8 +231,8 @@ impl<'v, 'a> Evaluator<'v, 'a> {
         self.profile_or_instrumentation_mode = ProfileOrInstrumentationMode::Profile(mode.dupe());
 
         match mode {
-            ProfileMode::HeapSummary
-            | ProfileMode::HeapFlame
+            ProfileMode::HeapSummaryAllocated
+            | ProfileMode::HeapFlameAllocated
             | ProfileMode::HeapSummaryRetained
             | ProfileMode::HeapFlameRetained => {
                 self.heap_profile.enable();
@@ -287,9 +287,9 @@ impl<'v, 'a> Evaluator<'v, 'a> {
             ProfileMode::Statement => {
                 self.before_stmt.instrument = true;
             }
-            ProfileMode::HeapSummary
+            ProfileMode::HeapSummaryAllocated
             | ProfileMode::HeapSummaryRetained
-            | ProfileMode::HeapFlame
+            | ProfileMode::HeapFlameAllocated
             | ProfileMode::HeapFlameRetained
             | ProfileMode::TimeFlame => {
                 self.heap_or_flame_profile = true;
@@ -322,11 +322,11 @@ impl<'v, 'a> Evaluator<'v, 'a> {
         };
         self.profile_or_instrumentation_mode = ProfileOrInstrumentationMode::Collected;
         match mode {
-            ProfileMode::HeapSummary => self
+            ProfileMode::HeapSummaryAllocated => self
                 .heap_profile
                 .gen(self.heap(), HeapProfileFormat::Summary)
                 .ok_or_else(|| EvaluatorError::HeapProfilingNotEnabled.into()),
-            ProfileMode::HeapFlame => self
+            ProfileMode::HeapFlameAllocated => self
                 .heap_profile
                 .gen(self.heap(), HeapProfileFormat::FlameGraph)
                 .ok_or_else(|| EvaluatorError::HeapProfilingNotEnabled.into()),

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

@@ -78,12 +78,12 @@ impl HeapProfile {
 
     fn write_flame_heap_profile(heap: &Heap) -> ProfileData {
         let stacks = AggregateHeapProfileInfo::collect(heap, None);
-        ProfileData::new(ProfileMode::HeapFlame, stacks.gen_flame_graph())
+        ProfileData::new(ProfileMode::HeapFlameAllocated, stacks.gen_flame_graph())
     }
 
     fn write_summarized_heap_profile(heap: &Heap) -> ProfileData {
         let stacks = AggregateHeapProfileInfo::collect(heap, None);
-        ProfileData::new(ProfileMode::HeapSummary, stacks.gen_summary_csv())
+        ProfileData::new(ProfileMode::HeapSummaryAllocated, stacks.gen_summary_csv())
     }
 }
 
@@ -115,7 +115,8 @@ f
         let globals = Globals::standard();
         let module = Module::new();
         let mut eval = Evaluator::new(&module);
-        eval.enable_profile(&ProfileMode::HeapSummary).unwrap();
+        eval.enable_profile(&ProfileMode::HeapSummaryAllocated)
+            .unwrap();
         let f = eval.eval_module(ast, &globals)?;
         // first check module profiling works
         HeapProfile::write_summarized_heap_profile(module.heap());
@@ -124,7 +125,8 @@ f
         // second check function profiling works
         let module = Module::new();
         let mut eval = Evaluator::new(&module);
-        eval.enable_profile(&ProfileMode::HeapSummary).unwrap();
+        eval.enable_profile(&ProfileMode::HeapSummaryAllocated)
+            .unwrap();
         eval.eval_function(f, &[Value::new_int(100)], &[])?;
         HeapProfile::write_summarized_heap_profile(module.heap());
         HeapProfile::write_flame_heap_profile(module.heap());
@@ -133,7 +135,8 @@ f
         let module = Module::new();
         let mut eval = Evaluator::new(&module);
         module.heap().alloc("Thing that goes before");
-        eval.enable_profile(&ProfileMode::HeapSummary).unwrap();
+        eval.enable_profile(&ProfileMode::HeapSummaryAllocated)
+            .unwrap();
         eval.eval_function(f, &[Value::new_int(100)], &[])?;
         module.heap().alloc("Thing that goes after");
         HeapProfile::write_summarized_heap_profile(module.heap());

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

@@ -37,12 +37,12 @@ pub enum ProfileMode {
     /// The heap profile mode provides information about the time spent in each function and allocations
     /// performed by each function. Enabling this mode the side effect of disabling garbage-collection.
     /// This profiling mode is the recommended one.
-    HeapSummary,
+    HeapSummaryAllocated,
     /// Like heap summary, but information about retained memory after module is frozen.
     HeapSummaryRetained,
     /// Like heap profile, but writes output comparible with
     /// [flamegraph.pl](https://github.com/brendangregg/FlameGraph/blob/master/flamegraph.pl).
-    HeapFlame,
+    HeapFlameAllocated,
     /// Like heap flame, but information about retained memory after module is frozen.
     HeapFlameRetained,
     /// The statement profile mode provides information about time spent in each statement.
@@ -67,9 +67,9 @@ impl Display for ProfileMode {
 impl ProfileMode {
     fn name(&self) -> &str {
         match self {
-            ProfileMode::HeapSummary => "heap-summary",
+            ProfileMode::HeapSummaryAllocated => "heap-summary-allocated",
             ProfileMode::HeapSummaryRetained => "heap-summary-retained",
-            ProfileMode::HeapFlame => "heap-flame",
+            ProfileMode::HeapFlameAllocated => "heap-flame-allocated",
             ProfileMode::HeapFlameRetained => "heap-flame-retained",
             ProfileMode::Statement => "statement",
             ProfileMode::Bytecode => "bytecode",
@@ -85,9 +85,9 @@ impl FromStr for ProfileMode {
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         for mode in [
-            ProfileMode::HeapSummary,
+            ProfileMode::HeapSummaryAllocated,
             ProfileMode::HeapSummaryRetained,
-            ProfileMode::HeapFlame,
+            ProfileMode::HeapFlameAllocated,
             ProfileMode::HeapFlameRetained,
             ProfileMode::Statement,
             ProfileMode::Bytecode,

starlark/src/values/layout/heap/profile/summary.rs

@@ -200,7 +200,8 @@ _ignore = str([1])     # allocate a string in non_drop
         let globals = Globals::standard();
         let module = Module::new();
         let mut eval = Evaluator::new(&module);
-        eval.enable_profile(&ProfileMode::HeapSummary).unwrap();
+        eval.enable_profile(&ProfileMode::HeapSummaryAllocated)
+            .unwrap();
 
         eval.eval_module(ast, &globals).unwrap();