2008-09-02 Cameron Zwarich <cwzwarich@uwaterloo.ca>
[WebKit-https.git] / SunSpider / sunspider
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2007 Apple Inc. All rights reserved.
4 # Copyright (C) 2007 Eric Seidel <eric@webkit.org>
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 # 1. Redistributions of source code must retain the above copyright
10 #    notice, this list of conditions and the following disclaimer.
11 # 2. Redistributions in binary form must reproduce the above copyright
12 #    notice, this list of conditions and the following disclaimer in the
13 #    documentation and/or other materials provided with the distribution.
14 #
15 # THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 # PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22 # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23 # OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26
27 use strict;
28 use Getopt::Long;
29 use File::Basename;
30 use File::Spec;
31 use Cwd;
32 use POSIX qw(strftime);
33 use Time::HiRes qw(gettimeofday tv_interval);
34
35 my $showHelp = 0;
36 my $runShark = 0;
37 my $runShark20 = 0;
38 my $runSharkCache = 0;
39 my $ubench = 0;
40 my $jsShellPath;
41 my $setBaseline = 0;
42 my $testsPattern;
43 my $testRuns = 10;
44
45 my $programName = basename($0);
46 my $usage = <<EOF;
47 Usage: $programName --shell=[path] [options]
48   --help            Show this help message
49   --set-baseline    Set baseline for future comparisons
50   --shell           Path to JavaScript shell
51   --runs            Number of times to run tests (default: $testRuns)
52   --tests           Only run tests matching provided pattern
53   --shark           Sample execution time with the Mac OS X "Shark" performance testing tool (implies --runs=1)
54   --shark20         Like --shark, but with a 20 microsecond sampling interval
55   --shark-cache     Like --shark, but performs a L2 cache-miss sample instead of time sample
56   --ubench          Use microbenchmark suite instead of regular tests (to check for core execution regressions)
57 EOF
58
59 GetOptions('runs=i' => \$testRuns,
60            'set-baseline' => \$setBaseline,
61            'shell=s' => \$jsShellPath,
62            'shark' => \$runShark,
63            'shark20' => \$runShark20,
64            'shark-cache' => \$runSharkCache,
65            'ubench' => \$ubench,
66            'tests=s' => \$testsPattern,
67            'help' => \$showHelp);
68
69 $runShark = 1 if $runSharkCache;
70 $runShark = 20 if $runShark20;
71 $testRuns = 1 if $runShark;
72 if ($runShark && ! -x "/usr/bin/shark") {
73     die "Please install CHUD tools from http://developer.apple.com/tools/download/\n";
74 }
75
76 my $sharkCacheProfileIndex = 0;
77 if ($runSharkCache) {
78     my $sharkProfileList = `shark -l 2>&1`;
79     for my $profile (split(/\n/, $sharkProfileList)) {
80         $profile =~ /(\d+) - (.+)/;
81         next  unless (defined $1);
82         my $profileIndex = $1;
83         my $profileName = $2;
84         if ($profileName =~ /L2 Cache/) {
85             $sharkCacheProfileIndex = $profileIndex;
86             print "Using Shark L2 Cache Miss Profile: " . $profile . "\n";
87             last;
88         }
89     }
90     die "Failed to find L2 Cache Miss Profile for --shark-cache\n"  unless ($sharkCacheProfileIndex);
91 }
92
93 if (!$jsShellPath || $showHelp) {
94    print STDERR $usage;
95    exit 1;
96 }
97
98 sub dumpToFile($$)
99 {
100     my ($contents, $path) = @_;
101     open FILE, ">", $path or die "Failed to open $path";
102     print FILE $contents;
103     close FILE;
104 }
105
106 my @tests = ();
107 my @categories = ();
108 my %uniqueCategories = ();
109
110 sub loadTestsList()
111 {
112     my $testlist = "LIST";
113     $testlist = "LIST-UBENCH" if ($ubench);
114
115     open TESTLIST, "<", "tests/${testlist}" or die "Can't find ./tests/LIST";
116     while (<TESTLIST>) {
117         chomp;
118         next unless !$testsPattern || /$testsPattern/;
119         
120         push @tests, $_;
121         my $category = $_;
122         $category =~ s/-.*//;
123         if (!$uniqueCategories{$category}) {
124             push @categories, $category;
125             $uniqueCategories{$category} = $category;
126         }
127     }
128     close TESTLIST;
129 }
130
131 my $timeString = strftime "%Y-%m-%d-%H.%M.%S", localtime $^T;
132 my $prefixFile = "tmp/sunspider-test-prefix.js";
133 my $resultsFile = "tmp/sunspider-results-$timeString.js";
134
135 sub writePrefixFile()
136 {
137     my $prefix = "var tests = [ " . join(", ", map { '"' . $_ . '"' } @tests) . " ];\n";
138     $prefix .= "var categories = [ " . join(", ", map { '"' . $_ . '"' } @categories) . " ];\n";
139
140     mkdir "tmp";
141     dumpToFile($prefix, $prefixFile);
142 }
143
144 sub runTestsOnce($)
145 {
146     my ($useShark) = @_;
147     my $shellArgs = "$prefixFile resources/sunspider-standalone-driver.js 2> /dev/null";
148     my $output;
149     if ($useShark) {
150         my $intervalArg = $useShark == 20 ? "-I 20u" : "";
151         my $cacheArg = $runSharkCache ? "-c $sharkCacheProfileIndex" : "";
152         $output = `shark $intervalArg $cacheArg -i -1-q "$jsShellPath" $shellArgs`;
153     } else {
154         $output = `"$jsShellPath" $shellArgs | grep -v break`;
155     }
156     return $output;
157 }
158
159 sub newestFile($$)
160 {
161     my ($dir, $pattern) = @_;
162
163     my $newestAge;
164     my $newestFile = "";
165     opendir DIR, $dir or die;
166     for my $file (readdir DIR) {
167         if ($file =~ $pattern) {
168             my $age = -M "$dir/$file";
169             if (!defined $newestAge || $age < $newestAge) {
170                 $newestFile = $file;
171                 $newestAge = $age;
172             }
173         }
174     }
175     closedir DIR;
176
177     return "$dir/$newestFile";
178 }
179
180 loadTestsList();
181 if ($testsPattern) {
182     print STDERR "Found " . scalar(@tests) . " tests matching '" . $testsPattern . "'\n";
183 } else {
184     print STDERR "Found " . scalar(@tests) . " tests\n";
185 }
186 die "No tests to run"  unless scalar(@tests);
187 print STDERR "Running SunSpider once for warmup, then " . ($runShark ? "under Shark" : "$testRuns time" . ($testRuns == 1 ? "" : "s")) . "\n";
188 writePrefixFile();
189
190 runTestsOnce(0);
191 print "Discarded first run.\n";
192
193 my $result;
194 my $count = 0;
195 my @results = ();
196 my $total = 0;
197 print "[";
198 while ($count++ < $testRuns) {
199     $result = runTestsOnce($runShark);
200     $result =~ s/\r\n/\n/g;
201     chomp $result;
202     push @results, $result;
203     print $result;
204     print ",\n" unless ($count == $testRuns);
205 }
206 print "]\n";
207
208 my $output = "var output = [\n" . join(",\n", @results) . "\n];\n";
209 dumpToFile($output, $resultsFile);
210 dumpToFile(File::Spec->rel2abs($resultsFile), "tmp/baseline-filename.txt") if $setBaseline;
211
212 system("$jsShellPath", $prefixFile, $resultsFile, "resources/sunspider-analyze-results.js");
213
214 if ($runShark) {
215     my $newestMShark = newestFile(".", qr/\.mshark$/);
216     if ($newestMShark) {
217         my $profileFile = "tmp/sunspider-profile-$timeString.mshark";
218         rename $newestMShark, $profileFile or die;
219         exec "/usr/bin/open", $profileFile;
220     }
221 }