Port memory.long_running_idle_gmail benchmarks to TBMv2.

tools/perf/benchmarks/memory_infra.py

 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import re
 
 from core import perf_benchmark
 
 from telemetry import benchmark
 from telemetry.timeline import tracing_category_filter
 from telemetry.web_perf import timeline_based_measurement
 from telemetry.web_perf.metrics import memory_timeline
-from telemetry.web_perf.metrics import v8_gc_latency
 
 import page_sets
 
 
 class _MemoryInfra(perf_benchmark.PerfBenchmark):
   """Base class for new-generation memory benchmarks based on memory-infra.
 
   This benchmark records data using memory-infra (https://goo.gl/8tGc6O), which
   is part of chrome tracing, and extracts it using timeline-based measurements.
   """
@@ skipping 87 matching lines @@
 class MemoryBenchmarkTop10Mobile(_MemoryInfra):
   """Timeline based benchmark for measuring memory on top 10 mobile sites."""
 
   page_set = page_sets.MemoryInfraTop10MobilePageSet
 
   @classmethod
   def Name(cls):
     return 'memory.top_10_mobile'
 
 
+class _MemoryV8Benchmark(_MemoryInfra):
+  def CreateTimelineBasedMeasurementOptions(self):
+    v8_categories = [

[petrcermak, 2016/04/27 16:22:17]

v8_categories and memory_categories could be class constants.

[ulan, 2016/04/28 14:34:35]

Since they are not reused, I'd prefer to keep them in the smallest possible
scope.

[petrcermak, 2016/04/28 14:38:45]

if you prefix them with an underscore, they will technically be private to the
class.

+        'blink.console', 'renderer.scheduler', 'v8', 'webkit.console']
+    memory_categories = ['blink.console', 'disabled-by-default-memory-infra']
+    all_categories = v8_categories + memory_categories

[petrcermak, 2016/04/27 16:22:17]

1) Note that this will contain 'blink.console' twice. To avoid this, I recommend
that |v8_categories| and |memory_categories| are sets instead.
2) You probably want to make sure that everything else is disabled (see
https://code.google.com/p/chromium/codesearch#chromium/src/tools/perf/benchma...).
To do this, I suggest you do: ','.join(['-*'] + list(v8_categories +
memory_categories)).
3) I would inline |all_categories| because it just seems to add unnecessary
indirection (feel free to ignore).

[ulan, 2016/04/28 14:34:35]

2, 3 - done. TracingCategoryFilter can handle duplicates.

+    category_filter = tracing_category_filter.TracingCategoryFilter(
+        ','.join(all_categories))
+    options = timeline_based_measurement.Options(category_filter)
+    return options
+
+  def SetupBenchmarkDefaultTraceRerunOptions(self, tbm_options):

[perezju, 2016/04/27 16:29:42]

we're getting rid of these TraceRerun* methods, just move this line of code to
the bottom of CreateTimelineBasedMeasurementOptions.

[ulan, 2016/04/28 14:34:35]

I tried to that, but then _MemoryInfra.SetupBenchmarkDefaultTraceRerunOptions
gets invoked and fails.

I'd rather not remove _MemoryInfra.SetupBenchmarkDefaultTraceRerunOptions in
this CL, so I am keeping this function for now.

[perezju, 2016/04/28 14:45:09]

This is no longer true after Petr's CL
https://codereview.chromium.org/1920363003/

It's probably a good idea to rebase against that and test again, because I guess
if you leave this as is then it's going to break.

+    tbm_options.SetTimelineBasedMetric('v8AndMemoryMetrics')
+

[petrcermak, 2016/04/27 16:22:17]

nit: add one more blank line here (there should be 2 blank lines between
top-level definitions)

[ulan, 2016/04/28 14:34:35]

Done.

 # Disabled on reference builds because they don't support the new
 # Tracing.requestMemoryDump DevTools API.
 # For 'reference' see http://crbug.com/540022.
 # For 'android' see http://crbug.com/579546.

[perezju, 2016/04/27 16:29:43]

That bug shows that the (non-tbm) benchmark was re-enabled on Android. Could we
also try to re-enable this one? (could be a follow up CL)

[ulan, 2016/04/28 14:34:35]

Acknowledged. I will re-enable in a different CL.

 @benchmark.Disabled('reference', 'android')
-class MemoryLongRunningIdleGmailTBM(_MemoryInfra):
+class MemoryLongRunningIdleGmail(_MemoryV8Benchmark):
   """Use (recorded) real world web sites and measure memory consumption
   of long running idle Gmail page """
   page_set = page_sets.LongRunningIdleGmailPageSet
 
-  def CreateTimelineBasedMeasurementOptions(self):
-    v8_categories = [
-        'blink.console', 'renderer.scheduler', 'v8', 'webkit.console']
-    memory_categories = 'blink.console,disabled-by-default-memory-infra'
-    category_filter = tracing_category_filter.TracingCategoryFilter(
-        memory_categories)
-    for category in v8_categories:
-      category_filter.AddIncludedCategory(category)
-    options = timeline_based_measurement.Options(category_filter)
-    return options
+  @classmethod
+  def Name(cls):
+    return 'memory.long_running_idle_gmail_tbmv2'
 

[petrcermak, 2016/04/27 16:22:17]

ditto: add extra blank line

[ulan, 2016/04/28 14:34:35]

Done.

-  def SetupBenchmarkDefaultTraceRerunOptions(self, tbm_options):
-    tbm_options.SetLegacyTimelineBasedMetrics((
-        v8_gc_latency.V8GCLatency(),
-        memory_timeline.MemoryTimelineMetric(),
-    ))
+# Disabled on reference builds because they don't support the new
+# Tracing.requestMemoryDump DevTools API.
+# For 'reference' see http://crbug.com/540022.
+# For 'android' see http://crbug.com/579546.
+@benchmark.Disabled('reference', 'android')
+class MemoryLongRunningIdleGmailBackground(_MemoryV8Benchmark):
+  """Use (recorded) real world web sites and measure memory consumption
+  of long running idle Gmail page """
+  page_set = page_sets.LongRunningIdleGmailBackgroundPageSet
 
   @classmethod
   def Name(cls):
-    return 'memory.long_running_idle_gmail_tbm'
-
-  @classmethod
-  def ShouldTearDownStateAfterEachStoryRun(cls):
-    return True
+    return 'memory.long_running_idle_gmail_background_tbmv2'