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