018e5b446b6d1759674ca7c1f8d892aee57e5973
[WebKit.git] / Tools / Scripts / webkitpy / benchmark_runner / benchmark_results.py
1 # Copyright (C) 2015 Apple Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions
5 # are met:
6 # 1.  Redistributions of source code must retain the above copyright
7 #     notice, this list of conditions and the following disclaimer.
8 # 2.  Redistributions in binary form must reproduce the above copyright
9 #     notice, this list of conditions and the following disclaimer in the
10 #     documentation and/or other materials provided with the distribution.
11 #
12 # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
13 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15 # DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
16 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
17 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
19 # ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22
23 import json
24 import math
25 import re
26
27
28 class BenchmarkResults(object):
29
30     aggregators = {
31         'Total': (lambda values: sum(values)),
32         'Arithmetic': (lambda values: sum(values) / len(values)),
33         'Geometric': (lambda values: math.exp(sum(map(math.log, values)) / len(values))),
34     }
35     metric_to_unit = {
36         'FrameRate': 'fps',
37         'Runs': '/s',
38         'Time': 'ms',
39         'Duration': 'ms',
40         'Malloc': 'B',
41         'Heap': 'B',
42         'Allocations': 'B',
43         'Score': 'pt',
44     }
45     SI_prefixes = ['n', 'u', 'm', '', 'K', 'M', 'G', 'T', 'P', 'E']
46
47     def __init__(self, results):
48         self._lint_results(results)
49         self._results = self._aggregate_results(results)
50
51     def format(self, scale_unit=True):
52         return self._format_tests(self._results, scale_unit)
53
54     @classmethod
55     def _format_tests(cls, tests, scale_unit, indent=''):
56         output = ''
57         config_name = 'current'
58         for test_name in sorted(tests.keys()):
59             is_first = True
60             test = tests[test_name]
61             metrics = test.get('metrics', {})
62             for metric_name in sorted(metrics.keys()):
63                 metric = metrics[metric_name]
64                 for aggregator_name in sorted(metric.keys()):
65                     output += indent
66                     if is_first:
67                         output += test_name
68                         is_first = False
69                     else:
70                         output += ' ' * len(test_name)
71                     output += ':' + metric_name + ':'
72                     if aggregator_name:
73                         output += aggregator_name + ':'
74                     output += ' ' + cls._format_values(metric_name, metric[aggregator_name][config_name], scale_unit) + '\n'
75             if 'tests' in test:
76                 output += cls._format_tests(test['tests'], scale_unit, indent=(indent + ' ' * len(test_name)))
77         return output
78
79     @classmethod
80     def _format_values(cls, metric_name, values, scale_unit=True):
81         values = map(float, values)
82         total = sum(values)
83         mean = total / len(values)
84         square_sum = sum(map(lambda x: x * x, values))
85         sample_count = len(values)
86
87         # With sum and sum of squares, we can compute the sample standard deviation in O(1).
88         # See https://rniwa.com/2012-11-10/sample-standard-deviation-in-terms-of-sum-and-square-sum-of-samples/
89         if sample_count <= 1:
90             sample_stdev = 0
91         else:
92             sample_stdev = math.sqrt(square_sum / (sample_count - 1) - total * total / (sample_count - 1) / sample_count)
93
94         unit = cls._unit_from_metric(metric_name)
95
96         if not scale_unit:
97             return ('{mean:.3f}{unit} stdev={delta:.1%}').format(mean=mean, delta=sample_stdev / mean, unit=unit)
98
99         if unit == 'ms':
100             unit = 's'
101             mean = float(mean) / 1000
102             sample_stdev /= 1000
103
104         base = 1024 if unit == 'B' else 1000
105         value_sig_fig = 1 - math.floor(math.log10(sample_stdev / mean)) if sample_stdev else 3
106         SI_magnitude = math.floor(math.log(mean, base))
107
108         scaled_mean = mean * math.pow(base, -SI_magnitude)
109         SI_prefix = cls.SI_prefixes[int(SI_magnitude) + 3]
110
111         non_floating_digits = 1 + math.floor(math.log10(scaled_mean))
112         floating_points_count = max(0, value_sig_fig - non_floating_digits)
113         return ('{mean:.' + str(int(floating_points_count)) + 'f}{prefix}{unit} stdev={delta:.1%}').format(
114             mean=scaled_mean, delta=sample_stdev / mean, prefix=SI_prefix, unit=unit)
115
116     @classmethod
117     def _unit_from_metric(cls, metric_name):
118         # FIXME: Detect unknown mettric names
119         suffix = re.match(r'.*?([A-z][a-z]+|FrameRate)$', metric_name)
120         return cls.metric_to_unit[suffix.group(1)]
121
122     @classmethod
123     def _aggregate_results(cls, tests):
124         results = {}
125         for test_name, test in tests.iteritems():
126             results[test_name] = cls._aggregate_results_for_test(test)
127         return results
128
129     @classmethod
130     def _aggregate_results_for_test(cls, test):
131         subtest_results = cls._aggregate_results(test['tests']) if 'tests' in test else {}
132         results = {}
133         for metric_name, metric in test.get('metrics', {}).iteritems():
134             if not isinstance(metric, list):
135                 results[metric_name] = {None: {}}
136                 for config_name, values in metric.iteritems():
137                     results[metric_name][None][config_name] = cls._flatten_list(values)
138                 continue
139
140             aggregator_list = metric
141             results[metric_name] = {}
142             for aggregator in aggregator_list:
143                 values_by_config_iteration = cls._subtest_values_by_config_iteration(subtest_results, metric_name, aggregator)
144                 for config_name, values_by_iteration in values_by_config_iteration.iteritems():
145                     results[metric_name].setdefault(aggregator, {})
146                     results[metric_name][aggregator][config_name] = [cls._aggregate_values(aggregator, values) for values in values_by_iteration]
147
148         return {'metrics': results, 'tests': subtest_results}
149
150     @classmethod
151     def _flatten_list(cls, nested_list):
152         flattened_list = []
153         for item in nested_list:
154             if isinstance(item, list):
155                 flattened_list += cls._flatten_list(item)
156             else:
157                 flattened_list.append(item)
158         return flattened_list
159
160     @classmethod
161     def _subtest_values_by_config_iteration(cls, subtest_results, metric_name, aggregator):
162         values_by_config_iteration = {}
163         for subtest_name, subtest in subtest_results.iteritems():
164             results_for_metric = subtest['metrics'].get(metric_name, {})
165             results_for_aggregator = results_for_metric.get(aggregator, results_for_metric.get(None, {}))
166             for config_name, values in results_for_aggregator.iteritems():
167                 values_by_config_iteration.setdefault(config_name, [[] for _ in values])
168                 for iteration, value in enumerate(values):
169                     values_by_config_iteration[config_name][iteration].append(value)
170         return values_by_config_iteration
171
172     @classmethod
173     def _aggregate_values(cls, aggregator, values):
174         return cls.aggregators[aggregator](values)
175
176     @classmethod
177     def _lint_results(cls, tests):
178         cls._lint_subtest_results(tests, None)
179         return True
180
181     @classmethod
182     def _lint_subtest_results(cls, subtests, parent_needing_aggregation):
183         iteration_groups_by_config = {}
184         for test_name, test in subtests.iteritems():
185             needs_aggregation = False
186
187             if 'metrics' not in test and 'tests' not in test:
188                 raise TypeError('"%s" does not contain metrics or tests' % test_name)
189
190             if 'metrics' in test:
191                 metrics = test['metrics']
192                 if not isinstance(metrics, dict):
193                     raise TypeError('The metrics in "%s" is not a dictionary' % test_name)
194                 for metric_name, metric in metrics.iteritems():
195                     if isinstance(metric, list):
196                         cls._lint_aggregator_list(test_name, metric_name, metric)
197                         needs_aggregation = True
198                     elif isinstance(metric, dict):
199                         cls._lint_configuration(test_name, metric_name, metric, parent_needing_aggregation, iteration_groups_by_config)
200                     else:
201                         raise TypeError('"%s" metric of "%s" was not an aggregator list or a dictionary of configurations: %s' % (metric_name, test_name, str(metric)))
202
203             if 'tests' in test:
204                 cls._lint_subtest_results(test['tests'], test_name if needs_aggregation else None)
205             elif needs_aggregation:
206                 raise TypeError('"%s" requires aggregation but "SomeTest" has no subtests' % (test_name))
207         return iteration_groups_by_config
208
209     @classmethod
210     def _lint_aggregator_list(cls, test_name, metric_name, aggregator_list):
211         if len(aggregator_list) != len(set(aggregator_list)):
212             raise TypeError('"%s" metric of "%s" had invalid aggregator list: %s' % (metric_name, test_name, json.dumps(aggregator_list)))
213         if not aggregator_list:
214             raise TypeError('The aggregator list is empty in "%s" metric of "%s"' % (metric_name, test_name))
215         for aggregator_name in aggregator_list:
216             if cls._is_numeric(aggregator_name):
217                 raise TypeError('"%s" metric of "%s" is not wrapped by a configuration; e.g. "current"' % (metric_name, test_name))
218             if aggregator_name not in cls.aggregators:
219                 raise TypeError('"%s" metric of "%s" uses unknown aggregator: %s' % (metric_name, test_name, aggregator_name))
220
221     @classmethod
222     def _lint_configuration(cls, test_name, metric_name, configurations, parent_needing_aggregation, iteration_groups_by_config):
223         # FIXME: Check that config_name is always "current".
224         for config_name, values in configurations.iteritems():
225             nested_list_count = [isinstance(value, list) for value in values].count(True)
226             if nested_list_count not in [0, len(values)]:
227                 raise TypeError('"%s" metric of "%s" had malformed values: %s' % (metric_name, test_name, json.dumps(values)))
228
229             if nested_list_count:
230                 value_shape = []
231                 for value_group in values:
232                     value_shape.append(len(value_group))
233                     cls._lint_values(test_name, metric_name, value_group)
234             else:
235                 value_shape = len(values)
236                 cls._lint_values(test_name, metric_name, values)
237
238             iteration_groups_by_config.setdefault(metric_name, {}).setdefault(config_name, value_shape)
239             if parent_needing_aggregation and value_shape != iteration_groups_by_config[metric_name][config_name]:
240                 raise TypeError('"%s" metric of "%s" had a mismatching subtest values' % (metric_name, parent_needing_aggregation))
241
242     @classmethod
243     def _lint_values(cls, test_name, metric_name, values):
244         if any([not cls._is_numeric(value) for value in values]):
245             raise TypeError('"%s" metric of "%s" contains non-numeric value: %s' % (metric_name, test_name, json.dumps(values)))
246
247     @classmethod
248     def _is_numeric(cls, value):
249         return isinstance(value, int) or isinstance(value, float)