2008-06-07 Cameron Zwarich <cwzwarich@uwaterloo.ca>
[WebKit-https.git] / WebKitTools / Scripts / run-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 FindBin;
29 use Getopt::Long qw(:config pass_through);
30 use lib $FindBin::Bin;
31 use webkitdirs;
32 use POSIX;
33
34 # determine configuration, but default to "Release" instead of last-used configuration
35 setConfiguration("Release");
36 setConfiguration();
37 my $configuration = configuration();
38
39 my $root;
40 my $testRuns = 10; # This number may be different from what sunspider defaults to (that's OK)
41 my $runShark = 0;
42 my $runShark20 = 0;
43 my $runSharkCache = 0;
44 my $ubench = 0;
45 my $setBaseline = 0;
46 my $showHelp = 0;
47 my $testsPattern;
48
49 my $programName = basename($0);
50 my $usage = <<EOF;
51 Usage: $programName [options] [options to pass to build system]
52   --help            Show this help message
53   --set-baseline    Set baseline for future comparisons
54   --root            Path to root tools build
55   --runs            Number of times to run tests (default: $testRuns)
56   --tests           Only run tests matching provided pattern
57   --shark           Sample 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 EOF
62
63 GetOptions('root=s' => sub { my ($x, $value) = @_; $root = $value; setConfigurationProductDir(Cwd::abs_path($root)); },
64            'runs=i' => \$testRuns,
65            'set-baseline' => \$setBaseline,
66            'shark' => \$runShark,
67            'shark20' => \$runShark20,
68            'shark-cache' => \$runSharkCache,
69            'ubench' => \$ubench,
70            'tests=s' => \$testsPattern,
71            'help' => \$showHelp);
72
73 if ($showHelp) {
74    print STDERR $usage;
75    exit 1;
76 }
77
78 sub buildTestKJS
79 {
80     if (!defined($root)){
81         push(@ARGV,  "--" . $configuration);
82         
83         chdirWebKit();
84         my $buildResult = system "WebKitTools/Scripts/build-testkjs", @ARGV;
85         if ($buildResult) {
86             print STDERR "Compiling testkjs failed!\n";
87             exit exitStatus($buildResult);
88         }
89     }
90 }
91
92 sub setupEnvironmentForExecution($)
93 {
94     my ($productDir) = @_;
95     print "Starting sunspider with DYLD_FRAMEWORK_PATH set to point to built JavaScriptCore in $productDir.\n";
96     $ENV{DYLD_FRAMEWORK_PATH} = $productDir;
97     # FIXME: Other platforms may wish to augment this method to use LD_LIBRARY_PATH, etc.
98 }
99
100 sub testKJSPath($)
101 {
102     my ($productDir) = @_;
103     my $testkjsName = "testkjs";
104     $testkjsName .= "_debug"  if (isCygwin() && ($configuration eq "Debug"));
105     return "$productDir/$testkjsName";
106 }
107
108 buildTestKJS();
109
110 chdirWebKit();
111 chdir("SunSpider");
112
113 my $productDir = productDir();
114 # FIXME: This hack should be pushed down into productDir()
115 $productDir .= "/JavaScriptCore" if (isQt() or isGtk());
116
117 setupEnvironmentForExecution($productDir);
118 my @args = ("--shell", testKJSPath($productDir), "--runs", $testRuns);
119 # This code could be removed if we chose to pass extra args to sunspider instead of Xcode
120 push @args, "--set-baseline" if $setBaseline;
121 push @args, "--shark" if $runShark;
122 push @args, "--shark20" if $runShark20;
123 push @args, "--shark-cache" if $runSharkCache;
124 push @args, "--ubench" if $ubench;
125 push @args, "--tests", $testsPattern if $testsPattern;
126
127 exec "./sunspider", @args;