e3dd91939b3d514030893f51a228c67837dd9e56
[WebKit-https.git] / Tools / Scripts / build-webkit
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 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 # Update defaults from Qt's project file
69 if (isQt()) {
70     # Take a sneek peek at the arguments, since we will need the qmake binary early
71     # on to do profile parsing. We also need to know if we're showing the help-text.
72     foreach (@ARGV) {
73         if (/^--qmake=(.*)/) {
74             setQmakeBinaryPath($1);
75         } elsif (/^--help$/) {
76             $showHelp = 1;
77         }
78     }
79
80     my %qtDefaults;
81     if ($showHelp) {
82         %qtDefaults = qtFeatureDefaults();
83     }
84
85     foreach (@features) {
86         $_->{default} = (%qtDefaults ? $qtDefaults{$_->{define}} || 0 : -1);
87     }
88 }
89
90 # Additional environment parameters
91 push @ARGV, split(/ /, $ENV{'BUILD_WEBKIT_ARGS'}) if ($ENV{'BUILD_WEBKIT_ARGS'});
92
93 # Initialize values from defaults
94 foreach (@ARGV) {
95     if ($_ eq '--minimal') {
96         $minimal = 1;
97     }
98 }
99
100 # Initialize values from defaults
101 foreach (@features) {
102     ${$_->{value}} = ($minimal ? 0 : $_->{default});
103 }
104
105 my $programName = basename($0);
106 my $usage = <<EOF;
107 Usage: $programName [options] [options to pass to build system]
108   --help                            Show this help message
109   --clean                           Cleanup the build directory
110   --debug                           Compile with Debug configuration
111   --release                         Compile with Release configuration
112   --sdk=<sdk>                       Use a specific Xcode SDK (iOS and Mac only)
113   --device                          Use the current iphoneos.internal SDK (iOS only)
114   --simulator                       Use the current iphonesimulator SDK (iOS only)
115   --coverage                        Enable Code Coverage support (Mac only)
116
117   --blackberry                      Build the BlackBerry port on Mac/Linux
118   --efl                             Build the EFL port
119   --gtk                             Build the GTK+ port
120   --qt                              Build the Qt port
121   --wincairo                        Build using Cairo (rather than CoreGraphics) on Windows
122   --wince                           Build the WinCE port
123
124   --inspector-frontend              Copy changes to the inspector front-end files to the build directory
125
126   --install-headers=<path>          Set installation path for the headers (Qt only)
127   --install-libs=<path>             Set installation path for the libraries (Qt only)
128
129   --prefix=<path>                   Set installation prefix to the given path (Gtk/Efl/BlackBerry only)
130   --makeargs=<arguments>            Optional Makefile flags
131   --qmakearg=<arguments>            Optional qmake flags (Qt only, e.g. --qmakearg="CONFIG+=webkit2" to build WebKit2)
132   --cmakeargs=<arguments>           Optional CMake flags (e.g. --cmakeargs="-DFOO=bar -DCMAKE_PREFIX_PATH=/usr/local")
133
134   --minimal                         No optional features, unless explicitly enabled
135
136   --only-webkit                     Build only the WebKit project
137   --no-webkit1                      Omit WebKit1 code from the build (Qt/EFL/GTK only)
138   --no-webkit2                      Omit WebKit2 code from the build
139
140 EOF
141
142 my %options = (
143     'help' => \$showHelp,
144     'clean' => \$clean,
145     'install-headers=s' => \$installHeaders,
146     'install-libs=s' => \$installLibs,
147     'prefix=s' => \$prefixPath,
148     'makeargs=s' => \$makeArgs,
149     'cmakeargs=s' => \$cmakeArgs,
150     'minimal' => \$minimal,
151     'only-webkit' => \$onlyWebKitProject,
152     'no-webkit1' => \$noWebKit1,
153     'no-webkit2' => \$noWebKit2,
154     'coverage' => \$coverageSupport,
155 );
156
157 # Build usage text and options list from features
158 foreach (@features) {
159     my $opt = sprintf("%-35s", "  --[no-]$_->{option}");
160     $usage .= "$opt $_->{desc} (default: $_->{default})\n";
161     $options{"$_->{option}!"} = $_->{value};
162 }
163
164 GetOptions(%options);
165
166 if ($showHelp) {
167    print STDERR $usage;
168    exit 1;
169 }
170
171 checkRequiredSystemConfig();
172 setConfiguration();
173
174 my $productDir = productDir();
175
176 # Remove 0 byte sized files from productDir after slave lost for Qt buildbots.
177 File::Find::find(\&unlinkZeroFiles, $productDir) if (isQt() && -e $productDir);
178
179 sub unlinkZeroFiles()
180 {
181     my $file = $File::Find::name;
182     # Remove 0 byte sized files, except
183     # - directories (Because they are always 0 byte sized on Windows)
184     # - .d files used for dependency tracking
185     if (! -d $file && ! -s $file && $file !~ m/\.d$/) {
186         unlink $file;
187         print "0 byte sized file removed from build directory: $file\n";
188     }
189 }
190
191 # Check that all the project directories are there.
192 my @projects = ("Source/JavaScriptCore", "Source/WebCore", "Source/WebKit");
193
194 # Build WTF as a separate static library on ports which support it.
195 splice @projects, 0, 0, "Source/WTF" if isAppleMacWebKit() or isAppleWinWebKit();
196
197 for my $dir (@projects) {
198     if (! -d $dir) {
199         die "Error: No $dir directory found. Please do a fresh checkout.\n";
200     }
201 }
202
203 if (!isQt() && !-d "WebKitLibraries") {
204     die "Error: No WebKitLibraries directory found. Please do a fresh checkout.\n";
205 }
206
207 my @options = ();
208
209 if (isAppleMacWebKit()) {
210     push @options, XcodeOptions();
211
212     sub option($$$)
213     {
214         my ($feature, $isEnabled, $defaultValue) = @_;
215         return "" if $defaultValue == $isEnabled;
216         return $feature . "=" . ($isEnabled ? $feature : "");
217     }
218
219     foreach (@features) {
220         my $option = option($_->{define}, ${$_->{value}}, $_->{default});
221         push @options, $option unless $option eq "";
222     }
223
224     # ANGLE must come before WebCore
225     splice @projects, 0, 0, "Source/ThirdParty/ANGLE";
226
227     # WebKit2 is only supported in SnowLeopard and later at present.
228     push @projects, ("Source/WebKit2", "Tools/MiniBrowser") if osXVersion()->{"minor"} >= 6 and !$noWebKit2;
229
230     push @projects, ("Source/WebInspectorUI");
231
232     # Build Tools needed for Apple ports
233     push @projects, ("Tools/DumpRenderTree", "Tools/WebKitTestRunner", "Source/ThirdParty/gtest", "Tools/TestWebKitAPI");
234     
235     # Copy library and header from WebKitLibraries to a findable place in the product directory.
236     (system("perl", "Tools/Scripts/copy-webkitlibraries-to-product-directory", $productDir) == 0) or die;
237 } elsif (isWinCairo()) {
238     (system("perl Tools/Scripts/update-webkit-wincairo-libs") == 0) or die;
239 } elsif (isAppleWinWebKit()) {
240     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
241     # Will fail if WebKitSupportLibrary.zip is not in source root.
242     (system("perl Tools/Scripts/update-webkit-support-libs") == 0) or die;
243 } elsif (isQt()) {
244     push @options, "--install-headers=" . $installHeaders if defined($installHeaders);
245     push @options, "--install-libs=" . $installLibs if defined($installLibs);
246     push @options, "--makeargs=" . $makeArgs if $makeArgs;
247     push @options, "WEBKIT_CONFIG-=build_webkit1" if $noWebKit1;
248     push @options, "WEBKIT_CONFIG-=build_webkit2" if $noWebKit2;
249
250     if (checkForArgumentAndRemoveFromARGV("-2")) {
251         print "Note: WebKit2 is now built by default, you don't need to pass -2. Disable using --no-webkit2\n";
252     }
253
254     @options = (@ARGV, @options);
255
256     foreach (@features) {
257         if ($_->{define} && ${$_->{value}} != $_->{default}) {
258             my $define = lc($_->{define});
259             $define =~ s/^enable_//;
260             push @options, "WEBKIT_CONFIG" . (${$_->{value}} == 1 ? "+" : "-") . "=" . $define;
261         }
262     }
263 }
264
265 # If asked to build just the WebKit project, overwrite the projects
266 # list after all of the port specific tweaks have been made to
267 # build options, etc.
268 @projects = ("Source/WebKit") if $onlyWebKitProject;
269
270 if (isInspectorFrontend()) {
271     exit exitStatus(copyInspectorFrontendFiles());
272 }
273
274 my $result = 0;
275
276 if (isEfl()) {
277     # By default we build using all of the available CPUs.
278     $makeArgs .= ($makeArgs ? " " : "") . "-j" . numberOfCPUs() if $makeArgs !~ /-j\s*\d+/;
279     $cmakeArgs = "-DENABLE_WEBKIT=OFF "  . $cmakeArgs if $noWebKit1;
280     $cmakeArgs = "-DENABLE_WEBKIT2=OFF " . $cmakeArgs if $noWebKit2;
281
282     # We remove CMakeCache to avoid the bots to reuse cached flags when
283     # we enable new features. This forces a reconfiguration.
284     removeCMakeCache();
285
286     buildCMakeProjectOrExit($clean, "Efl", $prefixPath, $makeArgs, (cmakeBasedPortArguments(), cMakeArgsFromFeatures()), $cmakeArgs);
287 }
288
289 if (isWinCE()) {
290     buildCMakeProjectOrExit($clean, "WinCE", $prefixPath, $makeArgs, (cmakeBasedPortArguments(), cMakeArgsFromFeatures()), $cmakeArgs);
291 }
292
293 if (isBlackBerry()) {
294     my $numberOfJobs;
295     if ($ENV{"USE_ICECC"}) {
296         $numberOfJobs = 50; # 50 is the number we choose for internal development
297     } else {
298         $numberOfJobs = numberOfCPUs();
299     }
300     $makeArgs .= ($makeArgs ? " " : "") . "-j" . $numberOfJobs if $makeArgs !~ /-j\s*\d+/;
301     $prefixPath = $ENV{"STAGE_DIR"} unless $prefixPath;
302     buildCMakeProjectOrExit($clean, "BlackBerry", $prefixPath, $makeArgs, (cmakeBasedPortArguments(), cMakeArgsFromFeatures()), $cmakeArgs);
303 }
304
305 if (isQt()) {
306     @projects = (); # An empty projects list will build the default projects
307     $result = buildQMakeProjects(\@projects, $clean, @options);
308     exit exitStatus($result) if exitStatus($result);
309 }
310
311 # Build, and abort if the build fails.
312 for my $dir (@projects) {
313     chdir $dir or die;
314     $result = 0;
315
316     # For Gtk the WebKit project builds all others
317     if (isGtk() && $dir ne "Source/WebKit") {
318         chdirWebKit();
319         next;
320     }
321
322     my $project = basename($dir);
323     my $baseProductDir = baseProductDir();
324     if (isGtk()) {
325         $result = buildGtkProject($project, $clean, $prefixPath, $makeArgs, $noWebKit1, $noWebKit2, @features);
326     } elsif (isAppleMacWebKit()) {
327         my @local_options = @options;
328         push @local_options, XcodeCoverageSupportOptions() if $coverageSupport && $project ne "ANGLE";
329         my $projectPath = $project =~ /gtest/ ? "xcode/gtest" : $project;
330         $result = buildXCodeProject($projectPath, $clean, @local_options, @ARGV);
331     } elsif (isAppleWinWebKit()) {
332         if ($project eq "WebKit") {
333             my $webkitSolutionPath = "WebKit.vcxproj/WebKit.sln";
334             $result = buildVisualStudioProject($webkitSolutionPath, $clean);
335             my $vsConfiguration = configurationForVisualStudio();
336             if (usingVisualStudioExpress()) {
337                 # Visual Studio Express is so lame it can't stdout build failures.
338                 # So we find its logs and dump them to the console ourselves.
339                 open(my $OUTPUT_HANDLE, '<', "$baseProductDir/$vsConfiguration/BuildOutput.htm") or die "Could not open build log file at $baseProductDir/$vsConfiguration/BuildOutput.htm";
340                 print while (<$OUTPUT_HANDLE>);
341             }
342         }
343     }
344     # Various build* calls above may change the CWD.
345     chdirWebKit();
346
347     if (exitStatus($result)) {
348         my $scriptDir = relativeScriptsDir();
349         if (isAppleWinWebKit()) {
350             print "\n\n===== BUILD FAILED ======\n\n";
351             print "Please ensure you have run $scriptDir/update-webkit to install dependencies.\n\n";
352             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
353         }
354         exit exitStatus($result);
355     }
356 }
357
358 # Don't report the "WebKit is now built" message after a clean operation.
359 exit if $clean;
360
361 # Don't report congrats message if build was interrupted by the user.
362 exit if ($result & 127) == SIGINT;
363
364 # Explicitly chdir back to where exit will take us anyway, since the following "launcher"
365 # message is relative to that directory.
366 chdir $originalWorkingDirectory;
367
368 # Write out congratulations message.
369 writeCongrats();
370
371 exit 0;
372
373 sub cMakeArgsFromFeatures()
374 {
375     my @args;
376     foreach (@features) {
377         my $featureName = $_->{define};
378         if ($featureName) {
379             my $featureEnabled = ${$_->{value}} ? "ON" : "OFF";
380             push @args, "-D$featureName=$featureEnabled";
381         }
382     }
383     return @args;
384 }
385
386 sub formatBuildTime($)
387 {
388     my ($buildTime) = @_;
389
390     my $buildHours = int($buildTime / 3600);
391     my $buildMins = int(($buildTime - $buildHours * 3600) / 60);
392     my $buildSecs = $buildTime - $buildHours * 3600 - $buildMins * 60;
393
394     if ($buildHours) {
395         return sprintf("%dh:%02dm:%02ds", $buildHours, $buildMins, $buildSecs);
396     }
397     return sprintf("%02dm:%02ds", $buildMins, $buildSecs);
398 }
399
400 sub writeCongrats()
401 {
402     my $launcherPath = launcherPath();
403     my $launcherName = launcherName();
404     my $endTime = time();
405     my $buildTime = formatBuildTime($endTime - $startTime);
406
407     print "\n";
408     print "====================================================================\n";
409     print " WebKit is now built ($buildTime). \n";
410     print " To run $launcherName with this newly-built code, use the\n";
411     print " \"$launcherPath\" script.\n";
412     print "====================================================================\n";
413 }