2009-10-12 Dirk Schulze <krit@webkit.org>
[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 $v8suite = 0;
41 my $parseonly = 0;
42 my $jsShellPath;
43 my $jsShellArgs = "";
44 my $setBaseline = 0;
45 my $testsPattern;
46 my $testRuns = 10;
47
48 my $programName = basename($0);
49 my $usage = <<EOF;
50 Usage: $programName --shell=[path] [options]
51   --help            Show this help message
52   --set-baseline    Set baseline for future comparisons
53   --shell           Path to JavaScript shell
54   --args            Arguments to pass to JavaScript shell
55   --runs            Number of times to run tests (default: $testRuns)
56   --tests           Only run tests matching provided pattern
57   --shark           Sample execution time with the Mac OS X "Shark" performance testing tool (implies --runs=1)
58   --shark20         Like --shark, but with a 20 microsecond sampling interval
59   --shark-cache     Like --shark, but performs a L2 cache-miss sample instead of time sample
60   --ubench          Use microbenchmark suite instead of regular tests (to check for core execution regressions)
61   --v8-suite        Use the V8 benchmark suite
62   --parse-only      Use the parse-only benchmark suite
63 EOF
64
65 GetOptions('runs=i' => \$testRuns,
66            'set-baseline' => \$setBaseline,
67            'shell=s' => \$jsShellPath,
68            'args=s' => \$jsShellArgs,
69            'shark' => \$runShark,
70            'shark20' => \$runShark20,
71            'shark-cache' => \$runSharkCache,
72            'ubench' => \$ubench,
73            'v8-suite' => \$v8suite,
74            'parse-only' => \$parseonly,
75            'tests=s' => \$testsPattern,
76            'help' => \$showHelp);
77
78 my $resultDirectory = "sunspider-results";
79 $resultDirectory = "ubench-results" if ($ubench);
80 $resultDirectory = "v8-results" if ($v8suite);
81 $resultDirectory = "parse-only-results" if ($parseonly);
82
83 $runShark = 1 if $runSharkCache;
84 $runShark = 20 if $runShark20;
85 $testRuns = 1 if $runShark;
86 if ($runShark && ! -x "/usr/bin/shark") {
87     die "Please install CHUD tools from http://developer.apple.com/tools/download/\n";
88 }
89
90 my $sharkCacheProfileIndex = 0;
91 if ($runSharkCache) {
92     my $sharkProfileList = `shark -l 2>&1`;
93     for my $profile (split(/\n/, $sharkProfileList)) {
94         $profile =~ /(\d+) - (.+)/;
95         next  unless (defined $1);
96         my $profileIndex = $1;
97         my $profileName = $2;
98         if ($profileName =~ /L2 Cache/) {
99             $sharkCacheProfileIndex = $profileIndex;
100             print "Using Shark L2 Cache Miss Profile: " . $profile . "\n";
101             last;
102         }
103     }
104     die "Failed to find L2 Cache Miss Profile for --shark-cache\n"  unless ($sharkCacheProfileIndex);
105 }
106
107 if (!$jsShellPath || $showHelp) {
108    print STDERR $usage;
109    exit 1;
110 }
111
112 sub dumpToFile($$)
113 {
114     my ($contents, $path) = @_;
115     open FILE, ">", $path or die "Failed to open $path";
116     print FILE $contents;
117     close FILE;
118 }
119
120 my @tests = ();
121 my @categories = ();
122 my %uniqueCategories = ();
123
124 sub loadTestsList()
125 {
126     my $testlist = "LIST";
127     $testlist = "LIST-UBENCH" if ($ubench);
128     $testlist = "LIST-V8" if ($v8suite);
129     $testlist = "LIST-PARSE-ONLY" if ($parseonly);
130
131     open TESTLIST, "<", "tests/${testlist}" or die "Can't find ./tests/${testlist}";
132     while (<TESTLIST>) {
133         chomp;
134         next unless !$testsPattern || /$testsPattern/;
135         
136         push @tests, $_;
137         my $category = $_;
138         $category =~ s/-.*//;
139         if (!$uniqueCategories{$category}) {
140             push @categories, $category;
141             $uniqueCategories{$category} = $category;
142         }
143     }
144     close TESTLIST;
145 }
146
147 my $timeString = strftime "%Y-%m-%d-%H.%M.%S", localtime $^T;
148 my $prefixFile = "$resultDirectory/sunspider-test-prefix.js";
149 my $resultsFile = "$resultDirectory/sunspider-results-$timeString.js";
150
151 sub writePrefixFile()
152 {
153     my $prefix = "var tests = [ " . join(", ", map { '"' . $_ . '"' } @tests) . " ];\n";
154     $prefix .= "var categories = [ " . join(", ", map { '"' . $_ . '"' } @categories) . " ];\n";
155
156     mkdir "$resultDirectory";
157     dumpToFile($prefix, $prefixFile);
158 }
159
160 sub runTestsOnce($)
161 {
162     my ($useShark) = @_;
163     my $shellArgs = $jsShellArgs . " -f $prefixFile -f resources/sunspider-standalone-driver.js 2> " . File::Spec->devnull();
164     my $output;
165     if ($useShark) {
166         my $intervalArg = $useShark == 20 ? "-I 20u" : "";
167         my $cacheArg = $runSharkCache ? "-c $sharkCacheProfileIndex" : "";
168         $output = `shark $intervalArg $cacheArg -i -1-q "$jsShellPath" $shellArgs`;
169     } else {
170         $output = `"$jsShellPath" $shellArgs | grep -v break`;
171     }
172     return $output;
173 }
174
175 sub newestFile($$)
176 {
177     my ($dir, $pattern) = @_;
178
179     my $newestAge;
180     my $newestFile = "";
181     opendir DIR, $dir or die;
182     for my $file (readdir DIR) {
183         if ($file =~ $pattern) {
184             my $age = -M "$dir/$file";
185             if (!defined $newestAge || $age < $newestAge) {
186                 $newestFile = $file;
187                 $newestAge = $age;
188             }
189         }
190     }
191     closedir DIR;
192
193     return "$dir/$newestFile";
194 }
195
196 loadTestsList();
197 if ($testsPattern) {
198     print STDERR "Found " . scalar(@tests) . " tests matching '" . $testsPattern . "'\n";
199 } else {
200     print STDERR "Found " . scalar(@tests) . " tests\n";
201 }
202 die "No tests to run"  unless scalar(@tests);
203 print STDERR "Running SunSpider once for warmup, then " . ($runShark ? "under Shark" : "$testRuns time" . ($testRuns == 1 ? "" : "s")) . "\n";
204 writePrefixFile();
205
206 runTestsOnce(0);
207 print "Discarded first run.\n";
208
209 my $result;
210 my $count = 0;
211 my @results = ();
212 my $total = 0;
213 print "[";
214 while ($count++ < $testRuns) {
215     $result = runTestsOnce($runShark);
216     $result =~ s/\r\n/\n/g;
217     chomp $result;
218     push @results, $result;
219     print $result;
220     print ",\n" unless ($count == $testRuns);
221 }
222 print "]\n";
223
224 my $output = "var output = [\n" . join(",\n", @results) . "\n];\n";
225 dumpToFile($output, $resultsFile);
226 dumpToFile(File::Spec->rel2abs($resultsFile), "$resultDirectory/baseline-filename.txt") if $setBaseline;
227
228 system("$jsShellPath", "-f", $prefixFile, "-f", $resultsFile, "-f", "resources/sunspider-analyze-results.js");
229
230 if ($runShark) {
231     my $newestMShark = newestFile(".", qr/\.mshark$/);
232     if ($newestMShark) {
233         my $profileFile = "$resultDirectory/sunspider-profile-$timeString.mshark";
234         rename $newestMShark, $profileFile or die;
235         exec "/usr/bin/open", $profileFile;
236     }
237 }