376982394b0ef1681d54ac917a48694716f9bca3
[WebKit-https.git] / Tools / Scripts / build-webkit
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Apple Inc. All rights reserved.
4 # Copyright (C) 2009 Google Inc. All rights reserved.
5 # Copyright (C) 2010 moiji-mobile.com All rights reserved.
6 # Copyright (C) 2011 Research In Motion Limited. All rights reserved.
7 #
8 # Redistribution and use in source and binary forms, with or without
9 # modification, are permitted provided that the following conditions
10 # are met:
11 #
12 # 1.  Redistributions of source code must retain the above copyright
13 #     notice, this list of conditions and the following disclaimer. 
14 # 2.  Redistributions in binary form must reproduce the above copyright
15 #     notice, this list of conditions and the following disclaimer in the
16 #     documentation and/or other materials provided with the distribution. 
17 # 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
18 #     its contributors may be used to endorse or promote products derived
19 #     from this software without specific prior written permission. 
20 #
21 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
22 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
25 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32 # Build script wrapper for the WebKit Open Source Project.
33
34 use strict;
35 use File::Basename;
36 use File::Find;
37 use File::Spec;
38 use FindBin;
39 use Getopt::Long qw(:config pass_through);
40 use lib $FindBin::Bin;
41 use webkitdirs;
42 use webkitperl::FeatureList qw(getFeatureOptionList);
43 use POSIX;
44
45 sub cMakeArgsFromFeatures();
46 sub formatBuildTime($);
47 sub writeCongrats();
48
49 my $originalWorkingDirectory = getcwd();
50 chdirWebKit();
51
52 my $showHelp = 0;
53 my $clean = 0;
54 my $minimal = 0;
55 my $installHeaders;
56 my $installLibs;
57 my $prefixPath;
58 my $makeArgs = "";
59 my $cmakeArgs = "";
60 my $onlyWebKitProject = 0;
61 my $noWebKit1 = 0;
62 my $noWebKit2 = 0;
63 my $coverageSupport = 0;
64 my $startTime = time();
65
66 my @features = getFeatureOptionList();
67
68 # Additional environment parameters
69 push @ARGV, split(/ /, $ENV{'BUILD_WEBKIT_ARGS'}) if ($ENV{'BUILD_WEBKIT_ARGS'});
70
71 # Initialize values from defaults
72 foreach (@ARGV) {
73     if ($_ eq '--minimal') {
74         $minimal = 1;
75     }
76 }
77
78 # Initialize values from defaults
79 foreach (@features) {
80     ${$_->{value}} = ($minimal ? 0 : $_->{default});
81 }
82
83 my $programName = basename($0);
84 my $usage = <<EOF;
85 Usage: $programName [options] [options to pass to build system]
86   --help                            Show this help message
87   --clean                           Cleanup the build directory
88   --debug                           Compile with Debug configuration
89   --release                         Compile with Release configuration
90   --sdk=<sdk>                       Use a specific Xcode SDK (iOS and Mac only)
91   --device                          Use the current iphoneos.internal SDK (iOS only)
92   --simulator                       Use the current iphonesimulator SDK (iOS only)
93   --coverage                        Enable Code Coverage support (Mac only)
94
95   --blackberry                      Build the BlackBerry port on Mac/Linux
96   --efl                             Build the EFL port
97   --gtk                             Build the GTK+ port
98   --wincairo                        Build using Cairo (rather than CoreGraphics) on Windows
99   --wince                           Build the WinCE port
100
101   --inspector-frontend              Copy changes to the inspector front-end files to the build directory
102
103   --prefix=<path>                   Set installation prefix to the given path (Gtk/Efl/BlackBerry only)
104   --makeargs=<arguments>            Optional Makefile flags
105   --cmakeargs=<arguments>           Optional CMake flags (e.g. --cmakeargs="-DFOO=bar -DCMAKE_PREFIX_PATH=/usr/local")
106
107   --minimal                         No optional features, unless explicitly enabled
108
109   --only-webkit                     Build only the WebKit project
110   --no-webkit1                      Omit WebKit1 code from the build (EFL/GTK only)
111   --no-webkit2                      Omit WebKit2 code from the build
112
113 EOF
114
115 my %options = (
116     'help' => \$showHelp,
117     'clean' => \$clean,
118     'install-headers=s' => \$installHeaders,
119     'install-libs=s' => \$installLibs,
120     'prefix=s' => \$prefixPath,
121     'makeargs=s' => \$makeArgs,
122     'cmakeargs=s' => \$cmakeArgs,
123     'minimal' => \$minimal,
124     'only-webkit' => \$onlyWebKitProject,
125     'no-webkit1' => \$noWebKit1,
126     'no-webkit2' => \$noWebKit2,
127     'coverage' => \$coverageSupport,
128 );
129
130 # Build usage text and options list from features
131 foreach (@features) {
132     my $opt = sprintf("%-35s", "  --[no-]$_->{option}");
133     $usage .= "$opt $_->{desc} (default: $_->{default})\n";
134     $options{"$_->{option}!"} = $_->{value};
135 }
136
137 GetOptions(%options);
138
139 if ($showHelp) {
140    print STDERR $usage;
141    exit 1;
142 }
143
144 checkRequiredSystemConfig();
145 setConfiguration();
146
147 my $productDir = productDir();
148
149 sub unlinkZeroFiles()
150 {
151     my $file = $File::Find::name;
152     # Remove 0 byte sized files, except
153     # - directories (Because they are always 0 byte sized on Windows)
154     # - .d files used for dependency tracking
155     if (! -d $file && ! -s $file && $file !~ m/\.d$/) {
156         unlink $file;
157         print "0 byte sized file removed from build directory: $file\n";
158     }
159 }
160
161 # Check that all the project directories are there.
162 my @projects = ("Source/JavaScriptCore", "Source/WebCore", "Source/WebKit");
163
164 # Build WTF as a separate static library on ports which support it.
165 splice @projects, 0, 0, "Source/WTF" if isAppleMacWebKit() or isAppleWinWebKit() or isWinCairo();
166
167 for my $dir (@projects) {
168     if (! -d $dir) {
169         die "Error: No $dir directory found. Please do a fresh checkout.\n";
170     }
171 }
172
173 if (!-d "WebKitLibraries") {
174     die "Error: No WebKitLibraries directory found. Please do a fresh checkout.\n";
175 }
176
177 my @options = ();
178 my $hasFTLJIT = 0;
179 my $forceCLoop = 0;
180
181 if (isAppleMacWebKit()) {
182     push @options, XcodeOptions();
183     sub option($$$)
184     {
185         my ($feature, $isEnabled, $defaultValue) = @_;
186         return "" if $defaultValue == $isEnabled;
187         return $feature . "=" . ($isEnabled ? $feature : "");
188     }
189
190     foreach (@features) {
191         my $option = option($_->{define}, ${$_->{value}}, $_->{default});
192         $hasFTLJIT = 1 if ($_->{define} eq "ENABLE_FTL_JIT") and (${$_->{value}});
193         $forceCLoop = 1 if ($_->{define} eq "ENABLE_LLINT_C_LOOP") and (${$_->{value}});
194         push @options, $option unless $option eq "";
195     }
196     $ENV{ENABLE_FTL_JIT} = 1 if $hasFTLJIT;
197     $ENV{ENABLE_LLINT_C_LOOP} = 1 if $forceCLoop;
198
199     # ANGLE must come before WebCore
200     splice @projects, 0, 0, "Source/ThirdParty/ANGLE";
201
202     # WebKit2 is only supported in SnowLeopard and later at present.
203     push @projects, ("Source/WebKit2", "Tools/MiniBrowser") if osXVersion()->{"minor"} >= 6 and !$noWebKit2;
204
205     # WebInspectorUI must come before WebKit and WebKit2
206     unshift @projects, ("Source/WebInspectorUI");
207
208     # Build Tools needed for Apple ports
209     push @projects, ("Tools/DumpRenderTree", "Tools/WebKitTestRunner", "Source/ThirdParty/gtest", "Tools/TestWebKitAPI");
210
211     # Copy library and header from WebKitLibraries to a findable place in the product directory.
212     (system("perl", "Tools/Scripts/copy-webkitlibraries-to-product-directory", $productDir) == 0) or die;
213 } elsif (isWinCairo()) {
214     (system("perl Tools/Scripts/update-webkit-wincairo-libs") == 0) or die;
215 } elsif (isAppleWinWebKit()) {
216     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
217     # Will fail if WebKitSupportLibrary.zip is not in source root.
218     (system("perl Tools/Scripts/update-webkit-support-libs") == 0) or die;
219 }
220
221 # If asked to build just the WebKit project, overwrite the projects
222 # list after all of the port specific tweaks have been made to
223 # build options, etc.
224 @projects = ("Source/WebKit") if $onlyWebKitProject;
225
226 my $result = 0;
227
228 if (isInspectorFrontend()) {
229     $result = copyInspectorFrontendFiles();
230     exit exitStatus($result) if exitStatus($result);
231     @projects = ("Source/WebInspectorUI");
232 }
233
234 if (isEfl()) {
235     # By default we build using all of the available CPUs.
236     $makeArgs .= ($makeArgs ? " " : "") . "-j" . numberOfCPUs() if $makeArgs !~ /-j\s*\d+/;
237     $cmakeArgs = "-DENABLE_WEBKIT=OFF "  . $cmakeArgs if $noWebKit1;
238     $cmakeArgs = "-DENABLE_WEBKIT2=OFF " . $cmakeArgs if $noWebKit2;
239
240     # We remove CMakeCache to avoid the bots to reuse cached flags when
241     # we enable new features. This forces a reconfiguration.
242     removeCMakeCache();
243
244     buildCMakeProjectOrExit($clean, "Efl", $prefixPath, $makeArgs, (cmakeBasedPortArguments(), cMakeArgsFromFeatures()), $cmakeArgs);
245 }
246
247 if (isWinCE()) {
248     buildCMakeProjectOrExit($clean, "WinCE", $prefixPath, $makeArgs, (cmakeBasedPortArguments(), cMakeArgsFromFeatures()), $cmakeArgs);
249 }
250
251 if (isBlackBerry()) {
252     my $numberOfJobs;
253     if ($ENV{"USE_ICECC"}) {
254         $numberOfJobs = 50; # 50 is the number we choose for internal development
255     } else {
256         $numberOfJobs = numberOfCPUs();
257     }
258     $makeArgs .= ($makeArgs ? " " : "") . "-j" . $numberOfJobs if $makeArgs !~ /-j\s*\d+/;
259     $prefixPath = $ENV{"STAGE_DIR"} unless $prefixPath;
260     buildCMakeProjectOrExit($clean, "BlackBerry", $prefixPath, $makeArgs, (cmakeBasedPortArguments(), cMakeArgsFromFeatures()), $cmakeArgs);
261 }
262
263 # Build, and abort if the build fails.
264 for my $dir (@projects) {
265     chdir $dir or die;
266     $result = 0;
267
268     # For Gtk the WebKit project builds all others
269     if (isGtk() && $dir ne "Source/WebKit") {
270         chdirWebKit();
271         next;
272     }
273
274     my $project = basename($dir);
275     my $baseProductDir = baseProductDir();
276     if (isGtk()) {
277         $result = buildGtkProject($project, $clean, $prefixPath, $makeArgs, $noWebKit1, $noWebKit2, @features);
278     } elsif (isAppleMacWebKit()) {
279         my @local_options = @options;
280         push @local_options, XcodeCoverageSupportOptions() if $coverageSupport;
281         my $projectPath = $project =~ /gtest/ ? "xcode/gtest" : $project;
282         $result = buildXCodeProject($projectPath, $clean, @local_options, @ARGV);
283     } elsif (isAppleWinWebKit() || isWinCairo()) {
284         if ($project eq "WebKit") {
285             my $webkitSolutionPath = "WebKit.vcxproj/WebKit.sln";
286             $result = buildVisualStudioProject($webkitSolutionPath, $clean);
287             my $vsConfiguration = configuration();
288             if (usingVisualStudioExpress()) {
289                 # Visual Studio Express is so lame it can't stdout build failures.
290                 # So we find its logs and dump them to the console ourselves.
291                 open(my $OUTPUT_HANDLE, '<', "$baseProductDir/$vsConfiguration/BuildOutput.htm") or die "Could not open build log file at $baseProductDir/$vsConfiguration/BuildOutput.htm";
292                 print while (<$OUTPUT_HANDLE>);
293             }
294         }
295     }
296     # Various build* calls above may change the CWD.
297     chdirWebKit();
298
299     if (exitStatus($result)) {
300         my $scriptDir = relativeScriptsDir();
301         if (isAppleWinWebKit() || isWinCairo()) {
302             print "\n\n===== BUILD FAILED ======\n\n";
303             print "Please ensure you have run $scriptDir/update-webkit to install dependencies.\n\n";
304             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
305         }
306         exit exitStatus($result);
307     }
308 }
309
310 # Don't report the "WebKit is now built" message after a clean operation.
311 exit if $clean;
312
313 # Don't report congrats message if build was interrupted by the user.
314 exit if ($result & 127) == SIGINT;
315
316 # Explicitly chdir back to where exit will take us anyway, since the following "launcher"
317 # message is relative to that directory.
318 chdir $originalWorkingDirectory;
319
320 # Write out congratulations message.
321 writeCongrats();
322
323 exit 0;
324
325 sub cMakeArgsFromFeatures()
326 {
327     my @args;
328     foreach (@features) {
329         my $featureName = $_->{define};
330         if ($featureName) {
331             my $featureEnabled = ${$_->{value}} ? "ON" : "OFF";
332             push @args, "-D$featureName=$featureEnabled";
333         }
334     }
335     return @args;
336 }
337
338 sub formatBuildTime($)
339 {
340     my ($buildTime) = @_;
341
342     my $buildHours = int($buildTime / 3600);
343     my $buildMins = int(($buildTime - $buildHours * 3600) / 60);
344     my $buildSecs = $buildTime - $buildHours * 3600 - $buildMins * 60;
345
346     if ($buildHours) {
347         return sprintf("%dh:%02dm:%02ds", $buildHours, $buildMins, $buildSecs);
348     }
349     return sprintf("%02dm:%02ds", $buildMins, $buildSecs);
350 }
351
352 sub writeCongrats()
353 {
354     my $launcherPath = launcherPath();
355     my $launcherName = launcherName();
356     my $endTime = time();
357     my $buildTime = formatBuildTime($endTime - $startTime);
358
359     print "\n";
360     print "====================================================================\n";
361     print " WebKit is now built ($buildTime). \n";
362     print " To run $launcherName with this newly-built code, use the\n";
363     print " \"$launcherPath\" script.\n";
364     print "====================================================================\n";
365 }