tools/perf/measurements/smoothness.py

   1 # Copyright 2013 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 from telemetry.page import page_test
   6 from telemetry.timeline import tracing_category_filter
   7 from telemetry.web_perf import timeline_based_measurement
   8 from telemetry.web_perf.metrics import smoothness
   9
  10
  11 class _CustomResultsWrapper(timeline_based_measurement.ResultsWrapperInterface):
  12   def __init__(self):
  13     super(_CustomResultsWrapper, self).__init__()
  14     self._pages_to_tir_labels = {}
  15
  16   def _AssertNewValueHasSameInteractionLabel(self, new_value):
  17     tir_label = self._pages_to_tir_labels.get(new_value.page)
  18     if tir_label:
  19       assert tir_label == self._tir_label, (
  20         'Smoothness measurement do not support multiple interaction record '
  21         'labels per page yet. See crbug.com/453109 for more information.')
  22     else:
  23       self._pages_to_tir_labels[new_value.page] = self._tir_label
  24
  25   def AddValue(self, value):
  26     self._AssertNewValueHasSameInteractionLabel(value)
  27     self._results.AddValue(value)
  28
  29
  30 class Smoothness(page_test.PageTest):
  31   def __init__(self, needs_browser_restart_after_each_page=False):
  32     super(Smoothness, self).__init__(needs_browser_restart_after_each_page)
  33     self._results_wrapper = _CustomResultsWrapper()
  34     self._tbm = None
  35
  36   @classmethod
  37   def CustomizeBrowserOptions(cls, options):
  38     options.AppendExtraBrowserArgs('--enable-gpu-benchmarking')
  39     options.AppendExtraBrowserArgs('--touch-events=enabled')
  40     options.AppendExtraBrowserArgs('--running-performance-benchmark')
  41
  42   def WillNavigateToPage(self, page, tab):
  43     tracing_controller = tab.browser.platform.tracing_controller
  44     # FIXME: Remove webkit.console when blink.console lands in chromium and
  45     # the ref builds are updated. crbug.com/386847
  46     custom_categories = [
  47         'webkit.console', 'blink.console', 'benchmark', 'trace_event_overhead']
  48     category_filter = tracing_category_filter.TracingCategoryFilter(
  49         ','.join(custom_categories))
  50
  51     options = timeline_based_measurement.Options(category_filter)
  52     options.SetTimelineBasedMetrics([smoothness.SmoothnessMetric()])
  53     for delay in page.GetSyntheticDelayCategories():
  54       options.category_filter.AddSyntheticDelay(delay)
  55     self._tbm = timeline_based_measurement.TimelineBasedMeasurement(
  56         options, self._results_wrapper)
  57     self._tbm.WillRunStoryForPageTest(tracing_controller)
  58
  59   def ValidateAndMeasurePage(self, _, tab, results):
  60     tracing_controller = tab.browser.platform.tracing_controller
  61     self._tbm.MeasureForPageTest(tracing_controller, results)
  62
  63   def DidRunPage(self, platform):
  64     if self._tbm:
  65       self._tbm.DidRunStoryForPageTest(platform.tracing_controller)
  66
  67
  68 class Repaint(Smoothness):
  69   def CustomizeBrowserOptions(self, options):
  70     options.AppendExtraBrowserArgs([
  71         '--enable-impl-side-painting',
  72         '--enable-threaded-compositing',
  73         '--enable-gpu-benchmarking'
  74     ])
  75
  76 class SmoothnessWithRestart(Smoothness):
  77   def __init__(self):
  78     super(SmoothnessWithRestart, self).__init__(
  79         needs_browser_restart_after_each_page=True)