c86019283d4cf097650f7420491b362404af5bd2
[WebKit-https.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 $sdkName = ""; # Ideally we only use this for build commands, rather than deciding policies about what needs to get copied or built and where it needs to be placed.
44 my $osxVersion;
45 my $force = 0;
46
47 my $programName = basename($0);
48 my $usage = <<EOF;
49 Usage: $programName [options]
50   --help                        Show this help message
51   --[no-]llvm                   Toggle copying LLVM drops (default: $llvm)
52   --[no-]wksi                   Toggle copying WebKitSystemInterface drops (default: $wksi)
53   --clean                       Clean the libraries (default: $clean)
54   --use-llvm-includes=<path>    Get the LLVM inludes package from <path>
55   --use-llvm-libraries=<path>   Get the LLVM libraries package from <path>
56   --[no-]use-full-lib-paths     Toggle using full library paths
57   --[no-]prefer-system-llvm     Toggle preferring the system LLVM over the binary drops (default: $preferSystemLLVMOverDrops)
58   --llvm-subdirectory=<name>    Set the name of the LLVM subdirectory to search for (default: $llvmSubdirectoryName)
59   --llvm-prefix=<path>          Set the prefix into which LLVM is installed (default: $llvmPrefix)
60   --sdk-name=<name>             Set the name of the Xcode SDK to use.
61   --osx-version=<version>       Set the OS X version to use when deciding what to copy.
62   --[no-]force                  Toggle forcing the copy - i.e. ignoring timestamps (default: $force)
63 EOF
64
65 GetOptions(
66     'help' => \$showHelp,
67     'llvm!' => \$llvm,
68     'wksi!' => \$wksi,
69     'clean' => \$clean,
70     'use-llvm-includes=s' => \$llvmIncludePackage,
71     'use-llvm-libraries=s' => \$llvmLibraryPackage,
72     'use-full-lib-paths!' => \$useFullLibPaths,
73     'prefer-system-llvm!' => \$preferSystemLLVMOverDrops,
74     'llvm-subdirectory=s' => \$llvmSubdirectoryName,
75     'llvm-prefix=s' => \$llvmPrefix,
76     'sdk-name=s' => \$sdkName,
77     'osx-version=s' => \$osxVersion,
78     'force!' => \$force
79 );
80
81 if ($showHelp) {
82    print STDERR $usage;
83    exit 1;
84 }
85
86 my $productDir = shift @ARGV;
87 if ($productDir) {
88     $productDir = File::Spec->rel2abs($productDir);
89 } else {
90     $productDir = $ENV{BUILT_PRODUCTS_DIR} || productDir();
91 }
92
93 if (!$osxVersion) {
94     $osxVersion = `sw_vers -productVersion | cut -d. -f-2`;
95     chomp($osxVersion);
96 }
97
98 chdirWebKit();
99
100 my $xcrunOptions = "";
101 if ($sdkName ne "") {
102     $xcrunOptions .= " -sdk $sdkName";
103 }
104 my $ranlib = `xcrun $xcrunOptions -find ranlib`;
105 chomp $ranlib;
106
107 sub unpackIfNecessary
108 {
109     my ($targetDir, $sampleFile, $package, $hasLibraries) = @_;
110     if ($force || !-e $sampleFile || -M $sampleFile > -M $package) {
111         print "Unpacking $package into $targetDir\n";
112         (system("tar -C $targetDir -xmf $package") == 0) or die;
113         if ($hasLibraries) {
114             foreach my $library (`tar -tf $package`) {
115                 chomp $library;
116                 print "   Ranlib $library\n";
117                 (system($ranlib, $targetDir . "/" . $library) == 0) or die;
118             }
119         }
120         return 1;
121     }
122     return 0;
123 }
124
125 sub dittoHeaders
126 {
127     my ($srcHeader, $header) = @_;
128     if ($force || !-e $header || -M $header > -M $srcHeader) {
129         print "Updating $header\n";
130         (system("ditto", $srcHeader, $header) == 0) or die;
131     }
132 }
133
134 if ($wksi) {
135     (system("mkdir", "-p", "$productDir/usr/local/include") == 0) or die;
136     
137     my $libraryDir = $useFullLibPaths ? "$productDir/usr/local/lib" : $productDir;
138     (system("mkdir", "-p", $libraryDir) == 0) or die;
139
140     my @librariesToCopy = (
141         "libWebKitSystemInterfaceMountainLion.a",
142         "libWebKitSystemInterfaceMavericks.a",
143     );
144     
145     foreach my $libName (@librariesToCopy) {
146         my $srcLib = "WebKitLibraries/" . $libName;
147         my $lib = "$libraryDir/" . $libName;
148         if ($force || !-e $lib || -M $lib > -M $srcLib) {
149             print "Updating $lib\n";
150             (system("ditto", $srcLib, $lib) == 0) or die;
151             (system($ranlib, $lib) == 0) or die;
152         }
153     }
154     
155     dittoHeaders("WebKitLibraries/WebKitSystemInterface.h", "$productDir/usr/local/include/WebKitSystemInterface.h");
156 }
157
158 if ($llvm) {
159     (system("mkdir", "-p", "$productDir$llvmPrefix/include") == 0) or die;
160
161     my $libraryDir = $useFullLibPaths ? "$productDir$llvmPrefix/lib" : $productDir;
162     (system("mkdir", "-p", $libraryDir) == 0) or die;
163
164     # Determine where to get LLVM binaries and headers.
165     my $useOwnLLVM = 0;
166     my $ownLLVMDirectory;
167     if (defined($ENV{LLVM_SOURCE_PATH})) {
168         print "Using LLVM from \$LLVM_SOURCE_PATH: " . $ENV{LLVM_SOURCE_PATH} . "\n";
169         $useOwnLLVM = 1;
170         $ownLLVMDirectory = $ENV{LLVM_SOURCE_PATH};
171     } elsif (-d $llvmSubdirectoryName && -e "$llvmSubdirectoryName/LLVMBuild.txt") {
172         print "Using LLVM from $llvmSubdirectoryName subdirectory.\n";
173         $useOwnLLVM = 1;
174         $ownLLVMDirectory = sourceDir() . "/$llvmSubdirectoryName";
175     } elsif ($llvmLibraryPackage ne "" && $llvmIncludePackage ne "") {
176         # Command-line arguments override our other ways of finding the packages.
177         print "Using LLVM binary drops specified on command-line: $llvmLibraryPackage and $llvmIncludePackage.\n";
178     } elsif (defined($ENV{LLVM_LIBRARY_PACKAGE}) && defined($ENV{LLVM_INCLUDE_PACKAGE})) {
179         $llvmLibraryPackage = $ENV{LLVM_LIBRARY_PACKAGE};
180         $llvmIncludePackage = $ENV{LLVM_INCLUDE_PACKAGE};
181         print "Using LLVM binary drops specified by \$LLVM_LIBRARY_PACKAGE and \$LLVM_INCLUDE_PACKAGE: $llvmLibraryPackage and $llvmIncludePackage.\n";
182     } elsif ($preferSystemLLVMOverDrops) {
183         # Don't fall through to drop detection.
184         print "Using system LLVM.\n";
185     } elsif ($osxVersion eq "10.8") {
186         $llvmLibraryPackage = "WebKitLibraries/LLVMLibrariesMountainLion.tar.bz2";
187         $llvmIncludePackage = "WebKitLibraries/LLVMIncludesMountainLion.tar.bz2";
188     } elsif ($osxVersion eq "10.9") {
189         $llvmLibraryPackage = "WebKitLibraries/LLVMLibrariesMavericks.tar.bz2";
190         $llvmIncludePackage = "WebKitLibraries/LLVMIncludesMavericks.tar.bz2";
191     } else {
192         print "Don't know where to find LLVM!\n";
193         print "\n";
194         print "Try defining LLVM_LIBRARY_PACKAGE and LLVM_INCLUDE_PACKAGE or setting the\n";
195         print "--use-llvm-includes and --use-llvm-libraries options.\n";
196         print "\n";
197         print "Alternatively, you can check out llvm trunk into the WebKit directory:\n";
198         print "svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm\n";
199         exit 1;
200     }
201
202     sub fileContains
203     {
204         my ($filename, $string) = @_;
205         open my $fileHandle, '<', $filename or die;
206         while (<$fileHandle>) {
207             return 1 if /^$string$/;
208         }
209         return 0;
210     }
211
212     sub fileContentsEquals
213     {
214         my ($filename, $string) = @_;
215         open my $fileHandle, '<', $filename or die;
216         binmode $fileHandle;
217         my $contents = <$fileHandle>;
218         return $contents eq $string;
219     }
220
221     my $shouldUpdateLLVMLibraryToken = 0;
222
223     if ($useOwnLLVM) {
224         if (!-e "$ownLLVMDirectory/wkLLVMBuild/Makefile.config") {
225             print("Configuring LLVM.\n");
226             (system("mkdir -p $ownLLVMDirectory/wkLLVMBuild"));
227             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";
228             (system("(cd $ownLLVMDirectory/wkLLVMBuild && ../configure $flags)") == 0) or die;
229         }
230
231         print("Building LLVM.\n");
232         my $oldPath = $ENV{"PATH"};
233         chdir "$ownLLVMDirectory/wkLLVMBuild";
234         my $binariesDirectory = "binariesForLLVMBuild";
235         my $pathCommand = "";
236         if (-e $binariesDirectory) {
237             my $binariesPath = File::Spec->rel2abs($binariesDirectory);
238             print "Detected binaries directory; prepending to path: $binariesPath\n";
239             $pathCommand = "PATH=\\\$PWD/$binariesDirectory:\\\$PATH";
240         }
241         my $makeCommand = "env -i bash -l -c \"$pathCommand make -j `sysctl -n hw.activecpu`\"";
242         print $makeCommand . "\n";
243         (system($makeCommand) == 0) or die;
244         $ENV{"PATH"} = $oldPath;
245         chdirWebKit();
246         
247         my $ownLLVMBuildMode = "";
248         if (fileContains($ownLLVMDirectory . "/wkLLVMBuild/Makefile.config", "ENABLE_OPTIMIZED=1")) {
249             $ownLLVMBuildMode .= "Release";
250         } else {
251             $ownLLVMBuildMode .= "Debug";
252         }
253         
254         if (fileContains($ownLLVMDirectory . "/wkLLVMBuild/Makefile.config", "DISABLE_ASSERTIONS=1")) {
255             # Nothing to do.
256         } else {
257             $ownLLVMBuildMode .= "+Asserts";
258         }
259         
260         my $librarySourceDirectory = "$ownLLVMDirectory/wkLLVMBuild/$ownLLVMBuildMode/lib";
261         my $libraryTargetDirectory = $libraryDir;
262         $shouldUpdateLLVMLibraryToken = 0;
263         print("Symlinking libraries from $librarySourceDirectory to $libraryTargetDirectory\n");
264         opendir (my $dirHandle, $librarySourceDirectory);
265         while (my $filename = readdir($dirHandle)) {
266             next if $filename !~ /\.a$/;
267             next if $filename =~ /libgtest/;
268             print "   Symlink $filename\n";
269             my $sourceLibrary = "$librarySourceDirectory/$filename";
270             my $targetLibrary = "$libraryTargetDirectory/$filename";
271             my $ranlibToken = "$libraryTargetDirectory/.ranlibToken-$filename";
272             unlink($targetLibrary);
273             symlink($sourceLibrary, $targetLibrary);
274             if ($force
275                 || !-e $ranlibToken
276                 || !fileContentsEquals($ranlibToken, $sourceLibrary)
277                 || -M $ranlibToken > -M $sourceLibrary) {
278                 print "   Ranlib $filename\n";
279                 (system($ranlib, $targetLibrary) == 0) or die;
280                 (open my $fileHandle, ">", $ranlibToken) or die;
281                 print {$fileHandle} "$sourceLibrary";
282                 close $fileHandle;
283                 $shouldUpdateLLVMLibraryToken = 1;
284             }
285         }
286         closedir $dirHandle;
287     } elsif (!$preferSystemLLVMOverDrops) {
288         $shouldUpdateLLVMLibraryToken =
289             unpackIfNecessary($libraryDir, "$libraryDir/libLLVMCore.a", $llvmLibraryPackage, 1);
290     }
291
292     (system("rm", "-f", "$productDir/ExtraIncludesForLocalLLVMBuild") == 0) or die;
293     if ($useOwnLLVM) {
294         (system("rm", "-rf", "$productDir$llvmPrefix/include/llvm") == 0) or die;
295         (system("rm", "-rf", "$productDir$llvmPrefix/include/llvm-c") == 0) or die;
296         symlink("$ownLLVMDirectory/include/llvm", "$productDir$llvmPrefix/include/llvm") or die;
297         symlink("$ownLLVMDirectory/include/llvm-c", "$productDir$llvmPrefix/include/llvm-c") or die;
298         symlink("$ownLLVMDirectory/wkLLVMBuild/include", "$productDir/ExtraIncludesForLocalLLVMBuild") or die;
299     } elsif (!$preferSystemLLVMOverDrops) {
300         unpackIfNecessary("$productDir$llvmPrefix/include", "$productDir$llvmPrefix/include/llvm-c/Core.h", $llvmIncludePackage, 0);
301     }
302
303     if ($shouldUpdateLLVMLibraryToken) {
304         (system("touch", "Source/JavaScriptCore/llvm/library/LLVMAnchor.cpp") == 0) or die;
305     }
306 }
307
308 if ($clean) {
309     print "Cleaning.\n";    
310     (system("rm", "-rf", "$productDir/usr/local/include/WebKitSystemInterface.h") == 0) or die;
311     (system("rm", "-rf", "$productDir$llvmPrefix") == 0) or die;
312     unlink glob "$productDir/libWebKitSystemInterface*" or die if glob "$productDir/libWebKitSystemInterface*";
313     unlink glob "$productDir/usr/local/lib/libWebKitSystemInterface*" or die if glob "$productDir/usr/local/lib/libWebKitSystemInterface*";
314     unlink glob "$productDir/libLLVM*" or die if glob "$productDir/libLLVM*";
315     unlink glob "$productDir/libLTO*" or die if glob "$productDir/libLTO*";
316 }