Calling internals from the performance test runner prevents manual running
[WebKit-https.git] / PerformanceTests / resources / runner.js
1 // There are tests for computeStatistics() located in LayoutTests/fast/harness/perftests
2
3 // We need access to console.memory for the memory measurements
4 if (window.internals)
5      internals.settings.setMemoryInfoEnabled(true);
6
7 var PerfTestRunner = {};
8
9 // To make the benchmark results predictable, we replace Math.random with a
10 // 100% deterministic alternative.
11 PerfTestRunner.randomSeed = PerfTestRunner.initialRandomSeed = 49734321;
12
13 PerfTestRunner.resetRandomSeed = function() {
14     PerfTestRunner.randomSeed = PerfTestRunner.initialRandomSeed
15 }
16
17 PerfTestRunner.random = Math.random = function() {
18     // Robert Jenkins' 32 bit integer hash function.
19     var randomSeed = PerfTestRunner.randomSeed;
20     randomSeed = ((randomSeed + 0x7ed55d16) + (randomSeed << 12))  & 0xffffffff;
21     randomSeed = ((randomSeed ^ 0xc761c23c) ^ (randomSeed >>> 19)) & 0xffffffff;
22     randomSeed = ((randomSeed + 0x165667b1) + (randomSeed << 5))   & 0xffffffff;
23     randomSeed = ((randomSeed + 0xd3a2646c) ^ (randomSeed << 9))   & 0xffffffff;
24     randomSeed = ((randomSeed + 0xfd7046c5) + (randomSeed << 3))   & 0xffffffff;
25     randomSeed = ((randomSeed ^ 0xb55a4f09) ^ (randomSeed >>> 16)) & 0xffffffff;
26     PerfTestRunner.randomSeed = randomSeed;
27     return (randomSeed & 0xfffffff) / 0x10000000;
28 };
29
30 PerfTestRunner.log = function (text) {
31     if (this._logLines) {
32         this._logLines.push(text);
33         return;
34     }
35     if (!document.getElementById("log")) {
36         var pre = document.createElement('pre');
37         pre.id = 'log';
38         document.body.appendChild(pre);
39     }
40     document.getElementById("log").innerHTML += text + "\n";
41     window.scrollTo(0, document.body.height);
42 }
43
44 PerfTestRunner.info = function (text) {
45     this.log("Info: " + text);
46 }
47
48 PerfTestRunner.logInfo = function (text) {
49     if (!window.testRunner)
50         this.log(text);
51 }
52
53 PerfTestRunner.loadFile = function (path) {
54     var xhr = new XMLHttpRequest();
55     xhr.open("GET", path, false);
56     xhr.send(null);
57     return xhr.responseText;
58 }
59
60 PerfTestRunner.computeStatistics = function (times, unit) {
61     var data = times.slice();
62
63     // Add values from the smallest to the largest to avoid the loss of significance
64     data.sort(function(a,b){return a-b;});
65
66     var middle = Math.floor(data.length / 2);
67     var result = {
68         min: data[0],
69         max: data[data.length - 1],
70         median: data.length % 2 ? data[middle] : (data[middle - 1] + data[middle]) / 2,
71     };
72
73     // Compute the mean and variance using a numerically stable algorithm.
74     var squareSum = 0;
75     result.mean = data[0];
76     result.sum = data[0];
77     for (var i = 1; i < data.length; ++i) {
78         var x = data[i];
79         var delta = x - result.mean;
80         var sweep = i + 1.0;
81         result.mean += delta / sweep;
82         result.sum += x;
83         squareSum += delta * delta * (i / sweep);
84     }
85     result.variance = squareSum / data.length;
86     result.stdev = Math.sqrt(result.variance);
87     result.unit = unit || "ms";
88
89     return result;
90 }
91
92 PerfTestRunner.logStatistics = function (times) {
93     this.log("");
94     var statistics = this.computeStatistics(times, this.unit);
95     this.printStatistics(statistics);
96 }
97
98 PerfTestRunner.printStatistics = function (statistics) {
99     this.log("");
100     this.log("avg " + statistics.mean + " " + statistics.unit);
101     this.log("median " + statistics.median + " " + statistics.unit);
102     this.log("stdev " + statistics.stdev + " " + statistics.unit);
103     this.log("min " + statistics.min + " " + statistics.unit);
104     this.log("max " + statistics.max + " " + statistics.unit);
105 }
106
107 PerfTestRunner.gc = function () {
108     if (window.GCController)
109         window.GCController.collect();
110     else {
111         function gcRec(n) {
112             if (n < 1)
113                 return {};
114             var temp = {i: "ab" + i + (i / 100000)};
115             temp += "foo";
116             gcRec(n-1);
117         }
118         for (var i = 0; i < 1000; i++)
119             gcRec(10);
120     }
121 }
122
123 PerfTestRunner._runLoop = function () {
124     if (this._completedRuns < this._runCount) {
125         this.gc();
126         window.setTimeout(function () { PerfTestRunner._runner(); }, 0);
127     } else {
128         if (this._description)
129             this.log("Description: " + this._description);
130         this.logStatistics(this._results);
131         if (this._logLines) {
132             var logLines = this._logLines;
133             this._logLines = null;
134             var self = this;
135             logLines.forEach(function(text) { self.log(text); });
136         }
137         this._doneFunction();
138         if (window.testRunner)
139             testRunner.notifyDone();
140     }
141 }
142
143 PerfTestRunner._runner = function () {
144     var start = Date.now();
145     var totalTime = 0;
146
147     for (var i = 0; i < this._loopsPerRun; ++i) {
148         var returnValue = this._runFunction.call(window);
149         if (returnValue - 0 === returnValue) {
150             if (returnValue <= 0)
151                 this.log("runFunction returned a non-positive value: " + returnValue);
152             totalTime += returnValue;
153         }
154     }
155
156     // Assume totalTime can never be zero when _runFunction returns a number.
157     var time = totalTime ? totalTime : Date.now() - start;
158
159     this.ignoreWarmUpAndLog(time);
160     this._runLoop();
161 }
162
163 PerfTestRunner.ignoreWarmUpAndLog = function (result) {
164     this._completedRuns++;
165
166     var labeledResult = result + " " + this.unit;
167     if (this._completedRuns <= 0)
168         this.log("Ignoring warm-up run (" + labeledResult + ")");
169     else {
170         this._results.push(result);
171         this.log(labeledResult);
172     }
173 }
174
175 PerfTestRunner.initAndStartLoop = function() {
176     this._completedRuns = -1;
177     this.customRunFunction = null;
178     this._results = [];
179     this._logLines = window.testRunner ? [] : null;
180     this.log("Running " + this._runCount + " times");
181     this._runLoop();
182 }
183
184 PerfTestRunner.run = function (runFunction, loopsPerRun, runCount, doneFunction, description) {
185     this._runFunction = runFunction;
186     this._loopsPerRun = loopsPerRun || 10;
187     this._runCount = runCount || 20;
188     this._doneFunction = doneFunction || function () {};
189     this._description = description || "";
190     this.unit = 'ms';
191     this.initAndStartLoop();
192 }
193
194 PerfTestRunner.runPerSecond = function (test) {
195     this._doneFunction = function () { if (test.done) test.done(); };
196     this._description = test.description || "";
197     this._runCount = test.runCount || 20;
198     this._callsPerIteration = 1;
199     this.unit = 'runs/s';
200
201     this._test = test;
202     this._runner = this._perSecondRunner;
203     this.initAndStartLoop();
204 }
205
206 PerfTestRunner._perSecondRunner = function () {
207     var timeToRun = this._test.timeToRun || 750;
208     var totalTime = 0;
209     var i = 0;
210     var callsPerIteration = this._callsPerIteration;
211
212     if (this._test.setup)
213         this._test.setup();
214
215     while (totalTime < timeToRun) {
216         totalTime += this._perSecondRunnerIterator(callsPerIteration);
217         i += callsPerIteration;
218         if (this._completedRuns < 0 && totalTime < 100)
219             callsPerIteration = Math.max(10, 2 * callsPerIteration);
220     }
221     this._callsPerIteration = callsPerIteration;
222
223     this.ignoreWarmUpAndLog(i * 1000 / totalTime);
224     this._runLoop();
225 }
226
227 PerfTestRunner._perSecondRunnerIterator = function (callsPerIteration) {
228     var startTime = Date.now();
229     for (var i = 0; i < callsPerIteration; i++)
230         this._test.run();
231     return Date.now() - startTime;
232 }
233
234 if (window.testRunner) {
235     testRunner.waitUntilDone();
236     testRunner.dumpAsText();
237 }