5bd2e0b11ecc058c83f3c8787cb3d7d31de40a49
[WebKit.git] / Tools / Scripts / copy-webkitlibraries-to-product-directory
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005, 2008, 2010, 2011, 2012, 2013, 2014 Apple Inc. All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
7 # are met:
8 #
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 AND ITS CONTRIBUTORS "AS IS" AND ANY
16 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
19 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25
26 use strict;
27 use File::Spec;
28 use FindBin;
29 use Getopt::Long qw(:config pass_through);
30 use lib $FindBin::Bin;
31 use webkitdirs;
32
33 my $showHelp = 0;
34 my $llvm = 0;
35 my $wksi = 0;
36 my $clean = 0;
37 my $llvmIncludePackage = "";
38 my $llvmLibraryPackage = "";
39 my $useFullLibPaths = 0;
40 my $preferSystemLLVMOverDrops = 0;
41 my $llvmSubdirectoryName = "llvm";
42 my $llvmPrefix = "/usr/local/LLVMForJavaScriptCore";
43 my $osxVersion;
44 my $force = 0;
45
46 my $programName = basename($0);
47 my $usage = <<EOF;
48 Usage: $programName [options]
49   --help                        Show this help message
50   --[no-]llvm                   Toggle copying LLVM drops (default: $llvm)
51   --[no-]wksi                   Toggle copying WebKitSystemInterface drops (default: $wksi)
52   --clean                       Clean the libraries (default: $clean)
53   --use-llvm-includes=<path>    Get the LLVM inludes package from <path>
54   --use-llvm-libraries=<path>   Get the LLVM libraries package from <path>
55   --[no-]use-full-lib-paths     Toggle using full library paths
56   --[no-]prefer-system-llvm     Toggle preferring the system LLVM over the binary drops (default: $preferSystemLLVMOverDrops)
57   --llvm-subdirectory=<name>    Set the name of the LLVM subdirectory to search for (default: $llvmSubdirectoryName)
58   --llvm-prefix=<path>          Set the prefix into which LLVM is installed (default: $llvmPrefix)
59   --sdk=<sdk>                   Use a specific Xcode SDK
60   --device                      Use the current iphoneos.internal SDK (iOS only)
61   --simulator                   Use the current iphonesimulator SDK (iOS only)
62   --osx-version=<version>       Set the OS X version to use when deciding what to copy.
63   --[no-]force                  Toggle forcing the copy - i.e. ignoring timestamps (default: $force)
64 EOF
65
66 GetOptions(
67     'help' => \$showHelp,
68     'llvm!' => \$llvm,
69     'wksi!' => \$wksi,
70     'clean' => \$clean,
71     'use-llvm-includes=s' => \$llvmIncludePackage,
72     'use-llvm-libraries=s' => \$llvmLibraryPackage,
73     'use-full-lib-paths!' => \$useFullLibPaths,
74     'prefer-system-llvm!' => \$preferSystemLLVMOverDrops,
75     'llvm-subdirectory=s' => \$llvmSubdirectoryName,
76     'llvm-prefix=s' => \$llvmPrefix,
77     'osx-version=s' => \$osxVersion,
78     'force!' => \$force
79 );
80
81 if ($showHelp) {
82    print STDERR $usage;
83    exit 1;
84 }
85
86 determineXcodeSDK();
87
88 my $productDir = shift @ARGV;
89 if ($productDir) {
90     $productDir = File::Spec->rel2abs($productDir);
91 } else {
92     $productDir = $ENV{BUILT_PRODUCTS_DIR} || productDir();
93 }
94
95 if (!$osxVersion) {
96     $osxVersion = `sw_vers -productVersion | cut -d. -f-2`;
97     chomp($osxVersion);
98 }
99
100 chdirWebKit();
101
102 sub executeRanlib($)
103 {
104     my ($library) = @_;
105     my @args;
106     push @args, ("-sdk", xcodeSDK()) if xcodeSDK();
107     push @args, "ranlib";
108     push @args, "-no_warning_for_no_symbols" if isIOSWebKit();
109     system("xcrun", @args, $library) == 0 or die;
110 }
111
112 sub unpackIfNecessary
113 {
114     my ($targetDir, $sampleFile, $package, $hasLibraries) = @_;
115     if ($force || !-e $sampleFile || -M $sampleFile > -M $package) {
116         print "Unpacking $package into $targetDir\n";
117         (system("tar -C $targetDir -xmf $package") == 0) or die;
118         if ($hasLibraries) {
119             foreach my $library (`tar -tf $package`) {
120                 chomp $library;
121                 print "   Ranlib $library\n";
122                 executeRanlib($targetDir . "/" . $library);
123             }
124         }
125         return 1;
126     }
127     return 0;
128 }
129
130 sub dittoHeaders
131 {
132     my ($srcHeader, $header) = @_;
133     if ($force || !-e $header || -M $header > -M $srcHeader) {
134         print "Updating $header\n";
135         (system("ditto", $srcHeader, $header) == 0) or die;
136     }
137 }
138
139 if ($wksi) {
140     (system("mkdir", "-p", "$productDir/usr/local/include") == 0) or die;
141     
142     my $libraryDir = $useFullLibPaths ? "$productDir/usr/local/lib" : $productDir;
143     (system("mkdir", "-p", $libraryDir) == 0) or die;
144
145     my @librariesToCopy;
146     if (isIOSWebKit()) {
147         push(@librariesToCopy, (
148             "libWebKitSystemInterfaceIOSDevice8.1.a",
149             "libWebKitSystemInterfaceIOSSimulator8.1.a",
150             "libWebKitSystemInterfaceIOSDevice8.2.a",
151             "libWebKitSystemInterfaceIOSSimulator8.2.a",
152             "libWebKitSystemInterfaceIOSDevice8.3.a",
153             "libWebKitSystemInterfaceIOSSimulator8.3.a",
154             "libWebKitSystemInterfaceIOSDevice8.4.a",
155             "libWebKitSystemInterfaceIOSSimulator8.4.a",
156         ));
157     } else {
158         push(@librariesToCopy, (
159             "libWebKitSystemInterfaceMavericks.a",
160             "libWebKitSystemInterfaceYosemite.a",
161             "libWebKitSystemInterfaceElCapitan.a"
162         ));
163     }
164
165     foreach my $libraryName (@librariesToCopy) {
166         my $sourceLibrary = "WebKitLibraries/" . $libraryName;
167         my $targetLibrary = "$libraryDir/" . $libraryName;
168         if ($force || !-e $targetLibrary || -M $targetLibrary > -M $sourceLibrary) {
169             print "Updating $targetLibrary\n";
170             (system("ditto", $sourceLibrary, $targetLibrary) == 0) or die;
171             executeRanlib($targetLibrary);
172         }
173     }
174     
175     dittoHeaders("WebKitLibraries/WebKitSystemInterface.h", "$productDir/usr/local/include/WebKitSystemInterface.h");
176     dittoHeaders("WebKitLibraries/WebKitSystemInterfaceIOS.h", "$productDir/usr/local/include/WebKitSystemInterfaceIOS.h") if isIOSWebKit();
177 }
178
179 if ($llvm) {
180     (system("mkdir", "-p", "$productDir$llvmPrefix/include") == 0) or die;
181
182     my $libraryDir = $useFullLibPaths ? "$productDir$llvmPrefix/lib" : $productDir;
183     # Always create a directory at the full library path, because the JavaScriptCore build emits a warning if it's not there.
184     (system("mkdir", "-p", "$productDir$llvmPrefix/lib") == 0) or die;
185
186     # Determine where to get LLVM binaries and headers.
187     my $useOwnLLVM = 0;
188     my $ownLLVMDirectory;
189     if (defined($ENV{LLVM_SOURCE_PATH})) {
190         print "Using LLVM from \$LLVM_SOURCE_PATH: " . $ENV{LLVM_SOURCE_PATH} . "\n";
191         $useOwnLLVM = 1;
192         $ownLLVMDirectory = $ENV{LLVM_SOURCE_PATH};
193     } elsif (-d $llvmSubdirectoryName && -e "$llvmSubdirectoryName/LLVMBuild.txt") {
194         print "Using LLVM from $llvmSubdirectoryName subdirectory.\n";
195         $useOwnLLVM = 1;
196         $ownLLVMDirectory = sourceDir() . "/$llvmSubdirectoryName";
197     } elsif ($llvmLibraryPackage ne "" && $llvmIncludePackage ne "") {
198         # Command-line arguments override our other ways of finding the packages.
199         print "Using LLVM binary drops specified on command-line: $llvmLibraryPackage and $llvmIncludePackage.\n";
200     } elsif (defined($ENV{LLVM_LIBRARY_PACKAGE}) && defined($ENV{LLVM_INCLUDE_PACKAGE})) {
201         $llvmLibraryPackage = $ENV{LLVM_LIBRARY_PACKAGE};
202         $llvmIncludePackage = $ENV{LLVM_INCLUDE_PACKAGE};
203         print "Using LLVM binary drops specified by \$LLVM_LIBRARY_PACKAGE and \$LLVM_INCLUDE_PACKAGE: $llvmLibraryPackage and $llvmIncludePackage.\n";
204     } elsif ($preferSystemLLVMOverDrops) {
205         # Don't fall through to drop detection.
206         print "Using system LLVM.\n";
207     } elsif ($osxVersion eq "10.9") {
208         $llvmLibraryPackage = "WebKitLibraries/LLVMLibrariesMavericks.tar.bz2";
209         $llvmIncludePackage = "WebKitLibraries/LLVMIncludesMavericks.tar.bz2";
210     } elsif ($osxVersion eq "10.10") {
211         $llvmLibraryPackage = "WebKitLibraries/LLVMLibrariesYosemite.tar.bz2";
212         $llvmIncludePackage = "WebKitLibraries/LLVMIncludesYosemite.tar.bz2";
213     } elsif ($osxVersion eq "10.11") {
214         $llvmLibraryPackage = "WebKitLibraries/LLVMLibrariesElCapitan.tar.bz2";
215         $llvmIncludePackage = "WebKitLibraries/LLVMIncludesElCapitan.tar.bz2";
216     } else {
217         print "Don't know where to find LLVM!\n";
218         print "\n";
219         print "Try defining LLVM_LIBRARY_PACKAGE and LLVM_INCLUDE_PACKAGE or setting the\n";
220         print "--use-llvm-includes and --use-llvm-libraries options.\n";
221         print "\n";
222         print "Alternatively, you can check out llvm trunk into the WebKit directory:\n";
223         print "svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm\n";
224         exit 1;
225     }
226
227     sub fileContains
228     {
229         my ($filename, $string) = @_;
230         open my $fileHandle, '<', $filename or die;
231         while (<$fileHandle>) {
232             return 1 if /^$string$/;
233         }
234         return 0;
235     }
236
237     sub fileContentsEquals
238     {
239         my ($filename, $string) = @_;
240         open my $fileHandle, '<', $filename or die;
241         binmode $fileHandle;
242         my $contents = <$fileHandle>;
243         return $contents eq $string;
244     }
245
246     my $shouldUpdateLLVMLibraryToken = 0;
247
248     if ($useOwnLLVM) {
249         my $sdkArg;
250         if (xcodeSDK()) {
251             $sdkArg = "--sdk " . xcodeSDK();
252         } else {
253             $sdkArg = "";
254         }
255         my $sdkRoot = `xcrun $sdkArg --show-sdk-path`;
256         chomp $sdkRoot;
257     
258         if (!-e "$ownLLVMDirectory/wkLLVMBuild/Makefile.config") {
259             print("Configuring LLVM.\n");
260             (system("mkdir -p $ownLLVMDirectory/wkLLVMBuild"));
261             my $flags = "--enable-optimized=yes --enable-backtraces=no --enable-targets=x86_64 --enable-libcpp=yes --enable-zlib=no --enable-terminfo=no --enable-crash-overrides=no";
262             (system("(cd $ownLLVMDirectory/wkLLVMBuild && SDKROOT=$sdkRoot ../configure $flags)") == 0) or die;
263         }
264
265         print("Building LLVM.\n");
266         my $oldPath = $ENV{"PATH"};
267         chdir "$ownLLVMDirectory/wkLLVMBuild";
268         my $binariesDirectory = "binariesForLLVMBuild";
269         my $pathCommand = "";
270         if (-e $binariesDirectory) {
271             my $binariesPath = File::Spec->rel2abs($binariesDirectory);
272             print "Detected binaries directory; prepending to path: $binariesPath\n";
273             $pathCommand = "PATH=\\\$PWD/$binariesDirectory:\\\$PATH";
274         }
275         my $makeCommand = "env -i bash -l -c \"$pathCommand SDKROOT=$sdkRoot make -j `sysctl -n hw.activecpu`\"";
276         print $makeCommand . "\n";
277         (system($makeCommand) == 0) or die;
278         $ENV{"PATH"} = $oldPath;
279         chdirWebKit();
280         
281         my $ownLLVMBuildMode = "";
282         if (fileContains($ownLLVMDirectory . "/wkLLVMBuild/Makefile.config", "ENABLE_OPTIMIZED=1")) {
283             $ownLLVMBuildMode .= "Release";
284         } else {
285             $ownLLVMBuildMode .= "Debug";
286         }
287         
288         if (fileContains($ownLLVMDirectory . "/wkLLVMBuild/Makefile.config", "DISABLE_ASSERTIONS=1")) {
289             # Nothing to do.
290         } else {
291             $ownLLVMBuildMode .= "+Asserts";
292         }
293         
294         my $librarySourceDirectory = "$ownLLVMDirectory/wkLLVMBuild/$ownLLVMBuildMode/lib";
295         my $libraryTargetDirectory = $libraryDir;
296         $shouldUpdateLLVMLibraryToken = 0;
297         print("Symlinking libraries from $librarySourceDirectory to $libraryTargetDirectory\n");
298         opendir (my $dirHandle, $librarySourceDirectory);
299         while (my $filename = readdir($dirHandle)) {
300             next if $filename !~ /\.a$/;
301             next if $filename =~ /libgtest/;
302             print "   Symlink $filename\n";
303             my $sourceLibrary = "$librarySourceDirectory/$filename";
304             my $targetLibrary = "$libraryTargetDirectory/$filename";
305             my $ranlibToken = "$libraryTargetDirectory/.ranlibToken-$filename";
306             unlink($targetLibrary);
307             symlink($sourceLibrary, $targetLibrary);
308             if ($force
309                 || !-e $ranlibToken
310                 || !fileContentsEquals($ranlibToken, $sourceLibrary)
311                 || -M $ranlibToken > -M $sourceLibrary) {
312                 print "   Ranlib $filename\n";
313                 executeRanlib($targetLibrary);
314                 (open my $fileHandle, ">", $ranlibToken) or die;
315                 print {$fileHandle} "$sourceLibrary";
316                 close $fileHandle;
317                 $shouldUpdateLLVMLibraryToken = 1;
318             }
319         }
320         closedir $dirHandle;
321     } elsif (!$preferSystemLLVMOverDrops) {
322         $shouldUpdateLLVMLibraryToken =
323             unpackIfNecessary($libraryDir, "$libraryDir/libLLVMCore.a", $llvmLibraryPackage, 1);
324     }
325
326     (system("rm", "-f", "$productDir/ExtraIncludesForLocalLLVMBuild") == 0) or die;
327     if ($useOwnLLVM) {
328         (system("rm", "-rf", "$productDir$llvmPrefix/include/llvm") == 0) or die;
329         (system("rm", "-rf", "$productDir$llvmPrefix/include/llvm-c") == 0) or die;
330         symlink("$ownLLVMDirectory/include/llvm", "$productDir$llvmPrefix/include/llvm") or die;
331         symlink("$ownLLVMDirectory/include/llvm-c", "$productDir$llvmPrefix/include/llvm-c") or die;
332         symlink("$ownLLVMDirectory/wkLLVMBuild/include", "$productDir/ExtraIncludesForLocalLLVMBuild") or die;
333     } elsif (!$preferSystemLLVMOverDrops) {
334         unpackIfNecessary("$productDir$llvmPrefix/include", "$productDir$llvmPrefix/include/llvm-c/Core.h", $llvmIncludePackage, 0);
335     }
336
337     if ($shouldUpdateLLVMLibraryToken) {
338         (system("touch", "Source/JavaScriptCore/llvm/library/LLVMAnchor.cpp") == 0) or die;
339     }
340 }
341
342 if ($clean) {
343     print "Cleaning.\n";    
344     (system("rm", "-rf", "$productDir/usr/local/include/WebKitSystemInterface.h") == 0) or die;
345     if (isIOSWebKit()) {
346         (system("rm", "-rf", "$productDir/usr/local/include/WebKitSystemInterfaceIOS.h") == 0) or die;
347     }
348     (system("rm", "-rf", "$productDir$llvmPrefix") == 0) or die;
349     unlink glob "$productDir/libWebKitSystemInterface*" or die if glob "$productDir/libWebKitSystemInterface*";
350     unlink glob "$productDir/usr/local/lib/libWebKitSystemInterface*" or die if glob "$productDir/usr/local/lib/libWebKitSystemInterface*";
351     unlink glob "$productDir/libLLVM*" or die if glob "$productDir/libLLVM*";
352     unlink glob "$productDir/libLTO*" or die if glob "$productDir/libLTO*";
353 }