Add option to specify output file location in sunspider.
[WebKit-https.git] / Tools / 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 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 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 $runInstruments = 0;
42 my $suite = "";
43 my $ubench = 0;
44 my $v8suite = 0;
45 my $parseonly = 0;
46 my $setBaseline = 0;
47 my $showHelp = 0;
48 my $testsPattern;
49 my $output = "";
50 my $noBuild = 0;
51 my $jsShellArgs="";
52
53 my $programName = basename($0);
54 my $usage = <<EOF;
55 Usage: $programName [options] [options to pass to build system]
56   --help            Show this help message
57   --set-baseline    Set baseline for future comparisons
58   --args            Arguments to pass to JavaScript shell
59   --root            Path to root tools build
60   --runs            Number of times to run tests (default: $testRuns)
61   --tests           Only run tests matching provided pattern
62   --instruments     Sample with the Mac OS X "Instruments" tool (Time Profile) (implies --runs=1)
63   --suite           Select a specific benchmark suite. The default is sunspider-0.9.1
64   --ubench          Use microbenchmark suite instead of regular tests. Same as --suite=ubench
65   --v8-suite        Use the V8 benchmark suite. Same as --suite=v8-v4
66   --parse-only      Use the parse-only benchmark suite. Same as --suite=parse-only
67   --output          Override the default output path and filename
68   --no-build        Do not try to build JSC before running the tests.
69 EOF
70
71 GetOptions('root=s' => sub { my ($x, $value) = @_; $root = $value; setConfigurationProductDir(Cwd::abs_path($root)); },
72            'runs=i' => \$testRuns,
73            'set-baseline' => \$setBaseline,
74            'args=s' => \$jsShellArgs,
75            'instruments' => \$runInstruments,
76            'suite=s' => \$suite,
77            'ubench' => \$ubench,
78            'v8-suite' => \$v8suite,
79            'parse-only' => \$parseonly,
80            'tests=s' => \$testsPattern,
81            'output=s' => \$output,
82            'help' => \$showHelp,
83            'no-build' => \$noBuild);
84
85 if ($showHelp) {
86    print STDERR $usage;
87    exit 1;
88 }
89
90 sub buildJSC
91 {
92     if (!defined($root)){
93         push(@ARGV,  "--" . $configuration);
94         
95         chdirWebKit();
96         my $buildResult = system currentPerlPath(), "Tools/Scripts/build-jsc", @ARGV;
97         if ($buildResult) {
98             print STDERR "Compiling jsc failed!\n";
99             exit exitStatus($buildResult);
100         }
101     }
102 }
103
104 sub setupEnvironmentForExecution($)
105 {
106     my ($productDir) = @_;
107     print "Starting sunspider with DYLD_FRAMEWORK_PATH set to point to built JavaScriptCore in $productDir.\n";
108     $ENV{DYLD_FRAMEWORK_PATH} = $productDir;
109     # FIXME: Other platforms may wish to augment this method to use LD_LIBRARY_PATH, etc.
110 }
111
112 unless ($noBuild) {
113     buildJSC();
114 }
115
116 chdirWebKit();
117 chdir("PerformanceTests/SunSpider");
118
119 my $productDir = jscProductDir();
120
121 setupEnvironmentForExecution($productDir);
122 my @args = ("--shell", jscPath($productDir), "--runs", $testRuns);
123 # This code could be removed if we chose to pass extra args to sunspider instead of Xcode
124 push @args, "--set-baseline" if $setBaseline;
125 push @args, "--instruments" if $runInstruments;
126 push @args, "--suite=${suite}" if $suite;
127 push @args, "--ubench" if $ubench;
128 push @args, "--v8-suite" if $v8suite;
129 push @args, "--parse-only" if $parseonly;
130 push @args, "--tests", $testsPattern if $testsPattern;
131 push @args, "--args", $jsShellArgs if $jsShellArgs;
132 push @args, "--output", $output if $output;
133
134 exec currentPerlPath(), "./sunspider", @args;