35ae0451dd13dcb3ca86db3d31af45fbc81983c7
[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.now = window.performance && window.performance.webkitNow ? function () { return window.performance.webkitNow(); } : Date.now;
31
32 PerfTestRunner.log = function (text) {
33     if (this._logLines) {
34         this._logLines.push(text);
35         return;
36     }
37     if (!document.getElementById("log")) {
38         var pre = document.createElement('pre');
39         pre.id = 'log';
40         document.body.appendChild(pre);
41     }
42     document.getElementById("log").innerHTML += text + "\n";
43     window.scrollTo(0, document.body.height);
44 }
45
46 PerfTestRunner.info = function (text) {
47     this.log("Info: " + text);
48 }
49
50 PerfTestRunner.logInfo = function (text) {
51     if (!window.testRunner)
52         this.log(text);
53 }
54
55 PerfTestRunner.loadFile = function (path) {
56     var xhr = new XMLHttpRequest();
57     xhr.open("GET", path, false);
58     xhr.send(null);
59     return xhr.responseText;
60 }
61
62 PerfTestRunner.computeStatistics = function (times, unit) {
63     var data = times.slice();
64
65     // Add values from the smallest to the largest to avoid the loss of significance
66     data.sort(function(a,b){return a-b;});
67
68     var middle = Math.floor(data.length / 2);
69     var result = {
70         min: data[0],
71         max: data[data.length - 1],
72         median: data.length % 2 ? data[middle] : (data[middle - 1] + data[middle]) / 2,
73     };
74
75     // Compute the mean and variance using a numerically stable algorithm.
76     var squareSum = 0;
77     result.values = times;
78     result.mean = data[0];
79     result.sum = data[0];
80     for (var i = 1; i < data.length; ++i) {
81         var x = data[i];
82         var delta = x - result.mean;
83         var sweep = i + 1.0;
84         result.mean += delta / sweep;
85         result.sum += x;
86         squareSum += delta * delta * (i / sweep);
87     }
88     result.variance = squareSum / data.length;
89     result.stdev = Math.sqrt(result.variance);
90     result.unit = unit || "ms";
91
92     return result;
93 }
94
95 PerfTestRunner.logStatistics = function (values, unit, title) {
96     var statistics = this.computeStatistics(values, unit);
97     this.printStatistics(statistics, title);
98 }
99
100 PerfTestRunner.printStatistics = function (statistics, title) {
101     this.log("");
102     this.log(title);
103     if (statistics.values)
104         this.log("values " + statistics.values.join(', ') + " " + statistics.unit);
105     this.log("avg " + statistics.mean + " " + statistics.unit);
106     this.log("median " + statistics.median + " " + statistics.unit);
107     this.log("stdev " + statistics.stdev + " " + statistics.unit);
108     this.log("min " + statistics.min + " " + statistics.unit);
109     this.log("max " + statistics.max + " " + statistics.unit);
110 }
111
112 PerfTestRunner.gc = function () {
113     if (window.GCController)
114         window.GCController.collect();
115     else {
116         function gcRec(n) {
117             if (n < 1)
118                 return {};
119             var temp = {i: "ab" + i + (i / 100000)};
120             temp += "foo";
121             gcRec(n-1);
122         }
123         for (var i = 0; i < 1000; i++)
124             gcRec(10);
125     }
126 }
127
128 PerfTestRunner._runLoop = function () {
129     if (this._completedRuns < this._runCount) {
130         this.gc();
131         window.setTimeout(function () { PerfTestRunner._runner(); }, 0);
132     } else {
133         if (this._description)
134             this.log("Description: " + this._description);
135         this.logStatistics(this._results, this.unit, "Time:");
136         if (this._jsHeapResults.length) {
137             this.logStatistics(this._jsHeapResults, "bytes", "JS Heap:");
138             this.logStatistics(this._mallocHeapResults, "bytes", "Malloc:");
139         }
140         if (this._logLines) {
141             var logLines = this._logLines;
142             this._logLines = null;
143             var self = this;
144             logLines.forEach(function(text) { self.log(text); });
145         }
146         this._doneFunction();
147         if (window.testRunner)
148             testRunner.notifyDone();
149     }
150 }
151
152 PerfTestRunner._runner = function () {
153     var start = this.now();
154     var returnValue = this._runFunction.call(window);
155     var end = this.now();
156
157     if (returnValue - 0 === returnValue) {
158         if (returnValue <= 0)
159             this.log("runFunction returned a non-positive value: " + returnValue);
160         time = returnValue;
161     } else
162         time = end - start;
163
164     this.ignoreWarmUpAndLog(time);
165     this._runLoop();
166 }
167
168 PerfTestRunner.storeHeapResults = function() {
169     if (!window.internals)
170         return;
171     this._jsHeapResults.push(this.getUsedJSHeap());
172     this._mallocHeapResults.push(this.getUsedMallocHeap());
173 }
174
175 PerfTestRunner.getUsedMallocHeap = function() {
176     var stats = window.internals.mallocStatistics();
177     return stats.committedVMBytes - stats.freeListBytes;
178 }
179
180 PerfTestRunner.getUsedJSHeap = function() {
181     return console.memory.usedJSHeapSize;
182 }
183
184 PerfTestRunner.getAndPrintMemoryStatistics = function() {
185     if (!window.internals)
186         return;
187     var jsMemoryStats = PerfTestRunner.computeStatistics([PerfTestRunner.getUsedJSHeap()], "bytes");
188     PerfTestRunner.printStatistics(jsMemoryStats, "JS Heap:");
189
190     var mallocMemoryStats = PerfTestRunner.computeStatistics([PerfTestRunner.getUsedMallocHeap()], "bytes");
191     PerfTestRunner.printStatistics(mallocMemoryStats, "Malloc:");
192 }
193
194 PerfTestRunner.ignoreWarmUpAndLog = function (result) {
195     this._completedRuns++;
196
197     var labeledResult = result + " " + this.unit;
198     if (this._completedRuns <= 0)
199         this.log("Ignoring warm-up run (" + labeledResult + ")");
200     else {
201         this._results.push(result);
202         this.storeHeapResults();
203         this.log(labeledResult);
204     }
205 }
206
207 PerfTestRunner.initAndStartLoop = function() {
208     this._completedRuns = -1;
209     this.customRunFunction = null;
210     this._results = [];
211     this._jsHeapResults = [];
212     this._mallocHeapResults = [];
213     this._logLines = window.testRunner ? [] : null;
214     this.log("Running " + this._runCount + " times");
215     this._runLoop();
216 }
217
218 PerfTestRunner.measureTime = function (test) {
219     this._runFunction = test.run;
220     this._doneFunction = test.done || function () {};
221     this._description = test.description || "";
222     this._runCount = test.runCount || 20;
223     this._callsPerIteration = 1;
224     this.unit = 'ms';
225
226     this._test = test;
227     this.initAndStartLoop();
228 }
229
230 PerfTestRunner.runPerSecond = function (test) {
231     this._doneFunction = test.done || function () {};
232     this._description = test.description || "";
233     this._runCount = 20;
234     this._callsPerIteration = 1;
235     this.unit = 'runs/s';
236
237     this._test = test;
238     this._runner = this._perSecondRunner;
239     this.initAndStartLoop();
240 }
241
242 PerfTestRunner._perSecondRunner = function () {
243     var timeToRun = this._test.timeToRun || 750;
244     var totalTime = 0;
245     var i = 0;
246     var callsPerIteration = this._callsPerIteration;
247
248     if (this._test.setup)
249         this._test.setup();
250
251     while (totalTime < timeToRun) {
252         totalTime += this._perSecondRunnerIterator(callsPerIteration);
253         i += callsPerIteration;
254         if (this._completedRuns < 0 && totalTime < 100)
255             callsPerIteration = Math.max(10, 2 * callsPerIteration);
256     }
257     this._callsPerIteration = callsPerIteration;
258
259     this.ignoreWarmUpAndLog(i * 1000 / totalTime);
260     this._runLoop();
261 }
262
263 PerfTestRunner._perSecondRunnerIterator = function (callsPerIteration) {
264     var startTime = this.now();
265     for (var i = 0; i < callsPerIteration; i++)
266         this._test.run();
267     return this.now() - startTime;
268 }
269
270 if (window.testRunner) {
271     testRunner.waitUntilDone();
272     testRunner.dumpAsText();
273 }