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