run-benchmark should print out the results
[WebKit-https.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):
52         return self._format_tests(self._results)
53
54     @classmethod
55     def _format_tests(self, tests, 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 += ' ' + self._format_values(metric_name, metric[aggregator_name][config_name]) + '\n'
75             if 'tests' in test:
76                 output += self._format_tests(test['tests'], indent=(indent + ' ' * len(test_name)))
77         return output
78
79     @classmethod
80     def _format_values(cls, metric_name, values):
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 unit == 'ms':
97             unit = 's'
98             mean = float(mean) / 1000
99             sample_stdev /= 1000
100
101         base = 1024 if unit == 'B' else 1000
102         value_sig_fig = 1 - math.floor(math.log10(sample_stdev / mean)) if sample_stdev else 3
103         SI_magnitude = math.floor(math.log(mean, base))
104
105         scaled_mean = mean * math.pow(base, -SI_magnitude)
106         SI_prefix = cls.SI_prefixes[int(SI_magnitude) + 3]
107
108         non_floating_digits = 1 + math.floor(math.log10(scaled_mean))
109         floating_points_count = max(0, value_sig_fig - non_floating_digits)
110         return ('{mean:.' + str(int(floating_points_count)) + 'f}{prefix}{unit} stdev={delta:.1%}').format(
111             mean=scaled_mean, delta=sample_stdev / mean, prefix=SI_prefix, unit=unit)
112
113     @classmethod
114     def _unit_from_metric(cls, metric_name):
115         # FIXME: Detect unknown mettric names
116         suffix = re.match(r'.*?([A-z][a-z]+|FrameRate)$', metric_name)
117         return cls.metric_to_unit[suffix.group(1)]
118
119     @classmethod
120     def _aggregate_results(cls, tests):
121         results = {}
122         for test_name, test in tests.iteritems():
123             results[test_name] = cls._aggregate_results_for_test(test)
124         return results
125
126     @classmethod
127     def _aggregate_results_for_test(cls, test):
128         subtest_results = cls._aggregate_results(test['tests']) if 'tests' in test else {}
129         results = {}
130         for metric_name, metric in test['metrics'].iteritems():
131             if not isinstance(metric, list):
132                 results[metric_name] = {None: {}}
133                 for config_name, values in metric.iteritems():
134                     results[metric_name][None][config_name] = cls._flatten_list(values)
135                 continue
136
137             aggregator_list = metric
138             results[metric_name] = {}
139             for aggregator in aggregator_list:
140                 values_by_config_iteration = cls._subtest_values_by_config_iteration(subtest_results, metric_name, aggregator)
141                 for config_name, values_by_iteration in values_by_config_iteration.iteritems():
142                     results[metric_name].setdefault(aggregator, {})
143                     results[metric_name][aggregator][config_name] = [cls._aggregate_values(aggregator, values) for values in values_by_iteration]
144
145         return {'metrics': results, 'tests': subtest_results}
146
147     @classmethod
148     def _flatten_list(cls, nested_list):
149         flattened_list = []
150         for item in nested_list:
151             if isinstance(item, list):
152                 flattened_list += cls._flatten_list(item)
153             else:
154                 flattened_list.append(item)
155         return flattened_list
156
157     @classmethod
158     def _subtest_values_by_config_iteration(cls, subtest_results, metric_name, aggregator):
159         values_by_config_iteration = {}
160         for subtest_name, subtest in subtest_results.iteritems():
161             results_for_metric = subtest['metrics'].get(metric_name, {})
162             results_for_aggregator = results_for_metric.get(aggregator, results_for_metric.get(None, {}))
163             for config_name, values in results_for_aggregator.iteritems():
164                 values_by_config_iteration.setdefault(config_name, [[] for _ in values])
165                 for iteration, value in enumerate(values):
166                     values_by_config_iteration[config_name][iteration].append(value)
167         return values_by_config_iteration
168
169     @classmethod
170     def _aggregate_values(cls, aggregator, values):
171         return cls.aggregators[aggregator](values)
172
173     @classmethod
174     def _lint_results(cls, tests):
175         cls._lint_subtest_results(tests, None)
176         return True
177
178     @classmethod
179     def _lint_subtest_results(cls, subtests, parent_needing_aggregation):
180         iteration_groups_by_config = {}
181         for test_name, test in subtests.iteritems():
182             if 'metrics' not in test:
183                 raise TypeError('"%s" does not contain metrics' % test_name)
184
185             metrics = test['metrics']
186             if not isinstance(metrics, dict):
187                 raise TypeError('The metrics in "%s" is not a dictionary' % test_name)
188
189             needs_aggregation = False
190             for metric_name, metric in metrics.iteritems():
191                 if isinstance(metric, list):
192                     cls._lint_aggregator_list(test_name, metric_name, metric)
193                     needs_aggregation = True
194                 elif isinstance(metric, dict):
195                     cls._lint_configuration(test_name, metric_name, metric, parent_needing_aggregation, iteration_groups_by_config)
196                 else:
197                     raise TypeError('"%s" metric of "%s" was not an aggregator list or a dictionary of configurations: %s' % (metric_name, test_name, str(metric)))
198
199             if 'tests' in test:
200                 cls._lint_subtest_results(test['tests'], test_name if needs_aggregation else None)
201             elif needs_aggregation:
202                 raise TypeError('"%s" requires aggregation but "SomeTest" has no subtests' % (test_name))
203         return iteration_groups_by_config
204
205     @classmethod
206     def _lint_aggregator_list(cls, test_name, metric_name, aggregator_list):
207         if len(aggregator_list) != len(set(aggregator_list)):
208             raise TypeError('"%s" metric of "%s" had invalid aggregator list: %s' % (metric_name, test_name, json.dumps(aggregator_list)))
209         if not aggregator_list:
210             raise TypeError('The aggregator list is empty in "%s" metric of "%s"' % (metric_name, test_name))
211         for aggregator_name in aggregator_list:
212             if cls._is_numeric(aggregator_name):
213                 raise TypeError('"%s" metric of "%s" is not wrapped by a configuration; e.g. "current"' % (metric_name, test_name))
214             if aggregator_name not in cls.aggregators:
215                 raise TypeError('"%s" metric of "%s" uses unknown aggregator: %s' % (metric_name, test_name, aggregator_name))
216
217     @classmethod
218     def _lint_configuration(cls, test_name, metric_name, configurations, parent_needing_aggregation, iteration_groups_by_config):
219         # FIXME: Check that config_name is always "current".
220         for config_name, values in configurations.iteritems():
221             nested_list_count = [isinstance(value, list) for value in values].count(True)
222             if nested_list_count not in [0, len(values)]:
223                 raise TypeError('"%s" metric of "%s" had malformed values: %s' % (metric_name, test_name, json.dumps(values)))
224
225             if nested_list_count:
226                 value_shape = []
227                 for value_group in values:
228                     value_shape.append(len(value_group))
229                     cls._lint_values(test_name, metric_name, value_group)
230             else:
231                 value_shape = len(values)
232                 cls._lint_values(test_name, metric_name, values)
233
234             iteration_groups_by_config.setdefault(metric_name, {}).setdefault(config_name, value_shape)
235             if parent_needing_aggregation and value_shape != iteration_groups_by_config[metric_name][config_name]:
236                 raise TypeError('"%s" metric of "%s" had a mismatching subtest values' % (metric_name, parent_needing_aggregation))
237
238     @classmethod
239     def _lint_values(cls, test_name, metric_name, values):
240         if any([not cls._is_numeric(value) for value in values]):
241             raise TypeError('"%s" metric of "%s" contains non-numeric value: %s' % (metric_name, test_name, json.dumps(values)))
242
243     @classmethod
244     def _is_numeric(cls, value):
245         return isinstance(value, int) or isinstance(value, float)